Bulk Archive Vendor Credits

PUT 
/api/vendor-credits/archive

Bulk archive vendor credits.

Required scope: accounting:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Body (either form):

{ "ids": [1, 2, 3] }

or apply-to-all with filters:

{ "apply_to_all": true, "filters": { "supplier_id": 5 } }

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.

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.