Получение списка отчётных периодов

POST /v1/billing/period/list

POST/v1/billing/period/list

Возвращает список отчётных периодов витрины. Идентификатор закрытого (CLOSED) периода используется в последующих запросах на получение данных. Логистическая схема определяется на уровне отдельных операций и поэтому не указывается в запросе.

Тело запроса

status
array
Фильтр. Если поле фильтра не передано, равно null или передан пустой массив [], фильтрация по этому полю не применяется. При одновременном указании нескольких фильтров условия объединяются по AND.
Статус отчётного периода. OPEN: период существует, но состав ещё может меняться. CLOSED: витрина зафиксировала период; membership можно использовать для сверки.
cursor
string
Курсор следующей страницы.
limit
integer
Размер страницы. min = 1; max = 300; default = 100.

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

200Список доступных отчётных периодов и их `report_id`.
application/json
object
periods
array
required
Элементы списка. Недоступные отчётные периоды в ответ не возвращаются.
Отчётный период витрины и stable report_id для последующих запросов.
Показать свойства
report_id
string
required
Уникальный идентификатор отчётного периода.
period_from
string
required
Начало периода включительно.
period_to
string
required
Конец периода включительно.
status
string
required
Статус отчётного периода. OPEN: период существует, но состав ещё может меняться. CLOSED: витрина зафиксировала период; membership можно использовать для сверки.
Допустимые значения
OPENCLOSED
status_changed_at
string
required
Момент последнего изменения статуса периода. Формат RFC3339 с обязательным timezone (пример: 2026-07-02T10:25:00+02:00). Несоблюдение формата может привести к непредсказуемому поведению системы и проблемам со сверкой.
next_cursor
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
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/period/list
1curl https://api.omninet.ru/v1/billing/period/list \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "status": [6    "string"7  ],8  "cursor": "string",9  "limit": 10010}'
{
  "periods": [
    {
      "report_id": "string",
      "period_from": "string",
      "period_to": "string",
      "status": "string",
      "status_changed_at": "string"
    }
  ],
  "next_cursor": "string"
}

Список доступных отчётных периодов и их `report_id`.