Skip to main content
GET
Queue a customer balance list export

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Sorgu Parametreleri

search
string | null

Search customers by name, email, or phone.

Maximum string length: 255
balance_min
number | null

The minimum outstanding balance in the tenant base currency.

Gerekli aralık: x >= 0
balance_max
number | null

The maximum outstanding balance in the tenant base currency.

Gerekli aralık: x >= 0
latest_transaction_at_from
string<date-time> | null

Include customers whose latest financial transaction is on or after this date.

latest_transaction_at_to
string<date-time> | null

Include customers whose latest financial transaction is on or before this date.

sort
enum<string> | null

The field used to sort customer balances.

Mevcut seçenekler:
balance,
latest_transaction_at,
customer,
null
direction
enum<string> | null

The sort direction.

Mevcut seçenekler:
asc,
desc,
null
format
enum<string> | null

The export file format.

Mevcut seçenekler:
excel,
pdf,
null

Yanıt

success
string
gerekli
data
object
gerekli