GET
/
invoices
Get Invoices
curl --request GET \
  --url https://api.shipbob.com/experimental/invoices \
  --header 'Authorization: Bearer <token>'
{
  "first": "m8cUk/xJkbeYp2JJvL8oHqxL2hFuGz3qjqtkQ",
  "items": [
    {
      "amount": 0.01,
      "currencyCode": "USD",
      "invoiceDate": "2019-08-24",
      "invoiceId": 12345,
      "invoiceType": "Shipping",
      "runningBalance": 123.01
    }
  ],
  "last": "n8cUk/xJkbeYp2JJvL8oHqxL2hFiGz3qjqtkQ",
  "next": "m8cUk/xJkbeYp2JhvL8oHqxL3hFiGz3qjqtkQ",
  "prev": "m8cUk/xJkbeYp2JJvL8oHqxL2hFvGz3qjqtkQ"
}

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Query Parameters

​
cursor
string

Optional cursor for paginated results.It is a random string to go to subsequest pages provided in first/prev/next/last column. If provided, pagination is based on the cursor and other filters are ignored.

​
fromDate
string

Optional start date for filtering invoices (inclusive).

​
toDate
string

Optional end date for filtering invoices (inclusive).

​
invoiceTypes
string

Optional list of invoice type identifiers to filter by.

​
pageSize
number

Number of invoices to return per page (default: 100). Must be between 1 and 100,000.

​
sortOrder
string

Sort order of the results. Valid values: Ascending or Descending (default: Descending).

Response

200
application/json

Success

The response is of type object.