API Docs
/
No Results Found
Opening-Balance

Opening-Balance

While migrating from existing accounting software to Zoho Books, you need to ensure that the transition is flawless, that all prevailing data such as journal entries, records, expense and income statements etc, has been recorded and continuity in financial statements is maintained. To ensure this, an opening balance needs to be calculated.

End Points

Attribute

opening_balance_id
string
ID of opening balance.
date
string
Date on which the opening balance needs to be recorded. [yyyy-MM-dd]
price_precision
integer
Price Precision of the Values
accounts
array
Show Sub-Attributes arrow
acount_split_id
string
ID of split account that you want to update.
account_id
string
ID of account for which you need to record opening balance.
account_name
string
debit_or_credit
string
Debit or Credit for which the amount needs to be recorded. Allowed Values: debit and credit.
exchange_rate
double
Exchange rate for the foreign currencies if involved.
currency_id
string
ID of account currency.
currency_code
string
bcy_amount
double
Amount in Base Currency of the Organisation
amount
double
total
integer
Total Amount from the Opening Balance

Example

{ "opening_balance_id": "460000000050041", "date": "2013-10-01", "price_precision": 2, "accounts": [ { "acount_split_id": "460000000050045", "account_id": "460000000000358", "account_name": "Undeposited Funds", "debit_or_credit": "debit", "exchange_rate": 1, "currency_id": "460000000000097", "currency_code": "USD", "bcy_amount": 2000, "amount": 2000 } ], "total": 10000 }

Create opening balance

Creates opening balance with the given information.
oauthscope : ZohoBooks.settings.CREATE

Arguments

date
string
(Required)
Date on which the opening balance needs to be recorded. [yyyy-MM-dd]
accounts
array
Show Sub-Attributes arrow
account_id
string
ID of account for which you need to record opening balance.
debit_or_credit
string
(Required)
Debit or Credit for which the amount needs to be recorded. Allowed Values: debit and credit.
exchange_rate
double
Exchange rate for the foreign currencies if involved.
currency_id
string
ID of account currency.
amount
double

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/openingbalances?organization_id=10234695 -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "date": "2013-10-01", "accounts": [ { "account_id": "460000000000358", "debit_or_credit": "debit", "exchange_rate": 1, "currency_id": "460000000000097", "amount": 2000 } ] }

Response Example

{ "code": 0, "message": "The opening balances are saved!", "opening_balance": { "opening_balance_id": "460000000050041", "date": "2013-10-01", "price_precision": 2, "accounts": [ { "acount_split_id": "460000000050045", "account_id": "460000000000358", "account_name": "Undeposited Funds", "debit_or_credit": "debit", "exchange_rate": 1, "currency_id": "460000000000097", "currency_code": "USD", "bcy_amount": 2000, "amount": 2000 } ], "total": 10000 } }

Update opening balance

Updates the existing opening balance information.
oauthscope : ZohoBooks.settings.UPDATE

Arguments

date
string
Date on which the opening balance needs to be recorded. [yyyy-MM-dd]
accounts
array
Show Sub-Attributes arrow
acount_split_id
string
ID of split account that you want to update.
account_id
string
ID of account for which you need to record opening balance.
account_name
string
debit_or_credit
string
(Required)
Debit or Credit for which the amount needs to be recorded. Allowed Values: debit and credit.
exchange_rate
double
Exchange rate for the foreign currencies if involved.
currency_id
string
ID of account currency.
currency_code
string
bcy_amount
double
Amount in Base Currency of the Organisation
amount
double
opening_balance_id
string
(Required)
ID of opening balance.

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/openingbalances?organization_id=10234695 -X PUT -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "date": "2013-10-01", "accounts": [ { "acount_split_id": "460000000050045", "account_id": "460000000000358", "account_name": "Undeposited Funds", "debit_or_credit": "debit", "exchange_rate": 1, "currency_id": "460000000000097", "currency_code": "USD", "bcy_amount": 2000, "amount": 2000 } ], "opening_balance_id": "460000000050041" }

Response Example

{ "code": 0, "message": "The opening balances are saved!", "opening_balance": { "opening_balance_id": "460000000050041", "date": "2013-10-01", "price_precision": 2, "accounts": [ { "acount_split_id": "460000000050045", "account_id": "460000000000358", "account_name": "Undeposited Funds", "debit_or_credit": "debit", "exchange_rate": 1, "currency_id": "460000000000097", "currency_code": "USD", "bcy_amount": 2000, "amount": 2000 } ], "total": 10000 } }

Get opening balance

Get opening balance.
oauthscope : ZohoBooks.settings.READ

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/openingbalances?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "opening_balance": { "opening_balance_id": "460000000050041", "date": "2013-10-01", "price_precision": 2, "accounts": [ { "acount_split_id": "460000000050045", "account_id": "460000000000358", "account_name": "Undeposited Funds", "debit_or_credit": "debit", "exchange_rate": 1, "currency_id": "460000000000097", "currency_code": "USD", "bcy_amount": 2000, "amount": 2000 } ], "total": 10000 } }

Delete opening balance

Delete the entered opening balance.
oauthscope : ZohoBooks.settings.DELETE

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/openingbalances?organization_id=10234695 -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The entered opening balance has been deleted." }