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)
valuestringnull мәнін қабылдай алады

Мысал: 2026-08-01 00:00:00

typestringміндетті

Мысал: date

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

date_toobject (FilterDateTo)
valuestringnull мәнін қабылдай алады

Мысал: 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)

Фильтр-тізім — enum мәндерінің жазық тізімі

valuestring

Мысал: example

typestringміндетті

Мысал: select

optionarray of string
modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

serviceobject (FilterEnum)

Фильтр-тізім — enum мәндерінің жазық тізімі

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