Skip to main content
GET
Get general

Авторизации

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

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

agent
integer
end_at
string<date>

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

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

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

start_at
string<date>

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

status
enum<integer>
  • 0 - Выплачено
  • 1 - Ожидает
Доступные опции:
0,
1

Ответ

200 - application/json
referral_count
integer
обязательно
referral_sum
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
referral_avg
string<decimal>
обязательно
Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$