Skip to main content

ContractFieldDTO

Contract custom field definition object.

idint64

Field ID

Example: 1
namestring

Field name

Example: Client Type
typeContractFieldType

Contract field type enum.

Possible values: [TEXT, DATE, SELECT, MULTI_SELECT, URL, TOGGLE_SWITCH, RADIO]

Example: SELECT
options object[]

Field options (for select / multi-select / radio / toggle).

  • Array [
  • idint64

    Option ID

    Example: 1
    namestring

    Option name

    Example: VIP
  • ]
  • requiredboolean

    Whether the field is mandatory

    Example: true
    ContractFieldDTO
    {
    "id": 1,
    "name": "Client Type",
    "type": "SELECT",
    "options": [
    {
    "id": 1,
    "name": "VIP"
    }
    ],
    "required": true
    }