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.

Attribute

journal_id
string
Unique identifier of the journal
journal_date
string
Date of the journal entry
journal_date_formatted
string
Formatted date of the journal entry
journal_number
string
Unique number of the journal
reversal_date
string
Date when the journal was reversed
is_period_end_journal
boolean
Indicates whether the journal is a period-end journal
fiscal_year
integer
Fiscal year to which the journal belongs
journal_template_name
string
Name of the journal template used
reference_number
string
Reference number associated with the journal
journal_number_prefix
string
Prefix of the journal entry number
journal_number_suffix
string
Suffix of the journal entry number
currency
object
Currency details associated with the journal
Show Sub-Attributes arrow
currency_id
string
Unique identifier of the currency
currency_code
string
Currency code
currency_symbol
string
Symbol of the currency
exchange_rate
double
Exchange rate applied for currency conversion
exchange_rate_formatted
string
Formatted exchange rate value
location
object
Details of the location associated with the journal
Show Sub-Attributes arrow
location_id
string
Unique identifier of the location
location_name
string
Name of the location
location_identification_number
string
Identification number of the location
location_difference
object
Location-level debit and credit differences
Show Sub-Attributes arrow
debit_diff
double
Debit difference amount for the branch
debit_diff_formatted
string
Formatted debit difference amount
location_name
string
Name of the branch for which the difference applies
credit_diff
double
Credit difference amount for the branch
credit_diff_formatted
string
Formatted credit difference amount
status
string
Status of the journal
status_formatted
string
Formatted status of the journal
notes
string
Notes associated with the journal
journal_type
string
Type of the journal
journal_type_formatted
string
Formatted type of the journal
journal_transaction_type
string
Transaction type of the journal
vat_treatment
string
VAT treatment applied to the journal
tax_treatment
string
Tax treatment applied to the journal
product_type
string
Type of product associated with the journal
include_in_vat_return
boolean
Indicates if the journal is included in VAT return
is_bas_adjustment
boolean
Indicates if Journal is created for BAS Adjustment
entity_type
string
Type of entity associated with the journal
entity_type_formatted
string
Formatted type of entity associated with the journal
available_receivables_credits
double
Available receivables credits applied to the journal
available_receivables_credits_formatted
string
Formatted available receivables credits value
available_payables_credits
double
Available payables credits applied to the journal
available_payables_credits_formatted
string
Formatted available payables credits value
price_precision
integer
Number of decimal places used for price calculations
total
double
Total amount in the journal in foreign currency
total_formatted
string
Formatted total amount in the journal in foreign currency
bcy_total
double
Total amount in base currency
bcy_total_formatted
string
Formatted total amount in base currency
sub_total
double
Total of all line items in the journal
sub_total_formatted
string
Formatted line item total
acquisition_vat_total
double
Total VAT amount for acquisitions
acquisition_vat_total_formatted
string
Formatted acquisition VAT total
acquisition_vat
object
Breakdown of acquisition VAT amounts by tax type
Show Sub-Attributes arrow
tax_id
string
Unique identifier of the acquisition VAT tax
tax_name
string
Name of the acquisition VAT tax
tax_amount
double
Tax amount applied for acquisition VAT
tax_amount_formatted
string
Formatted acquisition VAT tax amount
tax_percentage
double
Percentage of the acquisition VAT tax
reverse_charge_vat_total
double
Total VAT amount under reverse charge mechanism
reverse_charge_vat_total_formatted
string
Formatted reverse charge VAT total
reverse_charge_vat
object
Breakdown of reverse charge VAT amounts by tax type
Show Sub-Attributes arrow
tax_id
string
Unique identifier of the reverse charge VAT tax
tax_name
string
Name of the reverse charge VAT tax
tax_amount
double
Tax amount applied under reverse charge
tax_amount_formatted
string
Formatted reverse charge VAT tax amount
tax_percentage
double
Percentage of the reverse charge VAT tax
taxes
array
Taxes applied in the journal
Show Sub-Attributes arrow
tax_name
string
Name of the tax
tax_amount
double
Tax amount
tax_amount_formatted
string
Formatted tax amount
debit_or_credit
string
Indicates whether the tax is debit or credit
tax_account
string
Account associated with the tax
project
object
Project associated with the journal
Show Sub-Attributes arrow
project_id
string
Unique identifier of the project
project_name
string
Name of the project
statement_transactions
array
Imported bank statement transactions linked to the journal
Show Sub-Attributes arrow
statement_transaction_id
string
Unique identifier of the statement transaction
date
string
Transaction date
date_formatted
string
Formatted transaction date
amount
double
Transaction amount
amount_formatted
string
Formatted transaction amount
payee
string
Payee of the transaction
description
string
Transaction description
reference_number
string
Reference number of the transaction
status
string
Transaction status
status_formatted
string
Formatted transaction status
account_id
string
Account linked to the statement transaction
reverse_charge_taxes
array
Reverse charge taxes applied to the journal
Show Sub-Attributes arrow
id
string
Unique identifier of the reverse charge tax
text
string
Label of the tax
percentage
double
Tax percentage
type
string
Type of reverse charge tax
invoices_credited
array
Invoices credited in the journal
Show Sub-Attributes arrow
journal_invoice_id
string
Unique identifier of the journal invoice
is_opening_balance
boolean
Indicates if the invoice is an opening balance
invoice_id
string
Unique identifier of the credited invoice
date
string
Invoice date
date_formatted
string
Formatted invoice date
invoice_number
string
Invoice number
credited_amount
double
Amount credited from the invoice
credited_amount_formatted
string
Formatted credited amount
bills_credited
array
Bills credited in the journal
Show Sub-Attributes arrow
journal_bill_id
string
Unique identifier of the journal bill
bill_id
string
Unique identifier of the credited bill
is_opening_balance
boolean
Indicates if the bill is an opening balance
date
string
Bill date
date_formatted
string
Formatted bill date
bill_number
string
Bill number
credited_amount
double
Amount credited from the bill
credited_amount_formatted
string
Formatted credited amount
is_accrual_journal
boolean
Indicates if the journal is on accrual basis
department_id
string
Unique identifier of the department associated with the journal
submitter_details
object
Details of the journal submitter
Show Sub-Attributes arrow
user
object
User who submitted the journal
Show Sub-Attributes arrow
user_email
string
Email of the submitter
user_id
string
Unique identifier of the submitter
user_name
string
Name of the submitter
user_photo_url
string
Photo URL of the submitter
user_name_email
string
Combined name and email of the submitter
submitted_date
string
Date when the journal was submitted
submitted_date_formatted
string
Formatted submission date
approver_user_id
string
Unique identifier of the approver
approvers_list
array
List of users who approved or need to approve the journal
Show Sub-Attributes arrow
order
integer
Approval order
user
object
Approver details
Show Sub-Attributes arrow
user_email
string
Email of the approver
user_id
string
Unique identifier of the approver
user_name
string
Name of the approver
user_photo_url
string
Photo URL of the approver
is_next_approver
boolean
Indicates if this approver is next in line
user_status
string
Status of the approver
user_status_formatted
string
Formatted approver status
available_apps
array
Apps available to the approver
has_approved
boolean
Indicates if the approver has approved
approval_status
string
Approval status
approval_status_formatted
string
Formatted approval status
submitted_date
string
Date when sent for approval
submitted_date_formatted
string
Formatted submitted date
approved_date
string
Date when approved
approved_date_formatted
string
Formatted approved date
is_final_approver
boolean
Indicates if this approver is the final approver
html_string
string
created_time
string
Time when the journal was created
created_time_formatted
string
Formatted created time
last_modified_time
string
Time when the journal was last modified
last_modified_time_formatted
string
Formatted last modified time
line_items
array
List of line items in the journal
Show Sub-Attributes arrow
line_item_id
string
Unique identifier of the line item
account
object
Account details associated with the line item
Show Sub-Attributes arrow
account_id
string
Unique identifier of the account
account_name
string
Name of the account
account_type
string
Type of the account
contact
object
Contact details linked to the line item
Show Sub-Attributes arrow
contact_id
string
Unique identifier of the contact
contact_name
string
Name of the contact
item_order
integer
Order of the line item in the journal
description
string
Description of the line item
debit_or_credit
string
Indicates whether the line item is a debit or credit
tax_exemption
object
Tax exemption details
Show Sub-Attributes arrow
tax_exemption_id
string
Unique identifier of the tax exemption
tax_exemption_type
string
Type of tax exemption
tax_exemption_code
string
Code of the tax exemption
tax_authority
object
Tax authority details
Show Sub-Attributes arrow
tax_authority_id
string
Unique identifier of the tax authority
tax_authority_name
string
Name of the tax authority
tax
object
Tax details for the line item
Show Sub-Attributes arrow
tax_id
string
Unique identifier of the tax
tax_name
string
Name of the tax
tax_name_formatted
string
Formatted tax name
tax_percentage
double
Tax percentage applied
tax_type
string
Type of tax
tax_type_formatted
string
Formatted tax type
tax_status
string
Status of the tax
tax_start_date
string
Start date of the tax
tax_end_date
string
End date of the tax
tax_groups_details
array
Details of grouped taxes applied to the line item
Show Sub-Attributes arrow
id
string
Unique identifier of the tax group
name
string
Name of the tax group
type
string
Type of the tax group
type_formatted
string
Formatted type of the tax group
percentage
double
Percentage applied for the tax group
deleted
boolean
Indicates if the tax group is deleted
tax_specific_type
string
Specific type of tax in the group
start_date
string
Start date of the tax group
end_date
string
End date of the tax group
is_non_advol_tax
boolean
Indicates if it is a non-ad valorem tax
taxes
array
Taxes applied in the journal line item
Show Sub-Attributes arrow
tax_id
string
Unique identifier of the tax
tax_name
string
Name of the tax
tax_amount
double
Amount of the tax
tax_amount_formatted
string
Formatted tax amount
amount
double
Amount of the line item
amount_formatted
string
Formatted amount of the line item
bcy_amount
double
Base currency amount of the line item
bcy_amount_formatted
string
Formatted base currency amount
acquisition_vat
object
Acquisition VAT details
Show Sub-Attributes arrow
tax_id
string
Unique identifier of the acquisition VAT
tax_name
string
Name of the acquisition VAT
tax_amount
double
Amount of acquisition VAT
tax_amount_formatted
string
Formatted acquisition VAT amount
tax_percentage
double
Percentage of acquisition VAT
reverse_charge_vat
object
Reverse charge VAT details
Show Sub-Attributes arrow
tax_id
string
Unique identifier of the reverse charge VAT
tax_name
string
Name of the reverse charge VAT
tax_amount
double
Amount of reverse charge VAT
tax_amount_formatted
string
Formatted reverse charge VAT amount
tax_percentage
double
Percentage of reverse charge VAT
acquisition_tax
object
Acquisition tax details
Show Sub-Attributes arrow
tax_id
string
Unique identifier of the acquisition tax
tax_name
string
Name of the acquisition tax
tax_amount
double
Amount of acquisition tax
tax_amount_formatted
string
Formatted acquisition tax amount
tax_percentage
double
Percentage of acquisition tax
reverse_charge_tax
object
Reverse charge tax details
Show Sub-Attributes arrow
tax_id
string
Unique identifier of the reverse charge tax
tax_name
string
Name of the reverse charge tax
tax_name_formatted
string
Formatted name of the reverse charge tax
tax_amount
double
Amount of reverse charge tax
tax_amount_formatted
string
Formatted reverse charge tax amount
tax_percentage
double
Percentage of reverse charge tax
tax_type
string
Type of reverse charge tax
tax_status
string
Status of the reverse charge tax
reverse_charge_line_item_taxes
array
List of reverse charge taxes applied to the line item
Show Sub-Attributes arrow
id
string
Unique identifier of the reverse charge tax
project
object
Project details linked to the line item
Show Sub-Attributes arrow
project_id
string
Unique identifier of the project
project_name
string
Name of the project
location
object
Location details
Show Sub-Attributes arrow
location_id
string
Unique identifier of the location
location_name
string
Name of the location
tags
array
Tags associated with the line item
Show Sub-Attributes arrow
is_tag_mandatory
boolean
Indicates if the tag is mandatory
tag_id
string
Unique identifier of the tag
tag_name
string
Name of the tag
tag_option
object
Tag option details
Show Sub-Attributes arrow
tag_option_id
string
Unique identifier of the tag option
tag_option_name
string
Name of the tag option
taxable_type
string
Taxable type of the line item
department_id
string
Unique identifier of the department
created_by
object
Details of the user who created the journal
Show Sub-Attributes arrow
user_id
string
Unique identifier of the user
user_name
string
Name of the user
last_modified_by
object
Details of the user who last modified the journal
Show Sub-Attributes arrow
user_id
string
Unique identifier of the user
user_name
string
Name of the user

Example

{ "journal_id": "982000000567001", "journal_date": "2023-10-01", "journal_date_formatted": "01/10/2023", "journal_number": "J-12345", "reversal_date": "2023-10-15", "is_period_end_journal": true, "fiscal_year": "2025", "journal_template_name": "General Ledger Template", "reference_number": "REF-67890", "journal_number_prefix": "JE", "journal_number_suffix": "001", "currency": { "currency_id": "460000000055555", "currency_code": "USD", "currency_symbol": "$" }, "exchange_rate": 1.23, "exchange_rate_formatted": "1.23", "location": { "location_id": "982000000567013", "location_name": "Warehouse A", "location_identification_number": "LOC-001" }, "location_difference": { "debit_diff": 120.5, "debit_diff_formatted": "120.50", "location_name": "Los Angeles Branch", "credit_diff": 120.5, "credit_diff_formatted": "120.50" }, "status": "draft", "status_formatted": "Draft", "notes": "Important transaction", "journal_type": "accrual", "journal_type_formatted": "Accrual", "journal_transaction_type": "sales_journal", "vat_treatment": "Domestic", "tax_treatment": "Standard Rated", "product_type": "service", "include_in_vat_return": true, "is_bas_adjustment": false, "entity_type": "item", "entity_type_formatted": "Item", "available_receivables_credits": 500, "available_receivables_credits_formatted": "500.00", "available_payables_credits": 300, "available_payables_credits_formatted": "300.00", "price_precision": 2, "total": "1000.00", "total_formatted": "$1,000.00", "bcy_total": "1000.00", "bcy_total_formatted": "$1,000.00", "sub_total": 1400.5, "sub_total_formatted": "1,400.50", "acquisition_vat_total": 250, "acquisition_vat_total_formatted": "250.00", "acquisition_vat": { "tax_id": "460000000044444", "tax_name": "VAT 20%", "tax_amount": 200, "tax_amount_formatted": "200.00", "tax_percentage": 20 }, "reverse_charge_vat_total": 300, "reverse_charge_vat_total_formatted": "300.00", "reverse_charge_vat": { "tax_id": "460000000044445", "tax_name": "Reverse VAT 10%", "tax_amount": 300, "tax_amount_formatted": "300.00", "tax_percentage": 10 }, "taxes": [ { "tax_name": "VAT 20%", "tax_amount": 100, "tax_amount_formatted": "100.00", "debit_or_credit": "debit", "tax_account": "Tax Payable" } ], "project": { "project_id": "460000000045678", "project_name": "Migration Project" }, "statement_transactions": [ { "statement_transaction_id": "460000000044467", "date": "2025-03-15", "date_formatted": "15/03/2025", "amount": 500, "amount_formatted": "500.00", "payee": "ABC Supplies", "description": "Office Supplies Purchase", "reference_number": "REF-999", "status": "matched", "status_formatted": "Matched", "account_id": "460000000044444" } ], "reverse_charge_taxes": [ { "id": "460000000044444", "text": "Reverse VAT 10%", "percentage": 10, "type": "VAT" } ], "invoices_credited": [ { "journal_invoice_id": "982000000567109", "is_opening_balance": false, "invoice_id": "982000000567110", "date": "2025-03-10", "date_formatted": "10/03/2025", "invoice_number": "INV-1001", "credited_amount": "200.00", "credited_amount_formatted": "200.00 USD" } ], "bills_credited": [ { "journal_bill_id": "982000000567111", "bill_id": "982000000567112", "is_opening_balance": false, "date": "2025-03-08", "date_formatted": "08/03/2025", "bill_number": "BILL-1002", "credited_amount": "150.00", "credited_amount_formatted": "150.00 USD" } ], "is_accrual_journal": true, "department_id": "982000000567113", "submitter_details": { "user": { "user_email": "johndoe@example.com", "user_id": "982000000567114", "user_name": "John Doe", "user_photo_url": "https://example.com/photo.jpg", "user_name_email": "John Doe (johndoe@example.com)" }, "submitted_date": "2025-03-29", "submitted_date_formatted": "29/03/2025", "approver_user_id": "982000000567115" }, "approvers_list": [ { "order": 1, "user": { "user_email": "johndoe@example.com", "user_id": "982000000567116", "user_name": "John Doe", "user_photo_url": "https://example.com/photo.jpg", "is_next_approver": true, "user_status": "active", "user_status_formatted": "Active", "available_apps": [ [ "Books", "CRM" ] ] }, "has_approved": false, "approval_status": "pending", "approval_status_formatted": "Pending", "submitted_date": "2025-03-29", "submitted_date_formatted": "29/03/2025", "approved_date": "2025-03-30", "approved_date_formatted": "30/03/2025", "is_final_approver": true } ], "html_string": "string", "created_time": "2023-10-01T12:00:00Z", "created_time_formatted": "01-03-2025 10:00 AM", "last_modified_time": "2023-10-01T12:30:00Z", "last_modified_time_formatted": "31-03-2025 03:45 PM", "line_items": [ { "line_item_id": "982000000567401", "account": { "account_id": "982000000567402", "account_name": "Accounts Receivable", "account_type": "asset" }, "contact": { "contact_id": "982000000567403", "contact_name": "Jane Smith" }, "item_order": 1, "description": "Consulting services provided", "debit_or_credit": "debit", "tax_exemption": { "tax_exemption_id": "982000000567404", "tax_exemption_type": "Nonprofit", "tax_exemption_code": "TXE-001" }, "tax_authority": { "tax_authority_id": "982000000567405", "tax_authority_name": "IRS" }, "tax": { "tax_id": "982000000567406", "tax_name": "VAT", "tax_name_formatted": "Value Added Tax", "tax_percentage": "18.00", "tax_type": "tds", "tax_type_formatted": "TDS", "tax_status": "active", "tax_start_date": "2025-01-01", "tax_end_date": "2025-12-31" }, "tax_groups_details": [ { "id": "982000000567407", "name": "GST Group", "type": "group", "type_formatted": "Group", "percentage": "12.00", "deleted": false, "tax_specific_type": "CGST", "start_date": "2025-01-01", "end_date": "2025-12-31", "is_non_advol_tax": false } ], "taxes": [ { "tax_id": "982000000567408", "tax_name": "Sales Tax", "tax_amount": 25, "tax_amount_formatted": "$25.00" } ], "amount": "500.00", "amount_formatted": "$500.00", "bcy_amount": "420.00", "bcy_amount_formatted": "$420.00", "acquisition_vat": { "tax_id": "982000000567408", "tax_name": "Import VAT", "tax_amount": "25.00", "tax_amount_formatted": "25.00 USD", "tax_percentage": "5.00" }, "reverse_charge_vat": { "tax_id": "982000000567409", "tax_name": "Reverse VAT", "tax_amount": "50.00", "tax_amount_formatted": "50.00 USD", "tax_percentage": "10.00" }, "acquisition_tax": { "tax_id": "982000000567410", "tax_name": "Import Duty", "tax_amount": "10.00", "tax_amount_formatted": "10.00 USD", "tax_percentage": "2.00" }, "reverse_charge_tax": { "tax_id": "982000000567411", "tax_name": "RC GST", "tax_name_formatted": "Reverse Charge GST", "tax_amount": "40.00", "tax_amount_formatted": "40.00 USD", "tax_percentage": "8.00", "tax_type": "percentage", "tax_status": "active" }, "reverse_charge_line_item_taxes": [ { "id": "982000000567412" } ], "project": { "project_id": "982000000567412", "project_name": "Project Alpha" }, "location": { "location_id": "982000000567414", "location_name": "NYC" }, "tags": [ { "is_tag_mandatory": true, "tag_id": "982000000567415", "tag_name": "Marketing", "tag_option": { "tag_option_id": "982000000567416", "tag_option_name": "Campaign 2025" } } ], "taxable_type": "goods", "department_id": "982000000567417" } ], "created_by": { "user_id": "982000000567018", "user_name": "John Doe" }, "last_modified_by": { "user_id": "982000000567019", "user_name": "Jane Smith" } }

Get journals 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

List all journals with pagination.
OAuth Scope : ZohoBooks.accountants.READ

Query Parameters

organization-id
string
(Required)
entry_number_startswith
string
Search journals by entry number starting with a specific value
entry_number_contains
string
Search journals by entry number containing a specific value
reference_number_startswith
string
Search journals by reference number starting with a specific value
reference_number_contains
string
Search journals by reference number containing a specific value
date
string
Search journals by date
date_start
string
Search journals by start date
date_end
string
Search journals by end date
last_modified_time_start
string
Search journals by last modified time starting from a specific date
last_modified_time_end
string
Search journals by last modified time ending at a specific date
date_before
string
Search journals by date before a specific date
date_after
string
Search journals by date after a specific date
notes_startswith
string
Search journals by notes starting with a specific value
notes_contains
string
Search journals by notes containing a specific value
notes_in
string
Search journals by notes matching any of the specified values
notes_not_in
string
Search journals by notes not matching any of the specified values
last_modified_time
string
Search journals by last modified time
total
double
Search journals by total amount
total_start
double
Search journals by total amount starting from a specific value
total_end
double
Search journals by total amount ending at a specific value
total_less_than
double
Search journals by total amount less than a specific value
total_less_equals
double
Search journals by total amount less than or equal to a specific value
total_greater_than
double
Search journals by total amount greater than a specific value
total_greater_equals
double
Search journals by total amount greater than or equal to a specific value
filter_by
string
Filter journals by journal type, date, entity type or status
sort_column
string
Sort journals by date, entry number, reference number, total or last modified time
currency
double
Search journals by currency id
customer_id
string
Search journals by customer id
tax_id
string
Search journals by tax id
tax_exemption_id
string
Search journals by tax exemption id
tax_authority_id
string
Search journals by tax authority id
vendor_id
string
Search journals by vendor id
txn
boolean
Search journals by transaction type (true for transactions, false for non-transactions)
status
string
Search journals by status. Allowed Values: draft, published, approved, submitted, rejected
journalType
string
Search journals by journal type. Allowed Values: accrual, cash, both.
account_id
string
Search journals by account id
customview_id
string
Search journals by custom view id
journal_ids
string
Unique identifiers of journals, separated by commas
print
boolean
Indicates whether to print the journal. Allowed values are true, false, on or off
branch_ids
string
Search journals by branch ids, separated by commas
location_ids
string
Search journals by location ids, separated by commas
search_text
string
Search journals by a text string
exception_type
string
Search journals by exception type
project_id
string
Search journals by project id
can_include_sub_customer_transactions
boolean
Indicates whether to include sub-customer transactions
custom_fields
string
Search journals by custom field ids, separated by commas
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.com/books/v4/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/v4/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/v4/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/v4/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/v4/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/v4/journals?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "journals": [ { "journal_id": "982000000567001", "journal_date": "2023-10-01", "journal_date_formatted": "01/10/2023", "journal_number": "J-12345", "reference_number": "REF-67890", "currency": { "currency_id": "460000000055555" }, "location": { "location_id": "982000000567013", "location_name": "Warehouse A", "location_identification_number": "LOC-001" }, "status": "draft", "status_formatted": "Draft", "notes": "Important transaction", "journal_type": "accrual", "journal_type_formatted": "Accrual", "entity_type": "item", "entity_type_formatted": "Item", "total": "1000.00", "total_formatted": "$1,000.00", "bcy_total": "1000.00", "bcy_total_formatted": "$1,000.00", "_links": { "self": "/journals/982000000567001" }, "created_time": "2023-10-01T12:00:00Z", "created_time_formatted": "01-03-2025 10:00 AM", "last_modified_time": "2023-10-01T12:30:00Z", "last_modified_time_formatted": "31-03-2025 03:45 PM", "created_by": { "user_id": "982000000567018", "user_name": "John Doe" }, "last_modified_by": { "user_id": "982000000567019", "user_name": "Jane Smith" }, "documents": [ { "document_id": "460000000038034", "document_name": "proposal.pdf", "document_size": "1024000", "document_size_formatted": "1 MB", "document_type": "pdf", "source": "desktop", "source_formatted": "Desktop", "uploaded_by": { "user_id": "982000000567025", "user_name": "John Doe" }, "uploaded_on": "2023-04-01", "uploaded_on_formatted": "01-04-2023", "alter_text": "Project Proposal", "attachment_order": "1", "can_send_in_mail": "true", "can_show_in_portal": "true", "is_custom_field_document": "false", "comment": { "comment_id": "460000000038035" }, "is_comment": "false" } ] }, {...}, {...} ] }

Bulk delete 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

Delete multiple journals.
OAuth Scope : ZohoBooks.accountants.DELETE

Query Parameters

organization-id
string
(Required)
journal_ids
string
Unique identifiers of journals, separated by commas

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/journals?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/v4/journals?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/v4/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("DELETE", "/books/v4/journals?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/v4/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 DELETE \ --url 'https://www.zohoapis.com/books/v4/journals?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

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

Get journal details 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 a journal.
OAuth Scope : ZohoBooks.accountants.READ

Path Parameters

journal_id
string
(Required)

Query Parameters

organization-id
string
(Required)
print
boolean
Indicates whether to print the journal. Allowed values are true, false, on or off
accept
string
Get the details of a particular estimate in formats such as json/pdf/html. Default format is json.Allowed Values: json, pdf and html
include
string
Indicates whether to include the journal in the HTML or snail mail formats.
language_code
string
Language code for the response.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/journals/982000000567001?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/v4/journals/982000000567001?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/v4/journals/982000000567001?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/v4/journals/982000000567001?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/v4/journals/982000000567001?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/v4/journals/982000000567001?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "journal": { "journal_id": "982000000567001", "journal_date": "2023-10-01", "journal_date_formatted": "01/10/2023", "journal_number": "J-12345", "reversal_date": "2023-10-15", "is_period_end_journal": true, "fiscal_year": "2025", "journal_template_name": "General Ledger Template", "reference_number": "REF-67890", "journal_number_prefix": "JE", "journal_number_suffix": "001", "currency": { "currency_id": "460000000055555", "currency_code": "USD", "currency_symbol": "$" }, "exchange_rate": 1.23, "exchange_rate_formatted": "1.23", "location": { "location_id": "982000000567013", "location_name": "Warehouse A", "location_identification_number": "LOC-001" }, "location_difference": { "debit_diff": 120.5, "debit_diff_formatted": "120.50", "location_name": "Los Angeles Branch", "credit_diff": 120.5, "credit_diff_formatted": "120.50" }, "status": "draft", "status_formatted": "Draft", "notes": "Important transaction", "journal_type": "accrual", "journal_type_formatted": "Accrual", "journal_transaction_type": "sales_journal", "vat_treatment": "Domestic", "tax_treatment": "Standard Rated", "product_type": "service", "include_in_vat_return": true, "is_bas_adjustment": false, "entity_type": "item", "entity_type_formatted": "Item", "available_receivables_credits": 500, "available_receivables_credits_formatted": "500.00", "available_payables_credits": 300, "available_payables_credits_formatted": "300.00", "price_precision": 2, "total": "1000.00", "total_formatted": "$1,000.00", "bcy_total": "1000.00", "bcy_total_formatted": "$1,000.00", "sub_total": 1400.5, "sub_total_formatted": "1,400.50", "acquisition_vat_total": 250, "acquisition_vat_total_formatted": "250.00", "acquisition_vat": { "tax_id": "460000000044444", "tax_name": "VAT 20%", "tax_amount": 200, "tax_amount_formatted": "200.00", "tax_percentage": 20 }, "reverse_charge_vat_total": 300, "reverse_charge_vat_total_formatted": "300.00", "reverse_charge_vat": { "tax_id": "460000000044445", "tax_name": "Reverse VAT 10%", "tax_amount": 300, "tax_amount_formatted": "300.00", "tax_percentage": 10 }, "taxes": [ { "tax_name": "VAT 20%", "tax_amount": 100, "tax_amount_formatted": "100.00", "debit_or_credit": "debit", "tax_account": "Tax Payable" } ], "comments": [ { "comment_id": "460000000022232", "commented_by": { "user_id": "460000000022222", "user_name": "John Doe" }, "comment_type": "internal", "date": "2025-03-30", "date_formatted": "30/03/2025", "description": "Reviewed and approved", "operation_type": "added", "transaction_type": "journal" } ], "project": { "project_id": "460000000045678", "project_name": "Migration Project" }, "statement_transactions": [ { "statement_transaction_id": "460000000044467", "date": "2025-03-15", "date_formatted": "15/03/2025", "amount": 500, "amount_formatted": "500.00", "payee": "ABC Supplies", "description": "Office Supplies Purchase", "reference_number": "REF-999", "status": "matched", "status_formatted": "Matched", "account_id": "460000000044444" } ], "reverse_charge_taxes": [ { "id": "460000000044444", "text": "Reverse VAT 10%", "percentage": 10, "type": "VAT" } ], "invoices_credited": [ { "journal_invoice_id": "982000000567109", "is_opening_balance": false, "invoice_id": "982000000567110", "date": "2025-03-10", "date_formatted": "10/03/2025", "invoice_number": "INV-1001", "credited_amount": "200.00", "credited_amount_formatted": "200.00 USD" } ], "bills_credited": [ { "journal_bill_id": "982000000567111", "bill_id": "982000000567112", "is_opening_balance": false, "date": "2025-03-08", "date_formatted": "08/03/2025", "bill_number": "BILL-1002", "credited_amount": "150.00", "credited_amount_formatted": "150.00 USD" } ], "is_accrual_journal": true, "department_id": "982000000567113", "submitter_details": { "user": { "user_email": "johndoe@example.com", "user_id": "982000000567114", "user_name": "John Doe", "user_photo_url": "https://example.com/photo.jpg", "user_name_email": "John Doe (johndoe@example.com)" }, "submitted_date": "2025-03-29", "submitted_date_formatted": "29/03/2025", "approver_user_id": "982000000567115" }, "approvers_list": [ { "order": 1, "user": { "user_email": "johndoe@example.com", "user_id": "982000000567116", "user_name": "John Doe", "user_photo_url": "https://example.com/photo.jpg", "is_next_approver": true, "user_status": "active", "user_status_formatted": "Active", "available_apps": [ [ "Books", "CRM" ] ] }, "has_approved": false, "approval_status": "pending", "approval_status_formatted": "Pending", "submitted_date": "2025-03-29", "submitted_date_formatted": "29/03/2025", "approved_date": "2025-03-30", "approved_date_formatted": "30/03/2025", "is_final_approver": true } ], "html_string": "string", "_links": { "self": "/journals/982000000567001" }, "created_time": "2023-10-01T12:00:00Z", "created_time_formatted": "01-03-2025 10:00 AM", "last_modified_time": "2023-10-01T12:30:00Z", "last_modified_time_formatted": "31-03-2025 03:45 PM", "line_items": [ { "line_item_id": "982000000567401", "account": { "account_id": "982000000567402", "account_name": "Accounts Receivable", "account_type": "asset" }, "contact": { "contact_id": "982000000567403", "contact_name": "Jane Smith" }, "item_order": 1, "description": "Consulting services provided", "debit_or_credit": "debit", "tax_exemption": { "tax_exemption_id": "982000000567404", "tax_exemption_type": "Nonprofit", "tax_exemption_code": "TXE-001" }, "tax_authority": { "tax_authority_id": "982000000567405", "tax_authority_name": "IRS" }, "tax": { "tax_id": "982000000567406", "tax_name": "VAT", "tax_name_formatted": "Value Added Tax", "tax_percentage": "18.00", "tax_type": "tds", "tax_type_formatted": "TDS", "tax_status": "active", "tax_start_date": "2025-01-01", "tax_end_date": "2025-12-31" }, "tax_groups_details": [ { "id": "982000000567407", "name": "GST Group", "type": "group", "type_formatted": "Group", "percentage": "12.00", "deleted": false, "tax_specific_type": "CGST", "start_date": "2025-01-01", "end_date": "2025-12-31", "is_non_advol_tax": false } ], "taxes": [ { "tax_id": "982000000567408", "tax_name": "Sales Tax", "tax_amount": 25, "tax_amount_formatted": "$25.00" } ], "amount": "500.00", "amount_formatted": "$500.00", "bcy_amount": "420.00", "bcy_amount_formatted": "$420.00", "acquisition_vat": { "tax_id": "982000000567408", "tax_name": "Import VAT", "tax_amount": "25.00", "tax_amount_formatted": "25.00 USD", "tax_percentage": "5.00" }, "reverse_charge_vat": { "tax_id": "982000000567409", "tax_name": "Reverse VAT", "tax_amount": "50.00", "tax_amount_formatted": "50.00 USD", "tax_percentage": "10.00" }, "acquisition_tax": { "tax_id": "982000000567410", "tax_name": "Import Duty", "tax_amount": "10.00", "tax_amount_formatted": "10.00 USD", "tax_percentage": "2.00" }, "reverse_charge_tax": { "tax_id": "982000000567411", "tax_name": "RC GST", "tax_name_formatted": "Reverse Charge GST", "tax_amount": "40.00", "tax_amount_formatted": "40.00 USD", "tax_percentage": "8.00", "tax_type": "percentage", "tax_status": "active" }, "reverse_charge_line_item_taxes": [ { "id": "982000000567412" } ], "project": { "project_id": "982000000567412", "project_name": "Project Alpha" }, "location": { "location_id": "982000000567414", "location_name": "NYC" }, "tags": [ { "is_tag_mandatory": true, "tag_id": "982000000567415", "tag_name": "Marketing", "tag_option": { "tag_option_id": "982000000567416", "tag_option_name": "Campaign 2025" } } ], "taxable_type": "goods", "department_id": "982000000567417" } ], "created_by": { "user_id": "982000000567018", "user_name": "John Doe" }, "last_modified_by": { "user_id": "982000000567019", "user_name": "Jane Smith" }, "documents": [ { "document_id": "460000000038034", "document_name": "proposal.pdf", "document_size": "1024000", "document_size_formatted": "1 MB", "document_type": "pdf", "source": "desktop", "source_formatted": "Desktop", "uploaded_by": { "user_id": "982000000567025", "user_name": "John Doe" }, "uploaded_on": "2023-04-01", "uploaded_on_formatted": "01-04-2023", "alter_text": "Project Proposal", "attachment_order": "1", "can_send_in_mail": "true", "can_show_in_portal": "true", "is_custom_field_document": "false", "comment": { "comment_id": "460000000038035" }, "is_comment": "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

Delete a journal.
OAuth Scope : ZohoBooks.accountants.DELETE

Path Parameters

journal_id
string
(Required)

Query Parameters

organization-id
string
(Required)

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/journals/982000000567001?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/v4/journals/982000000567001?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/v4/journals/982000000567001?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/v4/journals/982000000567001?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/v4/journals/982000000567001?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/v4/journals/982000000567001?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

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

Get journal credits 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 the credit entries of a journal.
OAuth Scope : ZohoBooks.accountants.READ

Path Parameters

journal_id
string
(Required)

Query Parameters

organization-id
string
(Required)

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/journals/982000000567001/credits?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/v4/journals/982000000567001/credits?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/v4/journals/982000000567001/credits?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/v4/journals/982000000567001/credits?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/v4/journals/982000000567001/credits?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/v4/journals/982000000567001/credits?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "available_journal_credits": [ { "journal_line_item_id": "982000000789021", "account": { "account_id": "982000000789010", "account_name": "Sales", "account_type": "string" }, "contact": { "contact_id": "982000000789011", "contact_name": "John Doe" }, "item_order": 1, "description": "Credit note applied against Invoice #INV-009", "total_credits": "200.00", "total_credits_formatted": "$200.00", "bcy_total_credits": "200.00", "bcy_total_credits_formatted": "$200.00", "available_credits": "150.00", "available_credits_formatted": "$150.00", "bcy_available_credits": "150.00", "bcy_available_credits_formatted": "$150.00", "is_receivable_credit": true, "location": { "location_id": "982000000567013", "location_name": "Warehouse A", "location_identification_number": "LOC-001" } }, {...}, {...} ] }

Get journal templates 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 the list of templates for journals.
OAuth Scope : ZohoBooks.accountants.READ

Query Parameters

organization-id
string
(Required)
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.com/books/v4/journals/templates?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/v4/journals/templates?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/v4/journals/templates?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/v4/journals/templates?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/v4/journals/templates?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/v4/journals/templates?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "journal_templates": [ { "journal_template_id": "982000000789020", "journal_template_name": "General Ledger Template", "amount": "200.00", "amount_formatted": "$200.00", "notes": "Important transaction", "location": { "location_id": "982000000567013", "location_name": "Warehouse A", "location_identification_number": "LOC-001" } }, {...}, {...} ] }

Delete a journal template 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 journal template.
OAuth Scope : ZohoBooks.accountants.DELETE

Path Parameters

template_id
string
(Required)

Query Parameters

organization-id
string
(Required)

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/journals/templates/987000000654321?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/v4/journals/templates/987000000654321?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/v4/journals/templates/987000000654321?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/v4/journals/templates/987000000654321?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/v4/journals/templates/987000000654321?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/v4/journals/templates/987000000654321?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

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

Delete a journal 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 comment of a journal.
OAuth Scope : ZohoBooks.accountants.DELETE

Path Parameters

journal_id
string
(Required)
comment_id
string
(Required)

Query Parameters

organization-id
string
(Required)
entity
string
Specifies the entity type for which the comment or credit entry is being deleted.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/journals/982000000567001/comments/987000000654321?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/v4/journals/982000000567001/comments/987000000654321?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/v4/journals/982000000567001/comments/987000000654321?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/v4/journals/982000000567001/comments/987000000654321?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/v4/journals/982000000567001/comments/987000000654321?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/v4/journals/982000000567001/comments/987000000654321?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

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

Delete journal credit receivables 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 receivables of a credit entry of a journal.
OAuth Scope : ZohoBooks.accountants.DELETE

Path Parameters

journal_id
string
(Required)
credit_id
string
(Required)

Query Parameters

organization-id
string
(Required)
entity
string
Specifies the entity type for which the comment or credit entry is being deleted.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/journals/982000000567001/credits/987000000654321/receivables?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/v4/journals/982000000567001/credits/987000000654321/receivables?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/v4/journals/982000000567001/credits/987000000654321/receivables?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/v4/journals/982000000567001/credits/987000000654321/receivables?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/v4/journals/982000000567001/credits/987000000654321/receivables?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/v4/journals/982000000567001/credits/987000000654321/receivables?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

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

Delete journal credit payables 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 payables of a credit entry of a journal.
OAuth Scope : ZohoBooks.accountants.DELETE

Path Parameters

journal_id
string
(Required)
credit_id
string
(Required)

Query Parameters

organization-id
string
(Required)
entity
string
Specifies the entity type for which the comment or credit entry is being deleted.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/journals/982000000567001/credits/987000000654321/payables?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/v4/journals/982000000567001/credits/987000000654321/payables?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/v4/journals/982000000567001/credits/987000000654321/payables?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/v4/journals/982000000567001/credits/987000000654321/payables?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/v4/journals/982000000567001/credits/987000000654321/payables?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/v4/journals/982000000567001/credits/987000000654321/payables?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

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

Delete journal document 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 document attached to a journal.
OAuth Scope : ZohoBooks.accountants.DELETE

Path Parameters

journal_id
string
(Required)
document_id
string
(Required)

Query Parameters

organization-id
string
(Required)

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/journals/982000000567001/documents/987000000654321?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/v4/journals/982000000567001/documents/987000000654321?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/v4/journals/982000000567001/documents/987000000654321?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/v4/journals/982000000567001/documents/987000000654321?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/v4/journals/982000000567001/documents/987000000654321?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/v4/journals/982000000567001/documents/987000000654321?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "The attachment has been removed from the journal." }