| | |
| ---- |
| /contract/list | Отримання списку контрактів |
| /contract/add | Створення контрака |
| /contract/update | Оновлення контракта |
Назва методу: /contract/list
Повертає список контрактів. Для навігації використовується номер сторінки ( page).
Розмір сторінки фіксований і дорівнює 100 елементам.
| | |
| ---- |
| filter Тип: object (необов'язковий) | Доступні поля фільтру (завжди використовує логіку “AND“): |
| | Id - ідентифікатор контракту. Необов'язковий параметр |
| | Archive - ознака для пошуку архівних елементів (boolean). Необов'язковий параметр |
| | Contract - ідентифікатор компанії контракту. Необов'язковий параметр |
| | Partner - ідентифікатор партнера, контракти якого потрібно повернути. Необов'язковий параметр |
| page Тип: integer (необов'язковий) | Якщо в запиті не передати, за замовчуванням буде встановлена перша сторінка. |
Якщо в запиті фільтр відсутній, то повертається список контрактів у порядку зростання Id.
Значення полів контарктів, що повертаються методом:
| | |
| ---- |
| Id | Ідентифікатор контракту (integer) |
| Name | Назва контракту (string) |
| Kind | Вид контракту (string). P - з покупцем, M - з постачальником, C - З комітентом (беремо на реалізацію), S - З комісіонером (віддаємо на реалізацію), O - Інші |
| Сurrency | Код валюти (string) |
| Company | Компанія (integer) |
| Partner | Партнер (integer) |
| PriceType | Тип ціни (integer) |
Запит:
{
"filter": {
"Partner": 210,
"Archive": false
},
"page": 1
}
Результат:
{
"success": true,
"data": [
{
"Id": 263,
"Name": "Основний контракт",
"Currency": "грн",
"Company": 110,
"Partner": 210,
"PriceType": 110
},
...
]
}
Метод створення контракту(ів): /api/v2/contract/add
Метод додає контракти. Максимальна кількість контрактів в одному пакеті - 100.
| | |
| ---- |
| array Тип: масив (Обов'язковий) | Кожен контракт в масиві являє собою об'єкт з наступними полями: |
| | Name - назва контракту (string) |
| | Company - Id компанії (integer) |
| | Partner - Id партнера (integer) |
| | Сurrency - код валюти (integer) |
| | Memo - коментар (string) |
Метод повертає масив:
| | |
| ---- |
| success | true або false |
| data | Масив ідентифікаторів створених контрактів |
| error | Зміст помилки (вказується, якщо success = false) |
Запит:
{
"array": [
{
"Name": "Головний контракт",
"Company": 110,
"Partner": 122,
"Currency": 980,
"Memo": "Нотатки"
},
...
]
}
Результат:
{
"success": true,
"data": [
{
"id": 351
},
...
]
}
Метод оновлення контракту(ів): /api/v2/contract/update
Метод оновлює контракти. Максимальна кількість контрактів в одному пакеті - 100.
Якщо в запиті відсутній Id, повертається помилка і жоден контракт не оновлюється.
Якщо в запиті Id переданий, але не знайдений в довіднику контрактів, жоден контракт також не оновлюється і додатково повертається перелік незнайдених Id.
| | |
| ---- |
| array Тип: масив (Обов'язковий) | Кожен контракт в масиві являє собою об'єкт з наступними полями: |
| | Id - Ідентифікатор контракту(int). Обов'язкове. |
| | Name - назва контракту (string) |
| | Memo Коментар (string) |
Метод повертає масив:
| | |
| ---- |
| success | true або false |
| data | Масив ідентифікаторів оновлених контрактів |
| error | Зміст помилки (вказується, якщо success = false) |
Запит:
{
"array": [
{
"Id": 351,
"Name": "Головний контракт",
"Memo": "Нотатки"
},
...
]
}
Результат:
{
"success": true,
"data": [
{
"id": 351
},
...
]
}