What can we help you find? Products Coupa Product Documentation Integration Technical Documentation Coupa Core Flat Files (CSV) Flat File (CSV) Export Payables :: Allocation

Payables :: Allocation

Coupa Payables::Allocation CSV export and import format allows reporting and transfer of allocation amounts from one source document to another.

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.

Column Name	Description	Req'd	Unique	Type	Allowable Values
type	Describes the type of row	false	false		any
id	Coupa ID of allocation. Only used for reversing allocations. No other updates are allowed.	false	false	integer	any
payable-from-id	ID of payable sending the allocation. When figuring out which payable to attach the allocation to, we will first try to use payable-to-id, then source-transaction-from-id (e.g. an invoice-id or order-id), then source-transaction-reference (e.g. invoice-number). Only one of the three needs to be provided. This is true for both the From and To payables.	false	false	integer	any
payable-from-type	Type of payable sending the allocation. When figuring out which payable type we’re looking for, we accept the following values: invoice, milestone, expense, expense_preapproval, virtual_card_expense_preapproval, trip_booking, external_payable, supplier_payable, employee_payable.	false	false	string(255)	any
payable-from-amount	Amount to allocate from Payable From document	true	false	decimal(46,20)	any
payable-from-currency	Currency of the sending payable	true	false		any
payable-from-currency-code	Currency code of the payable				any
source-transaction-from-id	Source transaction ID of the sending payable	false	false		any
source-transaction-from-type	Source Transaction type of the sending payable	false	false		any
source-transaction-from-reference	Source Transaction Reference. External identifier of document associated with the payable from. Order number, invoice number, etc	false	false		any
payable-to-id	Coupa ID of payable receiving the allocation. When figuring out which payable to attach the allocation to, we will first try to use payable-to-id, then source-transaction-from-id (e.g. an invoice-id), then source-transaction-reference (e.g. invoice-number). Only one of the three needs to be provided. This is true for both the From and To payables.	false	false	integer	any
payable-to-type	Type of payable receiving the allocation. Allocating a milestone (attached to an order) to an invoice is the first supported use case.	false	false	string(255)	Any of the following values: invoice, milestone, expense, expense_preapproval, virtual_card_expense_preapproval, trip_booking, external_payable, supplier_payable, or employee_payable.
payable-to-amount	Amount of received allocation in the currency of the receiving payable	true	false	decimal(46,20)	any
payable-to-currency	Currency of the receiving payable	false	false		any
payable-to-currency-code	Currency code of the receiving payable				any
source-transaction-to-id	Coupa source transaction ID of the receiving payable.	true	false		any
source-transaction-to-type	Source transaction type of the receiving payable	false	false		any
source-transaction-to-reference	External identifier, source transaction reference of the receiving payable.	false	false		any
status	Status of the allocation.	false	false	string(255)	Allowable values: draft, committed, batched, voided, completed
source	The source that created this allocation. Allowable values include: erp, coupa_pay, UI, api, or csv	false	false	string(255)	Allowable values: coupa_pay, erp, ui, api, csv
reason-code	Why this allocation was created. Valid values are: payment, auto_payment, epr, epr_rejected, or manual	false	false	string(40)	payment, auto_payment, epr, epr_rejected, manual
payment-reference-id	Coupa reference ID of the payment	false	false	integer	any
payment-reference-type	Type of the payment reference	false	false	string(255)	any
last-exported-at	Last date-time the allocation was exported	false	false	datetime	any
reverse	Flag indicating whether the allocation should be reversed. If this is provided, ID must also be provided and no other values are considered. When “reverse” is "true" and an ID is provided, we will ignore all other values and back out the referenced allocation (including creating an offsetting reconciliation line). This is the ONLY modification that is allowed on an allocation. In all other cases, ID is ignored.			boolean	Values of true, t, yes, y, or 1 will indicate that the allocation should be reversed. An empty value, false, f, no, n, or 0 will indicate that the allocation should not be reversed.