Skip to main content

Approve and Pay Bill

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

Approve a pending bill payment request and record the payment in a single step. The payment amount defaults to the bill's outstanding balance when omitted.

Required scope: purchase-orders:write

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

Authentication: Requires Bearer token.

Fields:

  • amount (optional, numeric, > 0): Payment amount. Defaults to the outstanding balance.
  • payment_date (required, date): Date the payment was made.
  • currency_rate (optional, numeric, > 0): Exchange rate. Defaults to the bill's rate.
  • payment_type_id (optional, integer): Payment method ID.
  • external_reference (optional, max 255): External reference; alias 'reference' is also accepted.
  • notes (optional, max 1000): Approval notes.

Approval policy: While the bill-payment approval policy is enabled you must be eligible for the current step of the bill's payment approval request (403 approval_limit_exceeded otherwise; 409 approval_state_conflict when it was already decided). When your decision completes only your step, the response is the bill plus approval_message (e.g. "Approved your step — waiting on Step 2 (Finance).") and no payment is recorded until the request is fully approved.

Request​

Responses​

OK

Response Headers
    Content-Type