Bank Accounts

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

Download Bank Accounts OpenAPI Document

End Points

POST

/bankaccounts/{account_id}

GET

/bankaccounts/{account_id}

DELETE

/bankaccounts/{account_id}

POST

/bankaccounts/{account_id}/inactive

POST

/bankaccounts/{account_id}/active

POST

/bankstatements

GET

/bankaccounts/{account_id}/statement/lastimported

DELETE

/bankaccounts/{account_id}/statement/{statement_id}

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

{
    "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.
OAuth Scope : 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.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/bankaccounts?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/bankaccounts?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/bankaccounts?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/books/v3/bankaccounts?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/bankaccounts?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/books/v3/bankaccounts?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "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"
}

{
    "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.
OAuth Scope : ZohoBooks.banking.READ

Query Parameters

organization_id

string

(Required)

ID of the organization

filter_by

string

Filter the account by their status. Allowed Values: Status.All, Status.Active and Status.Inactive.

sort_column

string

Sort the values based on the allowed values. Allowed Values: account_name,account_type and account_code.

page

integer

Page number to be fetched. Default value is 1.

per_page

integer

Number of records to be fetched per page. Default value is 200.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/bankaccounts?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/bankaccounts?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/bankaccounts?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/bankaccounts?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/bankaccounts?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/bankaccounts?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "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.
OAuth Scope : 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.

Path Parameters

account_id

string

(Required)

Unique identifier of the bank account.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/bankaccounts/460000000050127?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/bankaccounts/460000000050127?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/bankaccounts/460000000050127?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/books/v3/bankaccounts/460000000050127?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/bankaccounts/460000000050127?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/books/v3/bankaccounts/460000000050127?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "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"
}

{
    "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.
OAuth Scope : ZohoBooks.banking.READ

Path Parameters

account_id

string

(Required)

Unique identifier of the bank account.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/bankaccounts/460000000050127?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/bankaccounts/460000000050127?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/bankaccounts/460000000050127?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/bankaccounts/460000000050127?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/bankaccounts/460000000050127?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/bankaccounts/460000000050127?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "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.
OAuth Scope : ZohoBooks.banking.DELETE

Path Parameters

account_id

string

(Required)

Unique identifier of the bank account.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/bankaccounts/460000000050127?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/bankaccounts/460000000050127?organization_id=10234695")
  .delete(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/bankaccounts/460000000050127?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("DELETE", "/books/v3/bankaccounts/460000000050127?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/bankaccounts/460000000050127?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url 'https://www.zohoapis.com/books/v3/bankaccounts/460000000050127?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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

Deactivate account.

Make an account inactive.
OAuth Scope : ZohoBooks.banking.CREATE

Path Parameters

account_id

string

(Required)

Unique identifier of the bank account.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/inactive?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/inactive?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/inactive?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/books/v3/bankaccounts/460000000050127/inactive?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/bankaccounts/460000000050127/inactive?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/inactive?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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

Activate account

Make an account active.
OAuth Scope : ZohoBooks.banking.CREATE

Path Parameters

account_id

string

(Required)

Unique identifier of the bank account.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/active?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/active?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/active?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/books/v3/bankaccounts/460000000050127/active?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/bankaccounts/460000000050127/active?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/active?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "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

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

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/bankstatements?organization_id=10234695"
type: POST
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/bankstatements?organization_id=10234695")
  .post(body)
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {'content-type': 'application/json'},
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/bankstatements?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = { 'content-type': "application/json" }

conn.request("POST", "/books/v3/bankstatements?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/bankstatements?organization_id=10234695",
  "headers": {
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/books/v3/bankstatements?organization_id=10234695' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "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"
        }
    ]
}

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

Get last imported statement

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

Path Parameters

account_id

string

(Required)

Unique identifier of the bank account.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/statement/lastimported?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/statement/lastimported?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/statement/lastimported?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/bankaccounts/460000000050127/statement/lastimported?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/bankaccounts/460000000050127/statement/lastimported?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/statement/lastimported?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "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.
OAuth Scope : ZohoBooks.banking.DELETE

Path Parameters

account_id

string

(Required)

Unique identifier of the bank account.

statement_id

string

(Required)

Unique identifier of the bank statement.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/statement/460000000049013?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/statement/460000000049013?organization_id=10234695")
  .delete(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/statement/460000000049013?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("DELETE", "/books/v3/bankaccounts/460000000050127/statement/460000000049013?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/bankaccounts/460000000050127/statement/460000000049013?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url 'https://www.zohoapis.com/books/v3/bankaccounts/460000000050127/statement/460000000049013?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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