Journals
Journals are used by accountants to work directly with the general ledger to create both debit and credit entries for unique financial transactions.
Attribute
Cash and Both .uk. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered, if he resides outside of the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu). digital_service, goods and service.debit and credit.customer and itemdebit and credit.draft and published.{
"journal_id": "460000000038001",
"entry_number": "1",
"reference_number": "7355",
"notes": "Loan repayment",
"currency_id": "460000000000097",
"currency_code": "USD",
"currency_symbol": "$",
"exchange_rate": 1,
"journal_date": "2013-09-04",
"journal_type": "both",
"vat_treatment": "string",
"product_type": "string",
"include_in_vat_return": true,
"is_bas_adjustment": true,
"line_items": [
{
"line_id": "460000000038005",
"account_id": "460000000000361",
"customer_id": "string",
"customer_name": "string",
"account_name": "Petty Cash",
"description": "string",
"debit_or_credit": "credit",
"tax_exemption_id": "string",
"tax_exemption_type": "string",
"tax_exemption_code": "string",
"tax_authority_id": "string",
"tax_authority_name": "string",
"tax_id": "string",
"tax_name": "string",
"tax_type": "tax",
"tax_percentage": "string",
"amount": 5000,
"bcy_amount": 100,
"acquisition_vat_id": "string",
"acquisition_vat_name": "string",
"acquisition_vat_percentage": "string",
"acquisition_vat_amount": "string",
"reverse_charge_vat_id": "string",
"reverse_charge_vat_name": "string",
"reverse_charge_vat_percentage": "string",
"reverse_charge_vat_amount": "string",
"tags": [
{
"is_tag_mandatory": false,
"tag_id": "460000000094001",
"tag_name": "Location",
"tag_option_id": "460000000048001",
"tag_option_name": "USA"
}
],
"location_id": "460000000038080",
"location_name": "string",
"project_id": "460000000898001",
"project_name": "Network Distribution"
}
],
"location_id": "460000000038080",
"location_name": "string",
"line_item_total": 5000,
"total": 5000,
"bcy_total": 100,
"price_precision": 2,
"taxes": [
{
"tax_name": "string",
"tax_amount": 0.1,
"debit_or_credit": "credit",
"tax_account": true
}
],
"created_time": "2013-09-04T09:40:07+0530",
"last_modified_time": "2013-09-05T17:13:31+0530",
"status": "draft",
"custom_fields": [
{
"customfield_id": "460000000098001",
"value": "Normal"
}
]
}
Create a journal
Create a journal.
OAuth Scope : ZohoBooks.accountants.CREATE
Arguments
Cash and Both .uk. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered, if he resides outside of the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu). digital_service, goods and service.customer and itemdebit and credit.customer and itemdraft and published.Query Parameters
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/journals?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/journals?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/journals?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/journals?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/journals?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/journals?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"journal_date": "2013-09-04",
"reference_number": "7355",
"notes": "Loan repayment",
"journal_type": "both",
"vat_treatment": "string",
"include_in_vat_return": true,
"product_type": "string",
"is_bas_adjustment": true,
"currency_id": "460000000000097",
"exchange_rate": 1,
"location_id": "460000000038080",
"line_items": [
{
"account_id": "460000000000361",
"customer_id": "string",
"line_id": "460000000038005",
"description": "string",
"tax_exemption_id": "string",
"tax_authority_id": "string",
"tax_exemption_type": "string",
"tax_exemption_code": "string",
"tax_authority_name": "string",
"tax_id": "string",
"amount": 5000,
"debit_or_credit": "credit",
"acquisition_vat_id": "string",
"reverse_charge_vat_id": "string",
"location_id": "460000000038080",
"tags": [
{
"tag_id": "460000000094001",
"tag_option_id": "460000000048001"
}
],
"project_id": "460000000898001"
}
],
"tax_exemption_code": "string",
"tax_exemption_type": "string",
"status": "draft",
"custom_fields": [
{
"customfield_id": "460000000098001",
"value": "Normal"
}
]
}
{
"code": 0,
"message": "The journal entry has been created.",
"journal": {
"journal_id": "460000000038001",
"entry_number": "1",
"reference_number": "7355",
"notes": "Loan repayment",
"currency_id": "460000000000097",
"currency_code": "USD",
"currency_symbol": "$",
"exchange_rate": 1,
"journal_date": "2013-09-04",
"journal_type": "both",
"vat_treatment": "string",
"product_type": "string",
"include_in_vat_return": true,
"is_bas_adjustment": true,
"line_items": [
{
"line_id": "460000000038005",
"account_id": "460000000000361",
"customer_id": "string",
"customer_name": "string",
"account_name": "Petty Cash",
"description": "string",
"debit_or_credit": "credit",
"tax_exemption_id": "string",
"tax_exemption_type": "string",
"tax_exemption_code": "string",
"tax_authority_id": "string",
"tax_authority_name": "string",
"tax_id": "string",
"tax_name": "string",
"tax_type": "tax",
"tax_percentage": "string",
"amount": 5000,
"bcy_amount": 100,
"acquisition_vat_id": "string",
"acquisition_vat_name": "string",
"acquisition_vat_percentage": "string",
"acquisition_vat_amount": "string",
"reverse_charge_vat_id": "string",
"reverse_charge_vat_name": "string",
"reverse_charge_vat_percentage": "string",
"reverse_charge_vat_amount": "string",
"tags": [
{
"is_tag_mandatory": false,
"tag_id": "460000000094001",
"tag_name": "Location",
"tag_option_id": "460000000048001",
"tag_option_name": "USA"
}
],
"location_id": "460000000038080",
"location_name": "string",
"project_id": "460000000898001",
"project_name": "Network Distribution"
}
],
"location_id": "460000000038080",
"location_name": "string",
"line_item_total": 5000,
"total": 5000,
"bcy_total": 100,
"price_precision": 2,
"taxes": [
{
"tax_name": "string",
"tax_amount": 0.1,
"debit_or_credit": "credit",
"tax_account": true
}
],
"created_time": "2013-09-04T09:40:07+0530",
"last_modified_time": "2013-09-05T17:13:31+0530",
"status": "draft",
"custom_fields": [
{
"customfield_id": "460000000098001",
"value": "Normal"
}
]
}
}
Get journal list
Get journal list.
OAuth Scope : ZohoBooks.accountants.READ
Query Parameters
entry_number_startswith and entry_number_containsreference_number_startswith and reference_number_containsdate_start, date_end, date_before and date_afternotes_startswith and notes_containstotal_less_than, total_less_equals, total_greater_than and total_greater_equalsJournalDate.All, JournalDate.Today, JournalDate.ThisWeek, JournalDate.ThisMonth, JournalDate.ThisQuarter and JournalDate.ThisYearjournal_date, entry_number, reference_number and totalheaders_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/journals?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/journals?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/journals?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/journals?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/journals?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/journals?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"journals": [
{
"journal_id": "460000000038001",
"journal_date": "2013-09-04",
"entry_number": "1",
"reference_number": "7355",
"currency_id": "460000000000097",
"notes": "Loan repayment",
"journal_type": "both",
"entity_type": "journal",
"total": 5000,
"bcy_total": 100,
"custom_field": "string"
},
{...},
{...}
]
}
Update a journal
Updates the journal with given information.
OAuth Scope : ZohoBooks.accountants.UPDATE
Arguments
Cash and Both .uk. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered, if he resides outside of the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu). digital_service, goods and service.customer and itemdebit and credit.customer and itemPath Parameters
Query Parameters
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/journals/460000000038001?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/journals/460000000038001?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/journals/460000000038001?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/journals/460000000038001?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/journals/460000000038001?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/journals/460000000038001?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"journal_date": "2013-09-04",
"reference_number": "7355",
"notes": "Loan repayment",
"journal_type": "both",
"vat_treatment": "string",
"include_in_vat_return": true,
"product_type": "string",
"is_bas_adjustment": true,
"currency_id": "460000000000097",
"exchange_rate": 1,
"location_id": "460000000038080",
"line_items": [
{
"account_id": "460000000000361",
"customer_id": "string",
"line_id": "460000000038005",
"description": "string",
"tax_exemption_id": "string",
"tax_authority_id": "string",
"tax_exemption_type": "string",
"tax_exemption_code": "string",
"tax_authority_name": "string",
"tax_id": "string",
"amount": 5000,
"debit_or_credit": "credit",
"acquisition_vat_id": "string",
"reverse_charge_vat_id": "string",
"tags": [
{
"tag_id": "460000000094001",
"tag_option_id": "460000000048001"
}
],
"location_id": "460000000038080",
"project_id": "460000000898001"
}
],
"tax_exemption_code": "string",
"tax_exemption_type": "string",
"custom_fields": [
{
"customfield_id": "460000000098001",
"value": "Normal"
}
]
}
{
"code": 0,
"message": "The journal entry has been updated.",
"journal": {
"journal_id": "460000000038001",
"entry_number": "1",
"reference_number": "7355",
"notes": "Loan repayment",
"currency_id": "460000000000097",
"currency_code": "USD",
"currency_symbol": "$",
"exchange_rate": 1,
"journal_date": "2013-09-04",
"journal_type": "both",
"vat_treatment": "string",
"product_type": "string",
"include_in_vat_return": true,
"is_bas_adjustment": true,
"line_items": [
{
"line_id": "460000000038005",
"account_id": "460000000000361",
"customer_id": "string",
"customer_name": "string",
"account_name": "Petty Cash",
"description": "string",
"debit_or_credit": "credit",
"tax_exemption_id": "string",
"tax_exemption_type": "string",
"tax_exemption_code": "string",
"tax_authority_id": "string",
"tax_authority_name": "string",
"tax_id": "string",
"tax_name": "string",
"tax_type": "tax",
"tax_percentage": "string",
"amount": 5000,
"bcy_amount": 100,
"acquisition_vat_id": "string",
"acquisition_vat_name": "string",
"acquisition_vat_percentage": "string",
"acquisition_vat_amount": "string",
"reverse_charge_vat_id": "string",
"reverse_charge_vat_name": "string",
"reverse_charge_vat_percentage": "string",
"reverse_charge_vat_amount": "string",
"tags": [
{
"is_tag_mandatory": false,
"tag_id": "460000000094001",
"tag_name": "Location",
"tag_option_id": "460000000048001",
"tag_option_name": "USA"
}
],
"location_id": "460000000038080",
"location_name": "string",
"project_id": "460000000898001",
"project_name": "Network Distribution"
}
],
"location_id": "460000000038080",
"location_name": "string",
"line_item_total": 5000,
"total": 5000,
"bcy_total": 100,
"price_precision": 2,
"taxes": [
{
"tax_name": "string",
"tax_amount": 0.1,
"debit_or_credit": "credit",
"tax_account": true
}
],
"created_time": "2013-09-04T09:40:07+0530",
"last_modified_time": "2013-09-05T17:13:31+0530",
"status": "draft",
"custom_fields": [
{
"customfield_id": "460000000098001",
"value": "Normal"
}
]
}
}
Get journal
Get the details of the journal.
OAuth Scope : ZohoBooks.accountants.READ
Path Parameters
Query Parameters
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/journals/460000000038001?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/journals/460000000038001?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/journals/460000000038001?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/journals/460000000038001?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/journals/460000000038001?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/journals/460000000038001?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"journal": {
"journal_id": "460000000038001",
"entry_number": "1",
"reference_number": "7355",
"notes": "Loan repayment",
"currency_id": "460000000000097",
"currency_code": "USD",
"currency_symbol": "$",
"exchange_rate": 1,
"journal_date": "2013-09-04",
"journal_type": "both",
"vat_treatment": "string",
"product_type": "string",
"include_in_vat_return": true,
"is_bas_adjustment": true,
"line_items": [
{
"line_id": "460000000038005",
"account_id": "460000000000361",
"customer_id": "string",
"customer_name": "string",
"account_name": "Petty Cash",
"description": "string",
"debit_or_credit": "credit",
"tax_exemption_id": "string",
"tax_exemption_type": "string",
"tax_exemption_code": "string",
"tax_authority_id": "string",
"tax_authority_name": "string",
"tax_id": "string",
"tax_name": "string",
"tax_type": "tax",
"tax_percentage": "string",
"amount": 5000,
"bcy_amount": 100,
"acquisition_vat_id": "string",
"acquisition_vat_name": "string",
"acquisition_vat_percentage": "string",
"acquisition_vat_amount": "string",
"reverse_charge_vat_id": "string",
"reverse_charge_vat_name": "string",
"reverse_charge_vat_percentage": "string",
"reverse_charge_vat_amount": "string",
"tags": [
{
"is_tag_mandatory": false,
"tag_id": "460000000094001",
"tag_name": "Location",
"tag_option_id": "460000000048001",
"tag_option_name": "USA"
}
],
"location_id": "460000000038080",
"location_name": "string",
"project_id": "460000000898001",
"project_name": "Network Distribution"
}
],
"location_id": "460000000038080",
"location_name": "string",
"line_item_total": 5000,
"total": 5000,
"bcy_total": 100,
"price_precision": 2,
"taxes": [
{
"tax_name": "string",
"tax_amount": 0.1,
"debit_or_credit": "credit",
"tax_account": true
}
],
"created_time": "2013-09-04T09:40:07+0530",
"last_modified_time": "2013-09-05T17:13:31+0530",
"status": "draft",
"custom_fields": [
{
"customfield_id": "460000000098001",
"value": "Normal"
}
]
}
}
Delete a journal
Deletes the given journal.
OAuth Scope : ZohoBooks.accountants.DELETE
Path Parameters
Query Parameters
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/journals/460000000038001?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/journals/460000000038001?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/journals/460000000038001?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/journals/460000000038001?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/journals/460000000038001?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/journals/460000000038001?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The selected journal entry has been deleted."
}
Mark a journal as published
Mark a draft journal as published.
OAuth Scope : ZohoBooks.accountants.CREATE
Path Parameters
Query Parameters
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/journals/460000000038001/status/publish?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/journals/460000000038001/status/publish?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/journals/460000000038001/status/publish?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/journals/460000000038001/status/publish?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/journals/460000000038001/status/publish?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/journals/460000000038001/status/publish?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "Journal has been published."
}
Add attachment to a journal
Attach a file to a journal.
OAuth Scope : ZohoBooks.accountants.CREATE
Path Parameters
Query Parameters
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/journals/460000000038001/attachment?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/journals/460000000038001/attachment?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/journals/460000000038001/attachment?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/journals/460000000038001/attachment?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/journals/460000000038001/attachment?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/journals/460000000038001/attachment?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
Add comment
Add a comment for a journal.
OAuth Scope : ZohoBooks.accountants.CREATE
Arguments
Path Parameters
Query Parameters
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/journals/460000000038001/comments?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/journals/460000000038001/comments?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/journals/460000000038001/comments?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/journals/460000000038001/comments?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/journals/460000000038001/comments?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/journals/460000000038001/comments?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"description": "Journal Created"
}
Delete a comment
Delete a jounral comment.
OAuth Scope : ZohoBooks.accountants.DELETE
Path Parameters
Query Parameters
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/journals/460000000038001/comments/460000000048023?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/journals/460000000038001/comments/460000000048023?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/journals/460000000038001/comments/460000000048023?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/journals/460000000038001/comments/460000000048023?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/journals/460000000038001/comments/460000000048023?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/journals/460000000038001/comments/460000000048023?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The selected journal comment entries have been deleted."
}
{ "code": 0, "message": "Journal comment has been added successfully.", "comment": [ { "comment_id": "460000000048023", "description": "string", "commented_by_id": "460000000017003", "commented_by": "John", "comment_type": "system", "date": "string", "operation_type": "Added" }, {...}, {...} ] }