Skip to main content
GET
Get cashflow

Авторизации

Authorization
string
header
обязательно

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Заголовки

X-Tenant-Id
integer

Компания, в контексте которой выполняется запрос — её id из GET /v1/tenant/. Пользователь должен состоять в этой компании: чужой id доступа к данным не даёт. Без заголовка компания определяется по домену запроса.

Параметры запроса

account
integer
category
integer
category__in
integer[]

Несколько значений могут быть разделены запятыми.

choice
enum<string>
  • credit - credit
  • debit - debit
  • exchange - exchange
Доступные опции:
credit,
debit,
exchange
created_by
integer
created_by__in
integer[]

Несколько значений могут быть разделены запятыми.

end_at
string<date>
maintenance__isnull
boolean
method
enum<integer>
  • 0 - Приход
  • 1 - Расход
Доступные опции:
0,
1
method__in
integer[]

Несколько значений могут быть разделены запятыми.

rental_point
number
request__client
integer
request__client__in
integer[]

Несколько значений могут быть разделены запятыми.

request__isnull
boolean
request__rental_point
integer
request__rental_point__in
integer[]

Несколько значений могут быть разделены запятыми.

request__status
enum<integer>
  • 0 - Запрос
  • 1 - Забронировано
  • 2 - В аренде
  • 3 - Отменено
  • 4 - Завершено
  • 5 - Должник
  • 6 - Просрочка
Доступные опции:
0,
1,
2,
3,
4,
5,
6
request__status__in
integer[]

Несколько значений могут быть разделены запятыми.

sale__isnull
boolean

A search term.

start_at
string<date>
statement__counterparty
integer
statement__counterparty__in
integer[]

Несколько значений могут быть разделены запятыми.

statement__inventory
integer
statement__inventory__in
integer[]

Несколько значений могут быть разделены запятыми.

statement__inventory__rental_point
integer
statement__inventory__rental_point__in
integer[]

Несколько значений могут быть разделены запятыми.

statement__isnull
boolean
statement_end_at
string<date>
statement_start_at
string<date>
status
enum<string>
  • pending - Ожидает оплаты
  • success - Успешно
  • failure - Ошибка
  • expired - Истёк срок
Доступные опции:
expired,
failure,
pending,
success
status__in
string[]

Несколько значений могут быть разделены запятыми.

tags
integer[]

Несколько значений могут быть разделены запятыми.

type
integer
type__in
integer[]

Несколько значений могут быть разделены запятыми.

workshop__isnull
boolean

Ответ

200 - application/json
year
integer
обязательно
month
integer
обязательно
incomes
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
incomes_request
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
incomes_sale
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
incomes_workshop
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
incomes_maintenance
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
incomes_deposit
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
expenses_deposit
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
deposit_charged
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
incomes_bonus
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
expenses
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
categories
string
обязательно
read-only
saldo
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
start_balance
string
обязательно
read-only
end_balance
string
обязательно
read-only