Payment
33 properties
Properties
Select a row for its DAC field and description| Property | Type | Data Type | |
|---|---|---|---|
ApplicationDate | DateTimeValue | DateTime | |
DAC Field: PX.Objects.AR.ARPayment.AdjDateDescription:No description available | |||
ApplicationHistory | List | PaymentApplicationHistoryDetail | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
AppliedToDocuments | DecimalValue | decimal | |
DAC Field: PX.Objects.AR.ARPayment.CuryApplAmtDescription:No description available | |||
Branch | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.BranchIDDescription:The identifier of the branch to which the document belongs. Corresponds to the Branch.BranchID field. | |||
CardAccountNbr | IntValue | int | |
DAC Field: PX.Objects.AR.ARPayment.PMInstanceIDDescription:No description available | |||
CashAccount | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.CashAccountIDDescription:No description available | |||
Charges | List | PaymentCharge | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
CreditCardProcessingInfo | List | CreditCardProcessingDetail | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
CurrencyID | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.CuryIDDescription:The code of the Currency of the document. Defaults to the base currency of the company. Corresponds to the Currency.CuryID field. | |||
CustomerID | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.CustomerIDDescription:The identifier of the Customer record associated with the document. Corresponds to the BAccount.BAccountID field. | |||
Description | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.DocDescDescription:The description of the document. | |||
DocumentsToApply | List | PaymentDetail | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
Hold | BooleanValue | boolean | |
DAC Field: PX.Objects.AR.ARPayment.HoldDescription:When set to "true" indicates that the document is on hold and thus cannot be released. | |||
IsCCPayment | BooleanValue | boolean | |
DAC Field: PX.Objects.AR.ARPayment.IsCCPaymentDescription:No description available | |||
OrdersToApply | List | PaymentOrderDetail | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
PaymentAmount | DecimalValue | decimal | |
DAC Field: PX.Objects.AR.ARPayment.CuryOrigDocAmtDescription:The amount of the document. Given in the currency of the document. | |||
PaymentMethod | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.PaymentMethodIDDescription:No description available | |||
PaymentRef | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.ExtRefNbrDescription:No description available | |||
ReferenceNbr | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.RefNbrDescription:The reference number of the document. This field is a part of the compound key of the document. | |||
Status | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.StatusDescription:The status of the document. The value of the field is determined by the values of the status flags, such as Hold, Released, Voided, Scheduled. The field can have one of the values described in ARDocStatus.ListAttribute. Defaults to ARDocStatus.Hold. | |||
Type | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.DocTypeDescription:The type of the document. This field is a part of the compound key of the document. The field can have one of the values described in ARDocType.ListAttribute. | |||
LastModifiedDateTime | DateTimeValue | DateTime | |
DAC Field: PX.Objects.AR.ARPayment.LastModifiedDateTimeDescription:No description available | |||
ProcessingCenterID | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.ProcessingCenterIDDescription:No description available | |||
SaveCard | BooleanValue | boolean | |
DAC Field: PX.Objects.AR.ARPayment.SaveCardDescription:No description available | |||
CreditCardTransactionInfo | List | CreditCardTransactionDetail | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
ExternalRef | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.ExternalRefDescription:No description available | |||
OrigTransaction | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.RefTranExtNbrDescription:No description available | |||
BranchID | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.BranchIDDescription:The identifier of the branch to which the document belongs. Corresponds to the Branch.BranchID field. | |||
CustomerLocationID | StringValue | string | |
DAC Field: PX.Objects.AR.ARPayment.CustomerLocationIDDescription:Identifier of the Location of the Customer. Defaults to the Default Location of the Customer if it is specified, or to the first found Location, associated with the Customer. Corresponds to the Location.LocationID field. | |||
IsNewCard | BooleanValue | boolean | |
DAC Field: PX.Objects.AR.ARPayment.NewCardDescription:No description available | |||
NoteID | GuidValue | Guid | |
DAC Field: PX.Objects.AR.ARPayment.NoteIDDescription:Identifier of the Note object, associated with the document. Corresponds to the Note.NoteID field. | |||
AvailableBalance | DecimalValue | decimal | |
DAC Field: PX.Objects.AR.ARPayment.CuryUnappliedBalDescription:No description available | |||
AppliedToOrders | DecimalValue | decimal | |
DAC Field: PX.Objects.AR.ARPayment.CurySOApplAmtDescription:No description available | |||
Minimum Payload
Derived from static analysis of the 2025.2 source; runtime configuration may require additional fields.
{
"CustomerID": {
"value": "string"
},
"Type": {
"value": "string"
}
}2 properties could not be judged statically and are omitted; see the full properties table.
Optional Children
None of these child collections is required — a payload without them is valid. If you do include one, these are the fields each row of it needs; keys the parent record supplies are named separately and must not be sent.
Chargesa list ofPaymentChargerequired if you include one:EntryTypeIDsupplied by the parent:DocTypeRefNbrDocumentsToApplya list ofPaymentDetailrequired if you include one:ReferenceNbrOrdersToApplya list ofPaymentOrderDetailrequired if you include one:OrderNbrCreditCardTransactionInfoa list ofCreditCardTransactionDetailrequired if you include one:TranNbrAuthNbrOrigTranNbrTranApiNbr