Накладні
Створення, редагування, імпорт, проведення та податкові реквізити накладних.
Idempotency-Key для кожної окремої бізнес-операції.
Як сформувати ключ і повторювати запит.
Накладні
nakl.add_linesДодає до накладної набір товарних позицій.
запис
inventory.write
з 0.4.0
Додає до накладної набір товарних позицій.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
default_quantКількість за замовчуванням | Кількість, яку буде використано для кожного доданого товару, якщо upstream не визначить її інакше. | string | необов’язковийПриклад: "0"За замовчуванням: "0" |
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
| Колекції | |||
codesКоди товарів | Масив кодів товарів. Порядок елементів зберігається під час передавання до операції. | array<string> | обов’язковийПриклад: [] |
Точна схема параметрів
{
"default_quant": {
"type": "string",
"max": 512,
"default": "0",
"title": "Кількість за замовчуванням",
"description": "Кількість, яку буде використано для кожного доданого товару, якщо upstream не визначить її інакше.",
"group": "Додаткові",
"example": "0"
},
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
},
"codes": {
"type": "array",
"required": true,
"min_items": 1,
"max_items": 300,
"unique": true,
"items": {
"type": "string",
"required": true,
"max": 190,
"pattern": "/^[^\\x00-\\x1F\\x7F]{1,190}$/uD",
"title": "Codes item",
"description": "Поле «Codes item» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
},
"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-nakl-add-lines-0001
{
"method": "nakl.add_lines",
"params": {
"nn": "ПН-1001",
"codes": [
"1001",
"1002"
]
},
"id": "example-nakl-add-lines"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.add_lines",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "add_lines",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-add-lines"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.adjust_prices_percentЗмінює ціни товарних позицій накладної на заданий відсоток.
запис
inventory.write
з 0.4.0
Змінює ціни товарних позицій накладної на заданий відсоток.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
| Суми та кількості | |||
percentВідсоток | Точне числове значення «Відсоток» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. | string · decimal-string · percent | необов’язковийПриклад: "100.00"За замовчуванням: "0" |
Точна схема параметрів
{
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
},
"percent": {
"type": "string",
"max": 512,
"default": "0",
"title": "Відсоток",
"description": "Точне числове значення «Відсоток» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "percent",
"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-nakl-adjust-prices-percent-0001
{
"method": "nakl.adjust_prices_percent",
"params": {
"nn": "ПН-1001"
},
"id": "example-nakl-adjust-prices-percent"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.adjust_prices_percent",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "adjust_prices_percent",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-adjust-prices-percent"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.cancel_empty_lineСкасовує незавершене додавання порожнього рядка до накладної.
запис
inventory.write
з 0.4.0
Скасовує незавершене додавання порожнього рядка до накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeКод запису | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | обов’язковийПриклад: "1001" |
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"required": true,
"title": "Код запису",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
}
}
Результат
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-nakl-cancel-empty-line-0001
{
"method": "nakl.cancel_empty_line",
"params": {
"code": "1001",
"nn": "ПН-1001"
},
"id": "example-nakl-cancel-empty-line"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.cancel_empty_line",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "cancel_empty_line",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-cancel-empty-line"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.cash_debtПовертає суму заборгованості, пов’язану з накладною та касою.
читання
inventory.read
з 0.4.0
Повертає суму заборгованості, пов’язану з накладною та касою.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
is_contragОперація з контрагентом | Визначає, чи застосовувати параметр «Операція з контрагентом». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: false |
kasКасовий рахунок | Поле «Касовий рахунок» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "Общая касса"За замовчуванням: "Общая касса" |
postПостачальник | Поле «Постачальник» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
Точна схема параметрів
{
"is_contrag": {
"type": "bool",
"default": false,
"title": "Операція з контрагентом",
"description": "Визначає, чи застосовувати параметр «Операція з контрагентом». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
},
"kas": {
"type": "string",
"max": 512,
"default": "Общая касса",
"title": "Касовий рахунок",
"description": "Поле «Касовий рахунок» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Общая касса"
},
"post": {
"type": "string",
"max": 4096,
"default": "",
"title": "Постачальник",
"description": "Поле «Постачальник» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
cash_balanceЗалишок у касі | Точне повернене значення «Залишок у касі» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
debt_balanceDebt balance | Точне повернене значення «Debt balance» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"cash_balance",
"debt_balance"
],
"field_specs": {
"cash_balance": {
"title": "Залишок у касі",
"description": "Точне повернене значення «Залишок у касі» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"debt_balance": {
"title": "Debt balance",
"description": "Точне повернене значення «Debt 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
{
"method": "nakl.cash_debt",
"params": {
"is_contrag": true,
"kas": "Касове місце N1",
"post": "Тестовий постачальник"
},
"id": "example-nakl-cash-debt"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.cash_debt",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "cash_debt",
"value": "1"
},
"rows": [
{
"cash_balance": "100.00",
"debt_balance": "100.00"
}
]
},
"id": "example-nakl-cash-debt"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
nakl.clearОчищає вміст накладної без видалення її заголовка.
запис
inventory.write
з 0.4.0
Очищає вміст накладної без видалення її заголовка.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
}
}
Результат
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-nakl-clear-0001
{
"method": "nakl.clear",
"params": {
"nn": "ПН-1001"
},
"id": "example-nakl-clear"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.clear",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "clear",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-clear"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.createСтворює нову накладну та автоматично присвоює їй номер.
запис
inventory.write
з 0.4.0
Створює нову накладну та автоматично присвоює їй номер.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Дати й час | |||
cdatДата документа | Дата створюваного або редагованого документа у форматі YYYY-MM-DD. | string · date | необов’язковийПриклад: "2026-07-23"За замовчуванням: "" |
inv_timeЧас інвентаризації | Час «Час інвентаризації» у форматі HH:MM:SS. | string · time | необов’язковийПриклад: "12:00:00"За замовчуванням: "" |
pay_dateДата оплати | Дата «Дата оплати» у календарному форматі YYYY-MM-DD. | string · date | необов’язковийПриклад: "2026-07-23"За замовчуванням: "" |
| Додаткові | |||
contragКонтрагент | Поле «Контрагент» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
copy_from_nnНомер документа-джерела | Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "ПН-1001"За замовчуванням: "" |
currencyВалюта | Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "UAH"За замовчуванням: "" |
expЕкспедиція | Поле «Експедиція» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
from_storeСклад-джерело | Поле «Склад-джерело» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
inv_typeТип інвентаризації | Поле «Тип інвентаризації» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
postПостачальник | Поле «Постачальник» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
reasonПричина операції | Поле «Причина операції» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
to_storeСклад-призначення | Поле «Склад-призначення» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
vnumЗовнішній номер документа | Поле «Зовнішній номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
| Фіскалізація | |||
fiscalФіскальна ознака | Визначає, чи застосовувати параметр «Фіскальна ознака». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: false |
| Суми та кількості | |||
kursКурс валюти | Курс валюти як десятковий рядок. Для гривні зазвичай передається 1.0000. | string · decimal-string · ratio | необов’язковийПриклад: "100.00"За замовчуванням: "0" |
pay_sumСума оплати | Точне числове значення «Сума оплати» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. | string · decimal-string · currency-of-operation | необов’язковийПриклад: "100.00" |
psumЗагальна сума документа | Точне числове значення «Загальна сума документа» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. | string · decimal-string · currency-of-operation | необов’язковийПриклад: "100.00"За замовчуванням: "0" |
| Основні | |||
typeТип накладної | Код виду документа або режиму. Розшифрування кожного допустимого значення наведено нижче.
| enum | обов’язковийПриклад: "PN" |
| Колекції | |||
linesПозиції документа | Позиції, які треба додати до документа. Формат елемента наведено в схемі нижче. | array<string> | необов’язковийПриклад: [] |
Точна схема параметрів
{
"cdat": {
"type": "string",
"max": 4096,
"default": "",
"title": "Дата документа",
"description": "Дата створюваного або редагованого документа у форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
},
"contrag": {
"type": "string",
"max": 512,
"default": "",
"title": "Контрагент",
"description": "Поле «Контрагент» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"copy_from_nn": {
"type": "string",
"max": 512,
"default": "",
"title": "Номер документа-джерела",
"description": "Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "ПН-1001"
},
"currency": {
"type": "string",
"max": 4096,
"default": "",
"title": "Валюта",
"description": "Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "UAH"
},
"exp": {
"type": "string",
"max": 4096,
"default": "",
"title": "Експедиція",
"description": "Поле «Експедиція» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"fiscal": {
"type": "bool",
"default": false,
"title": "Фіскальна ознака",
"description": "Визначає, чи застосовувати параметр «Фіскальна ознака». Передавайте JSON true або false.",
"group": "Фіскалізація",
"example": false
},
"from_store": {
"type": "string",
"max": 4096,
"default": "",
"title": "Склад-джерело",
"description": "Поле «Склад-джерело» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"inv_time": {
"type": "string",
"max": 512,
"default": "",
"title": "Час інвентаризації",
"description": "Час «Час інвентаризації» у форматі HH:MM:SS.",
"group": "Дати й час",
"format": "time",
"example": "12:00:00"
},
"inv_type": {
"type": "string",
"max": 512,
"default": "",
"title": "Тип інвентаризації",
"description": "Поле «Тип інвентаризації» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"kurs": {
"type": "string",
"max": 4096,
"default": "0",
"title": "Курс валюти",
"description": "Курс валюти як десятковий рядок. Для гривні зазвичай передається 1.0000.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "ratio",
"example": "100.00"
},
"pay_date": {
"type": "string",
"max": 512,
"default": "",
"title": "Дата оплати",
"description": "Дата «Дата оплати» у календарному форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
},
"pay_sum": {
"type": "string",
"max": 4096,
"title": "Сума оплати",
"description": "Точне числове значення «Сума оплати» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"post": {
"type": "string",
"max": 4096,
"default": "",
"title": "Постачальник",
"description": "Поле «Постачальник» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"psum": {
"type": "string",
"max": 4096,
"default": "0",
"title": "Загальна сума документа",
"description": "Точне числове значення «Загальна сума документа» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"reason": {
"type": "string",
"max": 4096,
"default": "",
"title": "Причина операції",
"description": "Поле «Причина операції» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"to_store": {
"type": "string",
"max": 4096,
"default": "",
"title": "Склад-призначення",
"description": "Поле «Склад-призначення» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"type": {
"type": "enum",
"required": true,
"values": [
"PN",
"RN",
"VN",
"SN",
"IV",
"MN"
],
"title": "Тип накладної",
"description": "Код виду документа або режиму. Розшифрування кожного допустимого значення наведено нижче.",
"group": "Основні",
"example": "PN",
"enum_labels": {
"PN": "прибуткова накладна",
"RN": "видаткова накладна",
"VN": "повернення постачальнику",
"SN": "списання",
"IV": "інвентаризація",
"MN": "переміщення між складами"
}
},
"vnum": {
"type": "string",
"max": 4096,
"default": "",
"title": "Зовнішній номер документа",
"description": "Поле «Зовнішній номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"lines": {
"type": "array",
"required": false,
"min_items": 0,
"max_items": 300,
"unique": true,
"items": {
"type": "string",
"required": true,
"max": 190,
"pattern": "/^[^\\x00-\\x1F\\x7F]{1,190}$/uD",
"title": "Lines item",
"description": "Поле «Lines item» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
},
"title": "Позиції документа",
"description": "Позиції, які треба додати до документа. Формат елемента наведено в схемі нижче.",
"group": "Колекції",
"example": []
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
document_numberНомер документа | Номер документа у базі поточного клієнта. | string | "ПН-1001" |
Точна схема результату
{
"mode": "rows",
"columns": [
"document_number"
],
"field_specs": {
"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-nakl-create-0001
{
"method": "nakl.create",
"params": {
"type": "PN",
"post": "Тестовий постачальник",
"cdat": "2026-07-23",
"currency": "UAH",
"kurs": "1.0000",
"lines": [
"1001",
"1002"
]
},
"id": "example-nakl-create"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.create",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "create",
"value": "1"
},
"rows": [
{
"document_number": "ПН-1001"
}
]
},
"id": "example-nakl-create"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.delete_emptyВидаляє порожню накладну, у якій немає товарних позицій.
запис
inventory.write
з 0.4.0
Видаляє порожню накладну, у якій немає товарних позицій.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
}
}
Результат
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-nakl-delete-empty-0001
{
"method": "nakl.delete_empty",
"params": {
"nn": "ПН-1001"
},
"id": "example-nakl-delete-empty"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.delete_empty",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "delete_empty",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-delete-empty"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.delete_linesВидаляє вибрані товарні позиції з накладної.
запис
inventory.write
з 0.4.0
Видаляє вибрані товарні позиції з накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
| Колекції | |||
codesКоди товарів | Масив кодів товарів. Порядок елементів зберігається під час передавання до операції. | array<string> | обов’язковийПриклад: [] |
Точна схема параметрів
{
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
},
"codes": {
"type": "array",
"required": true,
"min_items": 1,
"max_items": 300,
"unique": true,
"items": {
"type": "string",
"required": true,
"max": 190,
"pattern": "/^[^\\x00-\\x1F\\x7F]{1,190}$/uD",
"title": "Codes item",
"description": "Поле «Codes item» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
},
"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-nakl-delete-lines-0001
{
"method": "nakl.delete_lines",
"params": {
"nn": "ПН-1001",
"codes": [
"Приклад"
]
},
"id": "example-nakl-delete-lines"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.delete_lines",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "delete_lines",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-delete-lines"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.headerПовертає заголовок, тип, дати та контрагента накладної.
читання
inventory.read
з 0.4.0
Повертає заголовок, тип, дати та контрагента накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
created_atДата й час створення | Повернені дата й час «Дата й час створення» у форматі ISO 8601. | string · date-time | "2026-07-23T12:00:00+03:00" |
posted_atPosted at | Повернена дата «Posted at» у форматі YYYY-MM-DD. | string · date | "2026-07-23" |
created_userCreated user | Повернене значення «Created user» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
posted_userPosted user | Повернене значення «Posted user» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
side_nameНазва сторони документа | Повернене значення «Назва сторони документа» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
statusСтатус | Повернене значення «Статус» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
external_numberExternal number | Повернене значення «External number» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
declared_sumDeclared sum | Точне повернене значення «Declared sum» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
paid_sumPaid sum | Точне повернене значення «Paid sum» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
expeditionExpedition | Повернене значення «Expedition» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
fiscal_sumFiscal sum | Точне повернене значення «Fiscal sum» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
side_detailsSide details | Повернене значення «Side details» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
fiscalФіскальна ознака | Повернене значення «Фіскальна ознака» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
payment_datePayment date | Повернена дата «Payment date» у форматі YYYY-MM-DD. | string · date | "2026-07-23" |
exchange_rateExchange rate | Точне повернене значення «Exchange rate» як десятковий рядок із крапкою. | string · decimal-string · ratio | "100.00" |
currencyВалюта | Повернене значення «Валюта» відповідного запису, документа або підсумку ARM20. | string | "UAH" |
writeoff_reasonWriteoff reason | Повернене значення «Writeoff reason» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
inventory_reasonInventory reason | Повернене значення «Inventory reason» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
inventory_typeInventory type | Повернене значення «Inventory type» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
inventory_timeInventory time | Повернений час «Inventory time» у форматі HH:MM:SS. | string · time | "12:00:00" |
inventory_last_stockInventory last stock | Точне повернене значення «Inventory last stock» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"created_at",
"posted_at",
"created_user",
"posted_user",
"side_name",
"status",
"external_number",
"declared_sum",
"paid_sum",
"expedition",
"fiscal_sum",
"side_details",
"fiscal",
"payment_date",
"exchange_rate",
"currency",
"writeoff_reason",
"inventory_reason",
"inventory_type",
"inventory_time",
"inventory_last_stock"
],
"field_specs": {
"created_at": {
"title": "Дата й час створення",
"description": "Повернені дата й час «Дата й час створення» у форматі ISO 8601.",
"type": "string",
"format": "date-time",
"example": "2026-07-23T12:00:00+03:00"
},
"posted_at": {
"title": "Posted at",
"description": "Повернена дата «Posted at» у форматі YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2026-07-23"
},
"created_user": {
"title": "Created user",
"description": "Повернене значення «Created user» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"posted_user": {
"title": "Posted user",
"description": "Повернене значення «Posted user» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"side_name": {
"title": "Назва сторони документа",
"description": "Повернене значення «Назва сторони документа» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"status": {
"title": "Статус",
"description": "Повернене значення «Статус» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"external_number": {
"title": "External number",
"description": "Повернене значення «External number» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"declared_sum": {
"title": "Declared sum",
"description": "Точне повернене значення «Declared sum» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"paid_sum": {
"title": "Paid sum",
"description": "Точне повернене значення «Paid sum» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"expedition": {
"title": "Expedition",
"description": "Повернене значення «Expedition» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"fiscal_sum": {
"title": "Fiscal sum",
"description": "Точне повернене значення «Fiscal sum» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"side_details": {
"title": "Side details",
"description": "Повернене значення «Side details» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"fiscal": {
"title": "Фіскальна ознака",
"description": "Повернене значення «Фіскальна ознака» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"payment_date": {
"title": "Payment date",
"description": "Повернена дата «Payment date» у форматі YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2026-07-23"
},
"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"
},
"writeoff_reason": {
"title": "Writeoff reason",
"description": "Повернене значення «Writeoff reason» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"inventory_reason": {
"title": "Inventory reason",
"description": "Повернене значення «Inventory reason» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"inventory_type": {
"title": "Inventory type",
"description": "Повернене значення «Inventory type» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"inventory_time": {
"title": "Inventory time",
"description": "Повернений час «Inventory time» у форматі HH:MM:SS.",
"type": "string",
"format": "time",
"example": "12:00:00"
},
"inventory_last_stock": {
"title": "Inventory last stock",
"description": "Точне повернене значення «Inventory last stock» як десятковий рядок із крапкою.",
"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": "nakl.header",
"params": {
"nn": "ПН-1001"
},
"id": "example-nakl-header"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.header",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "header",
"value": "1"
},
"rows": [
{
"created_at": "2026-07-23T12:00:00+03:00",
"posted_at": "2026-07-23",
"created_user": "Приклад",
"posted_user": "Приклад",
"side_name": "Приклад",
"status": "Приклад",
"external_number": "Приклад",
"declared_sum": "100.00",
"paid_sum": "100.00",
"expedition": "Приклад",
"fiscal_sum": "100.00",
"side_details": "Приклад",
"fiscal": "Приклад",
"payment_date": "2026-07-23",
"exchange_rate": "100.00",
"currency": "UAH",
"writeoff_reason": "Приклад",
"inventory_reason": "Приклад",
"inventory_type": "Приклад",
"inventory_time": "12:00:00",
"inventory_last_stock": "100.00"
}
]
},
"id": "example-nakl-header"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
nakl.import_android_tsdІмпортує до накладної позиції, зібрані Android-терміналом.
запис
inventory.write
з 0.4.0
Імпортує до накладної позиції, зібрані Android-терміналом.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
ndocНомер документа | Номер службового, касового або фіскального документа у відповідному журналі. | string | обов’язковийПриклад: "Приклад" |
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"ndoc": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер документа",
"description": "Номер службового, касового або фіскального документа у відповідному журналі.",
"group": "Додаткові",
"example": "Приклад"
},
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
}
}
Результат
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-nakl-import-android-tsd-0001
{
"method": "nakl.import_android_tsd",
"params": {
"ndoc": "Приклад",
"nn": "ПН-1001"
},
"id": "example-nakl-import-android-tsd"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.import_android_tsd",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "import_android_tsd",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-import-android-tsd"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.import_cancelСкасовує поточний сеанс імпорту позицій до накладної.
запис
inventory.write
з 0.4.0
Скасовує поточний сеанс імпорту позицій до накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | необов’язковийПриклад: "ПН-1001"За замовчуванням: "" |
| Додаткові | |||
temp_nnНомер тимчасового документа | Поле «Номер тимчасового документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"nn": {
"type": "string",
"max": 512,
"default": "",
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
},
"temp_nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер тимчасового документа",
"description": "Поле «Номер тимчасового документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "ПН-1001"
}
}
Результат
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-nakl-import-cancel-0001
{
"method": "nakl.import_cancel",
"params": {
"temp_nn": "ПН-1001"
},
"id": "example-nakl-import-cancel"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.import_cancel",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "import_cancel",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-import-cancel"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.import_confirmПідтверджує підготовлений імпорт позицій до накладної.
запис
inventory.write
з 0.4.0
Підтверджує підготовлений імпорт позицій до накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | необов’язковийПриклад: "ПН-1001"За замовчуванням: "" |
| Додаткові | |||
temp_nnНомер тимчасового документа | Поле «Номер тимчасового документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "ПН-1001" |
actionsActions | Список «Actions». Структуру одного елемента, обов’язкові поля та межі кількості наведено нижче. | array<object> | необов’язковийПриклад: [] |
Точна схема параметрів
{
"nn": {
"type": "string",
"max": 512,
"default": "",
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
},
"temp_nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер тимчасового документа",
"description": "Поле «Номер тимчасового документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "ПН-1001"
},
"actions": {
"type": "array",
"required": false,
"min_items": 0,
"max_items": 250,
"items": {
"type": "object",
"fields": {
"code": {
"type": "string",
"required": true,
"max": 190,
"pattern": "/^[^\\x00-\\x1F\\x7F]{1,190}$/uD",
"title": "Код запису",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"decision": {
"type": "enum",
"required": true,
"values": [
"Заменить здесь",
"Заменить в базе"
],
"title": "Спосіб заміни",
"description": "Варіант «Спосіб заміни». Використовуйте лише одне зі значень, розшифрованих нижче.",
"group": "Додаткові",
"example": "Заменить здесь",
"enum_labels": {
"Заменить здесь": "замінити лише у поточній операції",
"Заменить в базе": "замінити та зберегти у базі"
}
}
}
},
"title": "Actions",
"description": "Список «Actions». Структуру одного елемента, обов’язкові поля та межі кількості наведено нижче.",
"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-nakl-import-confirm-0001
{
"method": "nakl.import_confirm",
"params": {
"temp_nn": "ПН-1001"
},
"id": "example-nakl-import-confirm"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.import_confirm",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "import_confirm",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-import-confirm"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.import_main_add_lineДодає до імпорту накладної товар із основного довідника.
запис
inventory.write
з 0.4.0
Додає до імпорту накладної товар із основного довідника.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeКод запису | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | обов’язковийПриклад: "1001" |
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
| Додаткові | |||
currencyВалюта | Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "UAH"За замовчуванням: "" |
from_nnПочатковий номер документа | Поле «Початковий номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "ПН-1001"За замовчуванням: "" |
| Суми та кількості | |||
currency_priceЦіна у валюті | Точне числове значення «Ціна у валюті» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. | string · decimal-string · currency-of-operation | необов’язковийПриклад: "100.00"За замовчуванням: "" |
quantКількість | Кількість товару як десятковий рядок; для вагового товару дозволена дробова частина. | string · decimal-string · product-unit | необов’язковийПриклад: "1.000"За замовчуванням: "0" |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"required": true,
"title": "Код запису",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"currency": {
"type": "string",
"max": 4096,
"default": "",
"title": "Валюта",
"description": "Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "UAH"
},
"currency_price": {
"type": "string",
"max": 4096,
"default": "",
"title": "Ціна у валюті",
"description": "Точне числове значення «Ціна у валюті» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"from_nn": {
"type": "string",
"max": 512,
"default": "",
"title": "Початковий номер документа",
"description": "Поле «Початковий номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "ПН-1001"
},
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
},
"quant": {
"type": "string",
"max": 512,
"default": "0",
"title": "Кількість",
"description": "Кількість товару як десятковий рядок; для вагового товару дозволена дробова частина.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "product-unit",
"example": "1.000"
}
}
Результат
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-nakl-import-main-add-line-0001
{
"method": "nakl.import_main_add_line",
"params": {
"code": "1001",
"nn": "ПН-1001"
},
"id": "example-nakl-import-main-add-line"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.import_main_add_line",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "import_main_add_line",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-import-main-add-line"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.import_prepareГотує тимчасовий набір даних для імпорту до накладної.
запис
inventory.write
з 0.4.0
Готує тимчасовий набір даних для імпорту до накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | необов’язковийПриклад: "ПН-1001"За замовчуванням: "" |
| Колекції | |||
linesПозиції документа | Позиції, які треба додати до документа. Формат елемента наведено в схемі нижче. | array<object> | обов’язковийПриклад: [] |
productsТовари | Список «Товари». Структуру одного елемента, обов’язкові поля та межі кількості наведено нижче. | array<object> | необов’язковийПриклад: [] |
Точна схема параметрів
{
"nn": {
"type": "string",
"max": 512,
"default": "",
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
},
"lines": {
"type": "array",
"required": true,
"min_items": 1,
"max_items": 80,
"items": {
"type": "object",
"fields": {
"code": {
"type": "string",
"required": true,
"max": 190,
"pattern": "/^[^\\x00-\\x1F\\x7F]{1,190}$/uD",
"title": "Код запису",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"name": {
"type": "string",
"required": true,
"max": 512,
"pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]{1,512}$/uD",
"title": "Назва",
"description": "Поле «Назва» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Основні",
"example": "Тестовий товар"
},
"cost": {
"type": "decimal",
"max": 32,
"scale": 8,
"default": "0",
"title": "Собівартість",
"description": "Точне числове значення «Собівартість» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"markup": {
"type": "decimal",
"max": 32,
"scale": 8,
"default": "0",
"title": "Націнка",
"description": "Точне числове значення «Націнка» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "percent",
"example": "100.00"
},
"price": {
"type": "decimal",
"max": 32,
"scale": 8,
"default": "0",
"title": "Ціна",
"description": "Ціна за одиницю товару як десятковий рядок без символу валюти.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"unit_type": {
"type": "int",
"min": 0,
"max": 2147483647,
"default": 0,
"title": "Одиниця виміру",
"description": "Поле «Одиниця виміру» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"quantity": {
"type": "decimal",
"max": 32,
"scale": 8,
"default": "0",
"title": "Кількість",
"description": "Кількість товару як десятковий рядок; одиниця залежить від картки товару.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "product-unit",
"example": "1.000"
},
"shelf_life_days": {
"type": "int",
"min": 0,
"max": 36500,
"default": 0,
"title": "Строк придатності, днів",
"description": "Поле «Строк придатності, днів» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"category_id": {
"type": "int",
"min": 0,
"max": 2147483647,
"default": 0,
"title": "Ідентифікатор категорії",
"description": "Ідентифікатор «Ідентифікатор категорії», отриманий із результату відповідного методу читання цієї бази.",
"group": "Додаткові",
"example": 1
},
"no_discount": {
"type": "bool",
"default": false,
"title": "Заборонити знижку",
"description": "Визначає, чи застосовувати параметр «Заборонити знижку». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
},
"source_document": {
"type": "string",
"max": 512,
"pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$/uD",
"default": "",
"title": "Документ-джерело",
"description": "Поле «Документ-джерело» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"inventory_quantity": {
"type": "decimal",
"max": 32,
"scale": 8,
"default": "0",
"title": "Кількість за інвентаризацією",
"description": "Точне числове значення «Кількість за інвентаризацією» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "product-unit",
"example": "100.00"
}
}
},
"title": "Позиції документа",
"description": "Позиції, які треба додати до документа. Формат елемента наведено в схемі нижче.",
"group": "Колекції",
"example": []
},
"products": {
"type": "array",
"required": false,
"min_items": 0,
"max_items": 80,
"items": {
"type": "object",
"fields": {
"code": {
"type": "string",
"required": true,
"max": 190,
"pattern": "/^[^\\x00-\\x1F\\x7F]{1,190}$/uD",
"title": "Код запису",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"name": {
"type": "string",
"required": true,
"max": 512,
"pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]{1,512}$/uD",
"title": "Назва",
"description": "Поле «Назва» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Основні",
"example": "Тестовий товар"
},
"cost": {
"type": "decimal",
"max": 32,
"scale": 8,
"default": "0",
"title": "Собівартість",
"description": "Точне числове значення «Собівартість» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"markup": {
"type": "decimal",
"max": 32,
"scale": 8,
"default": "0",
"title": "Націнка",
"description": "Точне числове значення «Націнка» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "percent",
"example": "100.00"
},
"price": {
"type": "decimal",
"max": 32,
"scale": 8,
"default": "0",
"title": "Ціна",
"description": "Ціна за одиницю товару як десятковий рядок без символу валюти.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"unit_type": {
"type": "int",
"min": 0,
"max": 2147483647,
"default": 0,
"title": "Одиниця виміру",
"description": "Поле «Одиниця виміру» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"quantity": {
"type": "decimal",
"max": 32,
"scale": 8,
"default": "0",
"title": "Кількість",
"description": "Кількість товару як десятковий рядок; одиниця залежить від картки товару.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "product-unit",
"example": "1.000"
},
"date_added": {
"type": "string",
"max": 30,
"pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$/uD",
"default": "",
"title": "Дата додавання",
"description": "Дата «Дата додавання» у календарному форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
},
"shelf_life_days": {
"type": "int",
"min": 0,
"max": 36500,
"default": 0,
"title": "Строк придатності, днів",
"description": "Поле «Строк придатності, днів» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"supplier": {
"type": "string",
"max": 512,
"pattern": "/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$/uD",
"default": "",
"title": "Постачальник",
"description": "Поле «Постачальник» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"critical_quantity": {
"type": "decimal",
"max": 32,
"scale": 8,
"default": "0",
"title": "Критичний залишок",
"description": "Точне числове значення «Критичний залишок» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "product-unit",
"example": "100.00"
},
"category_id": {
"type": "int",
"min": 0,
"max": 2147483647,
"default": 0,
"title": "Ідентифікатор категорії",
"description": "Ідентифікатор «Ідентифікатор категорії», отриманий із результату відповідного методу читання цієї бази.",
"group": "Додаткові",
"example": 1
},
"no_discount": {
"type": "bool",
"default": false,
"title": "Заборонити знижку",
"description": "Визначає, чи застосовувати параметр «Заборонити знижку». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
},
"c2": {
"type": "int",
"min": 0,
"max": 2147483647,
"default": 0,
"title": "C2",
"description": "Поле «C2» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
},
"additional_info": {
"type": "int",
"min": 0,
"max": 2147483647,
"default": 0,
"title": "Додаткова інформація",
"description": "Поле «Додаткова інформація» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": 1
}
}
},
"title": "Товари",
"description": "Список «Товари». Структуру одного елемента, обов’язкові поля та межі кількості наведено нижче.",
"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
Idempotency-Key: example-nakl-import-prepare-0001
{
"method": "nakl.import_prepare",
"params": {
"lines": [
{
"code": "1001",
"name": "Тестовий товар",
"cost": "10.00",
"markup": "20.00",
"price": "12.00",
"quantity": "1.000"
}
]
},
"id": "example-nakl-import-prepare"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.import_prepare",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "import_prepare",
"value": "Приклад"
},
"rows": []
},
"id": "example-nakl-import-prepare"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.import_quantitiesПереносить імпортовані кількості до підготовлених позицій накладної.
запис
inventory.write
з 0.4.0
Переносить імпортовані кількості до підготовлених позицій накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
| Колекції | |||
rowsРядки операції | Структурований масив рядків. Невідомі поля та порушення схеми відхиляються gateway. | array<object> | обов’язковийПриклад: [] |
Точна схема параметрів
{
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
},
"rows": {
"type": "array",
"required": true,
"min_items": 1,
"max_items": 250,
"items": {
"type": "object",
"fields": {
"code": {
"type": "string",
"required": true,
"max": 190,
"pattern": "/^[^\\x00-\\x1F\\x7F]{1,190}$/uD",
"title": "Код запису",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"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": "Структурований масив рядків. Невідомі поля та порушення схеми відхиляються gateway.",
"group": "Колекції",
"example": []
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
missing_codeMissing code | Повернене значення «Missing code» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"missing_code"
],
"field_specs": {
"missing_code": {
"title": "Missing code",
"description": "Повернене значення «Missing code» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-nakl-import-quantities-0001
{
"method": "nakl.import_quantities",
"params": {
"nn": "ІВ-1001",
"rows": [
{
"code": "1001",
"quantity": "1.250"
}
]
},
"id": "example-nakl-import-quantities"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.import_quantities",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "import_quantities",
"value": "1"
},
"rows": [
{
"missing_code": "Приклад"
}
]
},
"id": "example-nakl-import-quantities"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.import_temp_to_docПереносить підготовлені тимчасові позиції до накладної.
запис
inventory.write
з 0.4.0
Переносить підготовлені тимчасові позиції до накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
| Додаткові | |||
temp_nnНомер тимчасового документа | Поле «Номер тимчасового документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
},
"temp_nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер тимчасового документа",
"description": "Поле «Номер тимчасового документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "ПН-1001"
}
}
Результат
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-nakl-import-temp-to-doc-0001
{
"method": "nakl.import_temp_to_doc",
"params": {
"nn": "ПН-1001",
"temp_nn": "ПН-1001"
},
"id": "example-nakl-import-temp-to-doc"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.import_temp_to_doc",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "import_temp_to_doc",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-import-temp-to-doc"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.line_for_editПовертає та блокує товарну позицію накладної для редагування.
запис
inventory.write
з 0.4.0
Повертає та блокує товарну позицію накладної для редагування.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeКод запису | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | обов’язковийПриклад: "1001" |
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"required": true,
"title": "Код запису",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
costСобівартість | Точне повернене значення «Собівартість» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
markupНацінка | Точне повернене значення «Націнка» як десятковий рядок із крапкою. | string · decimal-string · percent | "100.00" |
priceЦіна | Точне повернене значення «Ціна» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
quantityКількість | Точне повернене значення «Кількість» як десятковий рядок із крапкою. | string · decimal-string · product-unit | "1.000" |
nameНазва | Повернене значення «Назва» відповідного запису, документа або підсумку ARM20. | string | "Тестовий товар" |
Точна схема результату
{
"mode": "rows",
"columns": [
"cost",
"markup",
"price",
"quantity",
"name"
],
"field_specs": {
"cost": {
"title": "Собівартість",
"description": "Точне повернене значення «Собівартість» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"markup": {
"title": "Націнка",
"description": "Точне повернене значення «Націнка» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "percent",
"example": "100.00"
},
"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"
},
"name": {
"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-nakl-line-for-edit-0001
{
"method": "nakl.line_for_edit",
"params": {
"code": "1001",
"nn": "ПН-1001"
},
"id": "example-nakl-line-for-edit"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.line_for_edit",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "line_for_edit",
"value": "1"
},
"rows": [
{
"cost": "100.00",
"markup": "100.00",
"price": "100.00",
"quantity": "1.000",
"name": "Тестовий товар"
}
]
},
"id": "example-nakl-line-for-edit"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.move_shortageПовертає позиції накладної, для яких бракує залишку.
читання
inventory.read
з 0.4.0
Повертає позиції накладної, для яких бракує залишку.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
codeКод запису | Повернене значення «Код запису» відповідного запису, документа або підсумку ARM20. | string | "1001" |
shortageShortage | Точне повернене значення «Shortage» як десятковий рядок із крапкою. | string · decimal-string · product-unit | "100.00" |
Точна схема результату
{
"mode": "rows",
"columns": [
"code",
"shortage"
],
"field_specs": {
"code": {
"title": "Код запису",
"description": "Повернене значення «Код запису» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "1001"
},
"shortage": {
"title": "Shortage",
"description": "Точне повернене значення «Shortage» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "product-unit",
"example": "100.00"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "nakl.move_shortage",
"params": {
"nn": "ПН-1001"
},
"id": "example-nakl-move-shortage"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.move_shortage",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "move_shortage",
"value": "1"
},
"rows": [
{
"code": "1001",
"shortage": "100.00"
}
]
},
"id": "example-nakl-move-shortage"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
nakl.postПроводить накладну та застосовує її зміни до обліку товарів і розрахунків.
запис
inventory.write
з 0.4.0
Проводить накладну та застосовує її зміни до обліку товарів і розрахунків.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
allow_minusДозволити від’ємний залишок | Визначає, чи застосовувати параметр «Дозволити від’ємний залишок». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: false |
cost_modeРежим перерахунку собівартості | Варіант «Режим перерахунку собівартості». Використовуйте лише одне зі значень, розшифрованих нижче.
| enum | необов’язковийПриклад: "no_update"За замовчуванням: "no_update" |
expedЕкспедиція | Поле «Експедиція» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "Приклад" |
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
| Оплата | |||
payment_modeРежим оплати | Варіант «Режим оплати». Використовуйте лише одне зі значень, розшифрованих нижче.
| enum | необов’язковийПриклад: "cash_out"За замовчуванням: "no_payment" |
| Суми та кількості | |||
payment_sumСума оплати | Точне числове значення «Сума оплати» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. | string · decimal-string · currency-of-operation | необов’язковийПриклад: "100.00"За замовчуванням: "" |
Точна схема параметрів
{
"allow_minus": {
"type": "bool",
"default": false,
"title": "Дозволити від’ємний залишок",
"description": "Визначає, чи застосовувати параметр «Дозволити від’ємний залишок». Передавайте JSON true або false.",
"group": "Додаткові",
"example": false
},
"cost_mode": {
"type": "enum",
"values": [
"no_update",
"average",
"as_doc"
],
"default": "no_update",
"title": "Режим перерахунку собівартості",
"description": "Варіант «Режим перерахунку собівартості». Використовуйте лише одне зі значень, розшифрованих нижче.",
"group": "Додаткові",
"example": "no_update",
"enum_labels": {
"no_update": "не змінювати собівартість",
"average": "розрахувати середню собівартість",
"as_doc": "взяти собівартість із документа"
}
},
"exped": {
"type": "string",
"max": 4096,
"title": "Експедиція",
"description": "Поле «Експедиція» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
},
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
},
"payment_mode": {
"type": "enum",
"values": [
"cash_out",
"supplier_debt",
"cash_in",
"cashless_in",
"contrag_debt",
"pay_supplier_debt",
"no_payment"
],
"default": "no_payment",
"title": "Режим оплати",
"description": "Варіант «Режим оплати». Використовуйте лише одне зі значень, розшифрованих нижче.",
"group": "Оплата",
"example": "cash_out",
"enum_labels": {
"cash_out": "вилучення готівки",
"supplier_debt": "борг постачальнику",
"cash_in": "внесення готівки",
"cashless_in": "безготівкове надходження",
"contrag_debt": "борг контрагента",
"pay_supplier_debt": "погашення боргу постачальнику",
"no_payment": "без реєстрації оплати"
}
},
"payment_sum": {
"type": "string",
"max": 512,
"default": "",
"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-nakl-post-0001
{
"method": "nakl.post",
"params": {
"nn": "ПН-1001"
},
"id": "example-nakl-post"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.post",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "post",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-post"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.price_diffПовертає різницю між поточними цінами та цінами в накладній.
читання
inventory.read
з 0.4.0
Повертає різницю між поточними цінами та цінами в накладній.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
codeКод запису | Повернене значення «Код запису» відповідного запису, документа або підсумку ARM20. | string | "1001" |
nameНазва | Повернене значення «Назва» відповідного запису, документа або підсумку ARM20. | string | "Тестовий товар" |
document_priceDocument price | Точне повернене значення «Document price» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
main_priceMain price | Точне повернене значення «Main price» як десятковий рядок із крапкою. | string · decimal-string · currency-of-operation | "100.00" |
document_quantityDocument quantity | Точне повернене значення «Document quantity» як десятковий рядок із крапкою. | string · decimal-string · product-unit | "100.00" |
main_quantityMain quantity | Точне повернене значення «Main quantity» як десятковий рядок із крапкою. | string · decimal-string · product-unit | "100.00" |
unit_typeОдиниця виміру | Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"code",
"name",
"document_price",
"main_price",
"document_quantity",
"main_quantity",
"unit_type"
],
"field_specs": {
"code": {
"title": "Код запису",
"description": "Повернене значення «Код запису» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "1001"
},
"name": {
"title": "Назва",
"description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Тестовий товар"
},
"document_price": {
"title": "Document price",
"description": "Точне повернене значення «Document price» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"main_price": {
"title": "Main price",
"description": "Точне повернене значення «Main price» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"document_quantity": {
"title": "Document quantity",
"description": "Точне повернене значення «Document quantity» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "product-unit",
"example": "100.00"
},
"main_quantity": {
"title": "Main quantity",
"description": "Точне повернене значення «Main quantity» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "product-unit",
"example": "100.00"
},
"unit_type": {
"title": "Одиниця виміру",
"description": "Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "nakl.price_diff",
"params": {
"nn": "ПН-1001"
},
"id": "example-nakl-price-diff"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.price_diff",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "price_diff",
"value": "1"
},
"rows": [
{
"code": "1001",
"name": "Тестовий товар",
"document_price": "100.00",
"main_price": "100.00",
"document_quantity": "100.00",
"main_quantity": "100.00",
"unit_type": "Приклад"
}
]
},
"id": "example-nakl-price-diff"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
nakl.renew_inventory_restПерераховує облікові залишки після інвентаризаційної накладної.
запис
inventory.write
з 0.4.0
Перераховує облікові залишки після інвентаризаційної накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
}
}
Результат
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-nakl-renew-inventory-rest-0001
{
"method": "nakl.renew_inventory_rest",
"params": {
"nn": "ПН-1001"
},
"id": "example-nakl-renew-inventory-rest"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.renew_inventory_rest",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "renew_inventory_rest",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-renew-inventory-rest"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.save_lineСтворює або оновлює одну товарну позицію накладної.
запис
inventory.write
з 0.4.0
Створює або оновлює одну товарну позицію накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
codeКод запису | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | обов’язковийПриклад: "1001" |
modeРежим операції | Вибирає один із підтримуваних сценаріїв операції. Значення та їх зміст наведено у списку варіантів.
| enum | необов’язковийПриклад: "set"За замовчуванням: "set" |
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
| Додаткові | |||
currencyВалюта | Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "UAH"За замовчуванням: "" |
| Суми та кількості | |||
kursКурс валюти | Курс валюти як десятковий рядок. Для гривні зазвичай передається 1.0000. | string · decimal-string · ratio | необов’язковийПриклад: "100.00"За замовчуванням: "0" |
nacНацінка | Точне числове значення «Націнка» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. | string · decimal-string · percent | необов’язковийПриклад: "100.00"За замовчуванням: "0" |
priceЦіна | Ціна за одиницю товару як десятковий рядок без символу валюти. | string · decimal-string · currency-of-operation | необов’язковийПриклад: "100.00"За замовчуванням: "0" |
quantКількість | Кількість товару як десятковий рядок; для вагового товару дозволена дробова частина. | string · decimal-string · product-unit | необов’язковийПриклад: "1.000"За замовчуванням: "0" |
ssСобівартість | Точне числове значення «Собівартість» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. | string · decimal-string · currency-of-operation | необов’язковийПриклад: "100.00"За замовчуванням: "0" |
Точна схема параметрів
{
"code": {
"type": "string",
"max": 512,
"required": true,
"title": "Код запису",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"currency": {
"type": "string",
"max": 4096,
"default": "",
"title": "Валюта",
"description": "Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "UAH"
},
"kurs": {
"type": "string",
"max": 4096,
"default": "0",
"title": "Курс валюти",
"description": "Курс валюти як десятковий рядок. Для гривні зазвичай передається 1.0000.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "ratio",
"example": "100.00"
},
"mode": {
"type": "enum",
"values": [
"set",
"add",
"delete"
],
"default": "set",
"title": "Режим операції",
"description": "Вибирає один із підтримуваних сценаріїв операції. Значення та їх зміст наведено у списку варіантів.",
"group": "Основні",
"example": "set",
"enum_labels": {
"set": "встановити значення",
"add": "додати новий запис",
"delete": "видалити запис"
}
},
"nac": {
"type": "string",
"max": 4096,
"default": "0",
"title": "Націнка",
"description": "Точне числове значення «Націнка» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "percent",
"example": "100.00"
},
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
},
"price": {
"type": "string",
"max": 4096,
"default": "0",
"title": "Ціна",
"description": "Ціна за одиницю товару як десятковий рядок без символу валюти.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"quant": {
"type": "string",
"max": 512,
"default": "0",
"title": "Кількість",
"description": "Кількість товару як десятковий рядок; для вагового товару дозволена дробова частина.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "product-unit",
"example": "1.000"
},
"ss": {
"type": "string",
"max": 4096,
"default": "0",
"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-nakl-save-line-0001
{
"method": "nakl.save_line",
"params": {
"code": "1001",
"nn": "ПН-1001"
},
"id": "example-nakl-save-line"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.save_line",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "save_line",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-save-line"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.scan_add_oneДодає одну одиницю відсканованого товару до накладної.
запис
inventory.write
з 0.4.0
Додає одну одиницю відсканованого товару до накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
allow_alphaДозволити літерний код | Якщо true, пошук приймає коди, що містять літери. | bool | необов’язковийПриклад: falseЗа замовчуванням: false |
currencyВалюта | Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "UAH"За замовчуванням: "" |
pref_discПрефікс дисконтної картки | Префікс, за яким відсканований код розпізнається як дисконтна картка. | string | необов’язковийПриклад: ""За замовчуванням: "" |
pref_vesПрефікс вагового штрихкоду | Префікс, за яким штрихкод розпізнається як ваговий. | string | необов’язковийПриклад: ""За замовчуванням: "" |
| Основні | |||
codeКод запису | Публічний код товару, картки або іншого запису, як він відображається у програмі. | string | обов’язковийПриклад: "1001" |
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
| Суми та кількості | |||
kursКурс валюти | Курс валюти як десятковий рядок. Для гривні зазвичай передається 1.0000. | string · decimal-string · ratio | необов’язковийПриклад: "100.00"За замовчуванням: "0" |
Точна схема параметрів
{
"allow_alpha": {
"type": "bool",
"default": false,
"title": "Дозволити літерний код",
"description": "Якщо true, пошук приймає коди, що містять літери.",
"group": "Додаткові",
"example": false
},
"code": {
"type": "string",
"max": 512,
"required": true,
"title": "Код запису",
"description": "Публічний код товару, картки або іншого запису, як він відображається у програмі.",
"group": "Основні",
"example": "1001"
},
"currency": {
"type": "string",
"max": 4096,
"default": "",
"title": "Валюта",
"description": "Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "UAH"
},
"kurs": {
"type": "string",
"max": 4096,
"default": "0",
"title": "Курс валюти",
"description": "Курс валюти як десятковий рядок. Для гривні зазвичай передається 1.0000.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "ratio",
"example": "100.00"
},
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
},
"pref_disc": {
"type": "string",
"max": 4096,
"default": "",
"title": "Префікс дисконтної картки",
"description": "Префікс, за яким відсканований код розпізнається як дисконтна картка.",
"group": "Додаткові",
"example": ""
},
"pref_ves": {
"type": "string",
"max": 4096,
"default": "",
"title": "Префікс вагового штрихкоду",
"description": "Префікс, за яким штрихкод розпізнається як ваговий.",
"group": "Додаткові",
"example": ""
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
resultResult | Повернене значення «Result» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
lookup_typeLookup type | Повернене значення «Lookup type» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
codeКод запису | Повернене значення «Код запису» відповідного запису, документа або підсумку ARM20. | string | "1001" |
quantity_or_valueQuantity or value | Точне повернене значення «Quantity or value» як десятковий рядок із крапкою. | string · decimal-string · product-unit | "100.00" |
reasonПричина операції | Повернене значення «Причина операції» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
replayedReplayed | Повернене значення «Replayed» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"result",
"lookup_type",
"code",
"quantity_or_value",
"reason",
"replayed"
],
"field_specs": {
"result": {
"title": "Result",
"description": "Повернене значення «Result» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"lookup_type": {
"title": "Lookup type",
"description": "Повернене значення «Lookup type» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"code": {
"title": "Код запису",
"description": "Повернене значення «Код запису» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "1001"
},
"quantity_or_value": {
"title": "Quantity or value",
"description": "Точне повернене значення «Quantity or value» як десятковий рядок із крапкою.",
"type": "string",
"format": "decimal-string",
"unit": "product-unit",
"example": "100.00"
},
"reason": {
"title": "Причина операції",
"description": "Повернене значення «Причина операції» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"replayed": {
"title": "Replayed",
"description": "Повернене значення «Replayed» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-nakl-scan-add-one-0001
{
"method": "nakl.scan_add_one",
"params": {
"code": "1001",
"nn": "ПН-1001"
},
"id": "example-nakl-scan-add-one"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.scan_add_one",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "scan_add_one",
"value": "1"
},
"rows": [
{
"result": "Приклад",
"lookup_type": "Приклад",
"code": "1001",
"quantity_or_value": "100.00",
"reason": "Приклад",
"replayed": "Приклад"
}
]
},
"id": "example-nakl-scan-add-one"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.statusПовертає поточний стан і ознаку проведення накладної.
читання
inventory.read
з 0.4.0
Повертає поточний стан і ознаку проведення накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"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": "nakl.status",
"params": {
"nn": "ПН-1001"
},
"id": "example-nakl-status"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.status",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "status",
"value": "Приклад"
},
"rows": []
},
"id": "example-nakl-status"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
nakl.tax_contrag_indexПовертає індекс контрагента для податкової накладної.
читання
inventory.read
з 0.4.0
Повертає індекс контрагента для податкової накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
source_nnНомер документа-джерела | Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"source_nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер документа-джерела",
"description": "Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"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": "nakl.tax_contrag_index",
"params": {
"source_nn": "ПН-1001"
},
"id": "example-nakl-tax-contrag-index"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.tax_contrag_index",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "tax_contrag_index",
"value": "Приклад"
},
"rows": []
},
"id": "example-nakl-tax-contrag-index"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
nakl.tax_save_contragЗберігає реквізити контрагента для податкової накладної.
запис
inventory.write
з 0.4.0
Зберігає реквізити контрагента для податкової накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
branchФілія | Поле «Філія» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
ipnІПН | Поле «ІПН» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
jdata_hexJSON-дані у HEX | Поле «JSON-дані у HEX» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
okpoЄДРПОУ | Поле «ЄДРПОУ» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
sign_nameПІБ підписанта | Поле «ПІБ підписанта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
source_nnНомер документа-джерела | Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "ПН-1001" |
| Фіскалізація | |||
sign_tax_numПодатковий номер підписанта | Поле «Податковий номер підписанта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
tax_codeПодатковий код | Поле «Податковий код» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | int | необов’язковийПриклад: 1За замовчуванням: 1 |
tax_numПодатковий номер | Поле «Податковий номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
Точна схема параметрів
{
"branch": {
"type": "string",
"max": 4096,
"default": "",
"title": "Філія",
"description": "Поле «Філія» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"ipn": {
"type": "string",
"max": 4096,
"default": "",
"title": "ІПН",
"description": "Поле «ІПН» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"jdata_hex": {
"type": "string",
"max": 60000,
"default": "",
"title": "JSON-дані у HEX",
"description": "Поле «JSON-дані у HEX» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"okpo": {
"type": "string",
"max": 4096,
"default": "",
"title": "ЄДРПОУ",
"description": "Поле «ЄДРПОУ» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"sign_name": {
"type": "string",
"max": 512,
"default": "",
"title": "ПІБ підписанта",
"description": "Поле «ПІБ підписанта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"sign_tax_num": {
"type": "string",
"max": 4096,
"default": "",
"title": "Податковий номер підписанта",
"description": "Поле «Податковий номер підписанта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"example": ""
},
"source_nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер документа-джерела",
"description": "Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "ПН-1001"
},
"tax_code": {
"type": "int",
"min": -2147483648,
"max": 2147483647,
"default": 1,
"title": "Податковий код",
"description": "Поле «Податковий код» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Фіскалізація",
"example": 1
},
"tax_num": {
"type": "string",
"max": 4096,
"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-nakl-tax-save-contrag-0001
{
"method": "nakl.tax_save_contrag",
"params": {
"source_nn": "ПН-1001"
},
"id": "example-nakl-tax-save-contrag"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.tax_save_contrag",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "tax_save_contrag",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-tax-save-contrag"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.tax_save_invoiceЗберігає реквізити податкової накладної.
запис
inventory.write
з 0.4.0
Зберігає реквізити податкової накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
jdata_hexJSON-дані у HEX | Поле «JSON-дані у HEX» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
pn_numНомер податкової накладної | Поле «Номер податкової накладної» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "Приклад" |
source_nnНомер документа-джерела | Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"jdata_hex": {
"type": "string",
"max": 60000,
"default": "",
"title": "JSON-дані у HEX",
"description": "Поле «JSON-дані у HEX» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"pn_num": {
"type": "string",
"max": 4096,
"required": true,
"title": "Номер податкової накладної",
"description": "Поле «Номер податкової накладної» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "Приклад"
},
"source_nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер документа-джерела",
"description": "Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "ПН-1001"
}
}
Результат
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-nakl-tax-save-invoice-0001
{
"method": "nakl.tax_save_invoice",
"params": {
"pn_num": "Приклад",
"source_nn": "ПН-1001"
},
"id": "example-nakl-tax-save-invoice"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.tax_save_invoice",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "tax_save_invoice",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-tax-save-invoice"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |
nakl.tax_saved_contragПовертає збережені реквізити контрагента податкової накладної.
читання
inventory.read
з 0.4.0
Повертає збережені реквізити контрагента податкової накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
source_nnНомер документа-джерела | Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"source_nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер документа-джерела",
"description": "Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "ПН-1001"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
okpoЄДРПОУ | Повернене значення «ЄДРПОУ» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
ipnІПН | Повернене значення «ІПН» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
branchФілія | Повернене значення «Філія» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
tax_numberTax number | Повернене значення «Tax number» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
tax_codeПодатковий код | Повернене значення «Податковий код» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
signer_nameSigner name | Повернене значення «Signer name» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
signer_tax_numberSigner tax number | Повернене значення «Signer tax number» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
json_hexJson hex | Повернене значення «Json hex» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"okpo",
"ipn",
"branch",
"tax_number",
"tax_code",
"signer_name",
"signer_tax_number",
"json_hex"
],
"field_specs": {
"okpo": {
"title": "ЄДРПОУ",
"description": "Повернене значення «ЄДРПОУ» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"ipn": {
"title": "ІПН",
"description": "Повернене значення «ІПН» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"branch": {
"title": "Філія",
"description": "Повернене значення «Філія» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"tax_number": {
"title": "Tax number",
"description": "Повернене значення «Tax number» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"tax_code": {
"title": "Податковий код",
"description": "Повернене значення «Податковий код» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"signer_name": {
"title": "Signer name",
"description": "Повернене значення «Signer name» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"signer_tax_number": {
"title": "Signer tax number",
"description": "Повернене значення «Signer tax number» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"json_hex": {
"title": "Json hex",
"description": "Повернене значення «Json hex» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "nakl.tax_saved_contrag",
"params": {
"source_nn": "ПН-1001"
},
"id": "example-nakl-tax-saved-contrag"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.tax_saved_contrag",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "tax_saved_contrag",
"value": "1"
},
"rows": [
{
"okpo": "Приклад",
"ipn": "Приклад",
"branch": "Приклад",
"tax_number": "Приклад",
"tax_code": "Приклад",
"signer_name": "Приклад",
"signer_tax_number": "Приклад",
"json_hex": "Приклад"
}
]
},
"id": "example-nakl-tax-saved-contrag"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
nakl.tax_saved_invoiceПовертає збережені реквізити податкової накладної.
читання
inventory.read
з 0.4.0
Повертає збережені реквізити податкової накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Додаткові | |||
source_nnНомер документа-джерела | Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"source_nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер документа-джерела",
"description": "Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "ПН-1001"
}
}
Результат
rows| Поле | Зміст | Тип | Приклад |
|---|---|---|---|
tax_invoice_numberTax invoice number | Повернене значення «Tax invoice number» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
json_hexJson hex | Повернене значення «Json hex» відповідного запису, документа або підсумку ARM20. | string | "Приклад" |
Точна схема результату
{
"mode": "rows",
"columns": [
"tax_invoice_number",
"json_hex"
],
"field_specs": {
"tax_invoice_number": {
"title": "Tax invoice number",
"description": "Повернене значення «Tax invoice number» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
},
"json_hex": {
"title": "Json hex",
"description": "Повернене значення «Json hex» відповідного запису, документа або підсумку ARM20.",
"type": "string",
"example": "Приклад"
}
}
}
Приклад запиту
POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
{
"method": "nakl.tax_saved_invoice",
"params": {
"source_nn": "ПН-1001"
},
"id": "example-nakl-tax-saved-invoice"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.tax_saved_invoice",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "tax_saved_invoice",
"value": "1"
},
"rows": [
{
"tax_invoice_number": "Приклад",
"json_hex": "Приклад"
}
]
},
"id": "example-nakl-tax-saved-invoice"
},
"request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
| Код | HTTP | Причина | Дія клієнта |
|---|---|---|---|
INVALID_PARAMETER | 422 | Один із параметрів має неправильний тип, формат або значення. | Виправити запит; автоматично не повторювати. |
UPSTREAM_FAILURE | 502 | Сервер бізнес-операції недоступний або відхилив безпечний контракт. | Дозволений повтор із backoff. |
nakl.update_headerОновлює заголовок, дати та контрагента накладної.
запис
inventory.write
з 0.4.0
Оновлює заголовок, дати та контрагента накладної.
Параметри params
| Поле | Що означає | Тип і формат | Правила |
|---|---|---|---|
| Дати й час | |||
cdatДата документа | Дата створюваного або редагованого документа у форматі YYYY-MM-DD. | string · date | необов’язковийПриклад: "2026-07-23"За замовчуванням: "" |
pay_dateДата оплати | Дата «Дата оплати» у календарному форматі YYYY-MM-DD. | string · date | необов’язковийПриклад: "2026-07-23"За замовчуванням: "" |
| Додаткові | |||
currencyВалюта | Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: "UAH"За замовчуванням: "" |
expЕкспедиція | Поле «Експедиція» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
sideСторона документа | Поле «Сторона документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
vnumЗовнішній номер документа | Поле «Зовнішній номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows. | string | необов’язковийПриклад: ""За замовчуванням: "" |
| Фіскалізація | |||
fiscalФіскальна ознака | Визначає, чи застосовувати параметр «Фіскальна ознака». Передавайте JSON true або false. | bool | необов’язковийПриклад: falseЗа замовчуванням: false |
| Суми та кількості | |||
kursКурс валюти | Курс валюти як десятковий рядок. Для гривні зазвичай передається 1.0000. | string · decimal-string · ratio | необов’язковийПриклад: "100.00"За замовчуванням: "0" |
pay_sumСума оплати | Точне числове значення «Сума оплати» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. | string · decimal-string · currency-of-operation | необов’язковийПриклад: "100.00" |
psumЗагальна сума документа | Точне числове значення «Загальна сума документа» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. | string · decimal-string · currency-of-operation | необов’язковийПриклад: "100.00"За замовчуванням: "0" |
| Основні | |||
nnНомер накладної | Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream. | string | обов’язковийПриклад: "ПН-1001" |
Точна схема параметрів
{
"cdat": {
"type": "string",
"max": 4096,
"default": "",
"title": "Дата документа",
"description": "Дата створюваного або редагованого документа у форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
},
"currency": {
"type": "string",
"max": 4096,
"default": "",
"title": "Валюта",
"description": "Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": "UAH"
},
"exp": {
"type": "string",
"max": 4096,
"default": "",
"title": "Експедиція",
"description": "Поле «Експедиція» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"fiscal": {
"type": "bool",
"default": false,
"title": "Фіскальна ознака",
"description": "Визначає, чи застосовувати параметр «Фіскальна ознака». Передавайте JSON true або false.",
"group": "Фіскалізація",
"example": false
},
"kurs": {
"type": "string",
"max": 4096,
"default": "0",
"title": "Курс валюти",
"description": "Курс валюти як десятковий рядок. Для гривні зазвичай передається 1.0000.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "ratio",
"example": "100.00"
},
"nn": {
"type": "string",
"max": 512,
"required": true,
"title": "Номер накладної",
"description": "Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.",
"group": "Основні",
"example": "ПН-1001"
},
"pay_date": {
"type": "string",
"max": 512,
"default": "",
"title": "Дата оплати",
"description": "Дата «Дата оплати» у календарному форматі YYYY-MM-DD.",
"group": "Дати й час",
"format": "date",
"example": "2026-07-23"
},
"pay_sum": {
"type": "string",
"max": 4096,
"title": "Сума оплати",
"description": "Точне числове значення «Сума оплати» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"psum": {
"type": "string",
"max": 4096,
"default": "0",
"title": "Загальна сума документа",
"description": "Точне числове значення «Загальна сума документа» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.",
"group": "Суми та кількості",
"format": "decimal-string",
"unit": "currency-of-operation",
"example": "100.00"
},
"side": {
"type": "string",
"max": 4096,
"default": "",
"title": "Сторона документа",
"description": "Поле «Сторона документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
"group": "Додаткові",
"example": ""
},
"vnum": {
"type": "string",
"max": 4096,
"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-nakl-update-header-0001
{
"method": "nakl.update_header",
"params": {
"nn": "ПН-1001"
},
"id": "example-nakl-update-header"
}
Замініть демонстраційні значення даними зі своєї бази.
Приклад успішної відповіді
{
"ok": true,
"data": {
"method": "nakl.update_header",
"result": {
"upstream": {
"name": "UPMAPI",
"version": "1",
"resource": "nakl"
},
"status": {
"code": "OK",
"operation": "update_header",
"affected": "Приклад",
"detail": "Приклад"
},
"rows": []
},
"id": "example-nakl-update-header"
},
"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 не виконав запис повторно. | Звірити документ, чек або платіж; не створювати новий ключ автоматично. |