QUINCE API. Контракти

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

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

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

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

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

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

Поле	Тип	Опис
`filter`	object	Необов’язковий фільтр. Поля фільтра працюють з логікою `AND`.
`filter.Id`	integer	Ідентифікатор контракту.
`filter.Archive`	boolean	Ознака повернення архівних контрактів.
`filter.Company`	integer	Ідентифікатор організації контракту.
`filter.Partner`	integer	Ідентифікатор партнера, контракти якого треба повернути.
`page`	integer	Номер сторінки. Якщо не передати, використовується перша сторінка.

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

Поле	Опис
`Id`	Ідентифікатор контракту.
`Name`	Назва контракту.
`Kind`	Вид контракту: `P` - з покупцем, `M` - з постачальником, `C` - з комітентом, `S` - з комісіонером, `O` - інші.
`Currency`	Код валюти.
`Company`	Ідентифікатор організації.
`Partner`	Ідентифікатор партнера.
`PriceType`	Ідентифікатор типу ціни.

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

{
  "filter": {
    "Partner": 210,
    "Archive": false
  },
  "page": 1
}

Створення контрактів

Назва методу: /api/v2/contract/add

Метод додає контракти пакетами до 100 елементів.

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

Поле	Опис
`array`	Масив контрактів. Обов’язковий.
`array[].Name`	Назва контракту.
`array[].Company`	Ідентифікатор організації.
`array[].Partner`	Ідентифікатор партнера.
`array[].Currency`	Код валюти.
`array[].Memo`	Коментар.

Оновлення контрактів

Назва методу: /api/v2/contract/update

Метод оновлює контракти пакетами до 100 елементів. Для оновлення поле Id обов’язкове. Якщо переданий Id не знайдено, пакет не оновлюється і API повертає перелік не знайдених ідентифікаторів.

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

Поле	Опис
`array`	Масив контрактів. Обов’язковий.
`array[].Id`	Ідентифікатор контракту. Обов’язковий.
`array[].Name`	Назва контракту.
`array[].Memo`	Коментар.

Формат відповіді для створення та оновлення

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