Supplier_Search Schema
Documentation {..} JSON XML
Mandatory field
Optional field
Returns a list of suppliers based on your search parameters
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
SearchParameters
ReturnCount
How many records would you like the API to return.
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
Whic columns should be used for ordering the record set.
string
Enumerated value: CreatedDate
Enumerated value: CompanyName
OrderDirection
Order direction. Ascending (ASC) or Descending (DESC).
string
Enumerated value: ASC
Enumerated value: DESC
ShowDeleted
boolean
Show previously deleted suppliers. Default is false.
CompanyName
string
Search by partial company name.
ContactFirstName
string
Search by first name.
ContactSurname
string
Search by first surname.
ContactEmail
string
Search by email.
SupplierReference
string
supplier reference
ContactTel
string
AdditionalParameters
ShowTotalInvoiced
boolean
set this to know totalInvoiced value for each supplier in the return list
ShowTotalPaid
boolean
set this to know totalPaid for each supplier in the return list
ShowCredits
boolean
set this to know the credits held by each supplier in the retun list
Endpoint: https://api.quickfile.co.uk/1_2/supplier/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 Supplier Methods
Create a new supplier record
Delete a supplier record
Retrieve supplier and contact data
Retrieve supplier records based on a set of search parameters
Quick File Limited - Copyright © 2019
QuickFile Accounting | Community | Knowledgebase