Features
Accountants
Pricing
Support
Log in
 

Soap API documentation

Method: listBankAccounts

Lists the existing bank accounts on the account.

Request

Field Type Description  
This method takes no parameters.

Response

Field Type Description  
bankAccounts array A list of existing bank accounts. optional
BankAccountListItem last_date string The date of the last transaction on this bank account. optional
BankAccountListItem account_type integer The type of the bank account. Valid bank account types are: 0 - Bank account 1 - Credit card 2 - Cash account 3 - Internet payments 4 - Investment account 5 - Savings account 6 - Directors loan account 7 - Loan account optional
BankAccountListItem balance float The current balance of the bank account. optional
BankAccountListItem bank_name string The name of the bank account. optional
BankAccountListItem currency integer The currency ID of the bank account. For a valid list of currencies, please check the listCurrencies method. optional
BankAccountListItem gl_account_code integer The account code of the bank account. optional
BankAccountListItem id integer The unique identifier of the bank account. optional

Examples

Request

<?xml version="1.0" encoding="UTF-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Header>
        <authenticate xmlns="https://secure.clearbooks.co.uk/api/accounting/soap/">
            <apiKey xmlns="">yourApiKey</apiKey>
        </authenticate>
    </Header>
    <Body>
        <listBankAccounts xmlns="https://secure.clearbooks.co.uk/api/accounting/soap/"/>
    </Body>
</Envelope>

Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://secure.clearbooks.co.uk/api/accounting/soap/">
    <SOAP-ENV:Body>
        <ns1:listBankAccountsResponse>
            <return>
                <bankAccounts>
                    <ns1:BankAccountListItem last_date="12 Jan 2018">
                        <account_type>0</account_type>
                        <balance>300</balance>
                        <bank_name>Barclays</bank_name>
                        <currency>1</currency>
                        <gl_account_code>7502001</gl_account_code>
                        <id>1</id>
                    </ns1:BankAccountListItem>
                    <ns1:BankAccountListItem>
                        <account_type>0</account_type>
                        <balance>0</balance>
                        <bank_name>HSBC</bank_name>
                        <currency>1</currency>
                        <gl_account_code>7502004</gl_account_code>
                        <id>2</id>
                    </ns1:BankAccountListItem>
                </bankAccounts>
                <total>2085.71</total>
            </return>
        </ns1:listBankAccountsResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Clear Books is proudly registered with the Financial Conduct Authority as an Account Information Services Provider (register no. 843585).