Статті на: Документація з API

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

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



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


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



Назва методу: /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": ""
        }
    ]
}

Оновлено: 06/06/2024

Чи була ця стаття корисною?

Поділіться своїм відгуком

Скасувати

Дякуємо!