GET
/
invoices
/
{invoiceId}
/
transactions
Get transactions by invoiceId
curl --request GET \
  --url https://api.shipbob.com/experimental/invoices/{invoiceId}/transactions \
  --header 'Authorization: Bearer <token>'
{
  "first": "f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjre",
  "items": [
    {
      "additionalDetails": {
        "InvoiceAdditionalDetails": "TestInvoice"
      },
      "amount": 0.09,
      "currencyCode": "USD",
      "fulfillmentCenter": "Altona VIC",
      "insertDate": "2025-01-01",
      "invoiceDate": "2025-01-01",
      "invoiceId": 12345,
      "invoiceType": "Shipping",
      "invoiced": true,
      "referenceId": "12345",
      "referenceType": "Shipment",
      "taxes": [
        {
          "taxAmount": 0.1,
          "taxRate": 0.1,
          "taxType": "GST"
        }
      ],
      "transactionFee": "Shipping",
      "transactionType": "Charge"
    }
  ],
  "last": "f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjqt",
  "next": "f8cUk/xjhyEYp2L8oHqxL2hFiGz3qjqt",
  "prev": "f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjcc"
}

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Path Parameters

​
invoiceId
string
required

The unique identifier of the invoice whose transactions are to be retrieved.

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.

​
pageSize
number

Number of transactions 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.