Billing Documents

List all Billing Document's Transaction Records

Changed on

Retrieve a list of all billing document's transactions. Pagination of this endpoint is not indexed. count on the response body will always be null.

Required authorization scope: public.transaction_record:read

get/2024-09/billing_documents/{id}/transaction_records

Request

  • Base URL
    https://public-api.easyship.com
  • URL
    https://public-api.easyship.com/2024-09/billing_documents/{id}/transaction_records
  • Auth
    HTTP bearer

Path parameters

idstring required

Billing document ID

Query parameters

pageinteger

Page number to fetch, default: 1

per_pageinteger

Number of records per page to fetch, default: 20

from_datestring date

Beginning of date. Only accept YYYY-MM-DD format.

to_datestring date

End of date. Only accept YYYY-MM-DD format.

Response

list of billing document's transaction records

OR
string required

Transaction Records in CSV format

Example response

{
  "transaction_records": [
    {
      "id": "01563646-58c1-4607-8fe0-cae3e33c0001"
    }
  ]
}

Changes

    • warning

      added the new Bank Account Charge Failed enum value to the /// response property for the response status

    • warning

      added the new Pay by Bank Cashback enum value to the /// response property for the response status

    • warning

      added the new Tax & Duty Adjustment by Courier Invoice enum value to the /// response property for the response status