System_CreateNote Schema
Documentation {..} JSON XML
Mandatory field
Optional field
Method for creating a new note against a client, invoice, supplier or purchase.
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
NoteDetails
DesignatedTo
ClientID
int
InvoiceID
int
Use this value to also add notes to estimates and recurring invoices
SupplierID
int
PurchaseID
int
Note
Note text
string
Maximum length: 1000
PostedBy
Optional: Enter the name of the person making the post.
string
Maximum length: 50
Endpoint: https://api.quickfile.co.uk/1_2/system/createnote
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