Контрагенти

Список контрагентів

Отримати список контрагентів

GET /api/clients{?is_supplier,is_buyer,ids_list,filters,with,active,order,offset,limit,unprotect_keys}

Отримання списку контрагентів. Якщо додаткові параметри не вказані, повертаються одразу і постачальники, і покупці. Параметри supplier, buyer зі значенням true дають змогу отримувати окремо списки постачальників або покупців

Параметри
Параметр	Тип	Обов’язковий	Опис
`is_supplier`	string	ні	Якщо параметр дорівнює «true», повертається (додається запис) список покупців
`is_buyer`	string	ні	Якщо параметр дорівнює «true», повертається (додається запис) список постачальників
`ids_list`	string	ні	Список значень ключового поля записів, які потрібно повернути. Зазначається через кому без пробілу
`filters`	string	ні	Текстові фільтри у форматі: field_name:: \|field_name1::
`with`	string	ні	Список імен пов’язаних ресурсів через кому без пробілів. Зв’язки: priceLevel, discountCards
`active`	string	ні	Якщо параметр дорівнює «true», повертаються лише активні контрагенти.
`order`	string	ні	Список полів сортування через кому без пробілів
`offset`	integer	ні	Повертати дані, починаючи з указаного номера запису
`limit`	integer	ні	Повертати вказану кількість записів

Відповідь 200 (application/json)

[
  {
    "id_client": 8,
    "name_client": "Иванов",
    "is_supplier": false,
    "is_buyer": true,
    "can_return": true,
    "id_price_level": 2,
    "active": true
  }
]

Додати контрагента

POST /api/clients{?is_supplier,is_buyer,ids_list,filters,with,active,order,offset,limit,unprotect_keys}

Додавання контрагента. Атрибут id_client у JSON запиту стандартно ігнорується.

Параметри
Параметр	Тип	Обов’язковий	Опис
`unprotect_keys`	string	ні	Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Заголовки запиту:

Content-Type: application/json

Тіло запиту:

{
  "id_client": 8,
  "name_client": "Иванов",
  "is_supplier": false,
  "is_buyer": true,
  "can_return": true,
  "id_price_level": 2,
  "active": true
}

Відповідь 201 (application/json)

{
  "id_client": 8,
  "name_client": "Иванов",
  "is_supplier": false,
  "is_buyer": true,
  "can_return": true,
  "id_price_level": 2,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_client": {
      "type": "number"
    },
    "name_client": {
      "type": "string"
    },
    "is_supplier": {
      "type": "boolean"
    },
    "is_buyer": {
      "type": "boolean"
    },
    "can_return": {
      "type": "boolean"
    },
    "id_price_level": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_client",
    "name_client",
    "is_supplier",
    "is_buyer",
    "can_return",
    "id_price_level",
    "active"
  ]
}

Кількість контрагентів

Отримати кількість контрагентів

GET /api/clients/count{?is_supplier,is_buyer,ids_list,filters,active}

Повертає кількість записів

Параметри
Параметр	Тип	Обов’язковий	Опис
`is_supplier`	string	ні	Якщо параметр дорівнює «true», враховуються покупці
`is_buyer`	string	ні	Якщо параметр дорівнює «true», враховуються постачальники
`ids_list`	string	ні	Список значень ключового поля записів, які потрібно повернути. Зазначається через кому без пробілу
`filters`	string	ні	Текстові фільтри у форматі: field_name:: \|field_name1::
`active`	string	ні	Якщо параметр дорівнює «true», враховуються лише активні контрагенти.

Відповідь 200 (application/json)

{
  "count": 10
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number"
    }
  },
  "required": [
    "count"
  ]
}