QUINCE API. Надходження на рахунок

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


/document/money_bank_income/list	Отримання списку документів
/document/money_bank_income/add	Додавання документа
/document/money_bank_income/update	Оновлення документа

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

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

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

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

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


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

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

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

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


Id	Ідентифікатор замовлення
Date	Дата замовлення (string)
Number	Номер (string)
Comment	Коментар (string)
Fixed	Ознака публікації документа
Company	Об’єкт з полями “Id” та “Name”
MoneyAccount	Грошовий рахунок. Об’єкт з полями “Id”, “Name”, “Iban”, “BankMFO”
Partner	Об’єкт з полями “Id” та “Name”
Responsible	Об’єкт з полями “Id” та “PersonName”
Rows	Рядки грошового документу. Об’єкт з наступними полями:
	Id - Ідентифікатор позиції
	RowNo - Номер рядка
	Contract - Контракт
	PaidDoc - Сплачений документ. Об’єкт з полями “Id”, “Type”, “Name”, “Number”, “Date”
	ASum - Сума у валюті грошового рахунку
	CSum - Сума у валюті контракту
	Purpose - Призначення платежу

Приклад:

Запит:

{
    "filter": {
        "DateFrom": "2024-05-01",
        "DateTo": "2024-06-30"
    },
    "page": 1
}

Результат:

{
    "success": true,
    "data": [
       {

            "Id": 786,
            "Date": "2024-05-15T21:50:23",
            "Number": 18,
            "Fixed": true,
            "Void": false,
            "Company": {
                "Id": 126,
                "Name": "Наше підприємство, ТОВ"
            },
            "MoneyAccount": {
                "Id": 136,
                "Name": "Каса в центр.офісі"
            },
            "Partner": {
                "Id": 154,
                "Name": "Наш комісіонер"
            },
            "Responsible": {
                "Id": 213,
                "PersonName": "Localhost Admin"
            },
            "Rows": [
                {
                    "Id": 263,
                    "RowNo": 1,
                    "Contract": {
                        "Id": 205,
                        "Name": "Основний контракт"
                    },
                    "PaidDoc": {
                        "Id": 785
                    },
                    "ASum": 100.00,
                    "CSum": 100.00,
                    "Purpose": ""
                }
            ]
        }
    ]
}

Додавання документа

Підтримується два режими:

Додавання на основі замовлення
Додавання з передачею всіх необхідних полів

Параметри запиту додавання на основі замовлення:

Підтримується додавання не більше одного елемента. Кількість елементів в масиві = 1.


array Тип: масив (Обов’язковий)	Кожен елемент в масиві являє собою об’єкт з наступними поля:
ParentDoc*	Id замовлення
Date*	дата операції надходження на рахунок (DateTime)
Sum*	сума в валюті контракту (Decimal)
CashAccount	Id банківського рахунку. Якщо не вказується, береться з замовлення (Integer)
Contract	Id контракту. Якщо не вказується, береться з замовлення (Integer)
Fixed	публікація документа (Bool)

- Обов’язкові поля

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

Повертається об’єкт:


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

Приклад:

Запит:

{
    "array": [
        {
            "ParentDoc": 507,
            "Date": "2026-03-03",
            "Sum": 45
        }
    ]
}

Результат:

{
    "success": true,
    "data": [
        {
            "Id": 509
        }
    ]
}

Параметри запиту додавання з передачею всіх полів:

Підтримується додавання не більше одного елемента. Кількість елементів в масиві array = 1.

Масив RowsMoney також має довжину = 1.


array Тип: масив (Обов’язковий)	Кожен елемент в масиві являє собою об’єкт з наступними поля:
Date*	дата операції надходження на рахунок (DateTime)
CashAccount*	Id банківського рахунку (Integer)
Partner*	Id партнера (Integer)
Fixed	публікація документа (Bool)
RowsMoney	Масив об’єктів, кожен з яких представляє деталі платежу. Поля об’єкта:
Sum*	сума в валюті контракту (Decimal)
Contract*	Id контракту (Integer)

- Обов’язкові поля

Приклад:

Запит:

{
    "array": [
        {
            "Date": "2026-03-03",
            "Partner": 111,
            "CashAccount": 111,
            "Fixed": true,
            "RowsMoney": [
                {
                    "Sum": 100,
                    "Contract": 509
                }
            ]
        }
    ]
}

Оновлення документа

Параметри запиту оновлення:

Підтримується оновлення не більше одного елемента. Кількість елементів в масиві = 1.

Масив RowsMoney також має довжину = 1.


array Тип: масив (Обов’язковий)	Кожен елемент в масиві являє собою об’єкт з наступними поля:
Id*	Id документа надходження (Integer)
Date	дата операції надходження на рахунок (DateTime)
CashAccount	Id банківського рахунку (Integer)
RowsMoney	Масив об’єктів, кожен з яких представляє деталі платежу. Поля об’єкта:
Id*	Id рядка, який представляє деталі платежу (Integer)
Sum	сума в валюті контракту (Decimal)
Contract	Id контракту (Integer)

- Обов’язкові поля

Приклад:

Запит:

{
    "array": [
        {
            "Id": 545,
            "Date": "2026-02-25",
            "RowsMoney": [
                {
                    "Id": 212,
                    "Sum": 100,
                    "Contract": 511
                }
            ]
        }
    ]
}

Результат:

{
    "success": true,
    "data": [
        {
            "Id": 545
        }
    ]
}