API Docs
/
No Results Found
Journals

Journals

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

Attribute

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 .
vat_treatment
string
🇬🇧 United Kingdom
, Europe only
(Optional) VAT treatment for the journals. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered, if he resides outside of the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu).
product_type
string
🇬🇧 United Kingdom
only
Type of the journal. This denotes whether the journal is to be treated as goods or service. Allowed Values: digital_service, goods and service.
include_in_vat_return
boolean
Europe 🇬🇧 United Kingdom
only
Check if Journal should be included in VAT Return
is_bas_adjustment
boolean
🇦🇺 Australia
only
Check if Journal is created for BAS Adjustment
line_items
array
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
, 🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
ID of the Tax Exemption
tax_exemption_type
string
🇮🇳 India
, 🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
Type of the Tax Exemption. Allowed Values : customer and item
tax_exemption_code
string
🇮🇳 India
, 🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
Code of the Tax Exemption
tax_authority_id
string
🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
ID of the Tax Authority
tax_authority_name
string
🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
Name of the Tax Authority
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
acquisition_vat_id
string
🇬🇧 United Kingdom
only
(Optional) This is the ID of the tax applied in case this is an EU - goods journal and acquisition VAT needs to be reported.
acquisition_vat_name
string
🇬🇧 United Kingdom
, Europe only
Name of the VAT Acquistion
acquisition_vat_percentage
string
🇬🇧 United Kingdom
, Europe only
Percentage of the VAT Acquistion
acquisition_vat_amount
string
🇬🇧 United Kingdom
, Europe only
Amount of the VAT Acquistion
reverse_charge_vat_id
string
🇬🇧 United Kingdom
only
(Optional) This is the ID of the tax applied in case this is a non UK - service journal and reverse charge VAT needs to be reported.
reverse_charge_vat_name
string
🇬🇧 United Kingdom
, Europe only
Name of the Reverse Charge
reverse_charge_vat_percentage
string
🇬🇧 United Kingdom
, Europe only
Percentage of the Reverse Charge
reverse_charge_vat_amount
string
🇬🇧 United Kingdom
, Europe only
Percentage of the Reverse Charge
tags
array
Show Sub-Attributes arrow
is_tag_mandatory
boolean
Boolean to check if the tag is mandatory
tag_id
long
ID of the Tag
tag_name
string
Name of the reporting tag
tag_option_id
long
ID of the Tag Option
tag_option_name
string
Name of the reporting tag's option
project_id
string
ID of the Project
project_name
string
Name of the Project
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
Show Sub-Attributes arrow
customfield_id
string
ID of the Custom Field
value
string
Value of the Custom Field

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", "vat_treatment": "string", "product_type": "string", "include_in_vat_return": true, "is_bas_adjustment": true, "line_items": [ { "line_id": "460000000038005", "account_id": "460000000000361", "customer_id": "string", "customer_name": "string", "account_name": "Petty Cash", "description": "string", "debit_or_credit": "credit", "tax_exemption_id": "string", "tax_exemption_type": "string", "tax_exemption_code": "string", "tax_authority_id": "string", "tax_authority_name": "string", "tax_id": "string", "tax_name": "string", "tax_type": "tax", "tax_percentage": "string", "amount": 5000, "bcy_amount": 100, "acquisition_vat_id": "string", "acquisition_vat_name": "string", "acquisition_vat_percentage": "string", "acquisition_vat_amount": "string", "reverse_charge_vat_id": "string", "reverse_charge_vat_name": "string", "reverse_charge_vat_percentage": "string", "reverse_charge_vat_amount": "string", "tags": [ { "is_tag_mandatory": false, "tag_id": "460000000094001", "tag_name": "Location", "tag_option_id": "460000000048001", "tag_option_name": "USA" } ], "project_id": "460000000898001", "project_name": "Network Distribution" } ], "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" } ] }

Create a journal

Create a journal.
oauthscope : ZohoBooks.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 .
vat_treatment
string
🇬🇧 United Kingdom
, Europe only
(Optional) VAT treatment for the journals. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered, if he resides outside of the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu).
include_in_vat_return
boolean
Europe 🇬🇧 United Kingdom
only
Check if Journal should be included in VAT Return
product_type
string
🇬🇧 United Kingdom
only
Type of the journal. This denotes whether the journal is to be treated as goods or service. Allowed Values: digital_service, goods and service.
is_bas_adjustment
boolean
🇦🇺 Australia
only
Check if Journal is created for BAS Adjustment
currency_id
string
ID of the Currency Associated with the Journal
exchange_rate
double
Exchange Rate between the Currencies
line_items
array
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
, 🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
ID of the Tax Exemption
tax_authority_id
string
🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
ID of the Tax Authority
tax_exemption_type
string
🇮🇳 India
, 🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
Type of the Tax Exemption. Allowed Values : customer and item
tax_exemption_code
string
🇮🇳 India
, 🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
Code of the Tax Exemption
tax_authority_name
string
🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
Name of the Tax Authority
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.
acquisition_vat_id
string
🇬🇧 United Kingdom
only
(Optional) This is the ID of the tax applied in case this is an EU - goods journal and acquisition VAT needs to be reported.
reverse_charge_vat_id
string
🇬🇧 United Kingdom
only
(Optional) This is the ID of the tax applied in case this is a non UK - service journal and reverse charge VAT needs to be reported.
tags
array
Show Sub-Attributes arrow
tag_id
long
ID of the Tag
tag_option_id
long
ID of the Tag Option
project_id
string
ID of the Project
tax_exemption_code
string
🇮🇳 India
, 🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
Code of the Tax Exemption
tax_exemption_type
string
🇮🇳 India
, 🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
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
Show Sub-Attributes arrow
customfield_id
string
ID of the Custom Field
value
string
Value of the Custom Field

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/journals -X POST -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "journal_date": "2013-09-04", "reference_number": "7355", "notes": "Loan repayment", "journal_type": "both", "vat_treatment": "string", "include_in_vat_return": true, "product_type": "string", "is_bas_adjustment": true, "currency_id": "460000000000097", "exchange_rate": 1, "line_items": [ { "account_id": "460000000000361", "customer_id": "string", "line_id": "460000000038005", "description": "string", "tax_exemption_id": "string", "tax_authority_id": "string", "tax_exemption_type": "string", "tax_exemption_code": "string", "tax_authority_name": "string", "tax_id": "string", "amount": 5000, "debit_or_credit": "credit", "acquisition_vat_id": "string", "reverse_charge_vat_id": "string", "tags": [ { "tag_id": "460000000094001", "tag_option_id": "460000000048001" } ], "project_id": "460000000898001" } ], "tax_exemption_code": "string", "tax_exemption_type": "string", "status": "draft", "custom_fields": [ { "customfield_id": "460000000098001", "value": "Normal" } ] }

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", "vat_treatment": "string", "product_type": "string", "include_in_vat_return": true, "is_bas_adjustment": true, "line_items": [ { "line_id": "460000000038005", "account_id": "460000000000361", "customer_id": "string", "customer_name": "string", "account_name": "Petty Cash", "description": "string", "debit_or_credit": "credit", "tax_exemption_id": "string", "tax_exemption_type": "string", "tax_exemption_code": "string", "tax_authority_id": "string", "tax_authority_name": "string", "tax_id": "string", "tax_name": "string", "tax_type": "tax", "tax_percentage": "string", "amount": 5000, "bcy_amount": 100, "acquisition_vat_id": "string", "acquisition_vat_name": "string", "acquisition_vat_percentage": "string", "acquisition_vat_amount": "string", "reverse_charge_vat_id": "string", "reverse_charge_vat_name": "string", "reverse_charge_vat_percentage": "string", "reverse_charge_vat_amount": "string", "tags": [ { "is_tag_mandatory": false, "tag_id": "460000000094001", "tag_name": "Location", "tag_option_id": "460000000048001", "tag_option_name": "USA" } ], "project_id": "460000000898001", "project_name": "Network Distribution" } ], "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" } ] } }

Get journal list

Get journal list.
oauthscope : ZohoBooks.accountants.READ

Query Parameters

entry_number
Search journals by journal entry number. Variants: entry_number_startswith and entry_number_contains
reference_number
Search journals by journal reference number. Variants: reference_number_startswith and reference_number_contains
date
Search journals by journal date. Variants: date_start, date_end, date_before and date_after
notes
Search journals by journal notes. Variants: notes_startswith and notes_contains
last_modified_time
Search the journals using Last Modified Time
total
Search journals by journal total. Variants: total_less_than, total_less_equals, total_greater_than and total_greater_equals
customer_id
Search Journals using Customer ID
vendor_id
Search the journals using Vendor ID
filter_by
Filter journals by journal date. Allowed Values: JournalDate.All, JournalDate.Today, JournalDate.ThisWeek, JournalDate.ThisMonth, JournalDate.ThisQuarter and JournalDate.ThisYear
sort_column
Sort journal list. Allowed Values: journal_date, entry_number, reference_number and total

Request Example

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

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

Update a journal

Updates the journal with given information.
oauthscope : ZohoBooks.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 .
vat_treatment
string
🇬🇧 United Kingdom
, Europe only
(Optional) VAT treatment for the journals. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered, if he resides outside of the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu).
include_in_vat_return
boolean
Europe 🇬🇧 United Kingdom
only
Check if Journal should be included in VAT Return
product_type
string
🇬🇧 United Kingdom
only
Type of the journal. This denotes whether the journal is to be treated as goods or service. Allowed Values: digital_service, goods and service.
is_bas_adjustment
boolean
🇦🇺 Australia
only
Check if Journal is created for BAS Adjustment
currency_id
string
ID of the Currency Associated with the Journal
exchange_rate
double
Exchange Rate between the Currencies
line_items
array
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
, 🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
ID of the Tax Exemption
tax_authority_id
string
🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
ID of the Tax Authority
tax_exemption_type
string
🇮🇳 India
, 🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
Type of the Tax Exemption. Allowed Values : customer and item
tax_exemption_code
string
🇮🇳 India
, 🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
Code of the Tax Exemption
tax_authority_name
string
🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
Name of the Tax Authority
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.
acquisition_vat_id
string
🇬🇧 United Kingdom
only
(Optional) This is the ID of the tax applied in case this is an EU - goods journal and acquisition VAT needs to be reported.
reverse_charge_vat_id
string
🇬🇧 United Kingdom
only
(Optional) This is the ID of the tax applied in case this is a non UK - service journal and reverse charge VAT needs to be reported.
tags
array
Show Sub-Attributes arrow
tag_id
long
ID of the Tag
tag_option_id
long
ID of the Tag Option
project_id
string
ID of the Project
tax_exemption_code
string
🇮🇳 India
, 🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
Code of the Tax Exemption
tax_exemption_type
string
🇮🇳 India
, 🇺🇸 United States
, 🇦🇺 Australia
, 🇨🇦 Canada
only
Type of the Tax Exemption. Allowed Values : customer and item
custom_fields
array
Show Sub-Attributes arrow
customfield_id
string
ID of the Custom Field
value
string
Value of the Custom Field

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/journals/{journal_id} -X PUT -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "journal_date": "2013-09-04", "reference_number": "7355", "notes": "Loan repayment", "journal_type": "both", "vat_treatment": "string", "include_in_vat_return": true, "product_type": "string", "is_bas_adjustment": true, "currency_id": "460000000000097", "exchange_rate": 1, "line_items": [ { "account_id": "460000000000361", "customer_id": "string", "line_id": "460000000038005", "description": "string", "tax_exemption_id": "string", "tax_authority_id": "string", "tax_exemption_type": "string", "tax_exemption_code": "string", "tax_authority_name": "string", "tax_id": "string", "amount": 5000, "debit_or_credit": "credit", "acquisition_vat_id": "string", "reverse_charge_vat_id": "string", "tags": [ { "tag_id": "460000000094001", "tag_option_id": "460000000048001" } ], "project_id": "460000000898001" } ], "tax_exemption_code": "string", "tax_exemption_type": "string", "custom_fields": [ { "customfield_id": "460000000098001", "value": "Normal" } ] }

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", "vat_treatment": "string", "product_type": "string", "include_in_vat_return": true, "is_bas_adjustment": true, "line_items": [ { "line_id": "460000000038005", "account_id": "460000000000361", "customer_id": "string", "customer_name": "string", "account_name": "Petty Cash", "description": "string", "debit_or_credit": "credit", "tax_exemption_id": "string", "tax_exemption_type": "string", "tax_exemption_code": "string", "tax_authority_id": "string", "tax_authority_name": "string", "tax_id": "string", "tax_name": "string", "tax_type": "tax", "tax_percentage": "string", "amount": 5000, "bcy_amount": 100, "acquisition_vat_id": "string", "acquisition_vat_name": "string", "acquisition_vat_percentage": "string", "acquisition_vat_amount": "string", "reverse_charge_vat_id": "string", "reverse_charge_vat_name": "string", "reverse_charge_vat_percentage": "string", "reverse_charge_vat_amount": "string", "tags": [ { "is_tag_mandatory": false, "tag_id": "460000000094001", "tag_name": "Location", "tag_option_id": "460000000048001", "tag_option_name": "USA" } ], "project_id": "460000000898001", "project_name": "Network Distribution" } ], "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" } ] } }

Get journal

Get the details of the journal.
oauthscope : ZohoBooks.accountants.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/journals/{journal_id}

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", "vat_treatment": "string", "product_type": "string", "include_in_vat_return": true, "is_bas_adjustment": true, "line_items": [ { "line_id": "460000000038005", "account_id": "460000000000361", "customer_id": "string", "customer_name": "string", "account_name": "Petty Cash", "description": "string", "debit_or_credit": "credit", "tax_exemption_id": "string", "tax_exemption_type": "string", "tax_exemption_code": "string", "tax_authority_id": "string", "tax_authority_name": "string", "tax_id": "string", "tax_name": "string", "tax_type": "tax", "tax_percentage": "string", "amount": 5000, "bcy_amount": 100, "acquisition_vat_id": "string", "acquisition_vat_name": "string", "acquisition_vat_percentage": "string", "acquisition_vat_amount": "string", "reverse_charge_vat_id": "string", "reverse_charge_vat_name": "string", "reverse_charge_vat_percentage": "string", "reverse_charge_vat_amount": "string", "tags": [ { "is_tag_mandatory": false, "tag_id": "460000000094001", "tag_name": "Location", "tag_option_id": "460000000048001", "tag_option_name": "USA" } ], "project_id": "460000000898001", "project_name": "Network Distribution" } ], "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" } ] } }

Delete a journal

Deletes the given journal.
oauthscope : ZohoBooks.accountants.DELETE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/journals/{journal_id} -X DELETE

Response Example

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

Mark a journal as published

Mark a draft journal as published.
oauthscope : ZohoBooks.accountants.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/journals/{journal_id}/status/publish -X POST

Response Example

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

Add attachment to a journal

Attach a file to a journal.
oauthscope : ZohoBooks.accountants.CREATE

Query Parameters

attachment
The file that is to be added as an Attachment in the Journal
doc
Document that is to be attached
totalFiles
Total number of files.
document_ids
ID's of the document

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/journals/{journal_id}/attachment -X POST -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Add comment

Add a comment for a journal.
oauthscope : ZohoBooks.accountants.CREATE

Arguments

description
string
Description of a comment

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/journals/{jounral_id}/comments -X POST -d '{"field":"value","field":"value"}'

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

Delete a jounral comment.
oauthscope : ZohoBooks.accountants.DELETE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/journals/{jounral_id}/comments/{comment_id} -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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