Get Bills Summary
GET/api/shipbob/:instance/bills/summary
Totals for a charge-date range: per-fee rows in the same shape as the Trackstar bills summary (charge_type, total_amount, bill_count, currency_code, plus share of the billed cost), the attribution breakdown (on orders, on products, on purchase orders, pending, unattributed, excluded payments, unattributed by reason, billed-vs-estimated freight variance) and the unattributed work queue grouped by reason and sales channel with a suggested action.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Query: from / to (date, Y-m-d; default the last 30 days; to must be on or after from).
currency_code is the tenant currency every total, attribution amount and share is expressed in (per-fee total_amount stays in that fee's billing currency_code).
unconverted lists bills whose charge-date exchange rate is not published yet, grouped by billed currency (currency_code, amount, count). They are left out of every tenant-currency total, and an item's amount_in_tenant_currency is null when none of its bills could be converted yet.
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.