# documentgenerator.document.getfields

URL: https://chugunov.pro/api-bitrix24/document-generator/document-generator-document-get-fields/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить список полей документа
Scope: `documentgenerator`
Кто может выполнять метод: пользователь с правом на изменение документов

## Описание

Метод `documentgenerator.document.getfields` возвращает поля документа, их текущие и базовые значения.

## Параметры

- `id` `integer` — обязательный. Идентификатор документа.
  Получить идентификатор документа можно после [создания документа](https://chugunov.pro/api-bitrix24/document-generator/document-generator-document-add/) или методом [получения списка документов](https://chugunov.pro/api-bitrix24/document-generator/document-generator-document-list/)
- `values` `object` — необязательный. Необязательный параметр.
  Значения полей, которые метод временно подставляет перед формированием `documentFields`.
  Используйте `values`, чтобы заранее проверить, как значения будут интерпретированы и отображены при [создании](https://chugunov.pro/api-bitrix24/document-generator/document-generator-document-add/) или [обновлении](https://chugunov.pro/api-bitrix24/document-generator/document-generator-document-update/) документа.
  Если `values` не передавать, метод вернет структуру полей с текущими и базовыми значениями

## Ответ

HTTP-статус: 200

```json
{
    "result": {
        "documentFields": {
            "DocumentNumber": {
                "title": "Номер",
                "value": "ДГ-2026-001",
                "required": "Y",
                "group": [
                    "Документ"
                ],
                "chain": "this.DOCUMENT.DOCUMENT_NUMBER",
                "default": "ДГ-2026-001"
            },
            "CurrentDate": {
                "value": "2026-03-18T00:00:00+03:00",
                "default": ""
            },
            "ClientName": {
                "value": "ООО Ромашка",
                "default": ""
            },
            "ClientPhone": {
                "value": "+7 999 123-45-67",
                "default": ""
            },
            "Total": {
                "value": "51000",
                "default": ""
            },
            "Comment": {
                "value": "Оплата в течение 5 рабочих дней после подписания",
                "default": ""
            },
            "UserName": {
                "value": "Иван Петров",
                "default": ""
            },
            "DocumentTitle": {
                "title": "Название документа",
                "value": "SUPPLY_CONTRACT Template 1773843147554 ДГ-2026-001",
                "group": [
                    "Документ"
                ],
                "chain": [
                    {},
                    "getTitle"
                ],
                "required": "Y",
                "default": "SUPPLY_CONTRACT Template 1773843147554 ДГ-2026-001"
            }
        }
    },
    "time": {
        "start": 1773931419,
        "finish": 1773931419.57404,
        "duration": 0.5740399360656738,
        "processing": 0,
        "date_start": "2026-03-19T17:43:39+03:00",
        "date_finish": "2026-03-19T17:43:39+03:00",
        "operating_reset_at": 1773932019,
        "operating": 0
    }
}
```

### Возвращаемые данные

- `result` `object`. Корневой элемент ответа [(подробное описание)](#result)
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "0",
    "error_description": "You do not have permissions to view documents"
}
```

- `400` — `100`. Bitrix\DocumentGenerator\Document constructor must be is public
- `400` — `0`. Документ не найден
- `400` — `0`. You do not have permissions to view documents

## Примеры запроса

### cURL (Webhook)

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"id":51,"values":{"DocumentNumber":"ДГ-2026-001","CurrentDate":"2026-03-18T00:00:00+03:00","ClientName":"ООО Ромашка","ClientPhone":"+7 999 123-45-67","Total":"51000","Comment":"Оплата в течение 5 рабочих дней после подписания","UserName":"Иван Петров"}}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.document.getfields
```

### cURL (OAuth)

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"id":51,"values":{"DocumentNumber":"ДГ-2026-001","CurrentDate":"2026-03-18T00:00:00+03:00","ClientName":"ООО Ромашка","ClientPhone":"+7 999 123-45-67","Total":"51000","Comment":"Оплата в течение 5 рабочих дней после подписания","UserName":"Иван Петров"},"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/documentgenerator.document.getfields
```

### JS (TS)

```ts
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type GetFieldsResult = {
  documentFields: Record<string, FieldInfo>
}

type FieldInfo = {
  title?: string
  value?: string
  default?: string
  group?: string[]
  chain?: string | unknown[]
  required?: 'Y' | 'N'
  type?: string
}

try {
  const response = await $b24.actions.v2.call.make<GetFieldsResult>({
    method: 'documentgenerator.document.getfields',
    params: {
      id: 51,
      values: {
        DocumentNumber: 'DG-2026-001',
        CurrentDate: '2026-03-18T00:00:00+03:00',
        ClientName: 'LLC Romashka',
        ClientPhone: '+7 999 123-45-67',
        Total: '51000',
        Comment: 'Payment within 5 business days after signing',
        UserName: 'Ivan Petrov',
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Document fields:', Object.keys(result.documentFields))
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getDocumentFields() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'documentgenerator.document.getfields',
        params: {
          id: 51,
          values: {
            DocumentNumber: 'DG-2026-001',
            CurrentDate: '2026-03-18T00:00:00+03:00',
            ClientName: 'LLC Romashka',
            ClientPhone: '+7 999 123-45-67',
            Total: '51000',
            Comment: 'Payment within 5 business days after signing',
            UserName: 'Ivan Petrov',
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Document fields:', Object.keys(result.documentFields))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getDocumentFields)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.documentgenerator.document.getfields(
        bitrix_id=51,
        values={
            "DocumentNumber": "ДГ-2026-001",
            "CurrentDate": "2026-03-18T00:00:00+03:00",
            "ClientName": "ООО Ромашка",
            "ClientPhone": "+7 999 123-45-67",
            "Total": "125000",
            "Comment": "Оплата в течение 5 рабочих дней после подписания",
            "UserName": "Иван Петров",
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service->core->call(
        'documentgenerator.document.getfields',
        [
            'id' => 51,
            'values' => [
                'DocumentNumber' => 'ДГ-2026-001',
                'CurrentDate' => '2026-03-18T00:00:00+03:00',
                'ClientName' => 'ООО Ромашка',
                'ClientPhone' => '+7 999 123-45-67',
                'Total' => '51000',
                'Comment' => 'Оплата в течение 5 рабочих дней после подписания',
                'UserName' => 'Иван Петров',
            ],
        ]
    );

    $result = $response->getResponseData()->getResult();
    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'documentgenerator.document.getfields',
    {
        id: 51,
        values: {
            DocumentNumber: 'ДГ-2026-001',
            CurrentDate: '2026-03-18T00:00:00+03:00',
            ClientName: 'ООО Ромашка',
            ClientPhone: '+7 999 123-45-67',
            Total: '51000',
            Comment: 'Оплата в течение 5 рабочих дней после подписания',
            UserName: 'Иван Петров'
        }
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'documentgenerator.document.getfields',
    [
        'id' => 51,
        'values' => [
            'DocumentNumber' => 'ДГ-2026-001',
            'CurrentDate' => '2026-03-18T00:00:00+03:00',
            'ClientName' => 'ООО Ромашка',
            'ClientPhone' => '+7 999 123-45-67',
            'Total' => '51000',
            'Comment' => 'Оплата в течение 5 рабочих дней после подписания',
            'UserName' => 'Иван Петров',
        ],
    ]
);

print_r($result);
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "documentgenerator.document.getfields", b24.Params{
	"id": 51,
	"values": b24.Params{
		"DocumentNumber": "ДГ-2026-001",
		"CurrentDate":    "2026-03-18T00:00:00+03:00",
		"ClientName":     "ООО Ромашка",
		"ClientPhone":    "+7 999 123-45-67",
		"Total":          "51000",
		"Comment":        "Оплата в течение 5 рабочих дней после подписания",
		"UserName":       "Иван Петров",
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("documentgenerator.document.getfields: %w", err)
}

// Метод заворачивает ответ в объект с ключом "documentFields".
raw, ok := b24.Unwrap(res.Result, "documentFields")
if !ok {
	return fmt.Errorf("в ответе нет ключа documentFields")
}

fmt.Printf("%s\n", raw)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/document-generator/document-generator-document-get-fields.html