purchase_search Schema
| Documentation | {..} JSON | XML |
| Mandatory field | Optional field |
Returns a list of purchases based on your search parameters
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
SearchParameters
ReturnCount
How many records would you like the API to return (MAX: 200).
int
Minimum inclusive value: 1
Maximum inclusive value: 200
Offset
int
Page offset. Zero (0) would show results from the begining of the record set. Offset can be used for paging functions.
OrderResultsBy
Which columns should be used for ordering the record set.
string
Enumerated value: ReceiptNumber
Enumerated value: ReceiptDate
Enumerated value: SupplierName
Enumerated value: Total
OrderDirection
Order direction. Ascending (ASC) or Descending (DESC).
string
Enumerated value: ASC
Enumerated value: DESC
ShowDeleted
boolean
Show previously deleted invoices. Default is false.
SupplierDetails
SupplierID
integer
Supplier ID can be used to return all purchases for a given supplier.
SupplierName
string
Whole or part of supplier business name.
ReceiptNumber
string
Search by whole or partial receipt number (e.g. QF00001)
ItemDescription
string
Search by item description
ReceiptDateFrom
date
Receipt date range from
ReceiptDateTo
date
Receipt date range to
AmountFrom
double
Amount range from
AmountTo
double
Amount range to
Currency
Currency ISO code
string
Maximum length: 3
Status
Purchase status
string
Enumerated value: DRAFT
Enumerated value: SENT
Enumerated value: DISPUTED
Enumerated value: PAIDPART
Enumerated value: PAIDFULL
Enumerated value: ACTIVE
Enumerated value: UNPAID
Enumerated value: DELETED
Enumerated value: CREDIT
Enumerated value: CREDITED
SupplierReference
string
AdditionalParameters
ShowSupplierRef
boolean
set this to know Supplier Reference for each purchase in the return list
ShowNetAmount
boolean
set this to know Net Amount for each purchase in the return list
ShowVatAmount
boolean
set this to know Vat Amount for each purchase in the return list
ShowWithReceipts
boolean
set this to know purchases with receipts attached
ShowWithoutReceipts
boolean
set this to show purchases without receipts
Endpoint: https://api.quickfile.co.uk/1_2/purchase/search
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
|