В системе RentRabbit есть ряд документов, которые генерируются в формате Word. На данный момент это договор, акт и транспортная накладная.
Для этих типов документов пользователи могут самостоятельно создавать шаблоны и генерировать документы в том виде, который им требуется.

Шаблоны настраиваются полностью, например, вы можете взять свой формальный договор в формате Word и указать специальным образом, какие данные куда нужно вставлять автоматически при генерации документа.
Как это сделать мы описываем в данной статье!

Общий принцип заполнения шаблонов

Чтобы указать системе, куда требуется подставить данные нужно вставлять специальные коды. Для разных документов список доступных кодов разный.

Пример:
В системе заполнен номер и дата договора, мы хотим чтобы они автоматически подставлялись при генерации договора.

В шаблоне договора указываем коды:

Код номера договора - project.contract.number
Код даты договора - project.contract.date

Система заменяет коды нужными значениями и мы получаем заполненный договор:

Структура кодов

Код пишется следующим образом

Сначала ставится знак доллара $, при замене кода на значение, именно со знака доллара берется стиль - цвет текста, размер шрифта. тип шрифта и другие;
Далее текстовая часть заключается в скобки { };
Затем пишется путь до поля, разделителем выступает символ точки, путь всегда ведет от объекта документа в целом до конечного нужного поля.
Например project.contract.number ведет из объекта документа в целом к объекту проекта, в нем к объекту договора и в нем к полю номера;
Далее в зависимости от типа кода, можно указать формат, в котором нужно вывести данные. Например, есть поле типа сумма денег - sum, можно указать формат .cents и будут выведены только копейки.

Типы кодов

Дата - глобальный момент времени, выводится согласно часовому поясу клиента - в Москве будет одно время, на Бали другое. Доступно множество форматов для красивого вывода даты и/или времени;

СМОТРЕТЬ ФОРМАТЫ

format - строка в красивом представлении с валютой и копейками;
formatWithoutCurrency - строка в красивом представлении без валюты с копейками;
withoutCents - неформатированная сумма как число без копеек (центов);
cents - неформатированная сумма только копеек (центов);
inWordsRuShowAll - прописью на русском, полностью с "рублей" и "копеек";
inWordsRuHowAllCentsAsNumber - прописью на русском, копейки числом с "рублей" и "копеек";
inWordsRuHideCents - прописью на русском, без копеек, с "рублей";
inWordsRuHideUnitNamesAndCents - прописью без копеек, без подписи "рублей";
half - половина суммы округленная в меньшую сторону до копеек, возвращается объект Сумма денег, можно далее применять к нему формат.

Строка - просто текстовая строка, например номер договора.
Сумма денег - сумма денег, доступны различные форматы вывода: с копейками, без копеек, прописью и другие;
Число с дробной частью - нецелое число, например 0.5 смены или скидка в 33.33 процента;
Локальная дата - дата записанная просто как фиксированная строка, например дата договора. Она просто хранит номер года и дня, часовой пояс клиента никак не влияет на нее. Форматы вывода доступны те же что и для обычной даты.
ФИО - фамилия, имя и отчество. Доступны форматы с инициалами, полным написанием, отдельно фамилией другие;

Объекты

Коды могут вести к полям объектов которые встречаются много раз, например есть объект с реквизитами legalDetails, он может быть в объекте арендатора renter.legalDetails либо в объекте компании businessAccount.legalDetails.

Основные объекты в системе

Реквизиты legalDetails

СМОТРЕТЬ ПОЛЯ

Общие (более одной страны)

fullOfficialName - официальное наименование, строка;
physicalAddress - адрес нахождения, строка;
legalAddress - юридический адрес, строка;
birthDate - дата рождения, локальная дата;
sex - пол, строка;
bankName - наименование банка, строка;
iban - IBAN (International Bank Account Number), строка;
swiftBic - BIC (Банковский идентификационный код SWIFT, в РФ используется обычный bic), строка;

Россия

inn - ИНН, строка;
innIp - ИННИП, строка;
kpp - КПП, строка;
ogrn - ОГРН, строка;
ogrnIp - ОГРНИП, строка;
bic - БИК (банковский идентификационный код), строка;
correspondentAccountNumber - корреспондентский счет, строка;
paymentAccountNumber - номер счета, строка;
passportNumber - номер паспорта, строка;
identityDocumentIssuerName - выдан (кем выдан паспорт), строка;
identityDocumentIssueDate - дата выдачи (паспорта), локальная дата;
passportIssuerCode - код подразделения, выдавшего паспорт, строка;
representedByDocumentString - в лице (родительский падеж), строка;

Беларусь

byUnp - УНП, строка;
byIdentificationPassportNumber - идентификационный номер, строка;
byPassportBookNumber - номер бланка паспорта, строка;

Казахстан

kzIin - ИИН, строка;
kzBin - БИН, строка;
kzPassportNumber - номер паспорта, строка;
kzCertificateNumber - номер удостоверения, строка;
identityDocumentExpirationDate - срок действия документа, уд. личность (дата истечения), локальная дата;

Другая

citizenship - гражданство, строка;
identityDocumentNumber - номер документа удостоверяющего личность, строка;

Технические поля (есть у всех стран, помогают в заполнении шаблона)

isEmpty - пустое ли поле, да / нет;
isLegalEntity - является юридическим лицом, да / нет;
isIndividualEntrepreneur - является индивидуальным предпринимателем, да / нет;
isNaturalPerson - является физическим лицом, да / нет;
country - название страны, строка;
subjectType - тип субъекта, строка. Пример - физ. лицо РФ;