
## Создать документ

`POST /v1/documents`

Создаёт документ по шаблону: Битрикс24 формирует файл, подставляя в шаблон значения из провайдера данных.

## Поля запроса (body)

Минимум для создания: `templateId`, `providerClassName`, `value`.

| Поле | Тип | Обяз. | Описание |
|------|-----|:-----:|---------|
| `templateId` | number | ★ | Идентификатор шаблона, по которому формируется документ. Список шаблонов: `GET /v1/doc-templates` |
| `providerClassName` | string | ★ | Класс провайдера данных — источник значений для меток шаблона. Например `Bitrix\DocumentGenerator\DataProvider\Rest` |
| `value` | string | ★ | Внешний идентификатор объекта-источника, по которому провайдер подставляет значения. Например `ORDER-1024` |
| `values` | object | | Значения полей-меток шаблона. Ключ — имя метки, значение — подставляемый текст. Например `{"DocumentNumber":"2026-001"}` |
| `fields` | object | | Описание форматирования полей документа |
| `stampsEnabled` | boolean | | Подставлять в документ печати и подписи |

## Примеры

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

```bash
curl -X POST https://vibecode.bitrix24.tech/v1/documents \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "templateId": 53,
    "providerClassName": "Bitrix\\DocumentGenerator\\DataProvider\\Rest",
    "value": "ORDER-1024",
    "values": { "DocumentNumber": "2026-001" }
  }'
```

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

```bash
curl -X POST https://vibecode.bitrix24.tech/v1/documents \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "templateId": 53,
    "providerClassName": "Bitrix\\DocumentGenerator\\DataProvider\\Rest",
    "value": "ORDER-1024",
    "values": { "DocumentNumber": "2026-001" }
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/documents', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    templateId: 53,
    providerClassName: 'Bitrix\\DocumentGenerator\\DataProvider\\Rest',
    value: 'ORDER-1024',
    values: { DocumentNumber: '2026-001' },
  }),
})

const { success, data } = await res.json()
console.log('Document ID:', data.id)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/documents', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    templateId: 53,
    providerClassName: 'Bitrix\\DocumentGenerator\\DataProvider\\Rest',
    value: 'ORDER-1024',
    values: { DocumentNumber: '2026-001' },
  }),
})

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

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | object | Созданный документ со всеми полями — см. [Поля документа](/docs/entities/documents/fields) |

Поле `provider` в ответе соответствует переданному в запросе `providerClassName`.

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

```json
{
  "success": true,
  "data": {
    "id": 51,
    "title": "Договор поставки 2026-001",
    "number": "2026-001",
    "templateId": 53,
    "provider": "Bitrix\\DocumentGenerator\\DataProvider\\Rest",
    "value": "ORDER-1024",
    "fileId": 241,
    "pdfId": 245,
    "imageId": 243,
    "createTime": "2026-03-18T17:27:48+03:00",
    "updateTime": "2026-03-18T17:27:48+03:00",
    "createdBy": 503,
    "updatedBy": null,
    "values": { "DocumentNumber": "2026-001" },
    "stampsEnabled": false,
    "publicUrl": null,
    "downloadUrl": "https://example.bitrix24.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getfile&id=51",
    "pdfUrl": "https://example.bitrix24.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getpdf&id=51"
  }
}
```

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

403 — нет скоупа:

```json
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'documentgenerator' scope"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `documentgenerator` |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 400 | `MISSING_REQUIRED_FIELDS` | Не передано одно из обязательных полей: `templateId`, `providerClassName` или `value` |
| 404 | `ENTITY_NOT_FOUND` | Шаблон с указанным `templateId` не найден или недоступен |
| 422 | `BITRIX_ERROR` | Провайдер данных не вернул объект по указанному `value` |

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

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

- [Список документов](/docs/entities/documents/list)
- [Получить документ](/docs/entities/documents/get)
- [Шаблоны документов](/docs/entities/doc-templates)
- [Entity API](/docs/entity-api)
