API Docs
/
No Results Found
Base-Currency-Adjustment

Base-Currency-Adjustment

In Zoho Books you can have an insight on the profit or loss incurred due to the change in exchange rates and also can apply the changes to open transactions.

End Points
Create a base currency adjustment
List base currency adjustment
Get a base currency adjustment
Delete a base currency adjustment
List account details for base currency adjustment

Attribute

base_currency_adjustment_id
string
ID of the Base Currency Adjustment
adjustment_date
string
Date of adjustment.
exchange_rate
double
Exchange rate of the currency.
currency_id
string
ID of currency for which we need to post adjustment.
accounts
array
Show Sub-Attributes arrow
account_id
string
ID of the Account in Base Currency Adjustment
account_name
string
Name of the Account in Base Currency Adjustment
bcy_balance
double
Balance in Base Currency of the Organisation
fcy_balance
double
Balance in Foreign Currency
adjusted_balance
double
Adjusted Balance
gain_or_loss
double
Amount in Total Gain/Loss
gl_specific_type
integer
GL Specific Type of the Account Involved
notes
string
Notes for base currency adjustment.
currency_code
string
Currency Code involved in the Adjustment

Example

{ "base_currency_adjustment_id": "460000000039001", "adjustment_date": "2013-09-05", "exchange_rate": 1, "currency_id": "460000000000109", "accounts": [ { "account_id": "460000000000364", "account_name": "Accounts Receivable", "bcy_balance": 171.47, "fcy_balance": 139.41, "adjusted_balance": 209.12, "gain_or_loss": 37.65, "gl_specific_type": 5 } ], "notes": "Base Currency Adjustment against EUR", "currency_code": "EUR" }

Create a base currency adjustment

Creates a base currency adjustment for the given information.
oauthscope : ZohoBooks.accountants.CREATE

Arguments

currency_id
string
(Required)
ID of currency for which we need to post adjustment.
adjustment_date
string
(Required)
Date of adjustment.
exchange_rate
double
(Required)
Exchange rate of the currency.
notes
string
(Required)
Notes for base currency adjustment.

Query Parameters

account_ids
(Required)
ID of the accounts for which base currency adjustments need to be posted.
organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/basecurrencyadjustment?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
{ "currency_id": "460000000000109", "adjustment_date": "2013-09-05", "exchange_rate": 1, "notes": "Base Currency Adjustment against EUR" }

Response Example

{ "code": 0, "message": "The adjustment has been made. The account balances will now reflect the adjustment.", "data": { "base_currency_adjustment_id": "460000000039001", "adjustment_date": "2013-09-05", "exchange_rate": 1, "currency_id": "460000000000109", "accounts": [ { "account_id": "460000000000364", "account_name": "Accounts Receivable", "bcy_balance": 171.47, "fcy_balance": 139.41, "adjusted_balance": 209.12, "gain_or_loss": 37.65, "gl_specific_type": 5 } ], "notes": "Base Currency Adjustment against EUR", "currency_code": "EUR" } }

List base currency adjustment

Lists base currency adjustment.
oauthscope : ZohoBooks.accountants.READ

Query Parameters

filter_by
Filter base currency adjustment list. Allowed Values: Date.All, Date.Today, Date.ThisWeek, Date.ThisMonth, Date.ThisQuarter and Date.ThisYear.
sort_column
Sort base currency adjustment list. Allowed Values: adjustment_date, exchange_rate, currency_code, debit_or_credit and gain_or_loss.
last_modified_time
Search using the Last Modified Time of the Base Currency Adjustment
organization_id
(Required)
ID of the organization

Request Example

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

Response Example

{ "code": 0, "message": "success", "base_currency_adjustments": [ { "base_currency_adjustment_id": "460000000039001", "adjustment_date": "2013-09-05", "exchange_rate": 1, "currency_id": "460000000000109", "currency_code": "EUR", "notes": "Base Currency Adjustment against EUR", "gain_or_loss": 37.65 }, {...}, {...} ] }

Get a base currency adjustment

Get the base currency adjustment details.
oauthscope : ZohoBooks.accountants.READ

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

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

Response Example

{ "code": 0, "message": "success", "data": { "base_currency_adjustment_id": "460000000039001", "adjustment_date": "2013-09-05", "exchange_rate": 1, "currency_id": "460000000000109", "accounts": [ { "account_id": "460000000000364", "account_name": "Accounts Receivable", "bcy_balance": 171.47, "fcy_balance": 139.41, "adjusted_balance": 209.12, "gain_or_loss": 37.65, "gl_specific_type": 5 } ], "notes": "Base Currency Adjustment against EUR", "currency_code": "EUR" } }

Delete a base currency adjustment

Deletes the base currency adjustment.
oauthscope : ZohoBooks.accountants.DELETE

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

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

Response Example

{ "code": 0, "message": "The selected base currency adjustment has been deleted." }

List account details for base currency adjustment

List of accounts having transaction with effect to the given exchange rate.
oauthscope : ZohoBooks.accountants.READ

Query Parameters

currency_id
(Required)
ID of currency for which we need to post adjustment.
adjustment_date
(Required)
Date of adjustment.
exchange_rate
(Required)
Exchange rate of the currency.
notes
(Required)
Notes for base currency adjustment.
organization_id
(Required)
ID of the organization

Request Example

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

Response Example

{ "code": 0, "message": "success", "data": { "adjustment_date": "2013-09-05", "exchange_rate": 1, "currency_id": "460000000000109", "accounts": [ { "account_id": "460000000000364", "account_name": "Accounts Receivable", "bcy_balance": 171.47, "fcy_balance": 139.41, "adjusted_balance": 209.12, "gain_or_loss": 37.65, "gl_specific_type": 5 } ], "notes": "Base Currency Adjustment against EUR", "currency_code": "EUR" } }