QUINCE API. Банківські рахунки

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

Метод	Опис
`/api/v2/bank_account/list`	Отримання списку банківських рахунків
`/api/v2/cash_account/add`	Створення каси або банківського рахунку
`/api/v2/cash_account/update`	Оновлення каси або банківського рахунку
`/api/v2/cash_account/markasdelete`	Видалення або архівування каси/рахунку
`/api/v2/cash_account/restore`	Відновлення каси/рахунку з архіву
`/api/v2/cash_account/folder/list`	Отримання списку папок рахунків і кас

Банківські рахунки й каси - це один довідник qfin.CashAccounts, розділений прапорцем IsCash. Створення, оновлення, видалення й відновлення для обох працюють через спільні методи /api/v2/cash_account/*; окремих /api/v2/bank_account/add|update|markasdelete|restore не існує. Повний опис методів створення/оновлення/видалення - у статті Каси.

Отримання списку банківських рахунків

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

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

Метод завжди повертає некасові рахунки (IsCash: false). Для готівкових рахунків використовуйте /api/v2/cash_account/list.

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

Поле	Опис
`filter`	Об’єкт з фільтрами. Необов’язковий.
`filter.Id`	Ідентифікатор рахунку.
`filter.Company`	Ідентифікатор організації.
`filter.ParentFolder`	Ідентифікатор папки. Якщо поле не передати, обмеження за папкою немає; `null` повертає елементи першого рівня; `Id` повертає прямий вміст папки.
`filter.IsFolder`	Якщо `false`, повертаються тільки рахунки без папок. Якщо `true`, тільки папки. Якщо поле не передати, повертаються і папки, і рахунки.
`filter.Archive`	Ознака архівності.
`filter.MobileApp`	Якщо `true`, API повертає збільшений ліміт елементів для мобільного сценарію.
`page`	Номер сторінки. Необов’язковий.

Поля відповіді

Поле	Опис
`Id`	Ідентифікатор рахунку.
`Name`	Назва рахунку.
`Company`	Організація: об’єкт `{ "Id": ..., "Name": ... }`.
`CompanyLocked`	`true`, якщо по рахунку вже є рух у грошовому регістрі. У такому разі зміна `Company` через `/api/v2/cash_account/update` буде відхилена з кодом `FIELD_LOCKED`.
`IsCash`	Для банківських рахунків повертається `false`.
`Currency`	Валюта рахунку: об’єкт `{ "Id": ..., "Code": ... }`.
`CurrencyCode`	Код валюти рахунку (те саме значення, що й `Currency.Code`, для зворотної сумісності).
`Bank`	Банк з довідника банків, якщо обраний: об’єкт `{ "Id": ..., "Name": ... }` або `null`.
`Iban`	IBAN рахунку.
`BankAccount`	Номер банківського рахунку.
`BankName`	Назва банку (текстове поле; якщо обрано `Bank` з довідника, підтягується з нього).
`BankMFO`	МФО банку (текстове поле; якщо обрано `Bank` з довідника, підтягується з нього).
`Memo`	Коментар.
`IsFolder`	Ознака папки.
`ParentFolder`	Ідентифікатор батьківської папки або `null` для першого рівня.
`IsDefault`	Ознака рахунку за замовчуванням.
`Void`	Ознака архівності.

Company повертається об’єктом, а не скалярним Id - це зворотно несумісна зміна. Якщо інтеграція раніше читала Company як число, оновіть парсинг на Company.Id. Детальніше - у розділі Незмінність власника конвенцій API.

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

{
  "filter": {
    "Company": 10,
    "IsFolder": false,
    "Archive": false
  },
  "page": 1
}

Папки банківських рахунків

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

Банківські рахунки й каси зберігають папки в одному довіднику, тому метод списку папок для них спільний. Для дерева папок банківських рахунків передайте filter.IsCash: false.

Повний опис параметрів і полів відповіді наведено у статті Каси, а загальне правило фільтра — у розділі Папки довідників.

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

{
  "filter": {
    "IsCash": false,
    "ParentFolder": null
  },
  "page": 1
}

Довідник банків

Окремо від банківських рахунків QUINCEFIN має довідник банків (qfin.Banks) - список банків, з якого можна обрати Bank під час створення чи редагування каси/рахунку (див. поле Bank вище).

Метод	Опис
`/api/v2/bank/list`	Отримання довідника банків
`/api/v2/bank/add`	Створення банку в довіднику
`/api/v2/bank/update`	Оновлення банку в довіднику
`/api/v2/bank/markasdelete`	Видалення або архівування банку
`/api/v2/bank/restore`	Відновлення банку з архіву

Отримання довідника банків

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

Метод не має пагінації - повертає всі банки, які відповідають фільтру.

Поле	Опис
`filter.Fragment`	Пошук за назвою або кодом банку (входження підрядка, без урахування регістру).
`filter.Archive`	Ознака архівності. Якщо не передати, за замовчуванням повертаються тільки активні банки (`false`).

Поля відповіді: Id, Name, Code, Memo, Void.

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

Назва методу створення: /api/v2/bank/add

Назва методу оновлення: /api/v2/bank/update

Методи приймають масив банків у полі array, пакетами до 100 елементів. Name обов’язкова, Id обов’язковий тільки для /api/v2/bank/update.

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

Видалення, архівування та відновлення банків

Банки входять до довідників з уніфікованим контрактом видалення й відновлення (/api/v2/bank/markasdelete і /api/v2/bank/restore). Повний опис формату запиту, відповіді та кодів відмов - у розділі Видалення, архівування та відновлення довідників.