Skip to main content
API Family:Default
Version:23.200.001
Screen ID:AR301000

Properties

Select a row for its DAC field and description
PropertyTypeData Type
AmountDecimalValuedecimal
DAC Field:PX.Objects.AR.ARInvoice.CuryOrigDocAmt
Description:The amount of the document. Given in the currency of the document.
ApplicationsCreditMemoListInvoiceApplicationsCreditMemo
DAC Field:Not mapped to a DAC field
Description:No description available
ApplicationsDefaultListInvoiceApplicationsDefault
DAC Field:Not mapped to a DAC field
Description:No description available
BalanceDecimalValuedecimal
DAC Field:PX.Objects.AR.ARInvoice.CuryDocBal
Description:The open balance of the document. Given in the currency of the document.
BillingPrintedBooleanValueboolean
DAC Field:PX.Objects.AR.ARInvoice.Printed
Description:Specifies (if set to "true") that the document has been printed.
BillToContactDocContactDocContact
DAC Field:Not mapped to a DAC field
Description:No description available
BillToContactOverrideBooleanValueboolean
DAC Field:PX.Objects.AR.ARContact.OverrideContact
Description:If set to "true", indicates that the contact overrides the default Contact record referenced by the CustomerContactID field. This field is the inverse of IsDefaultContact.
CreatedDateTimeDateTimeValueDateTime
DAC Field:PX.Objects.AR.ARInvoice.CreatedDateTime
Description:No description available
CustomerStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.CustomerID
Description:The identifier of the Customer record associated with the document. Corresponds to the BAccount.BAccountID field.
CustomerOrderStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.InvoiceNbr
Description:The original reference number or ID assigned by the customer to the customer document.
DateDateTimeValueDateTime
DAC Field:PX.Objects.AR.ARInvoice.DocDate
Description:The date of the document. Defaults to the current Business Date.
DescriptionStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.DocDesc
Description:The description of the document.
DetailsListInvoiceDetail
DAC Field:Not mapped to a DAC field
Description:No description available
DiscountDetailsListInvoiceDiscountDetail
DAC Field:Not mapped to a DAC field
Description:No description available
DueDateDateTimeValueDateTime
DAC Field:PX.Objects.AR.ARInvoice.DueDate
Description:The due date of the document.
HoldBooleanValueboolean
DAC Field:PX.Objects.AR.ARInvoice.Hold
Description:When set to "true" indicates that the document is on hold and thus cannot be released.
LastModifiedDateTimeDateTimeValueDateTime
DAC Field:PX.Objects.AR.ARInvoice.LastModifiedDateTime
Description:No description available
LinkARAccountStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.ARAccountID
Description:The identifier of the AR account to which the document should be posted. The Cash account and Year-to-Date Net Income account cannot be selected as the value of this field. Corresponds to the Account.AccountID field.
LinkBranchStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.BranchID
Description:The identifier of the branch to which the document belongs. Corresponds to the Branch.BranchID field.
LocationIDStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.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.
PostPeriodStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.FinPeriodID
Description:Financial Period of the document. Defaults to the period, to which the ARRegister.DocDate belongs, but can be overriden by user.
ProjectStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.ProjectID
Description:The identifier of the project associated with the document or the non-project code, which indicates that the document is not related to any particular project. Corresponds to the PMProject.ProjectID field.
ReferenceNbrStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.RefNbr
Description:The reference number of the document. This field is a part of the compound key of the document. For most document types, the reference number is generated automatically from the corresponding numbering sequence, which is specified in the Accounts Receivable module preferences.
StatusStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.Status
Description:The status of the document. The value of the field is determined by the values of the status flags, such as Hold, CRCaseStatusesAttribute.Released, Voided, Scheduled. The field can have one of the values described in ARDocStatus.ListAttribute. Defaults to ARDocStatus.Hold.
ShipToContactDocContactDocContact
DAC Field:Not mapped to a DAC field
Description:No description available
ShipToContactOverrideBooleanValueboolean
DAC Field:PX.Objects.AR.ARShippingContact.OverrideContact
Description:If set to "true", indicates that the contact overrides the default Contact record referenced by the CustomerContactID field. This field is the inverse of IsDefaultContact.
TaxDetailsListInvoiceTaxDetail
DAC Field:Not mapped to a DAC field
Description:No description available
IsTaxValidBooleanValueboolean
DAC Field:PX.Objects.AR.ARInvoice.ExternalTaxesImportInProgress
Description:No description available
TaxTotalDecimalValuedecimal
DAC Field:PX.Objects.AR.ARInvoice.CuryTaxTotal
Description:The total amount of tax associated with the document. Given in the currency of the document.
TermsStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.TermsID
Description:The identifier of the Credit Terms object associated with the document. Defaults to the credit terms that are selected for the customer. Corresponds to the Terms.TermsID field.
TypeStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.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 ARInvoiceType.ListAttribute.

Minimum Payload

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

4 required fields
{
  "Customer": {
    "value": "string"
  },
  "LinkARAccount": {
    "value": "string"
  },
  "PostPeriod": {
    "value": "string"
  },
  "Type": {
    "value": "string"
  },
  "Details": [
    {}
  ]
}

1 property could not be judged statically and is omitted; see the full properties table.

Details is the detail-lines collection (InvoiceDetail); one example row is included above because a document usually has lines, and no field of the row itself could be shown to be required on insert — the keys a line is identified by are defaulted from the parent record.

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.

Available in Versions