Skip to main content
GET
List customer balances

Autorisierungen

Authorization
string
header
erforderlich

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

Header

Authorization
string
erforderlich

Bearer Token

Abfrageparameter

o
string

Organization ID

include
string

Comma-separated. Allowed: balanceable, customer_account, invoices, invoices.items, invoices.reference, master_invoice, master_invoice.items, payment_setup

sort
string

Allowed: issue_at, total, start_date, end_date, created_at

filter[status]
string

Allowed values: open, issued, paid, rolled_over, void

filter[balanceable_type]
string

Polymorphic type filter. Values: customers, businesses

filter[balanceable_id]
string

UUID of the balanceable entity

filter[currency]
string

ISO 4217 currency code

filter[start_date_from]
string<date>
filter[start_date_to]
string<date>
page[number]
integer
page[size]
integer

Antwort

OK

data
Customer Balance · object[]