API Reference

clients/balance

get
https://{domain}/api/admin/v8/clients/balance

Method that enables extracting customer balance information from existing customer accounts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
clientNumbers
array of integers

Customer Id

clientNumbers
string

Text search through customer data.

string
enum
Allowed:
string
enum
Allowed:
lastPurchaseDate
object

Start and end date (YYYY-MM-DD).

returnElements
array of strings

Elements to be returned by the endpoint. By default all elements are returned.
Available elements:

  • clientId
  • clientBalance
  • clientBalanceHistory
returnElements
integer

Results page number. Numbering begins at 0. Default value: 0.

integer

Maximum number of results on a single page. Default is 100.

Responses

401

Authorization error

403

Access denied

404

Not found

422

Invalid data format

429

Too many requests

500

Internal server error

Updated about 2 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?