Бізнес-блок

Фінанси, борги та лояльність

Рух коштів, оплати накладних, борги, бонуси та додаткові дані дисконтних карток.

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

Дисконтні картки та бонуси

4 методів
discounts.bonus_commentsПовертає довідник коментарів для операцій із бонусами. читання finance.read з 0.4.0

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

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

Параметри params

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

Результат

Форма відповіді: rows_uncounted
ПолеЗмістТипПриклад
commentCommentПовернене значення «Comment» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "rows_uncounted",
    "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": "discounts.bonus_comments",
    "params": [],
    "id": "example-discounts-bonus-comments"
}

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

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

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

Видаляє значення додаткового поля дисконтної картки.

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

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
codeНомер дисконтної картки

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

string
обов’язковийПриклад: "1001"
ntНазва додаткового поля

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

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

Результат

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

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-discounts-delete-extra-value-0001

{
    "method": "discounts.delete_extra_value",
    "params": {
        "code": "1001",
        "nt": "Тестовий товар"
    },
    "id": "example-discounts-delete-extra-value"
}

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

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

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

Позначає дисконтну картку, яку слід пропустити під час імпорту.

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

Параметри params

ПолеЩо означаєТип і форматПравила
Дати й час
birth_dateДата народження

Дата «Дата народження» у календарному форматі YYYY-MM-DD.

string · date
необов’язковийПриклад: "2026-07-23"За замовчуванням: ""
Основні
codeНомер дисконтної картки

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

string
обов’язковийПриклад: "1001"
Додаткові
dfПрізвище

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

string
необов’язковийПриклад: ""За замовчуванням: ""
diІм’я

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

string
необов’язковийПриклад: ""За замовчуванням: ""
doПо батькові

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

string
необов’язковийПриклад: ""За замовчуванням: ""
dopinfДодаткова інформація

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

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

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

int
необов’язковийПриклад: 1За замовчуванням: 0
telТелефон

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

string · phone
необов’язковийПриклад: "+380501234567"За замовчуванням: ""
Суми та кількості
discВідсоток знижки

Точне числове значення «Відсоток знижки» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

string · decimal-string · percent
необов’язковийПриклад: "100.00"
maxdolgЛіміт боргу

Точне числове значення «Ліміт боргу» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
sumpokСума покупок

Точне числове значення «Сума покупок» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
Точна схема параметрів 
{
    "birth_date": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Дата народження",
        "description": "Дата «Дата народження» у календарному форматі YYYY-MM-DD.",
        "group": "Дати й час",
        "format": "date",
        "example": "2026-07-23"
    },
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Номер дисконтної картки",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "df": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Прізвище",
        "description": "Поле «Прізвище» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "di": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Ім’я",
        "description": "Поле «Ім’я» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "disc": {
        "type": "string",
        "max": 4096,
        "title": "Відсоток знижки",
        "description": "Точне числове значення «Відсоток знижки» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "percent",
        "example": "100.00"
    },
    "do": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "По батькові",
        "description": "Поле «По батькові» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "dopinf": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Додаткова інформація",
        "description": "Поле «Додаткова інформація» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "isdolg": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "default": 0,
        "title": "Дозволити борг",
        "description": "Поле «Дозволити борг» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": 1
    },
    "maxdolg": {
        "type": "string",
        "max": 4096,
        "title": "Ліміт боргу",
        "description": "Точне числове значення «Ліміт боргу» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    },
    "sumpok": {
        "type": "string",
        "max": 4096,
        "title": "Сума покупок",
        "description": "Точне числове значення «Сума покупок» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    },
    "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-discounts-import-card-ignore-0001

{
    "method": "discounts.import_card_ignore",
    "params": {
        "code": "1001"
    },
    "id": "example-discounts-import-card-ignore"
}

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

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

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

Зберігає значення додаткового поля дисконтної картки.

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

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
codeНомер дисконтної картки

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

string
обов’язковийПриклад: "1001"
ntНазва додаткового поля

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

string
обов’язковийПриклад: "Тестовий товар"
Додаткові
valЗначення

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

string
необов’язковийПриклад: ""За замовчуванням: ""
Точна схема параметрів 
{
    "code": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Номер дисконтної картки",
        "description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
        "group": "Основні",
        "example": "1001"
    },
    "nt": {
        "type": "string",
        "max": 512,
        "required": true,
        "title": "Назва додаткового поля",
        "description": "Поле «Назва додаткового поля» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Основні",
        "example": "Тестовий товар"
    },
    "val": {
        "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-discounts-save-extra-value-0001

{
    "method": "discounts.save_extra_value",
    "params": {
        "code": "1001",
        "nt": "Тестовий товар"
    },
    "id": "example-discounts-save-extra-value"
}

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

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

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

Фінанси

13 методів
finance.cash_moveВиконує внесення, вилучення або інше коригування суми в касі. запис finance.write з 0.4.0

Виконує внесення, вилучення або інше коригування суми в касі.

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

Параметри params

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

Основний текстовий коментар, який буде збережено разом з операцією.

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

Додатковий коментар операції; використовуйте лише коли він потрібний відповідному сценарію Windows.

string
необов’язковийПриклад: ""За замовчуванням: ""
kasКасовий рахунок

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

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

Номер службового, касового або фіскального документа у відповідному журналі.

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

Текстова назва або код виду документа, який зберігається у касовій операції.

string
необов’язковийПриклад: ""За замовчуванням: ""
Суми та кількості
sumСума

Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
Точна схема параметрів 
{
    "com1": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Основний коментар",
        "description": "Основний текстовий коментар, який буде збережено разом з операцією.",
        "group": "Додаткові",
        "example": ""
    },
    "com2": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Додатковий коментар",
        "description": "Додатковий коментар операції; використовуйте лише коли він потрібний відповідному сценарію Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "kas": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Касовий рахунок",
        "description": "Поле «Касовий рахунок» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "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": ""
    }
}

Результат

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

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

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

{
    "method": "finance.cash_move",
    "params": {
        "kas": "Касове місце N1",
        "sum": "Приклад",
        "ndoc": "Приклад"
    },
    "id": "example-finance-cash-move"
}

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

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

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

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

finance.contrag_debt_moveЗбільшує або зменшує заборгованість контрагента. запис finance.write з 0.4.0

Збільшує або зменшує заборгованість контрагента.

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

Параметри params

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

Основний текстовий коментар, який буде збережено разом з операцією.

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

Додатковий коментар операції; використовуйте лише коли він потрібний відповідному сценарію Windows.

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

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

string
необов’язковийПриклад: ""За замовчуванням: ""
fromkasКаса-джерело

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

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

Номер службового, касового або фіскального документа у відповідному журналі.

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

Текстова назва або код виду документа, який зберігається у касовій операції.

string
необов’язковийПриклад: ""За замовчуванням: ""
Суми та кількості
sumСума

Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
Точна схема параметрів 
{
    "com1": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Основний коментар",
        "description": "Основний текстовий коментар, який буде збережено разом з операцією.",
        "group": "Додаткові",
        "example": ""
    },
    "com2": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Додатковий коментар",
        "description": "Додатковий коментар операції; використовуйте лише коли він потрібний відповідному сценарію Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "contrag": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Контрагент",
        "description": "Поле «Контрагент» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "fromkas": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Каса-джерело",
        "description": "Поле «Каса-джерело» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "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": ""
    }
}

Результат

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

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-finance-contrag-debt-move-0001

{
    "method": "finance.contrag_debt_move",
    "params": {
        "contrag": "Тестовий контрагент",
        "sum": "Приклад",
        "ndoc": "Приклад"
    },
    "id": "example-finance-contrag-debt-move"
}

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

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

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

Видаляє оплату, прив’язану до накладної.

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

Параметри params

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

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

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

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

string
необов’язковийПриклад: ""За замовчуванням: ""
Основні
modeРежим операції

Вибирає один із підтримуваних сценаріїв операції. Значення та їх зміст наведено у списку варіантів.

  • contrag — операція з контрагентом
  • supplier — операція з постачальником
enum
обов’язковийПриклад: "contrag"
nnНомер накладної

Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.

string
необов’язковийПриклад: "ПН-1001"За замовчуванням: ""
Дати й час
payment_datДата оплати

Дата «Дата оплати» у календарному форматі YYYY-MM-DD.

string · date
необов’язковийПриклад: "2026-07-23"За замовчуванням: ""
Суми та кількості
payment_sumСума оплати

Точне числове значення «Сума оплати» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
Точна схема параметрів 
{
    "fromkas": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Каса-джерело",
        "description": "Поле «Каса-джерело» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "mode": {
        "type": "enum",
        "values": [
            "contrag",
            "supplier"
        ],
        "required": true,
        "title": "Режим операції",
        "description": "Вибирає один із підтримуваних сценаріїв операції. Значення та їх зміст наведено у списку варіантів.",
        "group": "Основні",
        "example": "contrag",
        "enum_labels": {
            "contrag": "операція з контрагентом",
            "supplier": "операція з постачальником"
        }
    },
    "nn": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Номер накладної",
        "description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
        "group": "Основні",
        "example": "ПН-1001"
    },
    "payment_dat": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Дата оплати",
        "description": "Дата «Дата оплати» у календарному форматі YYYY-MM-DD.",
        "group": "Дати й час",
        "format": "date",
        "example": "2026-07-23"
    },
    "payment_sum": {
        "type": "string",
        "max": 512,
        "title": "Сума оплати",
        "description": "Точне числове значення «Сума оплати» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    },
    "side_name": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Назва сторони документа",
        "description": "Поле «Назва сторони документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    }
}

Результат

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

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-finance-delete-invoice-payment-0001

{
    "method": "finance.delete_invoice_payment",
    "params": {
        "mode": "contrag"
    },
    "id": "example-finance-delete-invoice-payment"
}

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

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

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

Нараховує або списує бонуси дисконтної картки та фіксує операцію.

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

Параметри params

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

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

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

Основний текстовий коментар, який буде збережено разом з операцією.

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

Додатковий коментар операції; використовуйте лише коли він потрібний відповідному сценарію Windows.

string
необов’язковийПриклад: ""За замовчуванням: ""
Суми та кількості
sumСума

Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
Точна схема параметрів 
{
    "card": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Номер дисконтної картки",
        "description": "Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "990000001"
    },
    "com1": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Основний коментар",
        "description": "Основний текстовий коментар, який буде збережено разом з операцією.",
        "group": "Додаткові",
        "example": ""
    },
    "com2": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Додатковий коментар",
        "description": "Додатковий коментар операції; використовуйте лише коли він потрібний відповідному сценарію Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "sum": {
        "type": "string",
        "max": 4096,
        "title": "Сума",
        "description": "Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    }
}

Результат

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

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-finance-discount-bonus-add-0001

{
    "method": "finance.discount_bonus_add",
    "params": {
        "card": "990000001",
        "com1": "Демонстраційне значення",
        "com2": "Демонстраційне значення",
        "sum": "Приклад"
    },
    "id": "example-finance-discount-bonus-add"
}

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

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

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

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

finance.discount_bonus_infoПовертає бонусний баланс і параметри нарахування дисконтної картки. читання finance.read з 0.4.0

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

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

Параметри params

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

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

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

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
bonus_balanceБаланс бонусівТочне повернене значення «Баланс бонусів» як десятковий рядок із крапкою.string · decimal-string · currency-of-operation"100.00"
bonus_percentBonus percentПовернене значення «Bonus percent» відповідного запису, документа або підсумку ARM20.string"Приклад"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "bonus_balance",
        "bonus_percent"
    ],
    "field_specs": {
        "bonus_balance": {
            "title": "Баланс бонусів",
            "description": "Точне повернене значення «Баланс бонусів» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "bonus_percent": {
            "title": "Bonus percent",
            "description": "Повернене значення «Bonus percent» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

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

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

{
    "method": "finance.discount_bonus_info",
    "params": {
        "card": "990000001"
    },
    "id": "example-finance-discount-bonus-info"
}

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

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

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

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

finance.discount_debt_bonus_lineДодає рядок погашення боргу бонусами дисконтної картки. запис finance.write з 0.4.0

Додає рядок погашення боргу бонусами дисконтної картки.

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

Параметри params

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

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

string
необов’язковийПриклад: "990000001"За замовчуванням: ""
ncНомер чека

Номер касового чека у базі поточного клієнта.

string
необов’язковийПриклад: ""За замовчуванням: ""
Суми та кількості
sumСума

Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
Точна схема параметрів 
{
    "card": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Номер дисконтної картки",
        "description": "Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "990000001"
    },
    "nc": {
        "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"
    }
}

Результат

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

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-finance-discount-debt-bonus-line-0001

{
    "method": "finance.discount_debt_bonus_line",
    "params": {
        "card": "990000001",
        "nc": "Приклад",
        "sum": "Приклад"
    },
    "id": "example-finance-discount-debt-bonus-line"
}

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

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

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

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

finance.discount_debt_bonus_payПроводить погашення боргу бонусами дисконтної картки. запис finance.write з 0.4.0

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

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

Параметри params

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

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

string
необов’язковийПриклад: "990000001"За замовчуванням: ""
Суми та кількості
sumСума

Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
Точна схема параметрів 
{
    "card": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Номер дисконтної картки",
        "description": "Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "990000001"
    },
    "sum": {
        "type": "string",
        "max": 4096,
        "title": "Сума",
        "description": "Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    }
}

Результат

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

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-finance-discount-debt-bonus-pay-0001

{
    "method": "finance.discount_debt_bonus_pay",
    "params": {
        "card": "990000001",
        "sum": "Приклад"
    },
    "id": "example-finance-discount-debt-bonus-pay"
}

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

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

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

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

finance.discount_debt_cash_lineДодає рядок грошового погашення боргу за дисконтною карткою. запис finance.write з 0.4.0

Додає рядок грошового погашення боргу за дисконтною карткою.

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

Параметри params

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

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

string
необов’язковийПриклад: "990000001"За замовчуванням: ""
kasКасовий рахунок

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

string
необов’язковийПриклад: ""За замовчуванням: ""
ncНомер чека

Номер касового чека у базі поточного клієнта.

string
необов’язковийПриклад: ""За замовчуванням: ""
Суми та кількості
sumСума

Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
Точна схема параметрів 
{
    "card": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Номер дисконтної картки",
        "description": "Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "990000001"
    },
    "kas": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Касовий рахунок",
        "description": "Поле «Касовий рахунок» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "nc": {
        "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"
    }
}

Результат

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

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-finance-discount-debt-cash-line-0001

{
    "method": "finance.discount_debt_cash_line",
    "params": {
        "card": "990000001",
        "kas": "Касове місце N1",
        "nc": "Приклад",
        "sum": "Приклад"
    },
    "id": "example-finance-discount-debt-cash-line"
}

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

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

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

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

finance.discount_debt_cash_payПроводить грошове погашення боргу за дисконтною карткою. запис finance.write з 0.4.0

Проводить грошове погашення боргу за дисконтною карткою.

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

Параметри params

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

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

string
необов’язковийПриклад: "990000001"За замовчуванням: ""
kasКасовий рахунок

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

string
необов’язковийПриклад: ""За замовчуванням: ""
Суми та кількості
sumСума

Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
Точна схема параметрів 
{
    "card": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Номер дисконтної картки",
        "description": "Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "990000001"
    },
    "kas": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Касовий рахунок",
        "description": "Поле «Касовий рахунок» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "sum": {
        "type": "string",
        "max": 4096,
        "title": "Сума",
        "description": "Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    }
}

Результат

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

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-finance-discount-debt-cash-pay-0001

{
    "method": "finance.discount_debt_cash_pay",
    "params": {
        "card": "990000001",
        "kas": "Касове місце N1",
        "sum": "Приклад"
    },
    "id": "example-finance-discount-debt-cash-pay"
}

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

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

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

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

finance.invoice_currencyПовертає валюту та курс, використані в накладній. читання finance.read з 0.4.0

Повертає валюту та курс, використані в накладній.

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

Параметри params

ПолеЩо означаєТип і форматПравила
Основні
nnНомер накладної

Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.

string
необов’язковийПриклад: "ПН-1001"За замовчуванням: ""
Точна схема параметрів 
{
    "nn": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Номер накладної",
        "description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
        "group": "Основні",
        "example": "ПН-1001"
    }
}

Результат

Форма відповіді: rows
ПолеЗмістТипПриклад
exchange_rateExchange rateТочне повернене значення «Exchange rate» як десятковий рядок із крапкою.string · decimal-string · ratio"100.00"
currencyВалютаПовернене значення «Валюта» відповідного запису, документа або підсумку ARM20.string"UAH"
Точна схема результату 
{
    "mode": "rows",
    "columns": [
        "exchange_rate",
        "currency"
    ],
    "field_specs": {
        "exchange_rate": {
            "title": "Exchange rate",
            "description": "Точне повернене значення «Exchange rate» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "ratio",
            "example": "100.00"
        },
        "currency": {
            "title": "Валюта",
            "description": "Повернене значення «Валюта» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "UAH"
        }
    }
}

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

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

{
    "method": "finance.invoice_currency",
    "params": {
        "nn": "ПН-1001"
    },
    "id": "example-finance-invoice-currency"
}

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

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

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

Реєструє оплату накладної контрагента.

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

Параметри params

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

Основний текстовий коментар, який буде збережено разом з операцією.

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

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

string
необов’язковийПриклад: ""За замовчуванням: ""
fromkasКаса-джерело

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

string
необов’язковийПриклад: ""За замовчуванням: ""
Основні
nnНомер накладної

Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.

string
необов’язковийПриклад: "ПН-1001"За замовчуванням: ""
Суми та кількості
sumСума

Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
Точна схема параметрів 
{
    "com1": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Основний коментар",
        "description": "Основний текстовий коментар, який буде збережено разом з операцією.",
        "group": "Додаткові",
        "example": ""
    },
    "contrag": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Контрагент",
        "description": "Поле «Контрагент» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "fromkas": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Каса-джерело",
        "description": "Поле «Каса-джерело» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "nn": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Номер накладної",
        "description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
        "group": "Основні",
        "example": "ПН-1001"
    },
    "sum": {
        "type": "string",
        "max": 4096,
        "title": "Сума",
        "description": "Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    }
}

Результат

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

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-finance-pay-contrag-invoice-0001

{
    "method": "finance.pay_contrag_invoice",
    "params": {
        "nn": "ПН-1001",
        "contrag": "Тестовий контрагент",
        "sum": "Приклад"
    },
    "id": "example-finance-pay-contrag-invoice"
}

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

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

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

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

finance.pay_supplier_invoiceРеєструє оплату накладної постачальника. запис finance.write з 0.4.0

Реєструє оплату накладної постачальника.

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

Параметри params

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

Основний текстовий коментар, який буде збережено разом з операцією.

string
необов’язковийПриклад: ""За замовчуванням: ""
fromkasКаса-джерело

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

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

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

string
необов’язковийПриклад: ""За замовчуванням: ""
Основні
nnНомер накладної

Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.

string
необов’язковийПриклад: "ПН-1001"За замовчуванням: ""
Суми та кількості
sumСума

Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
Точна схема параметрів 
{
    "com1": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Основний коментар",
        "description": "Основний текстовий коментар, який буде збережено разом з операцією.",
        "group": "Додаткові",
        "example": ""
    },
    "fromkas": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Каса-джерело",
        "description": "Поле «Каса-джерело» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "nn": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Номер накладної",
        "description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
        "group": "Основні",
        "example": "ПН-1001"
    },
    "post": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Постачальник",
        "description": "Поле «Постачальник» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "sum": {
        "type": "string",
        "max": 4096,
        "title": "Сума",
        "description": "Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.",
        "group": "Суми та кількості",
        "format": "decimal-string",
        "unit": "currency-of-operation",
        "example": "100.00"
    }
}

Результат

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

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-finance-pay-supplier-invoice-0001

{
    "method": "finance.pay_supplier_invoice",
    "params": {
        "nn": "ПН-1001",
        "post": "Тестовий постачальник",
        "sum": "Приклад"
    },
    "id": "example-finance-pay-supplier-invoice"
}

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

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

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

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

finance.supplier_debt_moveЗбільшує або зменшує заборгованість перед постачальником. запис finance.write з 0.4.0

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

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

Параметри params

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

Основний текстовий коментар, який буде збережено разом з операцією.

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

Додатковий коментар операції; використовуйте лише коли він потрібний відповідному сценарію Windows.

string
необов’язковийПриклад: ""За замовчуванням: ""
fromkasКаса-джерело

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

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

Номер службового, касового або фіскального документа у відповідному журналі.

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

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

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

Текстова назва або код виду документа, який зберігається у касовій операції.

string
необов’язковийПриклад: ""За замовчуванням: ""
Суми та кількості
sumСума

Грошова сума як десятковий JSON-рядок без пробілів і символу валюти.

string · decimal-string · currency-of-operation
необов’язковийПриклад: "100.00"
Точна схема параметрів 
{
    "com1": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Основний коментар",
        "description": "Основний текстовий коментар, який буде збережено разом з операцією.",
        "group": "Додаткові",
        "example": ""
    },
    "com2": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Додатковий коментар",
        "description": "Додатковий коментар операції; використовуйте лише коли він потрібний відповідному сценарію Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "fromkas": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Каса-джерело",
        "description": "Поле «Каса-джерело» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": ""
    },
    "ndoc": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Номер документа",
        "description": "Номер службового, касового або фіскального документа у відповідному журналі.",
        "group": "Додаткові",
        "example": ""
    },
    "post": {
        "type": "string",
        "max": 4096,
        "default": "",
        "title": "Постачальник",
        "description": "Поле «Постачальник» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "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": ""
    }
}

Результат

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

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

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-finance-supplier-debt-move-0001

{
    "method": "finance.supplier_debt_move",
    "params": {
        "post": "Тестовий постачальник",
        "sum": "Приклад",
        "ndoc": "Приклад"
    },
    "id": "example-finance-supplier-debt-move"
}

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

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

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