## Поля реквизита

`GET /v1/requisites/fields`

Возвращает полный перечень полей реквизита. Поля схемы Вайбкод возвращаются в camelCase, пользовательские поля `UF_CRM_*` — в исходном регистре Битрикс24. Каждый реквизит хранит значения только тех полей, которые есть в его шаблоне.

## Примеры

### curl — личный ключ

```bash
curl "https://vibecode.bitrix24.tech/v1/requisites/fields" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth-приложение

```bash
curl "https://vibecode.bitrix24.tech/v1/requisites/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisites/fields', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success, data } = await res.json()
console.log('Всего полей:', Object.keys(data.fields).length)
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisites/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
```

## Формат ответа

Ответ — объект `{ success, data: { fields: {...} } }`. Каждое поле описано объектом:

- **Поля схемы Вайбкод** в camelCase: `{ type, readonly, label, description }`, где `label` и `description` приходят на русском языке. Заголовками запроса язык не переключается. В ответах `list`, `get`, `create`, `update`, `search` возвращаются под camelCase-именем. Фильтр и сортировка — по тому же имени.
- **Пользовательские поля `UF_CRM_*`** в исходном регистре: `{ type, readonly, label }`, где `label` — название поля на языке портала.

## Поля схемы Вайбкод

Поля российских и международных шаблонов реквизита.

### Служебные

| Вайбкод-имя | Битрикс24 | Тип | RO | Описание |
|----------|----------|-----|:--:|---------|
| `id` | `ID` | number | да | ID реквизита |
| `entityTypeId` | `ENTITY_TYPE_ID` | number | | `3` — контакт, `4` — компания |
| `entityId` | `ENTITY_ID` | number | | ID родительской сущности |
| `presetId` | `PRESET_ID` | number | | ID [шаблона реквизитов](/docs/entities/requisite-presets). Неизменяем после создания |
| `name` | `NAME` | string | | Название в интерфейсе Битрикс24 |
| `code` | `CODE` | string | | Символьный код для внешних интеграций |
| `xmlId` | `XML_ID` | string | | Внешний идентификатор для синхронизации |
| `originatorId` | `ORIGINATOR_ID` | string | | ID системы-источника |
| `active` | `ACTIVE` | boolean | | Активен ли реквизит |
| `sort` | `SORT` | number | | Порядок сортировки. Меньше — выше |
| `createdAt` | `DATE_CREATE` | datetime | да | Дата создания |
| `updatedAt` | `DATE_MODIFY` | datetime | да | Дата последнего изменения |
| `createdBy` | `CREATED_BY_ID` | number | да | ID создателя |
| `modifyBy` | `MODIFY_BY_ID` | number | да | ID последнего редактора |
| `addressOnly` | `ADDRESS_ONLY` | boolean | | Признак «только адрес» |

### Юрлица

| Вайбкод-имя | Битрикс24 | Тип | Описание |
|----------|----------|-----|---------|
| `rqName` | `RQ_NAME` | string | Полное наименование |
| `rqCompanyName` | `RQ_COMPANY_NAME` | string | Сокращённое название |
| `rqCompanyFullName` | `RQ_COMPANY_FULL_NAME` | string | Полное название |
| `rqCompanyId` | `RQ_COMPANY_ID` | string | Идентификатор компании |
| `rqCompanyRegDate` | `RQ_COMPANY_REG_DATE` | date | Дата регистрации |
| `rqDirector` | `RQ_DIRECTOR` | string | ФИО директора |
| `rqAccountant` | `RQ_ACCOUNTANT` | string | ФИО главного бухгалтера |
| `rqCeoName` | `RQ_CEO_NAME` | string | ФИО руководителя |
| `rqCeoWorkPos` | `RQ_CEO_WORK_POS` | string | Должность руководителя |
| `rqContact` | `RQ_CONTACT` | string | Контактное лицо |
| `rqEmail` | `RQ_EMAIL` | string | Email организации |
| `rqPhone` | `RQ_PHONE` | string | Телефон организации |
| `rqFax` | `RQ_FAX` | string | Факс |
| `rqInn` | `RQ_INN` | string | ИНН |
| `rqKpp` | `RQ_KPP` | string | КПП |
| `rqUsn` | `RQ_USN` | string | УСН |
| `rqOgrn` | `RQ_OGRN` | string | ОГРН |
| `rqOgrnip` | `RQ_OGRNIP` | string | ОГРНИП (для ИП) |
| `rqOkpo` | `RQ_OKPO` | string | ОКПО |
| `rqOkved` | `RQ_OKVED` | string | ОКВЭД |
| `rqOktmo` | `RQ_OKTMO` | string | ОКТМО |
| `rqIfns` | `RQ_IFNS` | string | ИФНС |
| `rqUsrle` | `RQ_USRLE` | string | Сведения о регистрации в реестре юридических лиц |
| `rqTaxRegime` | `RQ_TAX_REGIME` | string | Налоговый режим. Значение из справочника портала |
| `rqVatPayer` | `RQ_VAT_PAYER` | boolean | Плательщик НДС |
| `rqVatId` | `RQ_VAT_ID` | string | ИНН для НДС |
| `rqVatCertSer` | `RQ_VAT_CERT_SER` | string | Серия свидетельства НДС |
| `rqVatCertNum` | `RQ_VAT_CERT_NUM` | string | Номер свидетельства НДС |
| `rqVatCertDate` | `RQ_VAT_CERT_DATE` | date | Дата свидетельства НДС |
| `rqResidenceCountry` | `RQ_RESIDENCE_COUNTRY` | string | Страна регистрации |
| `rqBaseDoc` | `RQ_BASE_DOC` | string | Документ-основание |
| `rqBaseDocDate` | `RQ_BASE_DOC_DATE` | date | Дата документа-основания |
| `rqBaseDocNum` | `RQ_BASE_DOC_NUM` | string | Номер документа-основания |
| `rqRegCertNum` | `RQ_REG_CERT_NUM` | string | Свидетельство о регистрации — номер |
| `rqRegCertDate` | `RQ_REG_CERT_DATE` | date | Свидетельство о регистрации — дата |
| `rqStCertSer` | `RQ_ST_CERT_SER` | string | Серия свидетельства о государственной регистрации |
| `rqStCertNum` | `RQ_ST_CERT_NUM` | string | Номер свидетельства о государственной регистрации |
| `rqStCertDate` | `RQ_ST_CERT_DATE` | string | Дата свидетельства о государственной регистрации |
| `rqRegOrganization` | `RQ_REG_ORGANIZATION` | string | Регистрирующий орган |
| `rqStateReg` | `RQ_STATE_REG` | string | Государственная регистрация |
| `rqMnplReg` | `RQ_MNPL_REG` | string | Муниципальная регистрация |
| `rqStampPresent` | `RQ_STAMP_PRESENT` | boolean | Наличие печати |

### Физлица

| Вайбкод-имя | Битрикс24 | Тип | Описание |
|----------|----------|-----|---------|
| `rqFirstName` | `RQ_FIRST_NAME` | string | Имя |
| `rqLastName` | `RQ_LAST_NAME` | string | Фамилия |
| `rqSecondName` | `RQ_SECOND_NAME` | string | Отчество |
| `rqIdentType` | `RQ_IDENT_TYPE` | string | Тип документа, удостоверяющего личность. Значение из справочника портала |
| `rqIdentDocType` | `RQ_IDENT_DOC` | string | Название документа, удостоверяющего личность |
| `rqIdentDocSer` | `RQ_IDENT_DOC_SER` | string | Серия документа |
| `rqIdentDocNum` | `RQ_IDENT_DOC_NUM` | string | Номер документа |
| `rqIdentDocPersNum` | `RQ_IDENT_DOC_PERS_NUM` | string | Персональный номер документа |
| `rqIdentDocDate` | `RQ_IDENT_DOC_DATE` | date | Дата выдачи |
| `rqIdentDocIssuedBy` | `RQ_IDENT_DOC_ISSUED_BY` | string | Кем выдан |
| `rqIdentDocDepCode` | `RQ_IDENT_DOC_DEP_CODE` | string | Код подразделения |

### Международные шаблоны

Поля шаблонов других стран. Заполнены только на реквизитах соответствующего странового шаблона — на российских реквизитах возвращаются как `null`.

| Вайбкод-имя | Битрикс24 | Страна | Описание |
|----------|----------|--------|---------|
| `rqEdrpou` | `RQ_EDRPOU` | 🇺🇦 Украина | ЕДРПОУ |
| `rqDrfo` | `RQ_DRFO` | 🇺🇦 Украина | ДРФО |
| `rqKbe` | `RQ_KBE` | 🇰🇿 Казахстан | КБе |
| `rqIin` | `RQ_IIN` | 🇰🇿 Казахстан | ИИН |
| `rqBin` | `RQ_BIN` | 🇰🇿 Казахстан | БИН |
| `rqRegon` | `RQ_REGON` | 🇵🇱 Польша | REGON |
| `rqKrs` | `RQ_KRS` | 🇵🇱 Польша | KRS |
| `rqPesel` | `RQ_PESEL` | 🇵🇱 Польша | PESEL |
| `rqSiret` | `RQ_SIRET` | 🇫🇷 Франция | SIRET |
| `rqSiren` | `RQ_SIREN` | 🇫🇷 Франция | SIREN |
| `rqRcs` | `RQ_RCS` | 🇫🇷 Франция | RCS |
| `rqCapital` | `RQ_CAPITAL` | 🇫🇷 Франция | Capital |
| `rqCnpj` | `RQ_CNPJ` | 🇧🇷 Бразилия | CNPJ — юрлица |
| `rqCpf` | `RQ_CPF` | 🇧🇷 Бразилия | CPF — физлица |
| `rqLegalForm` | `RQ_LEGAL_FORM` | общее | Форма юрлица |

## Пользовательские поля

`UF_CRM_*` — поля, настроенные на портале через интерфейс Битрикс24. Возвращаются в исходном регистре с дополнительной меткой `label`.

## Пример ответа

```json
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "entityTypeId": { "type": "number", "readonly": false },
      "presetId": { "type": "number", "readonly": false },
      "rqInn": { "type": "string", "readonly": false },
      "rqKpp": { "type": "string", "readonly": false },
      "rqCompanyName": { "type": "string", "readonly": false },
      "rqDirector": { "type": "string", "readonly": false },
      "rqEdrpou": { "type": "string", "readonly": false },
      "rqRegon": { "type": "string", "readonly": false },
      "createdAt": { "type": "datetime", "readonly": true },
      "createdBy": { "type": "number", "readonly": true },

      "UF_CRM_1698325419": { "type": "string", "readonly": false, "label": "Внутренний код" }
    }
  }
}
```

Показана небольшая часть полей. Полный состав зависит от настроенных на портале шаблонов и пользовательских полей.

## Пример ответа при ошибке

401 — нет токенов:

```json
{
  "success": false,
  "error": {
    "code": "TOKEN_MISSING",
    "message": "API key has no OAuth tokens configured"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Известные особенности

**Все активные шаблоны в одном ответе.** Метод возвращает поля со всех активных шаблонов портала, включая страновые. На отдельном реквизите заполнены только поля его шаблона, остальные возвращаются как `null`.

**Пустые значения нормализованы.** Для строковых, числовых, date и datetime полей Вайбкод приводит `""` к `null` в ответах `list`, `get`, `create`, `update`, `search`. На метод `fields` это не влияет — он возвращает только метаданные поля.

**Метка `label` у пользовательских полей.** У полей `UF_CRM_*` возвращается `label` с названием поля на языке портала. У полей схемы Вайбкод `label` и `description` приходят на русском языке.

## Смотрите также

- [Создать реквизит](/docs/entities/requisites/create)
- [Список реквизитов](/docs/entities/requisites/list)
- [Entity API](/docs/entity-api)
- [Лимиты и оптимизация](/docs/optimization)