System_SearchEvents Schema
Documentation {..} JSON XML
Mandatory field
Optional field
Returns a list of events based on a query
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
SearchParameters
ReturnCount
How many records would you like the API to return (MAX 200).
int
Minimum inclusive value: 1
Maximum inclusive value: 200
ContinuationToken
string
Represents a continuation token from the server when the operation returns a partial result.
FromDateTime
dateTime
From date
ToDateTime
dateTime
To date
SearchType
If you want to isolate events by client, supplier invoice etc use these parameters
SearchType
Search type, see enumerations
string
Enumerated value: Client
Enumerated value: Supplier
Enumerated value: Invoice
Enumerated value: Purchase
RefID
string
Here you would supply the clientID, supplierID, invoiceID or purchaseID depending on the SearchType
Endpoint: https://api.quickfile.co.uk/1_2/system/searchevents
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 © 2019
QuickFile Accounting | Community | Knowledgebase