ContractFieldDTO

Contract custom field definition object. Null-valued properties are omitted from the response JSON entirely (not sent as null).

idint64

Field ID

Example: 1

namestring

Field name

Example: Client Type

typeContractFieldType

Contract field type enum (the CONTRACT-family slice of uysot-v2's CustomFieldType). Serialized by name.

Possible values: [TEXT, EXTENDED_TEXT, DATE, SELECT, MULTI_SELECT, RADIO, TOGGLE_SWITCH, URL, TAG, LOCATION, COUNTER, ADDRESS, EMPLOYEE, FILE, NUMBER]

Example: SELECT

options object[]

Field options (for SELECT/MULTI_SELECT/RADIO/TOGGLE_SWITCH).

Array [

idint64

Option ID

Example: 1

namestring

Option name

Example: VIP

descriptionstringnullable

Option description

Example: VIP-tier clients

colorstringnullable

Display color

Example: #FF5733

sortOrderint32nullable

Display order

Example: 1

]

requiredboolean

Whether the field is mandatory

Example: true

descriptionstringnullable

Field description

Example: Segment used for VIP treatment

iconstringnullable

Icon code

Example: star

maxElementsint32nullable

Max element count for multi-value types

Example: 5

numberFormatNumberFormatnullable

For type: NUMBER — how the value is formatted.

Possible values: [NUMBER, PERCENT, CURRENCY]

Example: NUMBER

decimalPlacesint32nullable

For type: NUMBER — decimal places.

Example: 2

visualizationNumberVisualizationnullable

For type: NUMBER — display style.

Possible values: [BAR, RING, NUMBER]

Example: NUMBER

maxValuedoublenullable

For type: NUMBER — upper bound.

Example: 1000000

ordersint32nullable

Display order

Example: 1

ContractFieldDTO

{
  "id": 1,
  "name": "Client Type",
  "type": "SELECT",
  "options": [
    {
      "id": 1,
      "name": "VIP",
      "description": "VIP-tier clients",
      "color": "#FF5733",
      "sortOrder": 1
    }
  ],
  "required": true,
  "description": "Segment used for VIP treatment",
  "icon": "star",
  "maxElements": 5,
  "numberFormat": "NUMBER",
  "decimalPlaces": 2,
  "visualization": "NUMBER",
  "maxValue": 1000000,
  "orders": 1
}