QUINCE API. Партнери

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

Метод	Опис
`/api/v2/partner/list`	Отримання списку партнерів
`/api/v2/partner/add`	Створення партнерів
`/api/v2/partner/update`	Оновлення партнерів
`/api/v2/partner/folder/list`	Отримання списку папок партнерів
`/api/v2/partner/folder/add`	Створення папок партнерів
`/api/v2/partner/folder/update`	Оновлення папок партнерів

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

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

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

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

Поле	Тип	Опис
`filter`	object	Необов’язковий фільтр. Поля фільтра працюють з логікою `AND`.
`filter.ParentFolder`	integer або `null`	Ідентифікатор папки. Для партнерів без папки передайте `null`.
`filter.Id`	integer	Ідентифікатор партнера.
`filter.Name`	string	Назва партнера. Пошук виконується за точним значенням.
`filter.Phone`	string	Основний або додатковий телефон. Пошук виконується за точним значенням.
`filter.Email`	string	Основний або додатковий email. Пошук виконується за точним значенням.
`filter.Company`	integer	Ідентифікатор організації. Повертає партнерів із контрактом для цієї організації.
`filter.TaxNumber`	string	ІПН.
`filter.Archive`	boolean	Ознака повернення архівних партнерів.
`filter.MobileApp`	boolean	Якщо `true`, API використовує збільшений ліміт вибірки.
`page`	integer	Номер сторінки. Якщо не передати, використовується перша сторінка.

Основні поля відповіді

Поле	Опис
`Id`	Ідентифікатор партнера.
`Name`	Назва партнера.
`ParentFolder`	Ідентифікатор батьківської папки.
`PrintName`	Назва для друку.
`VatString`	Ставка ПДВ у вигляді рядка.
`Memo`	Коментар.
`LegalAddress`	Юридична адреса.
`ActualAddress`	Фактична адреса.
`DeliveryAddress`	Адреса доставки.
`Phone`	Телефон.
`SecondaryPhone`	Додатковий телефон.
`RegCode`	Код ЄДРПОУ.
`TaxNumber`	ІПН.
`Kind`	Тип партнера: `U` - юридична особа, `F` - фізична особа або ФОП.
`Email`	Email.
`WebSite`	Вебсайт.
`Telegram`	Telegram.
`Viber`	Viber.
`Whatsapp`	Whatsapp.
`Contracts`	Контракти партнера.

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

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

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

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

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

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

Під час створення партнера автоматично створюється контракт зі значеннями за замовчуванням.

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

Поле	Опис
`array`	Масив партнерів. Обов’язковий.
`array[].Id`	Ідентифікатор партнера. Обов’язковий для `/api/v2/partner/update`.
`array[].Name`	Назва партнера.
`array[].ParentFolder`	Ідентифікатор папки.
`array[].PrintName`	Назва для друку.
`array[].Memo`	Коментар.
`array[].LegalAddress`	Юридична адреса.
`array[].ActualAddress`	Фактична адреса.
`array[].DeliveryAddress`	Адреса доставки.
`array[].Phone`	Телефон.
`array[].SecondaryPhone`	Додатковий телефон.
`array[].RegCode`	Код ЄДРПОУ.
`array[].TaxNumber`	ІПН.
`array[].Kind`	Тип партнера.
`array[].Email`	Email.
`array[].WebSite`	Вебсайт.
`array[].Telegram`	Telegram.
`array[].Viber`	Viber.
`array[].Whatsapp`	Whatsapp.

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

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

Папки партнерів

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

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

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

Метод списку повертає папки партнерів сторінками по 100 елементів. Для папок першого рівня передайте filter.ParentFolder: null. У списку також підтримуються filter.Archive і filter.MobileApp.

Параметри списку папок

Поле	Опис
`filter.ParentFolder`	Ідентифікатор батьківської папки або `null` для першого рівня.
`filter.Id`	Ідентифікатор папки.
`page`	Номер сторінки.

Параметри створення та оновлення папок

Поле	Опис
`array`	Масив папок. Обов’язковий.
`array[].Id`	Ідентифікатор папки. Обов’язковий для `/api/v2/partner/folder/update`.
`array[].Name`	Назва папки.
`array[].ParentFolder`	Ідентифікатор батьківської папки.

Для створення папки Name обов’язковий, а переданий Id ігнорується. Для оновлення Id має бути цілим числом; якщо передати порожній Name, API поверне помилку.