Auto-Apply Vendor Credit
POST/api/vendor-credits/:vendor_credit/auto-apply
Automatically apply the credit's remaining balance to the supplier's oldest open purchase invoices (bills), oldest first, until the balance is exhausted or no eligible bills remain. No request body is required.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns the allocations that were created. Returns 422 when nothing can be applied (e.g. no remaining balance or no open bills for the supplier).
Only bills in the credit's own currency are settled. When bills in other currencies were passed over, the success message says so ("Applied credit to 1 bill. Skipped 1 open bill in EUR — a credit only settles bills in its own currency (USD)."). When the only open bills are in other currencies the request is refused with 422 naming them.
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.