|Mandatory field||Optional field|
Returns a list of purchases based on your search parameters
Document header container
Enumerated value: Request
Enumerated value: Response
Test mode set as true will make no database modifications.
ID of the calling device where applicable. Use for mobile devices such as I-Phones and Android units
Minimum length: 0
Maximum length: 100
A unique reference used for each API request. The Submission Number is seeded within the Authentication MD5 Value to prevent cloning.
Account Number and an MD5 Hash of "API Key, Password and Submission Number"
Unique identiifier for the application making the request. Mandoatory from 10th Dec 2013
Minimum length: 1
Maximum length: 100
How many records would you like the API to return (MAX: 200).
Minimum inclusive value: 1
Maximum inclusive value: 200
Page offset. Zero (0) would show results from the begining of the record set. Offset can be used for paging functions.
Which columns should be used for ordering the record set.
Enumerated value: ReceiptNumber
Enumerated value: ReceiptDate
Enumerated value: SupplierName
Enumerated value: Total
Order direction. Ascending (ASC) or Descending (DESC).
Enumerated value: ASC
Enumerated value: DESC
Show previously deleted invoices. Default is false.
Supplier ID can be used to return all purchases for a given supplier.
Whole or part of supplier business name.
Search by whole or partial receipt number (e.g. QF00001)
Search by item description
Receipt date range from
Receipt date range to
Amount range from
Amount range to
Currency ISO code
Maximum length: 3
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
set this to know Supplier Reference for each purchase in the return list
set this to know Net Amount for each purchase in the return list
set this to know Vat Amount for each purchase in the return list
set this to know purchases with receipts attached
set this to show purchases without receipts
We had a problem retrieving a JSON sample for this method, please retry later
We had a problem retrieving an XML sample for this method, please retry later
|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