Skip to main content
API Family:Default
Version:22.200.001
Screen ID:AP301000

Properties

Select a row for its DAC field and description
PropertyTypeData Type
AmountDecimalValuedecimal
DAC Field:PX.Objects.AP.APInvoice.CuryOrigDocAmt
Description:The amount to be paid for the document in the currency of the document. (See CuryID)
ApplicationsListBillApplicationDetail
DAC Field:Not mapped to a DAC field
Description:No description available
ApprovedForPaymentBooleanValueboolean
DAC Field:PX.Objects.AP.APInvoice.PaySel
Description:When set to "true" indicates that the document is approved for payment.
BalanceDecimalValuedecimal
DAC Field:PX.Objects.AP.APInvoice.CuryDocBal
Description:The balance of the Accounts Payable document after tax (if inclusive) and the discount in the currency of the document. (See CuryID)
BranchIDStringValuestring
DAC Field:PX.Objects.AP.APInvoice.BranchID
Description:Identifier of the Branch, to which the document belongs. Corresponds to the Branch.BranchID field.
CashAccountStringValuestring
DAC Field:PX.Objects.AP.APInvoice.PayAccountID
Description:The cash account used for the payment. Defaults to the cash account associated with the selected location and payment method. In case such account is not found the default value will be the cash account which is specified as default for AP for the selected payment method.
CurrencyIDStringValuestring
DAC Field:PX.Objects.AP.APInvoice.CuryID
Description:Code of the Currency of the document. Defaults to the company's base currency.
DateDateTimeValueDateTime
DAC Field:PX.Objects.AP.APInvoice.DocDate
Description:Date of the document.
DescriptionStringValuestring
DAC Field:PX.Objects.AP.APInvoice.DocDesc
Description:Description of the document.
DetailsListBillDetail
DAC Field:Not mapped to a DAC field
Description:No description available
DueDateDateTimeValueDateTime
DAC Field:PX.Objects.AP.APInvoice.DueDate
Description:The date when payment for the document is due in accordance with the credit terms.
HoldBooleanValueboolean
DAC Field:PX.Objects.AP.APInvoice.Hold
Description:When set to "true" indicates that the document is on hold and thus cannot be released.
LocationIDStringValuestring
DAC Field:PX.Objects.AP.APInvoice.VendorLocationID
Description:Identifier of the Location of the Vendor, associated with the document. Corresponds to the Location.LocationID field. Defaults to vendor's default location.
PostPeriodStringValuestring
DAC Field:PX.Objects.AP.APInvoice.FinPeriodID
Description:Financial Period of the document. Defaults to the period, to which the APRegister.DocDate belongs, but can be overriden by user.
ProjectStringValuestring
DAC Field:PX.Objects.AP.APInvoice.ProjectID
Description:No description available
ReferenceNbrStringValuestring
DAC Field:PX.Objects.AP.APInvoice.RefNbr
Description:Reference number of the document.
StatusStringValuestring
DAC Field:PX.Objects.AP.APInvoice.Status
Description:The status of the document. The field is calculated based on the values of the status flag. It can't be changed directly. The following fields determine the status of the document: Hold, Released, Voided, Scheduled, Prebooked, Printed, Approved, Rejected. The field can have the following values: ""H"" - On Hold, ""B"" - Balanced, ""V"" - Voided, ""S"" - Scheduled, ""N"" - Open, ""C"" - Closed, ""P"" - Printed, ""K"" - Pre-Released, ""E"" - Pending Approval, ""R"" - Rejected, ""Z"" - Reserved. The value defaults to On Hold.
TaxDetailsListBillTaxDetail
DAC Field:Not mapped to a DAC field
Description:No description available
TaxTotalDecimalValuedecimal
DAC Field:PX.Objects.AP.APInvoice.CuryTaxTotal
Description:The total amount of taxes associated with the document. (Presented in the currency of the document, see CuryID)
TermsStringValuestring
DAC Field:PX.Objects.AP.APInvoice.TermsID
Description:The credit terms associated with the document (unavailable for prepayments and debit adjustments).\ Defaults to the credit terms of the vendor.
TypeStringValuestring
DAC Field:PX.Objects.AP.APInvoice.DocType
Description:Type of the document. Possible values are: "INV" - Invoice, "ACR" - Credit Adjustment, "ADR" - Debit Adjustment, "PPM" - Prepayment, "PPI" - Prepayment Invoice
VendorStringValuestring
DAC Field:PX.Objects.AP.APInvoice.VendorID
Description:Identifier of the Vendor, whom the document belongs to.
VendorRefStringValuestring
DAC Field:PX.Objects.AP.APInvoice.InvoiceNbr
Description:The document’s original reference number as assigned by the vendor (for informational purposes). The reference to the vendor document is required if APSetup.RequireVendorRef is set to "true". The reference should also be unique if APSetup.RaiseErrorOnDoubleInvoiceNbr is set to "true".
LastModifiedDateTimeDateTimeValueDateTime
DAC Field:PX.Objects.AP.APInvoice.LastModifiedDateTime
Description:No description available

Minimum Payload

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

3 required fields
{
  "PostPeriod": {
    "value": "string"
  },
  "Type": {
    "value": "string"
  },
  "Vendor": {
    "value": "string"
  },
  "Details": [
    {}
  ]
}

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

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

  • TaxDetailsa list of BillTaxDetailrequired if you include one:TaxID

Available in Versions