Client_Search Schema
| Documentation | {..} JSON | XML |
| Mandatory field | Optional field |
Returns a list of clients based on your search parameters
Header
Document header container
MessageType
string
Enumerated value: Request
Enumerated value: Response
DeviceID
ID of the calling device where applicable. Use for mobile devices such as I-Phones and Android units
string
Minimum length: 0
Maximum length: 100
SubmissionNumber
string
A unique reference used for each API request. The Submission Number is seeded within the Authentication MD5 Value to prevent cloning.
Authentication
Account number, and an MD5 hash "Account number, API Key and Submission Number"
AccNumber
MD5Value
ApplicationID
Unique identiifier for the application making the request. Mandoatory from 10th Dec 2013
string
Minimum length: 1
Maximum length: 100
Body
SearchParameters
ReturnCount
How many records would you like the API to return (MAX 200).
int
Minimum inclusive value: 1
Maximum inclusive value: 200
Offset
int
Page offset. Zero (0) would show results from the begining of the record set. Offset can be used for paging functions.
OrderResultsBy
Whic columns should be used for ordering the record set.
string
Enumerated value: CreatedDate
Enumerated value: CompanyName
OrderDirection
Order direction. Ascending (ASC) or Descending (DESC).
string
Enumerated value: ASC
Enumerated value: DESC
ShowDeleted
boolean
Show previously deleted clients. Default is false.
CompanyName
string
Search by partial company name.
FirstName
string
Search by first name.
Surname
string
Search by first surname.
Email
string
Search by email.
Telephone
string
AccountReference
string
Client account reference
AdditionalParameters
ShowTotalInvoiced
boolean
Returns the total amount invoiced for each client.
ShowTotalPaid
boolean
Returns the total payments received for each client.
ShowCredits
boolean
Returns the total of prepayments held on account for each client.
ShowAccountReference
boolean
Returns the account reference for each client.
Endpoint: https://api.quickfile.co.uk/1_2/client/search
Example Request:
We had a problem retrieving a JSON sample for this method, please retry later
Example Response:
Example Request:
We had a problem retrieving an XML sample for this method, please retry later
Example Response:
| 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
|