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.
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.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.