Bank_CreateAccount Schema
Documentation {..} JSON XML
Mandatory field
Optional field
Create a new Bank Account. Please refer here for more information: https://community.quickfile.co.uk/t/api-method-for-creating-bank-accounts/18738
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
BankNameId
int
The bank name ID. Each banking provider (e.g. Barclays) has a corresponding ID. Please refer here for a list of IDs: https://community.quickfile.co.uk/t/api-method-for-creating-bank-accounts/18738
AccountType
Account type (e.g. Current, Petty, Merchant)
string
Enumerated value: CURRENT
Enumerated value: RESERVE
Enumerated value: BUILDINGSOC
Enumerated value: PETTY
Enumerated value: CREDITCARD
Enumerated value: LOAN
Enumerated value: MERCHANT
CurrencyCode
Currency Code (Default is GBP). Specifiy an alternative currency only if you have enabled multi-currency accounting.
string
Maximum length: 3
Minimum length: 3
AccountName
A name for this bank account
string
Maximum length: 50
AccountNumber
A bank account number if applicable
string
Maximum length: 10
SortCode
A sort code if applicable
string
Maximum length: 8
OpeningBalance
Does an opening balance need to be supplied with this account?
Date
date
The date the opening balance should be committed
Amount
double
Opening balance amount
ShowOnDashboard
boolean
Show the account balance on the dashboard for this account. Default is false.
Endpoint: https://api.quickfile.co.uk/1_2/bank/createaccount
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 © 2024
QuickFile Accounting | Community | Knowledgebase