Справочник API

Платежи по броням отдела, только чтение


Платежи брони

GET
https://partners.zvezdnyy-burabai.edu.kz/ext/v1
/bookings/{id}/payments

Все платежи брони, включая возвраты. «Оплачено» по брони — их сумма.

Платежи брони › path Parameters

id
​string · required

Номер брони

Платежи брони › query Parameters

cursor
​string

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

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

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

Default: 50

Платежи брони › Responses

Готово

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

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


Платежи отдела

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

Все платежи по броням вашего отдела, по возрастанию номера.

Платежи отдела › query Parameters

paid_from
​string · date

Только оплаченные в этот день и позже, по paid_on (ГГГГ-ММ-ДД)

updated_since
​string · date-time

Только изменённые не раньше этого времени (RFC 3339), например сверенные бухгалтерией. Берите время с запасом в минуту

cursor
​string

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

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

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

Default: 50

Платежи отдела › Responses

Готово

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

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


Платёж

GET
https://partners.zvezdnyy-burabai.edu.kz/ext/v1
/payments/{id}

Платёж › path Parameters

id
​string · required

Номер платежа

Платёж › Responses

Готово

​Money · required

Сумма. Возврат — отрицательной суммой

bank
​string · required

Банк, как его записал лагерь

booking_id
​string · required
created_at
​string · date-time · required
id
​string · required
​LegalEntity · required

Юрлицо лагеря, на которое пришли деньги. У оплаты счёта Kaspi — юрлицо кассы, через которую счёт выставлен (у лагеря их несколько, и касса переключается). Возврат делается с этого же юрлица

paid_on
​string · date · required

День оплаты по календарю лагеря (дата, без времени)

source
​string · required

Откуда платёж: kaspi_invoice — оплата счёта Kaspi, manual — внесён лагерем. Список может пополняться

type
​string · required

prepayment — предоплата, payment — оплата, refund — возврат. Список может пополняться

verified
​boolean · required

Сверен бухгалтерией лагеря с выпиской банка. Остаток по брони уменьшает и несверенный платёж

version
​string · required

Версия записи: меняется при каждом изменении платежа

invoice_id
​string | null

Счёт Kaspi, оплатой которого создан платёж

method
​string | null

Как заплатили: kaspi_transfer — перевод на Kaspi лагеря, bank_transfer — банковский перевод, cash — наличные, kaspi_invoice — счёт Kaspi. null — не указано (записи до этого поля). Список может пополняться

​StatementLineRef | null

Строка выписки банка, с которой бухгалтерия лагеря сверила платёж. Есть только у сверенного (verified) платежа