Ledger_GetNominalLedgers Schema
| Documentation | {..} JSON | XML |
| Mandatory field | Optional field |
Returns a full list of nominal ledgers 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
StartNominalCode
The nominal code range from where you would like to start. Default is 1
int
Minimum inclusive value: 1
Maximum inclusive value: 9999
EndNominalCode
The nominal code range to where you would like to end. Default is 9999
int
Minimum inclusive value: 1
Maximum inclusive value: 9999
ReturnFullDescription
boolean
Returns the detailed description for each respective ledger. Set as false by default
Endpoint: https://api.quickfile.co.uk/1_2/ledger/getnominalledgers
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
|