Item_Create Schema
Documentation {..} JSON XML
Mandatory field
Optional field
Method for creating a new invetory item.
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
ItemDetails
ItemID
integer
If ItemID is supplied an update will be applied to the existing item record. If no ItemID is supplied a new item record will be created.
ItemName
Item/task name (Short)
string
Maximum length: 22
Minimum length: 1
ItemDescription
Item/task description (Long)
string
Maximum length: 500
UnitCost
double
Unit cost or hourly rate for task based items
ItemType
Inventory based item or task based item.
string
Enumerated value: ITEM
Enumerated value: TASK
VatRate
double
Enter the rate of VAT applicable to this item. For non-vatable items or non-vat registered accounts enter 0.
Qty
double
The default quantity to apply for this item when being called into an invoice. If not supplied 1 will be assumed. Decimal quantities are only permitted for TASK based entries.
NominalCode
integer
Nominal code to use for this item. If left blank assumes 4000 (General Sales)
Endpoint: https://api.quickfile.co.uk/1_2/item/create
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 Item Methods
Create a new inventory item or task
Delete an inventory item or task
Retrieve an inventory item or task
Search for inventory items or tasks based on a set of search parameters
Quick File Limited - Copyright © 2019
QuickFile Accounting | Community | Knowledgebase