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

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.
ApplicationsCreditMemoListSalesInvoiceApplicationCreditMemo
DAC Field:Not mapped to a DAC field
Description:No description available
ApplicationsInvoiceListSalesInvoiceApplicationInvoice
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.
BillingSettingsBillToSettingsBillToSettings
DAC Field:Not mapped to a DAC field
Description:No description available
CashDiscountDecimalValuedecimal
DAC Field:PX.Objects.AR.ARInvoice.CuryOrigDiscAmt
Description:The cash discount entered for the document. Given in the currency of the document.
CommissionsSalesInvoiceCommissionsSalesInvoiceCommissions
DAC Field:Not mapped to a DAC field
Description:No description available
CreditHoldBooleanValueboolean
DAC Field:PX.Objects.AR.ARInvoice.CreditHold
Description:When set to "true" indicates that the document is on credit hold, which means that the credit check failed for the Customer. The document can't be released while it's on credit hold.
CurrencyStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.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.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.
DetailsListSalesInvoiceDetail
DAC Field:Not mapped to a DAC field
Description:No description available
DetailTotalDecimalValuedecimal
DAC Field:PX.Objects.AR.ARInvoice.CuryLineTotal
Description:The total amount of the lines of the document. Given in the currency of the document.
DiscountDetailsListSalesInvoiceDiscountDetails
DAC Field:Not mapped to a DAC field
Description:No description available
DiscountTotalDecimalValuedecimal
DAC Field:PX.Objects.AR.ARInvoice.CuryDiscTot
Description:The group and document discount total for the document. Given in the currency of the document.
DueDateDateTimeValueDateTime
DAC Field:PX.Objects.AR.ARInvoice.DueDate
Description:The due date of the document.
IsTaxValidBooleanValueboolean
DAC Field:PX.Objects.AR.ARInvoice.ExternalTaxesImportInProgress
Description:No description available
FinancialDetailsSalesInvoiceFinancialDetailsSalesInvoiceFinancialDetails
DAC Field:Not mapped to a DAC field
Description:No description available
FreightDetailsListSalesInvoiceFreightDetail
DAC Field:Not mapped to a DAC field
Description:No description available
FreightPriceDecimalValuedecimal
DAC Field:PX.Objects.AR.ARInvoice.CuryFreightAmt
Description:The amount of freight associated with the document. Given in the currency 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
PaymentTotalDecimalValuedecimal
DAC Field:PX.Objects.AR.ARInvoice.CuryPaymentTotal
Description:No description available
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.
TaxDetailsListSalesInvoiceTaxDetail
DAC Field:Not mapped to a DAC field
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.
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.
VATExemptTotalDecimalValuedecimal
DAC Field:PX.Objects.AR.ARInvoice.CuryVatExemptTotal
Description:The portion of the document total that is exempt from VAT. Given in the currency of the document. This field is relevant only if the VAT Reporting feature is enabled. The value of this field is calculated as the taxable amount for the tax with Tax.ExemptTax set to "true".
VATTaxableTotalDecimalValuedecimal
DAC Field:PX.Objects.AR.ARInvoice.CuryVatTaxableTotal
Description:The portion of the document total that is subjected to VAT. Given in the currency of the document. This field is relevant only if the VAT Reporting feature is enabled.
BillToAddressSalesInvoiceAddressSalesInvoiceAddress
DAC Field:Not mapped to a DAC field
Description:No description available
BillToAddressOverrideBooleanValueboolean
DAC Field:Not mapped to a DAC field
Description:No description available
BillToContactSalesInvoiceDocContactSalesInvoiceDocContact
DAC Field:Not mapped to a DAC field
Description:No description available
BillToContactOverrideBooleanValueboolean
DAC Field:Not mapped to a DAC field
Description:No description available
CreatedDateDateTimeValueDateTime
DAC Field:PX.Objects.AR.ARInvoice.CreatedDateTime
Description:No description available
ExternalRefStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.ExternalRef
Description:No description available
LastModifiedDateDateTimeValueDateTime
DAC Field:PX.Objects.AR.ARInvoice.LastModifiedDateTime
Description:No description available
ShipToAddressSalesInvoiceAddressSalesInvoiceAddress
DAC Field:Not mapped to a DAC field
Description:No description available
ShipToAddressOverrideBooleanValueboolean
DAC Field:PX.Objects.AR.ARShippingAddress.OverrideAddress
Description:If set to "true", indicates that the address overrides the default Address record, which is referenced by CustomerAddressID. This field is the inverse of IsDefaultBillAddress.
ShipToContactSalesInvoiceDocContactSalesInvoiceDocContact
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.
TaxCalcModeStringValuestring
DAC Field:PX.Objects.AR.ARInvoice.TaxCalcMode
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"
  },
  "Details": [
    {}
  ]
}

For every property this entity accepts, see the properties table.

Details is the detail-lines collection (SalesInvoiceDetail); 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