Journals

Journals AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Journals are used by accountants to work directly with the general ledger to create both debit and credit entries for unique financial transactions.

Download Journals OpenAPI Document

Attribute

journal_id
string
ID of the Journal.
entry_number
string
Entry Number of the Journal.
reference_number
string
Reference number for the journal.
notes
string
Notes for the journal.
currency_id
string
ID of the Currency Associated with the Journal.
currency_code
string
Code of the Currency Associated with the Journal.
currency_symbol
string
Symbol of the Currency Associated with the Journal.
exchange_rate
double
Exchange Rate between the Currencies.
journal_date
string
Date on which the journal to be recorded.
journal_type
string
Type of the Journal. Allowed values: Cash and Both .
line_items
array
Line items for the journal.
Show Sub-Attributes arrow
line_id
string
ID of the Line.
account_id
string
ID of account for which journals to be recorded.
customer_id
string
ID of the Customer/Vendor.
customer_name
string
Name of the Customer/Vendor.
account_name
string
Name of the Account.
description
string
Description that can be given at the line item level.
debit_or_credit
string
Whether the accounts needs to be debited or credited. Allowed Values: debit and credit.
tax_exemption_id
string
🇮🇳 India
only
ID of the Tax Exemption.
tax_exemption_type
string
🇮🇳 India
only
Type of the Tax Exemption. Allowed Values : customer and item
tax_exemption_code
string
🇮🇳 India
only
Code of the Tax Exemption.
tax_id
string
ID of the tax.
tax_name
string
Name of the Tax.
tax_type
string
Type of the Tax.
tax_percentage
string
Percentage of the Tax.
amount
double
Amount to be recorded for the journal.
bcy_amount
double
Amount in Base Currency.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
Show Sub-Attributes arrow
tag_id
string
ID of the tag.
tag_option_id
string
ID of the tag option.
location_id
string
Location ID.
location_name
string
Name of the location.
project_id
string
ID of the Project.
project_name
string
Name of the Project.
location_id
string
Location ID.
location_name
string
Name of the location.
line_item_total
double
Total of the Line Item.
total
double
Total of the Journal.
bcy_total
double
Total in Base Currency.
price_precision
integer
Price Precision for the Values.
taxes
array
Show Sub-Attributes arrow
tax_name
string
Name of the Tax.
tax_amount
double
Amount of Tax.
debit_or_credit
string
Whether the accounts needs to be debited or credited. Allowed Values: debit and credit.
tax_account
boolean
Account for recording Tax.
created_time
string
Created Time of the Journal.
last_modified_time
string
Last Modified Time of the Journal.
status
string
Search Journal by journal status. Allowed Values: draft and published.
custom_fields
array
Custom fields for the journal.
Show Sub-Attributes arrow
customfield_id
string
ID of the Custom Field.
value
string
Value of the Custom Field.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
Show Sub-Attributes arrow
tag_id
string
ID of the tag.
tag_name
string
Name of the tag.
tag_option_id
string
ID of the tag option.
tag_option_name
string
Name of the tag option.
is_tag_mandatory
boolean
Used to check if the tag is mandatory.

Example

{ "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", "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_id": "string", "tax_name": "string", "tax_type": "tax", "tax_percentage": "string", "amount": 5000, "bcy_amount": 100, "tags": [ { "tag_id": "460000000000567", "tag_option_id": "460000000014044" } ], "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, "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" } ], "tags": [ { "tag_id": "460000000000567", "tag_name": "Business Unit", "tag_option_id": "460000000014044", "tag_option_name": "Sales", "is_tag_mandatory": false } ] }

Create a journal AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Create a journal.
OAuth Scope : ERP.accountants.CREATE

Arguments

journal_date
string
(Required)
Date on which the journal to be recorded.
reference_number
string
Reference number for the journal.
notes
string
Notes for the journal.
journal_type
string
Type of the Journal. Allowed values: Cash and Both .
currency_id
string
ID of the Currency Associated with the Journal.
exchange_rate
double
Exchange Rate between the Currencies.
location_id
string
Location ID.
line_items
array
Line items for the journal.
Show Sub-Attributes arrow
account_id
string
ID of account for which journals to be recorded.
customer_id
string
ID of the Customer/Vendor.
line_id
string
ID of the Line.
description
string
Description that can be given at the line item level.
tax_exemption_id
string
🇮🇳 India
only
ID of the Tax Exemption.
tax_exemption_type
string
🇮🇳 India
only
Type of the Tax Exemption. Allowed Values : customer and item
tax_exemption_code
string
🇮🇳 India
only
Code of the Tax Exemption.
tax_id
string
ID of the tax.
amount
double
(Required)
Amount to be recorded for the journal.
debit_or_credit
string
(Required)
Whether the accounts needs to be debited or credited. Allowed Values: debit and credit.
location_id
string
Location ID.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
Show Sub-Attributes arrow
tag_id
string
ID of the tag.
tag_option_id
string
ID of the tag option.
project_id
string
ID of the Project.
tax_exemption_code
string
🇮🇳 India
only
Code of the Tax Exemption.
tax_exemption_type
string
🇮🇳 India
only
Type of the Tax Exemption. Allowed Values : customer and item
status
string
Search Journal by journal status. Allowed Values: draft and published.
custom_fields
array
Custom fields for the journal.
Show Sub-Attributes arrow
customfield_id
string
ID of the Custom Field.
value
string
Value of the Custom Field.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
Show Sub-Attributes arrow
tag_id
string
ID of the tag.
tag_option_id
string
ID of the tag option.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
parameters_data='{"field1":"value1","field2":"value2"}'; headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.in/erp/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.in/erp/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.in/erp/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.in") payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}" headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "application/json" } conn.request("POST", "/erp/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.in", "port": null, "path": "/erp/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.in/erp/v3/journals?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
{ "journal_date": "2013-09-04", "reference_number": "7355", "notes": "Loan repayment", "journal_type": "both", "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_exemption_type": "string", "tax_exemption_code": "string", "tax_id": "string", "amount": 5000, "debit_or_credit": "credit", "location_id": "460000000038080", "tags": [ { "tag_id": "460000000000567", "tag_option_id": "460000000014044" } ], "project_id": "460000000898001" } ], "tax_exemption_code": "string", "tax_exemption_type": "string", "status": "draft", "custom_fields": [ { "customfield_id": "460000000098001", "value": "Normal" } ], "tags": [ { "tag_id": "460000000000567", "tag_option_id": "460000000014044" } ] }

Response Example

{ "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", "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_id": "string", "tax_name": "string", "tax_type": "tax", "tax_percentage": "string", "amount": 5000, "bcy_amount": 100, "tags": [ { "tag_id": "460000000000567", "tag_option_id": "460000000014044" } ], "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, "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" } ], "tags": [ { "tag_id": "460000000000567", "tag_name": "Business Unit", "tag_option_id": "460000000014044", "tag_option_name": "Sales", "is_tag_mandatory": false } ] } }

Get journal list AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Get journal list.
OAuth Scope : ERP.accountants.READ

Query Parameters

organization_id
string
(Required)
ID of the organization
entry_number
string
Search journals by journal entry number. Variants: entry_number_startswith and entry_number_contains
reference_number
string
Search journals by journal reference number. Variants: reference_number_startswith and reference_number_contains
date
string
Search journals by journal date. Variants: date_start, date_end, date_before and date_after
notes
string
Search journals by journal notes. Variants: notes_startswith and notes_contains
last_modified_time
string
Search the journals using Last Modified Time.
total
double
Search journals by journal total. Variants: total_less_than, total_less_equals, total_greater_than and total_greater_equals
customer_id
string
Search Journals using Customer ID.
vendor_id
string
Search the journals using Vendor ID.
filter_by
string
Filter journals by journal date. Allowed Values: JournalDate.All, JournalDate.Today, JournalDate.ThisWeek, JournalDate.ThisMonth, JournalDate.ThisQuarter and JournalDate.ThisYear
sort_column
string
Sort journal list. Allowed Values: journal_date, entry_number, reference_number and total
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

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.in/erp/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.in/erp/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.in/erp/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.in") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/erp/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.in", "port": null, "path": "/erp/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.in/erp/v3/journals?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "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", "tags": [ { "tag_id": "460000000000567", "tag_name": "Business Unit", "tag_option_id": "460000000014044", "tag_option_name": "Sales", "is_tag_mandatory": false } ] }, {...}, {...} ] }

Update a journal AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Updates the journal with given information.
OAuth Scope : ERP.accountants.UPDATE

Arguments

journal_date
string
(Required)
Date on which the journal to be recorded.
reference_number
string
Reference number for the journal.
notes
string
Notes for the journal.
journal_type
string
Type of the Journal. Allowed values: Cash and Both .
currency_id
string
ID of the Currency Associated with the Journal.
exchange_rate
double
Exchange Rate between the Currencies.
location_id
string
Location ID.
line_items
array
Line items for the journal.
Show Sub-Attributes arrow
account_id
string
ID of account for which journals to be recorded.
customer_id
string
ID of the Customer/Vendor.
line_id
string
ID of the Line.
description
string
Description that can be given at the line item level.
tax_exemption_id
string
🇮🇳 India
only
ID of the Tax Exemption.
tax_exemption_type
string
🇮🇳 India
only
Type of the Tax Exemption. Allowed Values : customer and item
tax_exemption_code
string
🇮🇳 India
only
Code of the Tax Exemption.
tax_id
string
ID of the tax.
amount
double
(Required)
Amount to be recorded for the journal.
debit_or_credit
string
(Required)
Whether the accounts needs to be debited or credited. Allowed Values: debit and credit.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
Show Sub-Attributes arrow
tag_id
string
ID of the tag.
tag_option_id
string
ID of the tag option.
location_id
string
Location ID.
project_id
string
ID of the Project.
tax_exemption_code
string
🇮🇳 India
only
Code of the Tax Exemption.
tax_exemption_type
string
🇮🇳 India
only
Type of the Tax Exemption. Allowed Values : customer and item
custom_fields
array
Custom fields for the journal.
Show Sub-Attributes arrow
customfield_id
string
ID of the Custom Field.
value
string
Value of the Custom Field.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
Show Sub-Attributes arrow
tag_id
string
ID of the tag.
tag_option_id
string
ID of the tag option.

Path Parameters

journal_id
string
(Required)
Unique identifier of the journal.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
parameters_data='{"field1":"value1","field2":"value2"}'; headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.in/erp/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.in/erp/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.in/erp/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.in") payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}" headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "application/json" } conn.request("PUT", "/erp/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.in", "port": null, "path": "/erp/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.in/erp/v3/journals/460000000038001?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
{ "journal_date": "2013-09-04", "reference_number": "7355", "notes": "Loan repayment", "journal_type": "both", "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_exemption_type": "string", "tax_exemption_code": "string", "tax_id": "string", "amount": 5000, "debit_or_credit": "credit", "tags": [ { "tag_id": "460000000000567", "tag_option_id": "460000000014044" } ], "location_id": "460000000038080", "project_id": "460000000898001" } ], "tax_exemption_code": "string", "tax_exemption_type": "string", "custom_fields": [ { "customfield_id": "460000000098001", "value": "Normal" } ], "tags": [ { "tag_id": "460000000000567", "tag_option_id": "460000000014044" } ] }

Response Example

{ "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", "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_id": "string", "tax_name": "string", "tax_type": "tax", "tax_percentage": "string", "amount": 5000, "bcy_amount": 100, "tags": [ { "tag_id": "460000000000567", "tag_option_id": "460000000014044" } ], "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, "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" } ], "tags": [ { "tag_id": "460000000000567", "tag_name": "Business Unit", "tag_option_id": "460000000014044", "tag_option_name": "Sales", "is_tag_mandatory": false } ] } }

Get journal AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Get the details of the journal.
OAuth Scope : ERP.accountants.READ

Path Parameters

journal_id
string
(Required)
Unique identifier of the journal.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.in/erp/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.in/erp/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.in/erp/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.in") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/erp/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.in", "port": null, "path": "/erp/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.in/erp/v3/journals/460000000038001?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "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", "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_id": "string", "tax_name": "string", "tax_type": "tax", "tax_percentage": "string", "amount": 5000, "bcy_amount": 100, "tags": [ { "tag_id": "460000000000567", "tag_option_id": "460000000014044" } ], "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, "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" } ], "tags": [ { "tag_id": "460000000000567", "tag_name": "Business Unit", "tag_option_id": "460000000014044", "tag_option_name": "Sales", "is_tag_mandatory": false } ] } }

Delete a journal AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Deletes the given journal.
OAuth Scope : ERP.accountants.DELETE

Path Parameters

journal_id
string
(Required)
Unique identifier of the journal.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.in/erp/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.in/erp/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.in/erp/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.in") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("DELETE", "/erp/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.in", "port": null, "path": "/erp/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.in/erp/v3/journals/460000000038001?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "The selected journal entry has been deleted." }

Mark a journal as published AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Mark a draft journal as published.
OAuth Scope : ERP.accountants.CREATE

Path Parameters

journal_id
string
(Required)
Unique identifier of the journal.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.in/erp/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.in/erp/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.in/erp/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.in") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("POST", "/erp/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.in", "port": null, "path": "/erp/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.in/erp/v3/journals/460000000038001/status/publish?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "Journal has been published." }

Add attachment to a journal AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Attach a file to a journal.
OAuth Scope : ERP.accountants.CREATE

Path Parameters

journal_id
string
(Required)
Unique identifier of the journal.

Query Parameters

organization_id
string
(Required)
ID of the organization
attachment
binary
The file that is to be added as an Attachment in the Journal.
doc
binary
Document that is to be attached.
totalFiles
integer
Total number of files.
document_ids
string
ID's of the document.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.in/erp/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.in/erp/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.in/erp/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.in") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("POST", "/erp/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.in", "port": null, "path": "/erp/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.in/erp/v3/journals/460000000038001/attachment?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "Your file has been successfully attached to the journal." }

Add comment AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Add a comment for a journal.
OAuth Scope : ERP.accountants.CREATE

Arguments

description
string
Description of a comment.

Path Parameters

journal_id
string
(Required)
Unique identifier of the journal.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
parameters_data='{"field1":"value1","field2":"value2"}'; headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.in/erp/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.in/erp/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.in/erp/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.in") payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}" headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "application/json" } conn.request("POST", "/erp/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.in", "port": null, "path": "/erp/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.in/erp/v3/journals/460000000038001/comments?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
{ "description": "Journal Created" }

Response Example

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

Delete a comment AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Delete a jounral comment.
OAuth Scope : ERP.accountants.DELETE

Path Parameters

journal_id
string
(Required)
Unique identifier of the journal.
comment_id
string
(Required)
Unique identifier of the comment.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.in/erp/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.in/erp/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.in/erp/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.in") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("DELETE", "/erp/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.in", "port": null, "path": "/erp/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.in/erp/v3/journals/460000000038001/comments/460000000048023?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "The selected journal comment entries have been deleted." }