PaymentFieldDTO

A payment custom field definition, returned by GET /v1/open-api/payment-field. Same shape as ContractFieldDTO, plus the translated names and show. Fields that are null are omitted from the response entirely.

idint64nullable

Field ID

Example: 42

namestringnullable

Field name

Example: To'lov kanali

typeCustomFieldType

Custom field type, shared by every custom-field family (contract, flat, payment and lead task). Serialized by name. Identical value set to ContractFieldType, which remains as the contract-family alias.

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

Example: SELECT

options object[]nullable

Available options — present for the option-based types (SELECT, MULTI_SELECT, RADIO, TOGGLE_SWITCH).

Array [

idint64nullable

Option ID

Example: 7

namestringnullable

Option name

Example: Naqd

descriptionstringnullable

Option description

Example: Kassaga naqd pul

colorstringnullable

Display colour

Example: #2E7D32

sortOrderint32nullable

Display position

Example: 1

nameUzstringnullable

Name in Uzbek (Latin)

Example: Naqd

nameRustringnullable

Name in Russian

Example: Наличные

nameEnstringnullable

Name in English

Example: Cash

nameTrstringnullable

Name in Turkish

Example: Nakit

nameTjstringnullable

Name in Tajik

Example: Нақд

nameKystringnullable

Name in Kyrgyz

Example: Накталай

]

requiredbooleannullable

Whether the field is mandatory

Example: false

showbooleannullable

Whether the field is shown in the UI. null means it is shown.

Example: true

descriptionstringnullable

Field description

Example: To'lov qaysi kanal orqali kelgani

iconstringnullable

Icon key

Example: wallet

maxElementsint32nullable

Maximum number of values for a multi-value field

Example: 3

numberFormatNumberFormat

How a NUMBER-typed contract field's value is formatted. Serialized by name.

Possible values: [NUMBER, PERCENT, CURRENCY]

Example: NUMBER

decimalPlacesint32nullable

Decimal places for a NUMBER field

Example: 2

visualizationNumberVisualization

How a NUMBER-typed contract field's value is displayed. Serialized by name.

Possible values: [BAR, RING, NUMBER]

Example: NUMBER

maxValuedoublenullable

Upper limit for a NUMBER field

Example: 100000000

ordersint32nullable

Display position

Example: 3

nameUzstringnullable

Name in Uzbek (Latin)

Example: To'lov kanali

nameRustringnullable

Name in Russian

Example: Канал оплаты

nameEnstringnullable

Name in English

Example: Payment channel

nameTrstringnullable

Name in Turkish

Example: Ödeme kanalı

nameTjstringnullable

Name in Tajik

Example: Канали пардохт

nameKystringnullable

Name in Kyrgyz

Example: Төлөм каналы

PaymentFieldDTO

{
  "id": 42,
  "name": "To'lov kanali",
  "type": "SELECT",
  "options": [
    {
      "id": 7,
      "name": "Naqd",
      "description": "Kassaga naqd pul",
      "color": "#2E7D32",
      "sortOrder": 1,
      "nameUz": "Naqd",
      "nameRu": "Наличные",
      "nameEn": "Cash",
      "nameTr": "Nakit",
      "nameTj": "Нақд",
      "nameKy": "Накталай"
    }
  ],
  "required": false,
  "show": true,
  "description": "To'lov qaysi kanal orqali kelgani",
  "icon": "wallet",
  "maxElements": 3,
  "numberFormat": "NUMBER",
  "decimalPlaces": 2,
  "visualization": "NUMBER",
  "maxValue": 100000000,
  "orders": 3,
  "nameUz": "To'lov kanali",
  "nameRu": "Канал оплаты",
  "nameEn": "Payment channel",
  "nameTr": "Ödeme kanalı",
  "nameTj": "Канали пардохт",
  "nameKy": "Төлөм каналы"
}