Purchase_Create Schema
| Documentation | {..} JSON | XML |
| Mandatory field | Optional field |
Create or Update a Purchase Invoice
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
PurchaseData
PurchaseID
integer
If PurchaseID is supplied an update will be applied to the existing invoice. If no PurchaseID is supplied a new invoice will be created.
SupplierID
integer
Unique Client ID.
ReceiptDate
date
Date invoice was issued
TermDays
integer
Number of days permitted to pay the invoice.
Currency
ISO 4217 Currency Code.
string
Maximum length: 3
InvoiceDescription
A brief description of the invoice raised. If not supplied will assume the description of the first invoice item/task.
string
Maximum length: 35
Minimum length: 2
VatCodes
Possible codes: exempt (VAT Exempt), oos (VAT Out of Scope), cisrc (CIS Reverse Charge), nigoods (EU acquisition of goods), servrc (Reverse Charge (Services)), postgoods (PVA on Goods).
Code
10string
Minimum length: 1
Maximum length: 30
SupplierReference
string
Optional reference number issued by the supplier.
ProjectTags
Provide up to 5 additional project tags
Tag
5string
Minimum length: 1
Maximum length: 30
InvoiceLines
ItemLine
500 Purchase Invoice item line type.
ItemNominalCode
Nominal Code (e.g. 5000 - General Purchases)
string
Maximum length: 5
Minimum length: 2
ItemDescription
Item Description (Long).
string
Maximum length: 5000
SubTotal
The line total before VAT
decimal
VatRate
The VAT rate to be applied. For non-VAT Reg suppliers use 0.00
decimal
VatTotal
Overrides the VAT Rate for specific VAT amounts. If missing will be calculated from the rate.
decimal
PaymentData
If the invoice is paid. Enter payment information here.
PaidDate
date
Date invoice was paid
BankNominalCode
integer
Nominal Code for receiving bank account. Default Bank account will be assumed if not supplied.
PayMethod
Method of payment used.
string
Enumerated value: BACS
Enumerated value: DD
Enumerated value: STO
Enumerated value: CHEQUE
Enumerated value: CASH
Enumerated value: DCARD
Enumerated value: CCARD
AmountPaid
double
Total amount paid in currency.
Notes
Optional payment notes container.
string
Maximum length: 100
Endpoint: https://api.quickfile.co.uk/1_2/purchase/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 Purchase Methods |
|---|
|
Create a new purchase invoice record
|
|
Delete an existing purchase invoice
|
|
Retrieve an existing purchase invoice
|
|
Search for a purchase invoices based on specific search parameters
|