SalesInvoice
45 properties
Properties
Select a row for its DAC field and description| Property | Type | Data Type | |
|---|---|---|---|
Amount | DecimalValue | decimal | |
DAC Field: PX.Objects.AR.ARInvoice.CuryOrigDocAmtDescription:The amount of the document. Given in the currency of the document. | |||
ApplicationsCreditMemo | List | SalesInvoiceApplicationCreditMemo | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
ApplicationsInvoice | List | SalesInvoiceApplicationInvoice | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
Balance | DecimalValue | decimal | |
DAC Field: PX.Objects.AR.ARInvoice.CuryDocBalDescription:The open balance of the document. Given in the currency of the document. | |||
BillingSettings | BillToSettings | BillToSettings | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
CashDiscount | DecimalValue | decimal | |
DAC Field: PX.Objects.AR.ARInvoice.CuryOrigDiscAmtDescription:The cash discount entered for the document. Given in the currency of the document. | |||
Commissions | SalesInvoiceCommissions | SalesInvoiceCommissions | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
CreditHold | BooleanValue | boolean | |
DAC Field: PX.Objects.AR.ARInvoice.CreditHoldDescription: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. | |||
Currency | StringValue | string | |
DAC Field: PX.Objects.AR.ARInvoice.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.ARInvoice.CustomerIDDescription:The identifier of the Customer record associated with the document. Corresponds to the BAccount.BAccountID field. | |||
CustomerOrder | StringValue | string | |
DAC Field: PX.Objects.AR.ARInvoice.InvoiceNbrDescription:The original reference number or ID assigned by the customer to the customer document. | |||
Date | DateTimeValue | DateTime | |
DAC Field: PX.Objects.AR.ARInvoice.DocDateDescription:The date of the document. Defaults to the current Business Date. | |||
Description | StringValue | string | |
DAC Field: PX.Objects.AR.ARInvoice.DocDescDescription:The description of the document. | |||
Details | List | SalesInvoiceDetail | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
DetailTotal | DecimalValue | decimal | |
DAC Field: PX.Objects.AR.ARInvoice.CuryLineTotalDescription:The total amount of the lines of the document. Given in the currency of the document. | |||
DiscountDetails | List | SalesInvoiceDiscountDetails | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
DiscountTotal | DecimalValue | decimal | |
DAC Field: PX.Objects.AR.ARInvoice.CuryDiscTotDescription:The group and document discount total for the document. Given in the currency of the document. | |||
DueDate | DateTimeValue | DateTime | |
DAC Field: PX.Objects.AR.ARInvoice.DueDateDescription:The due date of the document. | |||
IsTaxValid | BooleanValue | boolean | |
DAC Field: PX.Objects.AR.ARInvoice.ExternalTaxesImportInProgressDescription:No description available | |||
FinancialDetails | SalesInvoiceFinancialDetails | SalesInvoiceFinancialDetails | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
FreightDetails | List | SalesInvoiceFreightDetail | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
FreightPrice | DecimalValue | decimal | |
DAC Field: PX.Objects.AR.ARInvoice.CuryFreightAmtDescription:The amount of freight associated with the document. Given in the currency of the document. | |||
Hold | BooleanValue | boolean | |
DAC Field: PX.Objects.AR.ARInvoice.HoldDescription:When set to "true" indicates that the document is on hold and thus cannot be released. | |||
LastModifiedDateTime | DateTimeValue | DateTime | |
DAC Field: PX.Objects.AR.ARInvoice.LastModifiedDateTimeDescription:No description available | |||
PaymentTotal | DecimalValue | decimal | |
DAC Field: PX.Objects.AR.ARInvoice.CuryPaymentTotalDescription:No description available | |||
Project | StringValue | string | |
DAC Field: PX.Objects.AR.ARInvoice.ProjectIDDescription: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. | |||
ReferenceNbr | StringValue | string | |
DAC Field: PX.Objects.AR.ARInvoice.RefNbrDescription: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. | |||
Status | StringValue | string | |
DAC Field: PX.Objects.AR.ARInvoice.StatusDescription: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. | |||
TaxDetails | List | SalesInvoiceTaxDetail | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
TaxTotal | DecimalValue | decimal | |
DAC Field: PX.Objects.AR.ARInvoice.CuryTaxTotalDescription:The total amount of tax associated with the document. Given in the currency of the document. | |||
Type | StringValue | string | |
DAC Field: PX.Objects.AR.ARInvoice.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 ARInvoiceType.ListAttribute. | |||
VATExemptTotal | DecimalValue | decimal | |
DAC Field: PX.Objects.AR.ARInvoice.CuryVatExemptTotalDescription: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". | |||
VATTaxableTotal | DecimalValue | decimal | |
DAC Field: PX.Objects.AR.ARInvoice.CuryVatTaxableTotalDescription: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. | |||
BillToAddress | SalesInvoiceAddress | SalesInvoiceAddress | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
BillToAddressOverride | BooleanValue | boolean | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
BillToContact | SalesInvoiceDocContact | SalesInvoiceDocContact | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
BillToContactOverride | BooleanValue | boolean | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
CreatedDate | DateTimeValue | DateTime | |
DAC Field: PX.Objects.AR.ARInvoice.CreatedDateTimeDescription:No description available | |||
ExternalRef | StringValue | string | |
DAC Field: PX.Objects.AR.ARInvoice.ExternalRefDescription:No description available | |||
LastModifiedDate | DateTimeValue | DateTime | |
DAC Field: PX.Objects.AR.ARInvoice.LastModifiedDateTimeDescription:No description available | |||
ShipToAddress | SalesInvoiceAddress | SalesInvoiceAddress | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
ShipToAddressOverride | BooleanValue | boolean | |
DAC Field: PX.Objects.AR.ARShippingAddress.OverrideAddressDescription: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. | |||
ShipToContact | SalesInvoiceDocContact | SalesInvoiceDocContact | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
ShipToContactOverride | BooleanValue | boolean | |
DAC Field: PX.Objects.AR.ARShippingContact.OverrideContactDescription: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. | |||
TaxCalcMode | StringValue | string | |
DAC Field: PX.Objects.AR.ARInvoice.TaxCalcModeDescription: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"
},
"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.
ApplicationsCreditMemoa list ofSalesInvoiceApplicationCreditMemorequired if you include one:CustomerReferenceNbrApplicationsInvoicea list ofSalesInvoiceApplicationInvoicerequired if you include one:AdjustingDocReferenceNbrAdjustmentNbrCustomerDocTypesupplied by the parent:AdjustedDocReferenceNbrDocumentTypeDiscountDetailsa list ofSalesInvoiceDiscountDetailsrequired if you include one:DiscountCodeSequenceIDTypeFreightDetailsa list ofSalesInvoiceFreightDetailrequired if you include one:ShipmentNbrShipmentTypeTaxDetailsa list ofSalesInvoiceTaxDetailrequired if you include one:TaxID