Бізнес-блок

Шаблони друку

Читання, створення та збереження шаблонів чеків і друкованих документів.

10усього
6читання
4запис
Показано 10 із 10 Глобальний пошук · Ctrl + K — пошук на сторінці
Кожна картка містить готовий HTTP-приклад. Значення в ньому демонстраційні: замініть їх даними зі своєї бази. Для операцій запису використовуйте новий Idempotency-Key для кожної окремої бізнес-операції. Як сформувати ключ і повторювати запит.
pos

Каса

4 методів
pos.template_contractor_rekvПовертає реквізити контрагента для друкованого документа. читання pos.read з 0.4.0

Повертає реквізити контрагента для друкованого документа.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: pos.read Idempotency-Key: не потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
ntНазва товару

Поле «Назва товару» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: "Тестовий товар"За замовчуванням: ""
Точна схема параметрів 
{
    "nt": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Назва товару",
        "description": "Поле «Назва товару» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Основні",
        "example": "Тестовий товар"
    }
}

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
detailsDetailsБезпечні додаткові відомості про виконання операції.string"Приклад"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "details"
    ],
    "field_specs": {
        "details": {
            "title": "Details",
            "description": "Безпечні додаткові відомості про виконання операції.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "pos.template_contractor_rekv",
    "params": {
        "nt": "Тестовий товар"
    },
    "id": "example-pos-template-contractor-rekv"
}

Замініть демонстраційні значення даними зі своєї бази.

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

{
    "ok": true,
    "data": {
        "method": "pos.template_contractor_rekv",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "template_contractor_rekv",
                "value": "1"
            },
            "rows": [
                {
                    "details": "Приклад"
                }
            ]
        },
        "id": "example-pos-template-contractor-rekv"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.

Пов’язані методи

pos.template_contractorsПовертає список контрагентів для вибору в шаблоні документа. читання pos.read з 0.4.0

Повертає список контрагентів для вибору в шаблоні документа.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: pos.read Idempotency-Key: не потрібен

Параметри params

Параметри не потрібні. Передайте порожній об’єкт {}.
Точна схема параметрів 
{}

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
nameНазваПовернене значення «Назва» відповідного запису, документа або підсумку ARM20.string"Тестовий товар"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "name"
    ],
    "field_specs": {
        "name": {
            "title": "Назва",
            "description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Тестовий товар"
        }
    }
}

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "pos.template_contractors",
    "params": [],
    "id": "example-pos-template-contractors"
}

Замініть демонстраційні значення даними зі своєї бази.

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

{
    "ok": true,
    "data": {
        "method": "pos.template_contractors",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "template_contractors",
                "value": "1"
            },
            "rows": [
                {
                    "name": "Тестовий товар"
                }
            ]
        },
        "id": "example-pos-template-contractors"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.

Пов’язані методи

pos.template_get_partsПовертає збережені частини шаблону друкованого документа. читання pos.read з 0.4.0

Повертає збережені частини шаблону друкованого документа.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: pos.read Idempotency-Key: не потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Додаткові
prefixПрефікс

Варіант «Префікс». Використовуйте лише одне зі значень, розшифрованих нижче.

  • — без префікса
  • prro_ — лише операції з префіксом prro_
enum
необов’язковийПриклад: ""За замовчуванням: ""
Точна схема параметрів 
{
    "prefix": {
        "type": "enum",
        "values": [
            "",
            "prro_"
        ],
        "default": "",
        "title": "Префікс",
        "description": "Варіант «Префікс». Використовуйте лише одне зі значень, розшифрованих нижче.",
        "group": "Додаткові",
        "example": "",
        "enum_labels": {
            "": "без префікса",
            "prro_": "лише операції з префіксом prro_"
        }
    }
}

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
partPartПовернене значення «Part» відповідного запису, документа або підсумку ARM20.string"Приклад"
textTextПовернене значення «Text» відповідного запису, документа або підсумку ARM20.string"Приклад"
updated_atUpdated atПовернена дата «Updated at» у форматі YYYY-MM-DD.string · date"2026-07-23"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "part",
        "text",
        "updated_at"
    ],
    "field_specs": {
        "part": {
            "title": "Part",
            "description": "Повернене значення «Part» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "text": {
            "title": "Text",
            "description": "Повернене значення «Text» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "updated_at": {
            "title": "Updated at",
            "description": "Повернена дата «Updated at» у форматі YYYY-MM-DD.",
            "type": "string",
            "format": "date",
            "example": "2026-07-23"
        }
    }
}

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "pos.template_get_parts",
    "params": {
        "prefix": "prro_"
    },
    "id": "example-pos-template-get-parts"
}

Замініть демонстраційні значення даними зі своєї бази.

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

{
    "ok": true,
    "data": {
        "method": "pos.template_get_parts",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "template_get_parts",
                "value": "1"
            },
            "rows": [
                {
                    "part": "Приклад",
                    "text": "Приклад",
                    "updated_at": "2026-07-23"
                }
            ]
        },
        "id": "example-pos-template-get-parts"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.

Пов’язані методи

pos.template_report_getФормує дані звіту за вибраним шаблоном. запис pos.write з 0.4.0

Формує дані звіту за вибраним шаблоном.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: pos.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
typeТип звіту

Код виду документа або режиму. Розшифрування кожного допустимого значення наведено нижче.

  • dayrep — денний звіт
  • prrorep — звіт ПРРО
enum
обов’язковийПриклад: "dayrep"
Точна схема параметрів 
{
    "type": {
        "type": "enum",
        "values": [
            "dayrep",
            "prrorep"
        ],
        "required": true,
        "title": "Тип звіту",
        "description": "Код виду документа або режиму. Розшифрування кожного допустимого значення наведено нижче.",
        "group": "Основні",
        "example": "dayrep",
        "enum_labels": {
            "dayrep": "денний звіт",
            "prrorep": "звіт ПРРО"
        }
    }
}

Результат

Форма відповіді: scalar
ПолеЗмістТипПриклад
valueЗначенняПовернене значення «Значення» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "scalar",
    "value_type": "string",
    "value_spec": {
        "title": "Значення",
        "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
        "type": "string",
        "example": "Приклад"
    }
}

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-pos-template-report-get-0001

{
    "method": "pos.template_report_get",
    "params": {
        "type": "dayrep"
    },
    "id": "example-pos-template-report-get"
}

Замініть демонстраційні значення даними зі своєї бази.

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

{
    "ok": true,
    "data": {
        "method": "pos.template_report_get",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "template_report_get",
                "value": "Приклад"
            },
            "rows": []
        },
        "id": "example-pos-template-report-get"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.

Пов’язані методи

print_templates

Шаблони друку

6 методів
print_templates.count_receiptПовертає кількість збережених шаблонів касового чека. читання settings.read з 0.4.0

Повертає кількість збережених шаблонів касового чека.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: settings.read Idempotency-Key: не потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Додаткові
kindТип запису

Варіант «Тип запису». Використовуйте лише одне зі значень, розшифрованих нижче.

  • dprinter — принтер документів
  • prro — ПРРО
  • android — Android-каса
  • android_prro — Android-каса з ПРРО
enum
обов’язковийПриклад: "dprinter"
Точна схема параметрів 
{
    "kind": {
        "type": "enum",
        "values": [
            "dprinter",
            "prro",
            "android",
            "android_prro"
        ],
        "required": true,
        "title": "Тип запису",
        "description": "Варіант «Тип запису». Використовуйте лише одне зі значень, розшифрованих нижче.",
        "group": "Додаткові",
        "example": "dprinter",
        "enum_labels": {
            "dprinter": "принтер документів",
            "prro": "ПРРО",
            "android": "Android-каса",
            "android_prro": "Android-каса з ПРРО"
        }
    }
}

Результат

Форма відповіді: scalar
ПолеЗмістТипПриклад
valueЗначенняПовернене значення «Значення» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "scalar",
    "value_type": "string",
    "value_spec": {
        "title": "Значення",
        "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
        "type": "string",
        "example": "Приклад"
    }
}

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "print_templates.count_receipt",
    "params": {
        "kind": "dprinter"
    },
    "id": "example-print-templates-count-receipt"
}

Замініть демонстраційні значення даними зі своєї бази.

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

{
    "ok": true,
    "data": {
        "method": "print_templates.count_receipt",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "print_templates"
            },
            "status": {
                "code": "OK",
                "operation": "count_receipt",
                "value": "Приклад"
            },
            "rows": []
        },
        "id": "example-print-templates-count-receipt"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.
print_templates.ensure_singleСтворює єдиний початковий шаблон документа, якщо його ще немає. запис settings.write з 0.4.0

Створює єдиний початковий шаблон документа, якщо його ще немає.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: settings.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Додаткові
tcТип звіту

Варіант «Тип звіту». Використовуйте лише одне зі значень, розшифрованих нижче.

  • dayrep — денний звіт
  • prrorep — звіт ПРРО
enum
обов’язковийПриклад: "dayrep"
txtТекст

Поле «Текст» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: ""За замовчуванням: ""
Точна схема параметрів 
{
    "tc": {
        "type": "enum",
        "values": [
            "dayrep",
            "prrorep"
        ],
        "required": true,
        "title": "Тип звіту",
        "description": "Варіант «Тип звіту». Використовуйте лише одне зі значень, розшифрованих нижче.",
        "group": "Додаткові",
        "example": "dayrep",
        "enum_labels": {
            "dayrep": "денний звіт",
            "prrorep": "звіт ПРРО"
        }
    },
    "txt": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Текст",
        "description": "Поле «Текст» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату 
{
    "mode": "status",
    "fields": [
        "affected"
    ],
    "field_specs": {
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-print-templates-ensure-single-0001

{
    "method": "print_templates.ensure_single",
    "params": {
        "tc": "dayrep"
    },
    "id": "example-print-templates-ensure-single"
}

Замініть демонстраційні значення даними зі своєї бази.

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

{
    "ok": true,
    "data": {
        "method": "print_templates.ensure_single",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "print_templates"
            },
            "status": {
                "code": "OK",
                "operation": "ensure_single",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-print-templates-ensure-single"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.
print_templates.read_receiptПовертає шаблон друку касового чека. читання settings.read з 0.4.0

Повертає шаблон друку касового чека.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: settings.read Idempotency-Key: не потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Додаткові
kindТип запису

Варіант «Тип запису». Використовуйте лише одне зі значень, розшифрованих нижче.

  • dprinter — принтер документів
  • prro — ПРРО
  • android — Android-каса
  • android_prro — Android-каса з ПРРО
enum
обов’язковийПриклад: "dprinter"
Точна схема параметрів 
{
    "kind": {
        "type": "enum",
        "values": [
            "dprinter",
            "prro",
            "android",
            "android_prro"
        ],
        "required": true,
        "title": "Тип запису",
        "description": "Варіант «Тип запису». Використовуйте лише одне зі значень, розшифрованих нижче.",
        "group": "Додаткові",
        "example": "dprinter",
        "enum_labels": {
            "dprinter": "принтер документів",
            "prro": "ПРРО",
            "android": "Android-каса",
            "android_prro": "Android-каса з ПРРО"
        }
    }
}

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
partPartПовернене значення «Part» відповідного запису, документа або підсумку ARM20.string"Приклад"
textTextПовернене значення «Text» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "part",
        "text"
    ],
    "field_specs": {
        "part": {
            "title": "Part",
            "description": "Повернене значення «Part» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "text": {
            "title": "Text",
            "description": "Повернене значення «Text» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "print_templates.read_receipt",
    "params": {
        "kind": "dprinter"
    },
    "id": "example-print-templates-read-receipt"
}

Замініть демонстраційні значення даними зі своєї бази.

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

{
    "ok": true,
    "data": {
        "method": "print_templates.read_receipt",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "print_templates"
            },
            "status": {
                "code": "OK",
                "operation": "read_receipt",
                "value": "1"
            },
            "rows": [
                {
                    "part": "Приклад",
                    "text": "Приклад"
                }
            ]
        },
        "id": "example-print-templates-read-receipt"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.

Пов’язані методи

print_templates.read_singleПовертає єдиний шаблон вибраного типу документа. читання settings.read з 0.4.0

Повертає єдиний шаблон вибраного типу документа.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: settings.read Idempotency-Key: не потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Додаткові
tcТип звіту

Варіант «Тип звіту». Використовуйте лише одне зі значень, розшифрованих нижче.

  • dayrep — денний звіт
  • prrorep — звіт ПРРО
enum
обов’язковийПриклад: "dayrep"
Точна схема параметрів 
{
    "tc": {
        "type": "enum",
        "values": [
            "dayrep",
            "prrorep"
        ],
        "required": true,
        "title": "Тип звіту",
        "description": "Варіант «Тип звіту». Використовуйте лише одне зі значень, розшифрованих нижче.",
        "group": "Додаткові",
        "example": "dayrep",
        "enum_labels": {
            "dayrep": "денний звіт",
            "prrorep": "звіт ПРРО"
        }
    }
}

Результат

Форма відповіді: scalar
ПолеЗмістТипПриклад
valueЗначенняПовернене значення «Значення» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "scalar",
    "value_type": "string",
    "value_spec": {
        "title": "Значення",
        "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
        "type": "string",
        "example": "Приклад"
    }
}

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "print_templates.read_single",
    "params": {
        "tc": "dayrep"
    },
    "id": "example-print-templates-read-single"
}

Замініть демонстраційні значення даними зі своєї бази.

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

{
    "ok": true,
    "data": {
        "method": "print_templates.read_single",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "print_templates"
            },
            "status": {
                "code": "OK",
                "operation": "read_single",
                "value": "Приклад"
            },
            "rows": []
        },
        "id": "example-print-templates-read-single"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.

Пов’язані методи

print_templates.save_receiptЗберігає шаблон друку касового чека. запис settings.write з 0.4.0

Зберігає шаблон друку касового чека.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: settings.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Додаткові
kindТип запису

Варіант «Тип запису». Використовуйте лише одне зі значень, розшифрованих нижче.

  • dprinter — принтер документів
  • prro — ПРРО
  • android — Android-каса
  • android_prro — Android-каса з ПРРО
enum
обов’язковийПриклад: "dprinter"
part1Перша частина шаблону

Поле «Перша частина шаблону» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: ""За замовчуванням: ""
part2Друга частина шаблону

Поле «Друга частина шаблону» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: ""За замовчуванням: ""
part3Третя частина шаблону

Поле «Третя частина шаблону» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: ""За замовчуванням: ""
part4Четверта частина шаблону

Поле «Четверта частина шаблону» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: ""За замовчуванням: ""
Точна схема параметрів 
{
    "kind": {
        "type": "enum",
        "values": [
            "dprinter",
            "prro",
            "android",
            "android_prro"
        ],
        "required": true,
        "title": "Тип запису",
        "description": "Варіант «Тип запису». Використовуйте лише одне зі значень, розшифрованих нижче.",
        "group": "Додаткові",
        "example": "dprinter",
        "enum_labels": {
            "dprinter": "принтер документів",
            "prro": "ПРРО",
            "android": "Android-каса",
            "android_prro": "Android-каса з ПРРО"
        }
    },
    "part1": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Перша частина шаблону",
        "description": "Поле «Перша частина шаблону» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "part2": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Друга частина шаблону",
        "description": "Поле «Друга частина шаблону» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "part3": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Третя частина шаблону",
        "description": "Поле «Третя частина шаблону» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "part4": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Четверта частина шаблону",
        "description": "Поле «Четверта частина шаблону» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату 
{
    "mode": "status",
    "fields": [
        "affected"
    ],
    "field_specs": {
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-print-templates-save-receipt-0001

{
    "method": "print_templates.save_receipt",
    "params": {
        "kind": "dprinter"
    },
    "id": "example-print-templates-save-receipt"
}

Замініть демонстраційні значення даними зі своєї бази.

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

{
    "ok": true,
    "data": {
        "method": "print_templates.save_receipt",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "print_templates"
            },
            "status": {
                "code": "OK",
                "operation": "save_receipt",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-print-templates-save-receipt"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.

Пов’язані методи

print_templates.save_singleЗберігає єдиний шаблон вибраного типу документа. запис settings.write з 0.4.0

Зберігає єдиний шаблон вибраного типу документа.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: settings.write Idempotency-Key: потрібен

Параметри params

ПолеЩо означаєТип і форматПравила
Додаткові
tcТип звіту

Варіант «Тип звіту». Використовуйте лише одне зі значень, розшифрованих нижче.

  • dayrep — денний звіт
  • prrorep — звіт ПРРО
enum
обов’язковийПриклад: "dayrep"
txtТекст

Поле «Текст» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.

string
необов’язковийПриклад: ""За замовчуванням: ""
Точна схема параметрів 
{
    "tc": {
        "type": "enum",
        "values": [
            "dayrep",
            "prrorep"
        ],
        "required": true,
        "title": "Тип звіту",
        "description": "Варіант «Тип звіту». Використовуйте лише одне зі значень, розшифрованих нижче.",
        "group": "Додаткові",
        "example": "dayrep",
        "enum_labels": {
            "dayrep": "денний звіт",
            "prrorep": "звіт ПРРО"
        }
    },
    "txt": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Текст",
        "description": "Поле «Текст» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    }
}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
affectedЗмінено записівКількість записів, які upstream фактично змінив.string"Приклад"
Точна схема результату 
{
    "mode": "status",
    "fields": [
        "affected"
    ],
    "field_specs": {
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-print-templates-save-single-0001

{
    "method": "print_templates.save_single",
    "params": {
        "tc": "dayrep"
    },
    "id": "example-print-templates-save-single"
}

Замініть демонстраційні значення даними зі своєї бази.

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

{
    "ok": true,
    "data": {
        "method": "print_templates.save_single",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "print_templates"
            },
            "status": {
                "code": "OK",
                "operation": "save_single",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-print-templates-save-single"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
IDEMPOTENCY_KEY_REQUIRED422Для виконання запису не передано Idempotency-Key.Створити ключ для цієї бізнес-операції та повторити.
IDEMPOTENCY_RESULT_UNKNOWN409Результат попередньої спроби невідомий; gateway не виконав запис повторно.Звірити документ, чек або платіж; не створювати новий ключ автоматично.

Пов’язані методи