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).

Required scope: accounting:write

Grant 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 the bill's outstanding balance.

Optional fields:

• allocated_at (date) — Defaults to now.
• notes (string)

The allocation is recorded on vendor_credit_allocations and reduces the bill's outstanding amount. The response includes the new allocation with its purchase invoice and allocator user.

Request

Responses

200

Successful response

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

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.