Prepare

[POST] …/v1/docprintform/prepare

Подготавливает печатную форму документа по RTF-шаблону.
При version=1 возвращает подготовленный RTF-файл в виде строки base64, при version=2 возвращает URL файла.
Версии не пересекаются.

Поддерживаемые документы:

Входные параметры

Поле data для обычного документа

Используется для всех поддерживаемых документов, кроме DocPartnerBalance.

Пример запроса для обычного документа

{
    "print_form_type_id": 1,
    "version": 2,
    "data": {
        "document_id": 123
    }
}

Поле data для акта сверки взаиморасчётов

Используется, если печатная форма привязана к DocPartnerBalance.

Пример запроса для акта сверки взаиморасчётов

{
    "print_form_type_id": 1,
    "version": 2,
    "data": {
        "partner_id": 10,
        "firm_id": 1,
        "currency_id": 1,
        "start_date": 1711929600,
        "end_date": 1714521599
    }
}

Выходные параметры

При version=1 метод возвращает строку base64.
При version=2 метод сохраняет подготовленный файл через CommonFile и возвращает объект с URL файла.

Формат ответа при version=1

Пример ответа при version=1

{
    "ok": true,
    "result": "e1xydGYx..."
}

Формат ответа при version=2

Пример ответа при version=2

{
    "ok": true,
    "result": {
        "file_name": "printform_123.rtf",
        "data": "https://cdn.example/....rtf",
        "version": 2
    }
}

Допустимые значения version: 1 и 2.
Если передано иное значение, возвращается ошибка 1002 (version).

Переменные и таблицы

Обычные переменные имеют вид <CompanyName>, <PartnerName>, <DocCode>.

Табличная часть определяется строкой RTF-таблицы, содержащей переменные номенклатуры, например <ItemName>, <ItemQuantity>, <ItemCost>, <ItemTotal>, <ItemImage>. Эта строка используется как шаблон и копируется по количеству операций документа.

Для DocPartnerBalance табличная часть определяется строкой с переменными <RowDocType>, <RowDocCode>, <RowDocDate>, <RowDebit>, <RowCredit>, <RowSaldoBegin>, <RowSaldoEnd>.

Изображения

Для изображений используется переменная <ItemImage>. Если URL изображения пустой или состоит только из пробелов, вместо переменной вставляется пустая строка.

Если URL заполнен, вместо переменной вставляется RTF-поле INCLUDEPICTURE:

{\field{\*\fldinst INCLUDEPICTURE "https://site.com/logo.png" \d}{\fldrslt }}

После открытия документа в Word изображение можно обновить стандартным обновлением полей, например выделить документ и нажать F9.

Переменные в шаблоне должны быть записаны цельным текстом, без разрыва форматированием.