Sign in

v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB
Transaction label

List transaction labels

Returns a paginated list of transaction labels available to the caller, scoped to the caller's company (members with owner/admin/finance/member roles). Labels are company-scoped tags that can be associated with transactions.

get/v1/transaction_labels

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

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 labels

idstring uuid required
labelstring required
colorstring nullable
company_idstring uuid
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "id": "f1e2d3c4-b5a6-4978-8c9d-0e1f2a3b4c5d",
    "label": "Reembolsable",
    "color": "#22C55E",
    "company_id": "550e8400-e29b-41d4-a716-446655440000"
  }
]