Sign in

v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB
Custom column

List custom columns

Returns a paginated list of custom columns for the companies the caller belongs to. Custom columns define the configurable rendición (expense-tracking) fields attached to transactions and other applicable models. Results are scoped to the caller's company memberships.

get/v1/custom_columns

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

applicable_modelsstring

Filter by an applicable model (e.g. transactions).

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 custom columns

idstring uuid required
company_idstring uuid required
labelstring

Human-facing label shown in the UI.

internal_namestring nullable

Internal name used for programmatic references.

fieldstring

The field/input type of the column. options drives a select-style column with a fixed set of choices.

source_tablestring nullable

The source table the column reads from, when applicable.

default_valuestring nullable

Default value applied when no value is set.

applicable_modelsstring[]

The models this column applies to (e.g. transactions, card_transactions, payables).

created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "id": "c0ffee00-1111-2222-3333-444455556666",
    "company_id": "550e8400-e29b-41d4-a716-446655440000",
    "label": "Centro de costo",
    "internal_name": "cost_center",
    "field": "options",
    "applicable_models": [
      "transactions"
    ],
    "options": [
      {
        "key": "ops",
        "value": "Operaciones"
      },
      {
        "key": "mkt",
        "value": "Marketing"
      }
    ]
  }
]