[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Fdocuments\u002Ffields":3,"docs-tabs-entities\u002Fdocuments\u002Ffields":6},{"content":4,"lastmod":5},"\n## Поля документа\n\n`GET \u002Fv1\u002Fdocuments\u002Ffields`\n\nВозвращает полную схему полей документа: имя поля, тип, признак «только для чтения» и обязательность при создании. Поля помечены ★ — обязательны в теле запроса при создании документа.\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdocuments\u002Ffields\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdocuments\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\u002Fdocuments\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\u002Fdocuments\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`data.fields` — объект, ключ которого совпадает с именем поля, а значение содержит `type` (тип поля), `readonly` (`true` — поле нельзя передать при создании и обновлении), `label` (отображаемое название) и `description` (краткое описание). Значения `label`\u002F`description` локализованы: по-русски на `.tech`, по-английски на `.com`.\n\n| Поле | Битрикс24 | Тип | RO | Описание |\n|------|----------|-----|:--:|---------|\n| `id` | `id` | number | да | Идентификатор документа |\n| `title` | `title` | string | | Название документа |\n| `number` | `number` | string | | Номер документа |\n| `templateId` | `templateId` | number | | ★ Идентификатор шаблона. Список: `GET \u002Fv1\u002Fdoc-templates` |\n| `providerClassName` | `providerClassName` | string | | ★ Класс провайдера данных, например `Bitrix\\DocumentGenerator\\DataProvider\\Rest` |\n| `value` | `value` | string | | ★ Внешний идентификатор объекта-источника, из которого подставляются данные |\n| `values` | `values` | object | | Значения полей-меток шаблона |\n| `fields` | `fields` | object | | Описание форматирования полей |\n| `createTime` | `createTime` | datetime | да | Дата создания |\n| `updateTime` | `updateTime` | datetime | да | Дата последнего изменения |\n| `fileId` | `fileId` | number | | Идентификатор файла DOCX |\n| `pdfId` | `pdfId` | number | | Идентификатор файла PDF |\n| `imageId` | `imageId` | number | | Идентификатор файла изображения |\n| `stampsEnabled` | `stampsEnabled` | boolean | | Включены ли печати и подписи |\n| `provider` | `provider` | string | да | Класс провайдера данных документа |\n| `downloadUrl` | `downloadUrl` | string | да | Ссылка на скачивание DOCX для пользователя |\n| `pdfUrl` | `pdfUrl` | string | да | Ссылка на скачивание PDF для пользователя |\n| `imageUrl` | `imageUrl` | string | да | Ссылка на изображение для пользователя |\n| `downloadUrlMachine` | `downloadUrlMachine` | string | да | Ссылка на скачивание DOCX для приложения |\n| `pdfUrlMachine` | `pdfUrlMachine` | string | да | Ссылка на скачивание PDF для приложения |\n| `imageUrlMachine` | `imageUrlMachine` | string | да | Ссылка на изображение для приложения |\n| `createdBy` | `createdBy` | number | да | Идентификатор создавшего пользователя. Список: `GET \u002Fv1\u002Fusers` |\n| `updatedBy` | `updatedBy` | number \\| null | да | Идентификатор изменившего пользователя. `null`, если документ не изменялся. Список: `GET \u002Fv1\u002Fusers` |\n| `publicUrl` | `publicUrl` | string \\| null | да | Публичная ссылка на документ. `null`, если публичная ссылка не сформирована |\n\n★ — поля `templateId`, `providerClassName`, `value` обязательны в теле запроса при создании документа.\n\n## Пример ответа\n\nПоказаны 8 из 24 полей. Полный список — в таблице выше.\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"fields\": {\n      \"id\": { \"type\": \"number\", \"readonly\": true, \"label\": \"ID\", \"description\": \"Уникальный числовой идентификатор сгенерированного документа.\" },\n      \"title\": { \"type\": \"string\", \"readonly\": false, \"label\": \"Название\", \"description\": \"Название документа.\" },\n      \"number\": { \"type\": \"string\", \"readonly\": false, \"label\": \"Номер\", \"description\": \"Номер документа, отображаемый в печатной форме.\" },\n      \"templateId\": { \"type\": \"number\", \"readonly\": false, \"required\": true, \"label\": \"Шаблон\", \"description\": \"ID шаблона, по которому создаётся документ. Список: GET \u002Fv1\u002Fdoc-templates.\" },\n      \"providerClassName\": { \"type\": \"string\", \"readonly\": false, \"required\": true, \"label\": \"Провайдер данных\", \"description\": \"Имя класса провайдера данных, который поставляет значения для шаблона.\" },\n      \"value\": { \"type\": \"string\", \"readonly\": false, \"required\": true, \"label\": \"Идентификатор владельца\", \"description\": \"Идентификатор сущности, по которой провайдер данных строит документ (например, ID сделки).\" },\n      \"createTime\": { \"type\": \"datetime\", \"readonly\": true, \"label\": \"Дата создания\", \"description\": \"Дата и время создания документа.\" },\n      \"publicUrl\": { \"type\": \"string\", \"readonly\": true, \"label\": \"Публичная ссылка\", \"description\": \"Публичная ссылка для передачи документа.\" }\n    },\n    \"batch\": [\"create\", \"update\", \"delete\"]\n  }\n}\n```\n\nПоле `batch` перечисляет операции документа, доступные в [пакетном запросе](\u002Fdocs\u002Fbatch).\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 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Список документов](\u002Fdocs\u002Fentities\u002Fdocuments\u002Flist)\n- [Создать документ](\u002Fdocs\u002Fentities\u002Fdocuments\u002Fcreate)\n- [Справочник сущностей](\u002Fdocs\u002Fentity-api)\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n","2026-07-17",{}]