get.contractors.list — Перегляд списку: Контрагенти

Призначення

Повертає список записів довідника Контрагенти.

HTTP

• URL: https://api13.arm20.com/
• Метод: POST
• Content-Type: application/json

Авторизація

• Логін/пароль (як в онлайн статистиці): так.
• meta.user_card: обов’язково.

Параметри params

Поле	Тип	Обовʼязково	Опис

| limit | int | ні | Кількість рядків. За замовчуванням 100. Максимум 5000. |

| offset | int | ні | Зсув для пагінації. За замовчуванням 0. |

| q | string | ні | Пошуковий рядок (LIKE). Підтримувані поля залежать від довідника. |

| filters | object | ні | Точні фільтри поле=значення. Дозволені поля залежать від довідника. |

| order_by | string | ні | Поле сортування (якщо підтримується довідником). |

| order_dir | string | ні | Напрям сортування: ASC або DESC. |

| with_total | bool | ні | Якщо true, у відповіді буде total (може бути повільно). |

Що повертає метод

У result.items[] повертаються поля:

Ind, Nt, Rekv, Deleted

Примітки

• Контрагенти з таблиці Contrag.

• Видалення фізичне (DELETE), відновлення не підтримується.

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

Мокап: mockups/dictionaries/contractors/get.list/request.json

{
  "auth": {
    "login": "<LOGIN>",
    "password": "<PASSWORD>"
  },
  "method": "get.contractors.list",
  "params": {
    "limit": 50,
    "offset": 0,
    "q": "ФОП"
  },
  "meta": {
    "user_card": "<USER_CARD>",
    "client_name": "MyIntegration",
    "client_version": "1.0.0"
  },
  "id": "contractors-list-001"
}

Приклад відповіді (успіх)

Мокап: mockups/dictionaries/contractors/get.list/response.ok.json

{
  "ok": true,
  "result": {
    "items": [
      {
        "...": "..."
      }
    ],
    "limit": 50,
    "offset": 0,
    "count": 1,
    "total": 1
  },
  "meta": {
    "api_version": "0.1.0",
    "ts": "2026-01-26T12:00:00+00:00"
  },
  "id": "contractors-list-001"
}

Типові помилки

• AUTH_REQUIRED / AUTH_FAILED — проблеми з логіном/паролем.
• UNAUTHORIZED — проблема з meta.user_card.
• INVALID_FILTERS / INVALID_FILTER_FIELD — неправильні фільтри.