Check
16 properties
Properties
Select a row for its DAC field and description| Property | Type | Data Type | |
|---|---|---|---|
ApplicationDate | DateTimeValue | DateTime | |
DAC Field: PX.Objects.AP.APPayment.AdjDateDescription:The date when the payment is applied. Defaults to the current business date. | |||
CashAccount | StringValue | string | |
DAC Field: PX.Objects.AP.APPayment.CashAccountIDDescription:The cash account associated with the payment method. The field is irrelevant for debit adjustments. Corresponds to the CashAccount.CashAccountID field. Defaults to the cash account associated with the payment method and location. | |||
CurrencyID | StringValue | string | |
DAC Field: PX.Objects.AP.APPayment.CuryIDDescription:Code of the Currency of the document. Defaults to the company's base currency. | |||
Description | StringValue | string | |
DAC Field: PX.Objects.AP.APPayment.DocDescDescription:Description of the document. | |||
Details | List | CheckDetail | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
History | List | CheckHistoryDetail | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
Hold | BooleanValue | boolean | |
DAC Field: PX.Objects.AP.APPayment.HoldDescription:When set to "true" indicates that the document is on hold and thus cannot be released. | |||
PaymentAmount | DecimalValue | decimal | |
DAC Field: PX.Objects.AP.APPayment.CuryOrigDocAmtDescription:The total payment amount that should be applied to the documents. (Presented in the currency of the document, see CuryID) | |||
PaymentMethod | StringValue | string | |
DAC Field: PX.Objects.AP.APPayment.PaymentMethodIDDescription:The payment method used for the document. Corresponds to the PaymentMethod.PaymentMethodID field. Defaults to the payment method associated with the vendor location. | |||
PaymentRef | StringValue | string | |
DAC Field: PX.Objects.AP.APPayment.ExtRefNbrDescription:A payment reference number, which can be a system-generated number or an external reference number (such as a wire transfer number or a bank check number) entered manually. Irrelevant for Debit Adjustments. | |||
ReferenceNbr | StringValue | string | |
DAC Field: PX.Objects.AP.APPayment.RefNbrDescription:Reference number of the document. | |||
Status | StringValue | string | |
DAC Field: PX.Objects.AP.APPayment.StatusDescription:Status of the document. The field is calculated based on the values of status flag. It can't be changed directly. The fields tht determine status of a document are: Hold, Released, Voided, Scheduled, Prebooked, Printed Possible values are: ""H"" - Hold, ""B"" - Balanced, ""V"" - Voided, ""S"" - Scheduled, ""N"" - Open, ""C"" - Closed, ""P"" - Printed, ""K"" - Prebooked. Defaults to Hold. | |||
Type | StringValue | string | |
DAC Field: PX.Objects.AP.APPayment.DocTypeDescription:Type of the document. Possible values are: "CHK" - Payment, "ADR" - Debit Adjustment, "PPM" - Prepayment, "REF" - Refund, "VCK" - Voided Payment | |||
UnappliedBalance | DecimalValue | decimal | |
DAC Field: PX.Objects.AP.APPayment.CuryUnappliedBalDescription:The balance that has not been applied. This will be a nonzero value if the payment amount is not equal to a document’s total amount. Checks shall always have a zero unapplied balance. (Presented in the currency of the document, see CuryID) | |||
Vendor | StringValue | string | |
DAC Field: PX.Objects.AP.APPayment.VendorIDDescription:Identifier of the Vendor, whom the document belongs to. | |||
LastModifiedDateTime | DateTimeValue | DateTime | |
DAC Field: PX.Objects.AP.APPayment.LastModifiedDateTimeDescription:No description available | |||
Minimum Payload
Derived from static analysis of the 2025.2 source; runtime configuration may require additional fields.
{
"Type": {
"value": "string"
},
"Vendor": {
"value": "string"
},
"Details": [
{
"ReferenceNbr": {
"value": "string"
}
}
]
}For every property this entity accepts, see the properties table.
Details is the detail-lines collection (CheckDetail); one example row is included above because a document usually has lines, and each row needs ReferenceNbr of its own.