Справочник API

Продажи и квоты, долги, снятые по неоплате, сверка


Сверка броней

GET
https://partners.zvezdnyy-burabai.edu.kz/ext/v1
/reconcile/bookings

Все брони вашего отдела (и отменённые) — номер, статус и версия, большими порциями. Раз в сутки сравните со своей базой: чего у вас нет или где версия другая — перечитайте. Так находится всё, что разошлось, даже если события потерялись. Тяжёлый запрос.

Сверка броней › query Parameters

cursor
​string

Курсор из next_cursor прошлого ответа

limit
​integer · int64 · min: 1 · max: 5000

Сколько записей вернуть, 1–5000, по умолчанию 1000

Default: 1000

Сверка броней › Responses

Готово

Порция списка. `next_cursor` пуст — дальше ничего нет.
​BookingVersion[] · required
next_cursor
​string | null

Передать в cursor, чтобы получить следующую порцию


Долги

GET
https://partners.zvezdnyy-burabai.edu.kz/ext/v1
/reports/debts

Активные брони отдела, по которым оплачено меньше суммы к оплате. Тяжёлый запрос.

Долги › query Parameters

shift_id
​string

Только смена

overdue
​boolean

Только просроченные

cursor
​string

Курсор из next_cursor прошлого ответа

limit
​integer · int64 · min: 1 · max: 200

Сколько записей вернуть, 1–200, по умолчанию 50

Default: 50

Долги › Responses

Готово

Порция списка. `next_cursor` пуст — дальше ничего нет.
​Debt[] · required
next_cursor
​string | null

Передать в cursor, чтобы получить следующую порцию


Продажи и квоты по сменам

GET
https://partners.zvezdnyy-burabai.edu.kz/ext/v1
/reports/shifts

По каждой смене (кроме черновиков): квота отдела, занято, свободно, продано, оплачено, долг. Тяжёлый запрос.

Продажи и квоты по сменам › query Parameters

season_id
​string

Сезон. Пусто — действующие сезоны

Продажи и квоты по сменам › Responses

Готово

Отчёт по сменам — все смены одним ответом, без порций: их десятки.
​ShiftSales[] · required

Снятые по неоплате

GET
https://partners.zvezdnyy-burabai.edu.kz/ext/v1
/reports/unpaid

Брони, отменённые автоматически: минимальный платёж не пришёл за сутки. Готовый список на обзвон — узнать, почему не оплатили. Тяжёлый запрос.

Снятые по неоплате › query Parameters

hold_until_from
​string · date-time

Только брони, чьё удержание места (hold_until) истекло не раньше этого времени (RFC 3339)

cursor
​string

Курсор из next_cursor прошлого ответа

limit
​integer · int64 · min: 1 · max: 200

Сколько записей вернуть, 1–200, по умолчанию 50

Default: 50

Снятые по неоплате › Responses

Готово

Порция списка. `next_cursor` пуст — дальше ничего нет.
​Unpaid[] · required
next_cursor
​string | null

Передать в cursor, чтобы получить следующую порцию