v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB
Transaction label

List transaction label associations

Returns a paginated list of label-to-transaction associations, filterable by cardda_transaction_id or transaction_label_id.

get/v1/transaction_label_associations

Query parameters

_startinteger

If all the transactions where in an array, this would represent the index of the first item returned in the response

_endinteger

If all the transactions where in an array, this would represent the index of the last item returned in the response

_order'asc' | 'desc'

The order method, which can be ascending or descending

_fieldstring
Example:created_at

The field used to sort, the example illustrates a response that would be sorted by the creation date

cardda_transaction_idstring

Filter by transaction (accounting_ledger_tx_id).

transaction_label_idstring uuid

Filter by label.

Headers

company-idstring uuid required

UUID of the company on whose behalf the request is made. Required for every Accounting endpoint. See The company-id header for details on how to obtain a value for this header and the error responses to expect when it is missing or invalid.

Response

Paginated list of associations

idstring uuid required
transaction_label_idstring uuid required
cardda_transaction_idstring required

The transaction's accounting_ledger_tx_id.

created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "id": "aa11bb22-cc33-4d44-8e55-6f778899aabb",
    "transaction_label_id": "f1e2d3c4-b5a6-4978-8c9d-0e1f2a3b4c5d",
    "cardda_transaction_id": "09f6cc5e-8a16-43ae-8bb1-637c0e1c0a6d"
  }
]