API Docs
/
No Results Found
Bank Accounts

Bank Accounts

In Zoho Books, you can track your transactions, have manual and automatic feeds imported for your bank and credit card accounts.

Attribute

account_id
string
ID of the Bank/Credit Card account
account_name
string
Name of the account
account_code
string
Code of the Account
currency_id
string
ID of the Currency associated with the Account
currency_code
string
Code of the currency associated with the Bank Account
currency_symbol
string
Symbol of the Currency associated with the Account
price_precision
integer
Precision of the Price Values
account_type
string
Type of the account
account_number
string
Number associated with the Bank Account
uncategorized_transactions
integer
Number of uncategorized transactions
total_unprinted_checks
integer
Number of unprinted checks.
is_active
boolean
Check if Account is Active
is_feeds_subscribed
boolean
Check is feeds are subscribed
is_feeds_active
boolean
Check if feeds are active
balance
double
Balance present in the account
bank_balance
integer
Balance present in the Bank
bcy_balance
double
Balance in Base Currency
bank_name
string
Name of the Bank
routing_number
string
Routing Number of the Account
is_primary_account
boolean
Check if the Account is Primary Account in Zoho Books
is_paypal_account
boolean
Check if the Account is Paypal Account
description
string
Description of the Account
refresh_status_code
string
Refresh Status Code of the Bank
feeds_last_refresh_date
string
Last Refreshed Date of the Feeds
service_id
string
Service ID of the Account
is_system_account
boolean
Check if the account is a system account
is_show_warning_for_feeds_refresh
boolean
Check if warning should be shown for refreshing Bank Feeds

Example

{ "account_id": "460000000050127", "account_name": "Corporate Account", "account_code": "string", "currency_id": "460000000000097", "currency_code": "USD", "currency_symbol": "$", "price_precision": 2, "account_type": "bank", "account_number": "80000009823", "uncategorized_transactions": 0, "total_unprinted_checks": 0, "is_active": true, "is_feeds_subscribed": false, "is_feeds_active": false, "balance": 0, "bank_balance": 0, "bcy_balance": 0, "bank_name": "Xavier Bank", "routing_number": "123456789", "is_primary_account": false, "is_paypal_account": true, "description": "Salary details.", "refresh_status_code": "string", "feeds_last_refresh_date": "string", "service_id": "string", "is_system_account": false, "is_show_warning_for_feeds_refresh": false }

Create a bank account

Create a bank account or a credit card account for your organization.
oauthscope : ZohoBooks.banking.CREATE

Arguments

account_name
string
(Required)
Name of the account
account_type
string
(Required)
Type of the account
account_number
string
Number associated with the Bank Account
account_code
string
Code of the Account
currency_id
string
ID of the Currency associated with the Account
currency_code
string
Code of the currency associated with the Bank Account
description
string
Description of the Account
bank_name
string
Name of the Bank
routing_number
string
Routing Number of the Account
is_primary_account
boolean
Check if the Account is Primary Account in Zoho Books
is_paypal_account
boolean
Check if the Account is Paypal Account
paypal_type
string
The type of Payment for the Paypal Account. Allowed Values : standard and adaptive
paypal_email_address
string
Email Address of the Paypal account.

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/bankaccounts -X POST -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "account_name": "Corporate Account", "account_type": "bank", "account_number": "80000009823", "account_code": "string", "currency_id": "460000000000097", "currency_code": "USD", "description": "Salary details.", "bank_name": "Xavier Bank", "routing_number": "123456789", "is_primary_account": false, "is_paypal_account": true, "paypal_type": "string", "paypal_email_address": "johnsmith@zilliuminc.com" }

Response Example

{ "code": 0, "message": "The account has been created.", "bankaccount": { "account_id": "460000000050127", "account_name": "Corporate Account", "account_code": "string", "currency_id": "460000000000097", "currency_code": "USD", "currency_symbol": "$", "price_precision": 2, "account_type": "bank", "account_number": "80000009823", "uncategorized_transactions": 0, "total_unprinted_checks": 0, "is_active": true, "is_feeds_subscribed": false, "is_feeds_active": false, "balance": 0, "bank_balance": 0, "bcy_balance": 0, "bank_name": "Xavier Bank", "routing_number": "123456789", "is_primary_account": false, "is_paypal_account": true, "description": "Salary details.", "refresh_status_code": "string", "feeds_last_refresh_date": "string", "service_id": "string", "is_system_account": false, "is_show_warning_for_feeds_refresh": false } }

List view of accounts

List all bank and credit card accounts for your organization.
oauthscope : ZohoBooks.banking.READ

Query Parameters

filter_by
Filter the account by their status. Allowed Values: Status.All, Status.Active and Status.Inactive.
sort_column
Sort the values based on the allowed values. Allowed Values: account_name,account_type and account_code.

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/bankaccounts -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "bankaccounts": [ { "account_id": "460000000050127", "account_name": "Corporate Account", "account_code": "string", "currency_id": "460000000000097", "currency_code": "USD", "account_type": "bank", "account_number": "80000009823", "uncategorized_transactions": 0, "total_unprinted_checks": 0, "is_active": true, "balance": 0, "bank_balance": 0, "bcy_balance": 0, "bank_name": "Xavier Bank", "routing_number": "123456789", "is_primary_account": false, "is_paypal_account": true }, {...}, {...} ] }

Update bank account

Modify the account that was created.
oauthscope : ZohoBooks.banking.UPDATE

Arguments

account_name
string
(Required)
Name of the account
account_type
string
(Required)
Type of the account
account_number
string
Number associated with the Bank Account
account_code
string
Code of the Account
currency_id
string
ID of the Currency associated with the Account
currency_code
string
Code of the currency associated with the Bank Account
description
string
Description of the Account
bank_name
string
Name of the Bank
routing_number
string
Routing Number of the Account
is_primary_account
boolean
Check if the Account is Primary Account in Zoho Books
is_paypal_account
boolean
Check if the Account is Paypal Account
paypal_type
string
The type of Payment for the Paypal Account. Allowed Values : standard and adaptive
paypal_email_address
string
Email Address of the Paypal account.

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/bankaccounts/{account_id} -X PUT -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "account_name": "Corporate Account", "account_type": "bank", "account_number": "80000009823", "account_code": "string", "currency_id": "460000000000097", "currency_code": "USD", "description": "Salary details.", "bank_name": "Xavier Bank", "routing_number": "123456789", "is_primary_account": false, "is_paypal_account": true, "paypal_type": "string", "paypal_email_address": "johnsmith@zilliuminc.com" }

Response Example

{ "code": 0, "message": "The details of the account has been updated.", "bankaccount": { "account_id": "460000000050127", "account_name": "Corporate Account", "account_code": "string", "currency_id": "460000000000097", "currency_code": "USD", "currency_symbol": "$", "price_precision": 2, "account_type": "bank", "account_number": "80000009823", "uncategorized_transactions": 0, "total_unprinted_checks": 0, "is_active": true, "is_feeds_subscribed": false, "is_feeds_active": false, "balance": 0, "bank_balance": 0, "bcy_balance": 0, "bank_name": "Xavier Bank", "routing_number": "123456789", "is_primary_account": false, "is_paypal_account": true, "description": "Salary details.", "refresh_status_code": "string", "feeds_last_refresh_date": "string", "service_id": "string", "is_system_account": false, "is_show_warning_for_feeds_refresh": false } }

Get account details

Get a detailed look of the account specified.
oauthscope : ZohoBooks.banking.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/bankaccounts/{account_id}

Response Example

{ "code": 0, "message": "success", "bankaccount": { "account_id": "460000000050127", "account_name": "Corporate Account", "account_code": "string", "currency_id": "460000000000097", "currency_code": "USD", "currency_symbol": "$", "price_precision": 2, "account_type": "bank", "account_number": "80000009823", "uncategorized_transactions": 0, "total_unprinted_checks": 0, "is_active": true, "is_feeds_subscribed": false, "is_feeds_active": false, "balance": 0, "bank_balance": 0, "bcy_balance": 0, "bank_name": "Xavier Bank", "routing_number": "123456789", "is_primary_account": false, "is_paypal_account": true, "description": "Salary details.", "refresh_status_code": "string", "feeds_last_refresh_date": "string", "service_id": "string", "is_system_account": false, "is_show_warning_for_feeds_refresh": false } }

Delete an account

Delete a bank account from your organization.
oauthscope : ZohoBooks.banking.DELETE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/bankaccounts/{account_id} -X DELETE

Response Example

{ "code": 0, "message": "The account has been deleted." }

Deactivate account.

Make an account inactive.
oauthscope : ZohoBooks.banking.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/bankaccounts/{account_id}/inactive -X POST

Response Example

{ "code": 0, "message": "The account has been marked as inactive." }

Activate account

Make an account active.
oauthscope : ZohoBooks.banking.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/bankaccounts/{account_id}/active -X POST

Response Example

{ "code": 0, "message": "The account has been marked as active." }

Import a Bank/Credit Card Statement

Import your bank/credit card feeds into your account.

Arguments

account_id
string
(Required)
ID of the Bank/Credit Card account
start_date
string
Least date in the transaction set
end_date
string
Greatest date in the transaction set
transactions
array
(Required)
Show Sub-Attributes arrow
transaction_id
string
Unique ID that is specific to the transaction
date
string
(Required)
Date of the transaction
debit_or_credit
string
(Required)
Indicates if transaction is Debit or Credit
amount
double
(Required)
Amount involved in the transaction
payee
string
Payee involved in the transaction
description
string
Transaction description
reference_number
string
Reference Number of the transaction

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/bankstatements -X POST -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "account_id": "460000000050127", "start_date": "2019-01-01", "end_date": "2019-01-02", "transactions": [ { "transaction_id": "XXXXSCD01", "date": "2012-01-14", "debit_or_credit": "credit", "amount": 7500, "payee": "Bowman and Co", "description": "Electronics purchase", "reference_number": "Ref-2134" } ] }

Response Example

{ "code": 0, "message": "Your bank statement has been imported." }

Get last imported statement

Get the details of previously imported statement for the account.
oauthscope : ZohoBooks.banking.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/bankaccounts/{account_id}/statement/lastimported

Response Example

{ "code": 0, "message": "success", "statement": [ { "statement_id": "460000000049013", "from_date": "2012-01-12", "to_date": "2012-01-19", "source": "csv", "transactions": [ { "transaction_id": "460000000049023", "debit_or_credit": "credit", "date": "2012-01-14", "customer_id": "460000000026049", "payee": "Bowman and Co", "reference_number": "Ref-2134", "transaction_type": "expense", "amount": 7500, "status": "categorized" } ] }, {...}, {...} ] }

Delete last imported statement

Delete the statement that was previously imported.
oauthscope : ZohoBooks.banking.DELETE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/bankaccounts/{account_id}/statement/{statement_id} -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "You have successfully deleted the last imported statement." }