Получение сведений об отчётном периоде

POST /v1/billing/report/get

POST/v1/billing/report/get

Возвращает сведения об отчётном периоде, включая его текущее состояние, сумму отчёта (amount), схему расчётов, номер платёжного поручения (payment_order_number) и историю изменения статусов. Направление платежа определяется схемой расчётов. Номер платёжного поручения относится к полной сумме расчёта.

Тело запроса

report_id
string
required
Уникальный идентификатор отчётного периода.

Успешный ответ

200Состояние отчёта, сумма, схема платежа и история переходов.
application/json
object
report_id
string
required
Уникальный идентификатор отчётного периода.
period_from
string
required
Начало отчётного периода.
period_to
string
required
Конец отчётного периода.
scheme
string
required
Схема расчётов определяет направление платежа и участника, для которого формируется событие PAYMENT_RECEIVED. platform_payout — платёж выполняется витриной в пользу платформы. platform_invoice — платёж выполняется витриной в пользу мерчанта по счёту платформы. platformless — платёж выполняется витриной непосредственно в пользу мерчанта.
Допустимые значения
platform_payoutplatform_invoiceplatformless
state
string
required
Статус отчётного периода, отражающий его жизненный цикл. Возможные значения: DRAFT — черновик; IN_REVIEW_BY_STOREFRONT — на проверке у витрины; APPROVED_BY_STOREFRONT — одобрен витриной; IN_REVIEW_BY_MERCHANT — на проверке у мерчанта; APPROVED_BY_MERCHANT — одобрен мерчантом; DISPUTED_BY_MERCHANT — оспорен мерчантом; AGREED — согласован; SIGNED — подписан; PAYMENT_ORDER_CREATED — платёжное поручение создано; PAID — оплачен; PAYMENT_RECEIVED — поступление платежа подтверждено.
Допустимые значения
DRAFTIN_REVIEW_BY_STOREFRONTAPPROVED_BY_STOREFRONTIN_REVIEW_BY_MERCHANTAPPROVED_BY_MERCHANTDISPUTED_BY_MERCHANTAGREEDSIGNEDPAYMENT_ORDER_CREATEDPAIDPAYMENT_RECEIVED
state_changed_at
string
required
Момент последнего изменения состояния отчёта. Формат RFC3339 с обязательным timezone (пример: 2026-07-02T10:25:00+02:00). Несоблюдение формата может привести к непредсказуемому поведению системы и проблемам со сверкой.
payment_order_number
string
Номер платёжного поручения.
amount
object
required
Сумма отчета.
Показать свойства
value
integer
required
Значение суммы, умноженное на 100.
currency_code
string
required
Код валюты в формате ISO-like, ожидаемо RUB для текущего scope.
status_history
array
required
История статусов.
Запись истории перехода отчёта.
Показать свойства
at
string
required
Дата изменения. Формат RFC3339 с обязательным timezone (пример: 2026-07-02T10:25:00+02:00). Несоблюдение формата может привести к непредсказуемому поведению системы и проблемам со сверкой.
from_state
string
required
ReportStateValue
Допустимые значения
DRAFTIN_REVIEW_BY_STOREFRONTAPPROVED_BY_STOREFRONTIN_REVIEW_BY_MERCHANTAPPROVED_BY_MERCHANTDISPUTED_BY_MERCHANTAGREEDSIGNEDPAYMENT_ORDER_CREATEDPAIDPAYMENT_RECEIVED
to_state
string
required
ReportStateValue
Допустимые значения
DRAFTIN_REVIEW_BY_STOREFRONTAPPROVED_BY_STOREFRONTIN_REVIEW_BY_MERCHANTAPPROVED_BY_MERCHANTDISPUTED_BY_MERCHANTAGREEDSIGNEDPAYMENT_ORDER_CREATEDPAIDPAYMENT_RECEIVED
actor
string
required
Автор изменений. STOREFRONT: витрина. MERCHANT: мерчант. PLATFORM: платформа.
Допустимые значения
STOREFRONTMERCHANTPLATFORM
comment
string
Комментарий (опционально).

Ошибки

400Некорректный запрос
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
401Ошибка авторизации
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
404Отчёт не найден или недоступен текущему caller.
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
429Превышен лимит запросов
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
500Внутренняя ошибка сервера
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
defaultОшибка (неожиданная или прочие)
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
POST/v1/billing/report/get
1curl https://api.omninet.ru/v1/billing/report/get \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "report_id": "string"6}'
{
  "report_id": "string",
  "period_from": "string",
  "period_to": "string",
  "scheme": "string",
  "state": "string",
  "state_changed_at": "string",
  "payment_order_number": "string",
  "amount": {
    "value": 44350,
    "currency_code": "RUB"
  },
  "status_history": [
    {
      "at": "string",
      "from_state": "string",
      "to_state": "string",
      "actor": "string",
      "comment": "string"
    }
  ]
}

Состояние отчёта, сумма, схема платежа и история переходов.