Client_LogIn Schema
Documentation {..} JSON XML
Mandatory field
Optional field
Returns a fully formed log in URL providing direct access to a client account without the need to enter the email and password combination. The url is valid for upto 20 minutes following issue.
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
LandingPage
Dashboard
boolean
Routes the browser to the main account dashboard
InvoiceView
InvoiceID
integer
Provide an invoice ID and the browser will be redirected to the invoice view page.
ClientID
The Client ID relating to the account you wish to grant access.
Endpoint: https://api.quickfile.co.uk/1_2/client/login
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