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

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

Метод	Опис
`/api/v2/document/money_bank_income/list`	Отримання списку документів
`/api/v2/document/money_bank_income/add`	Додавання документа
`/api/v2/document/money_bank_income/update`	Оновлення документа
`/api/v2/document/money_bank_income/unpublish`	Зняття документа з проведення

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

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

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

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

Поле	Опис
`filter.Id`	Ідентифікатор документа.
`filter.DateFrom`	Початок періоду у форматі `YYYY-MM-DD` або `YYYY-MM-DD HH:mm:ss`.
`filter.DateTo`	Кінець періоду у форматі `YYYY-MM-DD` або `YYYY-MM-DD HH:mm:ss`.
`filter.Company`	Ідентифікатор організації.
`filter.Archive`	Ознака архівності.
`filter.MobileApp`	Якщо `true`, API повертає збільшений ліміт елементів для мобільного сценарію.
`page`	Номер сторінки. Необов’язковий.

Якщо DateFrom і DateTo не передані та немає фільтра Id, API повертає документи за поточний день. Якщо передати тільки одну з дат, API поверне помилку DateFrom and DateTo are required. Дати без часу автоматично розширюються до початку та кінця дня.

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

Поле	Опис
`Id`	Ідентифікатор документа.
`Date`	Дата документа у часовому поясі користувача.
`Number`	Номер документа.
`Comment`	Коментар.
`Fixed`	Ознака проведення документа.
`Void`	Ознака архівності.
`Company`	Організація.
`MoneyAccount`	Банківський рахунок.
`Partner`	Партнер.
`Responsible`	Відповідальний.
`Rows`	Рядки платежу з контрактом, сплаченим документом, статтею руху коштів і сумами.

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

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

Метод додає один документ за запит. Якщо array відсутній або не є масивом, API повертає Not valid format or empty array. Якщо передати більше одного документа, API поверне помилку Only one record can be added at a time.

Підтримується створення на основі документа-джерела через ParentDoc або ручне створення з передачею всіх потрібних полів.

Якщо передати Fixed: true, API після створення спробує провести документ. Якщо проведення не вдалось, відповідь лишається success: true, але в елементі data буде поле Message з текстом помилки проведення.

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

Поле	Опис
`array`	Масив з одним документом.
`array[].ParentDoc`	Id документа-джерела. Обов’язковий.
`array[].Date`	Дата операції. Обов’язкова.
`array[].Sum`	Сума у валюті контракту. Обов’язкова.
`array[].CashAccount`	Id банківського рахунку. Якщо не передати, береться з документа-джерела.
`array[].Contract`	Id контракту. Якщо не передати, береться з документа-джерела.
`array[].Fixed`	Провести документ після створення.

Ручне додавання з передачею всіх полів

Поле	Опис
`array`	Масив з одним документом.
`array[].Date`	Дата операції. Обов’язкова.
`array[].CashAccount`	Id банківського рахунку. Обов’язковий.
`array[].Partner`	Id партнера. Обов’язковий.
`array[].Comment`	Коментар.
`array[].Responsible`	Id відповідального.
`array[].Segment`	Id сегмента.
`array[].Fixed`	Провести документ після створення.
`array[].RowsMoney`	Масив з одним рядком платежу. Обов’язковий.
`array[].RowsMoney[].Contract`	Id контракту. Обов’язковий.
`array[].RowsMoney[].CashFlowItem`	Id статті руху коштів. Якщо не передати, API візьме статтю з контракту або налаштувань за замовчуванням.
`array[].RowsMoney[].Sum`	Сума у валюті контракту. Обов’язкова.

RowsMoney може містити тільки один рядок. Банківський рахунок передається в полі CashAccount; він визначає організацію та валюту грошового рахунку. Контракт має належати партнеру в цій організації, інакше API поверне помилку.

Приклад ручного додавання

{
  "array": [
    {
      "Date": "2026-06-01",
      "CashAccount": 210,
      "Partner": 110,
      "Comment": "Оплата на банківський рахунок",
      "Fixed": false,
      "RowsMoney": [
        {
          "Contract": 150,
          "CashFlowItem": 100,
          "Sum": 123.45
        }
      ]
    }
  ]
}

У відповіді API повертає success: true і масив data з Id створеного документа. Якщо передати Fixed: true, документ буде проведено після створення або повернеться Message з помилкою проведення.

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

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

Метод оновлює один документ за запит. Якщо передати більше одного документа, API поверне помилку Only one record can be updated at a time.

Поле	Опис
`array`	Масив з одним документом.
`array[].Id`	Id документа. Обов’язковий.
`array[].Date`	Дата операції.
`array[].CashAccount`	Id банківського рахунку.
`array[].Partner`	Id партнера.
`array[].Comment`	Коментар.
`array[].Fixed`	Ознака проведення.
`array[].RowsMoney`	Масив з одним рядком платежу.
`array[].RowsMoney[].Id`	Id рядка платежу. Обов’язковий для оновлення рядка.
`array[].RowsMoney[].Contract`	Id контракту.
`array[].RowsMoney[].CashFlowItem`	Id статті руху коштів.
`array[].RowsMoney[].Sum`	Сума у валюті контракту.

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

Приклад оновлення

{
  "array": [
    {
      "Id": 545,
      "Date": "2026-06-02",
      "CashAccount": 210,
      "Partner": 110,
      "Comment": "Уточнена оплата на банківський рахунок",
      "Fixed": false,
      "RowsMoney": [
        {
          "Id": 780,
          "Contract": 150,
          "CashFlowItem": 100,
          "Sum": 130.00
        }
      ]
    }
  ]
}

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

Зняття документа з проведення

Назва методу: /api/v2/document/money_bank_income/unpublish

Метод знімає з проведення один документ за запит. Він викликає Document.UnApply: документ не видаляється і не архівується. Якщо array відсутній, не є масивом, містить більше одного документа або не має Id, API поверне помилку.

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

{
  "array": [
    {
      "Id": 545
    }
  ]
}

Після успішного виконання документ лишається в системі, але його рухи скасовуються. Для повторного проведення оновіть документ через update з Fixed: true або проведіть його в інтерфейсі QUINCEFIN.