Сгенерировать документ с модификаторами даты и имени

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Модификаторы в шаблонах документов — это правила форматирования, которые управляют тем, как выводятся значения полей, например дата или ФИО.

Входные данные можно заранее отформатировать в приложении, а можно передать форматирование через REST.

Когда использовать

  • Нужно отформатировать дату средствами генератора документов
  • Нужно вывести ФИО в заданном формате
  • Нужно вывести русское имя в нужном падеже

Что передавать в запросе

Модификаторы даты и имени применяются к значениям плейсхолдеров шаблона через параметры values и fields метода documentgenerator.document.add.

Пользовательская документация

Для даты

  • В values передайте дату в формате Atom, например 2026-03-18T00:00:00+03:00

  • В fields укажите тип поля: TYPE = DATE

  • При необходимости задайте формат вывода по умолчанию через FORMAT['format']:

    • d — день месяца с ведущим нулем
    • j — день месяца без ведущего нуля
    • m — номер месяца с ведущим нулем
    • n — номер месяца без ведущего нуля
    • F — полное название месяца
    • y — год двумя цифрами
    • Y — год четырьмя цифрами
    • H — часы в 24-часовом формате с ведущим нулем
    • i — минуты с ведущим нулем
    • s — секунды с ведущим нулем

Символы форматирования даты и времени можно комбинировать:

  • d.m.y — 28.03.26
  • j F, Y — 28 Марта, 2026
  • H:i:s — 10:24:18
  • Y-m-d H:i:s — 2026-03-28 10:24:18

Для имени

  • В values передайте имя массивом с частями ФИО:

    [
        	'NAME' => 'Игорь', // имя
        	'LAST_NAME' => 'Иванов', // фамилия
        	'SECOND_NAME' => 'Петрович', // отчество
        	'GENDER' => 'M', // пол
        ]

По ключу GENDER можно передать пол явно: M или F. Если пол не указан, модуль попытается определить его по отчеству. Если GENDER и отчество не указаны, пол не будет определен и склонение не будет работать.

  • В fields укажите тип поля: TYPE = NAME

  • В FORMAT['format'] можно передать шаблон вывода:

    • #TITLE# — обращение
    • #NAME# — имя
    • #LAST_NAME# — фамилия
    • #SECOND_NAME# — отчество
    • #NAME_SHORT# — первая буква имени с точкой
    • #LAST_NAME_SHORT# — первая буква фамилии с точкой
    • #SECOND_NAME_SHORT# — первая буква отчества с точкой

  • В FORMAT['case'] можно передать падеж по умолчанию:

    • -1 — именительный
    • 0 — родительный
    • 1 — дательный
    • 2 — винительный
    • 3 — творительный
    • 4 — предложный

Пример

$data = [
        	'templateId' => 203,
        	'providerClassName' => 'Bitrix\\DocumentGenerator\\DataProvider\\Rest',
        	'value' => 'ORDER_1024',
        	'values' => [
        		'SomeDate' => '2026-03-18T00:00:00+03:00', // значение передано в формате atom
        		'SomeName' => [ // имя передано в виде массива
        			'NAME' => 'Владислав',
        			'LAST_NAME' => 'Горелкин',
        			'GENDER' => 'M',
        		],
        	],
        	'fields' => [
        		'SomeDate' => [
        			'TYPE' => 'DATE',
        			'FORMAT' => [
        				'format' => 'd f Y H:i', // формат вывода
        			],
        		], // тип поля - дата
        		'SomeName' => [
        			'TYPE' => 'NAME',
        			'FORMAT' => [ // здесь можно передать формат поля по умолчанию
        				'case' => 0, // код падежа
        				'format' => '#NAME# #LAST_NAME#' // формат вывода
        			]
        		], // тип поля - имя
        	]
        ];
        $url = $webHookUrl.'documentgenerator.document.add/';

Продолжите изучение

Предыдущая
Сгенерировать документ с изображениями и печатями
Следующая
Сгенерировать документ с табличными данными