GET
/
experimental
/
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": {
        "Comment": "TestInvoice"
      },
      "amount": 0.09,
      "chargeDate": "2025-01-01",
      "currencyCode": "USD",
      "fulfillmentCenter": "Altona VIC",
      "invoiceDate": "2025-01-01",
      "invoiceId": 12345,
      "invoiceType": "Shipping",
      "invoicedStatus": true,
      "referenceId": "12345",
      "referenceType": "Shipment",
      "taxes": [
        {
          "taxAmount": 0.01,
          "taxRate": 10,
          "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<int32>
required

The unique identifier of the invoice whose transactions are to be retrieved Ex:-12345.

Query Parameters

cursor
string

[Optional] A pagination token used to jump to first, last, next or previous pages. When supplied, it overrides all other filter parameters.

pageSize
number

Number of transactions to return per page (default is 100, to be entered when API is called for first time). Must be between 1 and 1000.

sortOrder
string

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

Response

Success

first
string | null

Go to the first page

items
object[] | null
last
string | null

Go to the Last page

next
string | null

Go to the Next page

prev
string | null

Go to the Previous page