Get Consignment Statement of Account
GET/api/consignment/suppliers/:supplier/statement
A rolling balance-forward statement of account for a supplier's consignment settlements: opening balance, each settlement with amount / paid / outstanding and a running balance, and the closing balance. The summary also reports the consignment liability that has accrued from sales but has not yet been settled.
Optionally window the statement with date_from / date_to (m/d/Y or Y-m-d): settlements before date_from roll into the opening balance; settlements after date_to are excluded.
Authentication: Requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.