[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Fdoc-templates\u002Ffields":3,"docs-tabs-entities\u002Fdoc-templates\u002Ffields":6},{"content":4,"lastmod":5},"\n## Поля шаблона\n\n`GET \u002Fv1\u002Fdoc-templates\u002Ffields`\n\nВозвращает полную схему полей шаблона документа: имя поля, тип, признак «только для чтения» и обязательность при создании. Поля помечены ★ — обязательны в теле запроса при создании шаблона.\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdoc-templates\u002Ffields\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdoc-templates\u002Ffields\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdoc-templates\u002Ffields', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data } = await res.json()\nconsole.log('Всего полей:', Object.keys(data.fields).length)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdoc-templates\u002Ffields', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Битрикс24 | Тип | RO | Описание |\n|------|----------|-----|:--:|---------|\n| `id` | `id` | number | да | ID шаблона |\n| `name` | `name` | string | | ★ Название шаблона |\n| `numeratorId` | `numeratorId` | number | | ★ ID нумератора, который присваивает документам порядковые номера |\n| `region` | `region` | string | | ★ Код региона шаблона, например `ru` или `by` |\n| `code` | `code` | string \\| null | | Системный код шаблона для привязки в коде приложения. `null`, если код не задан |\n| `moduleId` | `moduleId` | string | | Идентификатор модуля-владельца шаблона |\n| `active` | `active` | string | | Доступность шаблона: `Y` — включён, `N` — выключен |\n| `bodyType` | `bodyType` | string | | Формат тела документа, например `DOCX` |\n| `withStamps` | `withStamps` | string | | Печать факсимиле и штампов: `Y` — добавляются, `N` — нет |\n| `sort` | `sort` | number | | Порядок шаблона в списке: чем меньше значение, тем выше |\n| `users` | `users` | array | | Идентификаторы сотрудников, которым доступен шаблон. Список: `GET \u002Fv1\u002Fusers` |\n| `fileId` | `fileId` | number | | ID файла на Диске. Загрузка через `POST \u002Fv1\u002Ffiles\u002Fupload` |\n| `file` | `file` | string | | Содержимое .docx в base64, принимается при создании |\n| `createdBy` | `createdBy` | number | да | Идентификатор создавшего сотрудника |\n| `updatedBy` | `updatedBy` | number \\| null | да | Идентификатор изменившего сотрудника. `null`, если шаблон не изменялся |\n| `isDeleted` | `isDeleted` | boolean | да | Шаблон помечен как удалённый |\n| `createTime` | `createTime` | datetime | да | Дата создания |\n| `updateTime` | `updateTime` | datetime | да | Дата изменения |\n| `download` | `download` | string | да | Ссылка для скачивания исходного файла шаблона |\n| `downloadMachine` | `downloadMachine` | string | да | Ссылка для скачивания файла по машинному доступу без авторизации в браузере |\n| `providers` | `providers` | object | да | Перечень доступных поставщиков хранилищ с их настройками |\n| `isDefault` | `isDefault` | string | да | Признак того, что шаблон используется по умолчанию |\n| `productsTableVariant` | `productsTableVariant` | string | да | Вариант оформления таблицы товаров в генерируемом документе |\n\n★ — поля `name`, `numeratorId`, `region` обязательны в теле запроса при создании шаблона.\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"fields\": {\n      \"id\": { \"type\": \"number\", \"readonly\": true, \"label\": \"ID шаблона\", \"description\": \"Уникальный идентификатор шаблона документа.\" },\n      \"name\": { \"type\": \"string\", \"readonly\": false, \"required\": true, \"label\": \"Название шаблона\", \"description\": \"Название шаблона документа, отображаемое пользователю.\" },\n      \"numeratorId\": { \"type\": \"number\", \"readonly\": false, \"required\": true, \"label\": \"ID нумератора\", \"description\": \"Идентификатор нумератора, присваивающего документам порядковые номера.\" },\n      \"region\": { \"type\": \"string\", \"readonly\": false, \"required\": true, \"label\": \"Регион шаблона\", \"description\": \"Код региона шаблона, например ru или by.\" },\n      \"code\": { \"type\": \"string\", \"readonly\": false, \"label\": \"Системный код\", \"description\": \"Системный код шаблона для привязки к нему в коде приложения.\" },\n      \"moduleId\": { \"type\": \"string\", \"readonly\": false, \"label\": \"ID модуля-владельца\", \"description\": \"Идентификатор модуля Битрикс24, которому принадлежит шаблон.\" },\n      \"active\": { \"type\": \"string\", \"readonly\": false, \"label\": \"Активность\", \"description\": \"Признак доступности шаблона: включён или выключен.\" },\n      \"bodyType\": { \"type\": \"string\", \"readonly\": false, \"label\": \"Формат тела\", \"description\": \"Формат содержимого генерируемого документа, например DOCX.\" },\n      \"withStamps\": { \"type\": \"string\", \"readonly\": false, \"label\": \"Печать штампов\", \"description\": \"Признак добавления факсимиле и штампов при генерации документа.\" },\n      \"sort\": { \"type\": \"number\", \"readonly\": false, \"label\": \"Сортировка\", \"description\": \"Значение для сортировки шаблона в списке: чем меньше, тем выше.\" },\n      \"users\": { \"type\": \"array\", \"readonly\": false, \"label\": \"Доступные сотрудники\", \"description\": \"Список идентификаторов сотрудников, которым доступен шаблон.\" },\n      \"fileId\": { \"type\": \"number\", \"readonly\": false, \"label\": \"ID файла на Диске\", \"description\": \"Идентификатор файла шаблона, загруженного на Диск.\" },\n      \"file\": { \"type\": \"string\", \"readonly\": false, \"label\": \"Содержимое файла\", \"description\": \"Содержимое файла шаблона в формате .docx, закодированное в base64.\" },\n      \"createdBy\": { \"type\": \"number\", \"readonly\": true, \"label\": \"Создал сотрудник\", \"description\": \"Идентификатор сотрудника, создавшего шаблон.\" },\n      \"updatedBy\": { \"type\": \"number\", \"readonly\": true, \"label\": \"Изменил сотрудник\", \"description\": \"Идентификатор сотрудника, последним изменившего шаблон.\" },\n      \"isDeleted\": { \"type\": \"boolean\", \"readonly\": true, \"label\": \"Удалён\", \"description\": \"Признак того, что шаблон помечен как удалённый.\" },\n      \"createTime\": { \"type\": \"datetime\", \"readonly\": true, \"label\": \"Дата создания\", \"description\": \"Дата и время создания шаблона.\" },\n      \"updateTime\": { \"type\": \"datetime\", \"readonly\": true, \"label\": \"Дата изменения\", \"description\": \"Дата и время последнего изменения шаблона.\" },\n      \"download\": { \"type\": \"string\", \"readonly\": true, \"label\": \"Ссылка на скачивание\", \"description\": \"Ссылка для скачивания исходного файла шаблона.\" },\n      \"downloadMachine\": { \"type\": \"string\", \"readonly\": true, \"label\": \"Машинная ссылка\", \"description\": \"Ссылка для скачивания файла без авторизации в браузере, для программного доступа.\" },\n      \"providers\": { \"type\": \"object\", \"readonly\": true, \"label\": \"Список поставщиков\", \"description\": \"Перечень доступных поставщиков хранилищ файла шаблона с их настройками.\" },\n      \"isDefault\": { \"type\": \"string\", \"readonly\": true, \"label\": \"Шаблон по умолчанию\", \"description\": \"Признак того, что шаблон используется по умолчанию.\" },\n      \"productsTableVariant\": { \"type\": \"string\", \"readonly\": true, \"label\": \"Вариант таблицы товаров\", \"description\": \"Вариант оформления таблицы товаров в генерируемом документе.\" }\n    }\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n403 — у ключа нет нужного скоупа:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"SCOPE_DENIED\",\n    \"message\": \"This endpoint requires 'documentgenerator' scope\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 403 | `SCOPE_DENIED` | API-ключу не хватает скоупа `documentgenerator` |\n| 401 | `TOKEN_MISSING` | у ключа нет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Создать шаблон](\u002Fdocs\u002Fentities\u002Fdoc-templates\u002Fcreate)\n- [Список шаблонов](\u002Fdocs\u002Fentities\u002Fdoc-templates\u002Flist)\n","2026-07-20",{}]