Sign in

v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB
Custom column

Create a custom column

Creates a custom column. Requires the custom_columns_create permission on the company.

post/v1/custom_columns

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.

Request body

labelstring required

Human-facing label.

internal_namestring required

Internal name used for programmatic references.

fieldstring required

The field/input type of the column.

company_idstring uuid required

The owning company id. Required in the body (not read from the company-id header).

source_tablestring

The source table the column reads from, when applicable.

default_valuestring

Default value applied when no value is set.

applicable_modelsstring[] required

Example request

{
  "label": "Centro de costo",
  "internal_name": "cost_center",
  "field": "options",
  "applicable_models": [
    "transactions"
  ]
}

Response

Custom column created

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"
    }
  ]
}