Returns a list of clients based on your search parameters
Document header container
Enumerated value: Request
Enumerated value: Response
ID of the calling device where applicable. Use for mobile devices such as I-Phones and Android units
Minimum length: 0
Maximum length: 100
A unique reference used for each API request. The Submission Number is seeded within the Authentication MD5 Value to prevent cloning.
Account number, and an MD5 hash "Account number, API Key and Submission Number"
Unique identiifier for the application making the request. Mandoatory from 10th Dec 2013
Minimum length: 1
Maximum length: 100
How many records would you like the API to return (MAX 200).
Minimum inclusive value: 1
Maximum inclusive value: 200
Page offset. Zero (0) would show results from the begining of the record set. Offset can be used for paging functions.
Whic columns should be used for ordering the record set.
Enumerated value: CreatedDate
Enumerated value: CompanyName
Order direction. Ascending (ASC) or Descending (DESC).
Enumerated value: ASC
Enumerated value: DESC
Show previously deleted clients. Default is false.
Search by partial company name.
Search by first name.
Search by first surname.
Search by email.
Client account reference
Returns the total amount invoiced for each client.
Returns the total payments received for each client.
Returns the total of prepayments held on account for each client.
Returns the account reference for each client.
We had a problem retrieving a JSON sample for this method, please retry later
We had a problem retrieving an XML sample for this method, please retry later
|Other Client Methods
Create a new client record
Delete a client record
Retrieve client and contact data
Create a new contact record for an existing client
Retrieve a passwordless login URL for a client
Initiate a new Direct Debit collection request
Retrieve client records based on a set of search parameters
Update an existing client record