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

QUINCE API. Партнери

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



/partner/listОтримання списку партнерів
/partner/addСтворення нового партнера
/partner/updateВнесення змін даних партнера
/partner/folder/listОтримання списку папок
/partner/folder/addСтворення нової папки
/partner/folder/updateВнесення змін до папки


Отримання списку партнерів



Назва методу: /partner/list

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

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



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


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



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

Значення полей партнерів, що повертаються методом:

IdІдентифікатор партнера
NameНазва партнера (string)
ParentFolderID батьківської папки (integer)
PrintNameНазва для друку (string)
VatStringСтавка ПДВ у вигляді рядку (string)
MemoКоментар (string)
LegalAddressЮридична адреса (string)
ActualAddressФактична адреса (string)
DeliveryAddressАдреса доставки (string)
PhoneТелефон (string)
SecondaryPhoneДодатковий телефон (string)
RegCodeКод за ЄДРПОУ(string)
TaxNumberІПН (string)
KindU - юридична особа, F - фізична, ФОП (string)
EmailE-mail (string)
WebSiteВеб-сайт (string)
TelegramTelegram (string)
ViberViber (string)
WhatsappWhatsapp (string)
ContractsКонтракти партнера (масив)


Приклад:



Запит:

{
    "filter": {
        "ParentFolder": 110
    },
    "page": 1
}


Результат:

{
    "success": true,
    "data": [
        {
            "Id": 111,
            "ParentFolder": 110,
            "Name": "Партнер",
            ...
            "Whatsapp": null,
            "Void": false,
            "Contracts": [
                {
                    "Id": 540,
                    "Name": "Основний контракт",
                    "Company": 298,
                    "Currency": "грн"
                },
                ...
              ]
        },
        ...
    ]
}


Створення або оновлення партнера



Метод створення партнера(ів): /api/v2/partner/add

Метод оновлення партнера(ів): /api/v2/partner/update

Методи додають або оновлюють партнерів. Максимальна кількість партнерів в одному пакеті - 100.

Параметри запитів у методів майже ідентичні. Тільки для методу /partner/update обов'язковим є передача Id запису для оновлення. Якщо в запиті відсутній Id, повертається помилка і жоден з партнерів не оновлюється.
Якщо в запиті Id переданий, але не знайдений в довіднику партнерів, жоден з партнерів також не оновлється і додатково повертається перелік незнайдених Id.
Під час створення партнера автоматично створюється контракт зі значеннями за замовчуванням.

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



array Тип: масив (Обов'язковий)Кожен партнер в масиві являє собою об'єкт з переліком полів. Доступні поля:
id Ідентифікатор партнера. Враховується та є обов'язковим тільки для методу /partner/update
Name Назва партнера (string)
ParentFolder ID батьківської папки (integer)
PrintName Назва для друку (string)
Memo Коментар (string)
LegalAddress Юридична адреса (string)
ActualAddress Фактична адреса (string)
DeliveryAddress Адреса доставки (string)
Phone Телефон (string)
SecondaryPhone Телефон (string)
RegCode Код за ЄДРПОУ(string)
Email E-mail (string)
WebSite Веб-сайт (string)
Telegram Telegram (string)
Viber Viber (string)
Whatsapp Whatsapp (string)


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



Метод повертає масив:

successtrue або false
dataМасив ідентифікаторів створених партнерів
errorКод та зміст помилки (вказується, якщо success = false)


Приклад:



Запит:

{
    "array": [
        {
            "Name": "Новий_партнер",
            "Memo": "коментар до нового партнера",
            "ParentFolder": "110",
            ...
        },
        ...
    ]
}


Результат:

{
    "success": true,
    "data": [
        {
            "id": 116
        },
        ...
    ]
}


Отримання списку папок



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

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

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

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



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


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



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

Приклад:



{
    "success": true,
    "data": [
        {
            "Id": 118,
            "ParentFolder": 110,
            "Name": "Folder_123"
        },
        ...
    ]
}


Створення або оновлення папки



Метод створення папки(ок): /api/v2/partner/folder/add

Метод оновлення папки(ок): /api/v2/partner/folder/update

Методи додають або оновлюють папки. Максимальна кількість папок в одному пакеті - 100.

Параметри запитів у методів майже ідентичні. Тільки для методу /partner/folder/update обов'язковим є передача Id папки. Якщо в запиті відсутній Id, повертається помилка і жодна з папок не оновлюється.
Якщо в запиті Id переданий, але не знайдений в довіднику папок, жодна з папок також не оновлється і додатково повертається перелік не знайдених Id.

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



array Тип: масив (Обов'язковий)Кожна папка в масиві являє собою об'єкт з переліком полів. Доступні поля:
Id Ідентифікатор папки. Враховується та є обов'язковим тільки для методу /partner/folder/update
Name Назва папки (string)
ParentFolder ID батьківської папки (integer)


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



Метод повертає масив:

successtrue или false
dataМасив ідентифікаторів створених папок для методу /partner/folder/add або масив ідентифікаторів оновлених папок для методу /partner/folder/update
errorКод та зміст помилки (вказується, якщо success = false)


Приклад:



Запит:

{
    "array": [
        {
            "Id": 110,
            "Name": "Directory_111",
            "ParentFolder": 100
        },
      ...
    ]
}


Результат:

{
    "success": true,
    "data": [
        {
            "id": 129
        },
        ...
    ]
}

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