document_upload Schema
| Documentation | {..} JSON | XML |
| Mandatory field | Optional field |
Upload a document (e.g. receipt, sales attachment or general document management file) to QuickFile
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
DocumentDetails
10 Upload 1 to 10 documents per call.
FileName
Name of the file, including the extension.
string
Minimum length: 5
Maximum length: 150
EmbeddedFileBinaryObject
string
Base 64 encoded byte array containing the receipt image.
Type
Receipt
PurchaseId
int
If supplied the document will be attached to the supplied purchase ID. When absent the document will appear in the Receipt Hub untagged.
CaptureDateTime
dateTime
A date time object representing when the receipt image was captured.
ReceiptName
Optional name value assigned to the receipt for easy identification while untagged
string
Maximum length: 35
SalesAttachment
InvoiceId
int
The associated ID for the sales invoice you would like to attach to.
Notes
Optional notes
string
Maximum length: 600
General
CollectionName
string
The Doc Management folder to which the file will be uploaded
Endpoint: https://api.quickfile.co.uk/1_2/document/upload
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 document Methods |
|---|
|
Upload a document to the Document Management area or Receipt Hub
|