System_Login Schema
Documentation {..} JSON XML
Mandatory field
Optional field
Returns a fully formed log in URL providing direct access to the system 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
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
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.
CustomPath
A specific partial URL for the page you would like to route the client to. E.g. invoices.aspx (exclude: https://mydomain.quickfile.co.uk/secure/ca/)
string
Maximum length: 500
ClientID
integer
The client ID for the specic client you are granting access
Endpoint: https://api.quickfile.co.uk/1_2/system/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 System Methods
Create an invoice, purchase, client or supplier note
Query the system event log
Returns meta details for the authorised account
Quick File Limited - Copyright © 2024
QuickFile Accounting | Community | Knowledgebase