Заповнити шаблон та отримати файли для підпису

URI: /templates/:code/fill?edrpou={{edrpou}}

Використовується для заповнення шаблону та отримання файлів для підпису.

Запит виконується методом POST у json форматі з даними.

Параметри URI

Метод дозволяє передати наступні параметри:

/templates/:code/fill?edrpou={{edrpou}}, де:

• code - код шаблону, отриманий методом /templates;
• edrpou — код ЄДРПОУ компанії.

Параметри запиту

Ім'я	Тип	Обов'язковий	Опис
document_name	string	Так	Назва документа
fields	list[object]	Так	Містить параметри полів шаблону
fields.name	string	Так	Назва поля шаблону
fields.description	string	Так	Опис поля шаблону
fields.data_type	integer	Так	Тип даних поля шаблону
fields.max_length	integer	Так	Максимальна довжина даних в полі шаблону
fields.group	string	Так	Група поля шаблону
fields.path	string	Так	Шлях до поля шаблону
fields.value	string	Так	Значення поля шаблону

Приклад запиту

⚠️ Запит повинен містити заголовок api_token_key: api_token та Accept: application/json

Запит: /templates/311131113__MULTIDOC/fill?edrpou=123123

{
    "document_name": "Test TEST Test",
    "fields": [
        {
            "name": "DOCDATE",
            "description": "Дата документа",
            "data_type": 5,
            "group": "MAIN",
            "path": "0.0.DOCDATE",
            "value": "02.06.2023"
        },
        {
            "name": "DOCSUM",
            "description": "Сума по документа",
            "data_type": 2,
            "group": "MAIN",
            "path": "0.0.DOCSUM",
            "value": 0
        },
        {
            "name": "DOC_NAME",
            "description": "Найменування документа",
            "data_type": 3,
            "group": "MAIN",
            "path": "0.0.DOC_NAME",
            "value": "тестовий документ"
        },
        {
            "name": "EMAIL",
            "description": "Електронна пошта",
            "data_type": 3,
            "max_length": 100,
            "group": "MAIN",
            "path": "0.0.EMAIL"
        },
        {
            "name": "FIRM_DEPT",
            "description": "Код філії",
            "data_type": 3,
            "group": "MAIN",
            "path": "0.0.FIRM_DEPT"
        },
        {
            "name": "FIRM_EDRPOU",
            "description": "ЄДРПОУ/ДРФО",
            "data_type": 3,
            "group": "MAIN",
            "path": "0.0.FIRM_EDRPOU",
            "value": "{{edrpou}}"
        },
        {
            "name": "FIRM_NAME",
            "description": "Найменування",
            "data_type": 3,
            "group": "MAIN",
            "path": "0.0.FIRM_NAME"
        },
        {
            "name": "NUM",
            "description": "Номер документа",
            "data_type": 3,
            "max_length": 100,
            "group": "MAIN",
            "path": "0.0.NUM",
            "value": "2"
        },
        {
            "name": "ORDER_NUM",
            "description": "Номер замовлення ",
            "data_type": 3,
            "max_length": 30,
            "group": "MAIN",
            "path": "0.0.ORDER_NUM"
        },
        {
            "name": "SIDE_DEPT_K",
            "description": "Код філії",
            "data_type": 3,
            "max_length": 4,
            "group": "MAIN",
            "path": "0.0.SIDE_DEPT_K"
        },
        {
            "name": "SIDE_EDRPOU_K",
            "description": "ЄДРПОУ/ДРФО",
            "data_type": 3,
            "max_length": 10,
            "group": "MAIN",
            "path": "0.0.SIDE_EDRPOU_K",
            "value": "35758853"
        },
        {
            "name": "SIDE_SHORTNAME_K",
            "description": "Коротке найменування",
            "data_type": 3,
            "max_length": 200,
            "group": "MAIN",
            "path": "0.0.SIDE_SHORTNAME_K",
            "value": "TEST TEST"
        },
        {
            "name": "SIGNERINFO",
            "description": "Інформація про підписантів",
            "data_type": 3,
            "group": "MAIN",
            "path": "0.0.SIGNERINFO"
        },
        {
            "name": "TEXT",
            "description": "Текст",
            "data_type": 3,
            "max_length": 500,
            "group": "MAIN",
            "path": "0.0.TEXT"
        },
        {
            "name": "VO_NAME",
            "description": "Особа, яка склала документ",
            "data_type": 3,
            "max_length": 250,
            "group": "MAIN",
            "path": "0.0.VO_NAME"
        }
    ]
}

Параметри відповіді

Ім'я	Тип	Опис
uuid	string	Універсальний унікальний ідентифікатор документа
body	string	Тіло xml документа в кодуванні Base64
image_body	integer	PDF представлення документа в кодуванні Base64
error	string	Текст помилки

Приклад успішної відповіді

200 OK

Відповідь: /templates/311131113__MULTIDOC/fill?edrpou=123123

{
    "uuid": "fef1f374-0d20-4e49-9f06-60b64ac62f3f",
    "body": "base64 string",
    "image_body": "base64 string"
}

Приклад неуспішної відповіді

400 Bad Request

Відповідь: /templates/311131113__MULTIDOC/fill?edrpou=123123

{
    "error": "Текст помилки"
}