QUINCE API. Організації

Список методів


/api/v2/company/list	Отримання списку організацій
/api/v2/company/add	Створення організацій
/api/v2/company/update	Оновлення організацій
/api/v2/company/markasdelete	Видалення або архівування організації
/api/v2/company/restore	Відновлення організації з архіву

Отримання списку організацій

Назва методу: /api/v2/company/list

Повертає список організацій. Для навігації використовується номер сторінки (page).

Розмір сторінки фіксований і дорівнює 100 елементам.

Параметри запиту:


filter Тип: object (необов’язковий)	Доступні поля для фільтрації (Фільтр завжди використовує логіку “AND“):
	Id - ідентифікатор організації. Необов’язковий параметр
	Archive - Ознака того, що треба повертати архівні елементи
page Тип: integer (необов’язковий)	Якщо в запиті не передати, за замовчуванням буде встановлена перша сторінка.

Результат запиту:

Якщо в запиті фільтр відсутній, то повертається список організацій у порядку зростання Id.

Поля організацій, що повертаються методом:


Id	Ідентифікатор організації
Name	Назва організації (string)
PrintName	Назва для друку (string)
RegCode	ЄДРПОУ/ДРФО (string)
TaxNumber	ІПН (string)
LegalAddress	Юридична адреса (string)
MailingAddress	Поштова адреса (string)
Phone	Телефон (string)
Memo	Коментар (string)

Приклад:

Запит:

{

     "filter": {
        "Id": 126
    },
    "page": 1
}

Результат:

{

    "success": true,
    "data": [
        {
            "Id": 126,
            "Name": "Наше підприємство, ТОВ",
            "PrintName": "",
            "RegCode": "2356987458",
            "TaxNumber": "",
            "LegalAddress": "",
            "MailingAddress": "",
            "Phone": "",
            "Memo": ""
        }
    ]
}

Створення та оновлення організацій

Назва методу створення: /api/v2/company/add

Назва методу оновлення: /api/v2/company/update

Методи додають або оновлюють організації пакетами до 100 елементів. Для /api/v2/company/add поле Name обов’язкове, а переданий Id ігнорується. Для /api/v2/company/update поле Id обов’язкове. Якщо переданий Id не знайдено, API повертає success: false і список проблемних Id.

Поля, які не передані в об’єкті, під час оновлення зберігають попереднє значення - Name є винятком і завжди перезаписується переданим значенням.

Параметри запиту

Поле	Опис
`array`	Масив організацій. Обов’язковий.
`array[].Id`	Ідентифікатор організації. Обов’язковий для `/api/v2/company/update`.
`array[].Name`	Назва організації. Обов’язкова.
`array[].PrintName`	Назва для друку.
`array[].RegCode`	ЄДРПОУ/ДРФО.
`array[].TaxNumber`	ІПН.
`array[].LegalAddress`	Юридична адреса.
`array[].MailingAddress`	Поштова адреса.
`array[].Phone`	Телефон.
`array[].Memo`	Коментар.

Формат відповіді

Поле	Опис
`success`	`true` або `false`.
`data`	Масив ідентифікаторів створених або оновлених організацій.
`error`	Текст помилки, якщо `success = false`.

Видалення, архівування та відновлення організацій

Організації входять до довідників з уніфікованим контрактом видалення й відновлення (/api/v2/company/markasdelete і /api/v2/company/restore). Повний опис формату запиту, відповіді та кодів відмов - у розділі Видалення, архівування та відновлення довідників.

Відновлення організації наразі не підтримується: /api/v2/company/restore завжди повертає відмову з кодом NOT_SUPPORTED, навіть для щойно архівованої організації.