API

Hesabatları əldə et

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

Əməliyyatlar üzrə hesabatları qaytarır. download=yes ilə sorğu CSV faylı kimi qaytarılır.

Avtorizasiya

api-token + language + role

Sorğu parametrləri

page_numberinteger

Nümunə: 1

date_fromstring

Nümunə: 25/04/2024

date_tostring

Nümunə: 26/04/2024

chain_idinteger

Nümunə: 7142

branch_idinteger
order_numberinteger

Nümunə: 8

typestring

Dəyərlər:annulrefundaccrualwithdraw

Nümunə: annul

serviceoneOf
Variantlardan biri
integer
downloadstring

yes göndərin ki, seçimi CSV faylı kimi yükləyəsiniz

Dəyərlər:yes

Nümunə: yes

Cavablar

OK

object
statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringnull ola bilər

Nümunə: 2026-08-01 00:00:00

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_toobject (FilterDateTo)
valuestringnull ola bilər

Nümunə: 2026-08-31 23:59:59

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_rangeobject (FilterDateRange)

Hazır tarix aralığı filtrləri; aşağı sərhəd istifadəçinin saat qurşağında hesablanır. value — cari *_from və *_to-ya uyğun olan aralıq; null — istənilən aralıq. default — serverin tarixsiz sorğuda təyin etdiyi aralıq: həmçinin bölmə ilk dəfə yüklənəndə və sıfırlama zamanı tətbiq olunur. Aralığın yuxarı sərhədi həmişə istifadəçinin cari gününə bərabərdir, buna görə option onu ehtiva etmir: hazır aralıq üçün *_to göndərmək lazım deyil, server onu özü təyin edir. Bir ildən uzun aralıq yeni sərhəd tərəfindən kəsilir.

valuestring (DateRange) null ola bilər

Hazır tarix aralığı filtri. Bunun üçün ayrıca sorğu parametri yoxdur: aşağı sərhəd artıq hesablanmış şəkildə option daxilində gəlir və *_from sahəsinə əlavə olunur. Yuxarı sərhəd nə cavabda, nə də sorğuda ötürülmür — o, həmişə istifadəçinin cari gününə bərabərdir və server tərəfindən təyin olunur.

Dəyərlər:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Nümunə: today

defaultstring (DateRange) mütləq

Hazır tarix aralığı filtri. Bunun üçün ayrıca sorğu parametri yoxdur: aşağı sərhəd artıq hesablanmış şəkildə option daxilində gəlir və *_from sahəsinə əlavə olunur. Yuxarı sərhəd nə cavabda, nə də sorğuda ötürülmür — o, həmişə istifadəçinin cari gününə bərabərdir və server tərəfindən təyin olunur.

Dəyərlər:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Nümunə: today

typestringmütləq

Nümunə: select

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

optionarray of objectmütləq
valuestring (DateRange) mütləq

Hazır tarix aralığı filtri. Bunun üçün ayrıca sorğu parametri yoxdur: aşağı sərhəd artıq hesablanmış şəkildə option daxilində gəlir və *_from sahəsinə əlavə olunur. Yuxarı sərhəd nə cavabda, nə də sorğuda ötürülmür — o, həmişə istifadəçinin cari gününə bərabərdir və server tərəfindən təyin olunur.

Dəyərlər:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Nümunə: today

date_fromstringmütləq

Nümunə: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object
valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object
valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

order_numberobject (FilterId)
valueany

Nümunə: 0

typestringmütləq

Nümunə: integer

placeholderstring

Nümunə: integer

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

typeobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string
modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

serviceobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string
modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

downloadobject (FilterButtonDownloadCsv)

Seçimi yükləmə düyməsi: basıldıqda download=yes göndərin

valuestring

Nümunə: Download

typestringmütləq

Nümunə: button_download_csv

listarray of object
idintegermütləq

Nümunə: 9867834

branch_sumnumbermütləq

Nümunə: 100.55

branch_idintegermütləq

Nümunə: 8783

chain_coefficientnumbermütləq

Nümunə: 0.04

account_balancenumbermütləq

Nümunə: 100.55

typestring (TypeReports) mütləq

Dəyərlər:annulrefundaccrualwithdraw

Nümunə: accrual

datestring (DataTimeFormat) mütləq

Nümunə: 17:45 06/05/2024

descriptionstring

Nümunə: text

city_namestringmütləq

Nümunə: Voronezh

chain_namestringmütləq

Nümunə: Green Basket | Main

account_idintegermütləq

Nümunə: 5828

paginationobject (Pagination)
max_countintegermütləq

Səhifədəki elementlərin sayı

Nümunə: 30

page_numberintegermütləq

Cari səhifənin nömrəsi; offset 1000-dən çox olmamaqla məhdudlaşdırılıb

Nümunə: 1

has_nextbooleanmütləq

Növbəti səhifə varmı

Nümunə: true

has_previousbooleanmütləq

Əvvəlki səhifə mövcuddurmu

Nümunə: false