# Шаблоны реквизитов

Шаблоны наборов полей реквизитов: «Организация», «ИП», «Физ. лицо», «Иностранное юрлицо». Шаблон определяет, какие поля доступны у реквизита, и служит источником `presetId` для создания реквизита через `POST /v1/requisites`.

Битрикс24 API: `crm.requisite.preset.*`
Скоуп: `crm`

## Операции

- [Создать шаблон](./requisite-presets/create.md) — `POST /v1/requisite-presets`
- [Список шаблонов](./requisite-presets/list.md) — `GET /v1/requisite-presets`
- [Получить шаблон](./requisite-presets/get.md) — `GET /v1/requisite-presets/:id`
- [Обновить шаблон](./requisite-presets/update.md) — `PATCH /v1/requisite-presets/:id`
- [Удалить шаблон](./requisite-presets/delete.md) — `DELETE /v1/requisite-presets/:id`
- [Поиск шаблонов](./requisite-presets/search.md) — `POST /v1/requisite-presets/search`
- [Поля шаблонов](./requisite-presets/fields.md) — `GET /v1/requisite-presets/fields`
- [Список полей шаблона](./requisite-presets/preset-fields/list.md) — `GET /v1/requisite-presets/:presetId/fields`
- [Получить поле шаблона](./requisite-presets/preset-fields/get.md) — `GET /v1/requisite-presets/:presetId/fields/:id`
- [Добавить поле в шаблон](./requisite-presets/preset-fields/create.md) — `POST /v1/requisite-presets/:presetId/fields`
- [Обновить поле шаблона](./requisite-presets/preset-fields/update.md) — `PATCH /v1/requisite-presets/:presetId/fields/:id`
- [Удалить поле шаблона](./requisite-presets/preset-fields/delete.md) — `DELETE /v1/requisite-presets/:presetId/fields/:id`
- [Поля, доступные для добавления](./requisite-presets/preset-fields/available.md) — `GET /v1/requisite-presets/:presetId/fields/available`
- [Схема поля шаблона](./requisite-presets/preset-fields/schema.md) — `GET /v1/requisite-presets/:presetId/fields/schema`

## Ключевые поля

| Поле | Описание |
|------|---------|
| `name` | Название шаблона («Организация», «ИП», «Физ. лицо») |
| `entityTypeId` | Тип сущности набора — всегда `8`, реквизит |
| `countryId` | Страна набора полей, `1` — Россия |
| `active` | Активен ли шаблон |
| `sort` | Порядок сортировки в списке |

Полный список полей — [`GET /v1/requisite-presets/fields`](./requisite-presets/fields.md).

## Что нужно знать перед работой

1. **Шаблон — это шаблон набора полей.** У шаблона «Организация» один набор (ИНН, КПП, ОГРН, директор), у «Физ. лица» — другой (ФИО, паспорт). Сам по себе шаблон не хранит значения — он задаёт структуру.
2. **`presetId` нужен для создания реквизита.** При `POST /v1/requisites` поле `presetId` обязательно и неизменяемо после создания. Список доступных шаблонов отдаёт `GET /v1/requisite-presets`.
3. **Состав полей шаблона настраивается отдельно.** Операции «полей шаблона» по пути `/v1/requisite-presets/:presetId/fields` добавляют и убирают поля в шаблоне. Эндпоинт `available` показывает, какие поля ещё можно добавить, `schema` — структуру строки поля.
4. **Формат ответов единый.** И сам шаблон (`name`, `entityTypeId`), и строки его полей (`id`, `fieldName`, `fieldTitle`, `inShortList`, `sort`) возвращаются в camelCase. Флаг `inShortList` приходит как `true`/`false`. Значения `fieldName` — это либо системные имена реквизитов Битрикс24 в верхнем регистре (`RQ_INN`, `RQ_COMPANY_NAME`), либо пользовательские поля (`UF_CRM_*`).

## Связанные сущности

| Сущность | Эндпоинт | Назначение |
|----------|----------|-----------|
| Реквизиты | `POST /v1/requisites` | Используют `presetId` шаблона при создании — шаблон задаёт набор доступных полей реквизита. |
| Банковские реквизиты | `GET /v1/bank-details?filter[entityId]=:requisiteId` | Банковские счета реквизита: Р/с, БИК, к/с, SWIFT, IBAN. |
| Адреса | `GET /v1/addresses?filter[entityTypeId]=8&filter[entityId]=:requisiteId` | Адреса реквизита: юридический, фактический, для корреспонденции, доставки. |
| Связи реквизитов | `POST /v1/requisite-links` | Привязка реквизита (и опционально банка) к счёту или предложению. |

## Типичный сценарий

1. Получить список шаблонов: [`GET /v1/requisite-presets`](./requisite-presets/list.md) — выбрать подходящий `id`.
2. Создать реквизит с этим шаблоном: [`POST /v1/requisites`](./requisites/create.md) с `presetId`.
3. При необходимости настроить состав полей шаблона: [`POST /v1/requisite-presets/:presetId/fields`](./requisite-presets/preset-fields/create.md) — добавить поле из [доступных](./requisite-presets/preset-fields/available.md).

## Лимиты

| Лимит | Значение |
|-------|----------|
| Максимум записей на запрос | 5000 (`limit ≤ 5000`) |
| Авто-пагинация | включается при `limit > 50` |
| Список полей шаблона | `limit`/`offset` применяются на стороне Вайбкод |
| Batch-запросы | до 50 операций в [`POST /v1/batch`](/docs/batch) |
| Rate limit | общий для API Вайбкод — см. [Лимиты и оптимизация](/docs/optimization) |

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

- [Реквизиты компании для генерации документа](/docs/recipes/document-requisites)
- [Entity API](/docs/entity-api)
- [Синтаксис фильтрации](/docs/filtering)
- [Batch](/docs/batch)
- [Справочник сущностей](/docs/entities-index)