Client_Get Schema
Documentation {..} JSON XML
Mandatory field
Optional field
Retrieve Client Details
Header
Document header container
MessageType
string
Enumerated value: Request
Enumerated value: Response
TestMode
Test mode set as true will make no database modifications.
boolean
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 of "API Key, Password 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
ClientID
int
ReturnData
If you want to return only specific subsets of data, please provide the relevant nodes here. If absent all data will be returned.
Address
boolean
Returns the postal address
VATDetails
boolean
Returns VAT Number and EC Status
Preferences
boolean
Various client preferences
ClientContacts
boolean
Returns a list of client contacts associated with this particular client record.
Financials
boolean
Returns credits on account and balance info.
GoCardlessDetails
boolean
Will return a new signup URL if no Pre-Auth exists. Otherwise you will receive the GoCardless Pre-Auth ID.
Endpoint: https://api.quickfile.co.uk/1_2/client/get
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
Quick File Limited - Copyright © 2019
QuickFile Accounting | Community | Knowledgebase