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",
      "transactionId": "01AN4Z07BY79KA1307SR9X4MV3",
      "transactionType": "Charge"
    }
  ],
  "last": "f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjqt",
  "next": "f8cUk/xjhyEYp2L8oHqxL2hFiGz3qjqt",
  "prev": "f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjcc"
}

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",
      "transactionId": "01AN4Z07BY79KA1307SR9X4MV3",
      "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<int32>

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

Show child attributes

items.additionalDetails

object

Any additional details related to the transaction in a key-value pair format.

Show child attributes

items.additionalDetails.{key}

object

items.amount

number<double> | null

Charge Amount for the transaction

Example:

0.09

items.chargeDate

string | null

The Charge date of transaction

Example:

"2025-01-01"

items.currencyCode

string | null

The ISO currency code (e.g., USD, EUR) for the transaction

Example:

"USD"

items.fulfillmentCenter

string | null

The name or code of the fulfillment center involved in the transaction.

Example:

"Altona VIC"

items.invoiceDate

string | null

The date the invoice was generated

Example:

"2025-01-01"

items.invoiceId

integer<int32> | null

The unique identifier of the related invoice.

Example:

12345

items.invoiceType

string | null

The type or category of the invoice. Available options:

Shipping
Inbound Fee
WarehouseStorage
AdditionalFee
Return
Credits
BalanceAdjustment
Payment

Example:

"Shipping"

items.invoicedStatus

boolean | null

Indicates whether the transaction has been invoiced.

Example:

true

items.referenceId

string | null

A unique reference identifier associated with the transaction

Example:

"12345"

items.referenceType

string | null

The type of reference associated with the ReferenceId. Available options:

Shipment
Return
WRO
URO
Ticket Number
FC
LPN Reference
Transfer Plan

Example:

"Shipment"

items.taxes

object[] | null

A list of tax details applied to the transaction if exists.

Show child attributes

items.taxes.taxAmount

number<double>

Tax amount charged for the tax type.

Example:

0.01

items.taxes.taxRate

number<double>

Rate of Tax charged for the tax type

Example:

10

items.taxes.taxType

string | null

Type of tax charged for eg. GST

Example:

"GST"

items.transactionFee

string | null

The fee type associated with the transaction for eg. Shipping fees To get all the available transaction fees use the endpoint - '/transaction-fees'

Example:

"Shipping"

items.transactionId

string | null

The unique identifier for transaction

Example:

"01AN4Z07BY79KA1307SR9X4MV3"

items.transactionType

string | null

The classification or nature of the transaction Transaction Types - Charge, Refund, Credit, Payment, BalanceAdjustment

Example:

"Charge"

last

string | null

Go to the Last page

string | null

Go to the Next page

string | null

Go to the Previous page

Get Invoices Search transactions

⌘I

API Reference

Authorizations

Path Parameters

Query Parameters

Response