Invoice
31 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 | InvoiceApplicationsCreditMemo | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
ApplicationsDefault | List | InvoiceApplicationsDefault | |
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. | |||
BillingPrinted | BooleanValue | boolean | |
DAC Field: PX.Objects.AR.ARInvoice.PrintedDescription:Specifies (if set to "true") that the document has been printed. | |||
BillToContact | DocContact | DocContact | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
BillToContactOverride | BooleanValue | boolean | |
DAC Field: PX.Objects.AR.ARContact.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. | |||
CreatedDateTime | DateTimeValue | DateTime | |
DAC Field: PX.Objects.AR.ARInvoice.CreatedDateTimeDescription:No description available | |||
Customer | 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 | InvoiceDetail | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
DiscountDetails | List | InvoiceDiscountDetail | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
DueDate | DateTimeValue | DateTime | |
DAC Field: PX.Objects.AR.ARInvoice.DueDateDescription:The due date 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 | |||
LinkARAccount | StringValue | string | |
DAC Field: PX.Objects.AR.ARInvoice.ARAccountIDDescription: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. | |||
LinkBranch | StringValue | string | |
DAC Field: PX.Objects.AR.ARInvoice.BranchIDDescription:The identifier of the branch to which the document belongs. Corresponds to the Branch.BranchID field. | |||
LocationID | StringValue | string | |
DAC Field: PX.Objects.AR.ARInvoice.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. | |||
PostPeriod | StringValue | string | |
DAC Field: PX.Objects.AR.ARInvoice.FinPeriodIDDescription:Financial Period of the document. Defaults to the period, to which the ARRegister.DocDate belongs, but can be overriden by user. | |||
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. | |||
ShipToContact | DocContact | DocContact | |
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. | |||
TaxDetails | List | InvoiceTaxDetail | |
DAC Field:Not mapped to a DAC field Description:No description available | |||
IsTaxValid | BooleanValue | boolean | |
DAC Field: PX.Objects.AR.ARInvoice.ExternalTaxesImportInProgressDescription: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. | |||
Terms | StringValue | string | |
DAC Field: PX.Objects.AR.ARInvoice.TermsIDDescription: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. | |||
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. | |||
Minimum Payload
Derived from static analysis of the 2025.2 source; runtime configuration may require additional 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.
ApplicationsCreditMemoa list ofInvoiceApplicationsCreditMemorequired if you include one:CustomerReferenceNbrApplicationsDefaulta list ofInvoiceApplicationsDefaultrequired if you include one:DocTypeReferenceNbrDiscountDetailsa list ofInvoiceDiscountDetailrequired if you include one:DiscountCodeSequenceIDTypeTaxDetailsa list ofInvoiceTaxDetailrequired if you include one:TaxID