Skip to main content

Submit Bill Payment for Approval

POST 
/api/purchase-invoices/:purchaseInvoice/payment-request/submit

Submit a bill's outstanding balance for payment authorization. Routes the request to the appropriate approval chain, designated payer, or auto-approves it depending on configuration and amount.

Required scope: purchase-orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

This endpoint has no request body — the outstanding balance is used automatically. Returns the updated bill including its payment approval status and generated approval steps.

Returns 422 when the invoice is a committed-spend (provisional) bill.

Approval policy: While the bill-payment approval policy is enabled the outstanding balance is routed through the policy. If you could approve every step yourself the request completes in the same call; otherwise it waits on the policy's approvers. A bill that already has an approved amount can be submitted again for an increase — the earlier approval keeps covering what it authorized.

Approval levels are compared with the bill's outstanding balance in your home currency (balance × the bill's rate), not the document-currency figure. home_currency_code in the response names that currency.

supplier_bank_details_verified counts only verifications made since the supplier's bank details last changed; supplier_bank_details_changed_at (ISO 8601, null when no change has been recorded) says when that was.

Request​

Responses​

OK

Response Headers
    Content-Type