List Invoices
GET/api/portal/invoices
List the active account's invoices (open and paid).
Called by a B2B portal buyer with the bearer token POST /api/portal/auth/login returns (or the buyer's feed key) — not with a staff Personal Access Token.
Authentication: Bearer token (Personal Access Token).
Filtering: filter[status]=open|paid selects the balance view. Pass other column filters as filter[<column>] or filter[<column>.<operator>]. For AND/OR logic use filter_groups (base64-encoded JSON tree). Free-text search uses filter[search], optionally scoped via search_columns / search_strict_columns.
Sorting: sort=<field>, prefix - for descending. Allowed: id, order_date, payment_status, sales_order_number, created_at.
Pagination: page (default 1), per_page (default 10, max 100).
Which orders: by default every order the account has, whatever channel it came through (the portal, the merchant's store, phone or email orders entered by staff) — another channel's draft orders are never shown. A merchant can limit this to orders placed in the portal (Portal Settings → Order history).
Request
Responses
- 200
- 401
- 403
- 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.
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.