QUINCE API. Статті руху коштів

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

Метод	Опис
`/api/v2/cash_flow_item/list`	Отримання списку статей руху коштів
`/api/v2/cash_flow_item/add`	Створення статей руху коштів
`/api/v2/cash_flow_item/update`	Оновлення статей руху коштів
`/api/v2/cash_flow_item/folder/list`	Отримання списку папок статей руху коштів

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

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

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

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

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

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

Поле	Опис
`Id`	Ідентифікатор статті.
`Name`	Назва статті.
`ParentElement`	Батьківський елемент.
`ParentFolder`	Ідентифікатор батьківської папки або `null` для першого рівня. Значення збігається з `ParentElement`; це поле дає єдину назву з іншими довідниками.
`PnlItem`	Пов’язана стаття P&L, якщо є.
`Income`	Ознака статті надходжень.
`Outgoing`	Ознака статті витрат.
`Moving`	Ознака статті переміщення коштів.
`Memo`	Коментар.
`IsFolder`	Ознака папки.
`Void`	Ознака архівності.

Створення статей руху коштів

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

Метод приймає масив статей у полі array. Поле Name є обов’язковим.

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

Поле	Опис
`array`	Масив статей. Обов’язковий.
`array[].Name`	Назва статті. Обов’язкова.
`array[].Income`	Ознака статті надходжень.
`array[].Outgoing`	Ознака статті витрат.
`array[].Moving`	Ознака статті переміщення коштів.
`array[].ParentElement`	Ідентифікатор батьківської статті.
`array[].PnlItem`	Ідентифікатор пов’язаної статті P&L.
`array[].Memo`	Коментар.
`array[].Void`	Ознака архівності.

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

{
  "array": [
    {
      "Name": "Оплата від клієнта",
      "Income": true,
      "Outgoing": false,
      "Moving": false,
      "Memo": "Основна стаття надходжень"
    }
  ]
}

Оновлення статей руху коштів

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

Метод приймає масив статей у полі array. Поле Id є обов’язковим. Якщо переданий Id не знайдено, API поверне success: false і список проблемних Id у data.

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

Поле	Опис
`array`	Масив статей. Обов’язковий.
`array[].Id`	Ідентифікатор статті. Обов’язковий.
`array[].Name`	Назва статті. Якщо передається, не може бути порожньою.
`array[].Income`	Ознака статті надходжень.
`array[].Outgoing`	Ознака статті витрат.
`array[].Moving`	Ознака статті переміщення коштів.
`array[].ParentElement`	Ідентифікатор батьківської статті.
`array[].PnlItem`	Ідентифікатор пов’язаної статті P&L.
`array[].Memo`	Коментар.
`array[].Void`	Ознака архівності.

Приклад відповіді для add/update

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

Папки статей руху коштів

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

Метод повертає тільки папки статей руху коштів. Фільтр filter.ParentFolder працює за загальним правилом з розділу Папки довідників.

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

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

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

Поле	Опис
`Id`	Ідентифікатор папки.
`Name`	Назва папки.
`ParentFolder`	Ідентифікатор батьківської папки або `null` для першого рівня.
`Void`	Ознака архівності.

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

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