v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB

Custom column

Update a custom column

Updates a custom column. The caller must be a member of the company that owns the column. All fields are optional; only the provided fields are changed.

patch/v1/custom_columns/{custom_column_id}

Path parameters

custom_column_idstring uuid required

The id of the custom column.

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

internal_namestring

fieldstring

source_tablestring

default_valuestring

applicable_modelsstring[]

Example request

{
  "label": "Centro de costo",
  "internal_name": "cost_center",
  "field": "options"
}

Response

Custom column updated

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