Platform

Custom field definition

DEFINITION of a custom field of the account: its identifier, the type it admits and the values it accepts.

Schemas: CustomFieldDefinitionDto

{
  "id": "id_8f2a1c",
  "name": "Example",
  "dataType": "text",
  "description": "string",
  "options": [
    "string"
  ],
  "applyAt": [
    "order"
  ],
  "showOn": [
    "quote"
  ],
  "isActive": true,
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

The definition of a custom field of the account: its identifier, the type of data it admits, the values it accepts if it is a dropdown, and the kind of entity it applies to. It is not the value stored on any record; values travel inside each resource. Read the definitions before you write a custom field. Custom fields use the tenancy inherited from the parent account.

Attributes

idstring

Unique identifier of the definition. It is the one used when writing a value.

namestring

Display name of the field.

dataTypestring

Data type the field accepts.

Available options: text, multitext, dropdown, checkbox, radio, date, contact, item, space, staff_member, vehicle

descriptionstring | null

Field description; null if it has none.

optionsstring[]

Allowed values when the field is a dropdown. Empty for the other types.

applyAtstring[]

Entities the field can be used on.

Available options: order, item, space, contact, project, kit, orderTemplate, repairTicket, serializedItem, vehicle, staff, service, purchaseOrder, incident, opportunity, document, all

showOnstring[]

Documents the field is printed on.

Available options: quote, proforma, invoice, contract, packing_slip, purchase_order, repair_ticket, all

isActiveboolean

true if the definition is active and can be used.

createdAtstring<date-time> | null

Creation date in ISO 8601 UTC; null if not recorded.

updatedAtstring<date-time> | null

Last modification date in ISO 8601 UTC; null if not recorded.

Values

dataType: text, multitext, dropdown, checkbox, radio, date, contact, item, space, staff_member, vehicle
applyAt: order, item, space, contact, project, kit, orderTemplate, repairTicket, serializedItem, vehicle, staff, service, purchaseOrder, incident, opportunity, document, all
showOn: quote, proforma, invoice, contract, packing_slip, purchase_order, repair_ticket, all

Returned by

GET /api/v1/custom-fields — List custom field definitions

Modified by

No operation.

Was this page helpful?