Skip to main content
API Family:Default
Version:25.200.001
Screen ID:AR302000

Properties

Select a row for its DAC field and description
PropertyTypeData Type
ApplicationDateDateTimeValueDateTime
DAC Field:PX.Objects.AR.ARPayment.AdjDate
Description:No description available
ApplicationHistoryListPaymentApplicationHistoryDetail
DAC Field:Not mapped to a DAC field
Description:No description available
AppliedToDocumentsDecimalValuedecimal
DAC Field:PX.Objects.AR.ARPayment.CuryApplAmt
Description:No description available
BranchStringValuestring
DAC Field:PX.Objects.AR.ARPayment.BranchID
Description:The identifier of the branch to which the document belongs. Corresponds to the Branch.BranchID field.
CardAccountNbrIntValueint
DAC Field:PX.Objects.AR.ARPayment.PMInstanceID
Description:No description available
CashAccountStringValuestring
DAC Field:PX.Objects.AR.ARPayment.CashAccountID
Description:No description available
ChargesListPaymentCharge
DAC Field:Not mapped to a DAC field
Description:No description available
CreditCardProcessingInfoListCreditCardProcessingDetail
DAC Field:Not mapped to a DAC field
Description:No description available
CurrencyIDStringValuestring
DAC Field:PX.Objects.AR.ARPayment.CuryID
Description:The code of the Currency of the document. Defaults to the base currency of the company. Corresponds to the Currency.CuryID field.
CustomerIDStringValuestring
DAC Field:PX.Objects.AR.ARPayment.CustomerID
Description:The identifier of the Customer record associated with the document. Corresponds to the BAccount.BAccountID field.
DescriptionStringValuestring
DAC Field:PX.Objects.AR.ARPayment.DocDesc
Description:The description of the document.
DocumentsToApplyListPaymentDetail
DAC Field:Not mapped to a DAC field
Description:No description available
HoldBooleanValueboolean
DAC Field:PX.Objects.AR.ARPayment.Hold
Description:When set to "true" indicates that the document is on hold and thus cannot be released.
IsCCPaymentBooleanValueboolean
DAC Field:PX.Objects.AR.ARPayment.IsCCPayment
Description:No description available
OrdersToApplyListPaymentOrderDetail
DAC Field:Not mapped to a DAC field
Description:No description available
PaymentAmountDecimalValuedecimal
DAC Field:PX.Objects.AR.ARPayment.CuryOrigDocAmt
Description:The amount of the document. Given in the currency of the document.
PaymentMethodStringValuestring
DAC Field:PX.Objects.AR.ARPayment.PaymentMethodID
Description:No description available
PaymentRefStringValuestring
DAC Field:PX.Objects.AR.ARPayment.ExtRefNbr
Description:No description available
ReferenceNbrStringValuestring
DAC Field:PX.Objects.AR.ARPayment.RefNbr
Description:The reference number of the document. This field is a part of the compound key of the document.
StatusStringValuestring
DAC Field:PX.Objects.AR.ARPayment.Status
Description: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.
TypeStringValuestring
DAC Field:PX.Objects.AR.ARPayment.DocType
Description: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.
LastModifiedDateTimeDateTimeValueDateTime
DAC Field:PX.Objects.AR.ARPayment.LastModifiedDateTime
Description:No description available
ProcessingCenterIDStringValuestring
DAC Field:PX.Objects.AR.ARPayment.ProcessingCenterID
Description:No description available
SaveCardBooleanValueboolean
DAC Field:PX.Objects.AR.ARPayment.SaveCard
Description:No description available
CreditCardTransactionInfoListCreditCardTransactionDetail
DAC Field:Not mapped to a DAC field
Description:No description available
ExternalRefStringValuestring
DAC Field:PX.Objects.AR.ARPayment.ExternalRef
Description:No description available
OrigTransactionStringValuestring
DAC Field:PX.Objects.AR.ARPayment.RefTranExtNbr
Description:No description available
BranchIDStringValuestring
DAC Field:PX.Objects.AR.ARPayment.BranchID
Description:The identifier of the branch to which the document belongs. Corresponds to the Branch.BranchID field.
CustomerLocationIDStringValuestring
DAC Field:PX.Objects.AR.ARPayment.CustomerLocationID
Description: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.
IsNewCardBooleanValueboolean
DAC Field:PX.Objects.AR.ARPayment.NewCard
Description:No description available
NoteIDGuidValueGuid
DAC Field:PX.Objects.AR.ARPayment.NoteID
Description:Identifier of the Note object, associated with the document. Corresponds to the Note.NoteID field.
AvailableBalanceDecimalValuedecimal
DAC Field:PX.Objects.AR.ARPayment.CuryUnappliedBal
Description:No description available
AppliedToOrdersDecimalValuedecimal
DAC Field:PX.Objects.AR.ARPayment.CurySOApplAmt
Description:No description available

Minimum Payload

Derived from static analysis of the 2025.2 source; runtime configuration may require additional fields.

2 required 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 of PaymentChargerequired if you include one:EntryTypeIDsupplied by the parent:DocTypeRefNbr
  • DocumentsToApplya list of PaymentDetailrequired if you include one:ReferenceNbr
  • OrdersToApplya list of PaymentOrderDetailrequired if you include one:OrderNbr
  • CreditCardTransactionInfoa list of CreditCardTransactionDetailrequired if you include one:TranNbrTranApiNbrCommerceTranNbrAuthNbrOrigTranNbr

Available in Versions