API

Mendapatkan laporan

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

Mengembalikan laporan berdasarkan operasi. Dengan download=yes, hasil dikembalikan sebagai file CSV.

Otorisasi

api-token + language + role

Parameter permintaan

page_numberinteger

Contoh: 1

date_fromstring

Contoh: 25/04/2024

date_tostring

Contoh: 26/04/2024

chain_idinteger

Contoh: 7142

branch_idinteger
order_numberinteger

Contoh: 8

typestring

Nilai:annulrefundaccrualwithdraw

Contoh: annul

serviceoneOf
Salah satu pilihan
integer
downloadstring

Kirimkan yes untuk mengunduh data sebagai file CSV

Nilai:yes

Contoh: yes

Tanggapan

OK

object
statusstringwajib

Nilai:successerror

Contoh: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringdapat bernilai null

Contoh: 2026-08-01 00:00:00

typestringwajib

Contoh: date

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

date_toobject (FilterDateTo)
valuestringdapat bernilai null

Contoh: 2026-08-31 23:59:59

typestringwajib

Contoh: date

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

date_rangeobject (FilterDateRange)

Periode filter tanggal yang sudah jadi; batas bawah dihitung berdasarkan zona waktu pengguna. value — periode yang sesuai dengan *_from dan *_to saat ini; null — periode kustom. default — periode yang akan diisi server dalam permintaan tanpa tanggal: juga digunakan saat pertama kali membuka bagian, dan saat reset kembali ke periode ini. Batas atas periode selalu sama dengan hari saat ini pengguna, sehingga option tidak menyertakannya: tidak perlu mengirimkan *_to untuk periode siap pakai, server akan menetapkannya secara otomatis. Periode yang lebih dari satu tahun akan dipotong dari sisi batas terbaru.

valuestring (DateRange) dapat bernilai null

Periode filter tanggal yang sudah siap. Tidak memiliki parameter permintaan sendiri: batas bawah sudah dihitung di option dan dimasukkan ke *_from. Batas atas tidak dikirimkan baik dalam respons maupun permintaan — selalu sama dengan hari ini menurut pengguna dan ditetapkan oleh server.

Nilai:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Contoh: today

defaultstring (DateRange) wajib

Periode filter tanggal yang sudah siap. Tidak memiliki parameter permintaan sendiri: batas bawah sudah dihitung di option dan dimasukkan ke *_from. Batas atas tidak dikirimkan baik dalam respons maupun permintaan — selalu sama dengan hari ini menurut pengguna dan ditetapkan oleh server.

Nilai:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Contoh: today

typestringwajib

Contoh: select

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

optionarray of objectwajib
valuestring (DateRange) wajib

Periode filter tanggal yang sudah siap. Tidak memiliki parameter permintaan sendiri: batas bawah sudah dihitung di option dan dimasukkan ke *_from. Batas atas tidak dikirimkan baik dalam respons maupun permintaan — selalu sama dengan hari ini menurut pengguna dan ditetapkan oleh server.

Nilai:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Contoh: today

date_fromstringwajib

Contoh: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object
valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object
valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

order_numberobject (FilterId)
valueany

Contoh: 0

typestringwajib

Contoh: integer

placeholderstring

Contoh: integer

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

typeobject (FilterEnum)

Filter enum — daftar nilai enum datar

valuestring

Contoh: example

typestringwajib

Contoh: select

optionarray of string
modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

serviceobject (FilterEnum)

Filter enum — daftar nilai enum datar

valuestring

Contoh: example

typestringwajib

Contoh: select

optionarray of string
modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

downloadobject (FilterButtonDownloadCsv)

Tombol unduh hasil filter: saat ditekan, kirimkan download=yes

valuestring

Contoh: Download

typestringwajib

Contoh: button_download_csv

listarray of object
idintegerwajib

Contoh: 9867834

branch_sumnumberwajib

Contoh: 100.55

branch_idintegerwajib

Contoh: 8783

chain_coefficientnumberwajib

Contoh: 0.04

account_balancenumberwajib

Contoh: 100.55

typestring (TypeReports) wajib

Nilai:annulrefundaccrualwithdraw

Contoh: accrual

datestring (DataTimeFormat) wajib

Contoh: 17:45 06/05/2024

descriptionstring

Contoh: text

city_namestringwajib

Contoh: Voronezh

chain_namestringwajib

Contoh: Green Basket | Main

account_idintegerwajib

Contoh: 5828

paginationobject (Pagination)
max_countintegerwajib

Jumlah item per halaman

Contoh: 30

page_numberintegerwajib

Nomor halaman saat ini; dibatasi agar offset tidak melebihi 1000

Contoh: 1

has_nextbooleanwajib

Apakah ada halaman berikutnya

Contoh: true

has_previousbooleanwajib

Apakah ada halaman sebelumnya

Contoh: false