Payables :: Allocation

Allocations move the payment responsibility from one document to another. Our first use case is to allocate a prepayment (milestone) for an order to the associated invoice, so that it will not be overpaid. The format is set up so that we can allocate from any type of payable document to any type of payable document. We built in enough flexibility to allow integration to reference the source documents (e.g. order milestone and invoice) rather than needing to dig up the associated “payable” ids.

Payable Allocation

Field NameDescriptionField TypeRequired/UniquePossible Values
typeDescribes the type of rowNo/No
idIDintegerNo/No
payable-from-idID of payable sending the allocationintegerNo/No
payable-from-typeType of payable sending the allocationstring(255)No/No
payable-from-amountAmount of sent allocation in the sender's currencydecimal(46,20)Yes/No
payable-from-currencyCurrency of the sending payableYes/No
source-transaction-from-idSource transaction ID of the sending payableNo/No
source-transaction-from-typeSource Transaction type of the sending payableNo/No
source-transaction-from-referenceSource Transaction ReferenceNo/No
payable-to-idID of payable receiving the allocationintegerNo/No
payable-to-typeType of payable receiving the allocationstring(255)No/No
payable-to-amountAmount of received allocation in the receiver's currencydecimal(46,20)Yes/No
payable-to-currencyCurrency of the receiving payableYes/No
source-transaction-to-idSource transaction ID of the receiving payableNo/No
source-transaction-to-typeSource transaction type of the receiving payableNo/No
source-transaction-to-referenceSource transaction reference of the receiving payableNo/No
statusStatusstring(255)No/No
sourceOne of erp, coupa_pay, uistring(255)No/Nocoupa_pay, erp, ui, api, csv, early_pay_discount
reason-codeOne of payment, auto_payment, epr, epr_rejected, manualstring(40)No/Nopayment, auto_payment, epr, epr_rejected, manual
payment-reference-idReference ID of the payamentintegerNo/No
payment-reference-typeType of the payment referencestring(255)No/No
last-exported-atLast date the allocation was exporteddatetimeNo/No