getClientsBalance

Operation Id:
clients/balance/get [Official Documentaction]
Methods

  • clientNumbers Array<Integer>
  • textSearch String
  • active 'yes'|'no'
  • hasTradeCredit 'nonzero'|'positive'|'negative'|'zero'
  • lastPurchaseDate Object
  • returnElements Array<String>
  • resultsPage Integer
  • resultsLimit Integer
Examples

This function retrieves the balance of active clients.

const result = await idosellRequest.getClientsBalance
	.active("yes")
	.exec()

This function retrieves the balance of clients on page 2 with a page size of 10.

const result = await idosellRequest.getClientsBalance
	.page(2,10)
	.exec()

This function retrieves the balance of multiple clients with account numbers [123, 456, 678].

const result = await idosellRequest.getClientsBalance
	.client_numbers([123,456,678])
	.exec()

This function retrieves the balance of clients' last purchase made between January 1, 2023, and January 10, 2023.

const result = await idosellRequest.getClientsBalance
	.lastPurchased("2023-01-01", "2023-01-10")
	.exec()