Skip to main content

List Billing Invoices

GET 
/api/shipbob/:instance/invoices

List ShipBob invoices with reconciliation columns: ShipBob's amount, the sum and count of member transactions, how much is attributed / unattributed / excluded / pending, the variance, a reconciliation status (reconciled when |variance| < 0.01, variance, or awaiting_transactions), a shipbob_url deep link, and accounting_posting: status (posted, draft, pending, blocked, not_posted, or disabled when the instance does not post invoices or the invoice is a Payment), label, error (why posting is blocked, e.g. a locked accounting period), journal_entry_id, journal_entry_status, posted_at and reference.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Filterable columns:

  • Text: invoice_type, reconciliation_status, currency_code.
  • Numeric: id, shipbob_invoice_id, amount, transactions_total.
  • Date: invoice_date.
  • filter[search] matches id, invoice # or type.

Filtering uses the canonical filter tree: send filter_groups as base64-encoded JSON {"conjunction":"and","children":[{"type":"condition","condition":{"column":"invoice_type","operator":"is","value":"Shipping"}}]}, or flat filter[column.operator]=value params. Text operators: contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, ends_with, is_empty, is_not_empty. Numeric operators: is, is_not, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_empty, is_not_empty. Date operators: is, before, after, on_or_before, on_or_after, between, today, past_week, past_month, past_days, etc.

Allowed sorts: id, shipbob_invoice_id, invoice_date, amount, transactions_total, invoice_type (default -invoice_date). Pagination: page, per_page (default 10).

Request​

Responses​

OK

Response Headers
    Content-Type