Skip to main content
GET
Get amount

Авторизации

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 доступа к данным не даёт. Без заголовка компания определяется по домену запроса.

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

autorenewal
boolean
client
integer
client__in
integer[]

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

client__signed
boolean
client__type
enum<integer>
  • 0 - Физ. лицо
  • 1 - Юр. лицо
Доступные опции:
0,
1
date
string<date>
default_tarif_period
integer
default_tarif_period__in
integer[]

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

deleted
boolean
end_at
string<date>

Конец отчётного периода, включительно. Дата (ГГГГ-ММ-ДД) или момент времени, от которого берётся дата.

group
number
has_delivery
boolean
id
integer
id__in
integer[]

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

inventory
number
payment_status
enum<integer>
  • 0 - Ожидается оплата
  • 1 - Оплата произведена
  • 2 - Частичная оплата
Доступные опции:
0,
1,
2
payment_status__in
integer[]

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

plus_id
integer
rent_end_from
string<date>
rent_end_to
string<date>
rent_start_from
string<date>
rent_start_to
string<date>
rental_point
integer

A search term.

start_at
string<date>

Начало отчётного периода, включительно. Дата (ГГГГ-ММ-ДД) или момент времени, от которого берётся дата.

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

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

Ответ

200 - application/json
price_sum
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
price_discount_sum
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
tax_amount_sum
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
paid_amount_sum
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
debt_amount_sum
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
deposit_total_sum
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
deposit_held_sum
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
deposit_due_sum
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$