Ledger_Search Schema
| Documentation | {..} JSON | XML |
| Mandatory field | Optional field |
Returns a list of nominal ledger transactions for a set of given 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). To just return the meta data with no transaction enter zero.
int
Minimum inclusive value: 0
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: TransactionDate
Enumerated value: Amount
OrderDirection
Order direction. Ascending (ASC) or Descending (DESC).
string
Enumerated value: ASC
Enumerated value: DESC
NominalCode
The nominal code of the ledger you wish to query
int
Maximum inclusive value: 9999
Minimum inclusive value: 1
Reference
string
Search by whole or partial reference
Notes
string
Search by whole or partial notes.
FromDate
date
From date
ToDate
date
To date
AmountFrom
double
Amount range from (use - prefix for debits)
AmountTo
double
Amount range to (use - prefix for debits)
Endpoint: https://api.quickfile.co.uk/1_2/ledger/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 Ledger Methods |
|---|
|
Query a nominal ledger based on a specific date or amount range
|
|
Returns information on a specified range of nominal ledgers
|