COcoupa
Payables-Allocation

/payables/allocations

post/payables/allocations

Request

  • Base URL
    https://r38.coupadev.com/api
  • Auth
    • OAuth 2
      Authorization codehttps://r38.coupadev.com/oauth2/authorizations/new
      Token URLhttps://r38.coupadev.com/oauth2/token
    • or OAuth 2
      Client credentials
      Token URLhttps://r38.coupadev.com/oauth2/access_tokens
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

return_object'limited' | 'shallow' | 'none'
filterstring

Request body

bypass-strict-validationsboolean

Flag indicating that this allocation is confirmed to be correct. Skips overallocation validations

created-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

exported?boolean

Flag indicating whether the transaction has been exported to an external system

idinteger

Coupa unique identifier

last-exported-atstring datetime

Date of last update to the allocation

payable-from-amountnumber required

Amount allocated in currency of the document sending the allocation

payable-from-idinteger

Coupa ID of the payable document sending the allocation

payable-from-typestring string(255)

Type of payable document sending the allocation

payable-to-amountnumber required

Amount allocated in currency of the document receiving the allocation

payable-to-idinteger

Coupa ID of the payable document receiving the allocation

payable-to-typestring string(255)

Type of payable document receiving the allocation

payment-reference-idinteger

Coupa ID of payment reference

payment-reference-typestring string(255)

Type of payment reference

reason-code'payment' | 'auto_payment' | 'epr' | 'epr_rejected' | 'manual' string(40)

Code indicating the trigger for this allocation

source'coupa_pay' | 'erp' | 'ui' | 'api' | 'csv' | 'early_pay_discount' string(255)

Originating system (ERP, Coupa Pay, UI, etc)

source-transaction-from-idstring string

Coupa ID of the source transaction on the sending side

source-transaction-from-referencestring string

Reference number of the source transaction on the sending side

source-transaction-from-typestring string

Type of the source transaction on the sending side

source-transaction-to-idstring string

Coupa ID of the source transaction on the receiving side

source-transaction-to-referencestring string

Reference number of the source transaction on the receiving side

source-transaction-to-typestring string

Type of the source transaction on the receiving side

statusstring string(255)

Current status of the allocation

updated-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

Response

Created

bypass-strict-validationsboolean

Flag indicating that this allocation is confirmed to be correct. Skips overallocation validations

created-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

exported?boolean

Flag indicating whether the transaction has been exported to an external system

idinteger

Coupa unique identifier

last-exported-atstring datetime

Date of last update to the allocation

payable-from-amountnumber required

Amount allocated in currency of the document sending the allocation

payable-from-idinteger

Coupa ID of the payable document sending the allocation

payable-from-typestring string(255)

Type of payable document sending the allocation

payable-to-amountnumber required

Amount allocated in currency of the document receiving the allocation

payable-to-idinteger

Coupa ID of the payable document receiving the allocation

payable-to-typestring string(255)

Type of payable document receiving the allocation

payment-reference-idinteger

Coupa ID of payment reference

payment-reference-typestring string(255)

Type of payment reference

reason-code'payment' | 'auto_payment' | 'epr' | 'epr_rejected' | 'manual' string(40)

Code indicating the trigger for this allocation

source'coupa_pay' | 'erp' | 'ui' | 'api' | 'csv' | 'early_pay_discount' string(255)

Originating system (ERP, Coupa Pay, UI, etc)

source-transaction-from-idstring string

Coupa ID of the source transaction on the sending side

source-transaction-from-referencestring string

Reference number of the source transaction on the sending side

source-transaction-from-typestring string

Type of the source transaction on the sending side

source-transaction-to-idstring string

Coupa ID of the source transaction on the receiving side

source-transaction-to-referencestring string

Reference number of the source transaction on the receiving side

source-transaction-to-typestring string

Type of the source transaction on the receiving side

statusstring string(255)

Current status of the allocation

updated-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

Changes

No recorded changes to this operation across all 1 revision of this API.