Статті руху грошей

Список статей руху грошей

Отримати список статей руху грошей

GET /api/cashFlows{?active,order,filters,ids_list,offset,limit,unprotect_keys}

Параметри

Параметр	Тип	Обов’язковий	Опис
active	string	ні	Якщо параметр дорівнює “true”, то повертаються лише активні записи.
order	string	ні	Список полів сортування через кому без пробілів
ids_list	string	ні	Список значень ключового поля записів, які потрібно повернути. Зазначається через кому без пробілу
filters	string	ні	Текстові фільтри у форматі: field_name:: |field_name1::
offset	number	ні	Повертати дані, починаючи з указаного номера запису
limit	number	ні	Повертати вказану кількість записів

Відповідь 200 (application/json)

[
  {
    "id_article": 15,
    "name_cash_flow": "Инкассация в основную кассу",
    "type_cash_flow": 1,
    "active": true
  }
]

Додати статтю руху грошей

POST /api/cashFlows{?active,order,filters,ids_list,offset,limit,unprotect_keys}

• Атрибут unprotect_keys=true і значення id_article у тілі запиту вказувати обовʼязково. Значення ключа id_article автоматично не генерується при створенні запису.

Параметри

Параметр	Тип	Обов’язковий	Опис
unprotect_keys	string	ні	Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Заголовки запиту:

• Content-Type: application/json

Тіло запиту:

{
  "id_article": 15,
  "name_cash_flow": "Инкассация в основную кассу",
  "type_cash_flow": 1,
  "active": true
}

Відповідь 201 (application/json)

{
  "id_article": 15,
  "name_cash_flow": "Инкассация в основную кассу",
  "type_cash_flow": 1,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_article": {
      "type": "number"
    },
    "name_cash_flow": {
      "type": "string"
    },
    "type_cash_flow": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_article",
    "name_cash_flow",
    "type_cash_flow",
    "active"
  ]
}

Кількість статей руху грошей

Отримати кількість статей руху грошей

GET /api/cashFlows/count{?filters,ids_list,active}

Параметри

Параметр	Тип	Обов’язковий	Опис
ids_list	string	ні	Список значень ключового поля записів, які потрібно повернути. Зазначається через кому без пробілу
filters	string	ні	Текстові фільтри у форматі: field_name:: |field_name1::
active	string	ні	Якщо параметр дорівнює “true”, то враховуються лише активні записи.

Відповідь 200 (application/json)

{
  "count": 10
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number"
    }
  },
  "required": [
    "count"
  ]
}

Стаття руху грошей

Отримати дані про статтю руху грошей

GET /api/cashFlows/{id_article}/{?unprotect_keys}

Параметри

Параметр	Тип	Обов’язковий	Опис
id_article	number	так	Ідентифікатор статті руху грошей

Відповідь 200 (application/json)

{
  "id_article": 15,
  "name_cash_flow": "Инкассация в основную кассу",
  "type_cash_flow": 1,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_article": {
      "type": "number"
    },
    "name_cash_flow": {
      "type": "string"
    },
    "type_cash_flow": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_article",
    "name_cash_flow",
    "type_cash_flow",
    "active"
  ]
}

Змінити дані про статтю руху грошей

PUT /api/cashFlows/{id_article}/{?unprotect_keys}

Параметри

Параметр	Тип	Обов’язковий	Опис
id_article	number	так	Ідентифікатор валюти
unprotect_keys	string	ні	Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Заголовки запиту:

• Content-Type: application/json

Тіло запиту:

{
  "id_article": 15,
  "name_cash_flow": "Инкассация в основную кассу",
  "type_cash_flow": 1,
  "active": true
}

Відповідь 200 (application/json)

{
  "id_article": 15,
  "name_cash_flow": "Инкассация в основную кассу",
  "type_cash_flow": 1,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_article": {
      "type": "number"
    },
    "name_cash_flow": {
      "type": "string"
    },
    "type_cash_flow": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_article",
    "name_cash_flow",
    "type_cash_flow",
    "active"
  ]
}

Деактивувати дані про статтю руху грошей

DELETE /api/cashFlows/{id_article}/{?unprotect_keys}

Параметри

Параметр	Тип	Обов’язковий	Опис
id_article	number	так	Ідентифікатор валюти

Відповідь 204