Бізнес-блок
Каса та робочі операції
Кошти каси, клієнти, борги, сертифікати, FIFO, цінники, розміри та службові документи.
37усього
28читання
9запис
Кожна картка містить готовий HTTP-приклад. Значення в ньому демонстраційні:
замініть їх даними зі своєї бази. Для операцій запису використовуйте новий
Idempotency-Key для кожної окремої бізнес-операції.
Як сформувати ключ і повторювати запит.
pos
37 методів
Каса
pos.card_setting_historyПовертає історію змін налаштувань дисконтної картки.
читання
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.card_setting_history",
"params": {
"code": "1001"
},
"id": "example-pos-card-setting-history"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.card_setting_history",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "card_setting_history",
"value": "1"
},
"rows": [
{
"name": "Тестовий товар"
}
]
},
"id": "example-pos-card-setting-history"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.card_setting_saveЗберігає зміну налаштувань дисконтної картки.
запис
pos.write
з 0.4.0
Зберігає зміну налаштувань дисконтної картки.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeКод товару | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | необов’язковийПриклад: "1001"За замовчуванням: "" |
ntНазва товару | Поле «Назва товару» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "Тестовий товар"За замовчуванням: "" |
| Суми та кількості | |||
priceЦіна | Ціна за одиницю товару як десятковий рядок без символу валюти. | string · decimal-string · currency-of-operation | необов’язковийПриклад: "100.00"За замовчуванням: "0" |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"default": "",
"title": "Код товару",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"nt": {
"type": "string",
"max": 512,
"default": "",
"title": "Назва товару",
"description": "Поле «Назва товару» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Основні",
"example": "Тестовий товар"
},
"price": {
"type": "string",
"max": 4096,
"default": "0",
"title": "Ціна",
"description": "Ціна за одиницю товару як десятковий рядок без символу валюти.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
}
}Результат
Форма відповіді:
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-card-setting-save-0001
{
"method": "pos.card_setting_save",
"params": {
"code": "1001",
"nt": "Тестовий товар",
"price": "Приклад"
},
"id": "example-pos-card-setting-save"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.card_setting_save",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "card_setting_save",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-card-setting-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.cashdesk_balanceПовертає поточний грошовий залишок каси.
читання
pos.read
з 0.4.0
Повертає поточний грошовий залишок каси.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
akasРахунок оплати | Поле «Рахунок оплати» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
Точна схема параметрів
{
"akas": {
"type": "string",
"max": 512,
"required": true,
"title": "Рахунок оплати",
"description": "Поле «Рахунок оплати» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
balanceБаланс | Точне повернене значення «Баланс» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"balance"
],
"field_specs": {
"balance": {
"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.cashdesk_balance",
"params": {
"akas": "Касове місце N1"
},
"id": "example-pos-cashdesk-balance"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.cashdesk_balance",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "cashdesk_balance",
"value": "1"
},
"rows": [
{
"balance": "100.00"
}
]
},
"id": "example-pos-cashdesk-balance"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.cashdesk_monobank_next_destinationПовертає наступне призначення платежу для інтеграції з monobank.
читання
pos.read
з 0.4.0
Повертає наступне призначення платежу для інтеграції з monobank.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
Точна схема параметрів
{
"kasm": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": 1
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
idІдентифікатор запису | Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
destinationПризначення | Повернене значення «Призначення» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"id",
"destination"
],
"field_specs": {
"id": {
"title": "Ідентифікатор запису",
"description": "Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"destination": {
"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.cashdesk_monobank_next_destination",
"params": {
"kasm": 1
},
"id": "example-pos-cashdesk-monobank-next-destination"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.cashdesk_monobank_next_destination",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "cashdesk_monobank_next_destination",
"value": "1"
},
"rows": [
{
"id": "Приклад",
"destination": "Приклад"
}
]
},
"id": "example-pos-cashdesk-monobank-next-destination"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.cashdesk_monobank_statusПовертає стан платежу через інтеграцію з monobank.
читання
pos.read
з 0.4.0
Повертає стан платежу через інтеграцію з monobank.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
destinationПризначення | Поле «Призначення» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
Точна схема параметрів
{
"destination": {
"type": "string",
"max": 4096,
"required": true,
"title": "Призначення",
"description": "Поле «Призначення» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
statusСтатус | Повернене значення «Статус» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
json_dataJson data | Повернене значення «Json data» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"status",
"json_data"
],
"field_specs": {
"status": {
"title": "Статус",
"description": "Повернене значення «Статус» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"json_data": {
"title": "Json data",
"description": "Повернене значення «Json data» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.cashdesk_monobank_status",
"params": {
"destination": "Приклад"
},
"id": "example-pos-cashdesk-monobank-status"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.cashdesk_monobank_status",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "cashdesk_monobank_status",
"value": "1"
},
"rows": [
{
"status": "Приклад",
"json_data": "Приклад"
}
]
},
"id": "example-pos-cashdesk-monobank-status"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.cashdesk_movementРеєструє внесення, вилучення або інший рух коштів у касі.
запис
pos.write
з 0.4.0
Реєструє внесення, вилучення або інший рух коштів у касі.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
akasРахунок оплати | Поле «Рахунок оплати» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
com1Основний коментар | Основний текстовий коментар, який буде збережено разом з операцією. | string | необов’язковийПриклад: ""За замовчуванням: "" |
com2Додатковий коментар | Додатковий коментар операції; використовуйте лише коли він потрібний відповідному сценарію Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
curcertВалюта сертифіката | Поле «Валюта сертифіката» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
dolg_codeDolg code | Поле «Dolg code» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "990000001"За замовчуванням: "" |
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
ndocНомер документа | Номер службового, касового або фіскального документа у відповідному журналі. | string | необов’язковийПриклад: ""За замовчуванням: "" |
tdocТип документа | Текстова назва або код виду документа, який зберігається у касовій операції. | string | необов’язковийПриклад: ""За замовчуванням: "" |
| Суми та кількості | |||
sumСума | Грошова сума як десятковий JSON-рядок без пробілів і символу валюти. | string · decimal-string · currency-of-operation | необов’язковийПриклад: "100.00" |
Точна схема параметрів
{
"akas": {
"type": "string",
"max": 512,
"default": "",
"title": "Рахунок оплати",
"description": "Поле «Рахунок оплати» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"com1": {
"type": "string",
"max": 512,
"default": "",
"title": "Основний коментар",
"description": "Основний текстовий коментар, який буде збережено разом з операцією.",
"group": "Додаткові",
"example": ""
},
"com2": {
"type": "string",
"max": 512,
"default": "",
"title": "Додатковий коментар",
"description": "Додатковий коментар операції; використовуйте лише коли він потрібний відповідному сценарію Windows.",
"group": "Додаткові",
"example": ""
},
"curcert": {
"type": "string",
"max": 4096,
"default": "",
"title": "Валюта сертифіката",
"description": "Поле «Валюта сертифіката» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"dolg_code": {
"type": "string",
"max": 512,
"default": "",
"title": "Dolg code",
"description": "Поле «Dolg code» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "990000001"
},
"kasm": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": 1
},
"ndoc": {
"type": "string",
"max": 4096,
"default": "",
"title": "Номер документа",
"description": "Номер службового, касового або фіскального документа у відповідному журналі.",
"group": "Додаткові",
"example": ""
},
"sum": {
"type": "string",
"max": 4096,
"title": "Сума",
"description": "Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"tdoc": {
"type": "string",
"max": 4096,
"default": "",
"title": "Тип документа",
"description": "Текстова назва або код виду документа, який зберігається у касовій операції.",
"group": "Додаткові",
"example": ""
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
old_balanceOld balance | Точне повернене значення «Old balance» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
new_balanceNew balance | Точне повернене значення «New balance» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"old_balance",
"new_balance"
],
"field_specs": {
"old_balance": {
"title": "Old balance",
"description": "Точне повернене значення «Old balance» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"new_balance": {
"title": "New balance",
"description": "Точне повернене значення «New balance» як десятковий рядок із крапкою.",
"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
Idempotency-Key: example-pos-cashdesk-movement-0001
{
"method": "pos.cashdesk_movement",
"params": {
"kasm": 1,
"sum": "Приклад",
"ndoc": "Приклад"
},
"id": "example-pos-cashdesk-movement"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.cashdesk_movement",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "cashdesk_movement",
"value": "1"
},
"rows": [
{
"old_balance": "100.00",
"new_balance": "100.00"
}
]
},
"id": "example-pos-cashdesk-movement"
},
"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.cashier_bonus_balanceПовертає поточний бонусний баланс касира.
читання
pos.read
з 0.4.0
Повертає поточний бонусний баланс касира.
Параметри params
Параметри не потрібні. Передайте порожній об’єкт
{}.Точна схема параметрів
{}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
balanceБаланс | Точне повернене значення «Баланс» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"balance"
],
"field_specs": {
"balance": {
"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.cashier_bonus_balance",
"params": [],
"id": "example-pos-cashier-bonus-balance"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.cashier_bonus_balance",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "cashier_bonus_balance",
"value": "1"
},
"rows": [
{
"balance": "100.00"
}
]
},
"id": "example-pos-cashier-bonus-balance"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.cashier_bonus_reportПовертає звіт про нарахування та списання бонусів касира.
читання
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"За замовчуванням: "" |
| Суми та кількості | |||
minusСума вилучення | Визначає, чи застосовувати параметр «Сума вилучення». Передавайте JSON true або false. | bool · decimal-string · currency-of-operation | необов’язковийПриклад: falseЗа замовчуванням: true |
plusСума внесення | Визначає, чи застосовувати параметр «Сума внесення». Передавайте JSON true або false. | bool · decimal-string · currency-of-operation | необов’язковийПриклад: falseЗа замовчуванням: true |
Точна схема параметрів
{
"date_from": {
"type": "string",
"max": 512,
"default": "",
"title": "Початкова дата",
"description": "Дата «Початкова дата» у календарному форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
},
"date_to": {
"type": "string",
"max": 512,
"default": "",
"title": "Кінцева дата",
"description": "Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
},
"minus": {
"type": "bool",
"default": true,
"title": "Сума вилучення",
"description": "Визначає, чи застосовувати параметр «Сума вилучення». Передавайте JSON true або false.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": false
},
"plus": {
"type": "bool",
"default": true,
"title": "Сума внесення",
"description": "Визначає, чи застосовувати параметр «Сума внесення». Передавайте JSON true або false.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": false
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
idІдентифікатор запису | Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
old_balanceOld balance | Точне повернене значення «Old balance» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
deltaЗміна значення | Точне повернене значення «Зміна значення» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
new_balanceNew balance | Точне повернене значення «New balance» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
dateДата | Повернена дата «Дата» у форматі YYYY-MM-DD. | string · date | "2026-07-23" |
Точна схема результату
{
"mode": "rows",
"columns": [
"id",
"old_balance",
"delta",
"new_balance",
"date"
],
"field_specs": {
"id": {
"title": "Ідентифікатор запису",
"description": "Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"old_balance": {
"title": "Old balance",
"description": "Точне повернене значення «Old balance» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"delta": {
"title": "Зміна значення",
"description": "Точне повернене значення «Зміна значення» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"new_balance": {
"title": "New balance",
"description": "Точне повернене значення «New balance» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"date": {
"title": "Дата",
"description": "Повернена дата «Дата» у форматі YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2026-07-23"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.cashier_bonus_report",
"params": {
"date_from": "2026-07-01",
"date_to": "2026-07-31",
"minus": false,
"plus": true
},
"id": "example-pos-cashier-bonus-report"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.cashier_bonus_report",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "cashier_bonus_report",
"value": "1"
},
"rows": [
{
"id": "Приклад",
"old_balance": "100.00",
"delta": "100.00",
"new_balance": "100.00",
"date": "2026-07-23"
}
]
},
"id": "example-pos-cashier-bonus-report"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.cashier_bonus_withdrawСписує вказану суму з бонусного балансу касира.
запис
pos.write
з 0.4.0
Списує вказану суму з бонусного балансу касира.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Суми та кількості | |||
amountСума | Точне числове значення «Сума» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. | string · decimal-string · currency-of-operation | необов’язковийПриклад: "100.00"За замовчуванням: "0" |
Точна схема параметрів
{
"amount": {
"type": "string",
"max": 512,
"default": "0",
"title": "Сума",
"description": "Точне числове значення «Сума» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
}
}Результат
Форма відповіді:
scalar| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
valueЗначення | Повернене значення «Значення» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "scalar",
"value_type": "string",
"value_spec": {
"title": "Значення",
"description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-pos-cashier-bonus-withdraw-0001
{
"method": "pos.cashier_bonus_withdraw",
"params": {
"amount": "Приклад"
},
"id": "example-pos-cashier-bonus-withdraw"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.cashier_bonus_withdraw",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "cashier_bonus_withdraw",
"value": "Приклад"
},
"rows": []
},
"id": "example-pos-cashier-bonus-withdraw"
},
"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.cert_lookupЗнаходить подарунковий сертифікат за його кодом.
читання
pos.read
з 0.4.0
Знаходить подарунковий сертифікат за його кодом.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeКод товару | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | необов’язковийПриклад: "1001"За замовчуванням: "" |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"default": "",
"title": "Код товару",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
nameНазва | Повернене значення «Назва» відповідного запису, документа або підсумку ARM20. | string | "Тестовий товар" |
priceЦіна | Точне повернене значення «Ціна» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"name",
"price"
],
"field_specs": {
"name": {
"title": "Назва",
"description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Тестовий товар"
},
"price": {
"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.cert_lookup",
"params": {
"code": "1001"
},
"id": "example-pos-cert-lookup"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.cert_lookup",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "cert_lookup",
"value": "1"
},
"rows": [
{
"name": "Тестовий товар",
"price": "100.00"
}
]
},
"id": "example-pos-cert-lookup"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.comment_bonus_valuesПовертає довідник коментарів для бонусних операцій каси.
читання
pos.read
з 0.4.0
Повертає довідник коментарів для бонусних операцій каси.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
limitМаксимальна кількість рядків | Максимальна кількість рядків, яку потрібно повернути. Менше значення зменшує відповідь. | int | необов’язковийПриклад: 1За замовчуванням: 100 |
prefixПрефікс | Поле «Префікс» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
Точна схема параметрів
{
"limit": {
"type": "int",
"min": 1,
"max": 500,
"default": 100,
"title": "Максимальна кількість рядків",
"description": "Максимальна кількість рядків, яку потрібно повернути. Менше значення зменшує відповідь.",
"group": "Додаткові",
"example": 1
},
"prefix": {
"type": "string",
"max": 4096,
"default": "",
"title": "Префікс",
"description": "Поле «Префікс» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
commentComment | Повернене значення «Comment» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"comment"
],
"field_specs": {
"comment": {
"title": "Comment",
"description": "Повернене значення «Comment» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.comment_bonus_values",
"params": {
"limit": 20,
"prefix": "Приклад"
},
"id": "example-pos-comment-bonus-values"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.comment_bonus_values",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "comment_bonus_values",
"value": "1"
},
"rows": [
{
"comment": "Приклад"
}
]
},
"id": "example-pos-comment-bonus-values"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.comment_check_valuesПовертає довідник коментарів для касових чеків.
читання
pos.read
з 0.4.0
Повертає довідник коментарів для касових чеків.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
fieldПоле | Варіант «Поле». Використовуйте лише одне зі значень, розшифрованих нижче.
| enum | необов’язковийПриклад: "com1"За замовчуванням: "com1" |
limitМаксимальна кількість рядків | Максимальна кількість рядків, яку потрібно повернути. Менше значення зменшує відповідь. | int | необов’язковийПриклад: 1За замовчуванням: 100 |
prefixПрефікс | Поле «Префікс» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
Точна схема параметрів
{
"field": {
"type": "enum",
"values": [
"com1",
"com2"
],
"default": "com1",
"title": "Поле",
"description": "Варіант «Поле». Використовуйте лише одне зі значень, розшифрованих нижче.",
"group": "Додаткові",
"example": "com1",
"enum_labels": {
"com1": "основний коментар",
"com2": "додатковий коментар"
}
},
"limit": {
"type": "int",
"min": 1,
"max": 500,
"default": 100,
"title": "Максимальна кількість рядків",
"description": "Максимальна кількість рядків, яку потрібно повернути. Менше значення зменшує відповідь.",
"group": "Додаткові",
"example": 1
},
"prefix": {
"type": "string",
"max": 4096,
"default": "",
"title": "Префікс",
"description": "Поле «Префікс» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
commentComment | Повернене значення «Comment» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"comment"
],
"field_specs": {
"comment": {
"title": "Comment",
"description": "Повернене значення «Comment» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.comment_check_values",
"params": {
"field": "com1",
"limit": 20,
"prefix": "Приклад"
},
"id": "example-pos-comment-check-values"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.comment_check_values",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "comment_check_values",
"value": "1"
},
"rows": [
{
"comment": "Приклад"
}
]
},
"id": "example-pos-comment-check-values"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.consultantsПовертає список консультантів, доступних у касі.
читання
pos.read
з 0.4.0
Повертає список консультантів, доступних у касі.
Параметри params
Параметри не потрібні. Передайте порожній об’єкт
{}.Точна схема параметрів
{}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
idІдентифікатор запису | Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
nameНазва | Повернене значення «Назва» відповідного запису, документа або підсумку ARM20. | string | "Тестовий товар" |
Точна схема результату
{
"mode": "rows",
"columns": [
"id",
"name"
],
"field_specs": {
"id": {
"title": "Ідентифікатор запису",
"description": "Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"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.consultants",
"params": [],
"id": "example-pos-consultants"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.consultants",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "consultants",
"value": "1"
},
"rows": [
{
"id": "Приклад",
"name": "Тестовий товар"
}
]
},
"id": "example-pos-consultants"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.debt_balanceПовертає загальну непогашену заборгованість клієнта.
читання
pos.read
з 0.4.0
Повертає загальну непогашену заборгованість клієнта.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
cardНомер дисконтної картки | Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "990000001" |
Точна схема параметрів
{
"card": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер дисконтної картки",
"description": "Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "990000001"
}
}Результат
Форма відповіді:
scalar| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
valueЗначення | Повернене значення «Значення» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "scalar",
"value_type": "string",
"value_spec": {
"title": "Значення",
"description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.debt_balance",
"params": {
"card": "990000001"
},
"id": "example-pos-debt-balance"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.debt_balance",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "debt_balance",
"value": "Приклад"
},
"rows": []
},
"id": "example-pos-debt-balance"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.debt_bonus_balanceПовертає бонуси, доступні для погашення боргу клієнта.
читання
pos.read
з 0.4.0
Повертає бонуси, доступні для погашення боргу клієнта.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
cardНомер дисконтної картки | Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "990000001" |
Точна схема параметрів
{
"card": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер дисконтної картки",
"description": "Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "990000001"
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
bonus_balanceБаланс бонусів | Точне повернене значення «Баланс бонусів» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"bonus_balance"
],
"field_specs": {
"bonus_balance": {
"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.debt_bonus_balance",
"params": {
"card": "990000001"
},
"id": "example-pos-debt-bonus-balance"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.debt_bonus_balance",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "debt_bonus_balance",
"value": "1"
},
"rows": [
{
"bonus_balance": "100.00"
}
]
},
"id": "example-pos-debt-bonus-balance"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.debt_grid_debtsПовертає список боргів клієнтів для перегляду в касі.
читання
pos.read
з 0.4.0
Повертає список боргів клієнтів для перегляду в касі.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
cardНомер дисконтної картки | Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "990000001" |
Точна схема параметрів
{
"card": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер дисконтної картки",
"description": "Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "990000001"
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
check_numberНомер чека | Номер касового чека у базі поточного клієнта. | string | "Приклад" |
totalTotal | Кількість рядків або об’єктів у результаті операції. | string · decimal-string · currency-of-operation | "100.00" |
paidPaid | Точне повернене значення «Paid» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
date_addedДата додавання | Повернена дата «Дата додавання» у форматі YYYY-MM-DD. | string · date | "2026-07-23" |
last_paymentLast payment | Повернена дата «Last payment» у форматі YYYY-MM-DD. | string · date | "2026-07-23" |
user_nameUser name | Повернене значення «User name» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"check_number",
"total",
"paid",
"date_added",
"last_payment",
"user_name"
],
"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"
},
"paid": {
"title": "Paid",
"description": "Точне повернене значення «Paid» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"date_added": {
"title": "Дата додавання",
"description": "Повернена дата «Дата додавання» у форматі YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2026-07-23"
},
"last_payment": {
"title": "Last payment",
"description": "Повернена дата «Last payment» у форматі YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2026-07-23"
},
"user_name": {
"title": "User name",
"description": "Повернене значення «User name» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.debt_grid_debts",
"params": {
"card": "990000001"
},
"id": "example-pos-debt-grid-debts"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.debt_grid_debts",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "debt_grid_debts",
"value": "1"
},
"rows": [
{
"check_number": "Приклад",
"total": "100.00",
"paid": "100.00",
"date_added": "2026-07-23",
"last_payment": "2026-07-23",
"user_name": "Приклад"
}
]
},
"id": "example-pos-debt-grid-debts"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.debt_open_rowsПовертає відкриті рядки заборгованості вибраного клієнта.
читання
pos.read
з 0.4.0
Повертає відкриті рядки заборгованості вибраного клієнта.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
cardНомер дисконтної картки | Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "990000001" |
Точна схема параметрів
{
"card": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер дисконтної картки",
"description": "Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "990000001"
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
totalTotal | Кількість рядків або об’єктів у результаті операції. | string · decimal-string · currency-of-operation | "100.00" |
paidPaid | Точне повернене значення «Paid» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
check_numberНомер чека | Номер касового чека у базі поточного клієнта. | string | "Приклад" |
debtОплата в борг | Точне повернене значення «Оплата в борг» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
date_addedДата додавання | Повернена дата «Дата додавання» у форматі YYYY-MM-DD. | string · date | "2026-07-23" |
Точна схема результату
{
"mode": "rows",
"columns": [
"total",
"paid",
"check_number",
"debt",
"date_added"
],
"field_specs": {
"total": {
"title": "Total",
"description": "Кількість рядків або об’єктів у результаті операції.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"paid": {
"title": "Paid",
"description": "Точне повернене значення «Paid» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"check_number": {
"title": "Номер чека",
"description": "Номер касового чека у базі поточного клієнта.",
"type": "string",
"example": "Приклад"
},
"debt": {
"title": "Оплата в борг",
"description": "Точне повернене значення «Оплата в борг» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"date_added": {
"title": "Дата додавання",
"description": "Повернена дата «Дата додавання» у форматі YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2026-07-23"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.debt_open_rows",
"params": {
"card": "990000001"
},
"id": "example-pos-debt-open-rows"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.debt_open_rows",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "debt_open_rows",
"value": "1"
},
"rows": [
{
"total": "100.00",
"paid": "100.00",
"check_number": "Приклад",
"debt": "100.00",
"date_added": "2026-07-23"
}
]
},
"id": "example-pos-debt-open-rows"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.debt_pay_bonusПогашає заборгованість клієнта бонусами.
запис
pos.write
з 0.4.0
Погашає заборгованість клієнта бонусами.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Суми та кількості | |||
amountСума | Точне числове значення «Сума» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. | string · decimal-string · currency-of-operation | необов’язковийПриклад: "100.00" |
| Додаткові | |||
cardНомер дисконтної картки | Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "990000001" |
only_ncЛише вказаний чек | Поле «Лише вказаний чек» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
Точна схема параметрів
{
"amount": {
"type": "string",
"max": 512,
"title": "Сума",
"description": "Точне числове значення «Сума» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"card": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер дисконтної картки",
"description": "Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "990000001"
},
"only_nc": {
"type": "string",
"max": 4096,
"default": "",
"title": "Лише вказаний чек",
"description": "Поле «Лише вказаний чек» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
}
}Результат
Форма відповіді:
variable_rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
paidPaid | Точне повернене значення «Paid» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
bonus_balanceБаланс бонусів | Точне повернене значення «Баланс бонусів» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
remaining_debtRemaining debt | Точне повернене значення «Remaining debt» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
document_numberНомер документа | Номер документа у базі поточного клієнта. | string | "ПН-1001" |
Точна схема результату
{
"mode": "variable_rows",
"contract": "pos_debt_pay_bonus",
"row_shapes": {
"summary": [
"paid",
"bonus_balance",
"remaining_debt"
],
"document": [
"document_number",
"paid"
]
},
"constraints": [
"Перший рядок містить підсумок, після нього є щонайменше один розподіл оплати за документом."
],
"field_specs": {
"paid": {
"title": "Paid",
"description": "Точне повернене значення «Paid» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"bonus_balance": {
"title": "Баланс бонусів",
"description": "Точне повернене значення «Баланс бонусів» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"remaining_debt": {
"title": "Remaining debt",
"description": "Точне повернене значення «Remaining debt» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"document_number": {
"title": "Номер документа",
"description": "Номер документа у базі поточного клієнта.",
"type": "string",
"example": "ПН-1001"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-pos-debt-pay-bonus-0001
{
"method": "pos.debt_pay_bonus",
"params": {
"card": "990000001"
},
"id": "example-pos-debt-pay-bonus"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.debt_pay_bonus",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "debt_pay_bonus",
"value": "1"
},
"rows": [
[
"100.00",
"100.00",
"100.00"
]
]
},
"id": "example-pos-debt-pay-bonus"
},
"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.debt_pay_cashПогашає заборгованість клієнта грошима.
запис
pos.write
з 0.4.0
Погашає заборгованість клієнта грошима.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
akasРахунок оплати | Поле «Рахунок оплати» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
cardНомер дисконтної картки | Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "990000001" |
kasmНомер каси | Числовий номер каси, налаштований у Windows Касі. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
only_ncЛише вказаний чек | Поле «Лише вказаний чек» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
payment_nameНазва способу оплати | Поле «Назва способу оплати» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "Оплата долга"За замовчуванням: "Оплата долга" |
tdocТип документа | Текстова назва або код виду документа, який зберігається у касовій операції. | string | необов’язковийПриклад: "Приход кассы"За замовчуванням: "Приход кассы" |
| Суми та кількості | |||
amountСума | Точне числове значення «Сума» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. | string · decimal-string · currency-of-operation | необов’язковийПриклад: "100.00" |
Точна схема параметрів
{
"akas": {
"type": "string",
"max": 512,
"required": true,
"title": "Рахунок оплати",
"description": "Поле «Рахунок оплати» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
},
"amount": {
"type": "string",
"max": 512,
"title": "Сума",
"description": "Точне числове значення «Сума» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"card": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер дисконтної картки",
"description": "Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "990000001"
},
"kasm": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Номер каси",
"description": "Числовий номер каси, налаштований у Windows Касі.",
"group": "Додаткові",
"example": 1
},
"only_nc": {
"type": "string",
"max": 4096,
"default": "",
"title": "Лише вказаний чек",
"description": "Поле «Лише вказаний чек» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"payment_name": {
"type": "string",
"max": 512,
"default": "Оплата долга",
"title": "Назва способу оплати",
"description": "Поле «Назва способу оплати» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Оплата долга"
},
"tdoc": {
"type": "string",
"max": 4096,
"default": "Приход кассы",
"title": "Тип документа",
"description": "Текстова назва або код виду документа, який зберігається у касовій операції.",
"group": "Додаткові",
"example": "Приход кассы"
}
}Результат
Форма відповіді:
variable_rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
paidPaid | Точне повернене значення «Paid» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
document_numberНомер документа | Номер документа у базі поточного клієнта. | string | "ПН-1001" |
remaining_debtRemaining debt | Точне повернене значення «Remaining debt» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
Точна схема результату
{
"mode": "variable_rows",
"contract": "pos_debt_pay_cash",
"row_shapes": {
"summary": [
"paid",
"document_number",
"remaining_debt"
],
"document": [
"document_number",
"paid"
]
},
"constraints": [
"Перший рядок містить підсумок, після нього є щонайменше один розподіл оплати за документом."
],
"field_specs": {
"paid": {
"title": "Paid",
"description": "Точне повернене значення «Paid» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"document_number": {
"title": "Номер документа",
"description": "Номер документа у базі поточного клієнта.",
"type": "string",
"example": "ПН-1001"
},
"remaining_debt": {
"title": "Remaining debt",
"description": "Точне повернене значення «Remaining debt» як десятковий рядок із крапкою.",
"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
Idempotency-Key: example-pos-debt-pay-cash-0001
{
"method": "pos.debt_pay_cash",
"params": {
"akas": "Касове місце N1",
"card": "990000001"
},
"id": "example-pos-debt-pay-cash"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.debt_pay_cash",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "debt_pay_cash",
"value": "1"
},
"rows": [
[
"100.00",
"ПН-1001",
"100.00"
]
]
},
"id": "example-pos-debt-pay-cash"
},
"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.debt_payment_historyПовертає історію платежів за заборгованістю клієнта.
читання
pos.read
з 0.4.0
Повертає історію платежів за заборгованістю клієнта.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
cardНомер дисконтної картки | Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "990000001" |
com1Основний коментар | Основний текстовий коментар, який буде збережено разом з операцією. | string | необов’язковийПриклад: "Оплата долга"За замовчуванням: "Оплата долга" |
Точна схема параметрів
{
"card": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер дисконтної картки",
"description": "Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "990000001"
},
"com1": {
"type": "string",
"max": 512,
"default": "Оплата долга",
"title": "Основний коментар",
"description": "Основний текстовий коментар, який буде збережено разом з операцією.",
"group": "Додаткові",
"example": "Оплата долга"
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
cash_accountКасовий рахунок | Повернене значення «Касовий рахунок» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
amountСума | Точне повернене значення «Сума» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
dateДата | Повернена дата «Дата» у форматі YYYY-MM-DD. | string · date | "2026-07-23" |
document_numberНомер документа | Номер документа у базі поточного клієнта. | string | "ПН-1001" |
user_nameUser name | Повернене значення «User name» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"cash_account",
"amount",
"date",
"document_number",
"user_name"
],
"field_specs": {
"cash_account": {
"title": "Касовий рахунок",
"description": "Повернене значення «Касовий рахунок» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"amount": {
"title": "Сума",
"description": "Точне повернене значення «Сума» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"date": {
"title": "Дата",
"description": "Повернена дата «Дата» у форматі YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2026-07-23"
},
"document_number": {
"title": "Номер документа",
"description": "Номер документа у базі поточного клієнта.",
"type": "string",
"example": "ПН-1001"
},
"user_name": {
"title": "User name",
"description": "Повернене значення «User name» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.debt_payment_history",
"params": {
"card": "990000001"
},
"id": "example-pos-debt-payment-history"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.debt_payment_history",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "debt_payment_history",
"value": "1"
},
"rows": [
{
"cash_account": "Приклад",
"amount": "100.00",
"date": "2026-07-23",
"document_number": "ПН-1001",
"user_name": "Приклад"
}
]
},
"id": "example-pos-debt-payment-history"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.discount_card_addСтворює нову дисконтну картку клієнта безпосередньо з каси.
запис
pos.write
з 0.4.0
Створює нову дисконтну картку клієнта безпосередньо з каси.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
code_suffixЗакінчення коду | Поле «Закінчення коду» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
first_nameІм’я | Поле «Ім’я» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
last_nameПрізвище | Поле «Прізвище» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
pref_discПрефікс дисконтної картки | Префікс, за яким відсканований код розпізнається як дисконтна картка. | string | обов’язковийПриклад: "Приклад" |
telТелефон | Поле «Телефон» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string · phone | необов’язковийПриклад: "+380501234567"За замовчуванням: "" |
| Знижки, бонуси та борг | |||
is_debtПродаж у борг | Поле «Продаж у борг» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
Точна схема параметрів
{
"code_suffix": {
"type": "string",
"max": 512,
"required": true,
"title": "Закінчення коду",
"description": "Поле «Закінчення коду» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
},
"first_name": {
"type": "string",
"max": 512,
"default": "",
"title": "Ім’я",
"description": "Поле «Ім’я» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"is_debt": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 0,
"title": "Продаж у борг",
"description": "Поле «Продаж у борг» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Знижки, бонуси та борг",
"example": 1
},
"last_name": {
"type": "string",
"max": 512,
"default": "",
"title": "Прізвище",
"description": "Поле «Прізвище» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"pref_disc": {
"type": "string",
"max": 4096,
"required": true,
"title": "Префікс дисконтної картки",
"description": "Префікс, за яким відсканований код розпізнається як дисконтна картка.",
"group": "Додаткові",
"example": "Приклад"
},
"tel": {
"type": "string",
"max": 4096,
"default": "",
"title": "Телефон",
"description": "Поле «Телефон» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"format": "phone",
"example": "+380501234567"
}
}Результат
Форма відповіді:
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-discount-card-add-0001
{
"method": "pos.discount_card_add",
"params": {
"code_suffix": "Приклад",
"pref_disc": "99"
},
"id": "example-pos-discount-card-add"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.discount_card_add",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "discount_card_add",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-discount-card-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.discount_card_detailsПовертає повні дані вибраної дисконтної картки.
читання
pos.read
з 0.4.0
Повертає повні дані вибраної дисконтної картки.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeНомер дисконтної картки | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | необов’язковийПриклад: "1001"За замовчуванням: "" |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"default": "",
"title": "Номер дисконтної картки",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
fieldПоле | Повернене значення «Поле» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
valueЗначення | Повернене значення «Значення» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"field",
"value"
],
"field_specs": {
"field": {
"title": "Поле",
"description": "Повернене значення «Поле» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"value": {
"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.discount_card_details",
"params": {
"code": "1001"
},
"id": "example-pos-discount-card-details"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.discount_card_details",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "discount_card_details",
"value": "1"
},
"rows": [
{
"field": "Приклад",
"value": "Приклад"
}
]
},
"id": "example-pos-discount-card-details"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.discount_cardsПовертає список дисконтних карток для пошуку клієнта.
читання
pos.read
з 0.4.0
Повертає список дисконтних карток для пошуку клієнта.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
extra_nameНазва додаткового поля | Поле «Назва додаткового поля» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
filterФільтр пошуку | Варіант «Фільтр пошуку». Використовуйте лише одне зі значень, розшифрованих нижче.
| enum | необов’язковийПриклад: "none"За замовчуванням: "none" |
limitМаксимальна кількість рядків | Максимальна кількість рядків, яку потрібно повернути. Менше значення зменшує відповідь. | int | необов’язковийПриклад: 1За замовчуванням: 201 |
searchПошуковий запит | Поле «Пошуковий запит» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
Точна схема параметрів
{
"extra_name": {
"type": "string",
"max": 512,
"default": "",
"title": "Назва додаткового поля",
"description": "Поле «Назва додаткового поля» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"filter": {
"type": "enum",
"values": [
"none",
"code",
"last_name",
"first_name",
"extra"
],
"default": "none",
"title": "Фільтр пошуку",
"description": "Варіант «Фільтр пошуку». Використовуйте лише одне зі значень, розшифрованих нижче.",
"group": "Додаткові",
"example": "none",
"enum_labels": {
"none": "без фільтра",
"code": "за номером картки",
"last_name": "за прізвищем",
"first_name": "за ім’ям",
"extra": "за додатковим полем"
}
},
"limit": {
"type": "int",
"min": 1,
"max": 201,
"default": 201,
"title": "Максимальна кількість рядків",
"description": "Максимальна кількість рядків, яку потрібно повернути. Менше значення зменшує відповідь.",
"group": "Додаткові",
"example": 1
},
"search": {
"type": "string",
"max": 512,
"default": "",
"title": "Пошуковий запит",
"description": "Поле «Пошуковий запит» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
codeНомер дисконтної картки | Повернене значення «Номер дисконтної картки» відповідного запису, документа або підсумку ARM20. | string | "1001" |
last_nameПрізвище | Повернене значення «Прізвище» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
first_nameІм’я | Повернене значення «Ім’я» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
middle_nameПо батькові | Повернене значення «По батькові» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
discount_percentDiscount percent | Точне повернене значення «Discount percent» як десятковий рядок із крапкою. | string · decimal-string · percent | "100.00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"code",
"last_name",
"first_name",
"middle_name",
"discount_percent"
],
"field_specs": {
"code": {
"title": "Номер дисконтної картки",
"description": "Повернене значення «Номер дисконтної картки» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "1001"
},
"last_name": {
"title": "Прізвище",
"description": "Повернене значення «Прізвище» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"first_name": {
"title": "Ім’я",
"description": "Повернене значення «Ім’я» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"middle_name": {
"title": "По батькові",
"description": "Повернене значення «По батькові» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"discount_percent": {
"title": "Discount percent",
"description": "Точне повернене значення «Discount percent» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "percent",
"example": "100.00"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.discount_cards",
"params": {
"extra_name": "Опис",
"filter": "code",
"limit": 20,
"search": "кава"
},
"id": "example-pos-discount-cards"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.discount_cards",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "discount_cards",
"value": "1"
},
"rows": [
{
"code": "1001",
"last_name": "Приклад",
"first_name": "Приклад",
"middle_name": "Приклад",
"discount_percent": "100.00"
}
]
},
"id": "example-pos-discount-cards"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.discount_extra_namesПовертає назви додаткових полів дисконтних карток.
читання
pos.read
з 0.4.0
Повертає назви додаткових полів дисконтних карток.
Параметри params
Параметри не потрібні. Передайте порожній об’єкт
{}.Точна схема параметрів
{}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
nameНазва | Повернене значення «Назва» відповідного запису, документа або підсумку ARM20. | string | "Тестовий товар" |
Точна схема результату
{
"mode": "rows",
"columns": [
"name"
],
"field_specs": {
"name": {
"title": "Назва",
"description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Тестовий товар"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.discount_extra_names",
"params": [],
"id": "example-pos-discount-extra-names"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.discount_extra_names",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "discount_extra_names",
"value": "1"
},
"rows": [
{
"name": "Тестовий товар"
}
]
},
"id": "example-pos-discount-extra-names"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.extra_columnsПовертає додаткові колонки товарів, налаштовані для каси.
читання
pos.read
з 0.4.0
Повертає додаткові колонки товарів, налаштовані для каси.
Параметри params
Параметри не потрібні. Передайте порожній об’єкт
{}.Точна схема параметрів
{}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
idІдентифікатор запису | Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
nameНазва | Повернене значення «Назва» відповідного запису, документа або підсумку ARM20. | string | "Тестовий товар" |
Точна схема результату
{
"mode": "rows",
"columns": [
"id",
"name"
],
"field_specs": {
"id": {
"title": "Ідентифікатор запису",
"description": "Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"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.extra_columns",
"params": [],
"id": "example-pos-extra-columns"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.extra_columns",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "extra_columns",
"value": "1"
},
"rows": [
{
"id": "Приклад",
"name": "Тестовий товар"
}
]
},
"id": "example-pos-extra-columns"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.fifo_choice_appendДодає вибрану партію FIFO до позиції касового чека.
запис
pos.write
з 0.4.0
Додає вибрану партію FIFO до позиції касового чека.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeКод товару | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | необов’язковийПриклад: "1001"За замовчуванням: "" |
| Колекції | |||
itemsЕлементи | Список «Елементи». Структуру одного елемента, обов’язкові поля та межі кількості наведено нижче. | array<object> | обов’язковийПриклад: [] |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"default": "",
"title": "Код товару",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"items": {
"type": "array",
"required": true,
"min_items": 1,
"max_items": 250,
"items": {
"type": "object",
"fields": {
"document_number": {
"type": "string",
"required": true,
"max": 512,
"pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]{1,512}$/uD",
"title": "Номер документа",
"description": "Поле «Номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "ПН-1001"
},
"quantity": {
"type": "decimal",
"required": true,
"max": 32,
"scale": 3,
"title": "Кількість",
"description": "Кількість товару як десятковий рядок; одиниця залежить від картки товару.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "product-unit",
"example": "1.000"
}
}
},
"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-fifo-choice-append-0001
{
"method": "pos.fifo_choice_append",
"params": {
"code": "1001",
"items": [
{
"document_number": "ПН-1001",
"quantity": "1.000"
}
]
},
"id": "example-pos-fifo-choice-append"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.fifo_choice_append",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "fifo_choice_append",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-fifo-choice-append"
},
"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.fifo_choice_rowsПовертає партії FIFO, доступні для вибору під час продажу.
читання
pos.read
з 0.4.0
Повертає партії FIFO, доступні для вибору під час продажу.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeКод товару | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | необов’язковийПриклад: "1001"За замовчуванням: "" |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"default": "",
"title": "Код товару",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
document_numberНомер документа | Номер документа у базі поточного клієнта. | string | "ПН-1001" |
quantityКількість | Точне повернене значення «Кількість» як десятковий рядок із крапкою. | string · decimal-string · product-unit | "1.000" |
Точна схема результату
{
"mode": "rows",
"columns": [
"document_number",
"quantity"
],
"field_specs": {
"document_number": {
"title": "Номер документа",
"description": "Номер документа у базі поточного клієнта.",
"type": "string",
"example": "ПН-1001"
},
"quantity": {
"title": "Кількість",
"description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "product-unit",
"example": "1.000"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.fifo_choice_rows",
"params": {
"code": "1001"
},
"id": "example-pos-fifo-choice-rows"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.fifo_choice_rows",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "fifo_choice_rows",
"value": "1"
},
"rows": [
{
"document_number": "ПН-1001",
"quantity": "1.000"
}
]
},
"id": "example-pos-fifo-choice-rows"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.fifo_invoice_rowsПовертає партії накладних, з яких сформовано залишок товару.
читання
pos.read
з 0.4.0
Повертає партії накладних, з яких сформовано залишок товару.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeКод товару | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | необов’язковийПриклад: "1001"За замовчуванням: "" |
storageСклад | Логічний склад: main — основний, branch — філіальний.
| enum | необов’язковийПриклад: "main"За замовчуванням: "main" |
| Додаткові | |||
skНомер складу або філії | Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"default": "",
"title": "Код товару",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"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| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
document_numberНомер документа | Номер документа у базі поточного клієнта. | string | "ПН-1001" |
supplier_nameSupplier name | Повернене значення «Supplier name» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
dateДата | Повернена дата «Дата» у форматі YYYY-MM-DD. | string · date | "2026-07-23" |
fiscalФіскальна ознака | Повернене значення «Фіскальна ознака» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
quantityКількість | Точне повернене значення «Кількість» як десятковий рядок із крапкою. | string · decimal-string · product-unit | "1.000" |
Точна схема результату
{
"mode": "rows",
"columns": [
"document_number",
"supplier_name",
"date",
"fiscal",
"quantity"
],
"field_specs": {
"document_number": {
"title": "Номер документа",
"description": "Номер документа у базі поточного клієнта.",
"type": "string",
"example": "ПН-1001"
},
"supplier_name": {
"title": "Supplier name",
"description": "Повернене значення «Supplier name» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"date": {
"title": "Дата",
"description": "Повернена дата «Дата» у форматі YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2026-07-23"
},
"fiscal": {
"title": "Фіскальна ознака",
"description": "Повернене значення «Фіскальна ознака» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"quantity": {
"title": "Кількість",
"description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "product-unit",
"example": "1.000"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.fifo_invoice_rows",
"params": {
"code": "1001",
"sk": 1,
"storage": "main"
},
"id": "example-pos-fifo-invoice-rows"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.fifo_invoice_rows",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "fifo_invoice_rows",
"value": "1"
},
"rows": [
{
"document_number": "ПН-1001",
"supplier_name": "Приклад",
"date": "2026-07-23",
"fiscal": "Приклад",
"quantity": "1.000"
}
]
},
"id": "example-pos-fifo-invoice-rows"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.fifo_summaryПовертає зведення залишків товару за партіями FIFO.
читання
pos.read
з 0.4.0
Повертає зведення залишків товару за партіями FIFO.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeКод товару | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | необов’язковийПриклад: "1001"За замовчуванням: "" |
storageСклад | Логічний склад: main — основний, branch — філіальний.
| enum | необов’язковийПриклад: "main"За замовчуванням: "main" |
| Додаткові | |||
skНомер складу або філії | Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад. | int | необов’язковийПриклад: 1За замовчуванням: 0 |
with_fiscalВраховувати фіскальні дані | Визначає, чи застосовувати параметр «Враховувати фіскальні дані». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: false |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"default": "",
"title": "Код товару",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"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": "філіальний склад"
}
},
"with_fiscal": {
"type": "bool",
"default": false,
"title": "Враховувати фіскальні дані",
"description": "Визначає, чи застосовувати параметр «Враховувати фіскальні дані». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
batch_countBatch count | Повернене значення «Batch count» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
quantityКількість | Точне повернене значення «Кількість» як десятковий рядок із крапкою. | string · decimal-string · product-unit | "1.000" |
Точна схема результату
{
"mode": "rows",
"columns": [
"batch_count",
"quantity"
],
"field_specs": {
"batch_count": {
"title": "Batch count",
"description": "Повернене значення «Batch count» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"quantity": {
"title": "Кількість",
"description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "product-unit",
"example": "1.000"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.fifo_summary",
"params": {
"code": "1001",
"sk": 1,
"storage": "main",
"with_fiscal": true
},
"id": "example-pos-fifo-summary"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.fifo_summary",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "fifo_summary",
"value": "1"
},
"rows": [
{
"batch_count": "Приклад",
"quantity": "1.000"
}
]
},
"id": "example-pos-fifo-summary"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.is_etaxПеревіряє, чи має товар ознаку вхідного акцизу.
читання
pos.read
з 0.4.0
Перевіряє, чи має товар ознаку вхідного акцизу.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeКод товару | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | необов’язковийПриклад: "1001"За замовчуванням: "" |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"default": "",
"title": "Код товару",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
}
}Результат
Форма відповіді:
scalar| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
valueЗначення | Повернене значення «Значення» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "scalar",
"value_type": "string",
"value_spec": {
"title": "Значення",
"description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.is_etax",
"params": {
"code": "1001"
},
"id": "example-pos-is-etax"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.is_etax",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "is_etax",
"value": "Приклад"
},
"rows": []
},
"id": "example-pos-is-etax"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.overdue_debtsПовертає список прострочених боргів клієнтів.
читання
pos.read
з 0.4.0
Повертає список прострочених боргів клієнтів.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Дати й час | |||
max_dateМаксимальна дата | Дата «Максимальна дата» у календарному форматі YYYY-MM-DD. | string · date | необов’язковийПриклад: "2026-07-23"За замовчуванням: "" |
| Додаткові | |||
only_userЛише поточний користувач | Визначає, чи застосовувати параметр «Лише поточний користувач». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: false |
Точна схема параметрів
{
"max_date": {
"type": "string",
"max": 512,
"default": "",
"title": "Максимальна дата",
"description": "Дата «Максимальна дата» у календарному форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
},
"only_user": {
"type": "bool",
"default": false,
"title": "Лише поточний користувач",
"description": "Визначає, чи застосовувати параметр «Лише поточний користувач». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
cardНомер дисконтної картки | Повернене значення «Номер дисконтної картки» відповідного запису, документа або підсумку ARM20. | string | "990000001" |
last_nameПрізвище | Повернене значення «Прізвище» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
first_nameІм’я | Повернене значення «Ім’я» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
middle_nameПо батькові | Повернене значення «По батькові» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
debtОплата в борг | Точне повернене значення «Оплата в борг» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"card",
"last_name",
"first_name",
"middle_name",
"debt"
],
"field_specs": {
"card": {
"title": "Номер дисконтної картки",
"description": "Повернене значення «Номер дисконтної картки» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "990000001"
},
"last_name": {
"title": "Прізвище",
"description": "Повернене значення «Прізвище» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"first_name": {
"title": "Ім’я",
"description": "Повернене значення «Ім’я» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"middle_name": {
"title": "По батькові",
"description": "Повернене значення «По батькові» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"debt": {
"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.overdue_debts",
"params": {
"max_date": "Приклад",
"only_user": true
},
"id": "example-pos-overdue-debts"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.overdue_debts",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "overdue_debts",
"value": "1"
},
"rows": [
{
"card": "990000001",
"last_name": "Приклад",
"first_name": "Приклад",
"middle_name": "Приклад",
"debt": "100.00"
}
]
},
"id": "example-pos-overdue-debts"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.service_cheks_print_addДодає завдання на службовий друк касового чека.
запис
pos.write
з 0.4.0
Додає завдання на службовий друк касового чека.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
ncНомер чека | Номер касового чека у базі поточного клієнта. | string | обов’язковийПриклад: "Приклад" |
txtТекст | Поле «Текст» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
Точна схема параметрів
{
"nc": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер чека",
"description": "Номер касового чека у базі поточного клієнта.",
"group": "Додаткові",
"example": "Приклад"
},
"txt": {
"type": "string",
"max": 4096,
"default": "",
"title": "Текст",
"description": "Поле «Текст» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
}
}Результат
Форма відповіді:
status| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
affectedЗмінено записів | Кількість записів, які upstream фактично змінив. | string | "Приклад" |
Точна схема результату
{
"mode": "status",
"fields": [
"affected"
],
"field_specs": {
"affected": {
"title": "Змінено записів",
"description": "Кількість записів, які upstream фактично змінив.",
"type": "string",
"example": "Приклад"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-pos-service-cheks-print-add-0001
{
"method": "pos.service_cheks_print_add",
"params": {
"nc": "Приклад"
},
"id": "example-pos-service-cheks-print-add"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.service_cheks_print_add",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "service_cheks_print_add",
"affected": "Приклад"
},
"rows": []
},
"id": "example-pos-service-cheks-print-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.service_next_docПовертає наступний номер службового документа каси.
читання
pos.read
з 0.4.0
Повертає наступний номер службового документа каси.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
prefixПрефікс | Поле «Префікс» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
Точна схема параметрів
{
"prefix": {
"type": "string",
"max": 4096,
"required": true,
"title": "Префікс",
"description": "Поле «Префікс» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
}
}Результат
Форма відповіді:
scalar| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
valueЗначення | Повернене значення «Значення» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "scalar",
"value_type": "string",
"value_spec": {
"title": "Значення",
"description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.service_next_doc",
"params": {
"prefix": "Приклад"
},
"id": "example-pos-service-next-doc"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.service_next_doc",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "service_next_doc",
"value": "Приклад"
},
"rows": []
},
"id": "example-pos-service-next-doc"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.size_entriesПовертає доступні значення розмірів товарів.
читання
pos.read
з 0.4.0
Повертає доступні значення розмірів товарів.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
type_codeКод типу | Поле «Код типу» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
Точна схема параметрів
{
"type_code": {
"type": "string",
"max": 512,
"default": "",
"title": "Код типу",
"description": "Поле «Код типу» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
row_orderRow order | Повернене значення «Row order» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
canonical_sizeCanonical size | Повернене значення «Canonical size» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
ruRu | Повернене значення «Ru» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
euEu | Повернене значення «Eu» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
usUs | Повернене значення «Us» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
ukUk | Повернене значення «Uk» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
internationalInternational | Повернене значення «International» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
centimetersCentimeters | Повернене значення «Centimeters» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
waistWaist | Повернене значення «Waist» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
lengthLength | Повернене значення «Length» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
ageAge | Повернене значення «Age» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
commentComment | Повернене значення «Comment» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"row_order",
"canonical_size",
"ru",
"eu",
"us",
"uk",
"international",
"centimeters",
"waist",
"length",
"age",
"comment"
],
"field_specs": {
"row_order": {
"title": "Row order",
"description": "Повернене значення «Row order» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"canonical_size": {
"title": "Canonical size",
"description": "Повернене значення «Canonical size» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"ru": {
"title": "Ru",
"description": "Повернене значення «Ru» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"eu": {
"title": "Eu",
"description": "Повернене значення «Eu» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"us": {
"title": "Us",
"description": "Повернене значення «Us» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"uk": {
"title": "Uk",
"description": "Повернене значення «Uk» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"international": {
"title": "International",
"description": "Повернене значення «International» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"centimeters": {
"title": "Centimeters",
"description": "Повернене значення «Centimeters» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"waist": {
"title": "Waist",
"description": "Повернене значення «Waist» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"length": {
"title": "Length",
"description": "Повернене значення «Length» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"age": {
"title": "Age",
"description": "Повернене значення «Age» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"comment": {
"title": "Comment",
"description": "Повернене значення «Comment» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.size_entries",
"params": {
"type_code": "Продаж"
},
"id": "example-pos-size-entries"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.size_entries",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "size_entries",
"value": "1"
},
"rows": [
{
"row_order": "Приклад",
"canonical_size": "Приклад",
"ru": "Приклад",
"eu": "Приклад",
"us": "Приклад",
"uk": "Приклад",
"international": "Приклад",
"centimeters": "Приклад",
"waist": "Приклад",
"length": "Приклад",
"age": "Приклад",
"comment": "Приклад"
}
]
},
"id": "example-pos-size-entries"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.size_productsПовертає товари, що належать до вибраної розмірної групи.
читання
pos.read
з 0.4.0
Повертає товари, що належать до вибраної розмірної групи.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
canonCanon | Поле «Canon» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
type_codeКод типу | Поле «Код типу» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
Точна схема параметрів
{
"canon": {
"type": "string",
"max": 4096,
"default": "",
"title": "Canon",
"description": "Поле «Canon» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"type_code": {
"type": "string",
"max": 512,
"default": "",
"title": "Код типу",
"description": "Поле «Код типу» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
}
}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
codeКод товару | Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20. | string | "1001" |
nameНазва | Повернене значення «Назва» відповідного запису, документа або підсумку ARM20. | string | "Тестовий товар" |
priceЦіна | Точне повернене значення «Ціна» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
quantityКількість | Точне повернене значення «Кількість» як десятковий рядок із крапкою. | string · decimal-string · product-unit | "1.000" |
Точна схема результату
{
"mode": "rows",
"columns": [
"code",
"name",
"price",
"quantity"
],
"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"
},
"quantity": {
"title": "Кількість",
"description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "product-unit",
"example": "1.000"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.size_products",
"params": {
"canon": "Приклад",
"type_code": "Продаж"
},
"id": "example-pos-size-products"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.size_products",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "size_products",
"value": "1"
},
"rows": [
{
"code": "1001",
"name": "Тестовий товар",
"price": "100.00",
"quantity": "1.000"
}
]
},
"id": "example-pos-size-products"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
pos.size_typesПовертає довідник типів і груп розмірів.
читання
pos.read
з 0.4.0
Повертає довідник типів і груп розмірів.
Параметри params
Параметри не потрібні. Передайте порожній об’єкт
{}.Точна схема параметрів
{}Результат
Форма відповіді:
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
type_codeКод типу | Повернене значення «Код типу» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
type_nameType name | Повернене значення «Type name» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
type_orderType order | Повернене значення «Type order» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"type_code",
"type_name",
"type_order"
],
"field_specs": {
"type_code": {
"title": "Код типу",
"description": "Повернене значення «Код типу» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"type_name": {
"title": "Type name",
"description": "Повернене значення «Type name» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"type_order": {
"title": "Type order",
"description": "Повернене значення «Type order» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "pos.size_types",
"params": [],
"id": "example-pos-size-types"
}Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "pos.size_types",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "pos"
},
"status": {
"code": "OK",
"operation": "size_types",
"value": "1"
},
"rows": [
{
"type_code": "Приклад",
"type_name": "Приклад",
"type_order": "Приклад"
}
]
},
"id": "example-pos-size-types"
},
"request_id": "req_example_0123456789abcdef"
}Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |