ПРРО, акциз і черги документів
Фіскалізація, онлайн- та офлайн-черги, повторна обробка, звіряння й акцизні марки.
Idempotency-Key для кожної окремої бізнес-операції.
Як сформувати ключ і повторювати запит.
Каса
pos.excise_add_markДодає акцизну марку до товарної позиції чека.
запис
pos.write
з 0.4.0
Додає акцизну марку до товарної позиції чека.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
allow_duplicateДозволити дубль | Визначає, чи застосовувати параметр «Дозволити дубль». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: false |
etaxОзнака вхідного акцизу | Визначає, чи застосовувати параметр «Ознака вхідного акцизу». Передавайте JSON true або false. | bool | обов’язковийПриклад: false |
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
| Основні | |||
codeКод товару або акцизної марки | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | обов’язковийПриклад: "1001" |
Точна схема параметрів
{
"allow_duplicate": {
"type": "bool",
"default": false,
"title": "Дозволити дубль",
"description": "Визначає, чи застосовувати параметр «Дозволити дубль». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
},
"code": {
"type": "string",
"max": 512,
"required": true,
"title": "Код товару або акцизної марки",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"etax": {
"type": "bool",
"required": true,
"title": "Ознака вхідного акцизу",
"description": "Визначає, чи застосовувати параметр «Ознака вхідного акцизу». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
},
"kasm": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": 1
}
}
Результат
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-pos-excise-add-mark-0001
{
"method": "pos.excise_add_mark",
"params": {
"code": "1001",
"etax": true
},
"id": "example-pos-excise-add-mark"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.excise_add_mark",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "excise_add_mark",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-excise-add-mark"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.excise_bind_pendingПрив’язує підготовлені акцизні марки до поточного чека.
запис
pos.write
з 0.4.0
Прив’язує підготовлені акцизні марки до поточного чека.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
ndocНомер документа | Номер службового, касового або фіскального документа у відповідному журналі. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
Точна схема параметрів
{
"kasm": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": 1
},
"ndoc": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер документа",
"description": "Номер службового, касового або фіскального документа у відповідному журналі.",
"group": "Додаткові",
"example": 1
}
}
Результат
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-pos-excise-bind-pending-0001
{
"method": "pos.excise_bind_pending",
"params": {
"kasm": 1,
"ndoc": 1001
},
"id": "example-pos-excise-bind-pending"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.excise_bind_pending",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "excise_bind_pending",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-excise-bind-pending"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.excise_clear_pendingОчищає підготовлені акцизні марки поточного чека.
запис
pos.write
з 0.4.0
Очищає підготовлені акцизні марки поточного чека.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeКод товару або акцизної марки | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | необов’язковийПриклад: "1001"За замовчуванням: "" |
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"default": "",
"title": "Код товару або акцизної марки",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"kasm": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": 1
}
}
Результат
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-pos-excise-clear-pending-0001
{
"method": "pos.excise_clear_pending",
"params": {
"code": "1001",
"kasm": 1
},
"id": "example-pos-excise-clear-pending"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.excise_clear_pending",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "excise_clear_pending",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-excise-clear-pending"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.excise_duplicateПеревіряє, чи не використано акцизну марку повторно.
читання
pos.read
з 0.4.0
Перевіряє, чи не використано акцизну марку повторно.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
etaxОзнака вхідного акцизу | Визначає, чи застосовувати параметр «Ознака вхідного акцизу». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: false |
Точна схема параметрів
{
"etax": {
"type": "bool",
"default": false,
"title": "Ознака вхідного акцизу",
"description": "Визначає, чи застосовувати параметр «Ознака вхідного акцизу». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
excise_markExcise mark | Повернене значення «Excise mark» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
codeКод товару або акцизної марки | Повернене значення «Код товару або акцизної марки» відповідного запису, документа або підсумку ARM20. | string | "1001" |
check_numberНомер чека | Номер касового чека у базі поточного клієнта. | string | "Приклад" |
cashdesk_numberНомер каси | Повернене значення «Номер каси» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"excise_mark",
"code",
"check_number",
"cashdesk_number"
],
"field_specs": {
"excise_mark": {
"title": "Excise mark",
"description": "Повернене значення «Excise mark» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"code": {
"title": "Код товару або акцизної марки",
"description": "Повернене значення «Код товару або акцизної марки» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "1001"
},
"check_number": {
"title": "Номер чека",
"description": "Номер касового чека у базі поточного клієнта.",
"type": "string",
"example": "Приклад"
},
"cashdesk_number": {
"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.excise_duplicate",
"params": {
"etax": true
},
"id": "example-pos-excise-duplicate"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.excise_duplicate",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "excise_duplicate",
"value": "1"
},
"rows": [
{
"excise_mark": "Приклад",
"code": "1001",
"check_number": "Приклад",
"cashdesk_number": "Приклад"
}
]
},
"id": "example-pos-excise-duplicate"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.excise_marks_for_checkПовертає акцизні марки, прив’язані до вибраного чека.
читання
pos.read
з 0.4.0
Повертає акцизні марки, прив’язані до вибраного чека.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeКод товару або акцизної марки | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | обов’язковийПриклад: "1001" |
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
ndocНомер документа | Номер службового, касового або фіскального документа у відповідному журналі. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"required": true,
"title": "Код товару або акцизної марки",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"kasm": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": 1
},
"ndoc": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер документа",
"description": "Номер службового, касового або фіскального документа у відповідному журналі.",
"group": "Додаткові",
"example": 1
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
excise_markExcise mark | Повернене значення «Excise mark» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"excise_mark"
],
"field_specs": {
"excise_mark": {
"title": "Excise mark",
"description": "Повернене значення «Excise mark» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.excise_marks_for_check",
"params": {
"code": "1001"
},
"id": "example-pos-excise-marks-for-check"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.excise_marks_for_check",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "excise_marks_for_check",
"value": "1"
},
"rows": [
{
"excise_mark": "Приклад"
}
]
},
"id": "example-pos-excise-marks-for-check"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.excise_product_nameПовертає назву підакцизного товару за його кодом.
читання
pos.read
з 0.4.0
Повертає назву підакцизного товару за його кодом.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeКод товару або акцизної марки | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | необов’язковийПриклад: "1001"За замовчуванням: "" |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"default": "",
"title": "Код товару або акцизної марки",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
}
}
Результат
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.excise_product_name",
"params": {
"code": "1001"
},
"id": "example-pos-excise-product-name"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.excise_product_name",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "excise_product_name",
"value": "1"
},
"rows": [
{
"name": "Тестовий товар"
}
]
},
"id": "example-pos-excise-product-name"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.excise_shortage_checkПеревіряє наявність потрібних акцизних марок для продажу.
читання
pos.read
з 0.4.0
Перевіряє наявність потрібних акцизних марок для продажу.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
pref_discПрефікс дисконтної картки | Префікс, за яким відсканований код розпізнається як дисконтна картка. | string | необов’язковийПриклад: ""За замовчуванням: "" |
skНомер складу або філії | Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
| Основні | |||
storageСклад | Логічний склад: main — основний, branch — філіальний.
| enum | необов’язковийПриклад: "main"За замовчуванням: "main" |
| Колекції | |||
rowsРядки операції | Структурований масив рядків. Невідомі поля та порушення схеми відхиляються gateway. | array<object> | обов’язковийПриклад: [] |
Точна схема параметрів
{
"kasm": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": 1
},
"pref_disc": {
"type": "string",
"max": 4096,
"default": "",
"title": "Префікс дисконтної картки",
"description": "Префікс, за яким відсканований код розпізнається як дисконтна картка.",
"group": "Додаткові",
"example": ""
},
"sk": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер складу або філії",
"description": "Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад.",
"group": "Додаткові",
"example": 1
},
"storage": {
"type": "enum",
"values": [
"main",
"branch"
],
"default": "main",
"title": "Склад",
"description": "Логічний склад: main — основний, branch — філіальний.",
"group": "Основні",
"example": "main",
"enum_labels": {
"main": "основний склад",
"branch": "філіальний склад"
}
},
"rows": {
"type": "array",
"required": true,
"min_items": 1,
"max_items": 300,
"items": {
"type": "object",
"fields": {
"code": {
"type": "string",
"required": true,
"max": 190,
"pattern": "/^[^\\x00-\\x1F\\x7F]{1,190}$/uD",
"title": "Код товару або акцизної марки",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"nt": {
"type": "string",
"max": 512,
"pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$/uD",
"title": "Назва товару",
"description": "Поле «Назва товару» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Основні",
"example": "Тестовий товар"
},
"quant": {
"type": "decimal",
"required": true,
"max": 32,
"scale": 3,
"numeric_min": 0,
"exclusive_min": true,
"numeric_max": 1000000,
"title": "Кількість",
"description": "Кількість товару як десятковий рядок; для вагового товару дозволена дробова частина.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "product-unit",
"example": "1.000"
}
}
},
"title": "Рядки операції",
"description": "Структурований масив рядків. Невідомі поля та порушення схеми відхиляються gateway.",
"group": "Колекції",
"example": []
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
codeКод товару або акцизної марки | Повернене значення «Код товару або акцизної марки» відповідного запису, документа або підсумку ARM20. | string | "1001" |
nameНазва | Повернене значення «Назва» відповідного запису, документа або підсумку ARM20. | string | "Тестовий товар" |
required_countRequired count | Повернене значення «Required count» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
available_countAvailable count | Повернене значення «Available count» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
row_numberRow number | Повернене значення «Row number» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
pending_debugPending debug | Повернене значення «Pending debug» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"code",
"name",
"required_count",
"available_count",
"row_number",
"pending_debug"
],
"field_specs": {
"code": {
"title": "Код товару або акцизної марки",
"description": "Повернене значення «Код товару або акцизної марки» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "1001"
},
"name": {
"title": "Назва",
"description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Тестовий товар"
},
"required_count": {
"title": "Required count",
"description": "Повернене значення «Required count» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"available_count": {
"title": "Available count",
"description": "Повернене значення «Available count» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"row_number": {
"title": "Row number",
"description": "Повернене значення «Row number» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"pending_debug": {
"title": "Pending debug",
"description": "Повернене значення «Pending debug» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.excise_shortage_check",
"params": {
"storage": "main",
"rows": [
{
"code": "1001",
"nt": "Тестовий товар",
"quant": "1.000"
}
]
},
"id": "example-pos-excise-shortage-check"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.excise_shortage_check",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "excise_shortage_check",
"value": "1"
},
"rows": [
{
"code": "1001",
"name": "Тестовий товар",
"required_count": "Приклад",
"available_count": "Приклад",
"row_number": "Приклад",
"pending_debug": "Приклад"
}
]
},
"id": "example-pos-excise-shortage-check"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.excise_validate_return_marksПеревіряє акцизні марки перед оформленням повернення.
читання
pos.read
з 0.4.0
Перевіряє акцизні марки перед оформленням повернення.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
source_checkНомер початкового чека | Поле «Номер початкового чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
source_ndocНомер документа-джерела | Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
Точна схема параметрів
{
"kasm": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": 1
},
"source_check": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер початкового чека",
"description": "Поле «Номер початкового чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"source_ndoc": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер документа-джерела",
"description": "Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
codeКод товару або акцизної марки | Повернене значення «Код товару або акцизної марки» відповідного запису, документа або підсумку ARM20. | string | "1001" |
excise_markExcise mark | Повернене значення «Excise mark» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
nameНазва | Повернене значення «Назва» відповідного запису, документа або підсумку ARM20. | string | "Тестовий товар" |
pending_countPending count | Повернене значення «Pending count» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
source_countSource count | Повернене значення «Source count» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"code",
"excise_mark",
"name",
"pending_count",
"source_count"
],
"field_specs": {
"code": {
"title": "Код товару або акцизної марки",
"description": "Повернене значення «Код товару або акцизної марки» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "1001"
},
"excise_mark": {
"title": "Excise mark",
"description": "Повернене значення «Excise mark» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"name": {
"title": "Назва",
"description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Тестовий товар"
},
"pending_count": {
"title": "Pending count",
"description": "Повернене значення «Pending count» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"source_count": {
"title": "Source count",
"description": "Повернене значення «Source count» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.excise_validate_return_marks",
"params": {
"kasm": 1,
"source_check": 0,
"source_ndoc": 1
},
"id": "example-pos-excise-validate-return-marks"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.excise_validate_return_marks",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "excise_validate_return_marks",
"value": "1"
},
"rows": [
{
"code": "1001",
"excise_mark": "Приклад",
"name": "Тестовий товар",
"pending_count": "Приклад",
"source_count": "Приклад"
}
]
},
"id": "example-pos-excise-validate-return-marks"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_fiscal_error_move_empty_orderПереміщує порожнє фіскальне замовлення до списку помилок ПРРО.
запис
pos.write
з 0.4.0
Переміщує порожнє фіскальне замовлення до списку помилок ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
error_textТекст помилки | Поле «Текст помилки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
ncНомер чека | Номер касового чека у базі поточного клієнта. | string | обов’язковийПриклад: "Приклад" |
Точна схема параметрів
{
"error_text": {
"type": "string",
"max": 60000,
"default": "",
"title": "Текст помилки",
"description": "Поле «Текст помилки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"nc": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер чека",
"description": "Номер касового чека у базі поточного клієнта.",
"group": "Додаткові",
"example": "Приклад"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
moved_to_errorMoved to error | Повернене значення «Moved to error» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
deleted_from_fiscalDeleted from fiscal | Повернене значення «Deleted from fiscal» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"moved_to_error",
"deleted_from_fiscal"
],
"field_specs": {
"moved_to_error": {
"title": "Moved to error",
"description": "Повернене значення «Moved to error» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"deleted_from_fiscal": {
"title": "Deleted from fiscal",
"description": "Повернене значення «Deleted from fiscal» відповідного запису, документа або підсумку 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-prro-fiscal-error-move-empty-order-0001
{
"method": "pos.prro_fiscal_error_move_empty_order",
"params": {
"nc": "Приклад"
},
"id": "example-pos-prro-fiscal-error-move-empty-order"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_fiscal_error_move_empty_order",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_fiscal_error_move_empty_order",
"value": "1"
},
"rows": [
{
"moved_to_error": "Приклад",
"deleted_from_fiscal": "Приклад"
}
]
},
"id": "example-pos-prro-fiscal-error-move-empty-order"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_fiscal_lookupЗнаходить фіскальні дані чека для обміну з ПРРО.
читання
pos.read
з 0.4.0
Знаходить фіскальні дані чека для обміну з ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
ncНомер чека | Номер касового чека у базі поточного клієнта. | string | обов’язковийПриклад: "Приклад" |
| Фіскалізація | |||
nprroНомер ПРРО | Поле «Номер ПРРО» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "4000000001"За замовчуванням: "" |
Точна схема параметрів
{
"nc": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер чека",
"description": "Номер касового чека у базі поточного клієнта.",
"group": "Додаткові",
"example": "Приклад"
},
"nprro": {
"type": "string",
"max": 4096,
"default": "",
"title": "Номер ПРРО",
"description": "Поле «Номер ПРРО» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
order_tax_numberOrder tax number | Повернене значення «Order tax number» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
order_datetimeOrder datetime | Повернені дата й час «Order datetime» у форматі ISO 8601. | string · date-time | "2026-07-23T12:00:00+03:00" |
totalTotal | Кількість рядків або об’єктів у результаті операції. | string · decimal-string · currency-of-operation | "100.00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"order_tax_number",
"order_datetime",
"total"
],
"field_specs": {
"order_tax_number": {
"title": "Order tax number",
"description": "Повернене значення «Order tax number» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"order_datetime": {
"title": "Order datetime",
"description": "Повернені дата й час «Order datetime» у форматі ISO 8601.",
"type": "string",
"format": "date-time",
"example": "2026-07-23T12:00:00+03:00"
},
"total": {
"title": "Total",
"description": "Кількість рядків або об’єктів у результаті операції.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_fiscal_lookup",
"params": {
"nc": "Приклад"
},
"id": "example-pos-prro-fiscal-lookup"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_fiscal_lookup",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_fiscal_lookup",
"value": "1"
},
"rows": [
{
"order_tax_number": "Приклад",
"order_datetime": "2026-07-23T12:00:00+03:00",
"total": "100.00"
}
]
},
"id": "example-pos-prro-fiscal-lookup"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_fiscal_order_tax_updateОновлює податкові суми фіскального замовлення ПРРО.
запис
pos.write
з 0.4.0
Оновлює податкові суми фіскального замовлення ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
ncНомер чека | Номер касового чека у базі поточного клієнта. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
| Фіскалізація | |||
order_tax_numПодатковий номер документа | Поле «Податковий номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
Точна схема параметрів
{
"nc": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер чека",
"description": "Номер касового чека у базі поточного клієнта.",
"group": "Додаткові",
"example": 1
},
"order_tax_num": {
"type": "string",
"max": 4096,
"required": true,
"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-pos-prro-fiscal-order-tax-update-0001
{
"method": "pos.prro_fiscal_order_tax_update",
"params": {
"order_tax_num": "Приклад"
},
"id": "example-pos-prro-fiscal-order-tax-update"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_fiscal_order_tax_update",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_fiscal_order_tax_update",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-prro-fiscal-order-tax-update"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_fiscal_restore_from_errorПовертає фіскальний документ зі списку помилок до обробки ПРРО.
запис
pos.write
з 0.4.0
Повертає фіскальний документ зі списку помилок до обробки ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Фіскалізація | |||
original_order_tax_numOriginal order tax num | Поле «Original order tax num» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
recalculated_order_tax_numRecalculated order tax num | Поле «Recalculated order tax num» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
Точна схема параметрів
{
"original_order_tax_num": {
"type": "string",
"max": 4096,
"required": true,
"title": "Original order tax num",
"description": "Поле «Original order tax num» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"example": "Приклад"
},
"recalculated_order_tax_num": {
"type": "string",
"max": 4096,
"default": "",
"title": "Recalculated order tax num",
"description": "Поле «Recalculated order tax num» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"example": ""
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
fiscal_countFiscal count | Повернене значення «Fiscal count» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
error_countError count | Повернене значення «Error count» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
restored_countRestored count | Повернене значення «Restored count» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
deleted_error_countDeleted error count | Повернене значення «Deleted error count» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
updated_fiscal_countUpdated fiscal count | Повернене значення «Updated fiscal count» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"fiscal_count",
"error_count",
"restored_count",
"deleted_error_count",
"updated_fiscal_count"
],
"field_specs": {
"fiscal_count": {
"title": "Fiscal count",
"description": "Повернене значення «Fiscal count» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"error_count": {
"title": "Error count",
"description": "Повернене значення «Error count» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"restored_count": {
"title": "Restored count",
"description": "Повернене значення «Restored count» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"deleted_error_count": {
"title": "Deleted error count",
"description": "Повернене значення «Deleted error count» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"updated_fiscal_count": {
"title": "Updated fiscal count",
"description": "Повернене значення «Updated fiscal count» відповідного запису, документа або підсумку 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-prro-fiscal-restore-from-error-0001
{
"method": "pos.prro_fiscal_restore_from_error",
"params": {
"original_order_tax_num": "Приклад"
},
"id": "example-pos-prro-fiscal-restore-from-error"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_fiscal_restore_from_error",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_fiscal_restore_from_error",
"value": "1"
},
"rows": [
{
"fiscal_count": "Приклад",
"error_count": "Приклад",
"restored_count": "Приклад",
"deleted_error_count": "Приклад",
"updated_fiscal_count": "Приклад"
}
]
},
"id": "example-pos-prro-fiscal-restore-from-error"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_inline_countПовертає кількість документів у черзі онлайн-обміну з ПРРО.
читання
pos.read
з 0.4.0
Повертає кількість документів у черзі онлайн-обміну з ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Дати й час | |||
endКінцева дата | Дата «Кінцева дата» у календарному форматі YYYY-MM-DD. | string · date | необов’язковийПриклад: "2026-07-23"За замовчуванням: "" |
startПочаткова дата | Дата «Початкова дата» у календарному форматі YYYY-MM-DD. | string · date | необов’язковийПриклад: "2026-07-23"За замовчуванням: "" |
| Додаткові | |||
exclude_service_docsExclude service docs | Визначає, чи застосовувати параметр «Exclude service docs». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: false |
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
scopeОбласть вибірки | Визначає, для каси чи для користувача виконується вибірка.
| enum | необов’язковийПриклад: "kas"За замовчуванням: "kas" |
statusСтатус | Поле «Статус» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
Точна схема параметрів
{
"end": {
"type": "string",
"max": 4096,
"default": "",
"title": "Кінцева дата",
"description": "Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
},
"exclude_service_docs": {
"type": "bool",
"default": false,
"title": "Exclude service docs",
"description": "Визначає, чи застосовувати параметр «Exclude service docs». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
},
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"scope": {
"type": "enum",
"values": [
"kas",
"user"
],
"default": "kas",
"title": "Область вибірки",
"description": "Визначає, для каси чи для користувача виконується вибірка.",
"group": "Додаткові",
"example": "kas",
"enum_labels": {
"kas": "для каси",
"user": "для користувача"
}
},
"start": {
"type": "string",
"max": 4096,
"default": "",
"title": "Початкова дата",
"description": "Дата «Початкова дата» у календарному форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
},
"status": {
"type": "int",
"min": 0,
"max": 9,
"default": 0,
"title": "Статус",
"description": "Поле «Статус» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
countCount | Кількість рядків або об’єктів у результаті операції. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"count"
],
"field_specs": {
"count": {
"title": "Count",
"description": "Кількість рядків або об’єктів у результаті операції.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_inline_count",
"params": {
"kasm": "Касове місце N1",
"numprro": "4000000001"
},
"id": "example-pos-prro-inline-count"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_count",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_count",
"value": "1"
},
"rows": [
{
"count": "Приклад"
}
]
},
"id": "example-pos-prro-inline-count"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_inline_enqueueСтавить фіскальний документ у чергу онлайн-обміну з ПРРО.
запис
pos.write
з 0.4.0
Ставить фіскальний документ у чергу онлайн-обміну з ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
control_codeКонтрольний код ПРРО | Поле «Контрольний код ПРРО» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
doc_typeТип документа | Поле «Тип документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "0"За замовчуванням: "0" |
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
local_doc_numberЛокальний номер документа | Поле «Локальний номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
local_numЛокальний порядковий номер | Поле «Локальний порядковий номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
offline_session_idІдентифікатор офлайн-сесії | Ідентифікатор «Ідентифікатор офлайн-сесії», отриманий із результату відповідного методу читання цієї бази. | string | необов’язковийПриклад: ""За замовчуванням: "" |
| Фіскалізація | |||
doc_hashХеш документа | Поле «Хеш документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string · sha256 | необов’язковийПриклад: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"За замовчуванням: "" |
fiscal_numberФіскальний номер | Поле «Фіскальний номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "4000000001"За замовчуванням: "" |
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
prev_doc_hashPrev doc hash | Поле «Prev doc hash» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string · sha256 | необов’язковийПриклад: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"За замовчуванням: "" |
xml_body_b64XML документа у Base64 | Поле «XML документа у Base64» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string · byte | обов’язковийПриклад: "PHhtbD5leGFtcGxlPC94bWw+" |
Точна схема параметрів
{
"control_code": {
"type": "string",
"max": 512,
"default": "",
"title": "Контрольний код ПРРО",
"description": "Поле «Контрольний код ПРРО» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"doc_hash": {
"type": "string",
"max": 4096,
"default": "",
"title": "Хеш документа",
"description": "Поле «Хеш документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"format": "sha256",
"example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"doc_type": {
"type": "string",
"max": 512,
"default": "0",
"title": "Тип документа",
"description": "Поле «Тип документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "0"
},
"fiscal_number": {
"type": "string",
"max": 4096,
"default": "",
"title": "Фіскальний номер",
"description": "Поле «Фіскальний номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"local_doc_number": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Локальний номер документа",
"description": "Поле «Локальний номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"local_num": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Локальний порядковий номер",
"description": "Поле «Локальний порядковий номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"offline_session_id": {
"type": "string",
"max": 4096,
"default": "",
"title": "Ідентифікатор офлайн-сесії",
"description": "Ідентифікатор «Ідентифікатор офлайн-сесії», отриманий із результату відповідного методу читання цієї бази.",
"group": "Додаткові",
"example": ""
},
"prev_doc_hash": {
"type": "string",
"max": 4096,
"default": "",
"title": "Prev doc hash",
"description": "Поле «Prev doc hash» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"format": "sha256",
"example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"xml_body_b64": {
"type": "string",
"max": 60000,
"required": true,
"title": "XML документа у Base64",
"description": "Поле «XML документа у Base64» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"format": "byte",
"example": "PHhtbD5leGFtcGxlPC94bWw+"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
idІдентифікатор запису | Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"id"
],
"field_specs": {
"id": {
"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-prro-inline-enqueue-0001
{
"method": "pos.prro_inline_enqueue",
"params": {
"kasm": "Касове місце N1",
"numprro": "4000000001",
"xml_body_b64": "PHhtbD5leGFtcGxlPC94bWw+"
},
"id": "example-pos-prro-inline-enqueue"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_enqueue",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_enqueue",
"value": "1"
},
"rows": [
{
"id": "Приклад"
}
]
},
"id": "example-pos-prro-inline-enqueue"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_inline_error_docsПовертає документи онлайн-черги ПРРО, оброблені з помилкою.
читання
pos.read
з 0.4.0
Повертає документи онлайн-черги ПРРО, оброблені з помилкою.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Дати й час | |||
endКінцева дата | Дата «Кінцева дата» у календарному форматі YYYY-MM-DD. | string · date | обов’язковийПриклад: "2026-07-23" |
startПочаткова дата | Дата «Початкова дата» у календарному форматі YYYY-MM-DD. | string · date | обов’язковийПриклад: "2026-07-23" |
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
scopeОбласть вибірки | Визначає, для каси чи для користувача виконується вибірка.
| enum | необов’язковийПриклад: "kas"За замовчуванням: "kas" |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
Точна схема параметрів
{
"end": {
"type": "string",
"max": 4096,
"required": true,
"title": "Кінцева дата",
"description": "Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
},
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"scope": {
"type": "enum",
"values": [
"kas",
"user"
],
"default": "kas",
"title": "Область вибірки",
"description": "Визначає, для каси чи для користувача виконується вибірка.",
"group": "Додаткові",
"example": "kas",
"enum_labels": {
"kas": "для каси",
"user": "для користувача"
}
},
"start": {
"type": "string",
"max": 4096,
"required": true,
"title": "Початкова дата",
"description": "Дата «Початкова дата» у календарному форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
idІдентифікатор запису | Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
doc_typeТип документа | Повернене значення «Тип документа» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
created_atДата й час створення | Повернені дата й час «Дата й час створення» у форматі ISO 8601. | string · date-time | "2026-07-23T12:00:00+03:00" |
xml_body_b64XML документа у Base64 | Повернене значення «XML документа у Base64» відповідного запису, документа або підсумку ARM20. | string · byte | "PHhtbD5leGFtcGxlPC94bWw+" |
fiscal_numberФіскальний номер | Повернене значення «Фіскальний номер» відповідного запису, документа або підсумку ARM20. | string | "4000000001" |
Точна схема результату
{
"mode": "rows",
"columns": [
"id",
"doc_type",
"created_at",
"xml_body_b64",
"fiscal_number"
],
"field_specs": {
"id": {
"title": "Ідентифікатор запису",
"description": "Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"doc_type": {
"title": "Тип документа",
"description": "Повернене значення «Тип документа» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"created_at": {
"title": "Дата й час створення",
"description": "Повернені дата й час «Дата й час створення» у форматі ISO 8601.",
"type": "string",
"format": "date-time",
"example": "2026-07-23T12:00:00+03:00"
},
"xml_body_b64": {
"title": "XML документа у Base64",
"description": "Повернене значення «XML документа у Base64» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"format": "byte",
"example": "PHhtbD5leGFtcGxlPC94bWw+"
},
"fiscal_number": {
"title": "Фіскальний номер",
"description": "Повернене значення «Фіскальний номер» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "4000000001"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_inline_error_docs",
"params": {
"end": "2026-07-31",
"kasm": "Касове місце N1",
"numprro": "4000000001",
"start": "2026-07-01"
},
"id": "example-pos-prro-inline-error-docs"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_error_docs",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_error_docs",
"value": "1"
},
"rows": [
{
"id": "Приклад",
"doc_type": "Приклад",
"created_at": "2026-07-23T12:00:00+03:00",
"xml_body_b64": "PHhtbD5leGFtcGxlPC94bWw+",
"fiscal_number": "4000000001"
}
]
},
"id": "example-pos-prro-inline-error-docs"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_inline_error_gridПовертає помилки онлайн-черги ПРРО для перегляду в таблиці.
читання
pos.read
з 0.4.0
Повертає помилки онлайн-черги ПРРО для перегляду в таблиці.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Дати й час | |||
endКінцева дата | Дата «Кінцева дата» у календарному форматі YYYY-MM-DD. | string · date | обов’язковийПриклад: "2026-07-23" |
startПочаткова дата | Дата «Початкова дата» у календарному форматі YYYY-MM-DD. | string · date | обов’язковийПриклад: "2026-07-23" |
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
scopeОбласть вибірки | Визначає, для каси чи для користувача виконується вибірка.
| enum | необов’язковийПриклад: "kas"За замовчуванням: "kas" |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
Точна схема параметрів
{
"end": {
"type": "string",
"max": 4096,
"required": true,
"title": "Кінцева дата",
"description": "Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
},
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"scope": {
"type": "enum",
"values": [
"kas",
"user"
],
"default": "kas",
"title": "Область вибірки",
"description": "Визначає, для каси чи для користувача виконується вибірка.",
"group": "Додаткові",
"example": "kas",
"enum_labels": {
"kas": "для каси",
"user": "для користувача"
}
},
"start": {
"type": "string",
"max": 4096,
"required": true,
"title": "Початкова дата",
"description": "Дата «Початкова дата» у календарному форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
idІдентифікатор запису | Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
created_atДата й час створення | Повернені дата й час «Дата й час створення» у форматі ISO 8601. | string · date-time | "2026-07-23T12:00:00+03:00" |
offline_session_idІдентифікатор офлайн-сесії | Повернене значення «Ідентифікатор офлайн-сесії» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
local_doc_numberЛокальний номер документа | Повернене значення «Локальний номер документа» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
local_numЛокальний порядковий номер | Повернене значення «Локальний порядковий номер» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
fiscal_numberФіскальний номер | Повернене значення «Фіскальний номер» відповідного запису, документа або підсумку ARM20. | string | "4000000001" |
doc_typeТип документа | Повернене значення «Тип документа» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
control_codeКонтрольний код ПРРО | Повернене значення «Контрольний код ПРРО» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
doc_hashХеш документа | Повернене значення «Хеш документа» відповідного запису, документа або підсумку ARM20. | string · sha256 | "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" |
prev_doc_hashPrev doc hash | Повернене значення «Prev doc hash» відповідного запису, документа або підсумку ARM20. | string · sha256 | "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" |
user_idІдентифікатор користувача | Повернене значення «Ідентифікатор користувача» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
last_errorLast error | Повернене значення «Last error» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"id",
"created_at",
"offline_session_id",
"local_doc_number",
"local_num",
"fiscal_number",
"doc_type",
"control_code",
"doc_hash",
"prev_doc_hash",
"user_id",
"last_error"
],
"field_specs": {
"id": {
"title": "Ідентифікатор запису",
"description": "Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"created_at": {
"title": "Дата й час створення",
"description": "Повернені дата й час «Дата й час створення» у форматі ISO 8601.",
"type": "string",
"format": "date-time",
"example": "2026-07-23T12:00:00+03:00"
},
"offline_session_id": {
"title": "Ідентифікатор офлайн-сесії",
"description": "Повернене значення «Ідентифікатор офлайн-сесії» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"local_doc_number": {
"title": "Локальний номер документа",
"description": "Повернене значення «Локальний номер документа» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"local_num": {
"title": "Локальний порядковий номер",
"description": "Повернене значення «Локальний порядковий номер» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"fiscal_number": {
"title": "Фіскальний номер",
"description": "Повернене значення «Фіскальний номер» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "4000000001"
},
"doc_type": {
"title": "Тип документа",
"description": "Повернене значення «Тип документа» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"control_code": {
"title": "Контрольний код ПРРО",
"description": "Повернене значення «Контрольний код ПРРО» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"doc_hash": {
"title": "Хеш документа",
"description": "Повернене значення «Хеш документа» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"format": "sha256",
"example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"prev_doc_hash": {
"title": "Prev doc hash",
"description": "Повернене значення «Prev doc hash» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"format": "sha256",
"example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"user_id": {
"title": "Ідентифікатор користувача",
"description": "Повернене значення «Ідентифікатор користувача» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"last_error": {
"title": "Last error",
"description": "Повернене значення «Last error» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_inline_error_grid",
"params": {
"end": "2026-07-31",
"kasm": "Касове місце N1",
"numprro": "4000000001",
"start": "2026-07-01"
},
"id": "example-pos-prro-inline-error-grid"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_error_grid",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_error_grid",
"value": "1"
},
"rows": [
{
"id": "Приклад",
"created_at": "2026-07-23T12:00:00+03:00",
"offline_session_id": "Приклад",
"local_doc_number": "Приклад",
"local_num": "Приклад",
"fiscal_number": "4000000001",
"doc_type": "Приклад",
"control_code": "Приклад",
"doc_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"prev_doc_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"user_id": "Приклад",
"last_error": "Приклад"
}
]
},
"id": "example-pos-prro-inline-error-grid"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_inline_get_statusПовертає поточний стан документа в онлайн-черзі ПРРО.
читання
pos.read
з 0.4.0
Повертає поточний стан документа в онлайн-черзі ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
idІдентифікатор запису | Ідентифікатор запису у відповідному довіднику або таблиці ARM20. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
Точна схема параметрів
{
"id": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Ідентифікатор запису",
"description": "Ідентифікатор запису у відповідному довіднику або таблиці ARM20.",
"group": "Основні",
"example": 1
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
statusСтатус | Повернене значення «Статус» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"status"
],
"field_specs": {
"status": {
"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.prro_inline_get_status",
"params": {
"id": 1
},
"id": "example-pos-prro-inline-get-status"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_get_status",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_get_status",
"value": "1"
},
"rows": [
{
"status": "Приклад"
}
]
},
"id": "example-pos-prro-inline-get-status"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_inline_mark_errorПозначає документ онлайн-черги ПРРО як помилковий.
запис
pos.write
з 0.4.0
Позначає документ онлайн-черги ПРРО як помилковий.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
error_textТекст помилки | Поле «Текст помилки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
move_fiscalMove fiscal | Визначає, чи застосовувати параметр «Move fiscal». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: false |
| Основні | |||
idІдентифікатор запису | Ідентифікатор запису у відповідному довіднику або таблиці ARM20. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
| Фіскалізація | |||
order_tax_numПодатковий номер документа | Поле «Податковий номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
Точна схема параметрів
{
"error_text": {
"type": "string",
"max": 60000,
"default": "",
"title": "Текст помилки",
"description": "Поле «Текст помилки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"id": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Ідентифікатор запису",
"description": "Ідентифікатор запису у відповідному довіднику або таблиці ARM20.",
"group": "Основні",
"example": 1
},
"move_fiscal": {
"type": "bool",
"default": false,
"title": "Move fiscal",
"description": "Визначає, чи застосовувати параметр «Move fiscal». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
},
"order_tax_num": {
"type": "string",
"max": 4096,
"required": true,
"title": "Податковий номер документа",
"description": "Поле «Податковий номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"example": "Приклад"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
updatedUpdated | Повернене значення «Updated» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
moved_to_errorMoved to error | Повернене значення «Moved to error» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
deleted_from_fiscalDeleted from fiscal | Повернене значення «Deleted from fiscal» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"updated",
"moved_to_error",
"deleted_from_fiscal"
],
"field_specs": {
"updated": {
"title": "Updated",
"description": "Повернене значення «Updated» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"moved_to_error": {
"title": "Moved to error",
"description": "Повернене значення «Moved to error» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"deleted_from_fiscal": {
"title": "Deleted from fiscal",
"description": "Повернене значення «Deleted from fiscal» відповідного запису, документа або підсумку 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-prro-inline-mark-error-0001
{
"method": "pos.prro_inline_mark_error",
"params": {
"order_tax_num": "Приклад"
},
"id": "example-pos-prro-inline-mark-error"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_mark_error",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_mark_error",
"value": "1"
},
"rows": [
{
"updated": "Приклад",
"moved_to_error": "Приклад",
"deleted_from_fiscal": "Приклад"
}
]
},
"id": "example-pos-prro-inline-mark-error"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_inline_mark_sentПозначає документ онлайн-черги ПРРО як успішно надісланий.
запис
pos.write
з 0.4.0
Позначає документ онлайн-черги ПРРО як успішно надісланий.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
cashierКасир | Поле «Касир» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
order_numПорядковий номер | Поле «Порядковий номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "0"За замовчуванням: "0" |
record_typeТип запису | Варіант «Тип запису». Використовуйте лише одне зі значень, розшифрованих нижче.
| enum | необов’язковийПриклад: "none"За замовчуванням: "none" |
rtnsRtns | Поле «Rtns» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "0"За замовчуванням: "0" |
tax1Tax1 | Поле «Tax1» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "0"За замовчуванням: "0" |
tax2Tax2 | Поле «Tax2» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "0"За замовчуванням: "0" |
| Фіскалізація | |||
decoded_xml_b64Розкодований XML у Base64 | Поле «Розкодований XML у Base64» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string · byte | необов’язковийПриклад: "PHhtbD5leGFtcGxlPC94bWw+" |
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | необов’язковийПриклад: "4000000001"За замовчуванням: "1" |
order_tax_numПодатковий номер документа | Поле «Податковий номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
sent_xml_b64Надісланий XML у Base64 | Поле «Надісланий XML у Base64» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string · byte | необов’язковийПриклад: "PHhtbD5leGFtcGxlPC94bWw+" |
| Основні | |||
idІдентифікатор запису | Ідентифікатор запису у відповідному довіднику або таблиці ARM20. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
| Суми та кількості | |||
sumСума | Грошова сума як десятковий JSON-рядок без пробілів і символу валюти. | string · decimal-string · currency-of-operation | необов’язковийПриклад: "100.00"За замовчуванням: "0" |
Точна схема параметрів
{
"cashier": {
"type": "string",
"max": 4096,
"default": "",
"title": "Касир",
"description": "Поле «Касир» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"decoded_xml_b64": {
"type": "string",
"max": 60000,
"title": "Розкодований XML у Base64",
"description": "Поле «Розкодований XML у Base64» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"format": "byte",
"example": "PHhtbD5leGFtcGxlPC94bWw+"
},
"id": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Ідентифікатор запису",
"description": "Ідентифікатор запису у відповідному довіднику або таблиці ARM20.",
"group": "Основні",
"example": 1
},
"numprro": {
"type": "string",
"max": 4096,
"default": "1",
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"order_num": {
"type": "string",
"max": 4096,
"default": "0",
"title": "Порядковий номер",
"description": "Поле «Порядковий номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "0"
},
"order_tax_num": {
"type": "string",
"max": 4096,
"default": "",
"title": "Податковий номер документа",
"description": "Поле «Податковий номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"example": ""
},
"record_type": {
"type": "enum",
"values": [
"none",
"shift",
"zrep"
],
"default": "none",
"title": "Тип запису",
"description": "Варіант «Тип запису». Використовуйте лише одне зі значень, розшифрованих нижче.",
"group": "Додаткові",
"example": "none",
"enum_labels": {
"none": "звичайний документ",
"shift": "подія зміни",
"zrep": "Z-звіт"
}
},
"rtns": {
"type": "string",
"max": 4096,
"default": "0",
"title": "Rtns",
"description": "Поле «Rtns» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "0"
},
"sent_xml_b64": {
"type": "string",
"max": 60000,
"title": "Надісланий XML у Base64",
"description": "Поле «Надісланий XML у Base64» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"format": "byte",
"example": "PHhtbD5leGFtcGxlPC94bWw+"
},
"sum": {
"type": "string",
"max": 4096,
"default": "0",
"title": "Сума",
"description": "Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"tax1": {
"type": "string",
"max": 4096,
"default": "0",
"title": "Tax1",
"description": "Поле «Tax1» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "0"
},
"tax2": {
"type": "string",
"max": 4096,
"default": "0",
"title": "Tax2",
"description": "Поле «Tax2» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "0"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
updatedUpdated | Повернене значення «Updated» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
extra_writtenExtra written | Повернене значення «Extra written» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"updated",
"extra_written"
],
"field_specs": {
"updated": {
"title": "Updated",
"description": "Повернене значення «Updated» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"extra_written": {
"title": "Extra written",
"description": "Повернене значення «Extra written» відповідного запису, документа або підсумку 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-prro-inline-mark-sent-0001
{
"method": "pos.prro_inline_mark_sent",
"params": {
"sum": "Приклад",
"id": 1
},
"id": "example-pos-prro-inline-mark-sent"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_mark_sent",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_mark_sent",
"value": "1"
},
"rows": [
{
"updated": "Приклад",
"extra_written": "Приклад"
}
]
},
"id": "example-pos-prro-inline-mark-sent"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_inline_max_local_docПовертає найбільший локальний номер документа онлайн-черги ПРРО.
читання
pos.read
з 0.4.0
Повертає найбільший локальний номер документа онлайн-черги ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | необов’язковийПриклад: "4000000001"За замовчуванням: "1" |
| Додаткові | |||
offline_session_idІдентифікатор офлайн-сесії | Ідентифікатор «Ідентифікатор офлайн-сесії», отриманий із результату відповідного методу читання цієї бази. | string | обов’язковийПриклад: "Приклад" |
Точна схема параметрів
{
"numprro": {
"type": "string",
"max": 4096,
"default": "1",
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"offline_session_id": {
"type": "string",
"max": 4096,
"required": true,
"title": "Ідентифікатор офлайн-сесії",
"description": "Ідентифікатор «Ідентифікатор офлайн-сесії», отриманий із результату відповідного методу читання цієї бази.",
"group": "Додаткові",
"example": "Приклад"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
max_local_doc_numberMax local doc number | Повернене значення «Max local doc number» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"max_local_doc_number"
],
"field_specs": {
"max_local_doc_number": {
"title": "Max local doc number",
"description": "Повернене значення «Max local doc number» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_inline_max_local_doc",
"params": {
"offline_session_id": "Приклад"
},
"id": "example-pos-prro-inline-max-local-doc"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_max_local_doc",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_max_local_doc",
"value": "1"
},
"rows": [
{
"max_local_doc_number": "Приклад"
}
]
},
"id": "example-pos-prro-inline-max-local-doc"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_inline_max_local_numПовертає найбільший локальний порядковий номер онлайн-черги ПРРО.
читання
pos.read
з 0.4.0
Повертає найбільший локальний порядковий номер онлайн-черги ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
scopeОбласть вибірки | Визначає, для каси чи для користувача виконується вибірка.
| enum | необов’язковийПриклад: "kas"За замовчуванням: "kas" |
statusСтатус | Поле «Статус» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
Точна схема параметрів
{
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"scope": {
"type": "enum",
"values": [
"kas",
"user"
],
"default": "kas",
"title": "Область вибірки",
"description": "Визначає, для каси чи для користувача виконується вибірка.",
"group": "Додаткові",
"example": "kas",
"enum_labels": {
"kas": "для каси",
"user": "для користувача"
}
},
"status": {
"type": "int",
"min": 0,
"max": 9,
"default": 0,
"title": "Статус",
"description": "Поле «Статус» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
max_local_numMax local num | Повернене значення «Max local num» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"max_local_num"
],
"field_specs": {
"max_local_num": {
"title": "Max local num",
"description": "Повернене значення «Max local num» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_inline_max_local_num",
"params": {
"kasm": "Касове місце N1",
"numprro": "4000000001"
},
"id": "example-pos-prro-inline-max-local-num"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_max_local_num",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_max_local_num",
"value": "1"
},
"rows": [
{
"max_local_num": "Приклад"
}
]
},
"id": "example-pos-prro-inline-max-local-num"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_inline_nextПовертає наступний документ для надсилання до ПРРО.
читання
pos.read
з 0.4.0
Повертає наступний документ для надсилання до ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
scopeОбласть вибірки | Визначає, для каси чи для користувача виконується вибірка.
| enum | необов’язковийПриклад: "kas"За замовчуванням: "kas" |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
Точна схема параметрів
{
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"scope": {
"type": "enum",
"values": [
"kas",
"user"
],
"default": "kas",
"title": "Область вибірки",
"description": "Визначає, для каси чи для користувача виконується вибірка.",
"group": "Додаткові",
"example": "kas",
"enum_labels": {
"kas": "для каси",
"user": "для користувача"
}
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
idІдентифікатор запису | Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
xml_body_b64XML документа у Base64 | Повернене значення «XML документа у Base64» відповідного запису, документа або підсумку ARM20. | string · byte | "PHhtbD5leGFtcGxlPC94bWw+" |
local_numЛокальний порядковий номер | Повернене значення «Локальний порядковий номер» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
fiscal_numberФіскальний номер | Повернене значення «Фіскальний номер» відповідного запису, документа або підсумку ARM20. | string | "4000000001" |
local_doc_numberЛокальний номер документа | Повернене значення «Локальний номер документа» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
doc_typeТип документа | Повернене значення «Тип документа» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"id",
"xml_body_b64",
"local_num",
"fiscal_number",
"local_doc_number",
"doc_type"
],
"field_specs": {
"id": {
"title": "Ідентифікатор запису",
"description": "Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"xml_body_b64": {
"title": "XML документа у Base64",
"description": "Повернене значення «XML документа у Base64» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"format": "byte",
"example": "PHhtbD5leGFtcGxlPC94bWw+"
},
"local_num": {
"title": "Локальний порядковий номер",
"description": "Повернене значення «Локальний порядковий номер» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"fiscal_number": {
"title": "Фіскальний номер",
"description": "Повернене значення «Фіскальний номер» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "4000000001"
},
"local_doc_number": {
"title": "Локальний номер документа",
"description": "Повернене значення «Локальний номер документа» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"doc_type": {
"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.prro_inline_next",
"params": {
"kasm": "Касове місце N1",
"numprro": "4000000001"
},
"id": "example-pos-prro-inline-next"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_next",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_next",
"value": "1"
},
"rows": [
{
"id": "Приклад",
"xml_body_b64": "PHhtbD5leGFtcGxlPC94bWw+",
"local_num": "Приклад",
"fiscal_number": "4000000001",
"local_doc_number": "Приклад",
"doc_type": "Приклад"
}
]
},
"id": "example-pos-prro-inline-next"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_inline_pending_by_prroПовертає незавершені документи вибраного ПРРО.
читання
pos.read
з 0.4.0
Повертає незавершені документи вибраного ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
Точна схема параметрів
{
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
prro_numberPrro number | Повернене значення «Prro number» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
countCount | Кількість рядків або об’єктів у результаті операції. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"prro_number",
"count"
],
"field_specs": {
"prro_number": {
"title": "Prro number",
"description": "Повернене значення «Prro number» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"count": {
"title": "Count",
"description": "Кількість рядків або об’єктів у результаті операції.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_inline_pending_by_prro",
"params": {
"kasm": "Касове місце N1"
},
"id": "example-pos-prro-inline-pending-by-prro"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_pending_by_prro",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_pending_by_prro",
"value": "1"
},
"rows": [
{
"prro_number": "Приклад",
"count": "Приклад"
}
]
},
"id": "example-pos-prro-inline-pending-by-prro"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_inline_pending_countПовертає кількість незавершених документів онлайн-черги ПРРО.
читання
pos.read
з 0.4.0
Повертає кількість незавершених документів онлайн-черги ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
non_shift_onlyЛише документи поза зміною | Визначає, чи застосовувати параметр «Лише документи поза зміною». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: false |
scopeОбласть вибірки | Визначає, для каси чи для користувача виконується вибірка.
| enum | необов’язковийПриклад: "kas"За замовчуванням: "kas" |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
Точна схема параметрів
{
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"non_shift_only": {
"type": "bool",
"default": false,
"title": "Лише документи поза зміною",
"description": "Визначає, чи застосовувати параметр «Лише документи поза зміною». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"scope": {
"type": "enum",
"values": [
"kas",
"user"
],
"default": "kas",
"title": "Область вибірки",
"description": "Визначає, для каси чи для користувача виконується вибірка.",
"group": "Додаткові",
"example": "kas",
"enum_labels": {
"kas": "для каси",
"user": "для користувача"
}
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
countCount | Кількість рядків або об’єктів у результаті операції. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"count"
],
"field_specs": {
"count": {
"title": "Count",
"description": "Кількість рядків або об’єктів у результаті операції.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_inline_pending_count",
"params": {
"kasm": "Касове місце N1",
"numprro": "4000000001"
},
"id": "example-pos-prro-inline-pending-count"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_pending_count",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_pending_count",
"value": "1"
},
"rows": [
{
"count": "Приклад"
}
]
},
"id": "example-pos-prro-inline-pending-count"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_inline_pending_gridПовертає незавершені документи онлайн-черги ПРРО для таблиці.
читання
pos.read
з 0.4.0
Повертає незавершені документи онлайн-черги ПРРО для таблиці.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
scopeОбласть вибірки | Визначає, для каси чи для користувача виконується вибірка.
| enum | необов’язковийПриклад: "kas"За замовчуванням: "kas" |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
Точна схема параметрів
{
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"scope": {
"type": "enum",
"values": [
"kas",
"user"
],
"default": "kas",
"title": "Область вибірки",
"description": "Визначає, для каси чи для користувача виконується вибірка.",
"group": "Додаткові",
"example": "kas",
"enum_labels": {
"kas": "для каси",
"user": "для користувача"
}
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
idІдентифікатор запису | Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
offline_session_idІдентифікатор офлайн-сесії | Повернене значення «Ідентифікатор офлайн-сесії» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
local_doc_numberЛокальний номер документа | Повернене значення «Локальний номер документа» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
local_numЛокальний порядковий номер | Повернене значення «Локальний порядковий номер» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
fiscal_numberФіскальний номер | Повернене значення «Фіскальний номер» відповідного запису, документа або підсумку ARM20. | string | "4000000001" |
doc_typeТип документа | Повернене значення «Тип документа» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
control_codeКонтрольний код ПРРО | Повернене значення «Контрольний код ПРРО» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
doc_hashХеш документа | Повернене значення «Хеш документа» відповідного запису, документа або підсумку ARM20. | string · sha256 | "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" |
prev_doc_hashPrev doc hash | Повернене значення «Prev doc hash» відповідного запису, документа або підсумку ARM20. | string · sha256 | "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" |
user_idІдентифікатор користувача | Повернене значення «Ідентифікатор користувача» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"id",
"offline_session_id",
"local_doc_number",
"local_num",
"fiscal_number",
"doc_type",
"control_code",
"doc_hash",
"prev_doc_hash",
"user_id"
],
"field_specs": {
"id": {
"title": "Ідентифікатор запису",
"description": "Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"offline_session_id": {
"title": "Ідентифікатор офлайн-сесії",
"description": "Повернене значення «Ідентифікатор офлайн-сесії» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"local_doc_number": {
"title": "Локальний номер документа",
"description": "Повернене значення «Локальний номер документа» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"local_num": {
"title": "Локальний порядковий номер",
"description": "Повернене значення «Локальний порядковий номер» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"fiscal_number": {
"title": "Фіскальний номер",
"description": "Повернене значення «Фіскальний номер» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "4000000001"
},
"doc_type": {
"title": "Тип документа",
"description": "Повернене значення «Тип документа» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"control_code": {
"title": "Контрольний код ПРРО",
"description": "Повернене значення «Контрольний код ПРРО» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"doc_hash": {
"title": "Хеш документа",
"description": "Повернене значення «Хеш документа» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"format": "sha256",
"example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"prev_doc_hash": {
"title": "Prev doc hash",
"description": "Повернене значення «Prev doc hash» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"format": "sha256",
"example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"user_id": {
"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.prro_inline_pending_grid",
"params": {
"kasm": "Касове місце N1",
"numprro": "4000000001"
},
"id": "example-pos-prro-inline-pending-grid"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_pending_grid",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_pending_grid",
"value": "1"
},
"rows": [
{
"id": "Приклад",
"offline_session_id": "Приклад",
"local_doc_number": "Приклад",
"local_num": "Приклад",
"fiscal_number": "4000000001",
"doc_type": "Приклад",
"control_code": "Приклад",
"doc_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"prev_doc_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"user_id": "Приклад"
}
]
},
"id": "example-pos-prro-inline-pending-grid"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_inline_queue_rowsПовертає рядки онлайн-черги фіскальних документів ПРРО.
читання
pos.read
з 0.4.0
Повертає рядки онлайн-черги фіскальних документів ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
scopeОбласть вибірки | Визначає, для каси чи для користувача виконується вибірка.
| enum | необов’язковийПриклад: "kas"За замовчуванням: "kas" |
statusСтатус | Поле «Статус» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
Точна схема параметрів
{
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"scope": {
"type": "enum",
"values": [
"kas",
"user"
],
"default": "kas",
"title": "Область вибірки",
"description": "Визначає, для каси чи для користувача виконується вибірка.",
"group": "Додаткові",
"example": "kas",
"enum_labels": {
"kas": "для каси",
"user": "для користувача"
}
},
"status": {
"type": "int",
"min": 0,
"max": 9,
"default": 0,
"title": "Статус",
"description": "Поле «Статус» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
doc_typeТип документа | Повернене значення «Тип документа» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
xml_body_b64XML документа у Base64 | Повернене значення «XML документа у Base64» відповідного запису, документа або підсумку ARM20. | string · byte | "PHhtbD5leGFtcGxlPC94bWw+" |
local_numЛокальний порядковий номер | Повернене значення «Локальний порядковий номер» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"doc_type",
"xml_body_b64",
"local_num"
],
"field_specs": {
"doc_type": {
"title": "Тип документа",
"description": "Повернене значення «Тип документа» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"xml_body_b64": {
"title": "XML документа у Base64",
"description": "Повернене значення «XML документа у Base64» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"format": "byte",
"example": "PHhtbD5leGFtcGxlPC94bWw+"
},
"local_num": {
"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.prro_inline_queue_rows",
"params": {
"kasm": "Касове місце N1",
"numprro": "4000000001"
},
"id": "example-pos-prro-inline-queue-rows"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_queue_rows",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_queue_rows",
"value": "1"
},
"rows": [
{
"doc_type": "Приклад",
"xml_body_b64": "PHhtbD5leGFtcGxlPC94bWw+",
"local_num": "Приклад"
}
]
},
"id": "example-pos-prro-inline-queue-rows"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_inline_requeueПовертає помилковий документ до онлайн-черги ПРРО.
запис
pos.write
з 0.4.0
Повертає помилковий документ до онлайн-черги ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
control_codeКонтрольний код ПРРО | Поле «Контрольний код ПРРО» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
local_doc_numberЛокальний номер документа | Поле «Локальний номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
local_numЛокальний порядковий номер | Поле «Локальний порядковий номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
| Дати й час | |||
created_atДата й час створення | Дата й час «Дата й час створення» у форматі ISO 8601 із часовим поясом. | string · date-time | обов’язковийПриклад: "2026-07-23T12:00:00+03:00" |
| Фіскалізація | |||
doc_hashХеш документа | Поле «Хеш документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string · sha256 | необов’язковийПриклад: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"За замовчуванням: "" |
fiscal_numberФіскальний номер | Поле «Фіскальний номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "4000000001" |
prev_doc_hashPrev doc hash | Поле «Prev doc hash» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string · sha256 | необов’язковийПриклад: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"За замовчуванням: "" |
xml_body_b64XML документа у Base64 | Поле «XML документа у Base64» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string · byte | обов’язковийПриклад: "PHhtbD5leGFtcGxlPC94bWw+" |
| Основні | |||
idІдентифікатор запису | Ідентифікатор запису у відповідному довіднику або таблиці ARM20. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
Точна схема параметрів
{
"control_code": {
"type": "string",
"max": 512,
"default": "",
"title": "Контрольний код ПРРО",
"description": "Поле «Контрольний код ПРРО» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"created_at": {
"type": "string",
"max": 4096,
"required": true,
"title": "Дата й час створення",
"description": "Дата й час «Дата й час створення» у форматі ISO 8601 із часовим поясом.",
"group": "Дати й час",
"format": "date-time",
"example": "2026-07-23T12:00:00+03:00"
},
"doc_hash": {
"type": "string",
"max": 4096,
"default": "",
"title": "Хеш документа",
"description": "Поле «Хеш документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"format": "sha256",
"example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"fiscal_number": {
"type": "string",
"max": 4096,
"required": true,
"title": "Фіскальний номер",
"description": "Поле «Фіскальний номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"id": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Ідентифікатор запису",
"description": "Ідентифікатор запису у відповідному довіднику або таблиці ARM20.",
"group": "Основні",
"example": 1
},
"local_doc_number": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Локальний номер документа",
"description": "Поле «Локальний номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"local_num": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Локальний порядковий номер",
"description": "Поле «Локальний порядковий номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"prev_doc_hash": {
"type": "string",
"max": 4096,
"default": "",
"title": "Prev doc hash",
"description": "Поле «Prev doc hash» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"format": "sha256",
"example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"xml_body_b64": {
"type": "string",
"max": 60000,
"required": true,
"title": "XML документа у Base64",
"description": "Поле «XML документа у Base64» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"format": "byte",
"example": "PHhtbD5leGFtcGxlPC94bWw+"
}
}
Результат
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-pos-prro-inline-requeue-0001
{
"method": "pos.prro_inline_requeue",
"params": {
"created_at": "2026-07-23 12:00:00",
"fiscal_number": "4000000001",
"xml_body_b64": "PHhtbD5leGFtcGxlPC94bWw+"
},
"id": "example-pos-prro-inline-requeue"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_requeue",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_requeue",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-prro-inline-requeue"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_inline_set_statusЗмінює стан одного документа в онлайн-черзі ПРРО.
запис
pos.write
з 0.4.0
Змінює стан одного документа в онлайн-черзі ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
idІдентифікатор запису | Ідентифікатор запису у відповідному довіднику або таблиці ARM20. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
| Додаткові | |||
statusСтатус | Поле «Статус» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
Точна схема параметрів
{
"id": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Ідентифікатор запису",
"description": "Ідентифікатор запису у відповідному довіднику або таблиці ARM20.",
"group": "Основні",
"example": 1
},
"status": {
"type": "int",
"min": 0,
"max": 9,
"default": 0,
"title": "Статус",
"description": "Поле «Статус» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
}
}
Результат
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-pos-prro-inline-set-status-0001
{
"method": "pos.prro_inline_set_status",
"params": {
"id": 1,
"status": 0
},
"id": "example-pos-prro-inline-set-status"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_set_status",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_set_status",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-prro-inline-set-status"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_inline_set_status_by_filterЗмінює стан групи документів онлайн-черги ПРРО за заданим фільтром.
запис
pos.write
з 0.4.0
Змінює стан групи документів онлайн-черги ПРРО за заданим фільтром.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
from_statusПочатковий статус | Поле «Початковий статус» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
scopeОбласть вибірки | Визначає, для каси чи для користувача виконується вибірка.
| enum | необов’язковийПриклад: "kas"За замовчуванням: "kas" |
to_statusНовий статус | Поле «Новий статус» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
Точна схема параметрів
{
"from_status": {
"type": "int",
"min": 0,
"max": 9,
"default": 0,
"title": "Початковий статус",
"description": "Поле «Початковий статус» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"scope": {
"type": "enum",
"values": [
"kas",
"user"
],
"default": "kas",
"title": "Область вибірки",
"description": "Визначає, для каси чи для користувача виконується вибірка.",
"group": "Додаткові",
"example": "kas",
"enum_labels": {
"kas": "для каси",
"user": "для користувача"
}
},
"to_status": {
"type": "int",
"min": 0,
"max": 9,
"default": 0,
"title": "Новий статус",
"description": "Поле «Новий статус» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
}
}
Результат
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-pos-prro-inline-set-status-by-filter-0001
{
"method": "pos.prro_inline_set_status_by_filter",
"params": {
"kasm": "Касове місце N1",
"numprro": "4000000001"
},
"id": "example-pos-prro-inline-set-status-by-filter"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_inline_set_status_by_filter",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_inline_set_status_by_filter",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-prro-inline-set-status-by-filter"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_offline_countПовертає кількість документів у локальній офлайн-черзі ПРРО.
читання
pos.read
з 0.4.0
Повертає кількість документів у локальній офлайн-черзі ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
doc_typeТип документа | Поле «Тип документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
exclude_begin_docExclude begin doc | Визначає, чи застосовувати параметр «Exclude begin doc». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: false |
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
offline_session_idІдентифікатор офлайн-сесії | Ідентифікатор «Ідентифікатор офлайн-сесії», отриманий із результату відповідного методу читання цієї бази. | string | необов’язковийПриклад: ""За замовчуванням: "" |
scopeОбласть вибірки | Визначає, для каси чи для користувача виконується вибірка.
| enum | необов’язковийПриклад: "kas"За замовчуванням: "kas" |
statusСтатус | Поле «Статус» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
Точна схема параметрів
{
"doc_type": {
"type": "string",
"max": 512,
"default": "",
"title": "Тип документа",
"description": "Поле «Тип документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"exclude_begin_doc": {
"type": "bool",
"default": false,
"title": "Exclude begin doc",
"description": "Визначає, чи застосовувати параметр «Exclude begin doc». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
},
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"offline_session_id": {
"type": "string",
"max": 4096,
"default": "",
"title": "Ідентифікатор офлайн-сесії",
"description": "Ідентифікатор «Ідентифікатор офлайн-сесії», отриманий із результату відповідного методу читання цієї бази.",
"group": "Додаткові",
"example": ""
},
"scope": {
"type": "enum",
"values": [
"kas",
"user"
],
"default": "kas",
"title": "Область вибірки",
"description": "Визначає, для каси чи для користувача виконується вибірка.",
"group": "Додаткові",
"example": "kas",
"enum_labels": {
"kas": "для каси",
"user": "для користувача"
}
},
"status": {
"type": "int",
"min": 0,
"max": 9,
"default": 0,
"title": "Статус",
"description": "Поле «Статус» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
countCount | Кількість рядків або об’єктів у результаті операції. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"count"
],
"field_specs": {
"count": {
"title": "Count",
"description": "Кількість рядків або об’єктів у результаті операції.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_offline_count",
"params": {
"kasm": "Касове місце N1",
"numprro": "4000000001"
},
"id": "example-pos-prro-offline-count"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_offline_count",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_offline_count",
"value": "1"
},
"rows": [
{
"count": "Приклад"
}
]
},
"id": "example-pos-prro-offline-count"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_offline_enqueueСтавить фіскальний документ у локальну офлайн-чергу ПРРО.
запис
pos.write
з 0.4.0
Ставить фіскальний документ у локальну офлайн-чергу ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
control_codeКонтрольний код ПРРО | Поле «Контрольний код ПРРО» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
doc_typeТип документа | Поле «Тип документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "0"За замовчуванням: "0" |
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
local_doc_numberЛокальний номер документа | Поле «Локальний номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
local_numЛокальний порядковий номер | Поле «Локальний порядковий номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
offline_session_idІдентифікатор офлайн-сесії | Ідентифікатор «Ідентифікатор офлайн-сесії», отриманий із результату відповідного методу читання цієї бази. | string | обов’язковийПриклад: "Приклад" |
| Фіскалізація | |||
doc_hashХеш документа | Поле «Хеш документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string · sha256 | необов’язковийПриклад: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"За замовчуванням: "" |
fiscal_numberФіскальний номер | Поле «Фіскальний номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "4000000001"За замовчуванням: "" |
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
prev_doc_hashPrev doc hash | Поле «Prev doc hash» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string · sha256 | необов’язковийПриклад: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"За замовчуванням: "" |
xml_body_b64XML документа у Base64 | Поле «XML документа у Base64» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string · byte | обов’язковийПриклад: "PHhtbD5leGFtcGxlPC94bWw+" |
Точна схема параметрів
{
"control_code": {
"type": "string",
"max": 512,
"default": "",
"title": "Контрольний код ПРРО",
"description": "Поле «Контрольний код ПРРО» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"doc_hash": {
"type": "string",
"max": 4096,
"default": "",
"title": "Хеш документа",
"description": "Поле «Хеш документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"format": "sha256",
"example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"doc_type": {
"type": "string",
"max": 512,
"default": "0",
"title": "Тип документа",
"description": "Поле «Тип документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "0"
},
"fiscal_number": {
"type": "string",
"max": 4096,
"default": "",
"title": "Фіскальний номер",
"description": "Поле «Фіскальний номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"local_doc_number": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Локальний номер документа",
"description": "Поле «Локальний номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"local_num": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Локальний порядковий номер",
"description": "Поле «Локальний порядковий номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"offline_session_id": {
"type": "string",
"max": 4096,
"required": true,
"title": "Ідентифікатор офлайн-сесії",
"description": "Ідентифікатор «Ідентифікатор офлайн-сесії», отриманий із результату відповідного методу читання цієї бази.",
"group": "Додаткові",
"example": "Приклад"
},
"prev_doc_hash": {
"type": "string",
"max": 4096,
"default": "",
"title": "Prev doc hash",
"description": "Поле «Prev doc hash» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"format": "sha256",
"example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"xml_body_b64": {
"type": "string",
"max": 60000,
"required": true,
"title": "XML документа у Base64",
"description": "Поле «XML документа у Base64» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"format": "byte",
"example": "PHhtbD5leGFtcGxlPC94bWw+"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
idІдентифікатор запису | Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"id"
],
"field_specs": {
"id": {
"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-prro-offline-enqueue-0001
{
"method": "pos.prro_offline_enqueue",
"params": {
"kasm": "Касове місце N1",
"numprro": "4000000001",
"offline_session_id": "Приклад",
"xml_body_b64": "PHhtbD5leGFtcGxlPC94bWw+"
},
"id": "example-pos-prro-offline-enqueue"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_offline_enqueue",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_offline_enqueue",
"value": "1"
},
"rows": [
{
"id": "Приклад"
}
]
},
"id": "example-pos-prro-offline-enqueue"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_offline_max_local_docПовертає найбільший локальний номер офлайн-документа ПРРО.
читання
pos.read
з 0.4.0
Повертає найбільший локальний номер офлайн-документа ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
offline_session_idІдентифікатор офлайн-сесії | Ідентифікатор «Ідентифікатор офлайн-сесії», отриманий із результату відповідного методу читання цієї бази. | string | обов’язковийПриклад: "Приклад" |
Точна схема параметрів
{
"offline_session_id": {
"type": "string",
"max": 4096,
"required": true,
"title": "Ідентифікатор офлайн-сесії",
"description": "Ідентифікатор «Ідентифікатор офлайн-сесії», отриманий із результату відповідного методу читання цієї бази.",
"group": "Додаткові",
"example": "Приклад"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
max_local_doc_numberMax local doc number | Повернене значення «Max local doc number» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"max_local_doc_number"
],
"field_specs": {
"max_local_doc_number": {
"title": "Max local doc number",
"description": "Повернене значення «Max local doc number» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_offline_max_local_doc",
"params": {
"offline_session_id": "Приклад"
},
"id": "example-pos-prro-offline-max-local-doc"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_offline_max_local_doc",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_offline_max_local_doc",
"value": "1"
},
"rows": [
{
"max_local_doc_number": "Приклад"
}
]
},
"id": "example-pos-prro-offline-max-local-doc"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_offline_shift_eventРеєструє подію відкриття або закриття офлайн-зміни ПРРО.
запис
pos.write
з 0.4.0
Реєструє подію відкриття або закриття офлайн-зміни ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
columnКолонка стану | Варіант «Колонка стану». Використовуйте лише одне зі значень, розшифрованих нижче.
| enum | обов’язковийПриклад: "ShiftOpened" |
kasoruserКаса або користувач | Поле «Каса або користувач» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
ku_codeКод касового користувача | Поле «Код касового користувача» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
valueЗначення | Нове або шукане значення поля залежно від операції. | string | необов’язковийПриклад: ""За замовчуванням: "" |
| Фіскалізація | |||
fiscal_registration_numberФіскальний номер ПРРО | Поле «Фіскальний номер ПРРО» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
Точна схема параметрів
{
"column": {
"type": "enum",
"values": [
"ShiftOpened",
"Zreport",
"ShiftClosed"
],
"required": true,
"title": "Колонка стану",
"description": "Варіант «Колонка стану». Використовуйте лише одне зі значень, розшифрованих нижче.",
"group": "Додаткові",
"example": "ShiftOpened",
"enum_labels": {
"ShiftOpened": "ознака відкриття зміни",
"Zreport": "номер Z-звіту",
"ShiftClosed": "ознака закриття зміни"
}
},
"fiscal_registration_number": {
"type": "string",
"max": 4096,
"default": "",
"title": "Фіскальний номер ПРРО",
"description": "Поле «Фіскальний номер ПРРО» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"example": ""
},
"kasoruser": {
"type": "string",
"max": 512,
"required": true,
"title": "Каса або користувач",
"description": "Поле «Каса або користувач» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
},
"ku_code": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Код касового користувача",
"description": "Поле «Код касового користувача» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"value": {
"type": "string",
"max": 4096,
"default": "",
"title": "Значення",
"description": "Нове або шукане значення поля залежно від операції.",
"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-pos-prro-offline-shift-event-0001
{
"method": "pos.prro_offline_shift_event",
"params": {
"column": "ShiftOpened",
"kasoruser": "Приклад",
"numprro": "4000000001"
},
"id": "example-pos-prro-offline-shift-event"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_offline_shift_event",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_offline_shift_event",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-prro-offline-shift-event"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_offline_shift_getПовертає поточний стан офлайн-зміни ПРРО.
читання
pos.read
з 0.4.0
Повертає поточний стан офлайн-зміни ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
kasoruserКаса або користувач | Поле «Каса або користувач» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
ku_codeКод касового користувача | Поле «Код касового користувача» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
Точна схема параметрів
{
"kasoruser": {
"type": "string",
"max": 512,
"required": true,
"title": "Каса або користувач",
"description": "Поле «Каса або користувач» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
},
"ku_code": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Код касового користувача",
"description": "Поле «Код касового користувача» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
ownerOwner | Повернене значення «Owner» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
ku_codeКод касового користувача | Повернене значення «Код касового користувача» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
prro_numberPrro number | Повернене значення «Prro number» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
fiscal_registration_numberФіскальний номер ПРРО | Повернене значення «Фіскальний номер ПРРО» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
shift_openedShift opened | Повернене значення «Shift opened» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
z_reportZ report | Повернене значення «Z report» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
shift_closedShift closed | Повернене значення «Shift closed» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
updated_atUpdated at | Повернена дата «Updated at» у форматі YYYY-MM-DD. | string · date | "2026-07-23" |
stateState | Повернене значення «State» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"owner",
"ku_code",
"prro_number",
"fiscal_registration_number",
"shift_opened",
"z_report",
"shift_closed",
"updated_at",
"state"
],
"field_specs": {
"owner": {
"title": "Owner",
"description": "Повернене значення «Owner» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"ku_code": {
"title": "Код касового користувача",
"description": "Повернене значення «Код касового користувача» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"prro_number": {
"title": "Prro number",
"description": "Повернене значення «Prro number» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"fiscal_registration_number": {
"title": "Фіскальний номер ПРРО",
"description": "Повернене значення «Фіскальний номер ПРРО» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"shift_opened": {
"title": "Shift opened",
"description": "Повернене значення «Shift opened» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"z_report": {
"title": "Z report",
"description": "Повернене значення «Z report» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"shift_closed": {
"title": "Shift closed",
"description": "Повернене значення «Shift closed» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"updated_at": {
"title": "Updated at",
"description": "Повернена дата «Updated at» у форматі YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2026-07-23"
},
"state": {
"title": "State",
"description": "Повернене значення «State» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_offline_shift_get",
"params": {
"kasoruser": "Приклад",
"numprro": "4000000001"
},
"id": "example-pos-prro-offline-shift-get"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_offline_shift_get",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_offline_shift_get",
"value": "1"
},
"rows": [
{
"owner": "Приклад",
"ku_code": "Приклад",
"prro_number": "Приклад",
"fiscal_registration_number": "Приклад",
"shift_opened": "Приклад",
"z_report": "Приклад",
"shift_closed": "Приклад",
"updated_at": "2026-07-23",
"state": "Приклад"
}
]
},
"id": "example-pos-prro-offline-shift-get"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_offline_shift_saveЗберігає стан і реквізити офлайн-зміни ПРРО.
запис
pos.write
з 0.4.0
Зберігає стан і реквізити офлайн-зміни ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Фіскалізація | |||
fiscal_registration_numberФіскальний номер ПРРО | Поле «Фіскальний номер ПРРО» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
| Додаткові | |||
kasoruserКаса або користувач | Поле «Каса або користувач» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
ku_codeКод касового користувача | Поле «Код касового користувача» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
shift_closedShift closed | Поле «Shift closed» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
shift_openedShift opened | Поле «Shift opened» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
zreportZreport | Поле «Zreport» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
Точна схема параметрів
{
"fiscal_registration_number": {
"type": "string",
"max": 4096,
"default": "",
"title": "Фіскальний номер ПРРО",
"description": "Поле «Фіскальний номер ПРРО» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"example": ""
},
"kasoruser": {
"type": "string",
"max": 512,
"required": true,
"title": "Каса або користувач",
"description": "Поле «Каса або користувач» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
},
"ku_code": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Код касового користувача",
"description": "Поле «Код касового користувача» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"shift_closed": {
"type": "string",
"max": 4096,
"default": "",
"title": "Shift closed",
"description": "Поле «Shift closed» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"shift_opened": {
"type": "string",
"max": 4096,
"default": "",
"title": "Shift opened",
"description": "Поле «Shift opened» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"zreport": {
"type": "string",
"max": 4096,
"default": "",
"title": "Zreport",
"description": "Поле «Zreport» відповідного документа або довідника 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-pos-prro-offline-shift-save-0001
{
"method": "pos.prro_offline_shift_save",
"params": {
"kasoruser": "Приклад",
"numprro": "4000000001"
},
"id": "example-pos-prro-offline-shift-save"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_offline_shift_save",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_offline_shift_save",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-prro-offline-shift-save"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_retry_addДодає фіскальний чек до списку повторної обробки ПРРО.
запис
pos.write
з 0.4.0
Додає фіскальний чек до списку повторної обробки ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
cncНомер пов’язаного чека | Поле «Номер пов’язаного чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | необов’язковийПриклад: "4000000001"За замовчуванням: "1" |
Точна схема параметрів
{
"cnc": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер пов’язаного чека",
"description": "Поле «Номер пов’язаного чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
},
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"numprro": {
"type": "string",
"max": 4096,
"default": "1",
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
}
}
Результат
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-pos-prro-retry-add-0001
{
"method": "pos.prro_retry_add",
"params": {
"cnc": "Приклад",
"kasm": "Касове місце N1"
},
"id": "example-pos-prro-retry-add"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_retry_add",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_retry_add",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-prro-retry-add"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_retry_check_paymentПеревіряє оплату чека перед повторною фіскалізацією.
читання
pos.read
з 0.4.0
Перевіряє оплату чека перед повторною фіскалізацією.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
cncНомер пов’язаного чека | Поле «Номер пов’язаного чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
Точна схема параметрів
{
"cnc": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер пов’язаного чека",
"description": "Поле «Номер пов’язаного чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
payment_typePayment type | Повернене значення «Payment type» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"payment_type"
],
"field_specs": {
"payment_type": {
"title": "Payment type",
"description": "Повернене значення «Payment type» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_retry_check_payment",
"params": {
"cnc": "Приклад"
},
"id": "example-pos-prro-retry-check-payment"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_retry_check_payment",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_retry_check_payment",
"value": "1"
},
"rows": [
{
"payment_type": "Приклад"
}
]
},
"id": "example-pos-prro-retry-check-payment"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_retry_deleteВидаляє чек зі списку повторної обробки ПРРО.
запис
pos.write
з 0.4.0
Видаляє чек зі списку повторної обробки ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
cncНомер пов’язаного чека | Поле «Номер пов’язаного чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | необов’язковийПриклад: "4000000001"За замовчуванням: "" |
Точна схема параметрів
{
"cnc": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер пов’язаного чека",
"description": "Поле «Номер пов’язаного чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
},
"numprro": {
"type": "string",
"max": 4096,
"default": "",
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
}
}
Результат
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-pos-prro-retry-delete-0001
{
"method": "pos.prro_retry_delete",
"params": {
"cnc": "Приклад"
},
"id": "example-pos-prro-retry-delete"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_retry_delete",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_retry_delete",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-prro-retry-delete"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_retry_duplicate_lookupШукає можливий дублікат чека перед повторною фіскалізацією.
читання
pos.read
з 0.4.0
Шукає можливий дублікат чека перед повторною фіскалізацією.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
cncНомер пов’язаного чека | Поле «Номер пов’язаного чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
Точна схема параметрів
{
"cnc": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер пов’язаного чека",
"description": "Поле «Номер пов’язаного чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
order_tax_numberOrder tax number | Повернене значення «Order tax number» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
order_datetimeOrder datetime | Повернені дата й час «Order datetime» у форматі ISO 8601. | string · date-time | "2026-07-23T12:00:00+03:00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"order_tax_number",
"order_datetime"
],
"field_specs": {
"order_tax_number": {
"title": "Order tax number",
"description": "Повернене значення «Order tax number» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"order_datetime": {
"title": "Order datetime",
"description": "Повернені дата й час «Order datetime» у форматі ISO 8601.",
"type": "string",
"format": "date-time",
"example": "2026-07-23T12:00:00+03:00"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_retry_duplicate_lookup",
"params": {
"cnc": "Приклад"
},
"id": "example-pos-prro-retry-duplicate-lookup"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_retry_duplicate_lookup",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_retry_duplicate_lookup",
"value": "1"
},
"rows": [
{
"order_tax_number": "Приклад",
"order_datetime": "2026-07-23T12:00:00+03:00"
}
]
},
"id": "example-pos-prro-retry-duplicate-lookup"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_retry_process_rowsПовертає чеки, які очікують повторної обробки ПРРО.
читання
pos.read
з 0.4.0
Повертає чеки, які очікують повторної обробки ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | необов’язковийПриклад: "4000000001"За замовчуванням: "1" |
Точна схема параметрів
{
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"numprro": {
"type": "string",
"max": 4096,
"default": "1",
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
check_numberНомер чека | Номер касового чека у базі поточного клієнта. | string | "Приклад" |
prro_numberPrro number | Повернене значення «Prro number» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
payment_typePayment type | Повернене значення «Payment type» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
cash_receivedCash received | Точне повернене значення «Cash received» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
roundОкруглення | Точне повернене значення «Округлення» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
totalTotal | Кількість рядків або об’єктів у результаті операції. | string · decimal-string · currency-of-operation | "100.00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"check_number",
"prro_number",
"payment_type",
"cash_received",
"round",
"total"
],
"field_specs": {
"check_number": {
"title": "Номер чека",
"description": "Номер касового чека у базі поточного клієнта.",
"type": "string",
"example": "Приклад"
},
"prro_number": {
"title": "Prro number",
"description": "Повернене значення «Prro number» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"payment_type": {
"title": "Payment type",
"description": "Повернене значення «Payment type» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"cash_received": {
"title": "Cash received",
"description": "Точне повернене значення «Cash received» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"round": {
"title": "Округлення",
"description": "Точне повернене значення «Округлення» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"total": {
"title": "Total",
"description": "Кількість рядків або об’єктів у результаті операції.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_retry_process_rows",
"params": {
"kasm": "Касове місце N1"
},
"id": "example-pos-prro-retry-process-rows"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_retry_process_rows",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_retry_process_rows",
"value": "1"
},
"rows": [
{
"check_number": "Приклад",
"prro_number": "Приклад",
"payment_type": "Приклад",
"cash_received": "100.00",
"round": "100.00",
"total": "100.00"
}
]
},
"id": "example-pos-prro-retry-process-rows"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_retry_sale_rowsПовертає товарні позиції продажу для повторної фіскалізації.
читання
pos.read
з 0.4.0
Повертає товарні позиції продажу для повторної фіскалізації.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
cncНомер пов’язаного чека | Поле «Номер пов’язаного чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
yearРік | Поле «Рік» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "Приклад" |
Точна схема параметрів
{
"cnc": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер пов’язаного чека",
"description": "Поле «Номер пов’язаного чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
},
"year": {
"type": "string",
"max": 4,
"pattern": "/^[0-9]{4}$/D",
"title": "Рік",
"description": "Поле «Рік» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
codeКод товару | Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20. | string | "1001" |
nameНазва | Повернене значення «Назва» відповідного запису, документа або підсумку ARM20. | string | "Тестовий товар" |
priceЦіна | Точне повернене значення «Ціна» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
unit_typeОдиниця виміру | Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
quantityКількість | Точне повернене значення «Кількість» як десятковий рядок із крапкою. | string · decimal-string · product-unit | "1.000" |
line_totalLine total | Точне повернене значення «Line total» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
document_numberНомер документа | Номер документа у базі поточного клієнта. | string | "ПН-1001" |
c2C2 | Повернене значення «C2» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"code",
"name",
"price",
"unit_type",
"quantity",
"line_total",
"document_number",
"c2"
],
"field_specs": {
"code": {
"title": "Код товару",
"description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "1001"
},
"name": {
"title": "Назва",
"description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Тестовий товар"
},
"price": {
"title": "Ціна",
"description": "Точне повернене значення «Ціна» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"unit_type": {
"title": "Одиниця виміру",
"description": "Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"quantity": {
"title": "Кількість",
"description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "product-unit",
"example": "1.000"
},
"line_total": {
"title": "Line total",
"description": "Точне повернене значення «Line total» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"document_number": {
"title": "Номер документа",
"description": "Номер документа у базі поточного клієнта.",
"type": "string",
"example": "ПН-1001"
},
"c2": {
"title": "C2",
"description": "Повернене значення «C2» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_retry_sale_rows",
"params": {
"cnc": "Приклад"
},
"id": "example-pos-prro-retry-sale-rows"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_retry_sale_rows",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_retry_sale_rows",
"value": "1"
},
"rows": [
{
"code": "1001",
"name": "Тестовий товар",
"price": "100.00",
"unit_type": "Приклад",
"quantity": "1.000",
"line_total": "100.00",
"document_number": "ПН-1001",
"c2": "Приклад"
}
]
},
"id": "example-pos-prro-retry-sale-rows"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_retry_setЗмінює стан одного чека у списку повторної обробки ПРРО.
запис
pos.write
з 0.4.0
Змінює стан одного чека у списку повторної обробки ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
cncНомер пов’язаного чека | Поле «Номер пов’язаного чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | необов’язковийПриклад: ""За замовчуванням: "" |
trymeНомер спроби | Визначає, чи застосовувати параметр «Номер спроби». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: true |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | необов’язковийПриклад: "4000000001"За замовчуванням: "" |
Точна схема параметрів
{
"cnc": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер пов’язаного чека",
"description": "Поле «Номер пов’язаного чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
},
"kasm": {
"type": "string",
"max": 512,
"default": "",
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": ""
},
"numprro": {
"type": "string",
"max": 4096,
"default": "",
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"tryme": {
"type": "bool",
"default": true,
"title": "Номер спроби",
"description": "Визначає, чи застосовувати параметр «Номер спроби». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
}
}
Результат
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-pos-prro-retry-set-0001
{
"method": "pos.prro_retry_set",
"params": {
"cnc": "Приклад"
},
"id": "example-pos-prro-retry-set"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_retry_set",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_retry_set",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-prro-retry-set"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_retry_set_allЗмінює стан усіх вибраних чеків повторної обробки ПРРО.
запис
pos.write
з 0.4.0
Змінює стан усіх вибраних чеків повторної обробки ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
current_year_onlyCurrent year only | Визначає, чи застосовувати параметр «Current year only». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: false |
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
trymeНомер спроби | Визначає, чи застосовувати параметр «Номер спроби». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: true |
yearРік | Поле «Рік» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "Приклад" |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | обов’язковийПриклад: "4000000001" |
Точна схема параметрів
{
"current_year_only": {
"type": "bool",
"default": false,
"title": "Current year only",
"description": "Визначає, чи застосовувати параметр «Current year only». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
},
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"numprro": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"tryme": {
"type": "bool",
"default": true,
"title": "Номер спроби",
"description": "Визначає, чи застосовувати параметр «Номер спроби». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
},
"year": {
"type": "string",
"max": 4,
"pattern": "/^[0-9]{4}$/D",
"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-pos-prro-retry-set-all-0001
{
"method": "pos.prro_retry_set_all",
"params": {
"kasm": "Касове місце N1",
"numprro": "4000000001"
},
"id": "example-pos-prro-retry-set-all"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_retry_set_all",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_retry_set_all",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-prro-retry-set-all"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт. |
IDEMPOTENCY_KEY_REQUIRED | 422 | Для виконання запису не передано Idempotency-Key. | Створити ключ для цієї бізнес-операції та повторити. |
IDEMPOTENCY_RESULT_UNKNOWN | 409 | Результат попередньої спроби невідомий; gateway не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
pos.prro_revision_check_linesПовертає товарні позиції чека для звіряння з ПРРО.
читання
pos.read
з 0.4.0
Повертає товарні позиції чека для звіряння з ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
ncНомер чека | Номер касового чека у базі поточного клієнта. | string | обов’язковийПриклад: "Приклад" |
yearРік | Поле «Рік» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "Приклад" |
Точна схема параметрів
{
"nc": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер чека",
"description": "Номер касового чека у базі поточного клієнта.",
"group": "Додаткові",
"example": "Приклад"
},
"year": {
"type": "string",
"max": 4,
"pattern": "/^[0-9]{4}$/D",
"title": "Рік",
"description": "Поле «Рік» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
codeКод товару | Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20. | string | "1001" |
nameНазва | Повернене значення «Назва» відповідного запису, документа або підсумку ARM20. | string | "Тестовий товар" |
priceЦіна | Точне повернене значення «Ціна» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
unit_typeОдиниця виміру | Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
quantityКількість | Точне повернене значення «Кількість» як десятковий рядок із крапкою. | string · decimal-string · product-unit | "1.000" |
line_totalLine total | Точне повернене значення «Line total» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
check_numberНомер чека | Номер касового чека у базі поточного клієнта. | string | "Приклад" |
document_numberНомер документа | Номер документа у базі поточного клієнта. | string | "ПН-1001" |
c2C2 | Повернене значення «C2» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"code",
"name",
"price",
"unit_type",
"quantity",
"line_total",
"check_number",
"document_number",
"c2"
],
"field_specs": {
"code": {
"title": "Код товару",
"description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "1001"
},
"name": {
"title": "Назва",
"description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Тестовий товар"
},
"price": {
"title": "Ціна",
"description": "Точне повернене значення «Ціна» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"unit_type": {
"title": "Одиниця виміру",
"description": "Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"quantity": {
"title": "Кількість",
"description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "product-unit",
"example": "1.000"
},
"line_total": {
"title": "Line total",
"description": "Точне повернене значення «Line total» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"check_number": {
"title": "Номер чека",
"description": "Номер касового чека у базі поточного клієнта.",
"type": "string",
"example": "Приклад"
},
"document_number": {
"title": "Номер документа",
"description": "Номер документа у базі поточного клієнта.",
"type": "string",
"example": "ПН-1001"
},
"c2": {
"title": "C2",
"description": "Повернене значення «C2» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_revision_check_lines",
"params": {
"nc": "Приклад"
},
"id": "example-pos-prro-revision-check-lines"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_revision_check_lines",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_revision_check_lines",
"value": "1"
},
"rows": [
{
"code": "1001",
"name": "Тестовий товар",
"price": "100.00",
"unit_type": "Приклад",
"quantity": "1.000",
"line_total": "100.00",
"check_number": "Приклад",
"document_number": "ПН-1001",
"c2": "Приклад"
}
]
},
"id": "example-pos-prro-revision-check-lines"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_revision_checksПовертає список чеків для звіряння з даними ПРРО.
читання
pos.read
з 0.4.0
Повертає список чеків для звіряння з даними ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Дати й час | |||
date_fromПочаткова дата | Дата «Початкова дата» у календарному форматі YYYY-MM-DD. | string · date | обов’язковийПриклад: "2026-07-23" |
date_toКінцева дата | Дата «Кінцева дата» у календарному форматі YYYY-MM-DD. | string · date | обов’язковийПриклад: "2026-07-23" |
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | string | обов’язковийПриклад: "Приклад" |
pay_filterФільтр оплат | Варіант «Фільтр оплат». Використовуйте лише одне зі значень, розшифрованих нижче.
| enum | необов’язковийПриклад: "all"За замовчуванням: "all" |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | необов’язковийПриклад: "4000000001"За замовчуванням: "1" |
Точна схема параметрів
{
"date_from": {
"type": "string",
"max": 512,
"required": true,
"title": "Початкова дата",
"description": "Дата «Початкова дата» у календарному форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
},
"date_to": {
"type": "string",
"max": 512,
"required": true,
"title": "Кінцева дата",
"description": "Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
},
"kasm": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": "Приклад"
},
"numprro": {
"type": "string",
"max": 4096,
"default": "1",
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"pay_filter": {
"type": "enum",
"values": [
"all",
"card",
"cash"
],
"default": "all",
"title": "Фільтр оплат",
"description": "Варіант «Фільтр оплат». Використовуйте лише одне зі значень, розшифрованих нижче.",
"group": "Додаткові",
"example": "all",
"enum_labels": {
"all": "усі оплати",
"card": "картка",
"cash": "готівка"
}
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
check_numberНомер чека | Номер касового чека у базі поточного клієнта. | string | "Приклад" |
totalTotal | Кількість рядків або об’єктів у результаті операції. | string · decimal-string · currency-of-operation | "100.00" |
payment_typePayment type | Повернене значення «Payment type» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
dateДата | Повернена дата «Дата» у форматі YYYY-MM-DD. | string · date | "2026-07-23" |
order_tax_numberOrder tax number | Повернене значення «Order tax number» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
roundОкруглення | Точне повернене значення «Округлення» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"check_number",
"total",
"payment_type",
"date",
"order_tax_number",
"round"
],
"field_specs": {
"check_number": {
"title": "Номер чека",
"description": "Номер касового чека у базі поточного клієнта.",
"type": "string",
"example": "Приклад"
},
"total": {
"title": "Total",
"description": "Кількість рядків або об’єктів у результаті операції.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"payment_type": {
"title": "Payment type",
"description": "Повернене значення «Payment type» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"date": {
"title": "Дата",
"description": "Повернена дата «Дата» у форматі YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2026-07-23"
},
"order_tax_number": {
"title": "Order tax number",
"description": "Повернене значення «Order tax number» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"round": {
"title": "Округлення",
"description": "Точне повернене значення «Округлення» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_revision_checks",
"params": {
"date_from": "2026-07-01",
"date_to": "2026-07-31",
"kasm": "Касове місце N1"
},
"id": "example-pos-prro-revision-checks"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_revision_checks",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_revision_checks",
"value": "1"
},
"rows": [
{
"check_number": "Приклад",
"total": "100.00",
"payment_type": "Приклад",
"date": "2026-07-23",
"order_tax_number": "Приклад",
"round": "100.00"
}
]
},
"id": "example-pos-prro-revision-checks"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.prro_revision_fiscal_sumПовертає фіскальну суму документів для звіряння ПРРО.
читання
pos.read
з 0.4.0
Повертає фіскальну суму документів для звіряння ПРРО.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
modeРежим операції | Вибирає один із підтримуваних сценаріїв операції. Значення та їх зміст наведено у списку варіантів.
| enum | необов’язковийПриклад: "nc"За замовчуванням: "order_tax" |
| Фіскалізація | |||
numprroНомер ПРРО | Фіскальний номер ПРРО, налаштований для каси у Windows. | string | необов’язковийПриклад: "4000000001"За замовчуванням: "1" |
| Додаткові | |||
valueЗначення | Нове або шукане значення поля залежно від операції. | string | обов’язковийПриклад: "Приклад" |
Точна схема параметрів
{
"mode": {
"type": "enum",
"values": [
"nc",
"order_tax"
],
"default": "order_tax",
"title": "Режим операції",
"description": "Вибирає один із підтримуваних сценаріїв операції. Значення та їх зміст наведено у списку варіантів.",
"group": "Основні",
"example": "nc",
"enum_labels": {
"nc": "шукати за номером чека",
"order_tax": "шукати за податковим номером"
}
},
"numprro": {
"type": "string",
"max": 4096,
"default": "1",
"title": "Номер ПРРО",
"description": "Фіскальний номер ПРРО, налаштований для каси у Windows.",
"group": "Фіскалізація",
"example": "4000000001"
},
"value": {
"type": "string",
"max": 4096,
"required": true,
"title": "Значення",
"description": "Нове або шукане значення поля залежно від операції.",
"group": "Додаткові",
"example": "Приклад"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
check_numberНомер чека | Номер касового чека у базі поточного клієнта. | string | "Приклад" |
totalTotal | Кількість рядків або об’єктів у результаті операції. | string · decimal-string · currency-of-operation | "100.00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"check_number",
"total"
],
"field_specs": {
"check_number": {
"title": "Номер чека",
"description": "Номер касового чека у базі поточного клієнта.",
"type": "string",
"example": "Приклад"
},
"total": {
"title": "Total",
"description": "Кількість рядків або об’єктів у результаті операції.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.prro_revision_fiscal_sum",
"params": {
"value": "Демонстраційне значення"
},
"id": "example-pos-prro-revision-fiscal-sum"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.prro_revision_fiscal_sum",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "prro_revision_fiscal_sum",
"value": "1"
},
"rows": [
{
"check_number": "Приклад",
"total": "100.00"
}
]
},
"id": "example-pos-prro-revision-fiscal-sum"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |