QUINCE API. Статті P&L

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

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

Статті P&L використовуються у звіті P&L (Прибутки і збитки) і можуть бути пов’язані зі статтями руху коштів - див. поле PnlItem у статті Статті руху коштів.

Отримання списку статей P&L

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

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

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

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

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

Поле	Опис
`Id`	Ідентифікатор статті.
`Name`	Назва статті.
`ParentElement`	Батьківський елемент.
`ParentFolder`	Ідентифікатор батьківської папки або `null` для першого рівня. Значення збігається з `ParentElement`; це поле дає єдину назву з іншими довідниками.
`PnlItemType`	Ідентифікатор типу статті P&L.
`PnlItemTypeName`	Назва типу статті P&L.
`PnlItemTypeKind`	Різновид типу статті P&L.
`PnlItemSubType`	Підтип статті.
`IsSystem`	Ознака системної статті. Системні статті не можна редагувати або видаляти.
`Memo`	Коментар.
`IsFolder`	Ознака папки.
`Void`	Ознака архівності.

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

{
  "filter": {
    "Archive": false
  },
  "page": 1
}

Створення статей P&L

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

Метод приймає масив статей у полі array. Поле Name є обов’язковим. Метод створює тільки прості статті (без папок); IsFolder завжди дорівнює 0.

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

Поле	Опис
`array`	Масив статей. Обов’язковий.
`array[].Name`	Назва статті. Обов’язкова.
`array[].PnlItemType`	Ідентифікатор типу статті P&L.
`array[].Memo`	Коментар.
`array[].Void`	Ознака архівності.

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

{
  "array": [
    {
      "Name": "Комісія маркетплейсу",
      "PnlItemType": 5,
      "Memo": "Витрати на комісію торгового майданчика"
    }
  ]
}

Оновлення статей P&L

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

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

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

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

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

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

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

Статті P&L входять до довідників з уніфікованим контрактом видалення й відновлення. Повний опис формату запиту, відповіді та кодів відмов - у розділі Видалення, архівування та відновлення довідників.

/api/v2/pnl_item/markasdelete - видаляє статтю або переводить її в архів (Void = true), якщо вона вже використовується. Системну статтю (IsSystem: true) видалити не можна - відмова з кодом SYSTEM_ITEM.
/api/v2/pnl_item/restore - знімає позначку архівності.