Skip to Content

Zoho Books API

Zoho Books API icon
Arcade Unoptimized

Tools that enable LLMs to interact directly with the zoho-books API.

Author:Arcade
Version:1.0.0
Auth:User authorization via the Zoho auth provider
511tools
511require secrets
PyPI VersionPython VersionsWheel StatusDownloadsLicense

Zoho Books API toolkit lets LLMs interact directly with Zoho Books to automate accounting workflows and manage invoices, payments, expenses, projects, tax settings, inventory, and organization configuration. It exposes CRUD, reconciliation, file attachment, email and approval workflows so agents can perform end-to-end bookkeeping and operational tasks.

Capabilities

  • Automate transactional lifecycles (create/read/update/delete invoices, bills, payments, credit/debit notes).
  • Reconcile and categorize bank transactions, import statements, and match payments.
  • Manage documents, email communications, templates, and attachments programmatically.
  • Configure org settings, tax rules, projects, inventory and bulk operations for reporting and cleanup.

OAuth Provider: zoho Scopes: granular ZohoBooks.* permissions (CREATE/READ/UPDATE/DELETE and ALL) across accountants, banking, bills, contacts, creditnotes, customerpayments, custommodules, debitnotes, estimates, expenses, fixedasset, invoices, projects, purchaseorders, salesorders, settings, vendorpayments, taxes and related modules.

Secrets Secret types: unknown (likely environment/config secrets such as endpoints or API connection values). Example: ZOHO_SERVER_URL — base API URL override; store in a secure env or secrets manager.

Available tools(511)

511 of 511
Tool nameDescriptionSecrets
Mark a sent estimate as accepted if the customer has accepted it. Use this tool to update the status of a sent estimate to accepted once your customer has approved it.
1
Activate a bank account in Zoho Books. This tool is used to mark a bank account as active in Zoho Books. It should be called when there is a need to change the status of a bank account to active.
1
Activate a chart of account in Zoho Books. Use this tool to update the status of a chart of account to active in Zoho Books. This is useful when you need to ensure an account is reactivated and available for transactions.
1
Activate a contact in Zoho Books. Use this tool to mark a contact as active in Zoho Books. It should be called when a contact's status needs to be changed from inactive to active.
1
Activate a fixed asset to begin depreciation calculation. Use this tool to mark a fixed asset as active, which will initiate the calculation of its depreciation.
1
Activate an inactive item in Zoho Books. Use this tool to reactivate an item that has been previously marked as inactive in Zoho Books. It should be called when you need to make an item available again for transactions.
1
Mark an inactive user as active. Use this tool to activate a user who is currently marked as inactive in the system.
1
Enable automated payment reminders for invoices. Activate automatic reminders for invoice payments to ensure timely settlements.
1
Marks a location as active. Use this tool to mark a specified location as active in the system. This is useful for enabling locations that were previously inactive.
1
Activate a project in Zoho Books. This tool marks a specified project as active in Zoho Books. Call this tool when you need to change the status of a project to active to enable its functionalities or integrations.
1
Add a comment to a specific bill in Zoho Books. Use this tool to add a comment to a bill identified by its ID in Zoho Books. Useful for internal notes or communication about a bill. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add an additional address to a contact in Zoho Books. Use this tool to append a new address to an existing contact in Zoho Books. Suitable when updating contact details with more location information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add a comment to an existing credit note. Use this tool to append a comment to a specific credit note by providing the credit note's ID and the comment text. Ideal for documenting additional information or context on credit notes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add a comment for a specific estimate in Zoho Books. Use this tool to add a comment to an existing estimate in Zoho Books. Call it when you need to append notes or feedback to an estimate record. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add a comment to a fixed asset in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add a comment to a specific invoice. Use this tool to add a comment to an invoice by specifying the invoice ID. Useful for internal notes or communication related to invoice handling. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add a comment to a journal entry in Zoho Books. This tool adds a comment to a specified journal entry in Zoho Books. Call this tool when you need to annotate or provide additional information for a journal entry. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add a task to a specific project. Use this tool to add a task to a specified project in Zoho Books. It is suitable when you need to organize tasks within a project and track them through Zoho's project management system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add a comment to a purchase order in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add a comment to a specific retainer invoice. This tool is used to add a comment to a specified retainer invoice in Zoho Books. It should be called when a user wishes to provide additional information or notes related to an existing retainer invoice. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add a comment to a sales order in Zoho Books. This tool is used to add a comment to a specific sales order in Zoho Books. It should be called when you need to leave additional remarks or notes on a sales order. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add a comment to an existing vendor credit. Use this tool to add a comment to a vendor credit in Zoho Books. It should be called when you need to attach notes or additional information to a vendor credit entry. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Apply credit note to existing invoices in Zoho Books. This tool applies a credit note to specific existing invoices within the Zoho Books platform. It should be called when you want to manage or adjust invoice balances by using available credit notes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Apply customer credits to an invoice. This tool applies customer credits, from credit notes or excess payments, to a specified invoice. It can apply multiple credits at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Apply vendor credits to a bill. This tool applies vendor credits from excess payments to a specified bill. It is useful for managing accounts and applying multiple credits at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Page 1 of 21(25 of 511)

Selected tools

No tools selected.

Click "Show all tools" to add tools.

Requirements

Select tools to see requirements

#

ZohoBooksApi.AcceptEstimate

Mark a sent estimate as accepted if the customer has accepted it. Use this tool to update the status of a sent estimate to accepted once your customer has approved it.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID for the organization related to the estimate acceptance.
estimate_identifierstringRequiredUnique identifier of the estimate to be marked as accepted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_estimate_accepted'.
#

ZohoBooksApi.ActivateBankAccount

Activate a bank account in Zoho Books. This tool is used to mark a bank account as active in Zoho Books. It should be called when there is a need to change the status of a bank account to active.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization in Zoho Books. This ID is required to activate a bank account within the specified organization.
bank_account_idstringRequiredUnique identifier of the bank account to be activated in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_bank_account_active'.
#

ZohoBooksApi.ActivateChartOfAccount

Activate a chart of account in Zoho Books. Use this tool to update the status of a chart of account to active in Zoho Books. This is useful when you need to ensure an account is reactivated and available for transactions.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books that needs the account to be activated.
account_unique_identifierstringRequiredUnique identifier of the account to be activated in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_chart_of_account_active'.
#

ZohoBooksApi.ActivateContact

Activate a contact in Zoho Books. Use this tool to mark a contact as active in Zoho Books. It should be called when a contact's status needs to be changed from inactive to active.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization to which the contact belongs.
contact_identifierstringRequiredUnique identifier of the contact to be marked as active.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_contact_active'.
#

ZohoBooksApi.ActivateFixedAsset

Activate a fixed asset to begin depreciation calculation. Use this tool to mark a fixed asset as active, which will initiate the calculation of its depreciation.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization. This is required to identify which organization's asset to activate.
fixed_asset_idstringRequiredUnique identifier of the fixed asset to activate for depreciation calculation.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_fixed_asset_active'.
#

ZohoBooksApi.ActivateInactiveItem

Activate an inactive item in Zoho Books. Use this tool to reactivate an item that has been previously marked as inactive in Zoho Books. It should be called when you need to make an item available again for transactions.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for your organization in Zoho Books. Required to activate an item.
item_identifierstringRequiredUnique identifier of the item to be activated in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_item_active'.
#

ZohoBooksApi.ActivateInactiveUser

Mark an inactive user as active. Use this tool to activate a user who is currently marked as inactive in the system.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization for which the user will be reactivated. Ensure it matches the organization's records.
user_identifierstringRequiredUnique identifier for the user to be activated.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_user_active'.
#

ZohoBooksApi.ActivateInvoiceReminder

Enable automated payment reminders for invoices. Activate automatic reminders for invoice payments to ensure timely settlements.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which the invoice payment reminder is being activated.
invoice_identifierstringRequiredUnique identifier of the invoice for which payment reminders are to be activated.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'enable_invoice_payment_reminder'.
#

ZohoBooksApi.ActivateLocation

Marks a location as active. Use this tool to mark a specified location as active in the system. This is useful for enabling locations that were previously inactive.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization to which the location belongs.
location_identifierstringRequiredUnique identifier for the location to be marked as active.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_location_active'.
#

ZohoBooksApi.ActivateProject

Activate a project in Zoho Books. This tool marks a specified project as active in Zoho Books. Call this tool when you need to change the status of a project to active to enable its functionalities or integrations.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization in which the project is to be activated.
project_identifierstringRequiredUnique identifier for the project to activate in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_project_active'.
#

ZohoBooksApi.AddCommentToBill

Add a comment to a specific bill in Zoho Books. Use this tool to add a comment to a bill identified by its ID in Zoho Books. Useful for internal notes or communication about a bill. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique identifier of the organization in Zoho Books. Required to specify which organization's bill to comment on. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bill_identifierstringOptionalUnique identifier for the bill to add a comment. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_bill_comment'.
#

ZohoBooksApi.AddContactAddress

Add an additional address to a contact in Zoho Books. Use this tool to append a new address to an existing contact in Zoho Books. Suitable when updating contact details with more location information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization for which the contact address will be added. This is required to specify the target organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
contact_idstringOptionalThe unique identifier for the contact to which an address will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_contact_address'.
#

ZohoBooksApi.AddCreditNoteComment

Add a comment to an existing credit note. Use this tool to append a comment to a specific credit note by providing the credit note's ID and the comment text. Ideal for documenting additional information or context on credit notes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe string ID of the organization to which the credit note belongs. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
credit_note_idstringOptionalUnique identifier of the credit note to which the comment will be added. This is required to specify the exact credit note targeted for the comment. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_credit_note_comment'.
#

ZohoBooksApi.AddEstimateComment

Add a comment for a specific estimate in Zoho Books. Use this tool to add a comment to an existing estimate in Zoho Books. Call it when you need to append notes or feedback to an estimate record. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique ID of the organization within Zoho Books. It is required to specify which organization's estimate is being commented on. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
estimate_identifierstringOptionalUnique identifier for the specific estimate to comment on. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_estimate_comment'.
#

ZohoBooksApi.AddFixedAssetComment

Add a comment to a fixed asset in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization in Zoho Books. This is required to add a comment to the fixed asset. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
fixed_asset_identifierstringOptionalUnique identifier for the fixed asset to add a comment. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_fixed_asset_comment'.
#

ZohoBooksApi.AddInvoiceComment

Add a comment to a specific invoice. Use this tool to add a comment to an invoice by specifying the invoice ID. Useful for internal notes or communication related to invoice handling. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization for which the invoice belongs. It must be a valid and existing organization ID. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
invoice_identifierstringOptionalUnique identifier of the invoice to add a comment to. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_invoice_comment'.
#

ZohoBooksApi.AddJournalComment

Add a comment to a journal entry in Zoho Books. This tool adds a comment to a specified journal entry in Zoho Books. Call this tool when you need to annotate or provide additional information for a journal entry. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization in Zoho Books where the comment is to be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
journal_unique_idstringOptionalThe unique identifier for the journal entry to which the comment will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_journal_comment'.
#

ZohoBooksApi.AddProjectTask

Add a task to a specific project. Use this tool to add a task to a specified project in Zoho Books. It is suitable when you need to organize tasks within a project and track them through Zoho's project management system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique ID of the organization for which the task is being added. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
project_identifierstringOptionalUnique identifier of the project in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_task'.
#

ZohoBooksApi.AddPurchaseOrderComment

Add a comment to a purchase order in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books. This ID is required to specify which organization's purchase order is being commented on. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
purchase_order_identifierstringOptionalUnique identifier for the purchase order in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_purchase_order_comment'.
#

ZohoBooksApi.AddRetainerInvoiceComment

Add a comment to a specific retainer invoice. This tool is used to add a comment to a specified retainer invoice in Zoho Books. It should be called when a user wishes to provide additional information or notes related to an existing retainer invoice. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalUnique ID string of the organization in Zoho Books to add a comment to a retainer invoice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
retainer_invoice_idstringOptionalA unique identifier for the retainer invoice you want to comment on. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_retainer_invoice_comment'.
#

ZohoBooksApi.AddSalesOrderComment

Add a comment to a sales order in Zoho Books. This tool is used to add a comment to a specific sales order in Zoho Books. It should be called when you need to leave additional remarks or notes on a sales order. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier of the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
sales_order_idstringOptionalUnique identifier of the sales order to which the comment will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_sales_order_comment'.
#

ZohoBooksApi.AddVendorCreditComment

Add a comment to an existing vendor credit. Use this tool to add a comment to a vendor credit in Zoho Books. It should be called when you need to attach notes or additional information to a vendor credit entry. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. Required to specify which organization the vendor credit belongs to. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
vendor_credit_identifierstringOptionalUnique identifier for the vendor credit to which the comment will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_vendor_credit_comment'.
#

ZohoBooksApi.ApplyCreditNoteToInvoice

Apply credit note to existing invoices in Zoho Books. This tool applies a credit note to specific existing invoices within the Zoho Books platform. It should be called when you want to manage or adjust invoice balances by using available credit notes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization within Zoho Books to which the credit note is being applied. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
credit_note_idstringOptionalUnique identifier of the credit note to apply to invoices. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'apply_credit_note_to_invoice'.
#

ZohoBooksApi.ApplyCreditsToInvoice

Apply customer credits to an invoice. This tool applies customer credits, from credit notes or excess payments, to a specified invoice. It can apply multiple credits at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization to identify where credits are applied. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
invoice_unique_identifierstringOptionalUnique identifier of the invoice to which credits will be applied. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'apply_credits_to_invoice'.
#

ZohoBooksApi.ApplyVendorCreditsToBill

Apply vendor credits to a bill. This tool applies vendor credits from excess payments to a specified bill. It is useful for managing accounts and applying multiple credits at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization where credits are being applied. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bill_identifierstringOptionalUnique identifier for the bill to apply credits to. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'apply_credits_to_bill'.
#

ZohoBooksApi.ApplyVendorCreditToBill

Apply vendor credit to an existing bill in Zoho Books. Use this tool to apply a specific vendor credit to existing bills. It helps manage and track accounts payable by adjusting bills with vendor credits. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization where the vendor credit will be applied. Required for identification within Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
vendor_credit_identifierstringOptionalUnique identifier for the vendor credit to be applied to a bill. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'apply_credits_to_a_bill'.
#

ZohoBooksApi.ApproveBill

Approve a bill in Zoho Books. This tool approves a specified bill in Zoho Books. It should be used when you need to change the status of a bill to approved.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredID of the organization for which the bill needs approval.
bill_identifierstringRequiredUnique identifier of the bill to be approved in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'approve_bill'.
#

ZohoBooksApi.ApproveCreditNote

Approve a credit note for a specified ID. Use this tool to approve a credit note by providing the specific credit note ID. This action confirms the validity and acceptance of the credit note within the system.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredProvide the ID of the organization for which the credit note is being approved.
credit_note_identifierstringRequiredA unique string identifier for the specific credit note to approve.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'approve_credit_note'.
#

ZohoBooksApi.ApproveEstimate

Approve an estimate in Zoho Books. Use this tool to approve an estimate in the Zoho Books system when you have the estimate ID. It should be called when an estimate needs to be confirmed as approved.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization in Zoho Books whose estimate is being approved. This should be the unique identifier associated with the organization.
estimate_identifierstringRequiredUnique identifier for the estimate to be approved in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'approve_estimate'.
#

ZohoBooksApi.ApproveInvoice

Approve a specified invoice for processing. This tool approves a pending invoice given its ID, making it ready for processing. Call this tool when an invoice requires approval to proceed.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization for which the invoice is to be approved.
invoice_identifierstringRequiredUnique identifier of the invoice to approve.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'approve_invoice'.
#

ZohoBooksApi.ApprovePurchaseOrder

Approve a purchase order. This tool approves a specified purchase order in Zoho Books. It should be called when a purchase order needs to be authorized for further processing.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization for which to approve the purchase order. This should be a unique string identifier provided by Zoho Books.
purchase_order_identifierstringRequiredThe unique identifier for the purchase order to be approved.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'approve_purchase_order'.
#

ZohoBooksApi.ApproveRetainerInvoice

Approve a retainer invoice in Zoho Books. Use this tool to approve a specific retainer invoice in Zoho Books when you have the invoice ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which the retainer invoice is being approved.
retainer_invoice_idstringRequiredUnique identifier of the retainer invoice to approve.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'approve_retainer_invoice'.
#

ZohoBooksApi.ApproveSalesOrder

Approve a specified sales order in Zoho Books. Use this tool to approve a particular sales order within the Zoho Books system. This is typically called when a sales order needs to be confirmed and finalized.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization in Zoho Books required for approving a sales order.
sales_order_idstringRequiredThe unique identifier for the sales order to be approved.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'approve_sales_order'.
#

ZohoBooksApi.ApproveVendorCredit

Approve a vendor credit in Zoho Books. This tool approves a vendor credit in Zoho Books, marking the credit as accepted for the specified vendor credit ID.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe ID of the organization in Zoho Books. This uniquely identifies the organization for which the vendor credit approval will be processed.
vendor_credit_identifierstringRequiredUnique identifier for the vendor credit to be approved.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'approve_vendor_credit'.
#

ZohoBooksApi.AssignUsersToProject

Assign users to a specific project in Zoho Books. Use this tool to assign multiple users to a project in Zoho Books when managing project teams or updating project participation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalUnique ID of the organization in Zoho Books for which users are being assigned to a project. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
project_identifierstringOptionalThe unique identifier for the project to which users will be assigned. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_project_user'.
#

ZohoBooksApi.AssociateInvoiceWithSalesOrder

Link existing invoices to sales orders for tracking. This tool is used to associate existing invoices with one or more sales orders, enabling better tracking and management of orders and billing. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. Required for linking invoices with sales orders. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'map_invoice_with_salesorder'.
#

ZohoBooksApi.AttachExpenseReceipt

Attach a receipt to a specified expense. Use this tool to attach a receipt file to an existing expense record, identified by the expense ID. It is helpful when you need to provide proof or documentation for expense entries in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books.
expense_idstringRequiredUnique identifier for the expense to which the receipt will be attached.
expense_receipt_filestringOptionalThe file to attach as an expense receipt. Supported formats: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc, docx.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_expense_receipt'.
#

ZohoBooksApi.AttachFileToBill

Attach a file to a specific bill. Use this tool to attach a file to a specific bill in Zoho Books. It should be called when you need to upload and associate documents, such as receipts or invoices, with a bill.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe ID of the organization in Zoho Books to which the bill belongs.
bill_idstringRequiredUnique identifier of the bill for which the file will be attached. Use this to specify the target bill in Zoho Books.
file_attachmentstringOptionalFile to attach to the bill. Accepted formats: gif, png, jpeg, jpg, bmp, pdf.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_bill_attachment'.
#

ZohoBooksApi.AttachFileToInvoice

Attach a file to an invoice. Use this tool to upload and attach a file to a specified retainer invoice. This is useful for adding supporting documents or additional information to invoices. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization to which the invoice belongs. Required to specify the correct entity for file attachment. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
retainer_invoice_identifierstringOptionalUnique identifier of the retainer invoice to which the file will be attached. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_retainer_invoice_attachment'.
#

ZohoBooksApi.AttachFileToJournal

Attach a file to a Zoho Books journal entry. This tool is used to attach a file to a specific journal entry in Zoho Books. Use it when you need to upload and associate documents or files with journal entries for record-keeping or documentation purposes.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization where the file will be attached. This is used to specify the target organization in Zoho Books.
journal_unique_identifierstringRequiredProvide the unique identifier for the specific journal entry to which the file will be attached.
attachment_file_pathstringOptionalThe path to the file that will be attached to the journal in Zoho Books.
document_to_attachstringOptionalThe document or file to be attached to the journal entry in Zoho Books.
total_number_of_filesintegerOptionalSpecify the total number of files to be attached to the journal. Ensure this matches the actual number of attachments.
document_identifiersstringOptionalA string of document IDs that need to be attached. These IDs should be associated with the documents intended for attachment.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_journal_attachment'.
#

ZohoBooksApi.AttachFileToPurchaseOrder

Attach a file to a specified purchase order. Use this tool to attach a file to a specified purchase order in Zoho Books. Useful for adding supplementary documents or files to your existing purchase orders.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books.
purchase_order_idstringRequiredThe unique identifier of the purchase order to which the file will be attached.
file_attachmentstringOptionalThe file to attach to the purchase order. Must be one of the following formats: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc, or docx.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_purchase_order_attachment'.
#

ZohoBooksApi.AttachFileToSalesOrder

Attach a file to a specific sales order in Zoho Books. This tool is used to attach a file to a specific sales order in Zoho Books. It should be called when you need to upload and associate a document with a sales order for tracking or record-keeping purposes.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredUnique identifier for the organization in Zoho Books.
sales_order_identifierstringRequiredUnique identifier of the sales order to which the file will be attached.
file_to_attachstringOptionalPath or identifier of the file to be attached to the sales order.
document_file_pathstringOptionalPath to the document file that needs to be attached to the sales order.
number_of_filesintegerOptionalSpecify the total number of files to be attached to the sales order.
document_identifiersstringOptionalA string representing the IDs of the documents to attach. Comma-separated for multiple IDs.
allow_sending_file_in_mailbooleanOptionalBoolean indicating if the file can be sent in mail. True allows sending.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_sales_order_attachment'.
#

ZohoBooksApi.AttachInvoiceFile

Attach a file to a specified invoice. Use this tool to attach a file to a specific invoice using its ID. It is useful for adding documents related to the invoice.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredID of the organization for which the invoice attachment is being added. This is required to identify the specific organization within Zoho Books.
invoice_identifierstringRequiredUnique identifier for the invoice to attach the file to.
file_to_attachstringOptionalThe file to be attached. Allowed extensions: gif, png, jpeg, jpg, bmp, pdf.
send_attachment_in_emailbooleanOptionalSet to True to send the attachment with the invoice when emailed.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_invoice_attachment'.
#

ZohoBooksApi.BulkDeleteCustomerPayments

Delete multiple customer payments efficiently. Use this tool to remove several customer payments at once in Zoho Books. It's ideal for managing large-scale payment data cleanup.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier string for the organization in Zoho Books.
payment_ids_to_deletestringRequiredComma-separated list of payment IDs to be deleted in the bulk operation.
perform_bulk_deletebooleanRequiredSet to true to perform the bulk delete operation for customer payments.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'bulk_delete_customer_payments'.
#

ZohoBooksApi.CancelFixedAsset

Cancel a fixed asset in Zoho Books. Use this tool to cancel a fixed asset in Zoho Books by providing the fixed asset ID. This changes the status of the asset to canceled.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books. Required to specify which organization's fixed asset to cancel.
fixed_asset_idstringRequiredUnique identifier for the fixed asset to be canceled.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_fixed_asset_cancel'.
#

ZohoBooksApi.CancelPurchaseOrder

Cancel a specific purchase order in Zoho Books. Use this tool to mark a purchase order as cancelled within the Zoho Books platform. This is useful when an order needs to be invalidated or stopped.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe identifier for the organization in Zoho Books. This ID is required to specify which organization's purchase order should be cancelled.
purchase_order_idstringRequiredThe unique identifier of the purchase order to be cancelled.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_purchase_order_cancelled'.
#

ZohoBooksApi.CancelWriteOffInvoice

Cancel the write-off amount of an invoice in Zoho Books. Use this tool to revert the write-off process of an invoice in Zoho Books. This action can be performed when an invoice's write-off needs to be canceled, typically to amend financial records or correct a mistake.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization in Zoho Books whose invoice write-off is to be canceled.
invoice_unique_identifierstringRequiredThe unique identifier for the invoice whose write-off is to be canceled.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'cancel_write_off_invoice'.
#

ZohoBooksApi.CategorizeBankTransaction

Categorize an uncategorized bank transaction. This tool categorizes an uncategorized bank transaction by creating a new transaction. Use it when a bank transaction needs to be classified into a specific category. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalProvide the ID of the organization to categorize the transaction. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bank_transaction_idstringOptionalUnique identifier of the bank transaction to be categorized. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'categorize_bank_transaction'.
#

ZohoBooksApi.CategorizeBankTransactionAsExpense

Categorize an uncategorized bank transaction as an expense. Use this tool to classify an uncategorized bank transaction as an expense in Zoho Books. It should be called when a user needs to organize their financial records by assigning a transaction to the expense category. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique ID of the organization in Zoho Books. Required to identify which organization's transaction is being categorized. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bank_transaction_idstringOptionalUnique identifier for the bank transaction to be categorized as an expense. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
attachment_documentstringOptionalDocument file to attach with the transaction as a string (e.g., base64 encoded or URL). Only used when mode is 'execute'.
total_number_of_filesintegerOptionalTotal count of files to be attached to the transaction. Only used when mode is 'execute'.
document_identifiersintegerOptionalComma-separated list of document IDs to be attached to the transaction. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'categorize_bank_transaction_as_expense'.
#

ZohoBooksApi.CategorizeBankTransactionPaymentRefund

Categorize bank transactions as payment refunds. Use this tool to categorize uncategorized bank transactions specifically as payment refunds in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalUnique identifier for the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bank_statement_line_idstringOptionalUnique identifier for the bank statement line to be categorized. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'categorize_bank_transaction_as_payment_refund'.
#

ZohoBooksApi.CategorizeRefundVendorCredit

Categorize transactions as vendor credit refunds. Use this tool to categorize an uncategorized transaction as a refund from a vendor credit in Zoho Books. Call this tool when you need to identify and organize transactions involving vendor credit refunds. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalSpecify the ID of the organization for which the transaction is being categorized as a vendor credit refund. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bank_transaction_idstringOptionalUnique identifier of the bank transaction to categorize as a vendor credit refund. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'categorize_as_vendor_credit_refunds'.
#

ZohoBooksApi.CategorizeTransactionAsPayment

Categorize an uncategorized transaction as a Customer Payment. Use this tool to categorize an uncategorized bank transaction as a Customer Payment in Zoho Books. This should be called when you need to update the categorization status of bank transactions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization in Zoho Books for which the transaction is being categorized. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bank_transaction_idstringOptionalUnique identifier of the bank transaction to be categorized as Customer Payment. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'categorize_bank_transaction_as_customer_payment'.
#

ZohoBooksApi.CategorizeTransactionAsRefund

Categorize a transaction as a credit note refund. Use this tool to categorize an uncategorized bank transaction specifically as a refund from a credit note. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. Must match the organization in Zoho Books to categorize transactions accurately. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
transaction_idstringOptionalUnique identifier of the bank transaction to categorize as a refund from a credit note. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'categorize_as_credit_note_refunds'.
#

ZohoBooksApi.CategorizeTransactionAsVendorPayment

Categorize a bank transaction as a vendor payment. Use this tool to categorize an uncategorized bank transaction as a vendor payment in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique string ID of the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
transaction_idstringOptionalUnique identifier of the bank transaction to categorize as vendor payment. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'categorize_bank_transaction_as_vendor_payment'.
#

ZohoBooksApi.CategorizeVendorPaymentRefund

Categorize bank transactions as Vendor Payment Refund. Use this tool to categorize uncategorized bank transactions as vendor payment refunds. It should be called when organizing financial data related to refunds from vendors. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization whose transactions are being categorized. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bank_statement_line_idstringOptionalUnique identifier for the bank statement line to categorize as Vendor Payment Refund. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'categorize_as_vendor_payment_refund'.
#

ZohoBooksApi.CloneProject

Clone an existing project in Zoho Books. Use this tool to create a copy of an existing project in Zoho Books. It's useful for duplicating project setups with similar parameters or settings. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
project_unique_identifierstringOptionalUnique string identifier of the project to be cloned. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'clone_project'.
#

ZohoBooksApi.ConvertCreditNoteToDraft

Convert a voided credit note to a draft status. Use this tool to change the status of a voided credit note back to draft in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books.
credit_note_idstringRequiredUnique identifier of the credit note to be converted to draft.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_credit_note_draft'.
#

ZohoBooksApi.ConvertPurchaseOrderToBill

Fetch bill payload from purchase orders. This tool retrieves the bill payload for selected purchase orders using their IDs. It should be called when you want to convert purchase orders into a bill. After obtaining the payload, use it to create a bill in the system.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredEnter the ID of the organization for which the bill will be created.
purchase_order_idsstringRequiredComma-separated IDs of the purchase orders to be converted into a bill.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'convert_purchase_order_to_bill'.
#

ZohoBooksApi.CreateAssociatedTax

Create and associate a tax with an item. This tool creates a tax that can be added to an item within the Zoho Books system. It is used when a new tax needs to be defined and linked to specific goods or services. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization in Zoho Books where the tax will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_tax'.
#

ZohoBooksApi.CreateBankAccount

Create a bank or credit card account in your organization. This tool is used to create a new bank account or credit card account for your organization via Zoho Books. Call this tool when you need to add financial accounts to manage and track transactions in your organization's accounting system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization for which to create the bank or credit card account. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_bank_account'.
#

ZohoBooksApi.CreateBankTransaction

Creates a bank transaction in Zoho Books. This tool is used to create a bank transaction within Zoho Books. It should be called when a user needs to log a financial transaction using allowed transaction types. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization for which the bank transaction is to be created. This ID helps identify the specific organization within Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_bank_transaction'.
#

ZohoBooksApi.CreateBusinessContact

Create a new business contact with comprehensive details. Use this tool to create a contact in Zoho Books with information such as name, company details, addresses, and more. This contact can be utilized for various business transactions like invoices and estimates. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique ID of the organization for which the contact is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_contact'.
#

ZohoBooksApi.CreateChartOfAccount

Creates an account with a specified account type. This tool is used to create a new account within the chart of accounts by specifying the type of account desired. It is suitable when setting up financial frameworks or managing accounting structures. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization for which the account is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_chart_of_account'.
#

ZohoBooksApi.CreateContactPerson

Create a contact person for a contact in Zoho Books. Use this tool to add a new contact person associated with a contact in Zoho Books. It facilitates managing additional contact person details within the platform. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization where the contact person will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_contact_person'.
#

ZohoBooksApi.CreateCreditNote

Create a new credit note for customer adjustments. Use this tool to create a credit note when issuing credits to customers for reasons such as returned items, overpayments, or necessary adjustments. It supports multi-currency, custom line items, tax calculations, and workflows. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization for which the credit note is being created. Required for identifying the correct entity within Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
invoice_idstringOptionalInvoice ID for the required invoice to associate with the credit note. Only used when mode is 'execute'.
use_custom_credit_note_numberbooleanOptionalSet to true to provide your own credit note number, bypassing auto-numbering. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_credit_note'.
#

ZohoBooksApi.CreateCurrency

Create a currency for transactions in Zoho Books. Use this tool to add a new currency for use in transactions within Zoho Books. This is useful when expanding the supported currencies for financial activities. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization for which the currency is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_currency'.
#

ZohoBooksApi.CreateCurrencyAdjustment

Create a base currency adjustment. This tool creates an adjustment to the base currency based on the provided information. It is used to update and manage currency values in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique identifier for the organization in Zoho Books. Required for currency adjustments. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
account_identifiersstringOptionalComma-separated IDs of accounts for currency adjustments in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_base_currency_adjustment'.
#

ZohoBooksApi.CreateCustomerDebitNote

Create a customer debit note for invoice adjustments. This tool is used to create a customer debit note when there are additional charges or adjustments needed for an existing invoice in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalA unique identifier for the organization to which the debit note will be associated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
send_debit_notebooleanOptionalSet to true to send the debit note to the associated contacts. Accepts true or false. Only used when mode is 'execute'.
ignore_auto_number_generationbooleanOptionalSet to true to ignore automatic debit note number generation, requiring manual entry. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_customer_debit_note'.
#

ZohoBooksApi.CreateCustomerEstimate

Create an estimate for a customer using Zoho Books. Use this tool to generate a new estimate for a customer within the Zoho Books system. This could be useful when users need to provide potential price quotes or service costs to clients. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization for which the estimate is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
send_estimate_to_contactbooleanOptionalSet to true to send the estimate to the contact person(s) associated with it, false to skip sending. Only used when mode is 'execute'.
ignore_automatic_estimate_number_generationbooleanOptionalSet to true to bypass automatic estimate number generation. This requires specifying an estimate number. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_estimate'.
#

ZohoBooksApi.CreateCustomerInvoice

Create an invoice for your customer. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization for which the invoice is created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
send_invoice_to_contactsbooleanOptionalBoolean to determine if the invoice is sent to the contact persons. Use 'true' to send, 'false' otherwise. Only used when mode is 'execute'.
ignore_auto_number_generationbooleanOptionalSet to true to ignore auto invoice number generation, requiring manual input. Only used when mode is 'execute'.
enable_quick_create_modebooleanOptionalEnable quick create mode for streamlined invoice creation with minimal required fields. Set to true for activation. Only used when mode is 'execute'.
enable_batch_paymentsbooleanOptionalEnable batch payment processing for the invoice. True means the invoice is included in batch operations. Requires 'is_quick_create' to be true. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_invoice'.
#

ZohoBooksApi.CreateCustomerPayment

Create a new customer payment in Zoho Books. Use this tool to record a new payment for a customer in Zoho Books. It should be called when you need to add a payment entry for accounting purposes or to update a customer's payment status. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books. This is necessary to associate the payment with the correct organization. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_customer_payment'.
#

ZohoBooksApi.CreateCustomModule

Creates a custom module in Zoho Books. Use this tool to create a custom module in Zoho Books. Specify the module name as needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization for which the custom module is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
custom_module_namestringOptionalSpecify the name for the custom module to be created in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_custom_module'.
#

ZohoBooksApi.CreateEmployeeForExpense

Create an employee for an expense record in Zoho Books. This tool is used to create a new employee entry for the purpose of logging an expense in Zoho Books. It should be called when there is a need to register an employee related to specific expenses. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization in Zoho Books where the employee will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_employee'.
#

ZohoBooksApi.CreateExchangeRate

Create an exchange rate for a specified currency. This tool should be called when you need to create a new exchange rate for a specific currency in Zoho Books. It allows you to define exchange rates between specified currencies. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization for which the exchange rate is being created. This must be a unique identifier within Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
currency_identifierstringOptionalUnique identifier for the currency used to create the exchange rate in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_exchange_rate'.
#

ZohoBooksApi.CreateExpense

Create a billable or non-billable expense record. Use this tool to create an expense entry that can be marked as billable or non-billable. Ideal for tracking expenses in your financial system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization for which the expense is being recorded. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
expense_receipt_filestringOptionalFile path or URL for the expense receipt. Accepted formats: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc, docx. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_expense'.
#

ZohoBooksApi.CreateFinancialAccountRule

Create and apply rules for banking and credit accounts. This tool allows you to create a rule for deposits, withdrawals, refunds, or charges on bank and credit card accounts. It should be called when you need to automate financial processes by setting specific rules for account transactions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. Used to specify which organization's account rules are being altered. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_bank_account_rule'.
#

ZohoBooksApi.CreateFixedAsset

Create a fixed asset in Zoho Books. This tool is used to create a fixed asset in the Zoho Books platform. It should be called when a user wants to register a new fixed asset in their accounting records. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization in Zoho Books for which the fixed asset is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_fixed_asset'.
#

ZohoBooksApi.CreateFixedAssetType

Create a fixed asset type in Zoho Books. Use this tool to create a new fixed asset type in Zoho Books whenever you need to categorize assets. It facilitates asset management by defining specific asset categories. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization for which to create the fixed asset type. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_fixed_asset_type'.
#

ZohoBooksApi.CreateInvoiceFromSalesOrder

Create an invoice from a confirmed sales order. Use this tool to instantly generate an invoice based on confirmed sales orders. Ideal for automating billing processes directly from sales orders.

Parameters

ParameterTypeReq.Description
sales_order_idstringRequiredThe unique identifier of the confirmed sales order to create an invoice for.
organization_idstringRequiredID of the organization for which the invoice is being created. This must be a valid string ID.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_invoice_from_salesorder'.
#

ZohoBooksApi.CreateJournalEntry

Create a journal entry in Zoho Books. Use this tool to add a new journal entry in Zoho Books. It should be called when there's a need to record financial transactions manually. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_journal'.
#

ZohoBooksApi.CreateNewZohoItem

Create a new item in Zoho Books inventory. Use this tool to create a new item in Zoho Books. This is useful for adding products or services to your Zoho inventory for tracking purposes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_item'.
#

ZohoBooksApi.CreateOpeningBalance

Creates an opening balance for accounts. Use this tool to create an opening balance with specified account information in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization for which the opening balance is being created. This ID is required to specify the target organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_opening_balance'.
#

ZohoBooksApi.CreateOrganizationInZohoBooks

Create a new organization in Zoho Books. Use this tool to create a new organization in the Zoho Books platform. It is called when there's a need to add organizational details to Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization to be created in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_organization'.
#

ZohoBooksApi.CreateOrganizationUser

Create a user for your organization in Zoho Books. This tool facilitates the creation of a new user within your organization using Zoho Books' services. It should be called when you need to register a new user in your organization's Zoho Books account. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books where the user will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_user'.
#

ZohoBooksApi.CreateProject

Create a new project in Zoho Books. This tool facilitates the creation of a new project within Zoho Books. It should be called when there's a need to start a new project and integrate it into the Zoho Books system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalUnique identifier for the organization in Zoho Books. Required for project creation. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_project'.
#

ZohoBooksApi.CreateRecurringBill

Create a recurring bill in Zoho Books. This tool creates a recurring bill in Zoho Books. Use it to automate periodic billing tasks and ensure payments are scheduled consistently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization in Zoho Books for which the recurring bill will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_recurring_bill'.
#

ZohoBooksApi.CreateRecurringExpense

Create a recurring expense in Zoho Books. Use this tool to create a recurring expense in Zoho Books. It allows you to automate expense tracking by setting expenses to recur at specified intervals. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books. This ID is necessary to specify which organization's records to create the recurring expense under. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_recurring_expense'.
#

ZohoBooksApi.CreateRecurringInvoice

Create a new recurring invoice in Zoho Books. This tool creates a new recurring invoice within Zoho Books. Use this tool when you need to automate the billing of customers on a regular schedule. It returns the details of the invoice created, enabling tracking and management of recurring payments. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization for which the recurring invoice is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_recurring_invoice'.
#

ZohoBooksApi.CreateRetainerInvoice

Create a retainer invoice for a customer. Use this tool to create a retainer invoice for a customer through Zoho Books. It should be called when you need to generate an invoice requiring advance payment or retaining fees for services or products. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization for which the retainer invoice is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
ignore_auto_number_generationbooleanOptionalSet to true to ignore automatic invoice number generation and manually input the invoice number. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_retainer_invoice'.
#

ZohoBooksApi.CreateSalesOrder

Create a sales order for a customer. This tool creates a sales order for a customer using Zoho Books. It should be called when you need to generate a new sales order in your accounting system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique ID of the organization for which the sales order is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
total_number_of_filesintegerOptionalSpecify the total number of files to be attached to the sales order. Only used when mode is 'execute'.
document_attachmentstringOptionalA document to be attached to the sales order. Provide as a string containing the document details or content. Only used when mode is 'execute'.
ignore_auto_number_generationbooleanOptionalSet to true to ignore auto sales order number generation, requiring manual sales order number entry. Only used when mode is 'execute'.
can_send_via_emailbooleanOptionalSet to true if the file can be sent via email. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_sales_order'.
#

ZohoBooksApi.CreateSalesReceipt

Create a sales receipt for immediate payment transactions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalUnique identifier for the organization needed to create the sales receipt. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
ignore_auto_number_generationbooleanOptionalSet to true to ignore automatic sales receipt number generation, requiring manual entry of the receipt number. Only used when mode is 'execute'.
send_receipt_via_emailbooleanOptionalSet to true to send the sales receipt to the customer via email. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_sales_receipt'.
#

ZohoBooksApi.CreateTaxAuthority

Create a tax authority in Zoho Books. Use this tool to create a new tax authority in Zoho Books. Suitable for financial administrators managing tax compliance. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization for which the tax authority is to be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_tax_authority'.
#

ZohoBooksApi.CreateTaxExemption

Create a tax exemption in Zoho Books. Use this tool to create a tax exemption in Zoho Books when you need to apply tax exemptions for transactions or customers. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books for which the tax exemption is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_tax_exemption'.
#

ZohoBooksApi.CreateTaxGroup

Create a tax group with multiple associated taxes. This tool calls the Zoho Books API to create a tax group, allowing you to associate multiple taxes into a single group. Use this tool when you need to manage and apply tax groups for accounting purposes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization within Zoho Books. This is required to create a tax group. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_tax_group'.
#

ZohoBooksApi.CreateVendorBill

Create a bill received from your vendor. Use this tool to log and manage invoices received from vendors by creating a bill in your system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in which the bill will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
attachment_file_pathstringOptionalPath to the file to attach. Accepts GIF, PNG, JPEG, JPG, BMP, and PDF formats. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_bill'.
#

ZohoBooksApi.CreateVendorCredit

Create vendor credit for returns or adjustments. Use this tool to record new vendor credits for returned items, overpayments, or adjustments. Supports multi-currency, custom line items, taxes, and workflows. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization for which the vendor credit is being created. Must be a valid organization ID. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bill_idstringOptionalIdentifier of the bill associated with the vendor credit. Required for linking the credit to a specific transaction. Only used when mode is 'execute'.
ignore_auto_number_generationbooleanOptionalSet to true to bypass auto number generation. A vendor credit number becomes mandatory when enabled. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_vendor_credit'.
#

ZohoBooksApi.CreateVendorPayment

Create and apply a payment to a vendor's bill. This tool is used to record a payment made to a vendor, with the option to apply the payment either partially or fully to the vendor's outstanding bills. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique ID of the organization to which the vendor payment belongs. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_vendor_payment'.
#

ZohoBooksApi.CreateVendorPurchaseOrder

Generate a purchase order for a vendor. Use this tool to create a purchase order for a vendor in Zoho Books. It facilitates procurement by initiating an order with specified vendor details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books for which the purchase order is being created. Required to specify the target organization. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
file_attachmentstringOptionalFile path or URL to attach. Allowed extensions: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc, docx. Only used when mode is 'execute'.
ignore_auto_number_generationbooleanOptionalSet to true to disable automatic purchase order number generation, requiring a manual number. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_purchase_order'.
#

ZohoBooksApi.CreateZohoBookLocation

Create a new location in Zoho Books. Use this tool to create a new business location within Zoho Books. It handles the setup of location data, allowing integration of new physical or digital locations into the Zoho Books system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization for which the location is being created in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_location'.
#

ZohoBooksApi.CreditNoteRefundListing

Retrieve a paginated list of credit note refunds. Use this tool to get a list of all credit note refunds, including pagination information for navigating through large sets of data.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. Use this to specify which organization's credit note refunds to list.
customer_identifierstringOptionalID of the customer for whom the credit note is raised. Provide to filter refunds by customer.
refunds_sort_columnstringOptionalSpecifies the attribute to sort the credit note refunds. Use values like 'refund_mode', 'reference_number', 'date', 'creditnote_number', 'customer_name', 'amount_bcy', or 'amount_fcy'.
pagination_page_numberintegerOptionalPage number for pagination to specify which page of results to retrieve. Default is 1.
records_per_pageintegerOptionalNumber of records to display per page in the paginated results. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_credit_note_refunds'.
#

ZohoBooksApi.CrmToBooksContactImport

Import a customer from Zoho CRM to Zoho Books using CRM contact ID. Use this tool when you need to import a customer from Zoho CRM to Zoho Books based on their CRM contact ID. Ensure that Zoho Books is integrated with Zoho CRM using the correct sync settings for contacts.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization within Zoho Books.
zoho_crm_contact_idstringRequiredUnique identifier for the Zoho CRM contact to import into Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'import_customer_using_crm_contact_id'.
#

ZohoBooksApi.DeactivateBankAccount

Deactivate a bank account in Zoho Books. Use this tool to mark a bank account as inactive in Zoho Books. This can be useful when an account is no longer in use and should be temporarily disabled.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization in Zoho Books. This is required to identify which organization's bank account to deactivate.
bank_account_idstringRequiredUnique identifier of the bank account to deactivate in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_bank_account_inactive'.
#

ZohoBooksApi.DeactivateChartOfAccount

Deactivate a specific chart of account. Use this tool to mark a specific chart of account as inactive in Zoho Books. This is helpful when you need to manage account statuses and ensure they reflect current business requirements.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredID of the organization to deactivate the chart of account for.
account_identifierstringRequiredThe unique identifier of the account to be deactivated.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_chart_of_account_inactive'.
#

ZohoBooksApi.DeactivateProject

Deactivate a project in Zoho Books. Use this tool to mark a project as inactive in Zoho Books when it is no longer active or needed.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books. Required for identifying the organization for the project update.
project_idstringRequiredThe unique identifier of the project to be marked as inactive.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_project_inactive'.
#

ZohoBooksApi.DeactivateUserAccount

Deactivate a user's account in Zoho Books. Use this tool to mark an active user as inactive within Zoho Books. It is useful when needing to revoke access or deactivate an account.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization within Zoho Books to which the user belongs.
user_unique_identifierstringRequiredProvide the unique identifier of the user to be deactivated.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_user_inactive'.
#

ZohoBooksApi.DeclineEstimate

Marks a sent estimate as declined if rejected by customer. Use this tool to update the status of an estimate to 'declined' when a customer has rejected it. This is helpful in maintaining accurate records of customer interactions.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization for which the estimate is being declined.
estimate_identifierstringRequiredUnique identifier of the estimate to mark as declined.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_estimate_declined'.
#

ZohoBooksApi.DeleteAccount

Delete a chart of account in Zoho Books. Use this tool to delete an existing chart of account. Note that accounts associated with transactions or products cannot be deleted.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization in Zoho Books.
account_identifierstringRequiredThe unique identifier for the account to be deleted in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_chart_of_account'.
#

ZohoBooksApi.DeleteAssetComment

Delete a comment from a fixed asset in Zoho Books. Use this tool to delete an existing comment on a fixed asset within Zoho Books by specifying the fixed asset and comment IDs.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredProvide the ID of the organization to specify which organization's asset comment you want to delete.
fixed_asset_identifierstringRequiredUnique identifier of the fixed asset to delete a comment from.
comment_idstringRequiredUnique identifier of the comment to be deleted from the fixed asset.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_fixed_asset_comment'.
#

ZohoBooksApi.DeleteBankAccount

Delete a bank account from your organization. Use this tool to permanently delete a bank account associated with your organization in Zoho Books. This should be called when you need to remove an account to prevent future transactions.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books. Required to identify which organization's bank account is to be deleted.
bank_account_unique_idstringRequiredUnique identifier of the bank account to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_bank_account'.
#

ZohoBooksApi.DeleteBankAccountRule

Deletes a bank account rule, removing its effect on transactions. Use this tool to delete a specific bank account rule, making it inapplicable to future transactions.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID representing the organization. Required for identifying the correct account.
bank_account_rule_idstringRequiredUnique identifier of the bank account rule to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_bank_account_rule'.
#

ZohoBooksApi.DeleteBankTransaction

Delete a bank transaction using its ID. Use this tool to delete a specific bank transaction by providing the transaction ID. Ideal for managing and cleaning up bank account transactions.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredSpecify the ID of the organization to target for transaction deletion.
bank_transaction_idstringRequiredUnique identifier for the bank transaction to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_bank_transaction'.
#

ZohoBooksApi.DeleteBillAttachment

Delete the file attached to a specific bill. This tool deletes the file attached to a specified bill in Zoho Books. It should be called when there's a need to remove an attachment associated with a bill.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization within Zoho Books. This is required to specify which organization's bill attachment is to be deleted.
bill_unique_identifierstringRequiredUnique identifier for the specific bill whose attachment is to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_bill_attachment'.
#

ZohoBooksApi.DeleteBillComment

Delete a specific comment from a bill in Zoho Books. Use this tool to remove a comment from a specific bill in Zoho Books when the comment is no longer needed or was made in error.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization from which the bill comment will be deleted.
bill_identifierstringRequiredThe unique identifier for the bill from which the comment will be deleted. This ID is necessary to specify the correct bill in Zoho Books.
comment_idstringRequiredUnique identifier of the comment to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_bill_comment'.
#

ZohoBooksApi.DeleteBillPayment

Delete a payment made to a bill. Use this tool to delete an existing payment associated with a bill when necessary. It helps in managing and correcting payment records in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books for which the bill payment is to be deleted.
bill_identifierstringRequiredUnique identifier of the bill to be deleted.
bill_payment_identifierstringRequiredUnique identifier of the bill payment to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_bill_payment'.
#

ZohoBooksApi.DeleteContact

Delete an existing contact from the system.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization from which the contact will be deleted.
contact_unique_identifierstringRequiredUnique identifier of the contact to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_contact'.
#

ZohoBooksApi.DeleteContactAddress

Deletes an additional address of a contact. This tool deletes an additional address of a specific contact in Zoho Books when given the contact and address IDs. Use it to manage contact address details.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredUnique ID of the organization in Zoho Books required for address deletion.
contact_unique_idstringRequiredUnique identifier for the contact whose address you want to delete.
address_identifierstringRequiredUnique identifier of the address to be deleted for the specified contact.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_contact_address'.
#

ZohoBooksApi.DeleteContactPerson

Delete an existing contact person from the records. Use this tool to remove a contact person using their unique ID from the records. It should be called when a user's contact details are no longer needed or need to be removed for any reason.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization to identify which entity the contact person belongs to.
contact_person_idstringRequiredUnique identifier for the contact person to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_contact_person'.
#

ZohoBooksApi.DeleteCreditNote

Delete an existing credit note using its ID. Use this tool to delete a specific credit note by providing its unique ID. This action is irreversible.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization whose credit note you wish to delete.
credit_note_idstringRequiredUnique identifier of the credit note to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_credit_note'.
#

ZohoBooksApi.DeleteCreditNoteComment

Delete a specific comment from a credit note. Use this tool to delete a comment from a credit note in Zoho Books. It requires the credit note ID and the comment ID to specify which comment to remove.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books. Required for deleting a credit note comment.
credit_note_idstringRequiredUnique identifier of the credit note to which the comment belongs.
comment_unique_identifierstringRequiredThe unique ID of the comment to be deleted from a credit note.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_credit_note_comment'.
#

ZohoBooksApi.DeleteCreditNoteInvoice

Delete the credits applied to an invoice of a credit note. Use this tool to remove credits applied to an invoice associated with a credit note, ensuring the invoice record reflects modified credits.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization to identify which organization's data is being manipulated.
credit_note_unique_idstringRequiredUnique identifier for the credit note to delete its associated invoice credits.
credit_note_invoice_idstringRequiredUnique identifier of the credit note invoice to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_invoice_of_credit_note'.
#

ZohoBooksApi.DeleteCreditNoteRefund

Delete a specific credit note refund by ID. Use this tool to remove a credit note refund for a given credit note and refund ID when it's no longer needed or was made in error.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. Required to delete a credit note refund.
credit_note_idstringRequiredUnique identifier of the credit note to be refunded.
credit_note_refund_idstringRequiredUnique identifier of the credit note refund to delete.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_credit_note_refund'.
#

ZohoBooksApi.DeleteCurrencyAdjustment

Deletes the specified base currency adjustment. Use this tool to delete a specific base currency adjustment by providing its ID. Useful for managing and updating financial records.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization whose currency adjustment you want to delete.
base_currency_adjustment_idstringRequiredUnique identifier of the base currency adjustment to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_base_currency_adjustment'.
#

ZohoBooksApi.DeleteCustomerDebitNote

Delete an existing customer debit note in Zoho Books. Use this tool to delete a customer debit note in Zoho Books. Note that debit notes with payments or credit notes applied cannot be deleted.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization within Zoho Books. Required to specify which organization's data to access or modify.
debit_note_unique_idstringRequiredUnique identifier for the debit note to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_customer_debit_note'.
#

ZohoBooksApi.DeleteCustomerPayment

Delete an existing payment for a customer. Use this tool when you need to delete a specific customer payment by its payment ID. It confirms the removal of the payment record.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization whose payment is being deleted.
payment_identifierstringRequiredUnique identifier for the payment to be deleted. Required to specify which payment record should be removed.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_customer_payment'.
#

ZohoBooksApi.DeleteCustomerPaymentRefund

Delete a refund for an existing customer payment. This tool should be called when you need to delete a refund associated with an existing customer payment in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which the refund deletion is requested.
customer_payment_identifierstringRequiredThe unique identifier for the customer payment associated with the refund to be deleted.
refund_identifierstringRequiredUnique identifier of the refund to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_customer_payment_refund'.
#

ZohoBooksApi.DeleteCustomModule

Deletes a specified custom module in Zoho Books. This tool is used to delete a custom module within Zoho Books. It should be called when you need to remove a specific custom module by its name.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books.
module_namestringRequiredThe name of the custom module to be deleted in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_custom_module'.
#

ZohoBooksApi.DeleteCustomModuleRecord

Delete an individual record from a custom module. Use this tool to delete specific records from a custom module in Zoho Books. Provide the module name and module ID to identify and remove the desired record.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. Required to specify which organization's module record to delete.
module_namestringRequiredName of the custom module containing the record to delete.
custom_module_idintegerRequiredThe unique integer ID of the custom module to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_custom_module_record'.
#

ZohoBooksApi.DeleteEmployeeRecord

Remove an employee from the records in Zoho Books. This tool is used to delete an existing employee in Zoho Books. It should be called when there is a need to permanently remove an employee's record from the system.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredID of the organization to uniquely identify it for employee deletion.
employee_identifierstringRequiredThe unique identifier for the employee to be deleted in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_employee'.
#

ZohoBooksApi.DeleteEstimate

Delete an existing estimate in Zoho Books. Use this tool to remove an estimate by providing its unique estimate ID in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization where the estimate will be deleted.
estimate_idstringRequiredUnique identifier for the estimate to be deleted in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_estimate'.
#

ZohoBooksApi.DeleteEstimateComment

Delete an estimate comment. Use this tool to remove a comment from an estimate in Zoho Books. Ideal for cleaning up or managing comments related to estimates.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization where the estimate comment is located.
estimate_unique_idstringRequiredThe unique identifier for the estimate, required to specify which estimate's comment to delete.
comment_unique_identifierstringRequiredUnique identifier of the comment to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_estimate_comment'.
#

ZohoBooksApi.DeleteExchangeRate

Delete an exchange rate for a specific currency. Use this tool to delete an exchange rate using the specified currency and exchange rate IDs.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which the exchange rate is being deleted.
currency_identifierstringRequiredUnique identifier for the currency whose exchange rate is to be deleted.
exchange_rate_identifierstringRequiredUnique identifier for the exchange rate to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_exchange_rate'.
#

ZohoBooksApi.DeleteExistingBill

Deletes an existing bill if no payments are applied. Call this tool to delete a bill in Zoho Books if the bill has no payments applied. It confirms successful deletion of the bill.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization in Zoho Books needed to delete the bill.
bill_identifierstringRequiredThe unique identifier of the bill you wish to delete.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_bill'.
#

ZohoBooksApi.DeleteExpenseEntry

Delete an existing expense entry in Zoho Books. Use this tool to delete a specific expense entry from Zoho Books when you need to remove an incorrect or unnecessary record.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique identifier for the organization within Zoho Books.
expense_identifierstringRequiredUnique identifier of the expense to be deleted in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_expense'.
#

ZohoBooksApi.DeleteExpenseReceipt

Deletes the receipt attached to an expense. Use this tool to remove the receipt associated with a specific expense in Zoho Books, identified by the expense ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization for which the expense receipt is to be deleted. Ensure it's accurate to target the correct entity.
expense_idstringRequiredUnique identifier for the expense whose receipt is to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_expense_receipt'.
#

ZohoBooksApi.DeleteFixedAsset

Delete a specified fixed asset. Use this tool to delete a fixed asset by providing its ID. This action is irreversible, so ensure you have the correct ID before proceeding.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization from which the fixed asset will be deleted. Ensure this ID corresponds to the correct organization.
fixed_asset_identifierstringRequiredUnique identifier of the fixed asset to be deleted. This ID is required to specify which asset to remove.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_fixed_asset'.
#

ZohoBooksApi.DeleteFixedAssetType

Deletes a specified fixed asset type from the system.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization within Zoho Books.
fixed_asset_type_identifierstringRequiredUnique identifier for the fixed asset type to delete.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_fixed_asset_type'.
#

ZohoBooksApi.DeleteInvoiceAttachment

Delete the file attached to an invoice. This tool should be called to delete an attachment from a specified invoice in Zoho Books. Useful for managing or cleaning up invoice files.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which the invoice attachment will be deleted. This is required to authenticate and identify the specific organization on Zoho Books.
invoice_identifierstringRequiredUnique identifier of the invoice to delete the attachment from. Must match the invoice's ID in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_invoice_attachment'.
#

ZohoBooksApi.DeleteInvoiceComment

Delete a specific comment from an invoice. Use this tool to remove a comment from an invoice in Zoho Books. It is useful when a comment is no longer relevant or was added by mistake.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredIdentifier for the organization in Zoho Books.
invoice_identifierstringRequiredUnique identifier of the invoice to delete the comment from.
comment_unique_identifierstringRequiredThe unique identifier for the comment to be deleted from the invoice.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_invoice_comment'.
#

ZohoBooksApi.DeleteInvoiceDocument

Delete a document attached to an invoice. Permanently removes a document from an invoice in Zoho Books. This tool should be called when there is a need to delete a specific non-system-generated document associated with an invoice.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books. This is required to specify which organization's invoice document is to be deleted.
invoice_idstringRequiredThe unique identifier of the invoice from which the document will be deleted. This ID is required and must be a valid invoice in the system.
invoice_document_idstringRequiredThe unique ID of the document to be deleted from the invoice.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_invoice_document'.
#

ZohoBooksApi.DeleteInvoiceExpenseReceipt

Delete attached expense receipts from an invoice. Use this tool to delete expense receipts that are attached to an invoice, specifically those raised from an expense.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization from which the expense receipt will be deleted.
expense_identifierstringRequiredUnique identifier of the expense to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_invoice_expense_receipt'.
#

ZohoBooksApi.DeleteInvoiceInZohoBooks

Delete an existing invoice in Zoho Books. Use this tool to delete an existing invoice in Zoho Books. Note that invoices with payments or credit notes applied cannot be deleted.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which the invoice is to be deleted in Zoho Books.
invoice_identifierstringRequiredUnique identifier of the invoice to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_invoice'.
#

ZohoBooksApi.DeleteInvoicePayment

Delete a payment made to an invoice in Zoho Books. Use this tool to remove a payment record from an invoice in Zoho Books when it was entered incorrectly or is no longer needed.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books to which the payment belongs. This is required to identify the specific organization for deleting the invoice payment.
invoice_identifierstringRequiredUnique identifier of the invoice to delete the payment from.
invoice_payment_identifierstringRequiredUnique identifier of the invoice payment to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_invoice_payment'.
#

ZohoBooksApi.DeleteItemInZohoBooks

Delete an item from Zoho Books. This tool deletes an item from Zoho Books. It should be called to remove items that are no longer needed, provided they are not part of any transaction.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization in Zoho Books from which you wish to delete the item.
item_identifierstringRequiredUnique identifier of the item to be deleted from Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_item'.
#

ZohoBooksApi.DeleteJournalComment

Delete a journal comment in Zoho Books. Use this tool to delete a specific comment from a journal entry in Zoho Books. It should be called when you need to remove unwanted or incorrect comments from a journal.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. Required to specify which organization's journal comment should be deleted.
journal_unique_idstringRequiredUnique identifier of the journal for which the comment will be deleted.
comment_idstringRequiredUnique identifier of the comment to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_journal_comment'.
#

ZohoBooksApi.DeleteJournalEntry

Delete a specific journal entry by ID. This tool deletes a journal entry in Zoho Books when provided with the specific journal ID. Use this to remove incorrect or unnecessary journal records.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization associated with the journal to be deleted.
journal_entry_idstringRequiredThe unique identifier for the journal entry to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_journal'.
#

ZohoBooksApi.DeleteLastImportedBankStatement

Delete the last imported bank statement. Use this tool to delete the most recently imported bank statement from the specified bank account. Useful for correcting errors or removing unnecessary data.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. This is required to specify which organization's bank statement needs to be deleted.
bank_account_unique_identifierstringRequiredUnique identifier for the bank account from which the statement will be deleted.
bank_statement_idstringRequiredUnique identifier of the bank statement to be deleted. Required for identifying which statement to remove.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_last_imported_bank_statement'.
#

ZohoBooksApi.DeleteLocation

Delete a location from the system. Use this tool to remove a location by specifying its unique identifier in the system.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization to which the location belongs.
location_idstringRequiredThe unique identifier of the location to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_location'.
#

ZohoBooksApi.DeleteLoggedTimeEntry

Delete a specific logged time entry. Use this tool to delete a logged time entry from a project by specifying the time entry ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization from which the time entry will be deleted.
time_entry_identifierstringRequiredUnique identifier for the logged time entry to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_time_entry'.
#

ZohoBooksApi.DeleteMultipleVendorPayments

Delete multiple vendor payments in one action. Use this tool to delete multiple vendor payments at once, streamlining payment management and cleanup tasks.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization from which the vendor payments are to be deleted.
vendor_payment_idsstringRequiredComma-separated list of vendor payment IDs to delete.
bulk_deletebooleanRequiredSet to true to perform bulk deletion of vendor payments.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'bulk_delete_vendor_payments'.
#

ZohoBooksApi.DeleteOpeningBalance

Delete the entered opening balance in Zoho Books. Use this tool to remove the existing opening balance from Zoho Books settings when adjustments or corrections are needed.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization whose opening balance is to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_opening_balance'.
#

ZohoBooksApi.DeleteProject

Deletes an existing project in Zoho Books. Call this tool to delete an existing project in Zoho Books using the project ID. It confirms the deletion of the specified project.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization in Zoho Books. Required to identify the organization from which the project will be deleted.
project_idstringRequiredUnique identifier of the project to be deleted in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_project'.
#

ZohoBooksApi.DeleteProjectComment

Delete a specific comment from a project. Use this tool to delete a comment from a specified project. Useful when you need to remove unwanted or outdated comments from project discussions.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which the comment is to be deleted.
project_identifierstringRequiredUnique identifier of the project to delete the comment from.
comment_unique_identifierstringRequiredUnique identifier for the comment to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_project_comment'.
#

ZohoBooksApi.DeleteProjectTask

Remove a task from a specific project in Zoho Books. Call this tool to delete a specified task from a project using Zoho Books API. Use it when you need to manage project tasks and remove any that are no longer relevant.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization to which the task belongs.
project_identifierstringRequiredUnique identifier for the project from which a task will be deleted.
task_identifierstringRequiredUnique identifier of the task to be deleted in the project.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_task'.
#

ZohoBooksApi.DeletePurchaseOrder

Delete an existing purchase order in Zoho Books. Use this tool to remove a purchase order by providing its ID. The endpoint confirms the deletion once the operation is successful.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization within Zoho Books. Required to specify which organization's purchase order is to be deleted.
purchase_order_identifierstringRequiredUnique identifier for the purchase order to delete.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_purchase_order'.
#

ZohoBooksApi.DeletePurchaseOrderAttachment

Deletes the attachment from a purchase order. This tool is used to delete the file attached to a specified purchase order in Zoho Books, identified by the purchase order ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization in Zoho Books. This is required to specify which organization's records to access or modify.
purchase_order_idstringRequiredUnique identifier of the purchase order to delete the attachment from.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_purchase_order_attachment'.
#

ZohoBooksApi.DeletePurchaseOrderComment

Delete a comment from a purchase order. Use this tool to remove a specific comment associated with a purchase order by providing the purchase order ID and the comment ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books. Provide this to specify which organization's purchase order comment you wish to delete.
purchase_order_idstringRequiredUnique identifier of the purchase order to delete the comment from.
comment_unique_identifierstringRequiredUnique identifier of the comment to be deleted. Required to specify which comment to remove from a purchase order.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_purchase_order_comment'.
#

ZohoBooksApi.DeleteRecurringBill

Delete an existing recurring bill in Zoho Books. Use this tool to delete a recurring bill identified by its ID in Zoho Books. This is useful when managing financial records and removing bills that are no longer needed.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredID of the organization in Zoho Books to delete a recurring bill from.
recurring_bill_identifierstringRequiredUnique identifier of the recurring bill to be deleted in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_recurring_bill'.
#

ZohoBooksApi.DeleteRecurringExpense

Delete an existing recurring expense in Zoho Books. Use this tool to delete a recurring expense from Zoho Books when it's no longer needed or has been replaced. The tool confirms the successful removal of the specified recurring expense.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books.
recurring_expense_idstringRequiredThe unique identifier for the recurring expense to be deleted in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_recurring_expense'.
#

ZohoBooksApi.DeleteRecurringInvoice

Delete an existing recurring invoice. Call this tool to remove a recurring invoice from the system. Ensure you have the correct invoice ID to successfully delete the desired invoice.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization to which the recurring invoice belongs. Required for identifying the correct organization.
recurring_invoice_idstringRequiredUnique identifier for the recurring invoice to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_recurring_invoice'.
#

ZohoBooksApi.DeleteRetainerInvoice

Delete an existing retainer invoice. Use this tool to delete a retainer invoice. Note that invoices with applied payments or credit notes cannot be deleted.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization whose retainer invoice you want to delete.
retainer_invoice_identifierstringRequiredUnique identifier of the retainer invoice to delete. Required for specifying the invoice to be removed.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_retainer_invoice'.
#

ZohoBooksApi.DeleteRetainerInvoiceAttachment

Delete a file attached to a retainer invoice. Use this tool to delete a specific file attached to a retainer invoice. Call it when you need to remove an attachment from an invoice in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books whose invoice attachment is to be deleted.
retainer_invoice_idstringRequiredUnique identifier of the retainer invoice to specify which invoice's attachment should be deleted.
document_idstringRequiredUnique identifier of the retainer invoice document to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_retainer_invoice_attachment'.
#

ZohoBooksApi.DeleteRetainerInvoiceComment

Remove a specific comment from a retainer invoice. Use this tool to delete a comment from a retainer invoice in Zoho Books by providing the retainer invoice ID and the comment ID.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization within Zoho Books for which the comment is to be deleted.
retainer_invoice_idstringRequiredUnique identifier of the retainer invoice to find the specific invoice for comment deletion.
comment_identifierstringRequiredUnique identifier of the comment to be deleted from the retainer invoice.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_retainer_invoice_comment'.
#

ZohoBooksApi.DeleteSalesOrder

Delete an existing sales order. Use this tool to delete an existing sales order by its ID. It cannot delete invoiced sales orders.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredProvide the ID of the organization for which the sales order will be deleted.
sales_order_idstringRequiredUnique identifier for the sales order to be deleted. Ensure it is not invoiced.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_sales_order'.
#

ZohoBooksApi.DeleteSalesOrderAttachment

Delete an attached file from a sales order in Zoho Books. Call this tool to remove an attached file from a specified sales order in Zoho Books. Useful for managing and updating records by deleting unnecessary or outdated attachments.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization whose sales order attachment is to be deleted.
sales_order_idstringRequiredUnique identifier for the sales order from which the attachment will be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_sales_order_attachment'.
#

ZohoBooksApi.DeleteSalesOrderComment

Delete a comment from a sales order in Zoho Books. Use this tool to remove a comment from a specific sales order in Zoho Books by providing the sales order ID and the comment ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization. This ID is required to specify which organization's sales order comment needs to be deleted.
sales_order_idstringRequiredUnique identifier of the sales order to delete the comment from.
comment_identifierstringRequiredUnique identifier of the comment to delete.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_sales_order_comment'.
#

ZohoBooksApi.DeleteSalesReceipt

Delete an existing sales receipt in Zoho Books. This tool deletes a specified sales receipt from Zoho Books. It should be used when you need to permanently remove a sales receipt by its ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books.
sales_receipt_idstringRequiredThe unique identifier for the sales receipt to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_sales_receipt'.
#

ZohoBooksApi.DeleteTax

Delete a simple or compound tax in Zoho Books. Use this tool to remove a specific tax, whether simple or compound, from the Zoho Books system. This is useful when managing taxes and ensuring only relevant ones are active.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization within Zoho Books. This is required to specify which organization's tax entry to delete.
tax_identifierstringRequiredUnique identifier of the tax to be deleted in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_tax'.
#

ZohoBooksApi.DeleteTaxAuthority

Delete a specific tax authority. Use this tool to delete a tax authority when you need its removal confirmed.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization to identify which one the tax authority belongs to.
tax_authority_identifierstringRequiredThe unique identifier for the tax authority to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_tax_authority'.
#

ZohoBooksApi.DeleteTaxExemption

Delete a specific tax exemption from Zoho Books. Use this tool to delete a tax exemption in Zoho Books when you need to remove a specific exemption entry.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization in Zoho Books.
tax_exemption_identifierstringRequiredUnique identifier of the tax exemption to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_tax_exemption'.
#

ZohoBooksApi.DeleteTaxGroup

Delete a tax group if not associated with transactions. Use this tool to delete a tax group from Zoho Books. Note that tax groups associated with transactions cannot be deleted.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique identifier for the organization in Zoho Books.
tax_group_identifierstringRequiredUnique identifier of the tax group to be deleted. Ensure it's not associated with active transactions to proceed.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_tax_group'.
#

ZohoBooksApi.DeleteTimeEntries

Delete time tracking entries from projects. Use this tool to delete time entries from projects in Zoho Books. It should be called when you need to remove specific time tracking records.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredID of the organization to identify which entity's time entries will be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_time_entries'.
#

ZohoBooksApi.DeleteTransaction

Delete a specified accounting transaction. This tool is used to delete a specified transaction from the chart of accounts in Zoho Books. Call this tool when you need to remove a transaction permanently.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books for which the transaction will be deleted.
transaction_identifierstringRequiredUnique identifier for the transaction to be deleted in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_chart_of_account_transaction'.
#

ZohoBooksApi.DeleteVendorCredit

Delete a vendor credit by its ID. Use this tool to delete a specific vendor credit using its unique ID. This is typically required when a vendor credit is no longer valid or was added by mistake.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. Required to specify which organization's vendor credit to delete.
vendor_credit_identifierstringRequiredUnique identifier of the vendor credit to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_vendor_credit'.
#

ZohoBooksApi.DeleteVendorCreditComment

Delete a vendor credit comment in Zoho Books. Use this tool to delete a specific comment from a vendor credit in Zoho Books. This is useful when you need to manage or clean up vendor credit records by removing unnecessary or incorrect comments.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books.
vendor_credit_idstringRequiredUnique identifier of the vendor credit to specify which comment to delete.
comment_idstringRequiredUnique identifier of the vendor credit comment to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_vendor_credit_comment'.
#

ZohoBooksApi.DeleteVendorCreditRefund

Delete a vendor credit refund in Zoho Books. Use this tool to delete a specific vendor credit refund in Zoho Books when you have the vendor credit ID and refund ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization to which the vendor credit refund belongs.
vendor_credit_identifierstringRequiredUnique identifier for the vendor credit, required to delete the refund.
vendor_credit_refund_idstringRequiredUnique identifier for the specific vendor credit refund you wish to delete.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_vendor_credit_refund'.
#

ZohoBooksApi.DeleteVendorPayment

Delete an existing vendor payment in Zoho Books. Use this tool to delete a specific vendor payment in Zoho Books when you have the payment ID and need to erase it from the records.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization for which the vendor payment is to be deleted. This is required to identify the correct organization within Zoho Books.
vendor_payment_idstringRequiredUnique identifier of the vendor payment to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_vendor_payment'.
#

ZohoBooksApi.DeleteVendorPaymentRefund

Delete a refund from an existing vendor payment. Use this tool to remove a specific refund associated with a vendor payment. It's useful when a refund needs to be retracted or corrected.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization to which the vendor payment refund belongs.
payment_identifierstringRequiredUnique identifier of the payment to be deleted.
vendor_payment_refund_idstringRequiredUnique identifier of the vendor payment refund to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_vendor_payment_refund'.
#

ZohoBooksApi.DisableContactPaymentReminder

Disable automated payment reminders for a contact. This tool is used to disable automated payment reminders for a specific contact in Zoho Books. It should be called when you want to stop the system from sending payment reminders to a particular contact.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books for which payment reminders will be disabled.
contact_unique_identifierstringRequiredUnique identifier of the contact to disable payment reminders for.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'disable_contact_payment_reminder'.
#

ZohoBooksApi.DisableInvoicePaymentReminder

Disable automated payment reminders for an invoice.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. Required to specify which organization's invoice reminders are being disabled.
invoice_identifierstringRequiredUnique identifier of the invoice to disable payment reminders.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'disable_invoice_payment_reminder'.
#

ZohoBooksApi.EmailContactStatement

Sends an email statement to a specified contact. This tool triggers an email statement to be sent to a specific contact using Zoho Books. If no JSON input is provided, the email will use default content. Use this tool when you need to send financial statements to clients or contacts. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. Required to send the email statement to a specified contact. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
contact_identifierstringOptionalUnique identifier of the contact to send the statement to. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
statement_start_datestringOptionalThe starting date for the statement in the format [yyyy-mm-dd]. If omitted, the current month will be used. Only used when mode is 'execute'.
statement_end_datestringOptionalEnd date for the statement in the format [yyyy-mm-dd]. If not provided, the current month's statement will be sent. Only used when mode is 'execute'.
attachment_filesstringOptionalFiles to be attached with the statement email, in multipart/form-data format. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'email_contact_statement'.
#

ZohoBooksApi.EmailCreditNote

Send a credit note via email. Use this tool to email a credit note to the intended recipient. It's useful for sending invoice adjustments to clients. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalID of the organization for which the credit note is being emailed. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
credit_note_idstringOptionalUnique identifier of the credit note to be emailed. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
customer_id_for_credit_notestringOptionalCustomer ID for whom the credit note is raised. Used to identify the recipient of the email. Only used when mode is 'execute'.
email_attachmentsstringOptionalThe file paths or URLs of files to attach to the email. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'email_credit_note'.
#

ZohoBooksApi.EmailRetainerInvoiceToCustomer

Send a retainer invoice to a customer via email. This tool emails a retainer invoice to the specified customer. If no custom content is provided, the email will use the default content. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
retainer_invoice_idstringOptionalThe unique identifier of the retainer invoice to be emailed. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
email_attachmentsstringOptionalList of file paths or URLs for files to attach to the email. Only used when mode is 'execute'.
send_customer_statementbooleanOptionalSet to true to send the customer statement PDF with the email. Only used when mode is 'execute'.
attach_invoice_to_emailbooleanOptionalAttach the retainer invoice to the email if true. Accepts a boolean value. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'email_retainer_invoice'.
#

ZohoBooksApi.EmailSalesOrderToCustomer

Email a sales order to a customer. Send an email containing the sales order to the customer, with optional custom content. If no content is provided, the default email content will be used. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization for which the sales order is being emailed. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
sales_order_idstringOptionalProvide the unique identifier of the sales order to be emailed to the customer. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
sales_order_identifierstringOptionalUnique identifier of the sales order to be emailed. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
sales_order_attachmentsstringOptionalA list of file paths or URLs for attachments to include with the sales order email. Only used when mode is 'execute'.
file_namestringOptionalSpecify the name of the file to be attached to the email. Only used when mode is 'execute'.
include_sales_order_attachmentbooleanOptionalSpecify true to include the sales order attachment in the email, or false to exclude it. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'email_sales_order'.
#

ZohoBooksApi.EmailSalesReceiptToCustomer

Email a sales receipt to the customer. Use this tool to send a sales receipt via email to a specific customer. It should be called when you need to deliver the sales receipt directly to the customer. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
sales_receipt_identifierstringOptionalThe unique identifier of the sales receipt to be emailed to the customer. It must be a string. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
attach_pdfbooleanOptionalSet to true to send the sales receipt PDF with the email. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'email_sales_receipt'.
#

ZohoBooksApi.EnableContactPortalAccess

Enable portal access for a specified contact in Zoho Books. Use this tool to enable portal access for a contact in Zoho Books, allowing them to interact with their account through the portal. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization within Zoho Books, required to enable portal access for a contact. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
contact_unique_idstringOptionalUnique identifier for the specific contact whose portal access is to be enabled. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'enable_contact_portal'.
#

ZohoBooksApi.EnableOrganizationLocations

Enable locations for an organization in Zoho Books. Use this tool to enable location settings for an organization in Zoho Books, allowing tracking and management of different locations within the company's account.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization for which to enable location tracking.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'enable_locations'.
#

ZohoBooksApi.EnablePaymentReminder

Enable automated payment reminders for a contact. This tool is used to enable automated payment reminders for a specific contact, improving timely payment handling.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredProvide the unique ID of the organization for which to enable payment reminders.
contact_unique_identifierstringRequiredUnique identifier of the contact for whom the payment reminder is enabled.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'enable_contact_payment_reminder'.
#

ZohoBooksApi.ExcludeBankTransaction

Exclude a transaction from a bank or credit card account. Use this tool to exclude a specific transaction from your bank or credit card account records. Ideal for removing unwanted or incorrect entries.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization to which the transaction belongs.
transaction_idstringRequiredUnique identifier of the bank transaction to be excluded.
account_id_for_transaction_exclusionstringOptionalThe ID of the account from which a transaction will be excluded. This is a mandatory field.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'exclude_bank_transaction'.
#

ZohoBooksApi.ExportAndPrintEstimates

Export and print estimates as a PDF file. Use this tool to export up to 25 estimates as a PDF file and prepare them for printing.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization whose estimates are to be exported and printed.
estimate_ids_to_exportstringRequiredComma-separated list of estimate IDs to export and print. Maximum of 25 IDs allowed.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'bulk_print_estimates'.
#

ZohoBooksApi.ExportAndPrintInvoices

Export and print multiple invoices as PDFs. Use this tool to export and print up to 25 invoices at a time in PDF format.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. Required to specify which organization's invoices to print.
invoice_identifiersstringRequiredA comma-separated string of up to 25 invoice IDs to export and print as PDFs.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'bulk_print_invoices'.
#

ZohoBooksApi.ExportEstimatesAsPdf

Export up to 25 estimates as a single PDF document. Use this tool to export multiple estimates (up to 25) in one consolidated PDF document. Ideal for compiling estimates quickly into a single file for review or sharing.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books. Required to specify which organization's estimates are to be exported.
estimate_idsstringRequiredComma-separated list of estimate IDs to include in the PDF. Maximum of 25 IDs allowed.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'bulk_export_estimates_as_pdf'.
#

ZohoBooksApi.ExportInvoicesAsPdf

Export up to 25 invoices as a single PDF file. Use this tool to export multiple invoices into a single PDF document. Ideal for consolidating up to 25 invoices in one file.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization for which invoices are being exported.
invoice_idsstringRequiredComma-separated list of invoice IDs to export as a PDF. Maximum of 25 IDs allowed.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'bulk_export_invoices_as_pdf'.
#

ZohoBooksApi.ExportPrintSalesOrders

Export and print sales orders as PDFs. Exports up to 25 sales orders as PDF files for printing. This tool is used to generate printable documents of sales orders in batch format.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization whose sales orders you want to export and print as PDFs.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'bulk_print_sales_orders'.
#

ZohoBooksApi.ExportSalesOrdersPdf

Export sales orders as a single PDF document. Use this tool to export up to 25 sales orders into a single PDF file from Zoho Books. It is useful for generating and retrieving sales documentation in bulk for reporting or archiving.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization whose sales orders will be exported as a PDF. This ID is required to access and retrieve the sales order data from Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'bulk_export_sales_orders_as_pdf'.
#

ZohoBooksApi.FetchAssetHistory

Fetch the detailed history of a specific fixed asset. This tool retrieves a comprehensive history of a fixed asset, detailing its journey from acquisition to write-off. It should be called when you need insights into a fixed asset's lifecycle.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization whose asset history is being requested.
fixed_asset_identifierstringRequiredUnique identifier for the fixed asset. Required to fetch its detailed history.
page_numberintegerOptionalPage number to retrieve, with a default value of 1.
records_per_pageintegerOptionalNumber of records to fetch per page. Defaults to 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_fixed_asset_history'.
#

ZohoBooksApi.FetchBankAccountRules

Fetch rules for a specified bank account. This tool fetches all the rules created for a given bank or credit card account ID. It's used to retrieve details about transaction rules associated with a specific account.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. This ID is necessary to fetch the rules linked with the specified bank or credit card account.
bank_account_idintegerRequiredID of the bank or credit card account to fetch rules for.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_bank_account_rules'.
#

ZohoBooksApi.FetchBankTransactionDetails

Fetch details of a specific bank transaction by ID. Use this tool to retrieve detailed information about a bank transaction by providing its transaction ID. This is useful for accessing specific transaction records in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which the bank transaction details need to be fetched.
bank_transaction_idstringRequiredUnique identifier for the bank transaction to fetch its details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_bank_transaction'.
#

ZohoBooksApi.FetchEmployeeDetails

Retrieve detailed information about an employee. This tool is used to obtain comprehensive details of a specific employee by their ID in Zoho Books. It should be called when detailed employee information is needed.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization in Zoho Books. This ID is necessary to specify which organization's employee details are being requested.
employee_unique_idstringRequiredThe unique identifier for the employee whose details are to be fetched in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_employee'.
#

ZohoBooksApi.FetchVendorCreditRefunds

Retrieve a paginated list of vendor credit refunds. Use this tool to obtain detailed information about vendor credit refunds, useful for financial reconciliation and tracking vendor transactions. This tool supports pagination.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization for which to list vendor credit refunds.
search_vendor_credits_by_customer_idintegerOptionalSearch for vendor credits linked to a specific customer using their ID.
vendor_credit_last_modified_timestringOptionalSearch vendor credits using the last modified time as a filter. This expects a date-time string, typically in ISO 8601 format, to narrow down results by when they were last modified.
sort_vendor_credits_by_columnstringOptionalSpecify the column to sort vendor credits by. Allowed values: vendor_name, vendor_credit_number, balance, total, date, created_time, last_modified_time, reference_number.
pagination_page_numberintegerOptionalSpecify the page number of results to retrieve for pagination. Default is 1.
records_per_pageintegerOptionalNumber of vendor credits to return per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_vendor_credit_refunds1'.
#

ZohoBooksApi.FetchVendorPaymentDetails

Retrieve details of a vendor payment by payment ID. Call this tool to get detailed information about a specific vendor payment using the payment ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization to retrieve the vendor payment details.
payment_identifierstringRequiredUnique identifier for the payment to retrieve its details.
include_tax_informationbooleanOptionalSet to true to fetch tax information for the vendor payment.
fetch_statement_line_infobooleanOptionalSet to true to fetch statement line information for the vendor payment.
print_paymentbooleanOptionalSpecify true to print the Vendor Payment details.
is_bill_payment_idbooleanOptionalTrue if the ID is for a Bill Payment, false for a Vendor Payment.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_vendor_payment'.
#

ZohoBooksApi.FindMatchingBankTransactions

Find matching uncategorized bank transactions. This tool retrieves a list of uncategorized bank transactions that match specified criteria. It can also handle invoices, bills, and credit notes by recording and matching new payment or refund transactions.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization to search transactions for.
transaction_idstringRequiredUnique identifier for the bank transaction to search for matching entries.
bank_transaction_idstringRequiredUnique identifier of the bank transaction to be matched.
transaction_typestringOptionalSpecify the type of transaction. Allowed values: deposit, refund, transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return. Note: Some types are module-specific and cannot be created under this endpoint.
filter_date_afterstringOptionalSpecify the date after which transactions should be filtered. Use YYYY-MM-DD format.
filter_date_beforestringOptionalSpecify a date in YYYY-MM-DD format. Transactions before this date will be filtered.
minimum_transaction_amountnumberOptionalMinimum amount to filter transactions. Only transactions equal to or greater than this amount are included.
maximum_transaction_amountnumberOptionalMaximum amount for filtering transactions. Only transactions with an amount less than or equal to this value will be included.
transaction_contact_namestringOptionalName of the contact person involved in the transaction.
transaction_reference_numberstringOptionalReference number of the transaction to filter matching records.
page_number_to_fetchintegerOptionalPage number to fetch. Default is 1, used for pagination.
records_per_pageintegerOptionalNumber of records to be fetched per page. The default value is 200.
show_all_transactionsbooleanOptionalSet to true to display all transactions without applying filters; false to filter transactions.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_matching_bank_transactions'.
#

ZohoBooksApi.GetAccountDetails

Retrieve detailed information for a specified account. This tool is used to obtain detailed information about a specific account from the chart of accounts. It should be called when you need to access account specifics such as account name, type, and other related details.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization to which the account belongs.
account_unique_idstringRequiredUnique identifier for the account details request.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_chart_of_account'.
#

ZohoBooksApi.GetAssetDepreciationSummary

Displays detailed future depreciation rates for a fixed asset. Use this tool to obtain a summary of an asset's future depreciation rates. It is helpful for financial forecasting and decision-making regarding fixed assets.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization for which the asset's future depreciation rates are to be retrieved.
fixed_asset_identifierstringRequiredUnique identifier for the fixed asset to fetch its future depreciation rates.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_fixed_asset_forecast'.
#

ZohoBooksApi.GetBankAccountDetails

Retrieve detailed information of a specified bank account. Call this tool to get a comprehensive view of a bank account by specifying its account ID. Useful for accessing detailed account data within Zoho Books.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID for the organization. Required to specify which organization's data to access.
bank_account_idstringRequiredUnique identifier used to specify the bank account for detailed retrieval.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_bank_account'.
#

ZohoBooksApi.GetBankAccountRuleDetails

Retrieve details of a specific bank account rule. Call this tool to get information about a specific rule in a bank account using its rule ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which to retrieve the bank account rule details.
bank_account_rule_idstringRequiredUnique identifier of the bank account rule to retrieve its details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_bank_account_rule'.
#

ZohoBooksApi.GetBankTransactions

Retrieve all transaction details for a bank account. Use this tool to obtain detailed information about all transactions involved in a specific bank account. It is helpful for financial analysis and record-keeping.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredA unique ID representing the organization for which transactions are being queried. This is required to specify the context of the request.
bank_account_idintegerOptionalUnique identifier for the bank account to retrieve transactions for.
transaction_type_filterstringOptionalSpecify the type of transactions to retrieve. Expected as a string, e.g., 'expense', 'income'.
transaction_date_rangestringOptionalSpecify the start and end date for the transaction date range. Use 'date_start' for the start and 'date_end' for the end date.
transaction_amount_rangenumberOptionalSet a range of transaction amounts to filter transactions. Use two numbers: start amount, end amount.
transaction_status_list_viewstringOptionalFilter transactions by status: all, uncategorized, manually_added, matched, excluded, categorized.
transaction_reference_numberstringOptionalSearch for a transaction using its reference number for more precise results.
transaction_filter_typestringOptionalFilter transactions by type: Status.All, Status.Uncategorized, Status.Categorized, Status.ManuallyAdded, Status.Excluded, Status.Matched.
sort_transactions_bystringOptionalSpecify how to sort transactions. Allowed value: 'date'.
transaction_status_filterstringOptionalFilter transactions by status: All, uncategorized, manually_added, matched, excluded, categorized.
search_transactions_by_textstringOptionalSearch transactions using contact name or transaction description.
transaction_page_numberintegerOptionalPage number of transactions to fetch, with a default value of 1. Used for pagination.
records_per_pageintegerOptionalSpecify the number of transaction records to fetch per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_bank_transactions'.
#

ZohoBooksApi.GetBaseCurrencyAdjustmentDetails

Retrieve base currency adjustment details by ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization whose currency adjustment details are being retrieved.
base_currency_adjustment_identifierstringRequiredUnique identifier of the base currency adjustment to retrieve its details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_base_currency_adjustment'.
#

ZohoBooksApi.GetBillHistory

Retrieve the complete history and comments for a bill. This tool retrieves the entire history and comments associated with a specified bill. It is useful for reviewing past interactions and notes on a bill.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredString identifier for the organization whose bill history and comments you wish to retrieve.
bill_identifierstringRequiredUnique identifier of the bill to retrieve its history and comments.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_bill_comments'.
#

ZohoBooksApi.GetBillPaymentsList

Retrieve the list of payments made for a specific bill. This tool provides a list of all payments made for a specified bill using the bill ID. It should be called when you need to view detailed payment history for a particular bill.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization for which to retrieve bill payments.
bill_identifierstringRequiredUnique identifier for the specific bill to retrieve payment details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_bill_payments'.
#

ZohoBooksApi.GetContactActivityRecentComments

Retrieve recent comments for a specific contact. Use this tool to get a list of recent comments or activities associated with a specific contact in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization whose contact comments you want to retrieve.
contact_unique_identifierstringRequiredUnique identifier of the contact to retrieve recent comments.
page_number_to_fetchintegerOptionalPage number to be fetched. Defaults to 1 if not specified.
records_per_pageintegerOptionalNumber of records to be fetched per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_contact_comments'.
#

ZohoBooksApi.GetContactAddresses

Retrieve addresses for a specified contact. Get the shipping, billing, and additional addresses of a specific contact in Zoho Books. This tool is useful for retrieving address details when needing to display or utilize contact information in applications.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization in Zoho Books. This ID is necessary to fetch the contact's addresses within the specified organization.
contact_idstringRequiredUnique identifier of the contact in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_contact_address'.
#

ZohoBooksApi.GetContactPersonDetails

Retrieve details of a specific contact person. Use this tool to get detailed information about a specific contact person associated with a given contact in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books. This identifies which organization the contact person belongs to.
contact_identifierstringRequiredUnique identifier for the contact in Zoho Books.
contact_person_identifierstringRequiredUnique identifier of the contact person in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_contact_person'.
#

ZohoBooksApi.GetContactRefundHistory

Retrieve the refund history of a specific contact. Use this tool to get a list of all refunds associated with a particular contact in Zoho Books. This can be useful for financial reconciliations or customer service inquiries related to refund transactions.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books. Required to access the specific account data.
contact_unique_identifierstringRequiredUnique identifier of the contact in Zoho Books for refund history retrieval.
page_numberintegerOptionalThe page number to fetch for the contact's refund history. Default is 1.
records_per_pageintegerOptionalSpecifies how many refund records to fetch per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_contact_refunds'.
#

ZohoBooksApi.GetContactStatementMailContent

Retrieve the statement email content for a contact. Use this tool to get the content of a statement email for a specified contact in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredID of the organization to retrieve statement mail content for the contact.
contact_unique_identifierstringRequiredUnique identifier for the contact to retrieve the statement mail content.
statement_start_datestringOptionalStart date for the statement. Use format [yyyy-mm-dd]. Defaults to current month if not provided.
statement_end_datestringOptionalEnd date for the statement in the format [yyyy-mm-dd].

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_contact_statement_mail'.
#

ZohoBooksApi.GetCreditNoteComments

Retrieve comments and history of a credit note. Use this tool to obtain the history and comments associated with a specific credit note by providing the credit note's ID. This can be useful for tracking changes or feedback related to the credit transaction.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredProvide the organization's unique ID to retrieve credit note comments.
credit_note_idstringRequiredProvide the unique identifier of the credit note to retrieve its comments and history.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_credit_note_comments'.
#

ZohoBooksApi.GetCreditNoteDetails

Retrieve details of a specific credit note using its ID. Call this tool to obtain detailed information about an existing credit note by providing its unique identifier. Useful for tracking, reviewing, or managing credit notes within Zoho Books.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization in Zoho Books.
credit_note_idstringRequiredThe unique identifier of the credit note to retrieve details for. This ID is essential for accessing the specific credit note information.
response_formatstringOptionalSpecify the format of the credit note details: json, pdf, or html. Default is html.
export_with_default_print_optionbooleanOptionalSpecify whether to export the credit note PDF with the default print option. Use 'true' or 'false'.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_credit_note'.
#

ZohoBooksApi.GetCreditNoteEmailContent

Retrieve email content for a given credit note. Use this tool to get the email content associated with a specified credit note by its ID.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredID of the organization to retrieve the credit note email content for. This is a required field.
credit_note_idstringRequiredUnique identifier of the credit note to retrieve its email content.
specified_email_template_idstringOptionalID of a specific email template. If not provided, defaults to customer's or the default template.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_credit_note_email'.
#

ZohoBooksApi.GetCreditNotePdfTemplates

Retrieve all credit note PDF templates from Zoho Books. Use this tool to obtain a list of all available credit note PDF templates from Zoho Books. It's useful when you need to browse or select a specific credit note template for use.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books. Required to fetch credit note templates.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_credit_note_templates'.
#

ZohoBooksApi.GetCreditNoteRefund

Retrieve refund details for a specific credit note. Use this tool to obtain information about the refund of a specific credit note by providing the credit note ID and refund ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization for which the credit note refund is being retrieved. Use a valid organization identifier.
credit_note_idstringRequiredUnique identifier of the credit note to retrieve refund details for.
credit_note_refund_idstringRequiredUnique identifier of the credit note refund to retrieve specific refund details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_credit_note_refund'.
#

ZohoBooksApi.GetCurrencyDetails

Get the details of a specific currency. Use this tool to obtain detailed information about a particular currency by its ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which the currency details are requested.
currency_identifierstringRequiredUnique identifier for the currency to fetch details for.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_currency'.
#

ZohoBooksApi.GetCurrencyExchangeRate

Retrieve details of a specific currency exchange rate. This tool is used to get details of an exchange rate associated with a specified currency. It should be called when you need information about a specific exchange rate for financial or currency conversion purposes.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization for which you want to retrieve exchange rate details.
currency_unique_identifierstringRequiredUnique identifier for the currency. Use to specify the currency for the exchange rate details.
exchange_rate_unique_idstringRequiredUnique identifier of the exchange rate to retrieve details for.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_exchange_rate'.
#

ZohoBooksApi.GetCurrentRunningTimer

Retrieve the current running timer for a user. Use this tool to get information about the current running timer for personal time tracking in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization whose running timer is being retrieved.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_running_timer'.
#

ZohoBooksApi.GetCurrentUserDetails

Retrieve details of the current user from Zoho Books. Use this tool to get information about the currently authenticated user in Zoho Books. Ideal for scenarios where user-specific data is needed.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books to retrieve the current user details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_current_user'.
#

ZohoBooksApi.GetCustomerDebitNote

Retrieve the details of a customer debit note from Zoho Books. This tool is used to get detailed information about a specific customer debit note by its ID from Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredOrganization ID for the request. This ID is required to specify the organization from which to retrieve the debit note.
debit_note_unique_idstringRequiredUnique identifier for the specific debit note to retrieve details.
response_formatstringOptionalFormat of the debit note details. Options are json, pdf, or html. Default is json.
print_pdfbooleanOptionalIf true, print the exported PDF version of the debit note; otherwise, do not print.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_customer_debit_note'.
#

ZohoBooksApi.GetCustomerPaymentDetails

Retrieve details of a specific customer payment. Use this tool to obtain information about a specific customer payment by providing the payment ID. Ideal for retrieving payment history or verifying payment details.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which the payment details are requested.
payment_identifierstringRequiredThe unique identifier of the payment to retrieve details for.
response_formatstringOptionalFormat of the response. Allowed values: 'json' or 'pdf'. Default is 'json'.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_customer_payment'.
#

ZohoBooksApi.GetCustomerPaymentRefundDetails

Obtain details of a specific customer payment refund. Use this tool to get detailed information about a particular refund related to a customer's payment.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization. This is required to specify which organization's data to access.
customer_payment_unique_idstringRequiredUnique identifier of the customer payment to retrieve refund details.
refund_identifierstringRequiredUnique identifier of the refund for the specified customer payment.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_customer_payment_refund'.
#

ZohoBooksApi.GetCustomModuleRecordDetails

Fetch details of an organization in Zoho Books. Use this tool to retrieve details of a specific organization by providing the module name and module ID in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books.
module_namestringRequiredThe name of the module associated with the organization in Zoho Books.
custom_module_idintegerRequiredThe ID for the specific custom module in Zoho Books that you want to retrieve details for. This value should be an integer.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_custom_module_record_details'.
#

ZohoBooksApi.GetEstimateComments

Get the complete history and comments of an estimate. This tool retrieves all comments and historical data associated with a specific estimate. Use it to track changes or discussions about an estimate.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization whose estimate comments are needed.
estimate_identifierstringRequiredUnique identifier for the estimate to retrieve its history and comments.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_estimate_comments'.
#

ZohoBooksApi.GetEstimateEmailContent

Retrieve the email content for a specific estimate. Use this tool to get the email content associated with a specific estimate by providing the estimate ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which you want to retrieve the estimate email content.
email_template_idstringRequiredOptional. Specify a template ID to retrieve the email content based on a specific template. If not provided, defaults to the customer's associated or default template.
estimate_idstringRequiredUnique identifier for the estimate to retrieve its email content.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_estimate_email'.
#

ZohoBooksApi.GetEstimateTemplates

Retrieve all estimate PDF templates. This tool retrieves a list of all available PDF templates used for estimates. It should be called when users need to view or select templates for estimate documents.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization to fetch estimate templates.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_estimate_templates'.
#

ZohoBooksApi.GetExpenseComments

Retrieve comments and history for a specific expense. This tool should be called to get the discussion and history associated with an expense, specified by its ID, in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization in Zoho Books required to fetch the expense comments.
expense_unique_idstringRequiredUnique identifier for the expense to retrieve its comments and history in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_expense_comments'.
#

ZohoBooksApi.GetExpenseDetails

Retrieve details of a specific expense by ID. Use this tool to get detailed information about an expense by providing the expense ID. Ideal for financial reviews or tracking specific expenses.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredString representing the ID of the organization for which the expense details are requested.
expense_identifierstringRequiredUnique identifier for the expense to retrieve its details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_expense'.
#

ZohoBooksApi.GetFixedAssetDetails

Retrieve details of a fixed asset using its ID. This tool is used to obtain detailed information about a fixed asset by providing its unique ID. It should be called when you need specific details about an asset in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredProvide the ID of the organization for which you want to retrieve the asset details.
fixed_asset_identifierstringRequiredUnique identifier for the fixed asset to retrieve its details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_fixed_asset'.
#

ZohoBooksApi.GetFixedAssetsList

Retrieve a list of fixed assets from Zoho Books. Use this tool to obtain a detailed list of fixed assets stored in Zoho Books. Ideal for managing and reviewing asset inventories.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization for which to list fixed assets.
filter_fixed_asset_statusstringOptionalFilter the fixed asset list by status. Valid inputs: Status.All, Status.Active, Status.Cancel, Status.FullyDepreciated, Status.WriteOff, Status.Sold, Status.Draft.
sort_by_columnstringOptionalSpecify the column to sort the fixed asset list. Choose from: asset_name, asset_number, asset_cost, created_time, current_asset_value.
sort_orderstringOptionalSort the fixed asset list in ascending or descending order. Use 'A' for ascending and 'D' for descending.
page_numberintegerOptionalThe page number to fetch from the fixed asset list. Defaults to 1 if not specified.
records_per_pageintegerOptionalNumber of fixed asset records to fetch per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_fixed_assets'.
#

ZohoBooksApi.GetFixedAssetTypeList

Retrieve a list of fixed asset types. Call this tool to obtain a list of all available fixed asset types in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredUnique identifier for the organization to retrieve asset types for.
page_number_to_fetchintegerOptionalThe page number to retrieve for the list of fixed asset types. Defaults to 1 if not specified.
records_per_pageintegerOptionalNumber of records to fetch per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_fixed_asset_type_list'.
#

ZohoBooksApi.GetInvoiceAttachment

Fetch attachment file from a specified invoice. Call this tool to retrieve the file attached to a specific invoice using its ID. Useful for accessing documents associated with invoices.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization to retrieve the invoice attachment for.
invoice_identifierstringRequiredUnique identifier of the invoice to fetch the attachment from.
get_thumbnailbooleanOptionalSet to true to get the thumbnail of the invoice attachment.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_invoice_attachment'.
#

ZohoBooksApi.GetInvoiceComments

Get comments and history of an invoice. Use this tool to retrieve the full history and all comments associated with a specific invoice.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which the invoice comments and history are being retrieved. Must be a unique string identifier.
invoice_identifierstringRequiredUnique identifier for the specific invoice to retrieve comments and history.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_invoice_comments'.
#

ZohoBooksApi.GetInvoiceCreditsApplied

Retrieve the credits applied to a specific invoice. Use this tool to obtain a list of all credits that have been applied to a particular invoice. It should be called when detailed invoice credit information is needed.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. Required to retrieve credits applied to an invoice.
invoice_identifierstringRequiredUnique identifier of the invoice for which credits are applied.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_invoice_credits_applied'.
#

ZohoBooksApi.GetInvoiceDetails

Retrieve details of a specific invoice by ID. This tool is used to get detailed information about a specific invoice using its ID. It can be called when needing to verify invoice details, check status, or confirm amounts.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization for which the invoice details are requested.
invoice_identifierstringRequiredUnique identifier of the invoice. Used to specify which invoice details to retrieve.
format_typestringOptionalSpecify the format for invoice details: json, pdf, or html. Default is json.
print_pdfbooleanOptionalBoolean value indicating whether to print the exported PDF.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_invoice'.
#

ZohoBooksApi.GetInvoiceEmailContent

Retrieve the email content for a specific invoice. Use this tool to get the formatted email content of a particular invoice by specifying the invoice ID. Ideal for scenarios where you need to access or send invoice details via email.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique identifier for the organization. Required to retrieve invoice email content for the specified organization.
invoice_identifierstringRequiredUnique identifier of the invoice to retrieve its email content.
email_template_idstringOptionalOptional. Specify a template ID to get the email content based on a specific template. Defaults to customer-associated or default template if not provided.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_invoice_email'.
#

ZohoBooksApi.GetInvoiceList

Retrieve and organize a list of invoices from Zoho Books. This tool fetches a list of invoices using Zoho Books' API with options for pagination, filtering, searching, and sorting. Useful for finding specific invoices or browsing records systematically.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization for which invoices are being queried. This ID is crucial for accessing the correct set of invoices within Zoho Books.
search_by_invoice_numberstringOptionalSearch for invoices using their unique invoice number. Supports 'startswith' and 'contains' variants. Max length: 100 characters.
search_invoice_by_item_namestringOptionalFilters invoices by product or service name in line items. Supports 'item_name_startswith' and 'item_name_contains'. Max length: 100 characters.
search_by_item_idstringOptionalSearch invoices by item ID. Use the unique identifier of a product or service to filter invoices that include specific line items.
item_description_filterstringOptionalFilter invoices by item description using keywords. Supports 'startswith' and 'contains' variants. Max 100 characters.
search_reference_numberstringOptionalSearch invoices by reference number, such as purchase order or project codes, to find invoices associated with specific projects or transactions.
search_by_customer_namestringOptionalSearch for invoices using the customer's name, with a maximum length of 100 characters, to generate customer-specific reports or find all invoices for a customer.
recurring_invoice_idstringOptionalID of the recurring invoice from which the invoice is created. Use to filter invoices tied to specific recurring billing cycles.
customer_email_filterstringOptionalFilter invoices by the customer's email address. Maximum length is 100 characters. Ideal for finding specific customer invoices or customer segment analysis.
search_by_total_amountstringOptionalSearch and filter invoices based on the final total amount, including taxes, discounts, and adjustments. Useful for finding invoices within specific price ranges or identifying high-value transactions.
search_by_outstanding_balancestringOptionalFilter invoices by outstanding balance to find overdue invoices, track receivables, or generate aging reports.
search_by_custom_fieldstringOptionalSearch invoices using custom fields. Supports 'custom_field_startswith' and 'custom_field_contains' for partial matching.
invoice_date_filterstringOptionalFilter invoices by invoice date using yyyy-mm-dd format. Supports variants like date_start, date_end, date_before, and date_after to find invoices within specific date ranges.
invoice_due_date_filterstringOptionalFilter invoices by due date using yyyy-mm-dd format. Supports start, end, before, and after variants for flexible searching.
filter_by_creation_datestringOptionalFilter invoices by creation date with yyyy-mm-dd format. Supports variants: start, end, before, and after.
filter_by_last_modified_timestringOptionalFilters invoices modified after a specific timestamp in YYYY-MM-DDTHH:MM:SS-UTC format. Useful for identifying recently updated invoices.
invoice_statusstringOptionalFilter invoices by their current status (e.g., sent, draft, overdue, etc.).
search_by_customer_idstringOptionalFilters invoices using the unique customer ID. Use the ID from the Contacts API to find all invoices for a specific customer.
filter_invoices_by_criteriastringOptionalFilter invoices by status (e.g., Status.Sent, Status.Paid) or payment expected date using Date.PaymentExpectedDate.
general_search_textstringOptionalGeneral search for invoices by invoice number, purchase order, or customer name. Accepts up to 100 characters.
sort_by_columnstringOptionalSpecify the column to sort invoices by. Options: customer_name, invoice_number, date, due_date, total, balance, created_time.
search_by_crm_potential_idintegerOptionalFind invoices linked to a specific CRM deal or opportunity using its potential ID from Zoho CRM.
response_format_typeintegerOptionalSpecifies the desired response format: 0 for all invoices, 1 for all invoices with counts and totals, 2 for count only, 3 for count and totals, 4 for invoices and totals.
page_numberintegerOptionalPage number to fetch from paginated results. Default is 1. Use with 'per_page' for navigating large data sets.
records_per_pageintegerOptionalNumber of records to fetch per page. Default is 200, maximum is 200. Use to control result size for performance optimization.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_invoices'.
#

ZohoBooksApi.GetInvoicePayments

Retrieve a list of payments for a specific invoice. Use this tool to get detailed information about payments made for a specific invoice by providing the invoice ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization to retrieve invoice payments for.
invoice_identifierstringRequiredUnique identifier of the invoice to retrieve its payment details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_invoice_payments'.
#

ZohoBooksApi.GetJournalDetails

Retrieve the details of a specific journal entry in Zoho Books. This tool retrieves information about a specific journal entry from Zoho Books, using the journal ID. It should be called when details of a journal entry are needed.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization in Zoho Books required to retrieve journal details.
journal_unique_idstringRequiredThe unique identifier for the journal to retrieve its details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_journal'.
#

ZohoBooksApi.GetJournalList

Retrieve a list of accounting journals. Use this tool to get a list of accounting journals. It's useful for accessing journal entries in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization to retrieve journals for.
journal_entry_numberstringOptionalSearch journals by journal entry number using exact match or variants like 'entry_number_startswith' and 'entry_number_contains'.
search_by_reference_numberstringOptionalSearch journals by reference number. Use 'startswith:' or 'contains:' for filtering options.
journal_date_searchstringOptionalSpecify date criteria to search journals. Use date_start, date_end, date_before, or date_after.
search_journal_notesstringOptionalSearch journals by their associated notes. Options: 'startswith' or 'contains'.
search_by_last_modified_timestringOptionalSearch for journals using the last modified time as a filter criterion. Provide a valid timestamp to filter entries updated after that time.
journal_total_filternumberOptionalFilter journals based on total amount using keys like total_less_than or total_greater_equals.
search_by_customer_idintegerOptionalUse a specific Customer ID to search for journals in Zoho Books.
vendor_idintegerOptionalSpecify the Vendor ID to search journals associated with that vendor.
filter_journals_by_datestringOptionalSpecify the time period to filter journals by date. Options: JournalDate.All, JournalDate.Today, JournalDate.ThisWeek, JournalDate.ThisMonth, JournalDate.ThisQuarter, JournalDate.ThisYear.
sorting_column_for_journalsstringOptionalSpecify the field to sort journals by. Options: 'journal_date', 'entry_number', 'reference_number', 'total'.
page_number_to_fetchintegerOptionalPage number of the journal list to retrieve. Default value is 1.
records_per_pageintegerOptionalNumber of journal records to be fetched per page. Default value is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_journals'.
#

ZohoBooksApi.GetLastImportedBankStatement

Retrieve the last imported bank statement details for an account. Use this tool to get information about the most recently imported bank statement for a specified account. It provides insights into the account's latest financial activities.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization used to retrieve the bank statement.
bank_account_idstringRequiredUnique identifier of the bank account for retrieving the last imported statement.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_last_imported_bank_statement'.
#

ZohoBooksApi.GetOpeningBalance

Retrieves the opening balance for accounts.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization to retrieve the opening balance for.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_opening_balance'.
#

ZohoBooksApi.GetOrganizationDetails

Retrieve details of an organization from Zoho Books. Use this tool to get comprehensive details about a specific organization in Zoho Books by providing the organization ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredUnique identifier for the organization in Zoho Books. Used to retrieve specific organization details.
org_idstringRequiredUnique identifier for the specific organization.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_organization'.
#

ZohoBooksApi.GetOrganizationUsers

Retrieve the list of all users in the organization. Use this tool to get an updated list of all users within the organization. Ideal for tasks needing user information or management.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization to retrieve its users. Provide a valid organization ID as a string.
user_status_filterstringOptionalFilter users based on their status. Options: Status.All, Status.Active, Status.Inactive, Status.Invited, Status.Deleted.
sort_users_by_columnstringOptionalSpecify the attribute to sort users by. Allowed values are name, email, user_role, and status.
page_numberintegerOptionalPage number to be retrieved, with default being 1. Specify to navigate through pages.
records_per_pageintegerOptionalNumber of user records to retrieve per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_users'.
#

ZohoBooksApi.GetPaymentReminderEmailContent

Fetch the email content of a payment reminder for an invoice. Use this tool to obtain the email content for a payment reminder associated with a specific invoice. Ideal for scenarios where you need to preview or edit reminder emails before sending.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID for the organization within Zoho Books for which the payment reminder email content is being fetched.
invoice_identifierstringRequiredUnique identifier for the specific invoice to fetch the reminder email content.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_payment_reminder_mail_content_for_invoice'.
#

ZohoBooksApi.GetProjectComments

Retrieve comments for a specified project. Use this tool to get detailed comments for a specified project by providing the project ID.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization to fetch project comments for.
project_identifierstringRequiredUnique identifier of the project to fetch comments for.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_project_comments'.
#

ZohoBooksApi.GetProjectDetails

Retrieve detailed information of a specific project by ID. Call this tool to fetch details about a specific project using its ID. Useful for obtaining comprehensive project information.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredID of the organization to retrieve project details.
project_unique_identifierstringRequiredUnique identifier for the project to retrieve detailed information.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_project'.
#

ZohoBooksApi.GetProjectTasks

Retrieve a list of tasks for a specified project. Use this tool to obtain a list of tasks added to a specific project in Zoho Books. It should be called when you need detailed task information for project management or oversight.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. This is required to specify which organization's project tasks to retrieve.
project_unique_idstringRequiredUnique identifier for the project to fetch tasks.
fetch_page_numberintegerOptionalThe page number of results to retrieve. Default is 1.
records_per_pageintegerOptionalSpecify the number of task records to fetch per page. Defaults to 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_tasks'.
#

ZohoBooksApi.GetProjectUserDetails

Fetch details of a user within a project in Zoho Books. Use this tool to obtain information about a specific user's involvement in a particular project in Zoho Books. It is ideal for checking user roles or assignments within a project.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique identifier for the organization in Zoho Books. This is required to fetch the user details associated with the specified project.
project_identifierstringRequiredThe unique identifier for the project in Zoho Books to fetch user details from.
user_identifierstringRequiredUnique identifier of the user within the project. Required to fetch user-specific details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_project_user'.
#

ZohoBooksApi.GetPurchaseOrderComments

Retrieve comments and history of a purchase order. Fetches the complete history and comments of a specified purchase order, useful for tracking and reviewing order details.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization to retrieve purchase order comments for. Required to specify which organization's data to access.
purchase_order_idstringRequiredUnique identifier for the specific purchase order to retrieve comments and history.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_purchase_order_comments'.
#

ZohoBooksApi.GetPurchaseOrderEmailContent

Retrieves the email content of a purchase order. Use this tool to get the email content related to a specific purchase order by providing its ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization to retrieve the purchase order email content for.
purchase_order_idstringRequiredUnique identifier of the purchase order to retrieve its email content.
email_template_idstringOptionalGet the email content based on a specific email template. Defaults to customer-associated or default template if not provided.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_purchase_order_email'.
#

ZohoBooksApi.GetPurchaseOrderTemplates

Retrieve all purchase order PDF templates from Zoho Books. This tool is used to obtain a list of all available purchase order PDF templates in Zoho Books. It should be called when there's a need to view or select from existing purchase order templates.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization for retrieving purchase order templates.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_purchase_order_templates'.
#

ZohoBooksApi.GetRecurringBillDetails

Retrieve details of a recurring bill from Zoho Books. This tool retrieves comprehensive details of a specified recurring bill using its ID. It should be called when detailed information about a recurring bill is required from Zoho Books.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization in Zoho Books.
recurring_bill_unique_idstringRequiredUnique identifier for the recurring bill in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_recurring_bill'.
#

ZohoBooksApi.GetRecurringBillHistory

Get history and comments of a recurring bill. Use this tool to fetch detailed history and comments related to a specific recurring bill by providing the recurring bill ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which you want to get the recurring bill history.
recurring_bill_identifierstringRequiredUnique identifier for the specific recurring bill. Required to fetch its history and comments.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_recurring_bill_history'.
#

ZohoBooksApi.GetRecurringExpenseDetails

Get details of a specific recurring expense in Zoho Books. Use this tool to retrieve information about a particular recurring expense by providing its ID. Helpful for managing or reviewing ongoing expense details.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredProvide the ID of the organization to retrieve its specific recurring expense details from Zoho Books.
recurring_expense_idstringRequiredUnique identifier for the recurring expense to retrieve its details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_recurring_expense'.
#

ZohoBooksApi.GetRecurringExpenseHistory

Get history and comments of a recurring expense. Use this tool to retrieve the history and comments associated with a specific recurring expense in Zoho Books. Call this tool when you need detailed information about past actions and notes on a recurring expense item.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which the recurring expense history is requested.
recurring_expense_idstringRequiredUnique identifier for the specific recurring expense to retrieve history and comments.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_recurring_expense_history'.
#

ZohoBooksApi.GetRecurringInvoiceDetails

Retrieve details of a specific recurring invoice. Use this tool to access detailed information about a recurring invoice using its ID. It's useful for financial tracking and management purposes.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. Required to access organization-specific data.
recurring_invoice_identifierstringRequiredUnique identifier for the recurring invoice to retrieve its details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_recurring_invoice'.
#

ZohoBooksApi.GetRecurringInvoiceHistory

Get the complete history and comments of a recurring invoice. Use this tool to retrieve detailed history and comment logs for a specific recurring invoice. Ideal for reviewing past transactions and communication related to an invoice.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization. Required to access invoice history.
recurring_invoice_idstringRequiredUnique identifier for the specific recurring invoice to retrieve its history and comments.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_recurring_invoice_history'.
#

ZohoBooksApi.GetRetainerInvoiceAttachment

Retrieve the file attached to a retainer invoice. Use this tool to get the file that has been attached to a specific retainer invoice. It is helpful when you need to view or download the attached document related to the invoice.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization whose invoice attachment you want to retrieve.
retainer_invoice_idstringRequiredUnique identifier of the retainer invoice for which the attachment is to be retrieved.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_retainer_invoice_attachment'.
#

ZohoBooksApi.GetRetainerInvoiceDetails

Retrieve details of a specific retainer invoice. Use this tool to obtain details about a retainer invoice by specifying the invoice ID. Ideal for checking invoice status, amount, and related information.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization to retrieve the retainer invoice for.
retainer_invoice_idstringRequiredUnique identifier of the retainer invoice to retrieve details for.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_retainer_invoice'.
#

ZohoBooksApi.GetRetainerInvoiceHistory

Get the history and comments of a retainer invoice. Fetches complete history and comments for a specific retainer invoice by ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization to fetch its retainer invoice history.
retainer_invoice_idstringRequiredUnique identifier of the retainer invoice to look up its history and comments.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_retainer_invoice'.
#

ZohoBooksApi.GetRetainerInvoiceTemplates

Retrieve all retainer invoice PDF templates. Call this tool to get a list of all available retainer invoice PDF templates from Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization to retrieve retainer invoice templates from.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_retainer_invoice_templates'.
#

ZohoBooksApi.GetSalesOrderAttachment

Retrieve the file attached to a specific sales order. Use this tool to get the file attached to a sales order in Zoho Books by providing the sales order ID. It returns the file associated with the specified order.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books.
sales_order_idstringRequiredUnique identifier of the sales order to retrieve the attachment for.
require_preview_of_sales_orderbooleanOptionalSpecify whether a preview of the Sales Order is required. Use True for preview, False for no preview.
require_inline_responsebooleanOptionalSet to true if an inline response is needed, displaying directly in the browser.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_sales_order_attachment'.
#

ZohoBooksApi.GetSalesOrderComments

Retrieve the history and comments of a sales order. Use this tool to obtain all comments and the complete history associated with a specific sales order when needing detailed insights or updates.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization for which to retrieve sales order comments.
sales_order_idstringRequiredUnique identifier of the sales order to retrieve comments and history for.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_sales_order_comments'.
#

ZohoBooksApi.GetSalesOrderDetails

Retrieve details of a specific sales order. This tool is used to get the details of a sales order from Zoho Books. It should be called when there's a need to look up information about a particular sales order, such as for verification or record-keeping purposes.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. This ID is used to specify the organization within Zoho Books whose sales order details need to be retrieved.
sales_order_idstringRequiredUnique identifier of the sales order required to retrieve its details.
output_formatstringOptionalSpecifies the format in which to receive the sales order details. Options include: json, csv, xml, xls, xlsx, pdf, jhtml, and html. Default is json.
print_pdfbooleanOptionalSet to true to print the exported PDF of the sales order, otherwise false.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_sales_order'.
#

ZohoBooksApi.GetSalesOrderEmailContent

Retrieve email content for a specific sales order. This tool is used to get the email content associated with a particular sales order, identified by its sales order ID. Use it when you need to view or analyze the email details of a sales order in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization in Zoho Books for which the sales order email content is required.
sales_order_idstringRequiredUnique identifier of the sales order to retrieve its email content.
email_template_idstringOptionalOptional. ID of the email template for retrieving specific email content. If not provided, defaults will be used.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_sales_order_email'.
#

ZohoBooksApi.GetSalesOrderTemplates

Retrieve all sales order PDF templates from Zoho Books. Use this tool to get a list of all available sales order PDF templates in Zoho Books. This is helpful when you need to view or manage your sales order templates.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredA string representing the ID of the organization. Required to specify which organization's sales order templates to retrieve.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_sales_order_templates'.
#

ZohoBooksApi.GetSalesReceiptDetails

Retrieve the details of a sales receipt. This tool fetches the specific details of a sales receipt using the provided sales receipt ID. It should be called when detailed information about a particular sales receipt is needed.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredID of the organization for which the sales receipt is being retrieved.
sales_receipt_idstringRequiredThe unique identifier for the sales receipt to be retrieved. Required for fetching the specific sales receipt details.
output_formatstringOptionalSpecifies the format in which to retrieve the sales receipt details. Options are 'json', 'pdf', or 'html'. Default is 'json'.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_sales_receipt'.
#

ZohoBooksApi.GetTaskDetails

Retrieve detailed information about a specific task in a project. This tool should be called to obtain comprehensive details about a particular task within a project. It helps in understanding task specifics by providing relevant task data from Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books.
project_idstringRequiredUnique identifier of the project.
task_unique_identifierstringRequiredThe unique identifier for the task to retrieve details for from Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_task'.
#

ZohoBooksApi.GetTaxAuthorities

Retrieve the list of tax authorities. Use this tool to obtain a list of all tax authorities, which can be helpful for managing tax-related settings or compliance.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which to retrieve tax authorities.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_tax_authorities'.
#

ZohoBooksApi.GetTaxAuthorityDetails

Retrieve details of a specific tax authority. Use this tool to obtain information about a tax authority by providing its unique ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredProvide the ID of the organization to retrieve tax authority details.
tax_authority_unique_idstringRequiredUnique identifier of the tax authority to retrieve details for.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_tax_authority'.
#

ZohoBooksApi.GetTaxDetails

Retrieve the details of a specific tax. Use this tool to obtain information about a specific simple or compound tax by providing the tax ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization to retrieve tax details from.
tax_identifierstringRequiredUnique identifier for retrieving specific tax details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_tax'.
#

ZohoBooksApi.GetTaxExemptionDetails

Retrieve the details of a tax exemption using its ID. This tool retrieves details about a specific tax exemption identified by its ID. It is useful for understanding exemption specifics within financial settings.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. Required to access the organization's tax exemption details.
tax_exemption_identifierstringRequiredThe unique identifier for the tax exemption to retrieve details for.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_tax_exemption'.
#

ZohoBooksApi.GetTaxExemptionsList

Retrieve a list of tax exemptions from Zoho Books. Call this tool to get information about the current tax exemptions available in Zoho Books. It provides details on all tax exemptions configured in the system.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization whose tax exemptions are being requested.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_tax_exemptions'.
#

ZohoBooksApi.GetTimeEntryDetails

Retrieve details of a specific time entry. Use this tool to get detailed information about a specific time entry by providing the time entry ID. It's useful for tracking and managing project time entries.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which the time entry details are requested.
time_entry_identifierstringRequiredUnique identifier of the time entry to retrieve details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_time_entry'.
#

ZohoBooksApi.GetUserDetails

Retrieve detailed information about a specific user in Zoho Books. This tool fetches the details of a user from Zoho Books using their user ID. It should be called when user information such as name, email, or role is required.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books. This is required to specify the organization context for API calls.
user_unique_identifierstringRequiredA unique string that identifies the user in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_user'.
#

ZohoBooksApi.GetVendorCreditComments

Retrieve history and comments for a vendor credit. Use this tool to get the history and comments associated with a specific vendor credit by providing the vendor credit ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization. This ID is required to access the vendor credit comments.
vendor_credit_identifierstringRequiredThe unique identifier for the specific vendor credit to retrieve its history and comments.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_vendor_credit_comments'.
#

ZohoBooksApi.GetVendorCreditDetails

Retrieve details of a specific vendor credit. Use this tool to obtain detailed information about a vendor credit by providing the specific vendor credit ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization whose vendor credit details are being requested.
vendor_credit_idstringRequiredUnique identifier for the vendor credit to retrieve details.
output_formatstringOptionalSpecify the format for vendor credit details. Options: json, xml, csv, xls, pdf, html, jhtml. Default is html.
export_vendor_credit_pdfbooleanOptionalSet to true to export the vendor credit as a PDF with default print options. Accepts 'true', 'false', 'on', 'off'.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_vendor_credit'.
#

ZohoBooksApi.GetVendorCreditRefund

Retrieve a refund for a specific vendor credit. Fetches details of a refund associated with a specific vendor credit using the vendor credit ID and refund ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization to which the vendor credit belongs.
vendor_credit_identifierstringRequiredUnique identifier for the vendor credit to retrieve the refund details.
vendor_credit_refund_idstringRequiredUnique identifier of the vendor credit refund for the specific transaction. Required to retrieve refund details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_vendor_credit_refund'.
#

ZohoBooksApi.GetVendorPaymentEmailContent

Retrieve email content for a vendor payment receipt. This tool retrieves the pre-filled email details for a vendor payment, including the message subject, body, recipients, sender, and attachments. Use it to easily compose and send a payment receipt email to vendors.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. Required to retrieve the vendor payment email content.
vendor_payment_idstringRequiredUnique identifier for the vendor payment to retrieve email content.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_vendor_payment_email_content'.
#

ZohoBooksApi.GetVendorPaymentRefundDetails

Retrieve details of a specific vendor payment refund. Use this tool to obtain information about a particular refund of a vendor payment, identified by the payment ID and refund ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization whose vendor payment refund details are requested.
payment_identifierstringRequiredUnique identifier for the payment associated with the vendor refund.
vendor_payment_refund_idstringRequiredUnique identifier for the vendor payment refund to retrieve its details.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_vendor_payment_refund'.
#

ZohoBooksApi.ImportBankStatements

Import bank or credit card feeds into your account. Use this tool to import bank or credit card statements directly into your account for seamless financial management. This should be called when you need to process new bank or credit card data into the system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization to import bank statements for. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'import_bank_statements'.
#

ZohoBooksApi.ImportCrmProductToZohoBooks

Import a product from Zoho CRM to Zoho Books. Use this tool to import an item from Zoho CRM into Zoho Books by specifying its CRM product ID. This enables synchronization of product data between the two services.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization in Zoho Books. This is required to import products from Zoho CRM.
crm_product_idstringRequiredUnique identifier of the Zoho CRM product to be imported into Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint ''.
#

ZohoBooksApi.ImportCustomerFromCrm

Import a customer from Zoho CRM to Zoho Books using CRM account ID. Use this tool to import a customer from Zoho CRM into Zoho Books by providing the CRM account ID. This requires integration between Zoho Books and Zoho CRM either through Accounts and Contacts sync or Accounts only sync.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredUnique identifier for the organization within Zoho Books.
crm_account_idstringRequiredUnique identifier of the Zoho CRM account to import the customer from.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'import_customer_using_crm_account_id'.
#

ZohoBooksApi.ImportVendorFromCrm

Import a vendor from Zoho CRM to Zoho Books using CRM vendor ID. Use this tool to import a vendor from Zoho CRM to Zoho Books via Vendor-only sync, requiring the CRM vendor ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization in Zoho Books for which the vendor is being imported. This ID is used to specify the target organization in Zoho Books.
zoho_crm_vendor_idstringRequiredUnique identifier of the Zoho CRM vendor to import.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'import_vendor_using_crm_vendor_id'.
#

ZohoBooksApi.InviteUserToProject

Invite a user to a project in Zoho Books. Use this tool to send an invitation to a user to join a specific project in Zoho Books. This is helpful when you need to collaborate with others by adding them to project teams. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier of the organization in Zoho Books where the project is located. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
project_unique_identifierstringOptionalUnique identifier of the project in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'invite_project_user'.
#

ZohoBooksApi.ListAccountTransactions

Retrieve transactions for a specified account. Use this tool to list all transactions associated with a given account. Ideal for tracking financial activities related to specific accounts.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredUnique identifier for the organization whose account transactions are being queried.
account_idstringRequiredThe unique ID of the account to retrieve transactions for.
transaction_date_rangestringOptionalSpecify a date range for searching transactions. Use 'yyyy-mm-dd' format. Supports 'date.start', 'date.end', 'date.before', and 'date.after'.
amount_rangenumberOptionalSpecify the amount range to filter account transactions. Use fields like less_than, less_equals, greater_than, and greater_equals to define the criteria.
filter_by_account_typestringOptionalFilter accounts based on account type and status. Options: AccountType.All, AccountType.Active, AccountType.Inactive, AccountType.Asset, AccountType.Liability, AccountType.Equity, AccountType.Income, AccountType.Expense.
transaction_typestringOptionalFilter transactions by type, such as 'invoice', 'expense', or 'refund'.
sort_bystringOptionalSpecify the column to sort transactions. Possible values: 'account_name', 'account_type'.
page_numberintegerOptionalPage number to be fetched for the transaction list. Defaults to 1 if not specified.
records_per_pageintegerOptionalNumber of records to be fetched per page. Default is 200. Specify a custom integer to override.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_chart_of_account_transactions'.
#

ZohoBooksApi.ListActiveInventoryItems

Retrieve a paginated list of all active inventory items. Use this tool to fetch a list of all active items from the inventory. It provides the data with pagination to manage large sets of items efficiently.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization to fetch items from.
item_name_searchstringOptionalSearch for items by name using prefixes 'name_startswith' or 'name_contains'. Maximum length is 100 characters.
description_filterstringOptionalSearch items by description. Use keywords or phrases up to 100 characters. Prefix with 'description_startswith' or 'description_contains' for specific filtering.
search_by_rate_criteriastringOptionalSpecify rate conditions to filter items. Use format like 'rate_less_than:100'.
search_by_tax_idstringOptionalSearch for items using the tax ID as a filter.
tax_name_filterstringOptionalFilter items by their tax name.
tax_exemption_identifierstringOptionalID for the tax exemption. Required if is_taxable is false.
associated_account_idstringOptionalID of the account to associate the item with.
filter_items_by_statusstringOptionalFilter items by status. Allowed values are 'Status.All', 'Status.Active', and 'Status.Inactive'.
search_items_by_textstringOptionalSearch for items by name or description, up to 100 characters.
sort_items_bystringOptionalSpecify the attribute to sort items by. Allowed values: 'name', 'rate', 'tax_name'.
sat_item_key_codestringOptionalSAT Item key code used to filter items. Provide a valid string key code for lookup.
sat_unit_codestringOptionalSAT Unit code for specific inventory items. Used to search or filter items based on their unit code.
page_number_to_fetchintegerOptionalThe page number of active items to retrieve, with a default of 1 if unspecified.
records_per_pageintegerOptionalSpecify the number of records to fetch per page. Default is 200.
is_item_taxablebooleanOptionalBoolean indicating if the item is taxable. True means the item is taxable.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_items'.
#

ZohoBooksApi.ListAllBills

Retrieve all bills with pagination support. This tool is used to list all bills available in the system, providing pagination information to navigate through large datasets. It should be called whenever there's a need to view or analyze billing details over multiple pages.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. Required to specify which organization's bills to list.
filter_by_bill_numberstringOptionalFilter bills using the bill number. Use exact matches, prefix with 'bill_number_startswith', or substring with 'bill_number_contains'.
filter_by_reference_numberstringOptionalFilter bills by reference number. Supports exact matches, prefix matching using `reference_number_startswith`, and substring matching using `reference_number_contains`. Useful for finding bills by external references or vendor invoice numbers.
bill_date_filterstringOptionalFilter bills by bill date in YYYY-MM-DD format. Use for specific dates, date ranges (date_start/date_end), or relative dates (date_before/date_after).
filter_by_statusstringOptionalSpecify the status of bills to filter by. Options include 'paid', 'open', 'overdue', 'void', or 'partially_paid'.
filter_by_description_textstringOptionalFilter bills using description text. Supports exact matches, prefix matching with 'description_startswith', or substring matching with 'description_contains'. Useful for finding bills by line item descriptions or vendor notes.
filter_by_vendor_namestringOptionalFilter bills by vendor name. Use prefix matching with 'vendor_name_startswith' or substring matching with 'vendor_name_contains'.
filter_by_total_amountnumberOptionalFilter bills by total amount using conditions like less than, greater than, etc. Specify conditions using keys like 'total_less_than' or 'total_greater_than'.
filter_by_vendor_idintegerOptionalUnique identifier to filter bills by a specific vendor, retrieving all related bills.
filter_by_item_idintegerOptionalFilter bills by a specific item ID. Retrieves all bills containing a particular product or service item based on its unique identifier.
recurring_bill_identifierintegerOptionalFilter bills by a specific recurring bill ID to retrieve all bills generated from a recurring template or schedule.
filter_by_purchase_order_idintegerOptionalSpecify the Purchase Order ID to filter bills associated with a specific order. Helps track procurement workflows.
filter_by_last_modified_timestringOptionalFilter bills by last modification timestamp using ISO 8601 format (YYYY-MM-DDTHH:MM:SS+/-HHMM) to find bills modified at or after a specific time.
bill_status_filterstringOptionalFilter bills by status. Options: Status.All, Status.PartiallyPaid, Status.Paid, Status.Overdue, Status.Void, Status.Open.
search_textstringOptionalFilter bills using general text across bill number, reference number, and vendor name to find matches. Useful for quick searches.
page_numberintegerOptionalSpecify the page number for pagination to navigate multiple pages of bills.
bills_per_pageintegerOptionalSpecify the number of bills to retrieve per page. Default is 200, but adjustable for performance needs and rate limits.
sort_by_columnstringOptionalSpecify the column to sort bills by. Available options: vendor_name, bill_number, date, due_date, total, balance, created_time.
sorting_orderstringOptionalSpecify the sort order for bills: 'A' for ascending, 'D' for descending.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_bills'.
#

ZohoBooksApi.ListBankAccounts

List all bank and credit card accounts for your organization. Use this tool to retrieve all bank and credit card accounts associated with your organization in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. This is required to list all associated bank and credit card accounts in Zoho Books.
account_status_filterstringOptionalSpecify the status to filter accounts: 'Status.All', 'Status.Active', or 'Status.Inactive'.
sort_bystringOptionalSpecify the sorting criterion for the accounts. Options: 'account_name', 'account_type', 'account_code'.
page_numberintegerOptionalThe page number of results to retrieve. Defaults to 1 if not specified.
records_per_pageintegerOptionalNumber of records to be fetched per page. Default value is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_bank_accounts'.
#

ZohoBooksApi.ListBaseCurrencyAdjustments

Fetch base currency adjustments list from Zoho Books. This tool retrieves a list of base currency adjustments from Zoho Books. Call this tool when you need to obtain current base currency adjustments for accounting or financial reporting purposes.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization to retrieve currency adjustments from.
filter_by_datestringOptionalFilter the base currency adjustment list by specific date ranges. Allowed values are: Date.All, Date.Today, Date.ThisWeek, Date.ThisMonth, Date.ThisQuarter, Date.ThisYear.
sort_currency_adjustment_list_bystringOptionalSpecify the sorting criterion for the currency adjustment list. Options include: adjustment_date, exchange_rate, currency_code, debit_or_credit, or gain_or_loss.
search_by_last_modified_timestringOptionalUse a timestamp to filter adjustments by their last modified time.
fetch_page_numberintegerOptionalThe page number to fetch. Defaults to 1 if not specified.
records_per_pageintegerOptionalNumber of records to fetch per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_base_currency_adjustments'.
#

ZohoBooksApi.ListBillsWithVendorCredit

List bills with applied vendor credit from a vendor credit ID. Fetch a list of bills where a specific vendor credit has been applied. Use this tool to understand how vendor credits are distributed across bills.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization to fetch applicable bills for vendor credit.
vendor_credit_idstringRequiredUnique identifier for the vendor credit to list the applied bills.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_bills_credited'.
#

ZohoBooksApi.ListChartOfAccounts

Retrieve a list of all chart of accounts. Use this tool to obtain a complete list of chart of accounts with pagination support. Ideal for financial data management.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization to retrieve chart of accounts for.
account_type_filterstringOptionalFilter accounts based on type and status. Options: AccountType.All, AccountType.Active, AccountType.Inactive, AccountType.Asset, AccountType.Liability, AccountType.Equity, AccountType.Income, AccountType.Expense.
sort_accounts_bystringOptionalSpecify how to sort the accounts. Options: 'account_name', 'account_type'.
last_modified_time_filterstringOptionalFetch accounts modified since a specific timestamp, formatted as YYYY-MM-DDTHH:MM:SSZ.
page_numberintegerOptionalSpecify the page number to retrieve. Default is 1.
records_per_pageintegerOptionalNumber of records to retrieve per page. Defaults to 200 if not specified.
include_balancebooleanOptionalInclude current account balances in the response when set to true.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_chart_of_accounts'.
#

ZohoBooksApi.ListChildExpenses

Retrieve child expenses from a recurring expense. Use this tool to list expenses that have been generated from a specific recurring expense. Useful for tracking individual instances of a recurring cost.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization to list child expenses for.
recurring_expense_identifierstringRequiredUnique identifier for the recurring expense to retrieve child expenses.
sort_expenses_bystringOptionalSpecify the field to sort expenses. Valid options: next_expense_date, account_name, total, last_created_date, recurrence_name, customer_name, created_time.
fetch_page_numberintegerOptionalSpecify the page number to retrieve. Default is 1.
records_per_pageintegerOptionalSpecify the number of expense records to retrieve per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_child_expenses_of_recurring_expense'.
#

ZohoBooksApi.ListCompanyEmployees

Retrieve a paginated list of all employees. Use this tool to obtain a list of employees from the company database, including pagination for handling large sets of data. Ideal for getting employee details in an organized manner.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization whose employees are being listed. This should be provided as a string.
page_numberintegerOptionalThe page number to fetch. Default is 1 for the first page.
records_per_pageintegerOptionalSpecify the number of employee records to retrieve per page, with a default of 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_employees'.
#

ZohoBooksApi.ListConfiguredCurrencies

Retrieve the list of configured currencies in Zoho Books. This tool retrieves the list of all currencies configured within Zoho Books. Use it when you need to know which currencies are set up in the system.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books. Required to retrieve currency data for a specific organization.
exclude_base_currency_filterstringOptionalSet to exclude the base currency from the result. Use 'Currencies.ExcludeBaseCurrency'.
page_numberintegerOptionalThe page number of currency records to fetch. Default is 1.
records_per_pageintegerOptionalNumber of currency records to fetch per page. Defaults to 200 if not specified.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_currencies'.
#

ZohoBooksApi.ListContactPersons

Retrieve contact persons for a given contact ID. Use this tool to list all contact persons associated with a specific contact ID, utilizing pagination.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization for which the contact persons are being retrieved.
contact_identifierstringRequiredUnique identifier for the contact to retrieve associated persons.
page_numberintegerOptionalThe page number to fetch when listing contact persons. Default is 1.
records_per_pageintegerOptionalSpecifies the number of contact records to retrieve per page. The default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_contact_persons'.
#

ZohoBooksApi.ListCreditNoteInvoices

List invoices to which the credit note is applied. Use this tool to retrieve a list of invoices that are associated with a specific credit note.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which you want to list the invoices associated with the credit note.
credit_note_idstringRequiredUnique identifier of the credit note to retrieve associated invoices.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_invoices_of_credit_note'.
#

ZohoBooksApi.ListCreditNoteRefunds

Retrieve refunds for a specific credit note. Use this tool to list all refunds associated with a particular credit note by specifying its ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization to retrieve credit note refunds for.
credit_note_idstringRequiredUnique identifier of the credit note to retrieve refunds for.
page_numberintegerOptionalSpecify the page number to retrieve in paginated results. Default is 1.
results_per_pageintegerOptionalNumber of records to return per page, controlling pagination. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_credit_note_refunds1'.
#

ZohoBooksApi.ListCreditNotes

Retrieve and filter a list of credit notes. Retrieve a paginated list of credit notes using filters and sorting based on date, status, amount, customer details, items, taxes, and custom fields.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which you want to list credit notes. Required for identification and retrieval.
credit_note_numberstringOptionalFilter credit notes by a specific credit note number. The number must be a unique identifier, up to 100 characters.
filter_datestringOptionalFilter credit notes by the date they were raised. Use yyyy-mm-dd format to search for specific credit notes.
filter_by_statusstringOptionalSpecify the status to filter credit notes. Options include: 'open', 'closed', 'void', or 'draft'.
filter_by_total_amountnumberOptionalFilter credit notes by their total amount. Input a specific total value to retrieve matching credit notes.
filter_by_reference_numberstringOptionalFilter credit notes by their reference number, limited to 100 characters.
filter_by_customer_namestringOptionalFilter credit notes by customer name. Use to search for credit notes associated with a specific customer. Max-Length is 100 characters.
filter_by_item_namestringOptionalSearch for credit notes by item name. Maximum length is 100 characters.
filter_by_customer_idstringOptionalSearch for credit notes associated with a specific customer using the customer ID. Retrieve customer IDs from the contacts API.
filter_by_item_descriptionstringOptionalFilter credit notes by item description. Use 'startswith:' or 'contains:' for flexible matching. Max length of 100 characters.
filter_by_item_idstringOptionalFilter credit notes by item ID to find notes containing a specific item. Obtain item IDs from the items API.
filter_by_line_item_idstringOptionalSearch for credit notes containing a specific line item using its ID.
filter_by_tax_idstringOptionalFilter credit notes using a specific tax ID. Retrieve the tax ID from the taxes API.
status_filterstringOptionalFilter credit notes by status using predefined values: 'Status.All', 'Status.Open', 'Status.Draft', 'Status.Closed', 'Status.Void'.
search_textstringOptionalSearch credit notes across multiple fields like credit note number, customer name, and reference number. Max-length is 100 characters.
sort_credit_notes_by_columnstringOptionalSpecify the column by which to sort the credit notes. Allowed values: 'customer_name', 'creditnote_number', 'balance', 'total', 'date', and 'created_time'.
page_numberintegerOptionalPage number for pagination. Specify which page of results to retrieve. Default is 1.
records_per_pageintegerOptionalSpecify the number of credit notes to be returned per page for pagination. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_credit_notes'.
#

ZohoBooksApi.ListCurrencyAdjustmentAccounts

Retrieve accounts involved in currency adjustments. This tool retrieves a list of accounts that have transactions affected by a specified exchange rate. Use this to find financial accounts needing currency adjustment.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which the currency adjustment accounts are needed.
currency_id_for_adjustmentstringRequiredID of the currency to post an adjustment for. This specifies which currency is being adjusted.
adjustment_datestringRequiredSpecify the date for the currency adjustment in YYYY-MM-DD format.
exchange_ratenumberRequiredSpecify the exchange rate for the currency to affect transactions.
adjustment_notesstringRequiredNotes for the base currency adjustment, providing additional information or context.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_base_currency_adjustment_accounts'.
#

ZohoBooksApi.ListCurrencyExchangeRates

Retrieve exchange rates for a specific currency. This tool fetches a list of configured exchange rates for a given currency using its ID. Call this tool to obtain exchange rate information associated with a particular currency.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization to retrieve exchange rates.
currency_identifierstringRequiredUnique identifier for the currency to retrieve exchange rates.
exchange_rate_from_datestringOptionalDate to start retrieving exchange rates. Returns rates from this date or nearest previous match.
sort_by_columnstringOptionalSorts the exchange rates by the specified column. Only 'effective_date' is allowed.
return_current_date_exchange_rate_onlybooleanOptionalSet to true to return the exchange rate only if it's available for the current date.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_exchange_rates'.
#

ZohoBooksApi.ListCustomerDebitNotes

Retrieve and organize customer debit notes easily. Use this tool to access customer debit notes with options for pagination, filtering, searching, and sorting, allowing you to view and organize debit note data efficiently.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization for this request. Required for identifying the organization whose debit notes are being queried.
search_item_namestringOptionalSearch debit notes based on product or service names. Supports 'item_name_startswith' and 'item_name_contains'. Max length is 100 characters.
search_by_item_idstringOptionalSearch for customer debit notes using a specific item ID to filter based on product or service identifiers.
item_description_filterstringOptionalFilter debit notes by item description using detailed descriptions of products or services. Supports 'startswith' and 'contains' variants. Max length: 100 characters.
search_by_customer_namestringOptionalSearch debit notes by customer name. Filters based on the business or individual name. Maximum 100 characters.
customer_email_filterstringOptionalFilter debit notes by customer email address, with a maximum length of 100 characters, to find specific customers or generate segment reports.
search_by_total_amountstringOptionalFilter debit notes by the total amount, including taxes, discounts, and adjustments. Useful for finding specific price ranges or high-value transactions.
search_by_outstanding_balancestringOptionalFilter debit notes by the remaining unpaid amount owed by the customer. Useful for finding overdue debit notes, tracking receivables, or generating aging reports.
search_by_custom_fieldstringOptionalFilter debit notes using custom fields. Supports 'custom_field_startswith' and 'custom_field_contains' for searching specific text patterns.
search_date_rangestringOptionalFilter debit notes by creation date using yyyy-mm-dd format. Supports variants: date_start, date_end, date_before, date_after.
filter_due_datestringOptionalSearch debit notes by due date using yyyy-mm-dd format. Supports 'due_date_start', 'due_date_end', 'due_date_before', and 'due_date_after' variants.
creation_date_filterstringOptionalFilter debit notes by creation date. Use formats: 'yyyy-mm-dd', 'created_date_start', 'created_date_end', 'created_date_before', or 'created_date_after'.
last_modified_timestampstringOptionalFilter debit notes modified after this timestamp in YYYY-MM-DDTHH:MM:SS-UTC format.
status_filterstringOptionalFilter debit notes by their status. Allowed values: sent, draft, overdue, paid, void, unpaid, partially_paid, viewed.
search_by_customer_idstringOptionalSearch debit notes by the customer's unique identifier. Use the customer ID from the Contacts API to find all corresponding debit notes.
filter_by_debit_note_typestringOptionalSet to 'Type.DebitNote' to filter debit notes specifically. Required for this search.
general_search_textstringOptionalSearch debit notes by number, purchase order, or customer name. Max 100 characters. Useful for quick searches across multiple fields.
sort_debit_notes_by_columnstringOptionalSort debit notes by a specific column. Allowed values: customer_name, debit_note_number, date, due_date, total, balance, created_time.
page_number_to_fetchintegerOptionalPage number to retrieve from paginated results. Default is 1. Use with `per_page` to navigate extensive debit note data efficiently.
records_per_pageintegerOptionalSpecify the number of records to retrieve per page, up to a maximum of 200. The default value is 200. This helps manage data transfer efficiency.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_customer_debit_notes'.
#

ZohoBooksApi.ListCustomerPaymentRefunds

Retrieve refunds for a specified customer payment. Use this tool to list all refunds related to a particular customer payment by providing the customer payment ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization. Required to specify which organization's data to access.
customer_payment_identifierstringRequiredUnique identifier of the customer payment to retrieve associated refunds.
page_numberintegerOptionalSpecify the page number to fetch. Defaults to 1 if not provided.
records_per_pageintegerOptionalNumber of records to fetch per page. Defaults to 200 if not specified.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_customer_payment_refunds'.
#

ZohoBooksApi.ListCustomerPayments

List all payments made by your customers. Use this tool to retrieve a list of all the payments made by your customers. It is useful for financial analysis, reconciliation, or customer support purposes.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization. Required to specify which organization's payments to list.
search_customer_namestringOptionalFilter payments by customer name using 'startswith' or 'contains' variants. Max length: 100 characters.
search_by_reference_numberstringOptionalSearch payments by reference number. Supports 'startswith' and 'contains' variants. Max-length 100.
payment_datestringOptionalSpecify the date of the customer payment in YYYY-MM-DD format to filter results.
payment_amount_filternumberOptionalFilter payments by amount using variants: less_than, less_equals, greater_than, or greater_equals.
search_by_customer_notesstringOptionalSearch payments using customer notes, supporting 'startswith' and 'contains' variants.
payment_mode_filterstringOptionalFilter payments by specifying the payment mode. Use 'startswith' or 'contains' for partial matching.
filter_payments_by_modestringOptionalFilter payments by the payment mode. Accepted values include: All, Check, Cash, BankTransfer, Paypal, CreditCard, GoogleCheckout, Credit, Authorizenet, BankRemittance, Payflowpro, Stripe, TwoCheckout, Braintree, Others.
sort_columnstringOptionalSpecify the column to sort the payments by. Common options include date, amount, or customer name.
search_term_for_paymentsstringOptionalSearch payments by reference number, customer name, or payment description. Maximum length is 100 characters.
customer_idstringOptionalThe unique identifier for the customer involved in the payment. Use this to target specific customer transactions.
page_number_to_fetchintegerOptionalThe page number of payment records to be retrieved. Defaults to 1.
records_per_pageintegerOptionalNumber of records to be fetched per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_customer_payments'.
#

ZohoBooksApi.ListCustomModuleRecords

Fetches records from a specified custom module. Use this tool to retrieve the list of records from a specific custom module in Zoho Books. Provide the module name to get the corresponding records.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the Zoho organization to fetch records from.
custom_module_namestringRequiredName of the custom module from which to retrieve records in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_records_of_custom_module'.
#

ZohoBooksApi.ListEstimates

Retrieve a list of all estimates with pagination. Use this tool to fetch all estimates, including pagination information, from Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredSpecifies the ID of the organization to filter the estimates.
estimate_number_filterstringOptionalSpecify an estimate number or use variants like 'startswith' or 'contains' for partial matching to filter estimates.
reference_number_filterstringOptionalFilter or search estimates by their reference number. Supports partial matches using 'startswith' and 'contains'.
customer_namestringOptionalSearch estimates by customer's name with optional variants for partial matches, such as 'startswith' and 'contains'.
total_filternumberOptionalSpecify a condition to search estimates by their total amount. Use variants like 'less_than', 'less_equals', 'greater_than', and 'greater_equals' for range queries.
filter_by_customer_idstringOptionalFilter or search estimates using the unique customer ID. Use the `customer_id` provided by the Contacts API for the same organization to retrieve estimates linked to a specific customer.
filter_by_item_idstringOptionalFilter or search estimates by the unique item ID. Use the item_id returned by the Items API for the same organization to find estimates including a specific product or service.
item_name_filterstringOptionalSearch estimates by item name. Supports variants like 'item_name_startswith' and 'item_name_contains' for partial matches.
search_by_item_descriptionstringOptionalSearch estimates by item description. Use variants 'item_description_startswith' and 'item_description_contains' for pattern matching.
search_by_custom_fieldstringOptionalSearch estimates by a custom field, supporting variants like 'startswith' or 'contains' for partial matches. Useful for identifying estimates linked to specific custom data.
expiry_datestringOptionalSpecify the expiration date of the estimates to filter the results. Use the format YYYY-MM-DD.
estimate_date_filterstringOptionalSearch estimates by date using variants like 'date_start', 'date_end', 'date_before', or 'date_after'.
estimate_status_filterstringOptionalFilter estimates by status. Allowed values: draft, sent, invoiced, accepted, declined, expired.
filter_estimates_by_statusstringOptionalSpecify the status to filter estimates. Allowed values: Status.All, Status.Sent, Status.Draft, Status.Invoiced, Status.Accepted, Status.Declined, Status.Expired.
keyword_searchstringOptionalKeyword search across estimate number, reference number, or customer name to quickly find matching estimates.
sort_estimates_by_columnstringOptionalSpecify the column to sort estimates by. Options: customer_name, estimate_number, date, total, created_time.
deal_potential_idintegerOptionalPotential ID of a Deal in CRM. Use this to filter estimates linked to specific deals.
page_numberintegerOptionalSpecify the page number to fetch. Default is 1.
records_per_pageintegerOptionalNumber of records to fetch per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_estimates'.
#

ZohoBooksApi.ListExpenses

Retrieve a list of expenses with pagination. Use this tool to get a paginated list of all expenses recorded in the system.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredUnique identifier for the organization whose expenses are being queried.
search_by_descriptionstringOptionalSearch expenses by description, supports 'description_startswith' and 'description_contains'. Max-length is 100 characters.
search_by_reference_numberstringOptionalSearch expenses by part or complete reference number using 'startswith' or 'contains'. Max-length is 100 characters.
filter_by_datestringOptionalSearch expenses by expense date. Use variants: date_start, date_end, date_before, or date_after. Format [yyyy-mm-dd].
expense_statusstringOptionalSearch expenses by status. Allowed values: unbilled, invoiced, reimbursed, non-billable, billable.
amount_filternumberOptionalSearch expenses by amount using the variants: less_than, less_equals, greater_than, or greater_equals.
search_expense_account_namestringOptionalSearch expenses by account name. Use 'startswith:' or 'contains:'. Max length is 100 characters.
customer_name_filterstringOptionalFilter expenses by customer name. Supports 'startswith' and 'contains' variants. Max length is 100 characters.
vendor_name_filterstringOptionalFilter expenses by vendor name using 'vendor_name_startswith' or 'vendor_name_contains'.
expense_account_customer_idstringOptionalThe ID of the expense account for the customer. Use this to filter expenses specific to a customer's account.
vendor_idstringOptionalID of the vendor associated with the expense.
recurring_expense_idstringOptionalThe ID used to search for expenses associated with a recurring expense.
paid_through_account_idstringOptionalThe ID of the account through which the expense was paid.
search_expenses_textstringOptionalSearch expenses by account name, description, customer name, or vendor name. Maximum length is 100 characters.
sort_expenses_bystringOptionalSort expenses by the specified column. Allowed values: date, account_name, total, bcy_total, reference_number, customer_name, created_time.
expense_status_filterstringOptionalFilter expenses by status. Allowed values: 'Status.All', 'Status.Billable', 'Status.Nonbillable', 'Status.Reimbursed', 'Status.Invoiced', 'Status.Unbilled'.
page_numberintegerOptionalPage number to fetch, with the default starting at 1.
records_per_pageintegerOptionalNumber of expense records to fetch per page. Defaults to 200 if not specified.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_expenses'.
#

ZohoBooksApi.ListInventoryLocations

Retrieve all available locations from Zoho Inventory. Use this tool to get a comprehensive list of all the available locations in your Zoho Inventory. It should be called when you need to access inventory location details.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_locations'.
#

ZohoBooksApi.ListInvoiceTemplates

Fetch all invoice PDF templates from Zoho Books. This tool retrieves a list of all available invoice PDF templates in Zoho Books. Use this to access template options for invoices.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization to fetch invoice templates for.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_invoice_templates'.
#

ZohoBooksApi.ListOrganizations

Retrieve the list of organizations from Zoho Books. Use this tool to obtain a list of all organizations associated with the user's Zoho Books account. It is useful for managing and accessing organization-specific data or settings.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization to list details for.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_organizations'.
#

ZohoBooksApi.ListProjectInvoices

Retrieve invoices for a specific project in Zoho Books. Call this endpoint to obtain a list of all invoices associated with a particular project within Zoho Books. This tool is useful when you need to review or manage billing details for project-based work.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique identifier for the organization in Zoho Books. This is required to access the specific organization's project invoices.
project_unique_identifierstringRequiredUnique identifier for the specific project to retrieve invoices for.
sort_invoices_bystringOptionalSpecify the column to sort invoices by. Options are: 'invoice_number', 'date', 'total', 'balance', 'created_time'.
page_number_to_fetchintegerOptionalSpecify the page number to retrieve from the list of invoices. Default is 1.
records_per_pageintegerOptionalThe number of invoice records to fetch per page. Defaults to 200 if not specified.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_project_invoices'.
#

ZohoBooksApi.ListProjects

Retrieve a list of all projects with pagination. This tool is used to get a list of all projects from Zoho Books, with support for pagination. Call this tool to retrieve project data when managing tasks or resources.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which to list projects.
filter_projects_by_statusstringOptionalFilter projects by status. Use Status.All, Status.Active, or Status.Inactive.
search_by_customer_idstringOptionalSearch projects using the customer's ID to filter results.
sort_projects_bystringOptionalSort projects by project name, customer name, rate, or created time.
page_numberintegerOptionalSpecify the page number to retrieve. Defaults to 1 if not specified.
records_per_pageintegerOptionalNumber of records to fetch per page. Defaults to 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_projects'.
#

ZohoBooksApi.ListProjectUsers

Get a list of users associated with a project. Use this tool to retrieve users linked to a specific project in Zoho Books. This is useful for managing project collaborations and assignments.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID representing the organization in Zoho Books. Required to access project users.
project_identifierstringRequiredUnique identifier for the project to retrieve associated users.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_project_users'.
#

ZohoBooksApi.ListPurchaseOrders

Retrieve a list of all purchase orders.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization to filter purchase orders.
search_by_purchaseorder_numberstringOptionalSearch purchase order by number. Supports exact, starts with, and contains variants.
reference_number_searchstringOptionalSearch for a purchase order using the exact or partial reference number. Supports 'startswith' and 'contains' methods.
creation_datestringOptionalCreation date for purchase order search in YYYY-MM-DD format.
purchase_order_statusstringOptionalFilter purchase orders by status. Options: draft, open, billed, cancelled.
search_by_item_descriptionstringOptionalSearch purchase orders by item description. Use partial matches or specific description. Includes variants like 'startswith' and 'contains'.
vendor_namestringOptionalSearch purchase orders by vendor name with optional 'startswith' or 'contains' variants.
total_amount_filternumberOptionalFilter purchase orders by total amount. Use options like 'start', 'end', 'less_than', 'less_equals', 'greater_than', 'greater_equals' to specify the range or comparison.
vendor_identifierstringOptionalSpecify the unique ID of the vendor to filter purchase orders. Useful for grouping POs by a specific vendor.
search_by_last_modified_timestringOptionalISO 8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM) to filter POs by last modified time. For finding recently updated POs.
search_by_item_idstringOptionalSearch purchase orders using the unique item ID to find POs containing a specific item.
status_filterstringOptionalFilter purchase orders by status. Use 'Status.All', 'Status.Draft', 'Status.Open', 'Status.Billed', or 'Status.Cancelled'.
search_purchase_order_textstringOptionalSearch for purchase orders by number, reference, or vendor name. Allows general searching across multiple fields for quick lookup.
sort_by_columnstringOptionalColumn to sort purchase orders by. Options: vendor_name, purchaseorder_number, date, delivery_date, total, created_time.
search_by_custom_fieldstringOptionalSearch purchase orders using custom field criteria. Supports 'startswith' and 'contains' variants.
page_numberintegerOptionalSpecify the page number to fetch, with a default value of 1.
records_per_pageintegerOptionalSpecifies the number of purchase orders to retrieve per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_purchase_orders'.
#

ZohoBooksApi.ListRecurringExpenses

Retrieve all recurring expenses from your records. Use this tool to fetch a list of all recurring expenses. Ideal for situations where you need to review or manage periodic expenses systematically.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization whose recurring expenses need to be listed.
recurring_expense_name_filterstringOptionalFilter recurring expenses by name using either 'startswith' or 'contains'. Maximum length is 100 characters.
search_by_last_created_datestringOptionalFilter recurring expenses based on last generated expense date. Use formats: <code>last_created_date_start</code>, <code>last_created_date_end</code>, <code>last_created_date_before</code>, <code>last_created_date_after</code> with date [yyyy-mm-dd].
filter_by_next_expense_datestringOptionalFilter recurring expenses by dates related to the next expected expense. Options include 'next_expense_date_start', 'next_expense_date_end', 'next_expense_date_before', and 'next_expense_date_after'. Format is 'yyyy-mm-dd'.
expense_statusstringOptionalSpecify the status of expenses to search for. Allowed values are 'active', 'stopped', and 'expired'.
account_id_for_expensestringOptionalSpecify the unique identifier for the expense account to filter expenses associated with it.
filter_by_account_namestringOptionalSearch expenses by account name with options for exact match or partial match using 'startswith' and 'contains'. Max-length is 100 characters.
amount_filternumberOptionalSpecify a filter for expense amounts, such as 'amount_less_than', 'amount_less_equals', 'amount_greater_than', or 'amount_greater_than'.
search_by_customer_namestringOptionalSearch recurring expenses by customer name. Use variants 'customer_name_startswith' or 'customer_name_contains'. Max 100 characters.
search_by_customer_idstringOptionalSpecify the customer ID to search expenses associated with that customer.
paid_through_account_idstringOptionalID of the account through which the expense was paid. Used to filter expenses.
expense_status_filterstringOptionalFilter recurring expenses by their status. Use 'Status.All', 'Status.Active', 'Status.Expired', or 'Status.Stopped'.
search_expenses_by_textstringOptionalSpecify text to search expenses by account name, description, customer name, or vendor name. Maximum length is 100 characters.
sort_expenses_by_columnstringOptionalSpecify the column to sort expenses by. Allowed values: next_expense_date, account_name, total, last_created_date, recurrence_name, customer_name, created_time.
page_number_to_fetchintegerOptionalThe page number of records to retrieve, starting from 1. Default is 1.
records_per_pageintegerOptionalSpecify how many records to retrieve per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_recurring_expenses'.
#

ZohoBooksApi.ListRecurringInvoices

Retrieve details of all recurring invoices. Use this tool to get detailed information on all recurring invoices. Ideal for managing invoicing schedules and monitoring recurring payments.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization for which you want to list the recurring invoices. Required for accessing specific organization's data.
recurrence_unique_namestringOptionalUnique name for the recurring profile, provided by the user. Max-length is 100 characters.
search_by_item_namestringOptionalSearch recurring invoices by item name, using 'item_name_startswith' or 'profileitemname_contains' variants.
item_description_filterstringOptionalSearch for recurring invoices by item description using 'startswith' or 'contains' criteria.
customer_namestringOptionalName of the customer for whom the recurring invoice is raised. Use this to filter invoices by customer.
line_item_idstringOptionalSpecify the line item ID for filtering recurring invoices.
item_idstringOptionalUnique identifier for the item associated with the recurring invoice.
tax_identifierstringOptionalID of the tax or tax group associated with the recurring invoice.
invoice_notestringOptionalA short note for the recurring invoice, providing additional details or context.
recurring_invoice_start_datestringOptionalThe date on which the recurring invoice starts. Format: YYYY-MM-DD.
recurring_invoice_end_datestringOptionalThe date when the recurring invoice expires, formatted as YYYY-MM-DD.
customer_idstringOptionalThe ID of the customer for whom the recurring invoice is raised. Use this to filter invoices specific to a customer.
recurring_invoice_statusstringOptionalStatus of the recurring invoice: 'active', 'stopped', or 'expired'.
filter_recurring_invoice_statusstringOptionalFilter recurring invoices by status or payment expected date. Allowed values: Status.All, Status.Active, Status.Stopped, Status.Expired.
search_textstringOptionalSearch invoices by invoice number, purchase order, or customer name. Maximum length is 100 characters.
sort_by_columnstringOptionalSpecify the column to sort the recurring invoices by. Leave empty for no sorting.
page_numberintegerOptionalThe page number to fetch, with a default value of 1.
records_per_pageintegerOptionalNumber of records to retrieve per page, with a default of 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_recurring_invoices'.
#

ZohoBooksApi.ListRetainerInvoices

List all retainer invoices with pagination. Retrieve a complete list of retainer invoices. Use this tool to access invoices with pagination support.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization within Zoho Books.
sort_by_columnstringOptionalSpecifies the column to sort retainer invoices by. Allowed values: 'customer_name', 'retainer_invoice_number', 'date', 'due_date', 'total', 'balance', 'created_time'.
filter_invoices_by_status_or_datestringOptionalFilter invoices by status or payment expected date. Valid values: Status.All, Status.Sent, Status.Draft, Status.OverDue, Status.Paid, Status.Void, Status.Unpaid, Status.PartiallyPaid, Status.Viewed, Date.PaymentExpectedDate.
sorting_orderstringOptionalThe order for sorting retainer invoices. Typically 'asc' for ascending or 'desc' for descending.
page_numberintegerOptionalSpecifies the page number for pagination when listing retainer invoices.
records_per_pageintegerOptionalNumber of records to fetch per page. Default is 200.
print_pdfbooleanOptionalSet to true to print the exported PDF of retainer invoices.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_retainer_invoices'.
#

ZohoBooksApi.ListSalesOrders

Retrieve a list of all sales orders. Use this tool to get a complete list of sales orders. It helps in managing and reviewing sales transactions efficiently.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization for which sales orders are to be listed.
sort_columnstringOptionalColumn field to sort sales order results. Options: customer_name, salesorder_number, shipment_date, last_modified_time, reference_number, total, date, created_time.
cross_field_search_textstringOptionalA general search term for matching text across fields like sales order number, reference number, and customer name for quick identification.
filter_sales_order_by_statusstringOptionalFilter sales orders by status. Options: All, Open, Draft, OverDue, PartiallyInvoiced, Invoiced, Void, Closed.
filter_by_sales_order_numberstringOptionalFilter sales orders by sales order number with operators: startswith, not_in, in, or contains. Max length: 100 characters.
filter_by_item_namestringOptionalFilter sales orders by line item name. Use matching operators like startswith, not_in, in, and contains. Max length: 100 characters.
filter_by_item_idstringOptionalFilter sales orders by a specific line item identifier to retrieve orders containing a particular product or service.
filter_by_item_descriptionstringOptionalFilter sales orders by line item description. Supports variants like startswith, not_in, in, and contains. Max length: 100 characters.
filter_by_reference_numberstringOptionalFilter sales orders by external reference number using operators like `startswith`, `not_in`, `in`, and `contains`.
customer_name_filterstringOptionalFilter sales orders by customer name with operators like startswith, not_in, in, and contains. Max length: 100 characters.
filter_by_totalnumberOptionalSpecify range operators to filter sales orders by total. Use total_start, total_end, total_less_than, total_greater_than, etc.
creation_date_filterstringOptionalFilter sales orders by creation date using operators like `date_start`, `date_end`, `date_before`, `date_after`. Format: `yyyy-mm-dd`.
shipment_date_filterstringOptionalSpecify the shipment date filter for sales orders. Use variants such as 'shipment_date_start', 'shipment_date_end', 'shipment_date_before', and 'shipment_date_after' in 'yyyy-mm-dd' format.
sales_order_statusstringOptionalFilter sales orders by their status. Allowed values: draft, open, invoiced, partially_invoiced, void, and overdue.
filter_by_customer_idstringOptionalFilter sales orders by specific customer ID. Retrieves orders associated with a customer for CRM and reporting.
sales_representative_idstringOptionalFilter sales orders by specific sales representative ID for tracking and reporting purposes.
sales_order_idsstringOptionalComma-separated list of sales order IDs to filter results. Maximum length is 200 characters.
last_modified_timestringOptionalSpecify the last modified time of the sales order to filter results. Use the format 'yyyy-mm-dd'.
response_formatstringOptionalSpecifies the format for sales order details. Must be one of: json, csv, xml, xls, xlsx, pdf, jhtml, or html. Default is json.
custom_view_idstringOptionalID of the custom view to filter sales orders based on predefined criteria.
deal_crm_potential_idintegerOptionalPotential ID of a Deal in CRM. Used to filter sales orders associated with a specific deal.
page_numberintegerOptionalSpecify the page number for retrieving paginated sales order results. Default is 1 for the first page.
max_sales_orders_per_pageintegerOptionalSpecify the maximum number of sales order records to return per page. Default is 200 for optimal performance and memory usage.
enable_printingbooleanOptionalEnable printing of the exported PDF. Use when 'accept' is set to 'pdf' and 'salesorder_ids' includes values.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_sales_orders'.
#

ZohoBooksApi.ListSalesReceipts

Retrieve a list of all sales receipts. Use this tool to obtain a comprehensive list of all sales receipts. It should be called when there's a need to review or analyze sales transaction records.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization. Required to list sales receipts.
search_receipt_by_numberstringOptionalSearch for receipts using their unique number. Supports 'startswith' and 'contains' filters. Max length: 100 characters.
search_by_item_namestringOptionalSearch sales receipts by item name using 'startswith' or 'contains' variants. Maximum length is 100 characters.
sort_by_columnstringOptionalSpecify the column to sort sales receipts by. Options: customer_name, receipt_number, date, total, created_time.
filter_sales_receipts_by_statusstringOptionalFilter sales receipts based on their status. Options include date ranges like 'ThisWeek', and statuses like 'Status.Draft'.
customer_identifierstringOptionalFilter sales receipts by specific customer identifier. Provide the unique ID of the customer to retrieve their sales receipts.
date_filterstringOptionalFilter sales receipts by date using variants like date_start, date_end, date_before, and date_after. Use yyyy-mm-dd format.
total_filter_optionsnumberOptionalFilter sales receipts using range operators like total_start, total_end, total_less_than, and total_greater_than. Expects a number specifying the total amount.
page_numberintegerOptionalSpecify the page number for retrieving paginated sales receipt results. Defaults to 1.
max_records_per_pageintegerOptionalSpecify the maximum number of sales receipt records to return per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_sales_receipts'.
#

ZohoBooksApi.ListTaxes

Retrieve a list of simple and compound taxes. Use this tool to get a list of simple and compound taxes available in the system, with options for pagination.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredUnique ID of the organization to list taxes for.
page_numberintegerOptionalPage number of the tax list to retrieve. Defaults to 1 if not specified.
records_per_pageintegerOptionalThe number of tax records to retrieve per page. Defaults to 200 if not specified.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_taxes'.
#

ZohoBooksApi.ListTimeEntries

Retrieve all time entries with pagination. Call this tool to get a list of all time entries for projects, supporting pagination if needed.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique identifier for the organization. Required to retrieve time entries specific to this organization.
start_date_for_time_entriesstringOptionalDate from which the time entries should start being fetched. Expected format is YYYY-MM-DD.
end_date_for_time_entriesstringOptionalThe end date for fetching logged time entries in YYYY-MM-DD format.
filter_time_entries_bystringOptionalFilter time entries by date or status. Use values like Date.Today, Date.ThisMonth, Status.Unbilled, etc.
project_idstringOptionalSearch for time entries by specifying the project ID.
search_time_entries_by_user_idstringOptionalSearch and filter time entries based on a specific user's ID. Provide the ID as a string.
sort_time_entries_bystringOptionalSort time entries by project name, task name, user name, log date, timer start time, or customer name.
page_number_to_fetchintegerOptionalPage number to retrieve time entries from, starting at 1 by default.
records_per_pageintegerOptionalNumber of records to fetch per page. Defaults to 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_time_entries'.
#

ZohoBooksApi.ListVendorCreditRefunds

Retrieve all refunds for a specified vendor credit. Use this tool to get a list of all refunds associated with a particular vendor credit by providing the vendor credit ID.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredUnique string ID of the organization for which refunds are to be listed.
vendor_credit_idstringRequiredThe unique identifier for a specific vendor credit whose refunds are to be listed.
page_numberintegerOptionalPage number for pagination, specifying which set of results to retrieve. Default is 1.
records_per_pageintegerOptionalSpecify the number of refunds to return per page for pagination. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_vendor_credit_refunds'.
#

ZohoBooksApi.ListVendorCredits

Retrieve and filter vendor credits from Zoho Books. Retrieve a paginated list of vendor credits using various filtering, sorting, and search capabilities, such as by date, status, amount, vendor details, items, taxes, and custom fields.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books.
vendor_credit_number_filterstringOptionalFilter vendor credits by specific vendor credit number. Supports partial matching with options like 'startswith' and 'contains'.
filter_by_creation_datestringOptionalFilter vendor credits by creation date using yyyy-mm-dd format. Supports date_start, date_end, date_before, and date_after for range filtering.
vendor_credit_statusstringOptionalFilter vendor credits by their current status. Allowed values: 'open', 'closed', 'void', or 'draft'.
total_amount_filterstringOptionalFilter vendor credits by total amount. Use variants: total_start, total_end, total_less_than, total_less_equals, total_greater_than, total_greater_equals.
reference_number_filterstringOptionalFilter vendor credits by their reference number, supporting 'startswith' and 'contains' for partial matches.
filter_by_vendor_namestringOptionalFilter vendor credits by vendor name, supporting partial matches with 'startswith' and 'contains'.
filter_by_item_namestringOptionalFilter vendor credits by item name. Use 'startswith:' or 'contains:' as prefixes for partial matching.
item_description_filterstringOptionalFilter vendor credits by item description. Supports partial matching with 'startswith' and 'contains'.
filter_by_notes_contentstringOptionalFilter vendor credits by notes content. Use partial matching with variants: notes_startswith or notes_contains.
filter_by_custom_fieldstringOptionalFilter vendor credits by custom field values. Use 'custom_field_startswith' or 'custom_field_contains' for partial matching.
filter_by_last_modified_timestringOptionalFilter vendor credits by last modified time using ISO 8601 format (yyyy-mm-ddThh:mm:ss-hh:mm).
filter_by_customer_idintegerOptionalFilter vendor credits by a specific customer ID to find credits associated with that customer. Retrieve customer IDs from the contacts API.
filter_by_line_item_idintegerOptionalFilter vendor credits by a specific line item ID to find credits containing the item.
filter_by_item_idintegerOptionalFilter vendor credits by a specific item ID. Use this to find vendor credits containing the item. Retrieve item IDs from the items API.
filter_by_tax_idintegerOptionalFilter vendor credits by specific tax ID to find credits with that tax applied. Tax IDs are retrieved from the taxes API.
filter_by_statusstringOptionalFilter vendor credits by status using predefined values: Status.All, Status.Open, Status.Draft, Status.Closed, Status.Void.
search_textstringOptionalEnter text to search vendor credits by credit number, vendor name, and reference number.
sort_by_columnstringOptionalSpecify which column to sort vendor credits by. Options: vendor_name, vendor_credit_number, balance, total, date, created_time, last_modified_time, reference_number.
pagination_page_numberintegerOptionalSpecify the page number to retrieve results from for pagination. Default is 1.
pagination_records_per_pageintegerOptionalSpecify the number of vendor credit records to return per page. The default value is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_vendor_credits'.
#

ZohoBooksApi.ListVendorPaymentRefunds

List all refunds for a vendor payment. Retrieve a list of all refunds associated with a specific vendor payment in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization in Zoho Books to list the refunds for. This should be a unique identifier as specified by Zoho Books.
payment_identifierstringRequiredUnique identifier of the vendor payment to fetch refunds for.
page_numberintegerOptionalPage number to be fetched, starting from 1. Default is 1.
records_per_pageintegerOptionalNumber of records to fetch per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_vendor_payment_refunds'.
#

ZohoBooksApi.ListVendorPayments

Fetch all payments made to vendors. Use this tool to retrieve a list of all vendor payments. It helps manage and track financial transactions with vendors.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization whose vendor payments you want to list.
vendor_name_querystringOptionalSearch payments by vendor name using parameters like startswith or contains.
search_by_reference_numberstringOptionalSearch payments using the reference number. Supports variants: 'startswith' and 'contains'.
payment_number_searchstringOptionalSearch payments using the payment number with options for exact match, starts with, or contains.
payment_date_filterstringOptionalSpecify the date for payment filtering. Use variants like 'date_start', 'date_end', 'date_before', and 'date_after'.
payment_amount_filternumberOptionalFilter payments by amount paid to the vendor. Use variants: 'less_than', 'less_equals', 'greater_than', 'greater_equals' to specify the condition.
search_by_payment_modestringOptionalSearch payments by payment mode using variants like 'startswith' or 'contains'.
search_with_payment_notesstringOptionalSearch payments using notes with options like startswith or contains.
vendor_idstringOptionalThe unique ID of the vendor, used to search payments by vendor ID.
last_modified_time_filterstringOptionalFilter vendor payments by their last modified time. Use a date-time string in ISO 8601 format.
search_payments_by_bill_idstringOptionalSearch payments using the specific Bill ID associated with the transaction.
search_by_descriptionstringOptionalSearch payments by description. Use 'description_startswith' or 'description_contains' variants for specific matches.
filter_payment_modestringOptionalFilter payments by payment mode. Options include All, Check, Cash, BankTransfer, Paypal, CreditCard, GoogleCheckout, Credit, Authorizenet, BankRemittance, Payflowpro, and Others.
search_textstringOptionalSearch for payments using reference number, vendor name, or payment description.
sort_payments_bystringOptionalSort payments by column. Options: vendor_name, date, reference_number, amount, balance.
page_number_to_fetchintegerOptionalSpecify the page number of results to fetch. Default is 1.
records_per_pageintegerOptionalSpecify the number of records to fetch per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_vendor_payments'.
#

ZohoBooksApi.LogTimeEntries

Log time entries in Zoho Books. Use this tool to log time entries for projects in Zoho Books. It should be called when you need to track time spent on project tasks. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books. Required for logging time entries. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_time_entries'.
#

ZohoBooksApi.MarkBillOpen

Mark a void bill as open in Zoho Books. Use this tool to change the status of a void bill to open in Zoho Books. Call this tool when you need to reactivate a bill that was previously voided.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredProvide the ID of the organization in Zoho Books to mark the bill as open.
bill_idstringRequiredUnique identifier of the bill to mark as open in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_bill_open'.
#

ZohoBooksApi.MarkBillVoid

Mark a bill as void in Zoho Books. Use this tool to update the status of a bill to void in Zoho Books when you need to cancel or invalidate a bill.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books. Used to specify which organization's bill should be marked as void.
bill_identifierstringRequiredUnique identifier of the bill to mark as void in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_bill_void'.
#

ZohoBooksApi.MarkContactInactive

Mark a Zoho Books contact as inactive. Use this tool to mark a contact as inactive in Zoho Books, allowing for better organization and active contact management.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization in Zoho Books.
contact_identifierstringRequiredUnique identifier of the contact in Zoho Books. Required to specify which contact to mark as inactive.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_contact_inactive'.
#

ZohoBooksApi.MarkCreditNoteOpen

Convert a draft credit note to open status in Zoho Books. Use this tool to change the status of a credit note from Draft to Open in Zoho Books. This is helpful when you need to activate a credit note that has been prepared and saved as a draft.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books.
credit_note_idstringRequiredUnique identifier of the credit note to be converted to Open status.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_credit_note_open'.
#

ZohoBooksApi.MarkCreditNoteVoid

Marks a credit note as void in Zoho Books. Use this tool to mark a specific credit note as void, altering its status in the Zoho Books system.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books to mark the credit note as void.
credit_note_identifierstringRequiredUnique identifier of the credit note to mark as void in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_credit_note_void'.
#

ZohoBooksApi.MarkEstimateAsSent

Mark a draft estimate as sent. Use this tool to mark a draft estimate in Zoho Books as sent. Call this when you need to update the status of an estimate to indicate it has been sent to a client.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books. Required to identify which organization's estimate to mark as sent.
estimate_identifierstringRequiredThe unique identifier for the estimate to be marked as sent.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_estimate_sent'.
#

ZohoBooksApi.MarkFixedAssetAsDraft

Set a fixed asset status to draft in Zoho Books. Use this tool to change the status of a specific fixed asset to draft in Zoho Books. This is useful when revising asset details or temporarily removing it from active use.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization for which the fixed asset status will be changed.
fixed_asset_identifierstringRequiredUnique identifier for the fixed asset in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_fixed_asset_draft'.
#

ZohoBooksApi.MarkInvoiceAsDraft

Mark a voided invoice as draft in Zoho Books. This tool is used to change the status of a voided invoice to draft in Zoho Books. It should be called when there is a need to edit or resubmit an invoice previously marked as void.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization in Zoho Books.
invoice_identifierstringRequiredUnique identifier of the invoice to be marked as draft.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_invoice_draft'.
#

ZohoBooksApi.MarkInvoiceAsSent

Mark a draft invoice as sent. Use this tool to change the status of a draft invoice to 'sent'. Ideal for when an invoice is ready to be sent out to a client.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredUnique identifier of the organization for which the invoice will be marked as sent.
invoice_unique_identifierstringRequiredUnique identifier of the invoice to be marked as sent.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_invoice_sent'.
#

ZohoBooksApi.MarkInvoiceSent

Marks a draft retainer invoice as sent. Use this tool to update the status of a draft retainer invoice to 'sent' in Zoho Books. This is useful when you need to track the invoice as having been dispatched to a client.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books. This ID is necessary to specify which organization's invoice should be marked as sent.
retainer_invoice_idstringRequiredUnique identifier of the retainer invoice to be marked as sent.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_retainer_invoice_sent'.
#

ZohoBooksApi.MarkItemInactive

Mark an item as inactive in Zoho Books. Use this tool to mark an active item as inactive in Zoho Books. Useful for managing inventory and item status.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books. Required for specifying which organization's item to mark as inactive.
item_identifierstringRequiredUnique identifier of the item to be marked inactive.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_item_inactive'.
#

ZohoBooksApi.MarkLocationInactive

Marks a specific location as inactive in Zoho Books. Use this tool to set a location's status to inactive within Zoho Books. This is helpful for managing locations that are no longer in use.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization in Zoho Books to mark the location as inactive.
location_identifierstringRequiredUnique identifier of the location to be marked as inactive in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_location_inactive'.
#

ZohoBooksApi.MarkPrimaryContactPerson

Mark a contact person as primary for a contact. Use this tool to designate a specific contact person as the primary contact for a particular contact. Useful for managing contact hierarchies within an organization.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique identifier for the organization. This is required to specify which organization's contact is being updated.
contact_person_identifierstringRequiredUnique identifier for the contact person to be marked as primary.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_contact_person_primary'.
#

ZohoBooksApi.MarkPurchaseOrderBilled

Mark a purchase order as billed in Zoho Books. Use this tool to update the status of a purchase order to 'billed' in Zoho Books. This is useful when a purchase order has been fulfilled and needs to be recorded as billed.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization in Zoho Books. Required to perform actions within the specified organization.
purchase_order_idstringRequiredUnique identifier of the purchase order to be marked as billed.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_purchase_order_billed'.
#

ZohoBooksApi.MarkRetainerInvoiceAsDraft

Mark a voided retainer invoice as draft. Use this tool to change the status of a voided retainer invoice back to draft. This is useful when you need to reuse or edit a voided invoice within Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization in Zoho Books.
retainer_invoice_idstringRequiredUnique identifier of the retainer invoice to be marked as draft.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_retainer_invoice_draft'.
#

ZohoBooksApi.MarkSalesOrderAsVoid

Mark a sales order as void in Zoho Books. Use this tool to transition a specified sales order to a void status, effectively canceling it within Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
sales_order_idstringOptionalUnique identifier for the specific sales order to be marked as void. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_sales_order_as_void'.
#

ZohoBooksApi.MarkVendorCreditVoid

Mark an existing vendor credit as void in Zoho Books. Use this tool to mark a specific vendor credit as void. Typically called when you need to invalidate a previously issued vendor credit in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredProvide the unique ID of the organization in Zoho Books.
vendor_credit_identifierstringRequiredUnique identifier for the vendor credit to be marked as void.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_vendor_credit_void'.
#

ZohoBooksApi.MatchBankTransaction

Match an uncategorized bank transaction with an existing one. Use this tool to match an uncategorized transaction with an existing transaction in Zoho Books, ensuring proper categorization and reconciliation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalUnique identifier for the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bank_transaction_idstringOptionalUnique identifier of the bank transaction to be matched. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
account_idstringOptionalThe mandatory Account ID for listing transactions to match. This is required to specify the bank account in Zoho Books. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'match_bank_transaction'.
#

ZohoBooksApi.ModifyInvoice

Update an existing invoice in Zoho Books. This tool updates the information of an existing retainer invoice in Zoho Books. Use it when you need to modify invoice details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique ID of the organization within Zoho Books to which the retainer invoice belongs. This is required to ensure the update is applied to the correct entity. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
retainer_invoice_idstringOptionalUnique identifier of the retainer invoice to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_retainer_invoice'.
#

ZohoBooksApi.ModifyInvoiceAddress

Update the billing address for a specific invoice. Use this tool to update the billing address for a particular invoice in Zoho Books. It modifies the address details for a specified invoice. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique string ID of the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
invoice_identifierstringOptionalUnique identifier of the invoice to update the billing address. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_invoice_billing_address'.
#

ZohoBooksApi.ModifyRecurringExpense

Update a recurring expense in Zoho Books. Use this tool to modify details of an existing recurring expense in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalProvide the ID of the organization for which the recurring expense needs to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
recurring_expense_identifierstringOptionalUnique identifier for the recurring expense to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_recurring_expense'.
#

ZohoBooksApi.ModifyRetainerInvoiceTemplate

Update the PDF template for a retainer invoice. Use this tool to update the PDF template associated with a specific retainer invoice by providing the retainer invoice ID and the template ID. It should be called when you need to change the appearance or format of a retainer invoice.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe ID of the organization to update the retainer invoice template for. It should be a string representing the organization's unique identifier in Zoho Books.
retainer_invoice_idstringRequiredUnique identifier for the retainer invoice to update the PDF template.
retainer_invoice_template_idstringRequiredUnique identifier of the retainer invoice template.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_retainer_invoice_template'.
#

ZohoBooksApi.OpenPurchaseOrder

Mark a draft purchase order as open. Use this tool to change the status of a draft purchase order to 'open' in Zoho Books, making it active and processable. Call this when you need to activate draft purchase orders.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books whose purchase order status needs to be changed.
purchase_order_identifierstringRequiredUnique identifier for the purchase order to be marked as open.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_purchase_order_open'.
#

ZohoBooksApi.OpenSalesOrder

Mark a draft sales order as open in Zoho Books. Use this tool to change the status of a draft sales order to open in Zoho Books. This is useful when a sales order needs to be moved from draft status to active status, indicating it's ready for further processing.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization where the sales order is to be marked as open.
sales_order_idstringRequiredUnique identifier of the sales order to mark as open in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_sales_order_as_open'.
#

ZohoBooksApi.OpenVendorCreditStatus

Change a vendor credit status to open in Zoho Books. Use this tool to update the status of an existing vendor credit to 'open' in Zoho Books. This is useful when you need to reactivate a vendor credit for further processing or adjustments.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books whose vendor credit status needs to be marked as open.
vendor_credit_identifierstringRequiredUnique identifier for the vendor credit to be marked as open.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_vendor_credit_open'.
#

ZohoBooksApi.PostProjectComment

Post a comment to a specified project. This tool posts a comment to a specific project in Zoho Books. Use it when you need to add a comment or note to a project for tracking or communication purposes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique identifier of the organization for which the comment is being posted. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
project_unique_identifierstringOptionalUnique identifier for the project in Zoho Books. Required to specify the target project for adding a comment. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'add_project_comment'.
#

ZohoBooksApi.PublishDraftJournal

Mark a draft journal as published in Zoho Books. Use this tool to change the status of a draft journal entry to published within Zoho Books. This can be helpful when a draft is ready for final publication.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization in Zoho Books. Required to identify the organization where the journal resides.
journal_identifierstringRequiredUnique identifier of the journal to be marked as published.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_journal_published'.
#

ZohoBooksApi.RefundCreditNote

Process a credit note refund in Zoho Books. Use this tool to issue a refund for a specified credit note in Zoho Books. It is triggered when there's a need to reimburse the amount associated with a credit note. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization in Zoho Books for which the credit note refund is being processed. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
credit_note_idstringOptionalUnique identifier of the credit note to refund. This is required to specify which credit note the refund applies to. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_credit_note_refund'.
#

ZohoBooksApi.RefundExcessPayment

Refund the excess amount paid by a customer. Use this tool to refund any excess amount received from a customer payment. It is called when there is a need to process a refund for overpaid amounts in customer transactions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization to process the refund under. Ensure this matches the ID in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
customer_payment_identifierstringOptionalUnique identifier for the customer's payment to be refunded. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'create_customer_payment_refund'.
#

ZohoBooksApi.RefundVendorCredit

Process a refund for vendor credit. Use this tool to initiate a refund for a specified vendor credit. Suitable when needing to refund amounts credited to a vendor. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization for which the vendor credit refund is being processed. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
vendor_credit_identifierstringOptionalUnique identifier for the vendor credit that needs to be refunded. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'refund_vendor_credit'.
#

ZohoBooksApi.RefundVendorOverpayment

Refund excess amount paid to a vendor. Use this tool to process a refund for any excess amount that has been paid to a vendor. This should be called when an overpayment needs to be returned to the vendor. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique ID representing the organization. Required to refund vendor overpayment. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
vendor_payment_idstringOptionalUnique identifier for the vendor payment to be refunded. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'refund_excess_vendor_payment'.
#

ZohoBooksApi.RejectPurchaseOrder

Reject a specific purchase order in Zoho Books. This tool should be called when you need to reject a purchase order in the Zoho Books system. It confirms the rejection of the specified purchase order.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredA unique identifier for the organization in Zoho Books.
purchase_order_idstringRequiredThe ID of the purchase order to be rejected in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'reject_purchase_orders'.
#

ZohoBooksApi.RemindCustomerInvoicePayment

Remind customers of unpaid invoices by email. Use this tool to notify customers about unpaid invoices through email. It works for invoices that are open or overdue. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. It specifies which organization's invoice reminders to manage. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
invoice_identifierstringOptionalUnique identifier of the invoice to send a payment reminder for. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
email_attachmentsstringOptionalComma-separated list of file URLs to attach to the reminder email. Only used when mode is 'execute'.
include_customer_statement_pdfbooleanOptionalSet to true to include a customer statement PDF with the email reminder. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'remind_customer_for_invoice_payment'.
#

ZohoBooksApi.RemoveCurrency

Remove a specific currency from the system. This tool deletes a currency. It should be used when a currency that is no longer needed should be removed, as long as it is not associated with any transactions.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID representing the organization for which the currency deletion is requested.
currency_identifierstringRequiredUnique identifier of the currency to be deleted.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_currency'.
#

ZohoBooksApi.RemoveInvoiceCredit

Remove a specific credit applied to an invoice. Use this tool to delete a particular credit that has been applied to an invoice when adjustments are needed.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization from which the credit is being removed.
invoice_identifierstringRequiredUnique identifier of the invoice to remove a credit from.
credit_note_invoice_idstringRequiredUnique identifier of the credit note invoice to be removed from the invoice.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_invoice_applied_credit'.
#

ZohoBooksApi.RemoveUserFromOrganization

Delete a user from the organization. This tool removes a specified user from the organization in Zoho Books. It should be called when there is a need to delete a user's access or association with the organization.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization from which the user will be deleted.
user_unique_identifierstringRequiredUnique identifier of the user to be deleted from the organization.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_user'.
#

ZohoBooksApi.RemoveUserFromProject

Remove a user from a specific project in Zoho Books. This tool is used to remove a user from a project within Zoho Books. Call this tool when you need to manage project participants by deleting a user's access to a particular project.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization within Zoho Books.
project_identifierstringRequiredThe unique identifier for the project from which the user will be removed.
user_identifierstringRequiredUnique identifier of the user to be removed from the project.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_project_user'.
#

ZohoBooksApi.RemoveVendorBillCredit

Delete credits applied to a vendor bill. Use this tool to remove credits applied to a specific vendor bill using the vendor_credit_id and vendor_credit_bill_id.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization for which the vendor credit bill is to be deleted.
vendor_credit_identifierstringRequiredUnique identifier of the vendor credit to be deleted. Required for bill credit removal.
vendor_credit_bill_identifierstringRequiredUnique identifier of the vendor credit bill to delete the applied credits.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'delete_vendor_credit_bill'.
#

ZohoBooksApi.RestoreBankTransaction

Restores an excluded bank transaction in your account. Use this tool to recover a previously excluded bank transaction in your Zoho Books account, identified by the transaction ID. It should be called when you need to reinstate transactions that were mistakenly removed.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the Zoho Books organization to restore the transaction for.
bank_transaction_idstringRequiredThe unique identifier for the specific bank transaction to be restored.
account_idstringOptionalMandatory Account ID for which transactions are to be restored.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'restore_bank_transaction'.
#

ZohoBooksApi.ResumeRecurringBill

Resume a stopped recurring bill in Zoho Books. Use this tool to restart a suspended recurring bill in Zoho Books, ensuring payments continue as scheduled.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID for the organization in Zoho Books.
recurring_bill_identifierstringRequiredProvide the unique identifier of the recurring bill to resume it in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'resume_recurring_bill'.
#

ZohoBooksApi.ResumeRecurringExpense

Resumes a stopped recurring expense cycle. Use this tool to restart a recurring expense that has been previously paused in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books.
recurring_expense_idstringRequiredThe unique identifier for the recurring expense to be resumed.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'resume_recurring_expense'.
#

ZohoBooksApi.ResumeRecurringInvoice

Resumes a stopped recurring invoice. Use this tool to resume a recurring invoice that has been paused. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization whose invoice needs to be resumed. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
recurring_invoice_idstringOptionalUnique identifier of the recurring invoice to be resumed. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'resume_recurring_invoice'.
#

ZohoBooksApi.RetrieveBillAttachment

Retrieve the attachment from a specific bill. Call this tool to get the file attached to a bill using its bill ID. Useful for accessing invoices or related documents stored in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization to specify which organization's bill attachment to retrieve.
bill_identifierstringRequiredThe unique identifier of the bill to retrieve its attachment.
get_thumbnailbooleanOptionalSet to true to get the thumbnail of the attachment instead of the full file.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_bill_attachment'.
#

ZohoBooksApi.RetrieveBillDetails

Retrieve the details of a specific bill. Use this tool to get comprehensive details about a specific bill by providing its ID. Useful for retrieving bill information such as amount, due date, or vendor details.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization for which the bill details are being retrieved.
bill_identifierstringRequiredUnique identifier of the bill to retrieve its details. This should be provided as a string.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_bill'.
#

ZohoBooksApi.RetrieveContactDetails

Retrieve comprehensive details of a specific contact. This tool should be called to access complete information about a contact, including basic details, addresses, payment terms, and financial data such as outstanding amounts and transaction history.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique identifier of the organization for which the contact details are being retrieved.
contact_idstringRequiredUnique identifier for the contact to retrieve detailed information.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_contact'.
#

ZohoBooksApi.RetrieveContactList

Retrieve and filter a list of contacts from Zoho Books. Use this tool to obtain a detailed list of contacts with options for advanced filtering by name, company, status, and more. Ideal for managing contact information and accessing financial data like outstanding amounts and credit limits. Supports pagination for efficient data handling.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredProvide the ID of the organization to retrieve relevant contact data.
filter_contact_by_typestringOptionalFilter contacts by type. Accepts 'customer' or 'vendor'.
contact_name_filterstringOptionalFilter contacts by name. Use 'startswith' or 'contains' for match type. Max-length: 100 characters.
search_by_company_namestringOptionalSearch contacts by company name. Maximum length is 100 characters. Use variants like 'company_name_startswith' and 'company_name_contains' for different search methods.
primary_contact_first_namestringOptionalSearch contacts by the first name of the primary contact person. Use 'first_name_startswith' or 'first_name_contains'. Max-length 100.
search_by_last_namestringOptionalSearch contacts by last name of the primary contact person. Supports 'startswith' or 'contains' options. Max-length 100.
address_searchstringOptionalSearch contacts by address field. Use 'address_startswith' or 'address_contains'. Max-length 100.
email_search_criteriastringOptionalSearch contacts by email of the primary contact person. Use 'startswith' or 'contains' in the string to specify the search variant. Max length is 100 characters.
contact_phone_numberstringOptionalSearch contacts by primary contact's phone number. Supports 'startswith' and 'contains' variants. Max length of 100 characters.
contact_status_filterstringOptionalFilter contacts by status. Options include All, Active, Inactive, Duplicate, PortalEnabled, PortalDisabled, OverDue, Unpaid, CreditLimitExceed, and Crm.
search_contacts_textstringOptionalSearch contacts using contact name or notes. Maximum length is 100 characters.
sort_by_columnstringOptionalSpecify the column to sort contacts by. Allowed values: contact_name, first_name, last_name, email, outstanding_receivable_amount, created_time, and last_modified_time.
crm_contact_idstringOptionalCRM Contact ID to filter specific contact details.
crm_account_idstringOptionalSpecify the CRM Account ID for the contact to retrieve specific contact details.
crm_vendor_idstringOptionalThe CRM Vendor ID associated with the contact, used to filter results.
page_number_to_fetchintegerOptionalSpecify the page number to be fetched. Defaults to 1 if not provided.
records_per_pageintegerOptionalThe number of contact records to fetch per page. Default is 200.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'list_contacts'.
#

ZohoBooksApi.RetrieveCreditNoteEmailHistory

Retrieve the email history of a specific credit note. Use this tool to get detailed information about the email interactions associated with a specific credit note. Useful for tracking communication history.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization for which you want to retrieve the credit note email history.
credit_note_idstringRequiredUnique identifier of the credit note to retrieve its email history.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_credit_note_email_history'.
#

ZohoBooksApi.RetrieveEstimateDetails

Retrieve the details of a specific estimate. Use this tool to get information about a particular estimate by providing its ID. It returns the details associated with the specified estimate in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization in Zoho Books. Required to retrieve estimate details.
estimate_idstringRequiredUnique identifier of the specific estimate to retrieve details for.
response_formatstringOptionalSpecify the format for the estimate details: json, pdf, or html. Default is json.
print_pdfbooleanOptionalSet to true to print the exported PDF of the estimate.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_estimate'.
#

ZohoBooksApi.RetrieveExpenseReceipt

Retrieve the receipt attached to an expense. Use this tool to obtain the receipt attached to a specific expense entry in Zoho Books. It is useful for reviewing or auditing expense details by accessing the actual receipt document.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization in Zoho Books. Required to retrieve the expense receipt.
expense_identifierstringRequiredUnique identifier for the expense to retrieve its receipt. Required for locating the specific expense in Zoho Books.
get_receipt_thumbnailbooleanOptionalSet to true to get a thumbnail of the receipt; false returns the full receipt.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_expense_receipt'.
#

ZohoBooksApi.RetrieveInvoiceDocument

Retrieve a document attached to a specific invoice. Use this tool to access and download a document linked to an invoice by specifying the invoice and document IDs.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization to retrieve the document from.
invoice_idstringRequiredThe unique identifier for the invoice to which the document is attached. Required to retrieve the document.
invoice_document_idstringRequiredUnique identifier for the specific document attached to the invoice. Required to retrieve the exact document.
response_formatstringOptionalSpecify the desired format for the response, such as json, pdf, or html.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_invoice_document_details'.
#

ZohoBooksApi.RetrieveItemDetails

Retrieve details of a specific item in Zoho Books. Use this tool to get detailed information about a specific item in Zoho Books by providing the item ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization whose item details are being retrieved.
item_unique_identifierstringRequiredUnique identifier for the item to retrieve details from Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_item'.
#

ZohoBooksApi.RetrievePurchaseOrderAttachment

Retrieve the file attached to a specific purchase order. Use this tool to obtain the file attachment from a specific purchase order by providing the purchase order ID.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID representing the organization. Required to specify which organization's purchase order to access.
purchase_order_idstringRequiredThe unique identifier of the purchase order to retrieve the attachment for.
get_thumbnailbooleanOptionalSet to true to get the thumbnail of the attachment, or false to retrieve the full file.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_purchase_order_attachment'.
#

ZohoBooksApi.RetrievePurchaseOrderDetails

Retrieve the details of a purchase order. Use this tool to get detailed information about a specific purchase order by providing the purchase order ID. Ideal for retrieving purchase order data for review or processing.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredUnique ID of the organization to retrieve purchase order details.
purchase_order_idstringRequiredProvide the unique identifier of the purchase order to retrieve its details.
response_formatstringOptionalSpecifies the format of the purchase order details. Options: json, pdf, html. Default is json.
print_pdfbooleanOptionalSet to True to print the exported PDF of the purchase order.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_purchase_order'.
#

ZohoBooksApi.RetrieveRetainerInvoiceEmailContent

Retrieve the email content of a retainer invoice. This tool fetches the email content of a specific retainer invoice using the provided invoice ID. It should be called when you need to view or send the email details of a retainer invoice.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization. Required to access retainer invoice emails.
retainer_invoice_idstringRequiredUnique identifier of the retainer invoice. Used to fetch the specific email content.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_retainer_invoice_email'.
#

ZohoBooksApi.RetrieveTaxGroupDetails

Retrieve details of a specific tax group. Use this to obtain information about a specific tax group by its ID in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization in Zoho Books to get the tax group details for.
tax_group_identifierstringRequiredUnique identifier for the tax group in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_tax_group'.
#

ZohoBooksApi.RetrieveUnusedRetainerPayments

Retrieve unused retainer payments for a contact. Fetch details of unused retainer payments associated with a specific contact, providing insight into available credit balances.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredUnique identifier for the organization to filter retainer payments.
contact_idstringRequiredThe unique identifier for the contact whose unused retainer payments are being retrieved. This is required to specify which contact's data you want to access.
filter_by_currency_idstringOptionalCurrency ID to filter unused retainer payments by a specific currency.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'get_unused_retainer_payments'.
#

ZohoBooksApi.SellFixedAsset

Initiate the sale of a specified fixed asset. Use this tool to sell a specific fixed asset by providing its asset ID. It should be called when confirming or completing the sale process of a fixed asset in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier of the organization within Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
fixed_asset_identifierstringOptionalUnique identifier of the fixed asset to be sold. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'sell_fixed_asset'.
#

ZohoBooksApi.SendEmailToContact

Send an email directly to a specified contact. Use this tool to send an email to a contact by specifying their contact ID. Ideal for communicating directly with contacts via email. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique ID of the organization to which the contact belongs. It is required for sending the email. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
contact_idstringOptionalUnique identifier for the contact to send the email to. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
send_customer_statement_with_emailbooleanOptionalIndicate if a customer statement PDF should be sent with the email. Use 'true' to send, 'false' otherwise. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'email_contact'.
#

ZohoBooksApi.SendEstimateEmail

Send an email estimate to a customer. Use this tool to email an estimate to a customer. If no specific content is provided, the default email content will be used. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier of the organization. This ID is required to send an estimate email. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
estimate_identifierstringOptionalUnique identifier of the estimate to be emailed. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
email_attachmentsstringOptionalFiles to be attached to the email estimate. Provide file paths or URLs. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'email_estimate'.
#

ZohoBooksApi.SendEstimatesEmail

Send multiple estimates to customers via email. Use this tool to email up to 10 estimates to your customers efficiently. Ideal for managing and sharing multiple estimates at once.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books.
estimate_ids_to_emailstringRequiredComma-separated string of up to 10 estimate IDs to send via email.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'email_multiple_estimates'.
#

ZohoBooksApi.SendInvitationEmail

Send an invitation email to a user in Zoho Books. Use this tool to send an invitation email to a specific user by their user ID in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier of the organization in Zoho Books required to send the invitation.
user_unique_identifierstringRequiredUnique identifier of the user to whom the invitation email will be sent.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'invite_user'.
#

ZohoBooksApi.SendInvoiceEmail

Email an invoice to a customer with optional content customization. This tool is used to email an invoice to a customer. It can be called when there's a need to send invoice details via email, optionally allowing custom content. If no custom content is provided, default mail content will be used. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier of the organization to which the invoice is linked. This ID is required to specify which organization's invoice is being emailed. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
invoice_identifierstringOptionalUnique string identifier for the specific invoice to be emailed. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
invoice_email_attachmentsstringOptionalA comma-separated list of file paths to attach to the email. Provide file paths if additional files need to be included with the invoice email. Only used when mode is 'execute'.
send_customer_statementbooleanOptionalSet to 'True' to send the customer statement PDF with the email. Only used when mode is 'execute'.
send_invoice_attachmentbooleanOptionalSet to true to attach the invoice with the email; false to exclude it. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'email_invoice'.
#

ZohoBooksApi.SendInvoiceReminders

Send email reminders for unpaid invoices. Use this tool to remind customers about unpaid invoices by email. It sends reminder emails only for open or overdue invoices, with a maximum of 10 invoices at a time.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredProvide the ID of the organization for which the invoice reminders are to be sent.
invoice_idsstringRequiredList of invoice IDs to send reminders for. Only for open or overdue invoices, up to 10 at once.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'bulk_invoice_reminder'.
#

ZohoBooksApi.SendInvoicesEmail

Send up to 10 invoices by email to customers. This tool is used to email invoices to your customers, allowing you to send up to 10 invoices in a single request. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe organization ID for which invoices will be emailed. Required for sending emails. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
comma_separated_invoice_idsstringOptionalComma separated list of invoice IDs to be emailed. Maximum 10 IDs. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'email_invoices'.
#

ZohoBooksApi.SendPurchaseOrderEmail

Send a purchase order email to the vendor. Use this tool to email a purchase order to the vendor. If no custom content is provided, the email will be sent with default content. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique identifier for the organization. Required to specify which organization the purchase order belongs to. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
purchase_order_idstringOptionalUnique identifier of the purchase order to be emailed to the vendor. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
email_attachmentsstringOptionalA comma-separated list of file paths or URLs to attach to the email. Only used when mode is 'execute'.
attachment_file_namestringOptionalThe name of the file to attach to the email for the purchase order. Only used when mode is 'execute'.
send_purchase_order_attachmentbooleanOptionalSet to true to include the purchase order as an attachment with the email. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'email_purchase_order'.
#

ZohoBooksApi.SendVendorPaymentEmail

Send a payment receipt email to a vendor. This tool sends a vendor payment receipt to a vendor via email. You can customize the email content, attach files, and control sender preferences. If no customizations are provided, the email will use default templates. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization for which the vendor payment email is being sent. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
vendor_payment_idstringOptionalUnique identifier for the vendor payment. Used to retrieve and send the corresponding payment receipt via email. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
email_attachmentsstringOptionalList of file paths or URLs to attach to the email. Only used when mode is 'execute'.
attached_file_namestringOptionalSpecify the name of the file to be attached to the email. Only used when mode is 'execute'.
send_vendor_payment_attachmentbooleanOptionalSet to true to include the vendor payment attachment in the email. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'email_vendor_payment'.
#

ZohoBooksApi.SetInvoiceAttachmentPreference

Set the email attachment preference for an invoice. This tool updates whether an attached file should be sent when emailing a specific invoice in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books.
invoice_identifierstringRequiredUnique identifier for the specific invoice to update attachment preference.
send_attachment_with_emailbooleanRequiredSet to true to send the attachment with the invoice when emailed.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_attachment_preference'.
#

ZohoBooksApi.SetPrimaryLocation

Marks a specified location as primary in Zoho Books. Use this tool to designate a specific location as the primary one in Zoho Books. This is useful for managing location preferences and ensuring the correct primary location is set.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization for which to set the primary location in Zoho Books.
location_identifierstringRequiredUnique identifier of the location to be marked as primary.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_location_primary'.
#

ZohoBooksApi.SetSalesOrderAttachmentPreference

Sets attachment preference for sales order emails. Use this tool to set whether an attached file should be sent when emailing a sales order. Call this when you need to update the attachment settings on a specific sales order.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization for which you want to update the attachment preference.
sales_order_idstringRequiredUnique identifier of the sales order to update.
allow_attachment_in_emailbooleanRequiredIndicate if the file can be sent in the email. Set to true to allow, false to prevent.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_attachment_preference1'.
#

ZohoBooksApi.StartTimeTracking

Initiate time tracking for a specific entry. Use this tool to start tracking time for a given time entry in Zoho Books. It should be called when you need to begin or resume tracking time on a project task.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredID of the organization for which the time tracking is to be started.
time_entry_identifierstringRequiredUnique identifier for the specific time entry to be tracked.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'start_entry_timer'.
#

ZohoBooksApi.Stop1099TrackingForVendor

Stop 1099 payment tracking for a vendor in the U.S. Use to disable 1099 reporting for vendor payments in the U.S. organization.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization where 1099 tracking will be stopped.
vendor_contact_idstringRequiredUnique identifier of the vendor contact to stop 1099 tracking.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'untrack_contact_1099'.
#

ZohoBooksApi.StopRecurringBill

Stop an active recurring bill in Zoho Books. Use this tool to stop an active recurring bill in Zoho Books when you need to discontinue ongoing payments. It provides confirmation upon successful stoppage.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID representing the organization in Zoho Books.
recurring_bill_identifierstringRequiredUnique identifier for the recurring bill to be stopped.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'stop_recurring_bill'.
#

ZohoBooksApi.StopRecurringExpense

Stop an active recurring expense in Zoho Books. This tool is used to stop an active recurring expense in Zoho Books. It should be called when a user wants to terminate a recurring payment schedule associated with an expense.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books for which the recurring expense will be stopped.
recurring_expense_identifierstringRequiredUnique identifier for the recurring expense to be stopped.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'stop_recurring_expense'.
#

ZohoBooksApi.StopRecurringInvoice

Stop an active recurring invoice in Zoho Books. Use this tool to stop an active recurring invoice by providing the recurring invoice ID. This tool is useful for managing billing cycles when you need to halt a recurring charge. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization for which the recurring invoice is to be stopped. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
recurring_invoice_idstringOptionalThe unique identifier for the recurring invoice to be stopped. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'stop_recurring_invoice'.
#

ZohoBooksApi.StopTimeTracking

Stop the timer for a time entry. Use this tool to stop tracking time for a specific task or activity, such as when taking a break or ending a work session.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization where the time entry is being stopped. This ID is required to specify which organization's time tracking should be affected.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'stop_entry_timer'.
#

ZohoBooksApi.SubmitBillForApproval

Submit a bill for approval in Zoho Books. Use this tool to submit a specific bill for approval in Zoho Books by providing the bill ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization in Zoho Books for which the bill is being submitted.
bill_identifierstringRequiredUnique identifier of the bill to be submitted for approval.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'submit_bill'.
#

ZohoBooksApi.SubmitCreditNoteForApproval

Submit a credit note for approval in Zoho Books. Call this tool to submit a credit note for approval in Zoho Books using the credit note ID.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredProvide the ID of the organization for which the credit note is being submitted for approval.
credit_note_idstringRequiredUnique identifier of the credit note to submit for approval in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'submit_credit_note'.
#

ZohoBooksApi.SubmitEstimateForApproval

Submit an estimate for approval. Use this tool to submit a specific estimate for approval by providing the estimate ID. It facilitates the approval workflow for estimates in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books that the estimate belongs to.
estimate_identifierstringRequiredUnique identifier of the estimate to be submitted for approval.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'submit_estimate'.
#

ZohoBooksApi.SubmitInvoiceForApproval

Submit an invoice for approval in Zoho Books. This tool allows users to submit an invoice for approval using the Zoho Books API. It should be called when an invoice is ready to be reviewed.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization in Zoho Books.
invoice_unique_idstringRequiredThe unique identifier for the invoice to be submitted for approval.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'submit_invoice'.
#

ZohoBooksApi.SubmitPurchaseOrder

Submit a purchase order for approval. Use this tool to submit a specific purchase order for approval in the Zoho Books system.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization within Zoho Books.
purchase_order_idstringRequiredUnique identifier of the purchase order to be submitted for approval.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'submit_purchase_order'.
#

ZohoBooksApi.SubmitRetainerInvoice

Submit a retainer invoice for approval in Zoho Books. Use this tool to submit a specific retainer invoice for approval in Zoho Books. Call this tool when you need to send a retainer invoice for review and approval.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization in Zoho Books to which the retainer invoice belongs.
retainer_invoice_unique_idstringRequiredUnique identifier of the retainer invoice for submission.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'submit_retainer_invoice'.
#

ZohoBooksApi.SubmitSalesOrderForApproval

Submit a sales order for approval in Zoho Books. Use this tool to submit a sales order for approval in the Zoho Books system by providing the sales order ID.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization in Zoho Books where the sales order is submitted.
sales_order_idstringRequiredUnique identifier of the sales order to be submitted for approval.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'submit_sales_order'.
#

ZohoBooksApi.SubmitVendorCreditForApproval

Submit a vendor credit for approval. This tool submits a specified vendor credit for approval based on its unique ID. Use it to move vendor credits from draft to approval status in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe ID of the organization where the vendor credit is submitted for approval.
vendor_credit_unique_idstringRequiredUnique identifier of the vendor credit to be submitted for approval.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'submit_vendor_credit'.
#

ZohoBooksApi.TrackContactFor1099Reporting

Track a contact for 1099 reporting in Zoho Books. Use this tool to track a contact for 1099 reporting, applicable only when the organization's country is the U.S.A. Ideal for ensuring contacts meet 1099 requirements in financial records.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique identifier for the organization in Zoho Books required for 1099 reporting. This should be the ID specific to the organization tracked in the U.S.A.
contact_unique_idstringRequiredUnique identifier of the contact for 1099 tracking.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'track_contact_1099'.
#

ZohoBooksApi.UncategorizeBankTransaction

Revert a categorized bank transaction to uncategorized. Use this tool to uncategorize a previously categorized bank transaction. Call this when needing to correct or revert the categorization of a transaction in Zoho Books.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books for which the transaction is to be uncategorized.
bank_transaction_idstringRequiredUnique identifier of the bank transaction to uncategorize.
account_id_for_transactionsstringOptionalThe mandatory Account ID for which transactions are to be listed.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'uncategorize_bank_transaction'.
#

ZohoBooksApi.UnmatchBankTransaction

Unmatch a previously matched bank transaction. Use this tool to unmatch a bank transaction that was previously categorized, reverting it to an uncategorized state.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization for which the transaction unmatching is to be performed.
transaction_idstringRequiredThe unique identifier of the bank transaction to be unmatched.
account_id_for_transactionsstringOptionalThe mandatory ID of the account for which transactions are to be unlisted. This is essential to specify the correct account involved in the transaction.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'unmatch_bank_transaction'.
#

ZohoBooksApi.UpdateAccountInfo

Updates account information in Zoho Books. This tool updates the chart of account details for a specified account in Zoho Books. It should be called when account information needs modification, such as changing account names, codes, or related details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe ID of the organization for which the account will be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
account_identifierstringOptionalUnique identifier for the account to update in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_chart_of_account'.
#

ZohoBooksApi.UpdateBankAccountRule

Update or modify a bank account rule in Zoho Books. This tool updates an existing bank account rule in Zoho Books. It should be called when you need to make changes to a rule, either by adding new criteria or modifying existing ones. The tool provides confirmation once the rule update is successful. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization in Zoho Books for which the bank account rule needs to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bank_account_rule_idstringOptionalUnique identifier for the bank account rule to update in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_bank_account_rule'.
#

ZohoBooksApi.UpdateBankAccountZohoBooks

Modify a bank account in Zoho Books. Use this tool to update details of an existing bank account in Zoho Books. It should be called when there's a need to modify account information such as account name or details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization to be modified. Required for identifying the specific organization's bank account. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bank_account_idstringOptionalUnique identifier of the bank account to be updated in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_bank_account'.
#

ZohoBooksApi.UpdateBankTransaction

Update details of a specific bank transaction. This tool updates the specified bank transaction with the provided information. Call this tool to make changes to existing transaction details in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier of the organization in Zoho Books for which the bank transaction is being updated. This is required to specify the organization context for the transaction update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bank_transaction_identifierstringOptionalUnique identifier for the specific bank transaction to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_bank_transaction'.
#

ZohoBooksApi.UpdateBillByCustomField

Update or create a bill using a custom field identifier. Use this tool to update an existing bill or create a new one by specifying a custom field's unique value. The tool retrieves the bill based on the custom field value provided. If the bill is not found and the X-Upsert option is enabled, a new bill will be created with the provided details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization for which the bill is to be updated or created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_identifier_keystringOptionalSpecify the API name of the custom field with unique values for identifying the bill. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
custom_field_unique_valuestringOptionalProvide the unique value from the custom field to identify and update the specific bill. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
enable_upsertbooleanOptionalSet to true to enable upsert functionality. Creates a new bill if no existing bill matches the custom field value. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_bill_using_custom_field'.
#

ZohoBooksApi.UpdateBillingAddress

Updates the billing address for a specified bill. This tool is used to update the billing address associated with a specific bill. It should be called when there's a need to modify the billing address details of an existing bill. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization for which the billing address is being updated. This identifier is necessary to access specific organizational data. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bill_unique_identifierstringOptionalProvide the unique identifier for the bill to update its billing address. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_bill_billing_address'.
#

ZohoBooksApi.UpdateBillingAddressRetainerInvoice

Update billing address for a retainer invoice. This tool updates the billing address associated with a specific retainer invoice. It should be used when there's a need to change the billing address for a particular invoice without affecting other records. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. Required to specify which organization's invoice needs updating. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
retainer_invoice_idstringOptionalUnique identifier of the retainer invoice to update the billing address. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_retainer_invoice_billing_address'.
#

ZohoBooksApi.UpdateBillInZoho

Updates a bill by modifying details in Zoho Books. This tool is used to update a bill in Zoho Books. It allows you to modify details or remove line items by excluding them from the list. Call this tool when you need to make changes to an existing bill. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books. Required for updating a bill. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bill_unique_identifierstringOptionalThe unique identifier for the bill to be updated in Zoho Books. Ensure this matches the bill you intend to modify. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
file_attachmentstringOptionalFile to attach. Allowed extensions: gif, png, jpeg, jpg, bmp, pdf. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_bill'.
#

ZohoBooksApi.UpdateBusinessContact

Update detailed information for an existing business contact. Use this tool to modify comprehensive details of an existing contact, including addresses, contact persons, and payment terms. Useful for keeping contact information up-to-date with the latest business details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization to which the contact belongs. This is required for identifying the organization context for the update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
contact_idstringOptionalUnique identifier for the contact to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_contact'.
#

ZohoBooksApi.UpdateContactAddress

Edit the additional address of a contact. Use this tool to update the additional address associated with a contact in Zoho Books. It requires the contact ID and address ID to specify the contact and address to be updated. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books. This is required to specify which organization's contact address needs updating. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
contact_identifierstringOptionalUnique identifier of the contact to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
address_identifierstringOptionalUnique identifier of the address to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_contact_address'.
#

ZohoBooksApi.UpdateContactByCustomField

Update a contact using a unique custom field value. This tool updates or creates a contact in Zoho Books based on a unique custom field value. Use it when you need to modify a contact using a non-duplicate custom field value, or create a new contact if the unique value isn't found and upsert is enabled. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization in Zoho Books. This is required to specify which organization's records to update or create. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
custom_field_api_namestringOptionalThe API name of the unique custom field used to identify the contact. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_valuestringOptionalThe unique value of the custom field used to identify the contact. Must be a non-duplicate value. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
create_contact_if_not_foundbooleanOptionalSet to true to create a new contact if the unique custom field value isn't found. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_contact_using_custom_field'.
#

ZohoBooksApi.UpdateContactPerson

Update an existing contact person's details. Use this tool to update the details of an existing contact person in the system. This is useful when changes to contact information are needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique ID representing the organization whose contact person is being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
contact_person_identifierstringOptionalUnique identifier for the contact person to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_contact_person'.
#

ZohoBooksApi.UpdateCreditNoteBillingAddress

Update the billing address for a specific credit note. This tool updates the billing address associated with an existing credit note in Zoho Books. It should be called when a change in billing information for a specific credit note is required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization in Zoho Books. Required to specify which organization's data is being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
credit_note_identifierstringOptionalA unique identifier for the credit note to update its billing address. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_credit_note_billing_address'.
#

ZohoBooksApi.UpdateCreditNoteDetails

Update details of an existing credit note. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. Required to specify which organization's credit note to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
credit_note_unique_identifierstringOptionalUnique identifier for the credit note to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
ignore_auto_number_generationbooleanOptionalSet to true to provide your own credit note number instead of using the auto-generated one. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_credit_note'.
#

ZohoBooksApi.UpdateCreditNoteShippingAddress

Updates the shipping address of an existing credit note. Use this tool to update the shipping address for a specific credit note. Call this when you need to change the recipient's address on a credit note document. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalID of the organization to which the credit note belongs. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
credit_note_idstringOptionalUnique identifier of the credit note to update the shipping address for. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_credit_note_shipping_address'.
#

ZohoBooksApi.UpdateCreditNoteTemplate

Updates the PDF template for a specified credit note. Use this tool to change the PDF template associated with a specific credit note by providing the credit note ID and the template ID.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredUnique identifier for the organization. Required to specify which organization's credit note template will be updated.
credit_note_idstringRequiredUnique identifier of the credit note to be updated.
credit_note_template_idstringRequiredUnique identifier of the credit note template to be updated.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_credit_note_template'.
#

ZohoBooksApi.UpdateCreditNoteWithCustomField

Update or create a credit note using a custom field. Use this tool to modify an existing credit note or create a new one with unique values in custom fields. If the specified unique value doesn't match any existing credit note and upsert is enabled, a new credit note will be created given the necessary details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization to which the credit note belongs. This identifies the target organization for the update or creation operation. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_keystringOptionalThe API name of the unique custom field used to identify the credit note. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
custom_field_unique_valuestringOptionalThe unique value for the custom field used to identify the credit note to update or create. Ensure this matches the specific custom field's unique value constraints. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
create_new_credit_note_if_not_foundbooleanOptionalSet to true to create a new credit note if the unique custom field value isn't found in existing credit notes. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_credit_note_using_custom_field'.
#

ZohoBooksApi.UpdateCurrencyDetails

Update the details of a currency in Zoho Books. Use this tool to update information for a specific currency in Zoho Books by providing the currency ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization for which the currency details are being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
currency_unique_identifierstringOptionalUnique identifier of the currency to be updated in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_currency'.
#

ZohoBooksApi.UpdateCustomerDebitNote

Update an existing customer debit note. Use this tool to update details of an existing customer debit note in Zoho Books. Remove a line item by omitting it from the line_items list. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalOrganization ID for the request within Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
debit_note_unique_identifierstringOptionalUnique identifier for the debit note to be updated in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
ignore_auto_number_generationbooleanOptionalSet to true to ignore automatic debit note number generation, requiring manual input of the debit note number. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_customer_debit_note'.
#

ZohoBooksApi.UpdateCustomerPaymentCustomFields

Update custom fields in existing customer payments. Use this tool to update the values of custom fields in an existing customer payment in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization to which the customer payment belongs. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
customer_payment_identifierstringOptionalThe unique identifier for the customer payment you wish to update custom fields for. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_custom_fields_in_customer_payment'.
#

ZohoBooksApi.UpdateCustomerPaymentInfo

Update an existing payment information. Use this tool to update payment information for a customer when any corrections or modifications are needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization for which the payment update is requested. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
payment_unique_identifierstringOptionalThe unique identifier for the payment to be updated. Use this to specify which payment you want to modify. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_customer_payment'.
#

ZohoBooksApi.UpdateCustomFieldsInBill

Update custom fields in existing bills. This tool is used to update the value of custom fields in existing bills. It should be called when you need to change or add information to the custom fields of a specific bill identified by its bill ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization for which the bill's custom fields are being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
bill_identifierstringOptionalUnique identifier of the bill to update its custom fields. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_custom_fields_in_bill'.
#

ZohoBooksApi.UpdateCustomFieldsPurchaseOrder

Update custom field values in purchase orders. This tool updates the values of custom fields within existing purchase orders in Zoho Books. It should be called when there is a need to modify or update custom information in a specific purchase order. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique ID of the organization associated with the purchase order. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
purchase_order_idstringOptionalA unique identifier for the purchase order to update custom fields. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_custom_fields_in_purchase_order'.
#

ZohoBooksApi.UpdateCustomModuleRecord

Update an existing custom module in Zoho Books. Use this tool to update an existing custom module record in Zoho Books by specifying the module name and module ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
module_namestringOptionalThe name of the custom module to be updated in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
custom_module_idintegerOptionalThe ID of the custom module to be updated in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_custom_module_record'.
#

ZohoBooksApi.UpdateCustomModuleRecords

Updates existing custom module records in bulk. Use this tool to update multiple records in a custom module efficiently. This is useful for making uniform changes across a set of records within a specified module. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization that owns the module records to be updated. This ID is required to specify which organization's records are being modified. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
module_namestringOptionalSpecify the name of the custom module to update records in bulk. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'bulk_update_custom_module_records'.
#

ZohoBooksApi.UpdateEstimate

Update an existing estimate in Zoho Books. Use this tool to modify an existing estimate in Zoho Books. When updating, you can remove a line item by excluding it from the line_items list. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization whose estimate needs updating. It should be a unique identifier in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
estimate_unique_idstringOptionalUnique identifier for the estimate you want to update in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
ignore_auto_number_generationbooleanOptionalSet to true to ignore auto generation of estimate numbers and manually specify the estimate number. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_estimate'.
#

ZohoBooksApi.UpdateEstimateBillingAddress

Updates the billing address for a specific estimate. Use this tool to update the billing address for a specific estimate in Zoho Books. Call this tool when there's a need to change the billing details associated with an individual estimate. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier of the organization in Zoho Books. Required to specify the organization whose estimate billing address is to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
estimate_identifierstringOptionalUnique identifier of the estimate to update the billing address. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_estimate_billing_address'.
#

ZohoBooksApi.UpdateEstimateComment

Update an existing comment on an estimate. Use this tool to update a specific comment associated with an estimate in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe ID representing the organization. Required to update the comment in the specified organization's estimate. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
estimate_identifierstringOptionalUnique identifier of the estimate to update the comment for. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
comment_unique_identifierstringOptionalThe unique identifier of the comment to be updated on an estimate. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_estimate_comment'.
#

ZohoBooksApi.UpdateEstimateCustomFields

Update custom fields in a specific estimate. This tool updates the values of custom fields in an existing estimate. It should be called when you need to modify or add information to custom fields of a particular estimate. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization whose estimate custom fields are being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
estimate_identifierstringOptionalUnique identifier for the estimate to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_custom_fields_in_estimate'.
#

ZohoBooksApi.UpdateEstimateShippingAddress

Updates the shipping address for an existing estimate in Zoho Books. This tool is used to update the shipping address for a specific estimate in the Zoho Books system. It should be called when there's a need to modify the delivery details associated with an existing estimate. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization in Zoho Books whose estimate's shipping address is to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
estimate_identifierstringOptionalUnique identifier of the estimate to update its shipping address. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_estimate_shipping_address'.
#

ZohoBooksApi.UpdateEstimateTemplate

Update the PDF template for an estimate. Use this tool to update the PDF template associated with a specific estimate in Zoho Books by providing the estimate and template IDs.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization for which the estimate template is being updated.
estimate_identifierstringRequiredProvide the unique identifier for the specific estimate you want to update.
estimate_template_identifierstringRequiredUnique identifier for the estimate template to update in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_estimate_template'.
#

ZohoBooksApi.UpdateEstimateWithCustomField

Update or create an estimate using a custom field value. This tool allows updating an existing estimate by providing a unique custom field value. If the value does not match any existing estimates and the X-Upsert header is true, a new estimate will be created if required details are provided. Use this tool to maintain estimates based on unique identifiers. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalProvide the ID of the organization for which the estimate is being updated or created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_api_namestringOptionalThe API name of the custom field used to uniquely identify and update an estimate. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_valuestringOptionalThe unique value of the custom field used to identify and update the estimate. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
create_new_estimate_if_not_foundbooleanOptionalSet to true to create a new estimate if no existing record matches the custom field value. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_estimate_using_custom_field'.
#

ZohoBooksApi.UpdateExchangeRate

Update exchange rate details for a currency in Zoho Books. This tool updates the exchange rate for a specified currency in Zoho Books. It should be called when you need to modify the exchange rate details, usually for financial reports, accounting adjustments, or compliance with real-time rates. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization for which the exchange rate is being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
currency_unique_identifierstringOptionalUnique identifier for the currency you want to update the exchange rate for. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
exchange_rate_identifierstringOptionalUnique identifier for the exchange rate to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_exchange_rate'.
#

ZohoBooksApi.UpdateExistingExpense

Update an existing expense in Zoho Books. Use this tool to modify details of an existing expense in Zoho Books. It should be called when you need to change information such as amount, date, or description of a recorded expense. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization. Required to identify which organization's expense is being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
expense_identifierstringOptionalThe unique identifier for the expense to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
expense_receipt_filestringOptionalFile path of the expense receipt to attach. Allowed extensions are gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc, and docx. Ensure the file is accessible and in an accepted format. Only used when mode is 'execute'.
delete_receiptbooleanOptionalSet to true to remove the attached receipt from the expense. Use false to keep it. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_expense'.
#

ZohoBooksApi.UpdateExpenseWithCustomField

Update or create an expense using custom field values. This tool updates an existing expense based on a unique custom field value. If the unique value doesn't match any existing expenses, and the X-Upsert header is true, a new expense will be created if all required details are provided. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization for which the expense update is intended. It is required to identify the target organization in the API. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
custom_field_api_namestringOptionalAPI name of the unique custom field used to identify the expense. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_valuestringOptionalThe unique value for the custom field used to update or create an expense. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
allow_upsert_new_expensebooleanOptionalSet to true to create a new expense if no matching unique custom field value is found. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_expense_using_custom_field'.
#

ZohoBooksApi.UpdateFixedAssetInfo

Update fixed asset details in Zoho Books. Use this tool to update the information of a specific fixed asset in Zoho Books by providing the necessary asset details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization whose fixed asset you wish to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
fixed_asset_identifierstringOptionalUnique identifier for the specific fixed asset to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_fixed_asset'.
#

ZohoBooksApi.UpdateFixedAssetType

Update a fixed asset type with new information. Use this tool to update the details of a fixed asset type by providing the relevant asset type ID and new information. It should be called when modifying asset categories in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
fixed_asset_type_identifierstringOptionalUnique identifier for the fixed asset type to be updated in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_fixed_asset_type'.
#

ZohoBooksApi.UpdateInvoice

Update details of an existing invoice in Zoho Books. Use this tool to modify the details of an existing invoice. If you need to remove a line item, simply exclude it from the line_items list. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization to which the invoice belongs. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
invoice_idstringOptionalUnique identifier of the invoice to be updated. Ensure this ID corresponds to an existing invoice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
ignore_auto_invoice_number_generationbooleanOptionalSet to true to ignore automatic invoice number generation, requiring manual entry of the invoice number. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_invoice'.
#

ZohoBooksApi.UpdateInvoiceByCustomField

Update or create an invoice using a custom field value. Call this tool to update an existing invoice or create a new one using a custom field's unique value. If the value is not found and X-Upsert is true, a new invoice will be created if all required details are provided. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. This is required to specify which organization's invoice should be updated or created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_api_namestringOptionalThe API name of the unique custom field used to locate the invoice to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
custom_field_valuestringOptionalThe unique value of the custom field used to find or create the invoice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
create_new_invoice_if_not_foundbooleanOptionalSet to true to create a new invoice if the unique custom field value is not found in existing invoices. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_invoice_using_custom_field'.
#

ZohoBooksApi.UpdateInvoiceComment

Update an existing comment on an invoice. Use this tool to update a specific comment on an invoice by providing the invoice and comment IDs. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalID of the organization for which the invoice comment needs to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
invoice_unique_idstringOptionalUnique identifier for the invoice to update its comment. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
comment_idstringOptionalUnique identifier of the comment to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_invoice_comment'.
#

ZohoBooksApi.UpdateInvoiceCustomFields

Update custom fields in an existing invoice. Use this tool to modify the value of custom fields in a specified invoice. It should be called when you need to change or update custom information for invoice records. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization to which the invoice belongs. This is required to identify the correct organization context for the invoice update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
invoice_identifierstringOptionalUnique identifier of the invoice to update custom fields. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_custom_fields_in_invoice'.
#

ZohoBooksApi.UpdateInvoiceShippingAddress

Update the shipping address of a specific invoice. Use this tool to update the shipping address associated with a specific invoice in Zoho Books. It is used when there's a need to modify the shipping information for an invoice after it has been created. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier of the organization in Zoho Books. Required to specify which organization's invoice will be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
invoice_unique_identifierstringOptionalUnique identifier of the invoice to update the shipping address. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_invoice_shipping_address'.
#

ZohoBooksApi.UpdateInvoiceTemplate

Update the PDF template for a specific invoice. Use this tool to update the PDF template associated with a particular invoice. This is useful when you need to change the template style or format of an invoice after it has been issued.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredProvide the ID of the organization for which the invoice template is being updated.
invoice_identifierstringRequiredUnique identifier for the invoice to update the PDF template.
invoice_template_idstringRequiredUnique identifier for the invoice template to be updated.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_invoice_template'.
#

ZohoBooksApi.UpdateItemCustomFields

Updates custom fields in an existing item. Use this tool to update the value of custom fields in existing items. Call it when you need to modify specific custom field information for an item record in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization associated with the item. This is required to specify which organization's item custom fields should be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
item_identifierstringOptionalProvide the unique identifier for the item to update its custom fields. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_custom_fields_in_item'.
#

ZohoBooksApi.UpdateItemViaCustomField

Update or create an item using a unique custom field. Use this tool to update an existing item or create a new one based on a unique custom field value in Zoho Books. If the custom field value matches, the item is updated; otherwise, a new item is created if allowed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books. This ID is used to specify which organization's data you are trying to access or modify. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_api_namestringOptionalThe API name of the unique custom field used for identifying the item. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_valuestringOptionalThe unique value of the custom field used to identify or create an item in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
create_item_if_not_foundbooleanOptionalSet to true to create a new item if no item matches the unique custom field value. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_item_using_custom_field'.
#

ZohoBooksApi.UpdateJournalInZohoBooks

Updates a journal entry in Zoho Books with specified details. This tool updates an existing journal entry in Zoho Books using the provided details. It should be called when a user needs to modify a journal entry in their Zoho Books account. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization in Zoho Books. Required for identifying which organization's journal entry to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
journal_identifierstringOptionalThe unique identifier for the journal entry to be updated in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_journal'.
#

ZohoBooksApi.UpdateLocationInZohoBooks

Update location details in Zoho Books. Use this tool to update location details in Zoho Books by specifying the location ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization in Zoho Books. It is required to identify which organization's location is being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
location_identifierstringOptionalUnique identifier of the location to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_location'.
#

ZohoBooksApi.UpdateOpeningBalance

Update the existing opening balance information. This tool is used to update the existing opening balance information in Zoho Books. It should be called when there is a need to modify or correct the initial financial figures recorded in the system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. Required for updating the opening balance information. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_opening_balance'.
#

ZohoBooksApi.UpdateOrganizationDetails

Update an organization's details in Zoho Books. This tool updates the details of an organization in Zoho Books. It should be called when you need to modify existing information about a specific organization. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalUnique identifier of the organization to update in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
organization_identifierstringOptionalThe unique string identifier for the organization to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_organization'.
#

ZohoBooksApi.UpdatePaymentByCustomField

Update or upsert a customer payment using a unique custom field. Use this tool to update an existing customer payment or create a new one if it doesn't exist, by specifying a unique value from a custom field. The unique custom field value helps identify the payment to update. If upsert is enabled, a new payment will be created when the unique value is not found. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization whose payment is being updated or created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_api_namestringOptionalAPI name of the unique custom field used to identify the payment. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_valuestringOptionalThe unique value of the custom field used to identify or create a payment. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
create_new_payment_if_not_foundbooleanOptionalSet to true to create a new payment when no matching unique custom field value is found. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_customer_payment_using_custom_field'.
#

ZohoBooksApi.UpdatePaymentRefund

Update details of a customer payment refund. This tool updates the details of a refunded transaction for a customer payment in Zoho Books. It should be called when you need to modify existing refund details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books. Required to access the organization's data. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
customer_payment_identifierstringOptionalUnique identifier of the customer payment to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
refund_identifierstringOptionalUnique identifier for the refund transaction to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_customer_payment_refund'.
#

ZohoBooksApi.UpdateProjectDetails

Update details of a project in Zoho Books. This tool is called to update the details of a specific project within Zoho Books. It should be used when you need to modify project information such as its name, status, or any other attributes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization within Zoho Books, required to identify the organization whose project is being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
project_unique_identifierstringOptionalUnique identifier of the project to be updated in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_project'.
#

ZohoBooksApi.UpdateProjectTask

Update the details of a project task. Use this tool to update the details of a specific task within a project in Zoho Books. It should be called when you need to change task information such as its status, due date, or other attributes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization in Zoho Books to identify the context for the task update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
project_identifierstringOptionalUnique identifier of the project in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
task_identifierstringOptionalUnique identifier of the task to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_task'.
#

ZohoBooksApi.UpdateProjectUserDetails

Update user details in a specific project. Use this tool to update details of a user within a specified project in Zoho Books. It confirms the changes made to the user's information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. Required to update the user's project details. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
project_identifierstringOptionalUnique identifier for the project in Zoho Books. Required to specify which project's user details are being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
user_identifierstringOptionalUnique identifier for the user to be updated within the project. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_project_user'.
#

ZohoBooksApi.UpdateProjectWithCustomField

Update or create projects using a unique custom field. This tool updates an existing project or creates a new one if no match is found, using a unique custom field value in Zoho Books. Utilize it when you need to modify projects with specific identifiers. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalA string representing the organization's ID required to update or create a project using the custom field. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_api_namestringOptionalThe API name of the unique custom field used to identify the project. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_valuestringOptionalThe unique value for the custom field used to identify or create a project. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
create_new_project_if_not_foundbooleanOptionalSet to true to create a new project if no existing project matches the unique custom field value. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_projects_using_custom_field'.
#

ZohoBooksApi.UpdatePurchaseOrder

Update an existing purchase order in Zoho Books. Use this tool to update details of a specific purchase order in Zoho Books. It should be called when changes to a purchase order need to be made. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization for which the purchase order is being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
purchase_order_identifierstringOptionalUnique identifier for the specific purchase order to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
attachment_file_pathstringOptionalFile path of the attachment with extensions: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc, docx. Only used when mode is 'execute'.
ignore_auto_number_generationbooleanOptionalIf true, ignore automatic purchase order number generation and manually specify the order number. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_purchase_order'.
#

ZohoBooksApi.UpdatePurchaseOrderBillingAddress

Update the billing address for a specific purchase order. Use this tool to modify the billing address of a single purchase order in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization to update the billing address in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
purchase_order_identifierstringOptionalUnique identifier for the specific purchase order to update the billing address. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_purchase_order_billing_address'.
#

ZohoBooksApi.UpdatePurchaseOrderByCustomField

Update or create a purchase order via custom field value. Use this tool to update an existing purchase order or create a new one if needed, based on a unique custom field value. It should be called when you need to modify a purchase order by using a custom field's unique identifier. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. This is required to specify which organization's purchase order needs to be updated or created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_api_namestringOptionalThe API name of the unique custom field used to update or identify the purchase order. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_valuestringOptionalUnique value for the custom field to retrieve and update the purchase order. This should match the specific custom field value used to identify the order. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
create_new_order_if_not_foundbooleanOptionalSet to true to create a new purchase order if no existing order matches the unique custom field value. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_purchase_order_using_custom_field'.
#

ZohoBooksApi.UpdatePurchaseOrderComment

Update an existing comment on a purchase order. Use this tool to update a specific comment on a purchase order in Zoho Books. It should be called when you need to modify or correct information in a comment related to a purchase order. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID representing the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
purchase_order_idstringOptionalThe unique identifier for the purchase order to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
comment_identifierstringOptionalUnique identifier of the comment to be updated in the purchase order. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_purchase_order_comment'.
#

ZohoBooksApi.UpdatePurchaseOrderEmailAttachment

Update email attachment preference for a purchase order. This tool updates the preference to include or exclude the attached file when emailing a specific purchase order. It should be called when you need to change whether the attachment is sent via email for a particular purchase order.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization for which the purchase order email attachment preference is being updated.
purchase_order_idstringRequiredUnique identifier of the purchase order to update the email attachment preference for.
include_attachment_with_emailbooleanRequiredBoolean to determine if the attachment should be sent with the purchase order email. Set to true to include the attachment, or false to exclude it.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_purchase_order_attachment'.
#

ZohoBooksApi.UpdateRecurringBill

Update details of a recurring bill in Zoho Books. Use this tool to update a recurring bill in Zoho Books. Modify its details including line items by removing them from the list if needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization in Zoho Books. This ID is required to specify the organization whose recurring bill is being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
recurring_bill_identifierstringOptionalUnique identifier for the recurring bill to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_recurring_bill'.
#

ZohoBooksApi.UpdateRecurringBillCustomField

Update or create a recurring bill using a unique custom field. This tool updates a recurring bill by identifying it through a custom field with a unique value. If the unique value does not match any existing recurring bills and the X-Upsert header is true, a new bill will be created if the necessary details are provided. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization associated with the recurring bill. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
custom_field_unique_identifier_keystringOptionalThe API name of the unique custom field used to identify the recurring bill. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_valuestringOptionalUnique value of the custom field used to identify the recurring bill. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
allow_creation_if_missingbooleanOptionalSet to true to create a new recurring bill if the unique custom field value is not found. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_recurring_bill_using_custom_field'.
#

ZohoBooksApi.UpdateRecurringExpense

Update or create a recurring expense using a custom field. Use this tool to update a recurring expense in Zoho Books by specifying a unique custom field value. If the expense doesn't exist and upsert is enabled, a new expense can be created. This is useful for maintaining accurate financial records. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalUnique identifier for the organization whose recurring expense is to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_api_namestringOptionalUnique CustomField API Name to identify the recurring expense. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_valuestringOptionalUnique value of the CustomField used to identify the recurring expense. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
create_new_recurring_if_not_foundbooleanOptionalSet to true to create a new recurring expense if the unique custom field value is not found. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_recurring_expense_using_custom_field'.
#

ZohoBooksApi.UpdateRecurringInvoice

Update details of a recurring invoice in Zoho Books. Use this tool to modify an existing recurring invoice in Zoho Books by specifying the invoice ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique ID of the organization in Zoho Books. Required for updating a recurring invoice. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
recurring_invoice_idstringOptionalUnique identifier of the recurring invoice to be updated in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_recurring_invoice'.
#

ZohoBooksApi.UpdateRecurringInvoiceCustomField

Update or create a recurring invoice using a custom field. This tool updates an existing recurring invoice or creates a new one using a custom field's unique value. Use when you need to update invoices based on unique custom identifiers. If the unique key isn't found and the upsert option is true, a new invoice is created. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. This ID is required to update or create a recurring invoice using the custom field. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_api_namestringOptionalThe unique API name of the custom field used to identify which recurring invoice to update or create. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_valuestringOptionalThe unique value for the custom field used to identify and update the recurring invoice. This should be a unique string associated with a custom field configured to reject duplicates. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
enable_upsertbooleanOptionalSet to true to create a new invoice if no existing invoice matches the unique identifier. Set to false to update only without creating a new invoice. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_recurring_invoice_using_custom_field'.
#

ZohoBooksApi.UpdateRecurringInvoiceTemplate

Update the PDF template for a recurring invoice. This tool updates the PDF template associated with a specific recurring invoice in Zoho Books. It is used when you need to change the template for invoices that are generated on a recurring basis. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique identifier of the organization. This ID is used to specify which organization's recurring invoice template will be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
recurring_invoice_identifierstringOptionalUnique identifier of the recurring invoice to update the PDF template for. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
invoice_template_idstringOptionalUnique identifier of the recurring invoice template to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_recurring_invoice_template'.
#

ZohoBooksApi.UpdateRefundTransaction

Update the refunded transaction details. Use this tool to update the details of a refunded transaction associated with a specific credit note. This is helpful when corrections or updates are needed for bookkeeping or record maintenance. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization. Required to identify which organization's records are being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
credit_note_identifierstringOptionalUnique identifier of the credit note to update the refund transaction. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
credit_note_refund_idstringOptionalProvide the unique identifier of the credit note refund to update its transaction details. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_credit_note_refund'.
#

ZohoBooksApi.UpdateRetainerInvoiceComment

Update a comment on a retainer invoice. Use this tool to update an existing comment of a retainer invoice by specifying the invoice and comment IDs. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization to which the retainer invoice belongs. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
retainer_invoice_idstringOptionalUnique identifier of the retainer invoice to update the comment for. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
comment_identifierstringOptionalThe unique identifier of the comment to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_retainer_invoice_comment'.
#

ZohoBooksApi.UpdateSalesOrderBillingAddress

Updates the billing address for a specific sales order. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization associated with the sales order. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
sales_order_identifierstringOptionalUnique identifier of the sales order to update the billing address for. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_sales_order_billing_address'.
#

ZohoBooksApi.UpdateSalesOrderComment

Update an existing comment on a sales order. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique ID of the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
sales_order_idstringOptionalUnique identifier of the sales order to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
comment_idstringOptionalUnique identifier of the comment associated with the sales order that needs to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_sales_order_comment'.
#

ZohoBooksApi.UpdateSalesOrderCustomFields

Update custom fields in existing sales orders efficiently. Call this tool to update the value of custom fields in existing sales orders when you need to modify order details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization associated with the sales order. This is required to identify which organization's sales order needs updating. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
sales_order_idstringOptionalUnique identifier for the sales order to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_salesorder_customfields'.
#

ZohoBooksApi.UpdateSalesOrderInZohoBooks

Update details of an existing sales order in Zoho Books. Use this tool to update the details of an existing sales order in Zoho Books. It also allows for the deletion of line items by omitting them from the update request. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization to which the sales order belongs. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
sales_order_idstringOptionalUnique identifier of the sales order to update in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
total_number_of_filesintegerOptionalSpecify the total number of files to be attached to the sales order update. Only used when mode is 'execute'.
attach_documentstringOptionalA document to be attached to the sales order. Provide the file path or URL as a string. Only used when mode is 'execute'.
ignore_auto_number_generationbooleanOptionalSet to TRUE to ignore auto-generation of the sales order number. This requires manually entering the number. Only used when mode is 'execute'.
allow_email_sendingbooleanOptionalDetermine if the updated sales order can be sent via email. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_sales_order'.
#

ZohoBooksApi.UpdateSalesOrderSubStatus

Update the sub status of a sales order in Zoho Books. This tool updates the sub status of a specified sales order in Zoho Books, identified by the sales order ID and the new status code. It should be called when you need to change the status of an existing sales order.

Parameters

ParameterTypeReq.Description
organization_identifierstringRequiredThe unique ID of the organization in Zoho Books. This ID is required to specify which organization's sales order needs an update.
sales_order_idstringRequiredUnique identifier for the specific sales order to update.
sales_order_status_codestringRequiredThe unique code representing the new status for a sales order. This is required to update the status in Zoho Books.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_sales_order_sub_status'.
#

ZohoBooksApi.UpdateSalesOrderTemplate

Update the PDF template for a sales order. This tool updates the PDF template associated with a specific sales order. Use it when you need to change the template for an existing sales order.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique identifier for the organization associated with the sales order.
sales_order_idstringRequiredUnique identifier for the sales order to be updated with a new PDF template.
sales_order_template_idstringRequiredUnique identifier of the sales order template to update.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_sales_order_template'.
#

ZohoBooksApi.UpdateSalesOrderWithCustomField

Update or create a sales order using a custom field. Use a custom field's unique value to update an existing sales order or create a new one if the order does not exist and the required details are provided. This tool is useful when managing sales orders using specific identifiers in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_api_namestringOptionalThe API name of the unique custom field used to identify the sales order to update or create. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
unique_custom_field_valuestringOptionalThe unique value of the custom field used to retrieve and update a specific sales order. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
allow_creation_if_not_foundbooleanOptionalSet to true to create a new sales order if the unique custom field value is not found. Complete details are required for creation. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_sales_order_using_custom_field'.
#

ZohoBooksApi.UpdateSalesReceipt

Update an existing sales receipt in Zoho Books. This tool is used to update details of an existing sales receipt in Zoho Books. It should be called when modifications to sales receipt data are required, such as changing amounts, dates, or other relevant information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier of the organization in Zoho Books. It is required to specify which organization's sales receipt needs to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
sales_receipt_identifierstringOptionalUnique identifier for the sales receipt to be updated. This is required to specify which receipt to modify. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_sales_receipt'.
#

ZohoBooksApi.UpdateShippingAddressSalesOrder

Update the shipping address for a specific sales order. This tool updates the shipping address for a specific sales order in Zoho Books. It should be called when there's a need to modify the delivery location of an existing order. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe ID of the organization in Zoho Books to update the shipping address for the sales order. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
sales_order_identifierstringOptionalUnique identifier of the sales order to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_sales_order_shipping_address'.
#

ZohoBooksApi.UpdateTaxAuthorityDetails

Update details of a tax authority. Use this tool to update information for a specific tax authority. Ideal for modifications to existing records. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier of the organization for which the tax authority details need to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
tax_authority_identifierstringOptionalUnique identifier of the tax authority to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_tax_authority'.
#

ZohoBooksApi.UpdateTaxDetails

Update the details of a specified tax. Use this tool to update the details of a simple or compound tax by providing the tax ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique identifier for the organization that owns the tax to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
tax_identifierstringOptionalUnique identifier of the tax to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_tax'.
#

ZohoBooksApi.UpdateTaxExemptionDetails

Update the details of a tax exemption. This tool updates the information of a specific tax exemption. It should be called when changes to tax exemption records are needed, such as modifying existing details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier of the organization for which the tax exemption needs to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
tax_exemption_identifierstringOptionalUnique identifier for the tax exemption to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_tax_exemption'.
#

ZohoBooksApi.UpdateTaxGroupDetails

Update details of a specific tax group in Zoho Books. This tool updates the details of a tax group in Zoho Books using the provided tax group ID. It should be called when changes are needed to the tax group's configuration. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique ID of the organization in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
tax_group_identifierstringOptionalUnique identifier of the tax group to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_tax_group'.
#

ZohoBooksApi.UpdateTimeEntry

Updates an existing logged time entry. Use this tool to modify details of a previously logged time entry in Zoho Books. Ideal when adjustments or updates need to be made to existing time logs. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalID of the organization to which the time entry belongs. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
time_entry_identifierstringOptionalUnique identifier of the existing time entry to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_time_entry'.
#

ZohoBooksApi.UpdateUserDetails

Update user details in Zoho Books. Use this tool to update the information of an existing user in Zoho Books. Call it when changes to a user's profile are needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique ID of the organization whose user's details are being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
user_identifierstringOptionalUnique identifier of the user to be updated in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_user'.
#

ZohoBooksApi.UpdateVendorCredit

Update an existing vendor credit in Zoho Books. Use this tool to update the details of a specific vendor credit in Zoho Books. Call this when modifications to vendor credits are needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_identifierstringOptionalThe unique identifier of the organization in Zoho Books. Required to update vendor credit. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
vendor_credit_idstringOptionalThe unique identifier for the vendor credit to be updated. This string is required to locate the specific credit. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_vendor_credit'.
#

ZohoBooksApi.UpdateVendorCreditRefund

Update a refunded vendor credit transaction. Use this tool to update details of a refunded vendor credit transaction by specifying the vendor credit ID and refund ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalUnique identifier for the organization. This is needed to specify which organization the vendor credit refund update applies to. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
vendor_credit_identifierstringOptionalUnique identifier of the vendor credit to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
vendor_credit_refund_identifierstringOptionalUnique identifier for the vendor credit refund transaction that needs to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_vendor_credit_refund'.
#

ZohoBooksApi.UpdateVendorPayment

Update or modify an existing vendor payment. Use this tool to update an existing vendor payment, including modifying the amount applied to bills. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalProvide the specific ID of the organization for which the vendor payment is being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
payment_identifierstringOptionalThe unique identifier of the vendor payment to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_vendor_payment'.
#

ZohoBooksApi.UpdateVendorPaymentRefund

Update the refunded transaction for a vendor payment. Call this tool to update details related to a vendor payment refund. It is used when modifications to an existing refund transaction are necessary. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization associated with the refund transaction. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
payment_identifierstringOptionalUnique identifier of the payment. Required to specify which payment is being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
vendor_payment_refund_idstringOptionalUnique identifier of the vendor payment refund required for updating the transaction. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_vendor_payment_refund'.
#

ZohoBooksApi.UpdateVendorPaymentWithCustomId

Update or create a vendor payment using a unique custom field. This tool updates an existing vendor payment by using a unique custom field as an identifier. If the unique value is not found and the X-Upsert option is enabled, it will create a new vendor payment if sufficient details are provided. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization within Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
custom_field_api_namestringOptionalThe API name of the unique custom field used to identify the vendor payment. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
custom_field_unique_valuestringOptionalThe unique value of the custom field used to identify or create a vendor payment. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
create_new_record_if_not_existsbooleanOptionalSet to true to create a new vendor payment if no existing record matches the unique custom field value. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_vendor_payment_using_custom_field'.
#

ZohoBooksApi.UpdateZohoItemDetails

Update the details of an item in Zoho Books. Use this tool to update item details in Zoho Books by providing the item ID and the new information to be updated. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe ID of the organization in Zoho Books for which the item details are to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
item_identifierstringOptionalUnique identifier of the item to be updated in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'update_item'.
#

ZohoBooksApi.VoidInvoiceStatus

Mark an invoice as void in Zoho Books. Use this tool to change the status of an invoice to void in Zoho Books. This process will unassociate any payments and credits, placing them under customer credits.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books. Required to specify which organization the invoice belongs to.
invoice_unique_identifierstringRequiredUnique identifier for the invoice to be marked as void.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_invoice_void'.
#

ZohoBooksApi.VoidRetainerInvoice

Mark a retainer invoice as void. This tool marks a specified retainer invoice as void, disassociating any payments and credits and moving them under customer credits.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredID of the organization required to identify which organization's invoice to void.
retainer_invoice_idstringRequiredUnique identifier for the retainer invoice to be marked as void.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'mark_retainer_invoice_void'.
#

ZohoBooksApi.WriteOffFixedAsset

Remove a fixed asset from the records. Use this tool to write off a fixed asset. It should be called when an asset needs to be removed from the records in Zoho Books. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
organization_idstringOptionalThe unique identifier for the organization. Required to specify which organization's asset is to be written off. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
fixed_asset_identifierstringOptionalUnique identifier of the fixed asset to be written off in Zoho Books. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'write_off_fixed_asset'.
#

ZohoBooksApi.WriteOffInvoiceBalance

Write off the balance amount of an invoice in Zoho Books. Use this tool to write off the remaining balance of an invoice in Zoho Books when the amount is uncollectible.

Parameters

ParameterTypeReq.Description
organization_idstringRequiredThe unique ID of the organization in Zoho Books.
invoice_identifierstringRequiredThe unique identifier for the invoice to be written off.

Requirements

Secrets:ZOHO_SERVER_URL

Output

Type:json— Response from the API endpoint 'write_off_invoice'.
Last updated on