v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB

Custom column

Set a custom column value

Sets the value of a custom column on a specific source record (identified by source_id — for a transaction this is its accounting_ledger_tx_id). The caller must belong to the record's company. For option-type columns, value must be one of the column's option keys.

Returns the updated source record with its recomputed custom-column values.

Note: only an unknown custom_column_id yields a 404. An unknown/mismatched source_id is not currently guarded and results in a 500 (server error) rather than a 404 — this is a known server-side bug, not the intended contract.

patch/v1/custom_column_values

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

custom_column_idstring uuid required

The custom column whose value is being set.

source_idstring uuid required

The id of the record the value is set on (e.g. a transaction's accounting_ledger_tx_id).

valuestring nullable

The value to store. For option-type columns this must be one of the column's option keys.

Example request

{
  "custom_column_id": "c0ffee00-1111-2222-3333-444455556666",
  "source_id": "09f6cc5e-8a16-43ae-8bb1-637c0e1c0a6d",
  "value": "ops"
}

Response

The updated source record

object required

The updated source record (e.g. a transaction), with its custom column values.