Bank_GetAccounts Schema
Documentation {..} JSON XML
Mandatory field
Optional field
Returns a list of bank accounts based on a search criteria
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 "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
OrderResultsBy
How should the results be ordered?
string
Enumerated value: NominalCode
Enumerated value: Position
AccountTypes
List of account types to be returned
AccountType
10
string
Enumerated value: CURRENT
Enumerated value: PETTY
Enumerated value: BUILDINGSOC
Enumerated value: LOAN
Enumerated value: MERCHANT
Enumerated value: EQUITY
Enumerated value: CREDITCARD
Enumerated value: RESERVE
ShowHidden
boolean
Show hidden bank accounts. Default is false.
GetOpenBankingConsents
boolean
Show Open Banking consents. Default is false.
Endpoint: https://api.quickfile.co.uk/1_2/bank/getaccounts
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 Bank Methods
Query bank account transactions by date range, nominal code, reference or amount
Create a new bank account
Create untagged bank transactions
Returns a list of bank accounts grouped by type
Returns a list of bank balances from an ID Array
Quick File Limited - Copyright © 2021
QuickFile Accounting | Community | Knowledgebase