Payment_Search Schema
Documentation {..} JSON XML
Mandatory field
Optional field
Returns a list of client payments and credits 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
Maximum inclusive value: 200
Minimum inclusive value: 1
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: Amount
Enumerated value: PayDate
OrderDirection
Order direction. Ascending (ASC) or Descending (DESC).
string
Enumerated value: ASC
Enumerated value: DESC
ShowDeleted
boolean
Show previously deleted payments. Default is false.
ClientDetails
ClientID
int
Show all payments for a given Client ID.
ClientName
Whole or part of client company name.
PayMethod
Method of payment. Please use on of the predescribed codes. See Appendix in API Spec.
string
Type
ALLOCATED/UNALLOCATED
string
Enumerated value: ALLOCATED
Enumerated value: UNALLOCATED
DateFrom
date
Payment date range from
DateTo
date
Payment date range to
AmountFrom
double
Amount range from
AmountTo
double
Amount range to
Currency
Currency ISO code
string
Maximum length: 3
Endpoint: https://api.quickfile.co.uk/1_2/payment/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 Payment Methods
Create a new payment record
Delete a payment record
Retrieve a payment record
Get the collection of payment methods
Search for a payment based on specific search parameters
Quick File Limited - Copyright © 2019
QuickFile Accounting | Community | Knowledgebase