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

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

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



/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 - валюта
Memo - коментар (string)


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



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

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


Приклад:



Запит:

{
    "array": [
        {
            "Name": "Головний контракт",
            "Company": 110,
            "Partner": 122,
            "Currency": "грн",
            "Memo": "Нотатки"
        },
        ...
    ]
}


Результат:

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


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



Метод оновлення контракту(ів): /api/v2/contract/update

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

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

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



array Тип: масив (Обов'язковий)Кожен контракт в масиві являє собою об'єкт з наступними полями:
Id \- Ідентифікатор контракту(int). Обов'язкове.
Name \- назва контракту (string)
Memo Коментар (string)


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



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

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


Приклад:



Запит:

{
    "array": [
        {
            "Id": 351,
            "Name": "Головний контракт",
            "Memo": "Нотатки"
        },
        ...
    ]
}


Результат:

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

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

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

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

Скасувати

Дякуємо!