Create a custom column

Creates a custom column in the company of the company-id header. Requires the
custom_columns_create permission on the company. A company_id in the body is ignored.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Payload to create a custom column. Requires the custom_columns_create permission on the
company. The column is created in the company of the company-id header; a company_id in
the body is ignored.

string
required

Human-facing label.

string
required

Internal name used for programmatic references.

string
required

The field/input type of the column.

string

The source table the column reads from, when applicable.

string

Default value applied when no value is set.

applicable_models
array of strings
required
applicable_models*
options
array of objects
options
boolean
Defaults to false

Whether a purchase order cannot be requested without this column. Only valid on a
column whose applicable_models include purchase_orders (422 otherwise); removing
purchase_orders from them later switches it off. Only honoured when the caller has
custom_columns_manage: without it, it is silently dropped. Applies on create (the
order must be born with a value) and on edit (a value cannot be emptied); orders that
already existed are not changed.

boolean
Defaults to false

Whether a reimbursement (document_type 29) cannot be requested without this column,
through the public reimbursement link or the web form (POST /v1/erp/payouts/payables).
Not enforced over WhatsApp. Only valid on a column whose applicable_models include
tradables (422 otherwise); removing tradables from them later switches it off. Only
honoured when the caller has custom_columns_manage: without it, it is silently dropped.
Applies only on create: a value can be emptied or corrected afterwards, and reimbursements
that already existed are not changed.

Headers
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.

Responses

401

Unauthorized

404

Not Found — the company-id header is missing or names a company the caller does not
belong to.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json