Get Allocation Suggestion
GET/api/purchase-invoices/supplier-payments/allocation-suggestion
The supplier's open (unpaid or partially paid) invoices with a suggested allocation of the given total, distributed oldest due date first — the prefill for a payment run.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
paid_outside_approval is true for a payment synced from your accounting system without an approved payment request (bill payment approval policy).
Bill payment approval: when a bill payment approval policy is on, the response has bill_payment_approval_enabled: true and each purchase invoice row carries payment_approval: status (not_requested, pending, approved, rejected), approved_to_pay (the amount a payment may put on the bill right now) and needs_approval (true when the outstanding balance is more than the approved amount). The suggested amounts never exceed approved_to_pay. Landed-cost bills are outside the policy and have payment_approval: null. When the policy is off, bill_payment_approval_enabled is false and payment_approval is null on every row.
Request
Responses
- 200
- 401
- 403
- 429
OK
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.
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.