Allocate to Purchase Invoice
POST/api/vendor-credits/:vendor_credit/allocate
Allocate part or all of the vendor credit's remaining balance to a purchase invoice (bill).
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Required fields:
purchase_invoice_id(int) — Must exist.amount(float, >= 0.01) — Amount to allocate. Cannot exceed the credit's remaining balance or what the bill still owes (its total with tax, less payments, deposits and credits already applied) — a vendor credit can't take a bill below zero. A bill that is already fully settled takes no more credit.
Optional fields:
allocated_at(date) — Defaults to now.notes(string)
The allocation reduces the bill's outstanding amount. The response includes the new allocation with its purchase invoice and allocator user.
Validation errors return 422 with the field errors under errors: a bill of another supplier or another currency (purchase_invoice_id), or an amount above the credit's remaining balance or the bill's outstanding balance (amount).
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.