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

POST

/basecurrencyadjustment

GET

/basecurrencyadjustment

GET

/basecurrencyadjustment/{base_currency_adjustment_id}

DELETE

/basecurrencyadjustment/{base_currency_adjustment_id}

GET

/basecurrencyadjustment/accounts

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

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

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

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/basecurrencyadjustment?organization_id=10234695&account_ids=460000000000364"
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/basecurrencyadjustment?organization_id=10234695&account_ids=460000000000364")
  .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/basecurrencyadjustment?organization_id=10234695&account_ids=460000000000364', 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/basecurrencyadjustment?organization_id=10234695&account_ids=460000000000364", 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/basecurrencyadjustment?organization_id=10234695&account_ids=460000000000364",
  "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/basecurrencyadjustment?organization_id=10234695&account_ids=460000000000364' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "currency_id": "460000000000109",
    "adjustment_date": "2013-09-05",
    "exchange_rate": 1,
    "notes": "Base Currency Adjustment against EUR"
}

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

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/basecurrencyadjustment?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/basecurrencyadjustment?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/basecurrencyadjustment?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/basecurrencyadjustment?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/basecurrencyadjustment?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/basecurrencyadjustment?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/basecurrencyadjustment/460000000039001?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/basecurrencyadjustment/460000000039001?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/basecurrencyadjustment/460000000039001?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/basecurrencyadjustment/460000000039001?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/basecurrencyadjustment/460000000039001?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/basecurrencyadjustment/460000000039001?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/basecurrencyadjustment/460000000039001?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/basecurrencyadjustment/460000000039001?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/basecurrencyadjustment/460000000039001?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/basecurrencyadjustment/460000000039001?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/basecurrencyadjustment/460000000039001?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/basecurrencyadjustment/460000000039001?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/basecurrencyadjustment/accounts?organization_id=10234695&currency_id=460000000000109&adjustment_date=2013-09-05&exchange_rate=1&notes=Base Currency Adjustment against EUR"
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/basecurrencyadjustment/accounts?organization_id=10234695&currency_id=460000000000109&adjustment_date=2013-09-05&exchange_rate=1&notes=Base%20Currency%20Adjustment%20against%20EUR")
  .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/basecurrencyadjustment/accounts?organization_id=10234695&currency_id=460000000000109&adjustment_date=2013-09-05&exchange_rate=1&notes=Base%20Currency%20Adjustment%20against%20EUR', 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/basecurrencyadjustment/accounts?organization_id=10234695&currency_id=460000000000109&adjustment_date=2013-09-05&exchange_rate=1&notes=Base%20Currency%20Adjustment%20against%20EUR", 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/basecurrencyadjustment/accounts?organization_id=10234695&currency_id=460000000000109&adjustment_date=2013-09-05&exchange_rate=1&notes=Base%20Currency%20Adjustment%20against%20EUR",
  "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/basecurrencyadjustment/accounts?organization_id=10234695&currency_id=460000000000109&adjustment_date=2013-09-05&exchange_rate=1&notes=Base%20Currency%20Adjustment%20against%20EUR' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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