API

Получить отчёты

GET/api/crm/v2/reportsv2
operationId: reports.default

Возвращает отчёты по операциям. С download=yes выборка возвращается CSV-файлом.

Авторизация

api-token + language + role

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

page_numberinteger

Пример: 1

date_fromstring

Пример: 25/04/2024

date_tostring

Пример: 26/04/2024

chain_idinteger

Пример: 7142

branch_idinteger
order_numberinteger

Пример: 8

typestring

Значения:annulrefundaccrualwithdraw

Пример: annul

serviceoneOf
Один из вариантов
integer
downloadstring

Передайте yes, чтобы скачать выборку файлом CSV

Значения:yes

Пример: yes

Ответы

OK

object
statusstringобязательный

Значения:successerror

Пример: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringможет быть null

Пример: 2026-08-01 00:00:00

typestringобязательный

Пример: date

modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

date_toobject (FilterDateTo)
valuestringможет быть null

Пример: 2026-08-31 23:59:59

typestringобязательный

Пример: date

modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

date_rangeobject (FilterDateRange)

Готовые периоды фильтра по дате; нижняя граница рассчитана в часовом поясе пользователя. value — период, которому соответствуют текущие *_from и *_to; null — произвольный период. default — период, который сервер подставляет в запрос без дат: он же применяется при первой загрузке раздела, и к нему возвращает сброс. Верхняя граница периода всегда равна текущему дню пользователя, поэтому option её не содержит: передавать *_to для готового периода не нужно, сервер задаёт её сам. Период длиннее года обрезается со стороны свежей границы.

valuestring (DateRange) может быть null

Готовый период фильтра по дате. Своего параметра запроса у него нет: нижняя граница приходит уже рассчитанной в option и подставляется в *_from. Верхняя граница не передаётся ни в ответе, ни в запросе — она всегда равна текущему дню пользователя и задаётся сервером.

Значения:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Пример: today

defaultstring (DateRange) обязательный

Готовый период фильтра по дате. Своего параметра запроса у него нет: нижняя граница приходит уже рассчитанной в option и подставляется в *_from. Верхняя граница не передаётся ни в ответе, ни в запросе — она всегда равна текущему дню пользователя и задаётся сервером.

Значения:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Пример: today

typestringобязательный

Пример: select

modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

optionarray of objectобязательный
valuestring (DateRange) обязательный

Готовый период фильтра по дате. Своего параметра запроса у него нет: нижняя граница приходит уже рассчитанной в option и подставляется в *_from. Верхняя граница не передаётся ни в ответе, ни в запросе — она всегда равна текущему дню пользователя и задаётся сервером.

Значения:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Пример: today

date_fromstringобязательный

Пример: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Пример: 8920

typestringобязательный

Пример: select

optionarray of object
valueintegerобязательный

Пример: 8920

namestringобязательный

Пример: Green Basket | Kaliningrad

modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Пример: 8920

typestringобязательный

Пример: select

optionarray of object
valueintegerобязательный

Пример: 8920

namestringобязательный

Пример: Green Basket | Kaliningrad

modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

order_numberobject (FilterId)
valueany

Пример: 0

typestringобязательный

Пример: integer

placeholderstring

Пример: integer

modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

typeobject (FilterEnum)

Фильтр-перечисление — плоский список значений перечисления

valuestring

Пример: example

typestringобязательный

Пример: select

optionarray of string
modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

serviceobject (FilterEnum)

Фильтр-перечисление — плоский список значений перечисления

valuestring

Пример: example

typestringобязательный

Пример: select

optionarray of string
modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

downloadobject (FilterButtonDownloadCsv)

Кнопка скачивания выборки: при нажатии передайте download=yes

valuestring

Пример: Download

typestringобязательный

Пример: button_download_csv

listarray of object
idintegerобязательный

Пример: 9867834

branch_sumnumberобязательный

Пример: 100.55

branch_idintegerобязательный

Пример: 8783

chain_coefficientnumberобязательный

Пример: 0.04

account_balancenumberобязательный

Пример: 100.55

typestring (TypeReports) обязательный

Значения:annulrefundaccrualwithdraw

Пример: accrual

datestring (DataTimeFormat) обязательный

Пример: 17:45 06/05/2024

descriptionstring

Пример: text

city_namestringобязательный

Пример: Voronezh

chain_namestringобязательный

Пример: Green Basket | Main

account_idintegerобязательный

Пример: 5828

paginationobject (Pagination)
max_countintegerобязательный

Количество элементов на странице

Пример: 30

page_numberintegerобязательный

Номер текущей страницы; ограничен так, чтобы смещение не превышало 1000

Пример: 1

has_nextbooleanобязательный

Есть ли следующая страница

Пример: true

has_previousbooleanобязательный

Есть ли предыдущая страница

Пример: false