API

Saada aruanded

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

Tagastab tehinguaruanded. Kui download=yes, tagastatakse andmed CSV-failina.

Autoriseerimine

api-token + language + role

Päringu parameetrid

page_numberinteger

Näide: 1

date_fromstring

Näide: 25/04/2024

date_tostring

Näide: 26/04/2024

chain_idinteger

Näide: 7142

branch_idinteger
order_numberinteger

Näide: 8

typestring

Väärtused:annulrefundaccrualwithdraw

Näide: annul

serviceoneOf
Üks variantidest
integer
downloadstring

Edastage yes, et laadida valim alla CSV-failina

Väärtused:yes

Näide: yes

Vastused

OK

object
statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringvõib olla null

Näide: 2026-08-01 00:00:00

typestringkohustuslik

Näide: date

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

date_toobject (FilterDateTo)
valuestringvõib olla null

Näide: 2026-08-31 23:59:59

typestringkohustuslik

Näide: date

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

date_rangeobject (FilterDateRange)

Valmis kuupäevafiltri perioodid; alumine piir arvutatakse kasutaja ajavööndi järgi. value — periood, millele vastavad praegused *_from ja *_to; null — suvaline periood. default — periood, mille server lisab päringusse ilma kuupäevadeta: seda kasutatakse ka jaotise esmasel laadimisel ning lähtestamisel. Perioodi ülemine piir on alati kasutaja tänane päev, seetõttu option seda ei sisalda: valmisperioodi puhul pole vaja *_to edastada, server määrab selle ise. Üle aasta pikkune periood kärbitakse uuema piiri poolt.

valuestring (DateRange) võib olla null

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

defaultstring (DateRange) kohustuslik

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

typestringkohustuslik

Näide: select

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

optionarray of objectkohustuslik
valuestring (DateRange) kohustuslik

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

date_fromstringkohustuslik

Näide: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

order_numberobject (FilterId)
valueany

Näide: 0

typestringkohustuslik

Näide: integer

placeholderstring

Näide: integer

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

typeobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

optionarray of string
modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

serviceobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

optionarray of string
modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

downloadobject (FilterButtonDownloadCsv)

Allalaadimisnupp: vajutamisel edastage download=yes

valuestring

Näide: Download

typestringkohustuslik

Näide: button_download_csv

listarray of object
idintegerkohustuslik

Näide: 9867834

branch_sumnumberkohustuslik

Näide: 100.55

branch_idintegerkohustuslik

Näide: 8783

chain_coefficientnumberkohustuslik

Näide: 0.04

account_balancenumberkohustuslik

Näide: 100.55

typestring (TypeReports) kohustuslik

Väärtused:annulrefundaccrualwithdraw

Näide: accrual

datestring (DataTimeFormat) kohustuslik

Näide: 17:45 06/05/2024

descriptionstring

Näide: text

city_namestringkohustuslik

Näide: Voronezh

chain_namestringkohustuslik

Näide: Green Basket | Main

account_idintegerkohustuslik

Näide: 5828

paginationobject (Pagination)
max_countintegerkohustuslik

Elementide arv lehel

Näide: 30

page_numberintegerkohustuslik

Praeguse lehekülje number; piiratud nii, et nihe ei ületaks 1000

Näide: 1

has_nextbooleankohustuslik

Kas on järgmine lehekülg

Näide: true

has_previousbooleankohustuslik

Kas eelmine lehekülg on olemas

Näide: false