Skip to main content
Zoho Books logo
  • Category: accounting
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 270
  • Triggers: 0
  • Slug: ZOHO_BOOKS
  • Version: 20261103_00

Tools

Slug: ZOHO_BOOKS_ACCEPT_ESTIMATETool to mark an estimate as accepted. Use after reviewing and confirming the estimate.

Input Parameters

string
required
Unique identifier of the estimate to accept
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_ACTIVATE_BANK_ACCOUNTTool to activate a bank account. Use when you need to reactivate a previously deactivated bank account after confirming its ID.

Input Parameters

string
required
Unique identifier of the bank account to activate.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_ADD_BILL_ATTACHMENTTool to add an attachment to an existing bill in Zoho Books. Use when you need to attach a file to a bill.

Input Parameters

string
required
Unique identifier of the bill to add the attachment to.
object
required
File to attach to the bill. Allowed file types: gif, png, jpeg, jpg, bmp, pdf.
string
required
Zoho Books organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_ADD_BILL_COMMENTTool to add a comment to a bill in Zoho Books. Use when you need to add notes or comments to an existing bill for tracking or collaboration purposes.

Input Parameters

string
required
Unique identifier of the bill.
string
required
The comment text to be added to the bill
string
required
Organization ID for which the bill belongs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_ADD_CONTACT_ADDRESSTool to add an additional address to a contact in Zoho Books. Use when you need to add a new shipping, billing, or other address to an existing contact.

Input Parameters

string
Fax number for the address
string
Postal or ZIP code for the address
string
City name for the address
string
The contact phone number associated with the address
string
State for the address
string
Street 1 address for the contact
string
Country name for the address
string
Street 2 address for the contact
string
Attention for proper delivery and routing of business correspondence
string
required
Unique identifier of the contact
string
State or province code for the address
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_ADD_INVOICE_COMMENTTool to add a comment to an invoice. Use when you need to attach notes or comments to an existing invoice.

Input Parameters

string
required
Unique identifier of the invoice.
string
required
The comment text to add to the invoice
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_ADD_PROJECT_COMMENTTool to add a comment to a project. Use when you need to attach notes or comments to an existing project for tracking or collaboration purposes.

Input Parameters

string
required
Unique identifier of the project.
string
required
The comment text to add to the project
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_ADD_PURCHASE_ORDER_COMMENTTool to add a comment to a purchase order in Zoho Books. Use when you need to add notes or comments to an existing purchase order for tracking or collaboration purposes.

Input Parameters

string
required
The comment text to be added to the purchase order
string
required
Organization ID for which the purchase order belongs.
string
required
Unique identifier of the purchase order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_ADD_SALES_ORDER_COMMENTTool to add a comment to a sales order in Zoho Books. Use when you need to add notes or comments to an existing sales order for tracking or collaboration purposes.

Input Parameters

string
required
The comment text to be added to the sales order
string
required
Unique identifier of the sales order.
string
required
Organization ID for which the sales order belongs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_ADD_VENDOR_CREDIT_COMMENTTool to add a comment to a vendor credit. Use when you need to attach notes or comments to an existing vendor credit for tracking or collaboration purposes.

Input Parameters

string
required
The comment text to add to the vendor credit
string
required
ID of the organization. Required when the user belongs to multiple organizations.
string
required
Unique identifier of the vendor credit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_APPLY_CREDIT_NOTE_TO_INVOICETool to apply a credit note to one or more invoices in Zoho Books. Use when you need to apply available credit from a credit note to reduce the outstanding balance of invoices.

Input Parameters

array
required
List of invoices to apply the credit note to. Each entry specifies the invoice_id and amount_applied.
string
required
Unique identifier of the credit note to apply.
string
required
Zoho Books organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_APPLY_CREDITS_TO_BILLTool to apply vendor credits to a bill in Zoho Books. Use when you need to apply one or more vendor credits to reduce the outstanding balance of a bill.

Input Parameters

string
required
Unique identifier of the bill to apply credits to.
array
required
List of vendor credits to apply to the bill. Each credit specifies the vendor_credit_id and the amount to apply.
string
required
Zoho Books organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_APPLY_CREDITS_TO_INVOICETool to apply credit notes to an invoice in Zoho Books. Use when you need to apply one or more credit notes to reduce the outstanding balance of an invoice.

Input Parameters

string
required
Unique identifier of the invoice to apply credits to.
array
required
List of credit notes to apply to the invoice. Each credit note specifies the creditnote_id and the amount to apply.
string
required
Zoho Books organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_BULK_EXPORT_INVOICES_PDFTool to export multiple invoices to a single PDF. Use when you have up to 25 invoice IDs ready to merge.

Input Parameters

array
required
List of invoice IDs to export as PDF. Must contain between 1 and 25 IDs.
string
required
ID of the Zoho Books organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_BULK_PRINT_INVOICESTool to bulk print up to 25 invoices as a single PDF. Use when you have multiple invoice IDs and need a combined PDF for printing.

Input Parameters

array
required
List of invoice IDs to print (max 25 items)
string
required
The organization ID in Zoho Books

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CATEGORIZE_AS_CUSTOMER_PAYMENT_REFUNDTool to categorize an uncategorized bank transaction as a customer payment refund. Use when you need to link a bank withdrawal to a refund issued to a customer.

Input Parameters

string
required
Refund date in YYYY-MM-DD format
number
required
Refund amount - must match uncategorized transaction amount and not exceed available payment amount
string
required
Unique identifier of the customer payment to refund from
string
required
Unique identifier of the uncategorized bank transaction to categorize
string
required
Source account ID from which refund is issued
string
required
Zoho Books organization ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CATEGORIZE_UNCATEGORIZED_TRANSACTIONTool to categorize an uncategorized bank transaction. Use after fetching an uncategorized entry to assign proper type and details.

Input Parameters

string
Transaction date in YYYY-MM-DD format
array
Global tags for the transaction
number
Transaction amount
string
Tax or tax group ID applied (not applicable in US)
integer
ID of the user recording the transaction
array
Files to attach to the transaction
array
Detailed line items for the transaction
string
Currency ID if different from base currency
string
ID of the customer or vendor associated
string
Brief description of the transaction
number
Bank charges applied
string
Mode of payment (not applicable for transfers, card payments, or owner drawings)
array
Custom field values
number
Foreign currency exchange rate
string
Destination account ID; required for transfers and certain types of transactions
string
required
Unique identifier of the uncategorized bank transaction
string
Source account ID; required for transfers and certain types of transactions
string
required
Zoho Books organization ID for the API call
array
Tags for the destination account
boolean
Whether amounts include tax
string
Reference number for the transaction
string
Tax authority ID (US/AU/CA only)
string
Tax exemption ID (IN/US/AU/CA only)
string ("deposit" | "refund" | "transfer_fund" | "card_payment" | "sales_without_invoices" | "expense_refund" | "owner_contribution" | "interest_income" | "other_income" | "owner_drawings" | "sales_return")
required
Type of transaction to create; only specific types supported here
array
Tags for the source account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CLONE_PROJECTTool to clone an existing project. Use when duplicating a project with a new name and optional description.

Input Parameters

string
required
Unique identifier of the project to clone
string
Description for the cloned project (max 500 characters)
string
required
Name for the cloned project (max 100 characters)
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CONVERT_PURCHASE_ORDER_TO_BILLTool to retrieve bill data from purchase orders for conversion. Use when you need to convert one or more purchase orders into a bill.

Input Parameters

string
required
The ID of the organization
string
required
Comma-separated purchase order IDs to convert to bill

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_BANK_ACCOUNTTool to create a bank or credit card account. Use when you need to add a new bank or credit card account to your Zoho Books organization.

Input Parameters

object
required
Details of the bank or credit card account to be created.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_BANK_TRANSACTIONTool to create a manual bank transaction. Use when you need to record a non-invoice bank movement in Zoho Books after obtaining valid account IDs. All IDs (from_account_id, to_account_id, customer_id) must belong to the same organization as organization_id.

Input Parameters

string
Transaction date in YYYY-MM-DD format
array
List of tags to apply
number
Transaction amount, must be non-negative
string
Tax or tax group ID (not applicable in US)
integer
ID of the user involved
array
List of files to attach
string
Currency ID of the transaction
string
ID of the customer or vendor
string
Brief description or memo
number
Bank charges for this transaction
string
Mode of payment; not applicable to transfer_fund, card_payment, owner_drawings
array
List of custom fields to populate
number
Foreign currency exchange rate, must be >0
string
Account ID funds are transferred to. Required for: transfer_fund, deposit, sales_return, expense_refund, owner_drawings. For owner_drawings, must be equity account type. From bank accounts, can transfer to: bank/card/equity (drawings)/expense/credit_note account types. From card accounts, can transfer to: card/bank/expense account types
string
Account ID funds are transferred from. Required for: transfer_fund, card_payment, sales_without_invoices, expense_refund, other_income, owner_drawings. Account type must match transaction_type: card_payment requires credit_card account type; owner_drawings requires bank/cash/credit_card account type; transfer_fund requires bank or cash account type. For deposits to bank accounts, can be bank/card/income/refund type. For deposits to card accounts, can be bank/card/refund type
string
required
Zoho Books organization ID All account and entity IDs used in the request must belong to this organization; cross-organization IDs cause request failures.
array
List of tags on to-account entry
boolean
Whether the tax is inclusive
string
Reference number for transaction
string
Tax authority ID (US, AU, CA only)
string
Tax exemption ID (IN, US, AU, CA only)
string ("deposit" | "refund" | "transfer_fund" | "card_payment" | "sales_without_invoices" | "expense_refund" | "owner_contribution" | "interest_income" | "other_income" | "owner_drawings" | "sales_return")
required
Type of transaction. Account type requirements vary by transaction_type: ‘deposit’ requires to_account (bank/card can receive from bank/card/income/refund accounts); ‘refund’ (credit card accounts only); ‘transfer_fund’ requires from_account and to_account (both bank/card); ‘card_payment’ requires from_account (credit card type) and to_account; ‘sales_without_invoices’ requires from_account; ‘expense_refund’ requires from_account and to_account; ‘owner_contribution’ (equity account as to_account); ‘interest_income’ (income account); ‘other_income’ requires from_account; ‘owner_drawings’ requires from_account (bank/cash/credit card) and to_account (equity type); ‘sales_return’ requires to_account
array
List of tags on from-account entry

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_CHART_OF_ACCOUNTTool to create a new chart of account in Zoho Books. Use when you need to add a new account with account type, code, and other details to the organization’s chart of accounts.

Input Parameters

string
The identifier for the account’s currency
string
Details about the account’s purpose
string
An identifier linked to the account
string
required
The designation for the account being established
string ("cash" | "bank" | "fixed_asset" | "accounts_receivable" | "accounts_payable" | "credit_card" | "equity" | "income" | "expense")
Enumeration of valid account types.
boolean
Indicates whether the account appears in specific reports
string
required
The organization ID to identify the organization
string
The identifier of a parent account for hierarchical structuring
boolean
Display preference for dashboard visibility
boolean
UK-specific flag for VAT return inclusion

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_CONTACTTool to create a new contact in Zoho Books. Use when adding a customer or vendor after gathering details.

Input Parameters

array
Reporting tags for contact
string
Additional notes
string
GSTIN (India only)
string
Tax or tax group ID
string
Twitter profile URL
string
Website URL of contact
string
Facebook profile URL
string
Owner user ID (customers only)
boolean
Taxable flag
Official legal name (MX only)
string
Tax registration number (GCC/MX/KE/ZA)
string
Tax regime (MX only)
string
TDS tax ID (MX only)
boolean
Track for 1099 (US only)
string
VAT registration number (UK/EU)
string
Currency ID for contact
string
Tax ID type (SSN/ATIN/ITIN/EIN)
string
Legal/registered company name (max 200)
string
required
Display name for contact
string ("customer" | "vendor")
Contact type: customer or vendor
string
Country/emirate code for tax
number
Max receivables (customers only)
string
Associated pricebook ID
string
Tax ID value
array
Custom field values
string
GST treatment (IN only)
string ("de" | "en" | "es" | "fr" | "it" | "ja" | "nl" | "pt" | "pt_br" | "sv" | "zh" | "en_gb")
Preferred language code
integer
Payment terms in days
string
Tax treatment per edition
string
VAT treatment (UK only)
string
Internal contact number
string
Avalara use code
object
Billing address
array
List of contact persons
string
required
Organization ID (query param)
string
Avalara exemption number
array
Opening balances by location
string
Place of supply code (IN only)
object
Shipping address
string
Tax authority ID (US only)
string
Tax exemption ID
string ("individual" | "business")
Customer subtype; only for customers
object
Default document templates
boolean
Enable client portal
boolean
TDS registration flag (MX only)
string
Tax authority name
string
Tax exemption code
string
Read-only label for payment terms
boolean
Disable auto-generation of contact number
string
Exemption cert. number (KE)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_CONTACT_PERSONTool to create a new contact person for an existing contact in Zoho Books. Use when adding an individual to a contact record.

Input Parameters

string
Email address of the contact person. Max-length [100]
string
Phone number. Max-length [50]
string
Skype address. Max-length [50]
string
Mobile number. Max-length [50]
string
Last name of the contact person. Max-length [100]
string
required
Contact identifier for the associated contact
string
Department on which a person belongs. Max-length [50]
string
required
First name of the contact person. Max-length [100]
string
Salutation for the contact. Max-length [25]
string
Designation of a person. Max-length [50]
boolean
Portal access option (true/false)
string
required
Organization ID (required query parameter)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_CURRENCYTool to create a new currency for an organization. Use when you need to add a new currency to Zoho Books.

Input Parameters

string
required
A unique standard code for the currency. Max-len [100]
string
required
The format for the currency to be displayed. Max-len [100]
string
A unique symbol for the currency. Max-len [4]
string
required
The organization ID for which the currency is being created
integer
The precision level for pricing display

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_CUSTOMER_PAYMENT_REFUNDTool to refund an excess customer payment. Use when a customer has overpaid and needs to receive a refund.

Input Parameters

string
required
Refund date in yyyy-mm-dd format.
number
required
Refund amount to be returned to the customer.
string
Additional details about the refund.
string
Method of refund (max 50 characters). Examples: cash, check, banktransfer.
string
Mexico-specific payment mode field.
number
Currency conversion rate; defaults to 1 if not specified.
string
required
The account from which the refund originates.
string
required
ID of the organization. Required for users belonging to multiple organizations.
string
Reference identifier for the refund (max 100 characters).
string
required
Unique identifier of the customer payment to refund.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_EMPLOYEETool to create a new employee in Zoho Books. Use when adding an employee to track expenses and time entries.

Input Parameters

string
required
Email address of the employee
string
Role ID to assign to the employee. Format: numeric string (e.g., ‘3183742000000000777’).
number
Hourly cost rate for the employee
string
required
Full name of the employee to create
string
required
Unique numeric identifier for the Zoho Books organization. Obtain this by calling the ZOHO_BOOKS_LIST_ORGANIZATIONS action. Format: numeric string (e.g., ‘913373484’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_EXCHANGE_RATETool to create a new exchange rate for a currency. Use after confirming currency_id and organization_id.

Input Parameters

number
required
The exchange rate of the specified currency relative to the base currency. Must be greater than zero.
string
required
Unique identifier of the currency to which the exchange rate will be added.
string
required
Date on which the exchange rate takes effect (YYYY-MM-DD).
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_EXPENSETool to create a new expense in Zoho Books. Use when you need to record business expenses.

Input Parameters

string
required
Date of the expense in YYYY-MM-DD format
number
required
Amount of the expense
string
Tax identifier to apply to this expense
string
Vendor ID associated with this expense
string
required
ID of the expense account
string
Project ID to associate with this expense
string
Currency identifier if different from base currency
string
Customer ID if expense is billable
string
Description of the expense (max 100 characters)
boolean
Whether this expense is billable to a customer
boolean
Whether this is a personal expense
number
Exchange rate if using a different currency
string
required
ID of the organization
boolean
Whether the amount includes tax
string
Reference number for the expense (max 100 characters)
string
required
Account through which expense was paid

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_INVOICE_FROM_SALESORDERTool to create an instant invoice from an existing sales order. Use when you need to convert a sales order to an invoice.

Input Parameters

string
required
ID of the sales order to convert to an invoice
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_ITEMTool to create a new item (product or service). Use when you need to add new items with pricing and inventory details. Item names must be unique within an organization. If an item with the same name already exists, the API returns code=1001 with message indicating the duplicate. Check the response code to handle this scenario - use LIST_ITEMS to verify if an item exists before creating, or handle code=1001 responses to retrieve/update the existing item instead.

Input Parameters

string
Stock Keeping Unit identifier for the item.
string
required
Name of the item (product or service).
number
required
Sales price or rate of the item. Must be non-negative.
string
Unit of measurement for the item (e.g., pcs, hours).
string
Primary tax ID to apply on the item.
string
Secondary tax ID to apply on the item.
string
Description or details about the item.
boolean
Flag to enable inventory tracking for this item.
integer
Opening stock quantity for the item. Must be non-negative.
number
Purchase cost of the item. Must be non-negative.
integer
Reorder level quantity to trigger restocking.
string
required
ID of the organization.
string
Asset account ID for inventory valuation.
string
Account ID for sales of this item.
number
Cost rate for opening stock. Must be non-negative.
string
Account ID for purchase of this item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_JOURNALTool to create a journal entry in Zoho Books. Use when recording manual journal entries with debit and credit line items.

Input Parameters

array
Reporting tags for the journal.
string
Notes or description for the journal.
array
required
Array of line items. At least 2 line items are required (debit and credit entries must balance).
string
Currency identifier for multi-currency organizations.
string
required
Date on which the journal is to be recorded, in YYYY-MM-DD format.
string ("Cash" | "Both")
Enum for journal type.
array
Custom fields for the journal.
number
Exchange rate between currencies.
string
required
Zoho Books organization ID. Required query parameter.
string
Reference identifier for the journal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_LOCATIONTool to create a new location in Zoho Books. Use when you need to add a new physical or virtual location for inventory management or business operations.

Input Parameters

string ("general" | "line_item_only")
Location type: general or line_item_only
string
Email address for the location
string
Phone number for the location
object
required
Address details for the location
string
Comma-separated list of user identifiers
string
required
Name of the location
string
required
ID of the organization
string
Tax settings ID (required for India edition only)
string
Parent location identifier for hierarchical locations
array
List of associated series identifiers
boolean
Whether all users are selected for this location
string
Autonumber generation group ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_PROJECTTool to create a project in Zoho Books. Use when you need to create a new project for tracking work and billing.

Input Parameters

string
Hourly rate for a task
string
required
ID of the user to be added to the project
string
Budget type for the project
string
required
ID of the customer
string
Project description. Max-length 500
string ("fixed_cost_for_project" | "based_on_project_hours" | "based_on_staff_hours" | "based_on_task_hours")
required
The way you bill your customer
number
Budgeted hours for the project
string
required
Name of the project. Max-length 100
string
Budgeted amount for the project
string
required
Organization ID to identify the organization
number
Budgeted Cost to complete this project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_RECURRING_BILLTool to create a recurring bill in Zoho Books. Use when you need to set up automated vendor bills that recur at regular intervals (daily, weekly, monthly, or yearly).

Input Parameters

string
Notes for the recurring bill
string
Terms and conditions
string
India: 15-digit GSTIN
string
End date of the recurring bill in YYYY-MM-DD format. If not provided, bill recurs indefinitely.
string
required
ID of the vendor the bill has to be created for
array
Array of line items with item details. At least one line item is typically required.
string
required
Start date of the recurring bill in YYYY-MM-DD format
string
Currency identifier if multi-currency is enabled
string
Location ID
string
Price book ID
string
required
Recurrence interval (e.g., ‘1’, ‘2’, ‘3’)
array
Custom fields for the recurring bill
string
India: GST treatment (e.g., ‘business_gst’, ‘business_none’, ‘overseas’, ‘consumer’)
integer
Payment terms in days. 0 means Due on Receipt.
string
GCC/MX/KE/ZA: tax treatment code
string
required
ID of the organization
string
GCC: place-of-supply code
string
required
Name of the recurring bill. Max-length [100]
boolean
Whether prices include tax (non-US organizations)
string
India GST: source state
string
Custom label for payment terms
string
required
Frequency pattern (e.g., ‘days’, ‘weeks’, ‘months’, ‘years’)
string
India GST: destination state

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_RECURRING_EXPENSETool to create a new recurring expense in Zoho Books. Use when you need to set up automated recurring expenses.

Input Parameters

number
required
Expense amount (must be greater than 0)
string
Tax identifier to apply to this recurring expense
string
required
Account ID for the expense
string
Project ID to associate with this expense
string
required
Start date of recurrence in yyyy-mm-dd format
string
Currency identifier if different from base currency
string
Customer ID if expense is billable
boolean
Whether this expense is billable to a customer
integer
required
Interval count (e.g., 1 for every month, 2 for every 2 months)
string
required
ID of the organization
string
required
Name of recurring expense (max 100 chars)
boolean
Whether the amount includes tax
string ("days" | "weeks" | "months" | "years")
required
Frequency pattern (days, weeks, months, years)
string
Account ID through which expense is paid

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_RECURRING_INVOICETool to create a recurring invoice. Use when you need to set up automatic invoice generation on a regular schedule.

Input Parameters

array
Tags for categorization and reporting
string
Customer email address
string
Notes to be printed on the invoice
string
Terms and conditions for the invoice
string
15-digit GSTIN (India-specific)
number
Invoice-level discount value
string
End date for the recurring invoice in YYYY-MM-DD format
array
List of line items for the recurring invoice
string
Start date for invoice generation in YYYY-MM-DD format
string
Currency identifier for the recurring invoice
string
required
Customer identifier for whom the recurring invoice is raised
string
Business location ID
integer
Number of frequency periods between recurrences (e.g., 1 for every month, 2 for every 2 months)
array
Custom fields for the recurring invoice
string
Type of discount: entity_level or item_level
number
Exchange rate if different from base currency
string
GST treatment (India-specific)
string
Tax treatment for the invoice
object
Address details for billing or shipping.
string
required
ID of the organization
string
Place of supply code (India/GCC)
string
required
Unique name for the recurring profile. Max-length 100 characters.
boolean
Whether unit rates include tax
string
Order or reference number for tracking
object
Address details for billing or shipping.
string ("days" | "weeks" | "months" | "years")
required
Frequency of time interval at which the invoice is to be generated
boolean
Apply discount before tax if true
array
List of contact persons to associate with recurring invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_REPORTING_TAGTool to create a new reporting tag in Zoho Books. Use when you need to create custom tags for categorizing transactions, customers, or other entities for reporting purposes.

Input Parameters

array
required
List of entities that can only be enabled or disabled. Each entity has entity_name and is_enabled fields. Common entity names include ‘customers’, ‘vendors’, ‘items’, etc.
string
required
The name of the reporting tag
string
Description of the reporting tag
boolean
Whether the tag is mandatory. If true, users must assign this tag when creating transactions.
string
required
Numeric ID of your Zoho Books organization (e.g., ‘913373484’). Must contain only digits. To obtain valid organization IDs, first call ZOHO_BOOKS_LIST_ORGANIZATIONS which returns all organizations accessible to your account. Each organization has an ‘organization_id’ field. Invalid or non-existent organization IDs will result in 404 errors.
object
required
Configuration for transaction/line-item level entities with preference and entities fields. The preference can be ‘transaction’ or ‘line_item’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_RULETool to create a rule for automatic transaction categorization. Use when you need to set up automatic categorization for deposits/withdrawals (bank accounts) or refunds/charges (credit card accounts) based on transaction criteria like amount, description, or payee.

Input Parameters

string
Tax ID to apply to the transaction
string ("deposits" | "withdrawals" | "refunds" | "charges")
required
Transaction type to which the rule applies: deposits/withdrawals for bank accounts, refunds/charges for credit card accounts
array
required
List of criteria for matching transactions. At least one criterion is required.
string
How to record the matched transaction (e.g., ‘deposit’, ‘expense’, ‘refund’, ‘transfer_fund’)
string
required
Name of the rule
string
Chart of accounts ID for categorizing the transaction
string
Customer ID to associate with the transaction
string ("and" | "or")
required
Logical operator for combining criteria: ‘and’ (all criteria must match) or ‘or’ (any criterion must match)
string
required
ID of the organization
string
Reference number configuration (e.g., ‘manual’, ‘from_statement’)
string
required
ID of the bank or credit card account on which the rule applies

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_SALES_RECEIPTTool to create a sales receipt in Zoho Books. Use when you need to record a payment received from a customer along with line items for goods or services sold.

Input Parameters

string
Date of the sales receipt in YYYY-MM-DD format. Defaults to current date if not provided.
array
Reporting tags to help organize and filter data across reports
string
Notes to be printed on the sales receipt
string
Terms and conditions for the sales receipt
array
required
List of line items for the sales receipt. At least one line item is required.
string
required
Unique identifier for the customer. Get this from list_contacts or create_contact action.
string
required
Mode through which payment was received. Allowed values: cash, check, credit_card, bank_transfer, paypal, etc.
string
Sales receipt number. Mandatory if ignore_auto_number_generation is true.
string
required
ID of the organization. Get this from list_organizations action.
boolean
Send the sales receipt to customer via email
boolean
Ignore auto sales receipt number generation. When true, receipt_number must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_TIME_ENTRYTool to create a new time entry for a project task. Use when you need to log time spent by a user on a specific task.

Input Parameters

string
Description of the work done. Max-length: 500 characters
string
required
ID of the task
string
required
ID of the user who worked on the task
string
Time the user stopped working on this task in HH:mm format. Use with begin_time instead of log_time
string
required
Date on which the user spent time on the task. Format: YYYY-MM-DD
string
Time spent on task in HH:mm format. Use either this OR begin_time/end_time
string
Time the user started working on this task in HH:mm format. Use with end_time instead of log_time
string
required
ID of the project
boolean
Whether the time entry is billable to the customer
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_USERTool to create a new user in Zoho Books. Use when inviting a team member to your organization.

Input Parameters

string
required
Full name of the user to invite. Must not be empty.
string
required
Email address of the user. An invitation will be sent to this email.
string
required
Role ID to assign to the user. This is required. Obtain valid role IDs by calling the ZOHO_BOOKS_LIST_USERS action and checking the ‘role_id’ field of existing users. Format: numeric string (e.g., ‘3183742000000000777’).
string
required
Unique numeric identifier for the Zoho Books organization. Obtain this by calling the ZOHO_BOOKS_LIST_ORGANIZATIONS action. Format: numeric string (e.g., ‘60059838605’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_VENDOR_CREDITTool to create a vendor credit in Zoho Books. Use when you need to record a credit from a vendor.

Input Parameters

string
required
Creation date in YYYY-MM-DD format
string
Notes for the vendor credit
string
Bill ID to associate with the vendor credit
string
required
Unique identifier for the vendor contact
array
required
Array of line items (at least one required)
string
required
Zoho Books organization ID (required)
string
External reference number for the vendor credit
string
Vendor credit number (required if auto-generation is disabled)
boolean
Ignore auto number generation for this vendor credit only. On enabling this option vendor credit number is mandatory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_CREATE_VENDOR_PAYMENTTool to create a vendor payment in Zoho Books. Use when you need to record a payment made to a vendor, either for specific bills or as a general payment.

Input Parameters

string
required
Date when the payment is made (format: yyyy-MM-dd)
array
List of bills to apply payment to. Each entry specifies bill_id and amount_applied. If not provided, payment will be recorded as excess payment/credit.
number
required
Total amount of vendor payment
string
required
ID of the vendor to whom the payment is being made
string
Description or notes for the payment
string
Mode of vendor payment (e.g., Cash, Check, Bank Transfer)
number
Currency exchange rate for multi-currency payments
string
required
ID of the organization
string
Reference number or identifier for the payment
string
required
ID of the cash/bank account from which payment originates

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DEACTIVATE_BANK_ACCOUNTTool to deactivate a bank account. Use when you need to mark an existing bank account as inactive after confirming its ID.

Input Parameters

string
required
Unique identifier of the bank account.
string
required
ID of the organization. Required when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_BANK_ACCOUNTTool to delete a bank account from your organization. Use when you need to remove an existing bank account after confirming its ID.

Input Parameters

string
required
Unique identifier of the bank account to delete.
string
required
ID of the organization. Required when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_BANK_TRANSACTIONTool to delete a specific bank transaction. Use when you need to remove an existing transaction after confirming its ID.

Input Parameters

string
required
ID of the organization
string
required
Unique identifier of the bank transaction to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_BILLTool to delete a specific bill. Use when you need to remove an existing bill after confirming its ID.

Input Parameters

string
required
Unique identifier of the bill to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_BILL_ATTACHMENTTool to delete an attachment from a specific bill. Use when you need to remove an attached document from an existing bill.

Input Parameters

string
required
The unique identifier for the specific bill from which you want to remove the attached document
string
required
Required query parameter specifying your organization’s ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_BILL_COMMENTTool to delete a comment from a bill. Use when you need to remove a specific comment after confirming both the bill ID and comment ID.

Input Parameters

string
required
Unique identifier of the bill.
string
required
Unique identifier of the comment.
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_BILL_PAYMENTTool to delete a specific bill payment. Use when you need to remove a payment record from a bill after confirming both the bill ID and payment ID.

Input Parameters

string
required
Unique identifier of the bill
string
required
Unique identifier of the bill payment to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_BULK_CUSTOMER_PAYMENTSTool to bulk delete multiple customer payments. Use when you need to remove multiple customer payment records at once.

Input Parameters

array
required
List of customer payment IDs to be deleted in bulk. Provide 1 or more payment IDs.
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_BULK_VENDOR_PAYMENTSTool to bulk delete multiple vendor payments. Use when you need to remove multiple vendor payment records at once.

Input Parameters

string
required
ID of the organization
array
required
List of vendor payment IDs to be deleted in bulk. Provide 1 or more vendor payment IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_CHART_OF_ACCOUNTTool to delete a specific chart of account. Use when you need to remove an existing account after confirming its ID.

Input Parameters

string
required
Unique identifier of the account to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_CHART_OF_ACCOUNT_TRANSACTIONTool to delete a chart of account transaction. Use when you need to remove an existing transaction after confirming its ID.

Input Parameters

string
required
Unique identifier of the transaction to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_CONTACTTool to delete a specific contact. Use when you need to remove an existing contact after confirming its ID.

Input Parameters

string
required
Unique identifier of the contact to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_CONTACT_ADDRESSTool to delete an additional address from a contact. Use when you need to remove a specific address entry from a contact’s address list.

Input Parameters

string
required
Unique identifier of the address to delete
string
required
Unique identifier of the contact
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_CONTACT_PERSONTool to delete a specific contact person. Use when you need to remove a contact person from a contact after confirming their ID.

Input Parameters

string
required
ID of the organization
string
required
Unique identifier of the contact person to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_CREDIT_NOTETool to delete a specific credit note. Use when you need to remove an existing credit note after confirming its ID.

Input Parameters

string
required
Unique identifier of the credit note to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_CREDIT_NOTE_COMMENTTool to delete a comment from a credit note. Use when you need to remove a specific comment from a credit note after confirming both IDs.

Input Parameters

string
required
Unique identifier of the comment to delete
string
required
Unique identifier of the credit note
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_CREDIT_NOTE_REFUNDTool to delete a specific credit note refund. Use when you need to remove a refund entry from a credit note.

Input Parameters

string
required
Unique identifier of the credit note.
string
required
ID of the organization
string
required
Unique identifier of the credit note refund.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_CURRENCYTool to delete a specific currency from organization settings. Use when you need to remove an unused currency after confirming it has no associated transactions.

Input Parameters

string
required
Unique identifier of the currency to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_CUSTOMER_PAYMENTTool to delete a customer payment. Use when you need to remove an existing payment record after confirming its ID.

Input Parameters

string
required
Unique identifier of the payment to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_CUSTOMER_PAYMENT_REFUNDTool to delete a specific customer payment refund. Use when you need to remove an existing refund after confirming its ID.

Input Parameters

string
required
Unique identifier of the refund to delete.
string
required
ID of the organization
string
required
Unique identifier of the customer payment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_EMPLOYEETool to delete a specific employee. Use when you need to remove an existing employee after confirming its ID.

Input Parameters

string
required
Unique identifier of the employee to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_ESTIMATETool to delete a specific estimate. Use when you need to remove an existing estimate after confirming its ID.

Input Parameters

string
required
Unique identifier of the estimate to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_EXCHANGE_RATETool to delete an exchange rate for a currency. Use when you need to remove an existing exchange rate after confirming the currency_id and exchange_rate_id.

Input Parameters

string
required
Unique identifier of the currency.
string
required
ID of the organization.
string
required
Unique identifier of the exchange rate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_EXPENSETool to delete a specific expense. Use when you need to remove an existing expense after confirming its ID.

Input Parameters

string
required
Unique identifier of the expense to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_EXPENSE_RECEIPTTool to delete a receipt from an expense. Use when you need to remove an attached receipt from an existing expense after confirming its ID.

Input Parameters

string
required
Unique identifier of the expense.
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_INVOICETool to delete a specific invoice. Use when you need to remove an existing invoice after confirming its ID.

Input Parameters

string
required
Unique identifier of the invoice to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_INVOICE_ATTACHMENTTool to delete the last attached attachment from an invoice. Use when you need to remove the most recently attached file from a specific invoice.

Input Parameters

string
required
Unique identifier of the invoice from which to delete the attachment
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_INVOICE_COMMENTTool to delete a comment from an invoice. Use when you need to remove a specific comment from an invoice.

Input Parameters

string
required
Unique identifier of the comment.
string
required
Unique identifier of the invoice.
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_INVOICE_DOCUMENTTool to delete a document/attachment from a specific invoice. Use when you need to remove an invoice attachment after confirming it is no longer needed.

Input Parameters

string
required
Unique identifier of the invoice
string
required
Unique identifier of the document/attachment to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_INVOICE_PAYMENTTool to delete a payment applied to an invoice. Use when you need to remove a payment record from a specific invoice.

Input Parameters

string
required
Unique identifier of the invoice
string
required
ID of the organization
string
required
Unique identifier of the invoice payment to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_ITEMTool to delete a specific item. Use when you need to remove an unused item after confirming it has no linked transactions.

Input Parameters

string
required
Unique identifier of the item to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_JOURNAL_COMMENT_V4Tool to delete a journal comment using Zoho Books API v4 (Beta). Use when you need to remove an existing comment from a journal after confirming both the journal ID and comment ID.

Input Parameters

string
Specifies the entity type for which the comment or credit entry is being deleted.
string
required
The unique identifier of the comment to be deleted.
string
required
The unique identifier of the journal.
string
required
Your organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_JOURNAL_DOCUMENTTool to delete a document/attachment from a journal entry. Use when you need to remove an existing attachment from a journal.

Input Parameters

string
required
Unique identifier of the journal
string
required
Unique identifier of the document/attachment to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_JOURNALSTool to delete multiple journal entries in one request. Use when you need to remove multiple journals after confirming their IDs.

Input Parameters

array
required
List of unique identifiers of journals to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_JOURNAL_V4Tool to delete a journal using the v4 Beta API. Use when you need to remove an existing journal after confirming its ID.

Input Parameters

string
required
Unique identifier of the journal to delete
string
required
ID of the organization. IMPORTANT: Use underscore (organization_id) not hyphen (organization-id)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_LOCATIONTool to delete a specific location. Use when you need to remove a location from the organization.

Input Parameters

string
required
Unique identifier of the location to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_PROJECT_COMMENT_V4Tool to delete a project comment using v4 Beta API. Use when you need to remove an existing comment from a project after confirming its ID.

Input Parameters

string
required
Unique identifier of the comment to delete
string
required
Unique identifier of the project
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_PROJECT_TASKTool to delete a project task. Use when you need to remove a task from a project after confirming both project ID and task ID.

Input Parameters

string
required
Unique identifier of the task to delete.
string
required
Unique identifier of the project.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_PROJECT_V4Tool to delete a specific project using v4 Beta API. Use when you need to remove an existing project after confirming its ID.

Input Parameters

string
required
Unique identifier of the project to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_PURCHASE_ORDERTool to delete a specific purchase order. Use when you need to remove an existing purchase order after confirming its ID.

Input Parameters

string
required
ID of the organization
string
required
Unique identifier of the purchase order to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_PURCHASE_ORDER_ATTACHMENTTool to delete an attachment from a purchase order. Use when you need to remove a file attached to a purchase order after confirming the purchase order ID.

Input Parameters

string
required
ID of the organization
string
required
Unique identifier of the purchase order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_PURCHASE_ORDER_COMMENTTool to delete a comment from a purchase order. Use when you need to remove an existing comment after confirming its ID.

Input Parameters

string
required
Unique identifier of the comment to delete
string
required
ID of the organization
string
required
Unique identifier of the purchase order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_RECURRING_BILLTool to delete a recurring bill. Use when you need to remove an existing recurring bill after confirming its ID.

Input Parameters

string
required
ID of the organization
string
required
Unique identifier of the recurring bill to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_RECURRING_INVOICETool to delete a recurring invoice. Use when you need to remove an existing recurring invoice after confirming its ID.

Input Parameters

string
required
ID of the organization
string
required
Unique identifier of the recurring invoice to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_RULETool to delete a bank account rule from your account. Use when you need to remove a rule and make it no longer applicable on transactions.

Input Parameters

string
required
Unique identifier of the bank account rule to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_SALES_ORDER_COMMENTTool to delete a comment from a sales order. Use when you need to remove a specific comment from a sales order.

Input Parameters

string
required
Unique identifier of the comment.
string
required
Unique identifier of the sales order.
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_SALES_RECEIPTTool to delete a specific sales receipt. Use when you need to remove an existing sales receipt after confirming its ID.

Input Parameters

string
required
ID of the organization
string
required
Unique identifier of the sales receipt to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_TIME_ENTRYTool to delete a specific time entry from a project. Use when you need to remove an existing time entry after confirming its ID.

Input Parameters

string
required
Unique identifier of the time entry to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_VENDOR_CREDITTool to delete a specific vendor credit. Use when you need to remove an existing vendor credit after confirming its ID.

Input Parameters

string
required
ID of the organization
string
required
Unique identifier of the vendor credit to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_VENDOR_CREDIT_REFUNDTool to delete a vendor credit refund. Use when you need to remove a refund associated with a vendor credit.

Input Parameters

string
required
ID of the organization
string
required
Unique identifier of the vendor credit
string
required
Unique identifier of the vendor credit refund to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DELETE_VENDOR_PAYMENTTool to delete a vendor payment. Use when you need to remove an existing vendor payment record after confirming its ID.

Input Parameters

string
required
Unique identifier of the vendor payment to delete
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DISABLE_CONTACT_PAYMENT_REMINDERTool to disable payment reminders for a contact. Use when you need to stop all automated payment reminder emails for a specific contact.

Input Parameters

string
required
Unique identifier of the contact to disable payment reminders for
string
required
ID of the organization. Required when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_DISABLE_INVOICE_PAYMENT_REMINDERTool to disable payment reminders for an invoice. Use when you need to stop automatic payment reminder emails for a specific invoice.

Input Parameters

string
required
Unique identifier of the invoice
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_EMAIL_CONTACT_STATEMENTTool to email a statement to a contact. Use when you need to send account statements to customers or vendors for a specific period.

Input Parameters

string
Custom body content for the statement email (plain text or HTML)
string
Custom subject line for the statement email
string
End date for the statement period. Format: yyyy-mm-dd
string
required
Unique identifier of the contact
string
Start date for the statement period. If start_date and end_date are not provided, current month’s statement will be sent. Format: yyyy-mm-dd
array
List of CC recipient email addresses
array
List of recipient email addresses to send the statement to. If not provided, statement will be sent to the contact’s email
string
required
Organization ID (query param)
boolean
Whether to send additional attachments with the statement
boolean
Whether to send from the organization’s primary email address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_EMAIL_ESTIMATETool to send an estimate email. Use after estimate creation to share it with the customer.

Input Parameters

string
Custom body content for the email
string
Custom subject for the email
array
Additional files to attach to the email.
array
List of CC recipient email addresses
string
required
Unique identifier of the estimate to email
array
required
List of recipient email addresses
string
Specific email address ID to use as the sender
string
required
ID of the organization
boolean
Include existing estimate attachments with the email
boolean
Send from the organization’s primary email address if true

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_EMAIL_INVOICETool to send an invoice email. Use after invoice creation to share it with the customer.

Input Parameters

string
Custom body content for the email
string
Custom subject for the email
string
required
Unique identifier of the invoice
array
Additional files to attach to the email.
array
List of CC recipient email addresses
array
required
List of recipient email addresses
string
Specific email address ID to use as the sender
string
required
ID of the organization
boolean
Include existing invoice attachments with the email
boolean
Send from the organization’s primary email address if true
boolean
Include customer statement PDF with the email

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_ENABLE_CONTACT_PAYMENT_REMINDERTool to enable payment reminders for a contact. Use when you need to activate automated payment reminder emails for a specific contact.

Input Parameters

string
required
Unique identifier of the contact to enable payment reminders for
string
required
ID of the organization. Required when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_ENABLE_CONTACT_PORTALTool to enable portal access for a contact. Use when you need to grant customer portal access to a specific contact after confirming its ID.

Input Parameters

string
required
Unique identifier of the contact to enable portal access for
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_ENABLE_INVOICE_PAYMENT_REMINDERTool to enable payment reminders for an invoice. Use when you need to activate automated payment reminder emails for a specific invoice.

Input Parameters

string
required
Unique identifier of the invoice to enable payment reminders for
string
required
ID of the organization. Required when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_EXCLUDE_BANK_TRANSACTIONTool to exclude an uncategorized bank transaction. Use when you need to mark a transaction as excluded from categorization.

Input Parameters

string
Account ID for which transactions are to be listed
string
required
Unique identifier of the uncategorized bank transaction to exclude
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_EXPORT_BULK_ESTIMATES_PDFTool to export multiple estimates to a single PDF. Use when you have up to 25 estimate IDs ready to merge.

Input Parameters

array
required
List of estimate IDs to export as PDF. Must contain between 1 and 25 IDs.
string
required
ID of the Zoho Books organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_EXPORT_SALES_ORDERS_PDFTool to export multiple sales orders to a single PDF. Use when you have up to 25 sales order IDs ready to merge.

Input Parameters

array
required
List of sales order IDs to export as PDF. Must contain between 1 and 25 IDs.
string
required
ID of the Zoho Books organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_ACCOUNT_TRANSACTION_REPORTRetrieve the organization-wide account transaction report for a date range.

Input Parameters

integer
Page number, starting at 1.
string
required
End of the report date range in YYYY-MM-DD format.
integer
Number of records per page, up to 200.
string
Zoho Books report filter, such as TransactionDate.ThisMonth.
string
required
Start of the report date range in YYYY-MM-DD format.
string
required
Unique identifier of the Zoho Books organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_ALL_TAG_OPTIONSTool to retrieve all options for a reporting tag. Use when you need to fetch the complete list of tag option values.

Input Parameters

string
required
The ID of the reporting tag to fetch options for
boolean
Set to true to include ‘untagged’ in the response
string
required
The organization ID to identify the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_BANK_ACCOUNTTool to fetch details of a specific bank account. Use when you need full metadata of one account by ID.

Input Parameters

string
required
Unique identifier of the bank account.
string
required
Zoho Books organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_BASE_CURRENCY_ADJUSTMENTTool to fetch details of a specific base currency adjustment. Use when you need to retrieve adjustment information by its ID.

Input Parameters

string
required
ID of the organization
string
required
Unique identifier of the base currency adjustment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_BILLTool to fetch details of a specific bill. Use after confirming the organization context.

Input Parameters

string
required
Unique identifier of the bill to fetch
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_BILL_ATTACHMENTTool to fetch an attachment from a specific bill. Use when you need to download a document attached to a bill.

Input Parameters

string
required
Unique identifier of the bill to fetch the attachment from
boolean
Get the thumbnail of the attachment instead of the full file
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_CHART_OF_ACCOUNTTool to fetch details of a specific chart of account. Use when you need to retrieve all attributes of an existing account by its ID.

Input Parameters

string
required
Unique identifier of the account to retrieve
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_CONTACTTool to fetch details of a specific contact. Use when you need to retrieve comprehensive contact information after obtaining the contact_id.

Input Parameters

string
required
Unique identifier of the contact
string
required
Organization ID (query param)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_CONTACT_ADDRESSTool to retrieve all addresses associated with a contact. Use when you need to fetch billing, shipping, and additional addresses for a specific contact.

Input Parameters

string
required
Unique identifier of the contact
string
required
Organization ID to identify the specific organization when user belongs to multiple organizations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_CONTACT_PERSONTool to retrieve details of a specific contact person. Use when you need to fetch information about an individual associated with a contact.

Input Parameters

string
required
Unique identifier of the contact
string
required
Organization ID (required query parameter)
string
required
Unique identifier of the contact person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_CONTACT_STATEMENT_MAILTool to retrieve the pre-populated email content for a contact statement. Use when you need to get the email template, subject, body, and recipients before sending a statement.

Input Parameters

string
End date for the statement period. Format: yyyy-mm-dd
string
required
Unique identifier of the contact
string
Start date for the statement period. If not provided along with end_date, current month’s statement will be used. Format: yyyy-mm-dd
string
required
Organization ID (query param)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_CREDIT_NOTETool to fetch details of a specific credit note by ID. Use when you need the full credit note record including line items, taxes, and applied invoices.

Input Parameters

boolean
Export credit note pdf with default print option. Only applies when accept is pdf. Allowed values: true, false, on, off.
string
Response format. Allowed values: json, pdf, html. Default is json. Use pdf or html to download the credit note document.
string
required
Unique identifier of the credit note to retrieve (e.g., ‘7472322000000247060’). This is the numeric ID returned when listing or creating credit notes.
string
required
Unique identifier of the Zoho Books organization. Required for users with multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_CURRENCYTool to retrieve details of a specific currency. Use when you need to get currency settings including exchange rates and formatting options.

Input Parameters

string
required
Unique identifier of the currency
string
required
Organization ID (query parameter)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_DETAILED_GENERAL_LEDGERRetrieve grouped detailed general-ledger rows for a date range.

Input Parameters

integer
Page number, starting at 1.
string
required
End of the report date range in YYYY-MM-DD format.
integer
Number of records per page, up to 200.
string
required
Start of the report date range in YYYY-MM-DD format.
string
required
Unique identifier of the Zoho Books organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_ESTIMATETool to fetch details of a specific estimate. Use when you need to retrieve all attributes of an existing estimate by its ID.

Input Parameters

string
required
Unique identifier of the estimate
string
required
Organization ID for the Zoho Books account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_ESTIMATE_EMAILTool to retrieve the pre-populated email content for an estimate. Use when you need to get the email template, subject, body, and recipients before sending an estimate email.

Input Parameters

string
required
Unique identifier of the estimate
string
required
ID of the organization
string
Get the email content based on a specific email template. If not provided, the content will be based on the email template associated with the customer. If no template is associated with the customer, the default template will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_EXPENSETool to fetch details of a specific expense. Use when you need the full expense record by its ID after creation or listing.

Input Parameters

string
required
Unique identifier of the expense to fetch.
string
required
ID of the organization. Required when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_FINANCIAL_STATEMENTRetrieve a balance sheet, cash flow, profit and loss, or trial balance.

Input Parameters

string
required
End of the report date range in YYYY-MM-DD format.
string
Zoho Books report filter, such as TransactionDate.ThisYear.
string
required
Start of the report date range in YYYY-MM-DD format.
string ("balance_sheet" | "cash_flow" | "profit_and_loss" | "trial_balance")
required
Financial statement to retrieve.
string
required
Unique identifier of the Zoho Books organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_INVOICETool to fetch details of a specific invoice. Use when you need the full invoice record by its ID after creation or listing.

Input Parameters

boolean
When retrieving a PDF, whether to render it in print mode.
string ("json" | "pdf" | "html")
Response format. One of: json, pdf, html. Default is json.
string
required
Unique invoice ID accepted by the invoice API route. Pass letters, digits, hyphens, and underscores unchanged; the ID need not be numeric.
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_INVOICE_ATTACHMENTTool to fetch the last attached attachment from a specific invoice. Use when you need to download a document attached to an invoice.

Input Parameters

boolean
Get the thumbnail of the attachment instead of the full file
string
required
Unique identifier of the invoice to fetch the attachment from
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_INVOICE_EMAILTool to retrieve the pre-populated email content for an invoice. Use when you need to get the email template, subject, body, and recipients before sending an invoice email.

Input Parameters

string
required
Unique identifier of the invoice
string
required
ID of the organization
string
Get the email content based on a specific email template. If not provided, the content will be based on the email template associated with the customer. If no template is associated with the customer, the default template will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_ITEMFetch details of a specific item by its ID and organization ID.

Input Parameters

string
required
Unique identifier of the item to retrieve
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_JOURNAL_CREDITS_LIST_V4Tool to retrieve the list of available journal credits for a specific journal using v4 Beta API. Use when you need to view credits associated with a journal entry.

Input Parameters

string
required
Unique identifier of the journal to retrieve credits for
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_JOURNAL_DETAILS_V4Tool to fetch details of a specific journal entry from Zoho Books API v4 (Beta). Use when you need complete journal information including line items, tax details, metadata, and approvals.

Input Parameters

boolean
Controls journal printing; accepts true or false
string
Response format options: json (default), pdf, or html
string
Specifies content inclusion for HTML/mail formats
string
required
Unique identifier of the journal to fetch.
string
Language preference for response content
string
required
The organization ID for which to retrieve journal details. Required when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_JOURNALS_LIST_V4Tool to retrieve a paginated list of journals using Zoho Books v4 Beta API. Use when you need to fetch and filter journal entries with advanced filtering options.

Input Parameters

integer
Page number for pagination (default: 1).
string ("draft" | "published" | "approved" | "submitted" | "rejected")
Filter by journal status.
string
End date for filtering journals (YYYY-MM-DD format).
integer
Number of records per page (default: 200, max: 200).
string
Filter journals by type, date, entity type, or status (e.g., ‘Status.Draft’, ‘Date.ThisMonth’).
string
Start date for filtering journals (YYYY-MM-DD format).
string
Search text for filtering journals (searches across journal number, reference number, notes).
string ("journal_date" | "entry_number" | "reference_number" | "total" | "last_modified_time")
Sort by: journal_date, entry_number, reference_number, total, or last_modified_time.
string
required
ID of the organization. This will be sent as a header (X-com-zoho-books-organizationid).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_LAST_IMPORTED_STATEMENTTool to get details of previously imported statement for a bank account. Use when you need to retrieve information about the last statement import.

Input Parameters

string
required
Unique identifier of the bank account.
string
required
The unique ID of the organization. Required when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_MATCHING_BANK_TRANSACTIONSTool to retrieve potential matching transactions for an uncategorized bank transaction. Use when you need to find existing transactions that could be matched with an imported or uncategorized transaction for reconciliation purposes.

Input Parameters

integer
Page number for pagination. Starts at 1. Use when there are many potential matches.
string
Filter by contact person name involved in the transaction. Helps narrow down matches to specific customers or vendors.
integer
Number of matching transactions to return per page. Maximum is 200.
number
Maximum amount for filtering potential matching transactions. Use together with amount_start for a range.
string
Filter to show only transactions dated after this date (YYYY-MM-DD format). Useful for narrowing down potential matches.
string
Filter to show only transactions dated before this date (YYYY-MM-DD format). Useful for narrowing down potential matches.
number
Minimum amount for filtering potential matching transactions. Use together with amount_end for a range.
string
required
ID of the uncategorized transaction to find matches for. This is the transaction that needs to be matched with existing records.
string
required
Unique identifier of the Zoho Books organization. Retrieve this using the List Organizations action.
string
Filter by exact transaction reference number. Useful when you know the reference number of the transaction to match.
boolean
If true, shows all possible matching transactions regardless of other filters. If false or not provided, applies standard matching logic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_OPENING_BALANCETool to retrieve opening balance for an organization. Use when you need to view the initial account balances configured in Zoho Books.

Input Parameters

string
required
The organization ID to identify which organization to get opening balance for. Required when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_ORGANIZATIONTool to fetch details of a specific organization. Use when you need to retrieve comprehensive organization information by its ID.

Input Parameters

string
required
Unique identifier of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_PAYMENT_REMINDER_MAIL_CONTENT_FOR_INVOICETool to retrieve the pre-populated payment reminder email content for an invoice. Use when you need to get the email template, subject, body, and recipients before sending a payment reminder.

Input Parameters

string
required
Unique identifier of the invoice
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_PROJECTTool to fetch details of a specific project. Use when you need to retrieve comprehensive project information after obtaining the project_id.

Input Parameters

string
required
Unique identifier of the project to fetch
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_PROJECT_USERTool to fetch details of a specific user associated with a project. Use when you need to retrieve user information for a project.

Input Parameters

string
required
Unique identifier of the user
string
required
Unique identifier of the project
string
required
Organization ID for the Zoho Books account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_PURCHASE_ORDERTool to fetch details of a specific purchase order. Use after confirming the organization context to retrieve comprehensive purchase order information.

Input Parameters

string
required
ID of the organization
string
required
Unique identifier of the purchase order to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_RECURRING_INVOICETool to retrieve a single recurring invoice profile’s full configuration by ID. Returns complete schedule, customer, line items, and status for ‘read-before-write’ update safety.

Input Parameters

string
required
ID of the organization. Required when user belongs to multiple organizations.
string
required
Unique identifier of the recurring invoice profile to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_SALES_ORDERTool to fetch details of a specific sales order. Use when you need the full record of a sales order by its ID.

Input Parameters

boolean
Whether to print/export the sales order as PDF
string ("json" | "csv" | "xml" | "xls" | "xlsx" | "pdf" | "jhtml" | "html")
Response format. Allowed: json, csv, xml, xls, xlsx, pdf, jhtml, html
string
required
Unique identifier of the sales order
string
required
ID of the organization to which the sales order belongs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_SALES_ORDER_ATTACHMENTTool to fetch an attachment from a specific sales order. Use when you need to download a document attached to a sales order.

Input Parameters

boolean
Get inline response instead of downloading as attachment
boolean
Get the thumbnail of the attachment instead of the full file
string
required
Unique identifier of the sales order to fetch the attachment from
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_SALES_ORDER_EMAIL_CONTENTTool to retrieve the pre-populated email content for a sales order. Use when you need to get the email template, subject, body, and recipients before sending a sales order email.

Input Parameters

string
required
Unique identifier of the sales order
string
required
ID of the organization
string
Get the email content based on a specific email template. If not provided, the content will be based on the email template associated with the customer. If no template is associated with the customer, the default template will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_TEMPLATERetrieve one Zoho Books PDF template and its layout settings.

Input Parameters

string
required
Unique identifier of the PDF template to retrieve.
string
required
Unique identifier of the Zoho Books organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_USERTool to fetch details of a specific user. Use after obtaining the user_id to retrieve comprehensive user information.

Input Parameters

string
required
Unique identifier of the user to retrieve
string
required
Organization ID for the Zoho Books account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_GET_VENDOR_CREDIT_REFUNDTool to fetch details of a specific vendor credit refund. Use when you need to retrieve information about a refund associated with a vendor credit.

Input Parameters

string
required
ID of the organization
string
required
Unique identifier of the vendor credit
string
required
Unique identifier of the vendor credit refund

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_IMPORT_BANK_STATEMENTSTool to import bank or credit card statement transactions in bulk. Use when you need to import multiple transactions from a bank statement.

Input Parameters

string
End date of the statement period in YYYY-MM-DD format
string
required
Bank or credit card account ID to import transactions into. Get this from List Bank Accounts action.
string
Start date of the statement period in YYYY-MM-DD format
array
required
Array of transactions to import. Each transaction must have date, debit_or_credit, and amount.
string
required
Zoho Books organization ID. Required for all API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_BANK_ACCOUNTSTool to list bank and credit card accounts. Use when retrieving all accounts for reconciliation or overview. Paginate using page and per_page for large organizations with many accounts.

Input Parameters

integer
Page number to fetch (minimum 1)
integer
Number of records per page (minimum 1)
string ("Status.All" | "Status.Active" | "Status.Inactive")
Filter accounts by status. Allowed values: Status.All, Status.Active, Status.Inactive
string ("account_name" | "account_type" | "account_code")
Field to sort accounts by. Allowed values: account_name, account_type, account_code
string
required
ID of the organization Must match the Zoho Books organization context; cross-org IDs cause request failures.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_BANK_ACCOUNT_STATEMENTSList imported statements for a Zoho Books bank account.

Input Parameters

integer
Page number to fetch. Defaults to 1.
integer
Number of statements to fetch per page. Defaults to 200 and cannot exceed 200.
string
Provider-supported filter to apply to imported statements.
string
required
Unique identifier of the bank account.
string
required
Unique identifier of the Zoho Books organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_BANK_RULESTool to list all rules created for a bank or credit card account. Use when you need to retrieve rules for transaction categorization and automation.

Input Parameters

integer
required
ID of the Bank Account for which rules should be fetched. Get this from List Bank Accounts action.
string
required
ID of the organization (required for users belonging to multiple organizations). Retrieve this using the List Organizations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_BANK_TRANSACTIONSTool to list bank transactions with optional filters. Use when you need to retrieve transactions for reconciliation and reporting.

Input Parameters

integer
Page number for pagination. Starts at 1.
string ("All" | "uncategorized" | "manually_added" | "matched" | "excluded" | "categorized")
Filter by transaction status. All: all transactions, uncategorized: imported but not matched, manually_added: manually created, matched: matched with records, excluded: excluded from reconciliation, categorized: matched/categorized transactions.
string
Filter transactions on or before this date (YYYY-MM-DD format).
integer
Number of records per page (max 200).
string ("Status.All" | "Status.Uncategorized" | "Status.Categorized" | "Status.ManuallyAdded" | "Status.Excluded" | "Status.Matched")
Alternative status filter format. Use either ‘status’ or ‘filter_by’, not both.
string
Filter by specific bank account ID. Get this from List Bank Accounts action.
number
Maximum transaction amount for range filter.
string
Filter transactions on or after this date (YYYY-MM-DD format).
string
Search transactions by payee name or description text.
string
Field to sort results by. Currently only ‘date’ is supported.
number
Minimum transaction amount for range filter.
string
required
Unique identifier of the Zoho Books organization. Retrieve this using the List Organizations action.
string
Filter by exact transaction reference number.
string
Filter by transaction type. Common values: customer_payment, vendor_payment, deposit, withdrawal, transfer_fund, refund, expense, card_payment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_BASE_CURRENCY_ADJUSTMENTSTool to list base currency adjustments for an organization. Use when retrieving currency adjustment records for reconciliation or reporting.

Input Parameters

integer
Page number to be fetched. Default value is 1.
integer
Number of records to be fetched per page. Default value is 200.
string ("Date.All" | "Date.Today" | "Date.ThisWeek" | "Date.ThisMonth" | "Date.ThisQuarter" | "Date.ThisYear")
Filter base currency adjustment list by date range. Allowed Values: Date.All, Date.Today, Date.ThisWeek, Date.ThisMonth, Date.ThisQuarter and Date.ThisYear.
string ("adjustment_date" | "exchange_rate" | "currency_code" | "gain_or_loss")
Sort base currency adjustment list by specified column. Allowed Values: adjustment_date, exchange_rate, currency_code and gain_or_loss.
string
required
ID of the organization. Required when user belongs to multiple organizations.
string
Search using the Last Modified Time of the Base Currency Adjustment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_BILL_COMMENTS_AND_HISTORYTool to list comments and history entries for a bill. Use when retrieving all comments and historical activities associated with a specific bill.

Input Parameters

string
required
Unique identifier of the bill
string
required
ID of the organization to which the bill belongs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_BILL_PAYMENTSTool to list payments recorded against a bill. Use when retrieving all payment transactions applied to a specific vendor bill.

Input Parameters

string
required
Unique identifier of the bill.
string
required
The unique identifier for the organization. Required when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_BILLSTool to retrieve a paginated list of bills. Use when listing bills with filters and pagination.

Input Parameters

integer
Page number to retrieve, starting from 1.
string ("paid" | "open" | "overdue" | "void" | "partially_paid")
Filter by bill status.
integer
Filter by item ID.
string
Filter by bill date (YYYY-MM-DD), up to this date.
integer
Number of records per page (max 200).
integer
Filter by vendor ID.
string
Filter by bills dated after this date (YYYY-MM-DD).
string
Filter by bill date (YYYY-MM-DD), starting from this date.
string ("A" | "D")
Sort order: A for ascending, D for descending.
string
Filter by exact bill number.
string
Filter by bills dated before this date (YYYY-MM-DD).
string ("vendor_name" | "bill_number" | "date" | "due_date" | "total" | "balance" | "created_time")
Column to sort by.
string
required
ID of the organization.
number
Filter by total amount less than this value.
string
Filter by exact reference number.
number
Filter by total amount less than or equal to this value.
number
Filter by total amount greater than this value.
string
Filter by bill numbers containing this string.
string
Filter by descriptions containing this string.
number
Filter by total amount greater than or equal to this value.
string
Filter by vendor names containing this string.
string
Filter by bill numbers starting with this string.
string
Filter by descriptions starting with this string.
string
Filter by vendor names starting with this string.
string
Filter by reference numbers containing this string.
string
Filter by reference numbers starting with this string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_CHART_OF_ACCOUNTSLists a page of an organization’s chart of accounts, with optional filtering, sorting, and pagination.

Input Parameters

integer
Page number for pagination (default 1)
integer
Number of records per page (default 200)
string ("AccountType.All" | "AccountType.Active" | "AccountType.Inactive" | "AccountType.Asset" | "AccountType.Liability" | "AccountType.Equity" | "AccountType.Income" | "AccountType.Expense")
Filter accounts by type or status.
boolean
Include current balance of accounts (true or false)
string ("account_name" | "account_type")
Field to sort by. Allowed: account_name, account_type
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_CHART_OF_ACCOUNT_TRANSACTIONSTool to list transactions for a specific chart of account. Use when you need to retrieve transaction history for an account with optional filters.

Input Parameters

integer
Page number for pagination. Starts at 1.
string
Filter transactions on or before this date (YYYY-MM-DD format). Use with date_start for a date range.
integer
Number of records per page (max 200).
string ("AccountType.All" | "AccountType.Active" | "AccountType.Inactive" | "AccountType.Asset" | "AccountType.Liability" | "AccountType.Equity" | "AccountType.Income" | "AccountType.Expense")
Filter types for chart of accounts
string
required
ID of the chart of account for which transactions need to be listed.
string
Filter transactions dated after this date (YYYY-MM-DD format). Alternative to date_start/date_end.
string
Filter transactions on or after this date (YYYY-MM-DD format). Use with date_end for a date range.
string
Filter transactions dated before this date (YYYY-MM-DD format). Alternative to date_start/date_end.
string ("account_name" | "account_type")
Sort column options
string
required
Unique identifier of the Zoho Books organization. Retrieve this using the List Organizations action.
number
Filter transactions with amount less than this value.
string ("invoice" | "customer_payment" | "bills" | "vendor_payment" | "credit_notes" | "creditnote_refund" | "expense" | "card_payment" | "purchase_or_charges" | "journal" | "deposit" | "refund" | "transfer_fund" | "base_currency_adjustment" | "opening_balance" | "sales_without_invoices" | "expense_refund" | "tax_refund" | "receipt_from_initial_debtors" | "owner_contribution" | "interest_income" | "other_income" | "owner_drawings" | "payment_to_initial_creditors")
Transaction types for filtering
number
Filter transactions with amount less than or equal to this value.
number
Filter transactions with amount greater than this value.
number
Filter transactions with amount greater than or equal to this value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_CONTACT_COMMENTSTool to retrieve recent activities and comments for a specific contact. Use when you need to fetch the comment history of a contact.

Input Parameters

integer
Page number to be fetched. Default value is 1.
integer
Number of records to be fetched per page. Default value is 200.
string
required
Unique identifier of the contact.
string
required
Organization ID (query param)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_CONTACT_PERSONSTool to retrieve a paginated list of contact persons from Zoho Books. Use when you need to list all contact persons across all contacts in the organization.

Input Parameters

integer
Page number for pagination; defaults to 1
integer
Number of records per page; defaults to 200
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_CONTACT_REFUNDSList a page of refunds for a specific contact in a Zoho Books organization.

Input Parameters

integer
Page number to be fetched. Default value is 1.
integer
Number of records to be fetched per page. Default value is 200.
string
required
Unique identifier of the contact.
string
required
ID of the organization. Required for users belonging to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_CONTACTSTool to retrieve a paginated list of contacts with optional filters. Use when you need to fetch and filter contacts from Zoho Books before processing them.

Input Parameters

integer
Page number to retrieve
integer
Number of records per page (max 200)
string ("Status.All" | "Status.Active" | "Status.Inactive" | "Status.Duplicate" | "Status.PortalEnabled" | "Status.PortalDisabled" | "Invoice.OverDue" | "Invoice.Unpaid" | "Status.CreditLimitExceed" | "Status.Crm")
Filter by contact status
string
Search text on contact name or notes (max 100 chars)
string ("contact_name" | "first_name" | "last_name" | "email" | "outstanding_receivable_amount" | "created_time" | "last_modified_time")
Column to sort by
string ("customer" | "vendor")
Filter by contact type
string
Filter by email contains
string
Filter by phone contains
string
Filter by Zoho CRM Vendor ID
string
required
Organization ID (query param)
string
Filter by Zoho CRM Account ID
string
Filter by Zoho CRM Contact ID
string
Filter by address contains
string
Filter by email prefix
string
Filter by phone prefix
string
Filter by address prefix
string
Filter by primary contact last name contains
string
Filter by primary contact first name contains
string
Filter by primary contact last name prefix
string
Filter by company name contains
string
Filter by contact name contains (max 100 chars)
string
Filter by primary contact first name prefix
string
Filter by company name prefix
string
Filter by contact name prefix (max 100 chars)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_CREDIT_NOTE_REFUNDSTool to retrieve a paginated list of credit note refunds with filters. Use when you need to fetch credit note refunds from Zoho Books.

Input Parameters

integer
Page number for pagination. Specify which page of results to retrieve.
integer
Number of records per page for pagination. Controls how many credit note refunds are returned in each page.
string
Customer ID of the customer for whom the credit note is raised. Use to filter refunds by customer.
string ("refund_mode" | "reference_number" | "date" | "creditnote_number" | "customer_name" | "amount_bcy" | "amount_fcy")
Sort refunds list by the specified column.
string
required
ID of the organization. Required when the user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_CREDIT_NOTESTool to retrieve a paginated list of credit notes with optional filters. Use when you need to discover credit note IDs or fetch credit notes by status, customer, date, or amount.

Input Parameters

string
Filter credit notes by the date they were raised. Use yyyy-mm-dd format to search for credit notes created on a specific date.
integer
Page number for pagination. Specify which page of results to retrieve. Default value is 1.
number
Filter credit notes by their total amount. Use this parameter to search for credit notes with a specific total value.
string ("open" | "closed" | "void" | "draft")
Filter credit notes by their current status.
string
Filter credit notes by tax ID. Use this parameter to search for credit notes with a specific tax applied. Retrieve tax IDs from the taxes API.
string
Filter credit notes by item ID. Use this parameter to search for credit notes containing a specific item. Retrieve item IDs from the items API.
integer
Number of records per page for pagination. Controls how many credit notes are returned in each page. Default value is 200.
string ("Status.All" | "Status.Open" | "Status.Draft" | "Status.Closed" | "Status.Void")
Filter credit notes by status using predefined status values.
string
Filter credit notes by item name. Use this parameter to search for credit notes containing specific items.
string
Filter credit notes by customer ID. Use this parameter to search for credit notes associated with a specific customer. Retrieve customer IDs from the contacts API.
string
Search credit notes using text search across multiple fields. Searches credit note number, customer name, and reference number.
string ("customer_name" | "creditnote_number" | "balance" | "total" | "date" | "created_time")
Sort credit notes by specified column.
string
Filter credit notes by line item ID. Use this parameter to search for credit notes containing a specific line item within the credit note.
string
Filter credit notes by customer name. Use this parameter to search for credit notes associated with a specific customer.
string
required
Unique identifier of the Zoho Books organization. Required for users with multiple organizations.
string
Filter credit notes by item description. Supports variants item_description_startswith and item_description_contains for flexible searching.
string
Filter credit notes by their reference number. Use this parameter to search for credit notes with a specific reference number.
string
Filter credit notes by specific credit note number. Use this parameter to search for a particular credit note by its unique number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_CURRENCIESList currencies configured for an organization, with pagination and an optional filter to exclude the base currency.

Input Parameters

integer
Page number for pagination (default: 1)
integer
Number of records per page (default: 200)
string
Filter to exclude the base currency. Allowed value: “Currencies.ExcludeBaseCurrency”.
string
required
Organization ID (query parameter)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_CUSTOMER_PAYMENT_REFUNDSTool to list refunds of a customer payment. Use when retrieving all refund transactions for a specific customer payment.

Input Parameters

integer
Page number to be fetched. Default value is 1.
integer
Number of records to be fetched per page. Default value is 200.
string
required
ID of the organization. Required for users belonging to multiple organizations.
string
required
Unique identifier of the customer payment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_CUSTOMER_PAYMENTSList a page of customer payments in Zoho Books with optional filters. Pagination information indicates whether more pages are available.

Input Parameters

string
Search payments by payment date in YYYY-MM-DD format.
integer
Page number to be fetched. Default value is 1.
string
Search payments by customer notes. Variants: notes_startswith and notes_contains
number
Search payments by payment amount. Variants: amount_less_than, amount_less_equals, amount_greater_than and amount_greater_equals
integer
Number of records to be fetched per page. Default value is 200.
string
Filter payments by mode. Allowed Values: PaymentMode.All, PaymentMode.Check, PaymentMode.Cash, PaymentMode.BankTransfer, PaymentMode.Paypal, PaymentMode.CreditCard, PaymentMode.GoogleCheckout, PaymentMode.Credit, PaymentMode.Authorizenet, PaymentMode.BankRemittance, PaymentMode.Payflowpro, PaymentMode.Stripe, PaymentMode.TwoCheckout, PaymentMode.Braintree and PaymentMode.Others
string
Customer ID of the customer involved in the payment.
string
Search payments by reference number or customer name or payment description. Max-length [100]
string
Column to sort by.
string
Search payments by payment mode. Variants: payment_mode_startswith and payment_mode_contains
string
Search payments by customer name. Variants: customer_name_startswith and customer_name_contains. Max-len [100]
string
required
ID of the organization. Required for users belonging to multiple organizations.
string
Search payments by reference number. Variants: reference_number_startswith and reference_number_contains. Max-len [100]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_EMPLOYEESTool to retrieve a paginated list of employees. Use when you need to fetch and browse employees of an organization in Zoho Books.

Input Parameters

integer
Page number to be fetched. Default value is 1.
integer
Number of records to be fetched per page. Default value is 200.
string
required
Unique numeric identifier for the Zoho Books organization. Obtain this by calling the ZOHO_BOOKS_LIST_ORGANIZATIONS action, which returns all organizations accessible to the authenticated user. Format: numeric string (e.g., ‘903642962’). Do NOT use placeholder values like ‘your_organization_id’ or ‘123456789’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_ESTIMATE_COMMENTS_AND_HISTORYTool to retrieve comments and history for a specific estimate. Use when you need to fetch activity log, status changes, or user comments associated with an estimate.

Input Parameters

string
required
Unique identifier of the estimate.
string
required
Unique identifier of the Zoho Books organization. Retrieve this using the List Organizations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_ESTIMATESTool to retrieve a paginated list of estimates with optional filters. Use when you need to discover estimate IDs or fetch estimates by status, customer, date range, or amount.

Input Parameters

string
Filter estimates by exact date in YYYY-MM-DD format.
integer
Page number for pagination. Starts at 1.
number
Filter by exact total amount.
string ("draft" | "sent" | "accepted" | "declined" | "invoiced")
Filter by estimate status. draft: not yet sent, sent: sent to customer, accepted: customer accepted, declined: customer declined, invoiced: converted to invoice.
string
Filter estimates on or before this date (YYYY-MM-DD format).
integer
Number of records per page (max 200).
string ("Status.All" | "Status.Draft" | "Status.Sent" | "Status.Accepted" | "Status.Declined" | "Status.Invoiced")
Alternative status filter format using Status prefix. Use either ‘status’ or ‘filter_by’, not both.
string
Filter estimates on or after this date (YYYY-MM-DD format).
string
Filter estimates by specific customer ID.
string
Search estimates by customer name, estimate number, or reference number.
string ("customer_name" | "estimate_number" | "date" | "total" | "created_time" | "last_modified_time")
Column to sort results by.
string
Filter estimates by exact customer name.
string
Filter by exact estimate number.
string
required
Unique identifier of the Zoho Books organization. Retrieve this using the List Organizations action.
number
Filter estimates with total less than specified amount.
number
Filter estimates with total greater than specified amount.
string
Filter estimates where customer name contains the specified text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_ESTIMATE_TEMPLATESTool to retrieve a list of estimate templates. Use when you need to fetch available estimate templates for the organization.

Input Parameters

string
required
ID of the organization. Required for users with multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_EXPENSE_COMMENTSTool to retrieve history and comments for a specific expense. Use when you need to fetch the comment history and activity log of an expense.

Input Parameters

string
required
Unique identifier of the expense.
string
required
Organization ID (query param)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_EXPENSESTool to retrieve a paginated list of expenses with filters and search. Use when you need to fetch and filter expenses from Zoho Books.

Input Parameters

string
Search expenses by expense date (exact match). Format: YYYY-MM-DD.
integer
Page number to retrieve, starting from 1.
number
Search expenses by exact amount.
string ("unbilled" | "invoiced" | "reimbursed" | "non-billable" | "billable")
Filter expenses by status.
string
Search expenses by expense date up to this date. Format: YYYY-MM-DD.
integer
Number of records per page (default 200, max 200).
string ("Status.All" | "Status.Billable" | "Status.Nonbillable" | "Status.Reimbursed" | "Status.Invoiced" | "Status.Unbilled")
Filter expenses by status category.
string
Filter expenses by vendor ID.
string
Search expenses dated after this date. Format: YYYY-MM-DD.
string
Search expenses by expense date starting from this date. Format: YYYY-MM-DD.
string
Filter expenses by customer ID.
string
Search expenses dated before this date. Format: YYYY-MM-DD.
string
Search expenses by description (exact match).
string
Search expenses by account name, description, customer name, or vendor name.
string ("date" | "account_name" | "total" | "bcy_total" | "reference_number" | "customer_name" | "created_time")
Column to sort expenses by.
string
Search expenses by vendor name (exact match).
string
Search expenses by expense account name (exact match).
string
Search expenses by customer name (exact match).
string
required
ID of the organization. Required when user belongs to multiple organizations.
number
Search expenses with amount less than this value.
string
Search expenses by reference number (exact match).
number
Search expenses with amount less than or equal to this value.
number
Search expenses with amount greater than this value.
string
Search expenses by description containing this string.
string
Search expenses by recurring expense ID.
string
Search expenses by vendor name containing this string.
string
Search expenses by expense account name containing this string.
number
Search expenses with amount greater than or equal to this value.
string
Search expenses by customer name containing this string.
string
Search expenses by description starting with this string.
string
Search expenses by vendor name starting with this string.
string
Search expenses by expense account name starting with this string.
string
Search expenses by paid through account ID.
string
Search expenses by customer name starting with this string.
string
Search expenses by reference number containing this string.
string
Search expenses by reference number starting with this string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_FIXED_ASSETSTool to retrieve a paginated list of fixed assets from Zoho Books. Use when you need to fetch and filter fixed assets with optional sorting and pagination.

Input Parameters

integer
Page number to be fetched. Default value is 1.
integer
Number of records to be fetched per page. Default value is 200.
string ("Status.All" | "Status.Active" | "Status.Cancel" | "Status.FullyDepreciated" | "Status.WriteOff" | "Status.Sold" | "Status.Draft")
Filter fixed asset by fixed asset status.
string ("A" | "D")
Sort fixed asset list in ascending (A) or descending (D) order.
string ("asset_name" | "asset_number" | "asset_cost" | "created_time" | "current_asset_value")
Sort fixed asset list by the specified column.
string
required
The organization ID. Required when the user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_FIXED_ASSET_TYPESTool to retrieve a paginated list of fixed asset types from Zoho Books. Use when you need to fetch available fixed asset type classifications for categorizing fixed assets.

Input Parameters

integer
Page number to be fetched. Default value is 1.
integer
Number of records to be fetched per page. Default value is 200.
string
required
The unique ID of the organization. Required when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_INVOICE_COMMENTS_AND_HISTORYTool to list comments and history entries for an invoice. Use when retrieving all comments and historical activities associated with a specific invoice.

Input Parameters

string
required
Unique identifier of the invoice
string
required
ID of the organization to which the invoice belongs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_INVOICE_CREDITS_APPLIEDTool to list credit notes applied to an invoice. Use when retrieving all credit transactions applied to a specific invoice.

Input Parameters

string
required
Unique identifier of the invoice
string
required
ID of the organization to which the invoice belongs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_INVOICE_PAYMENTSTool to list payments recorded against an invoice. Use when retrieving all payment transactions applied to a specific invoice.

Input Parameters

string
required
Unique identifier of the invoice
string
required
ID of the organization to which the invoice belongs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_INVOICESTool to retrieve a paginated list of invoices with filters and search. Use when you need to fetch and filter invoices before processing.

Input Parameters

integer
Page number to retrieve, starting from 1.
string ("sent" | "draft" | "overdue" | "paid" | "void" | "unpaid" | "partially_paid" | "viewed")
Filter by invoice status.
string
Filter by invoice date up to (YYYY-MM-DD).
integer
Number of records per page. Defaults to 25 for optimal response size; API default is 200.
string
Filter by predefined filters like Status.Sent or Date.PaymentExpectedDate.
string
Filter by invoice date starting from (YYYY-MM-DD).
string ("A" | "D")
Sort order: A for ascending, D for descending.
integer
Filter by customer ID.
string
Search text on invoice number, reference number, or customer name.
string ("customer_name" | "invoice_number" | "date" | "due_date" | "total" | "balance" | "created_time")
Column to sort by.
string
Filter by due date up to (YYYY-MM-DD).
string
Filter by customer name.
string
Filter by due date starting from (YYYY-MM-DD).
string
Filter by exact invoice number.
string
required
ID of the organization. Required for users with multiple organizations.
integer
Undocumented parameter that controls response verbosity. Observed behavior: 0 or omit for full invoice details (default), 1 for full details plus aggregate totals in page_context, 2 for only page_context with counts/totals (no invoice array). Note: This parameter is not in official Zoho Books API documentation and may change without notice.
string
Filter by invoice numbers containing this string.
string
Filter by invoice numbers starting with this string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_INVOICE_TEMPLATESTool to retrieve a list of invoice templates. Use when you need to fetch available invoice templates for the organization.

Input Parameters

string
required
ID of the organization. Required for users with multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_ITEM_DETAILSTool to bulk fetch details for multiple items from Zoho Books using their IDs. Use when you need to retrieve detailed information for multiple items in a single API call.

Input Parameters

string
required
Comma-separated list of item IDs to retrieve (e.g., ‘4815000000044208,4815000000044274,4815000000044340’). Multiple item IDs must be separated by commas without spaces.
string
required
Numeric ID of your Zoho Books organization (e.g., ‘913373484’). Must contain only digits. To obtain valid organization IDs, first call ZOHO_BOOKS_LIST_ORGANIZATIONS which returns all organizations accessible to your account. Each organization has an ‘organization_id’ field. Invalid or non-existent organization IDs will result in 404 errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_ITEMSTool to retrieve a paginated list of items from Zoho Books. Use when you need to list items with optional filters, search, and sorting.

Input Parameters

string
Exact match search by item name
integer
Page number for pagination (default 1)
number
Exact match search by item rate
string
Filter by tax ID
integer
Number of items per page (default 200)
string
Filter by tax name
string ("Status.All" | "Status.Active" | "Status.Inactive")
Filter items by status
string
Account ID to associate the item with
boolean
Whether the item is taxable (India, US, Mexico editions)
string ("A" | "D")
Sort order: ascending (A) or descending (D)
string
Exact match search by item description
string
Search term to look in name or description (max 100 characters)
string ("name" | "rate" | "tax_name")
Column to sort the results by
string
SAT unit key code (Mexico edition)
string
Search items whose names contain this value
number
Search items with rate less than this value
string
Search items whose names start with this value
string
required
Numeric ID of your Zoho Books organization (e.g., ‘913373484’). Must contain only digits. To obtain valid organization IDs, first call ZOHO_BOOKS_LIST_ORGANIZATIONS which returns all organizations accessible to your account. Each organization has an ‘organization_id’ field. Invalid or non-existent organization IDs will result in 404 errors.
number
Search items with rate less than or equal to this value
string
Tax exemption ID (required if is_taxable=false)
number
Search items with rate greater than this value
string
SAT item key code (Mexico edition)
number
Search items with rate greater than or equal to this value
string
Search items whose descriptions contain this value
string
Search items whose descriptions start with this value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_JOURNAL_TEMPLATESTool to list journal templates with pagination. Use when you need to retrieve predefined journal entry templates for accounting.

Input Parameters

integer
Page number for pagination. Starts at 1.
integer
Number of records per page (max 200).
string
required
Unique identifier of the Zoho Books organization. Retrieve this using the List Organizations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_LOCATIONSTool to list all locations in the organization. Use when you need to retrieve all available locations from Zoho Books.

Input Parameters

string
required
The organization_id parameter should be sent with every API request to identify the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_ORGANIZATIONSTool to list all organizations for the authenticated user. Use when you need to obtain the organization_id for subsequent API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_PROJECTSTool to retrieve a paginated list of projects with optional filters. Use when you need to fetch projects from Zoho Books for a specific organization.

Input Parameters

integer
Page number to be fetched
integer
Number of records to be fetched per page
string ("Status.All" | "Status.Active" | "Status.Inactive")
Filter projects by status
string
Search projects by customer id
string ("project_name" | "customer_name" | "rate" | "created_time")
Column to sort projects by
string
required
The organization ID to associate the request with. Required when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_PROJECT_USERSTool to retrieve all users assigned to a project. Use when you need to fetch the list of users associated with a specific project in Zoho Books.

Input Parameters

string
required
Unique identifier of the project
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_PURCHASE_ORDERSTool to retrieve a paginated list of purchase orders. Use when listing purchase orders with filters, search, and pagination.

Input Parameters

string
Search by exact purchase order creation date (YYYY-MM-DD format).
integer
Page number to retrieve, starting from 1.
number
Search by exact total amount.
string ("draft" | "open" | "billed" | "cancelled")
Filter by purchase order status.
string
Filter by item ID. Use to locate all purchase orders containing a particular item.
integer
Number of records per page. Default and maximum is 200.
string ("Status.All" | "Status.Draft" | "Status.Open" | "Status.Billed" | "Status.Cancelled")
Predefined status filter for bulk filtering.
number
Search by total amount up to this value.
string
Filter by vendor ID. Use to group purchase orders by specific vendor.
string
General search across purchase order number, reference, and vendor name.
string ("vendor_name" | "purchaseorder_number" | "date" | "delivery_date" | "total" | "created_time")
Column to sort by.
number
Search by total amount starting from this value.
string
Search by exact vendor name.
string
Search by exact custom field value.
string
required
ID of the organization. Required for users with multiple organizations.
number
Filter by total amount less than this value.
string
Search by exact item description.
string
Search by exact reference number.
number
Filter by total amount less than or equal to this value.
string
Filter by last modified time (ISO 8601 format: YYYY-MM-DDTHH:MM:SS+/-HH:MM). Use to identify recently updated purchase orders.
number
Filter by total amount greater than this value.
string
Search by exact purchase order number.
number
Filter by total amount greater than or equal to this value.
string
Search by vendor names containing this string.
string
Search by custom field values containing this string.
string
Search by vendor names starting with this string.
string
Search by custom field values starting with this string.
string
Search by item descriptions containing this string.
string
Search by reference numbers containing this string.
string
Search by item descriptions starting with this string.
string
Search by reference numbers starting with this string.
string
Search by purchase order numbers containing this string.
string
Search by purchase order numbers starting with this string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_RECURRING_BILL_HISTORYTool to list comments and history entries for a recurring bill. Use when retrieving all comments and historical activities associated with a specific recurring bill.

Input Parameters

string
required
ID of the organization to which the recurring bill belongs
string
required
Unique identifier of the recurring bill

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_RECURRING_INVOICE_HISTORYTool to retrieve comments and history for a specific recurring invoice. Use when you need to view all activities, comments, and historical changes associated with a recurring invoice.

Input Parameters

string
required
The unique identifier for the organization in Zoho Books. Required when user belongs to multiple organizations.
string
required
Unique identifier of the recurring invoice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_REPORTING_TAGSTool to retrieve all reporting tags from Zoho Books. Use when you need to list reporting tags for categorization and filtering purposes.

Input Parameters

string
required
Numeric ID of your Zoho Books organization (e.g., ‘913373484’). Must contain only digits. To obtain valid organization IDs, first call ZOHO_BOOKS_LIST_ORGANIZATIONS which returns all organizations accessible to your account. Each organization has an ‘organization_id’ field. Invalid or non-existent organization IDs will result in 404 errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_RETAINER_INVOICESTool to retrieve a paginated list of retainer invoices with filters and sorting. Use when listing retainer invoices before processing them.

Input Parameters

integer
Page number to retrieve, starting from 1.
boolean
Export and print the PDF of retainer invoices.
integer
Number of records per page (default: 200, max: 200).
string ("Status.All" | "Status.Sent" | "Status.Draft" | "Status.OverDue" | "Status.Paid" | "Status.Void" | "Status.Unpaid" | "Status.PartiallyPaid" | "Status.Viewed" | "Date.PaymentExpectedDate")
Filter retainer invoices by status or payment expected date.
string ("A" | "D")
Sort order: A for ascending, D for descending.
string ("customer_name" | "retainerinvoice_number" | "date" | "due_date" | "total" | "balance" | "created_time")
Column to sort by.
string
required
ID of the organization. Required for users with multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_SALES_ORDER_COMMENTS_AND_HISTORYTool to list comments and history entries for a sales order. Use when retrieving all comments and historical activities associated with a specific sales order.

Input Parameters

string
required
Unique identifier of the sales order
string
required
ID of the organization to which the sales order belongs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_SALES_ORDERSTool to retrieve a paginated list of sales orders. Use when browsing sales orders by organization with optional sorting and filtering.

Input Parameters

integer
Page number, must be ≥1
integer
Records per page, max 200
string ("Status.All" | "Status.Open" | "Status.Draft" | "Status.OverDue" | "Status.PartiallyInvoiced" | "Status.Invoiced" | "Status.Void" | "Status.Closed")
Predefined status filter
string
Cross-field text search
string ("customer_name" | "salesorder_number" | "shipment_date" | "last_modified_time" | "reference_number" | "total" | "date" | "created_time")
Column to sort by
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_SALES_RECEIPTSTool to retrieve a paginated list of sales receipts with filters. Use when you need to fetch sales receipts by customer, date range, amount, or other criteria.

Input Parameters

string
Filter sales receipts by exact date. Date format: YYYY-MM-DD.
integer
Page number to retrieve, starting from 1.
number
Filter sales receipts by exact total amount.
string
Filter sales receipts up to this date (inclusive). Date format: YYYY-MM-DD.
integer
Number of records per page. Default is 200, maximum is 200.
string ("ThisWeek" | "ThisMonth" | "ThisQuarter" | "ThisYear" | "PreviousDay" | "PreviousWeek" | "PreviousMonth" | "PreviousQuarter" | "PreviousYear" | "Status.All" | "Status.Draft" | "Status.Sent")
Filter sales receipts by time period or status.
string
Search receipt by exact item name. Maximum length is 100 characters.
number
Filter sales receipts with total amount up to this value (inclusive).
string
Filter sales receipts after this date (exclusive). Date format: YYYY-MM-DD.
string
Filter sales receipts starting from this date (inclusive). Date format: YYYY-MM-DD.
string
Filter sales receipts by specific customer identifier.
string
Filter sales receipts before this date (exclusive). Date format: YYYY-MM-DD.
string ("customer_name" | "receipt_number" | "date" | "total" | "created_time")
Available columns for sorting sales receipt results.
number
Filter sales receipts with total amount starting from this value (inclusive).
string
Search receipt by exact receipt number. Maximum length is 100 characters.
string
required
ID of the organization. Required for users with multiple organizations.
number
Filter sales receipts with total amount less than this value.
string
Filter receipts where item name contains this string. Maximum length is 100 characters.
number
Filter sales receipts with total amount greater than this value.
string
Filter receipts where item name starts with this string. Maximum length is 100 characters.
string
Filter receipts where receipt number contains this string. Maximum length is 100 characters.
string
Filter receipts where receipt number starts with this string. Maximum length is 100 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_TASKSTool to retrieve a paginated list of tasks for a specific project. Use when you need to fetch tasks associated with a project in Zoho Books.

Input Parameters

integer
Page number to be fetched. Default value is 1.
integer
Number of records to be fetched per page. Default value is 200.
string
required
Unique identifier of the project.
string
required
ID of the organization. Required for users with multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_TAXESTool to retrieve a paginated list of taxes. Use when you need to fetch tax configurations for an organization in Zoho Books.

Input Parameters

integer
Page number to be fetched. Default value is 1.
integer
Number of records to be fetched per page. Default value is 200.
string
required
Unique numeric identifier for the Zoho Books organization. Obtain this by calling the ZOHO_BOOKS_LIST_ORGANIZATIONS action, which returns all organizations accessible to the authenticated user. Format: numeric string (e.g., ‘60059838605’). Do NOT use placeholder values like ‘your_organization_id’ or ‘123456789’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_TAX_EXEMPTIONSTool to retrieve a list of tax exemptions from Zoho Books. Use when you need to list tax exemptions for US Edition organizations. This feature is only available for US Edition of Zoho Books.

Input Parameters

string
required
Numeric ID of your Zoho Books organization (e.g., ‘903642962’). Must contain only digits. To obtain valid organization IDs, first call ZOHO_BOOKS_LIST_ORGANIZATIONS which returns all organizations accessible to your account. Each organization has an ‘organization_id’ field. Invalid or non-existent organization IDs will result in 404 errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_USERSTool to retrieve a paginated list of users. Use when you need to fetch and browse users of an organization in Zoho Books.

Input Parameters

integer
Page number to retrieve (default 1, minimum 1)
integer
Number of records per page (default 200, max 200)
string ("Status.All" | "Status.Active" | "Status.Inactive" | "Status.Invited" | "Status.Deleted")
Filter by user status. Allowed: Status.All | Status.Active | Status.Inactive | Status.Invited | Status.Deleted
string ("name" | "email" | "user_role" | "status")
Column to sort by. Allowed: name | email | user_role | status
string
required
Unique numeric identifier for the Zoho Books organization. Obtain this by calling the ZOHO_BOOKS_LIST_ORGANIZATIONS action, which returns all organizations accessible to the authenticated user. Format: numeric string (e.g., ‘60059838605’). Do NOT use placeholder values like ‘your_organization_id’ or ‘123456789’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_VENDOR_CREDIT_REFUNDSTool to retrieve a paginated list of vendor credit refunds with filters. Use when you need to fetch vendor credit refunds from Zoho Books.

Input Parameters

integer
Page number for pagination. Specify which page of results to retrieve.
integer
Number of records per page for pagination. Controls how many vendor credit refunds are returned in each page.
integer
Search vendor credit refunds by vendor credit customer ID.
string ("vendor_name" | "vendor_credit_number" | "balance" | "total" | "date" | "created_time" | "last_modified_time" | "reference_number")
Sort vendor credit refunds by the specified column.
string
required
ID of the organization. Required when the user belongs to multiple organizations.
string
Search vendor credit refunds by vendor credit last modified time (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_VENDOR_CREDIT_REFUNDS2Tool to list refunds of a specific vendor credit. Use when retrieving all refund transactions applied to a particular vendor credit.

Input Parameters

integer
Page number for pagination. Specify which page of results to retrieve. Default value is 1.
integer
Number of records per page for pagination. Controls how many refunds are returned in each page. Default value is 200.
string
required
The unique identifier for the organization. Required when the user belongs to multiple organizations.
string
required
Unique identifier of the vendor credit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_VENDOR_CREDITSTool to retrieve a paginated list of vendor credits with filters and search. Use when you need to fetch and filter vendor credits before processing.

Input Parameters

string
Filter vendor credits by creation date. Use yyyy-mm-dd format.
integer
Page number to retrieve, starting from 1.
string
Filter vendor credits by notes content.
string
Filter vendor credits by their total amount.
string ("open" | "closed" | "void" | "draft")
Filter vendor credits by their current status.
integer
Filter vendor credits by tax ID. Use this parameter to search for vendor credits with a specific tax applied.
integer
Filter vendor credits by item ID. Use this parameter to search for vendor credits containing a specific item.
string
Filter by vendor credits created on or before this date (yyyy-mm-dd).
integer
Number of records per page for pagination. Default value is 200.
string ("Status.All" | "Status.Open" | "Status.Draft" | "Status.Closed" | "Status.Void")
Filter vendor credits by status using predefined status values.
string
Filter vendor credits by item name.
string
Filter by vendor credits with total amount up to this value.
string
Filter by vendor credits created after this date (yyyy-mm-dd).
string
Filter by vendor credits created on or after this date (yyyy-mm-dd).
integer
Filter vendor credits by customer ID. Use this parameter to search for vendor credits associated with a specific customer.
string
Filter by vendor credits created before this date (yyyy-mm-dd).
string
Search vendor credits using text search across vendor credit number, vendor name, and reference number.
string ("vendor_name" | "vendor_credit_number" | "balance" | "total" | "date" | "created_time" | "last_modified_time" | "reference_number")
Sort vendor credits by specified column.
string
Filter by vendor credits with total amount starting from this value.
string
Filter vendor credits by custom field values.
integer
Filter vendor credits by line item ID. Use this parameter to search for vendor credits containing a specific line item.
string
Filter vendor credits by vendor name.
string
Filter by notes containing this string.
string
required
The unique identifier for the organization. Required when the user belongs to multiple organizations.
string
Filter by vendor credits with total amount less than this value.
string
Filter vendor credits by item description.
string
Filter by notes starting with this string.
string
Filter vendor credits by their reference number.
string
Filter by vendor credits with total amount less than or equal to this value.
string
Filter by item names containing this string.
string
Filter vendor credits by last modified time. Use ISO 8601 format (yyyy-mm-ddThh:mm:ss-hh:mm).
string
Filter by vendor credits with total amount greater than this value.
string
Filter by item names starting with this string.
string
Filter by vendor credits with total amount greater than or equal to this value.
string
Filter vendor credits by specific vendor credit number.
string
Filter by custom field values containing this string.
string
Filter by vendor names containing this string.
string
Filter by custom field values starting with this string.
string
Filter by vendor names starting with this string.
string
Filter by item descriptions containing this string.
string
Filter by reference numbers containing this string.
string
Filter by item descriptions starting with this string.
string
Filter by reference numbers starting with this string.
string
Filter by vendor credit numbers containing this string.
string
Filter by vendor credit numbers starting with this string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_VENDOR_PAYMENT_REFUNDSList a page of refund transactions for a specific vendor payment in Zoho Books.

Input Parameters

integer
Page number to be fetched. Default value is 1.
integer
Number of records to be fetched per page. Default value is 200.
string
required
Unique identifier of the payment.
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_LIST_VENDOR_PAYMENTSTool to retrieve a paginated list of vendor payments with filters and search. Use when listing vendor payments for reporting or reconciliation.

Input Parameters

string
Date the payment is made (YYYY-MM-DD). Search payments by payment made date. Variants: date_start, date_end, date_before and date_after.
integer
Page number to be fetched. Default value is 1.
string
Search with Payment Notes. Variant: notes_startswith, notes_contains.
number
Payment amount made to the vendor. Search payments by payment amount. Variants: amount_less_than, amount_less_equals, amount_greater_than and amount_greater_equals.
string
Search payments by Bill ID.
string
Filter by payment date up to this date (YYYY-MM-DD).
integer
Number of records to be fetched per page. Default value is 200.
string ("PaymentMode.All" | "PaymentMode.Check" | "PaymentMode.Cash" | "PaymentMode.BankTransfer" | "PaymentMode.Paypal" | "PaymentMode.CreditCard" | "PaymentMode.GoogleCheckout" | "PaymentMode.Credit" | "PaymentMode.Authorizenet" | "PaymentMode.BankRemittance" | "PaymentMode.Payflowpro" | "PaymentMode.Others")
Enum for payment mode filter values.
string
ID of the vendor. Search payments by vendor id.
string
Filter by payments dated after this date (YYYY-MM-DD).
string
Filter by payment date starting from this date (YYYY-MM-DD).
string
Filter by payments dated before this date (YYYY-MM-DD).
string
Search payments by description. Variants: description_startswith and description_contains.
string
Search payments by reference number or vendor name or payment description.
string ("vendor_name" | "date" | "reference_number" | "amount" | "balance")
Enum for sort column values.
string
Search payments by vendor name. Variants: vendor_name_startswith and vendor_name_contains.
string
Search payments by payment mode. Variants: payment_mode_startswith and payment_mode_contains.
string
Filter by notes containing this string.
string
Search with Payment Number. Variant: payment_number_startswith, payment_number_contains.
string
required
ID of the organization. Required when user belongs to multiple organizations.
number
Filter by amount less than this value.
string
Filter by notes starting with this string.
string
Search payments by reference number. Variants: reference_number_startswith and reference_number_contains.
number
Filter by amount less than or equal to this value.
string
Search with the Last Modified Time of the Vendor Payment.
number
Filter by amount greater than this value.
string
Filter by descriptions containing this string.
string
Filter by vendor names containing this string.
number
Filter by amount greater than or equal to this value.
string
Filter by payment modes containing this string.
string
Filter by descriptions starting with this string.
string
Filter by vendor names starting with this string.
string
Filter by payment modes starting with this string.
string
Filter by payment numbers containing this string.
string
Filter by payment numbers starting with this string.
string
Filter by reference numbers containing this string.
string
Filter by reference numbers starting with this string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_BILL_OPENTool to mark a bill as open. Use when you need to change a bill’s status to open (e.g., from void status).

Input Parameters

string
required
Unique identifier of the bill to mark as open
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_BILL_VOIDTool to mark a bill as Void. Use when you need to void an existing bill after reviewing any outstanding payments.

Input Parameters

string
required
Unique identifier of the bill to void
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_CONTACT_AS_ACTIVETool to mark a contact as active. Use when you need to reactivate a previously deactivated contact after confirming its ID.

Input Parameters

string
required
Unique identifier of the contact to activate
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_CONTACT_AS_INACTIVETool to mark a contact as inactive. Use when you need to deactivate a contact after confirming its ID.

Input Parameters

string
required
Unique identifier of the contact to mark as inactive
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_ESTIMATE_AS_SENTTool to mark an estimate as Sent. Use after the estimate is finalized and ready for delivery to the customer.

Input Parameters

string
required
Unique identifier of the estimate to mark as Sent
string
required
ID of the organization. Required when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_INVOICE_AS_SENTTool to mark an invoice as Sent. Use after the invoice is finalized and ready for delivery to the customer.

Input Parameters

string
required
Unique identifier of the invoice to mark as Sent
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_ITEM_AS_ACTIVETool to mark an item as active. Use when you need to reactivate a previously deactivated item after confirming its ID.

Input Parameters

string
required
Unique identifier of the item to activate
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_ITEM_INACTIVETool to mark an item as inactive. Use when you need to deactivate an item after confirming its ID.

Input Parameters

string
required
Unique identifier of the item to mark as inactive
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_LOCATION_ACTIVETool to mark a location as active. Use when you need to activate a previously inactive location.

Input Parameters

string
required
Unique identifier of the location to mark as active
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_LOCATION_INACTIVETool to mark a location as inactive. Use when you need to deactivate a location without permanently deleting it.

Input Parameters

string
required
Unique identifier of the location to mark as inactive
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_LOCATION_PRIMARYTool to mark a location as primary. Use when you need to set a specific location as the primary location for the organization after confirming its ID.

Input Parameters

string
required
Unique identifier of the location to mark as primary
string
required
Your organization ID (required with all Zoho Books API requests)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_PROJECT_ACTIVETool to mark a project as active. Use when you need to reactivate a previously inactive project after confirming its ID.

Input Parameters

string
required
Unique identifier of the project to activate
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_REPORTING_TAG_AS_ACTIVETool to mark a reporting tag as active. Use when you need to activate a reporting tag after ensuring it has at least one option configured.

Input Parameters

string
required
Unique identifier of the reporting tag to mark as active
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_REPORTING_TAG_AS_INACTIVETool to mark a reporting tag as inactive. Use when you need to deactivate a reporting tag that is no longer needed.

Input Parameters

string
required
Unique identifier of the reporting tag to mark as inactive
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_REPORTING_TAG_DEFAULT_OPTIONTool to mark an option as default for a reporting tag. Use when you need to set a specific tag option as the default choice.

Input Parameters

string
required
The reporting tag ID
string
required
The organization ID to identify the organization
string
required
ID of the option to be marked as default. If this parameter is not sent or sent empty, the current default option of the tag will be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_RETAINER_INVOICE_SENTTool to mark a retainer invoice as Sent. Use after the retainer invoice is finalized and ready for delivery to the customer.

Input Parameters

string
required
ID of the organization
string
required
Unique identifier of the retainer invoice to mark as sent

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_SALES_ORDER_VOIDTool to mark a sales order as Void. Use when you need to void an existing sales order after reviewing any outstanding deliveries or invoices.

Input Parameters

string
required
Unique identifier of the sales order to void
string
required
ID of the organization. Required when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_TAG_OPTION_ACTIVETool to mark a reporting tag option as active. Use when you need to activate a previously inactive tag option for an organization.

Input Parameters

string
required
Unique identifier of the reporting tag
string
required
Unique identifier of the tag option to mark as active
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_TAG_OPTION_AS_INACTIVETool to mark a reporting tag option as inactive. Use when you need to deactivate a specific tag option for reporting purposes.

Input Parameters

string
required
The reporting tag ID
string
required
The option ID to mark as inactive
string
required
The organization ID to identify the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_USER_INACTIVETool to mark a user as inactive in Zoho Books. Use when you need to deactivate a user account while preserving their historical data.

Input Parameters

string
required
Unique identifier of the user to mark as inactive. Obtain this by calling the ZOHO_BOOKS_LIST_USERS action. Format: numeric string (e.g., ‘7472322000000265001’). Note: You cannot mark your own user account as inactive.
string
required
Unique numeric identifier for the Zoho Books organization. Obtain this by calling the ZOHO_BOOKS_LIST_ORGANIZATIONS action. Format: numeric string (e.g., ‘60059838605’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_MARK_VENDOR_CREDIT_VOIDTool to void a vendor credit. Use when you need to mark an existing vendor credit as void, making it inactive in the system.

Input Parameters

string
required
ID of the organization. Required when the user belongs to multiple organizations.
string
required
Unique identifier of the vendor credit to void

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_OPEN_SALES_ORDERTool to mark a sales order as Open. Use when a sales order in Draft status needs to be opened for processing.

Input Parameters

string
required
Unique identifier of the sales order to open
string
required
ID of the organization to which the sales order belongs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_PRINT_BULK_ESTIMATESTool to bulk print up to 25 estimates as a single PDF. Use when you have multiple estimate IDs and need a combined PDF for printing.

Input Parameters

array
required
List of estimate IDs to print (max 25 items)
string
required
The organization ID in Zoho Books

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_PRINT_BULK_SALES_ORDERSTool to bulk print up to 25 sales orders as a single PDF. Use when you have multiple sales order IDs and need a combined PDF for printing.

Input Parameters

array
required
List of sales order IDs to print (max 25 items)
string
required
The organization ID in Zoho Books

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_REMIND_CUSTOMER_INVOICETool to send a payment reminder for an invoice. Use when invoice is in Open or Overdue status.

Input Parameters

string
Body content of the reminder email.
string
Subject of the reminder email.
string
required
Unique identifier of the invoice
array
List of CC email addresses for the reminder email.
array
List of recipient email addresses to send the reminder to.
string
required
ID of the organization
boolean
If true, send from the organization’s email address instead of the user email.
boolean
Include customer statement with the reminder email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_RESUME_RECURRING_INVOICETool to resume a recurring invoice. Use when you need to reactivate a paused or stopped recurring invoice.

Input Parameters

string
required
ID of the organization. Required when user belongs to multiple organizations.
string
required
Unique identifier of the recurring invoice to resume

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_SEND_BULK_INVOICE_REMINDERTool to send payment reminders for multiple invoices at once. Use when you need to send reminders to multiple customers for their outstanding invoices.

Input Parameters

array
required
List of invoice IDs for which payment reminders should be sent
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_SEND_CONTACT_EMAILTool to send an email to a contact in Zoho Books. Use when you need to email a customer or vendor about statements, documents, or general communication.

Input Parameters

string
required
Email body content (plain text or HTML)
string
required
Email subject line
string
required
Unique identifier of the contact to email
array
Array of email addresses to CC (carbon copy)
array
required
Array of recipient email addresses to send the email to
string
required
Organization ID (query param)
boolean
Whether to send attachments with the email
boolean
Whether to send from the organization’s primary email address
boolean
Send customer statement PDF with email

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_STOP_RECURRING_INVOICETool to stop a recurring invoice. Use when you need to stop a recurring invoice from generating future invoices.

Input Parameters

string
required
ID of the organization
string
required
Unique identifier of the recurring invoice to stop

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UNTRACK_CONTACT1099Tool to untrack a contact for 1099 reporting. Use when you need to stop tracking a vendor for 1099 tax form reporting in the US.

Input Parameters

string
required
Unique identifier of the contact to untrack for 1099 reporting
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_BANK_TRANSACTIONTool to update an existing bank transaction in Zoho Books. Use when you need to modify transaction details such as amount, description, or date after the transaction has been created.

Input Parameters

string
Transaction date in YYYY-MM-DD format
array
List of tags to apply
number
Transaction amount, must be non-negative
string
Tax or tax group ID (not applicable in US)
integer
ID of the user involved
array
List of files to attach
array
Detailed transaction breakdown with account, tax, and amount information
string
Currency ID of the transaction
string
ID of the customer or vendor
string
Brief description or memo
number
Bank charges for this transaction
string
Mode of payment; not applicable to transfer_fund, card_payment, owner_drawings
array
List of custom fields to populate
number
Foreign currency exchange rate, must be >0
string
Account ID funds are transferred to. Required for: transfer_fund, deposit, sales_return, expense_refund, owner_drawings. For owner_drawings, must be equity account type. From bank accounts, can transfer to: bank/card/equity (drawings)/expense/credit_note account types. From card accounts, can transfer to: card/bank/expense account types
string
Account ID funds are transferred from. Required for: transfer_fund, card_payment, sales_without_invoices, expense_refund, other_income, owner_drawings. Account type must match transaction_type: card_payment requires credit_card account type; owner_drawings requires bank/cash/credit_card account type; transfer_fund requires bank or cash account type. For deposits to bank accounts, can be bank/card/income/refund type. For deposits to card accounts, can be bank/card/refund type
string
required
Zoho Books organization ID
array
List of tags on to-account entry
boolean
Whether the tax is inclusive
string
Reference number for transaction
string
Tax authority ID (US, AU, CA only)
string
Tax exemption ID (IN, US, AU, CA only)
string ("deposit" | "refund" | "transfer_fund" | "card_payment" | "sales_without_invoices" | "expense_refund" | "owner_contribution" | "interest_income" | "other_income" | "owner_drawings" | "sales_return")
required
Type of transaction. Account type requirements vary by transaction_type: ‘deposit’ requires to_account (bank/card can receive from bank/card/income/refund accounts); ‘refund’ (credit card accounts only); ‘transfer_fund’ requires from_account and to_account (both bank/card); ‘card_payment’ requires from_account (credit card type) and to_account; ‘sales_without_invoices’ requires from_account; ‘expense_refund’ requires from_account and to_account; ‘owner_contribution’ (equity account as to_account); ‘interest_income’ (income account); ‘other_income’ requires from_account; ‘owner_drawings’ requires from_account (bank/cash/credit card) and to_account (equity type); ‘sales_return’ requires to_account
array
List of tags on from-account entry
string
required
Unique identifier of the bank transaction to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_BILLTool to update a vendor bill. Use when you need to modify an existing bill in Zoho Books. Use after fetching the current bill details.

Input Parameters

string
Bill date YYYY-MM-DD.
string
Notes for bill.
array
Bill-level taxes.
string
Terms & conditions.
string
India: 15-digit GSTIN.
string
required
Unique identifier of the bill to update.
string
Due date YYYY-MM-DD.
array
Approval workflow.
array
Documents to attach.
string
required
Vendor identifier.
number
Manual adjustment.
object
Optional file attachment.
array
Line items.
string
required
Unique bill number/reference.
string
Currency ID if multi-currency.
string
Location ID.
string
Price book ID.
array
Custom fields.
number
Exchange rate.
string ("business_gst" | "business_none" | "overseas" | "consumer")
India: GST treatment. Optional; required only for India GST orgs.
integer
Payment terms in days.
string
UAE: permit number.
string
GCC/MX/KE/ZA: tax treatment.
string
required
Zoho Books organization ID.
string
GCC: place-of-supply code.
boolean
Prices include tax (non-US).
string
External reference.
string
India: GST source state.
array
Purchase Order IDs.
string
Recurring bill template ID.
string
Custom label.
string
India: GST dest state.
string
Adjustment reason.
boolean
Tax at item level.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_CONTACTUpdate supported details of a Zoho Books contact identified by contact ID and organization ID. A contact name is required.

Input Parameters

array
Reporting tags
string
Additional notes
string
India-only GSTIN (15 characters)
string
Tax ID (IN/US)
string
Twitter/X profile URL
string
Website URL of contact
string
Facebook profile URL
string
Owner user ID (customers only)
string
required
Contact ID to update
boolean
Whether contact is taxable
Mexico-only legal name
string
Tax registration number (GCC/MX/KE/ZA)
string
Mexico-only tax regime
boolean
US-only 1099 tracking flag
string
VAT registration number (UK/Avalara)
string
Currency identifier
string
US-only tax ID type (SSN/ATIN/ITIN/EIN)
string
Company or legal name
string
required
Display name of the contact
string ("customer" | "vendor")
Type of contact: customer or vendor
string
Two-letter country code (UK/GCC/Avalara)
number
Maximum credit limit (customers only)
string
Associated pricebook ID
string
US-only tax ID value
array
Custom field values
string
India-only GST treatment
integer
Number of days allowed for payment
string
Region-specific tax treatment value
string
UK-only VAT treatment
string
Custom contact number
string
Avalara use code
object
Billing address details
array
List of contact persons
string
required
Organization ID (query param)
string
Avalara exemption certificate number
array
Opening balances for locations
string
India-only place of contact code
object
Shipping address details
string
US-only tax authority ID
string
US/CA/AU/IN tax exemption ID
string ("individual" | "business")
Customer subtype (only for customers)
object
Default document templates
boolean
Mexico-only TDS registered flag
string
Tax authority name
string
US/CA/AU/IN tax exemption code
string
Label for payment terms
boolean
Skip auto-generation of contact number
string
Kenya tax exemption certificate no.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_CONTACT_PERSONTool to update an existing contact person in Zoho Books. Use when modifying details of a contact person after verifying their contact_person_id.

Input Parameters

string
Email address of the contact person. Max-length [100]
string
Phone number. Max-length [50]
string
Skype address. Max-length [50]
string
Mobile number. Max-length [50]
string
Last name of the contact person. Max-length [100]
string
required
Contact identifier for the associated contact
string
Department on which a person belongs. Max-length [50]
string
required
First name of the contact person. Max-length [100]
string
Salutation for the contact. Max-length [25]
string
Designation of a person. Max-length [50]
boolean
Portal access option (true/false)
string
required
Organization ID (required query parameter)
string
required
Unique identifier of the contact person to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_CREDIT_NOTE_REFUNDTool to update details of a specific credit note refund. Use when you need to modify an existing refund associated with a credit note—change the description, reference number, or other refund fields.

Input Parameters

string
Refund date in yyyy-mm-dd format
number
Refund amount
string
Additional details about the refund
string
Method of refund (e.g., cash, check, bank transfer)
string
required
Unique identifier of the credit note.
string
The account from which the refund originates
string
required
ID of the organization
string
Reference identifier
string
required
Unique identifier of the credit note refund.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_CURRENCYTool to update an existing currency in Zoho Books. Use when you need to modify currency settings such as symbol, format, or precision.

Input Parameters

string
required
Unique identifier of the currency to update
string
required
A unique standard code for the currency. Max-len [100]
string
required
The format for the currency to be displayed. Max-len [100]
string
A unique symbol for the currency. Max-len [4]
string
required
The organization ID for which the currency is being updated
integer
The precision level for pricing display

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_CUSTOM_FIELDS_IN_ITEMTool to update custom field values in an existing item. Use when you need to modify custom field data for a specific item without changing other item properties.

Input Parameters

string
required
Unique identifier of the item whose custom fields should be updated
array
required
List of custom fields to update with their new values
string
required
ID of the organization context

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_ESTIMATETool to update an existing estimate (quote). Use when you need to modify an existing customer quote in Zoho Books.

Input Parameters

string
Estimate date in YYYY-MM-DD format.
string
Notes for the estimate.
string
Terms and conditions.
string
15-digit GSTIN (India only).
string
Top-level tax ID.
number
Overall discount amount.
number
Adjustment amount.
array
Line items for the estimate.
string
Associated project ID.
string
Currency ID for the estimate.
string
Custom email body.
string
Contact ID of the customer for the estimate.
string
required
Unique identifier of the estimate to update.
string
Expiry date in YYYY-MM-DD format.
string
Business location ID.
string
ID of the PDF template to use.
array
Custom fields to add to estimate.
string ("entity_level" | "item_level")
Discount type (entity_level or item_level).
number
Exchange rate for multi-currency.
string ("business_gst" | "business_none" | "overseas" | "consumer")
GST treatment (India/GCC only).
string
Custom email subject.
string
Custom estimate number if auto-numbering is ignored.
string
required
Zoho Books organization ID.
string
Place of supply code (India/GCC only).
number
Shipping charge amount.
boolean
Line item prices include tax if true (non-US/CA).
string
External reference number.
string
Salesperson name.
string
Description for adjustment.
boolean
Apply discount before tax if true.
array
List of contact persons to associate with estimate.
boolean
Ignore auto numbering and provide custom estimate_number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_ESTIMATE_BILLING_ADDRESSTool to update the billing address of an estimate. Use when you need to modify billing address details for an existing estimate in Zoho Books.

Input Parameters

string
Fax number for billing address
string
Postal code for billing address
string
City name for billing address
string
Phone number for billing address
string
State or province for billing address
string
Street address line 1 for billing
string
Country name for billing address
string
Street address line 2 for billing
string
Contact person name for the billing address
string
required
Unique identifier of the estimate
string
required
Organization ID for the Zoho Books account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_ESTIMATE_SHIPPING_ADDRESSTool to update the shipping address for an estimate. Use when you need to modify the delivery address details of an existing estimate.

Input Parameters

string
Fax number for the address. Max-length [50]
string
Postal or ZIP code for the address. Max-length [50]
string
City name for the address. Max-length [100]
string
The contact phone number associated with the address. Max-length [50]
string
State for the address. Max-length [100]
string
Street 1 address for the contact. Max-length [500]
string
Country name for the address. Max-length [100]
string
Street 2 address for the contact. Max-length [255]
string
Attention for proper delivery and routing of business correspondence. Max-length [100]
string
State or province code for the address. Max-length [100]
string
required
Unique identifier of the estimate
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_ESTIMATE_TEMPLATETool to update the template associated with an estimate. Use when you need to change the PDF template used for an existing estimate.

Input Parameters

string
required
Unique identifier of the estimate
string
required
Unique identifier of the estimate template
string
required
The unique identifier of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_INVOICEUpdate an existing Zoho Books invoice, including its line items, dates, and other invoice fields. Requires the invoice ID, organization ID, customer ID, and a list of line items.

Input Parameters

string
Invoice date in YYYY-MM-DD format
string
Notes to be printed on the invoice
string
Terms and conditions for the invoice
number
Invoice-level discount value
string
Due date in YYYY-MM-DD format
string
required
Identifier of the invoice to update
array
required
List of line items to update or add
string
Currency identifier for the invoice
string
required
Customer identifier for this invoice
string
Type of discount: entity_level or item_level
number
Exchange rate if different from base currency
integer
Number of days for payment terms
string
Custom invoice number; requires ignore_auto_number_generation=true
string
required
ID of the organization
boolean
Whether unit rates include tax
string
Custom label for payment terms
boolean
Apply discount before tax if true
boolean
If true, uses provided invoice_number and ignores auto-numbering

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_INVOICE_ATTACHMENT_PREFERENCETool to update attachment preference for an invoice. Use when you need to control whether the invoice attachment should be sent when the invoice is emailed.

Input Parameters

string
required
Unique identifier of the invoice.
string
required
ID of the organization
boolean
required
Boolean to send the attachment with the invoice when emailed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_INVOICE_BILLING_ADDRESSTool to update the billing address of an invoice. Use when you need to modify billing address fields (city, state, zip, country, fax) for an existing invoice.

Input Parameters

string
Customer’s fax number
string
Zip code of the customer’s billing address
string
City of the customer’s billing address
string
State of the customer’s billing address
string
Billing address (street address line 1)
string
Country of the customer’s billing address
string
Secondary street address (street address line 2)
string
required
Unique identifier of the invoice.
string
required
The organization ID to identify the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_INVOICE_SHIPPING_ADDRESSTool to update the shipping address of a specific invoice. Use when you need to modify the shipping address details for an existing invoice in Zoho Books.

Input Parameters

string
Fax number (optional)
string
Postal code
string
City name
string
State/province
string
Shipping address line
string
Country name
string
Secondary address line
string
required
Unique identifier of the invoice
string
required
The organization ID to identify the organization. Required for all API requests when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_INVOICE_TEMPLATETool to update the template associated with an invoice. Use when you need to change the PDF template used for an existing invoice.

Input Parameters

string
required
Unique identifier of the invoice
string
required
Unique identifier of the invoice template
string
required
The unique identifier of the organization. Required for all Zoho Books API requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_ITEMTool to update details of a specific item. Use when you need to modify an existing item’s attributes after fetching its current state.

Input Parameters

string
Unique SKU identifier for the item
string
required
Name of the item (max 100 chars)
number
required
Sales rate of the item (non-negative)
string
Tax ID to associate with this item
string
required
Unique identifier of the item to update
string ("sales" | "purchases" | "sales_and_purchases" | "inventory")
Defines if item is for sales, purchases, both or inventory
array
List of opening stock details per location
string
Preferred vendor ID for this item
string
GL account ID to associate with the item
string
HSN or SAC code for this item (India, Kenya, South Africa only)
boolean
Flag to indicate if item is taxable
string
Detailed description of the item (max 2000 chars)
string ("goods" | "service" | "digital_service")
Type of the product (goods, service, digital_service)
string
SAT unit key code (Mexico only)
array
Custom field values to set for this item
string
Purchase rate or cost (string format for precision)
string
Reorder threshold quantity (string format)
string
Tax percentage to apply (string format)
string
Avalara tax code grouping (max 25 chars)
string
Avalara exemption grouping (max 25 chars)
string
required
ID of the organization context
string
Tax exemption ID; mandatory if is_taxable is false
string
Sales tax rule ID (Mexico, Kenya, South Africa only)
string
SAT item key code (Mexico only)
string
COGS account ID; required for purchase/inventory item types
string
Inventory asset account ID; required if item_type is inventory
array
List of item tax preferences (India only)
string
Description for purchase side of the item
string
Purchase tax rule ID (Mexico, Kenya, South Africa only)
string
Purchase tax exemption ID; required if is_taxable is false (Kenya, South Africa)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_JOURNALTool to update a journal entry in Zoho Books. Use when modifying existing journal entries—changing line items, dates, amounts, or other journal fields.

Input Parameters

array
Reporting tags for the journal.
string
Notes or description for the journal.
string
required
Unique identifier of the journal to update.
array
Array of line items. At least 2 line items are required (debit and credit entries must balance). Include line_id for existing lines to update them.
string
Currency identifier for multi-currency organizations.
string
Date on which the journal is to be recorded, in YYYY-MM-DD format.
string ("Cash" | "Both")
Enum for journal type.
array
Custom fields for the journal.
number
Exchange rate between currencies.
string
required
Zoho Books organization ID. Required query parameter.
string
Reference identifier for the journal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_LOCATIONTool to update an existing location in Zoho Books. Use when you need to modify location details such as name, address, or associated users.

Input Parameters

string
Type of the location
string
Email address for the location
string
Phone number for the location
object
required
Address details for the location
string
Comma-separated list of user identifiers
string
required
Unique identifier of the location to update
string
required
Name of the location
string
required
ID of the organization
string
Parent location identifier for hierarchical locations
array
List of associated series identifiers
boolean
Whether all users are selected for this location
string
Autonumber generation group ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_ORGANIZATIONTool to update an organization’s settings and details. Use when you need to modify organization information like name, contact details, or fiscal year settings.

Input Parameters

string
Organization name
string
Contact email address
string
Contact telephone number
string
Time zone in which the organization is located geographically
string
Format for representing the date
string
Contact person name
string
Language code (e.g., ‘en’)
string
Field separator for components in date
string
required
Unique identifier of the organization to update
boolean
To determine whether logo is uploaded
string ("january" | "february" | "march" | "april" | "may" | "june" | "july" | "august" | "september" | "october" | "november" | "december")
Allowed values for fiscal year starting month.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_PROJECTTool to update a project in Zoho Books. Use when you need to modify project details like name, billing type, rate, or other project attributes. Requires project_id.

Input Parameters

string
Hourly rate for a task
array
List of tasks associated with the project
array
List of users to assign to the project
string
required
ID of the user to be added to the project
string
required
Unique identifier of the project to update
string
Budget type for the project
string
Currency identifier for the project
string
required
ID of the customer associated with this project
string
Project description. Max-length 500
string ("fixed_cost_for_project" | "based_on_project_hours" | "based_on_staff_hours" | "based_on_task_hours")
required
The way you bill your customer
string
Budgeted hours for the project
string
required
Name of the project. Max-length 100
string
Budgeted amount for the project
string
required
Organization ID to identify the organization
number
Budgeted cost to complete this project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_PROJECT_USERTool to update a user’s details in a project. Use when you need to modify the role, rate, or budget hours for a user assigned to a specific project.

Input Parameters

string
Hourly rate for the user’s work on this project
string
required
Unique identifier of the user to update in the project
string ("staff" | "admin" | "timesheetstaff")
Allowed user roles for project users.
string
required
Unique identifier of the project
string
Budget hours allocated for the user on this project
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_PURCHASE_ORDER_BILLING_ADDRESSTool to update the billing address of a purchase order. Use when you need to modify billing address details for an existing purchase order.

Input Parameters

string
Fax number for the billing address
string
required
Postal or ZIP code for the billing address
string
required
City name for the billing address
string
Phone number for the billing address
string
required
State or province for the billing address
string
required
Street address line 1 of the billing address
string
required
Country name for the billing address
string
Street address line 2 of the billing address
string
Contact person name or attention line for the billing address
string
required
Organization ID for users belonging to multiple organizations.
string
required
Unique identifier of the purchase order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_PURCHASE_ORDER_COMMENTTool to update a comment on a purchase order. Use when you need to modify the text of an existing comment. Only user-created comments can be updated; system-generated comments will fail with error 4073.

Input Parameters

string
required
Unique identifier of the comment to update. Note: Only user-created comments (comment_type=‘internal’) can be updated. System-generated comments will return error code 4073.
string
required
The updated comment text.
string
required
Required parameter for users belonging to multiple organizations. Specifies which organization’s purchase order comment to update.
string
required
Unique identifier of the purchase order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_RECURRING_BILLTool to update a recurring bill in Zoho Books. Use when you need to modify an existing recurring bill’s details such as vendor, recurrence pattern, line items, or other bill attributes.

Input Parameters

string
Notes for the recurring bill
string
Terms and conditions
string
India: 15-digit GSTIN
string
Discount applied to the recurrence. It can be either in % or in amount
string
End date of the recurring bill in YYYY-MM-DD format. If not provided, bill recurs indefinitely.
string
ID of the vendor the bill has to be created for
array
Array of line items with item details.
string
Start date of the recurring bill in YYYY-MM-DD format
string
Currency identifier if multi-currency is enabled
string
Location ID
string
Price book ID
string
Recurrence interval (e.g., ‘1’, ‘2’, ‘3’)
array
Custom fields for the recurring bill
string
India: GST treatment (e.g., ‘business_gst’, ‘business_none’, ‘overseas’, ‘consumer’)
integer
Payment terms in days. 0 means Due on Receipt.
string
GCC/MX/KE/ZA: tax treatment code
string
required
ID of the organization
string
GCC: place-of-supply code
string
Name of the recurring bill. Max-length [100]
boolean
Whether prices include tax (non-US organizations)
string
India GST: source state
string
required
Unique identifier of the recurring bill to update
string
Custom label for payment terms
string
Frequency pattern (e.g., ‘days’, ‘weeks’, ‘months’, ‘years’)
string
India GST: destination state

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_RECURRING_INVOICE_TEMPLATETool to update the template associated with a recurring invoice. Use when you need to change the PDF template used for an existing recurring invoice.

Input Parameters

string
required
Unique identifier of the recurring invoice template
string
required
The unique identifier of the organization. Required for all Zoho Books API requests.
string
required
Unique identifier of the recurring invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_REPORTING_TAGTool to update an existing reporting tag in Zoho Books. Use when you need to modify the name, description, or settings of a reporting tag.

Input Parameters

string
required
ID of the reporting tag to update
array
List of entities that can only be enabled or disabled. Each entity has entity_name and is_enabled fields. Common entity names include ‘customers’, ‘vendors’, ‘items’, ‘fixed_asset’, ‘banking’.
string
required
The name of the reporting tag
string
Description of the reporting tag
boolean
Whether the tag is mandatory. If true, users must assign this tag when creating transactions.
string
required
Numeric ID of your Zoho Books organization (e.g., ‘913373484’). Must contain only digits. To obtain valid organization IDs, first call ZOHO_BOOKS_LIST_ORGANIZATIONS which returns all organizations accessible to your account. Each organization has an ‘organization_id’ field. Invalid or non-existent organization IDs will result in 404 errors.
object
Configuration for transaction/line-item level entities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_REPORTING_TAG_OPTIONSTool to update reporting tag options in Zoho Books. Use when you need to modify, add, or update the available options for a reporting tag including their active status and default settings.

Input Parameters

string
required
ID of the reporting tag to update options for
array
required
Array of options to update. Each option must include option_name (required) and may include option_id, is_active, and is_default fields
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_SALES_ORDERTool to update a specific sales order. Use when you need to modify an existing sales order (e.g., change dates, line items, or custom fields) after creation.

Input Parameters

string
Sales order date in YYYY-MM-DD format
array
Line items to update or add
string
Currency ID for this sales order
string
Customer ID for this sales order
array
Custom fields to update on the sales order
string
required
ID of the sales order to update
string
Shipment date in YYYY-MM-DD format
string
required
Organization ID under which the sales order exists
string
Tax exemption ID (India/US only)
string
Tax exemption code (India/US/Mexico only)
array
List of contact persons to associate with the sales order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_SALES_ORDER_ATTACHMENT_PREFERENCETool to update attachment preference for a sales order. Use when you need to control whether the sales order attachment should be sent when the sales order is emailed.

Input Parameters

string
required
Unique identifier of the sales order.
string
required
ID of the organization
boolean
required
Boolean to send the attachment with the sales order when emailed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_SALES_ORDER_BILLING_ADDRESSTool to update the billing address of a sales order. Use when you need to modify billing address details for an existing sales order in Zoho Books.

Input Parameters

string
Fax number for billing address
string
Postal code for billing address
string
City name for billing address
string
State or province for billing address
string
Street address line 1 for billing
string
Country name for billing address
string
Street address line 2 for billing
string
Contact person name for the billing address
string
required
Unique identifier of the sales order
string
required
Organization ID for the Zoho Books account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_SALES_ORDER_SHIPPING_ADDRESSTool to update the shipping address of a specific sales order. Use when you need to modify the shipping address details for an existing sales order in Zoho Books.

Input Parameters

string
Fax number
string
ZIP/Postal code
string
City of the address
string
State designation
string
Primary address line
string
Country name
string
Secondary address line
string
Attention/recipient name
string
required
Unique identifier of the sales order
string
required
The organization ID to identify the organization. Required for all API requests when user belongs to multiple organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_SALES_ORDER_TEMPLATETool to update the template associated with a sales order. Use when you need to change the PDF template used for an existing sales order.

Input Parameters

string
required
Unique identifier of the sales order template
string
required
Unique identifier of the sales order
string
required
The unique identifier of the organization. Required for all Zoho Books API requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_USERUpdates an existing Zoho Books user in an organization, requiring a name and email and optionally assigning a role.

Input Parameters

string
required
Updated full name of the user. Must not be empty.
string
required
Updated email address of the user.
string
Role ID to assign to the user. Obtain valid role IDs by calling the ZOHO_BOOKS_LIST_USERS action and checking the ‘role_id’ field of existing users. Format: numeric string (e.g., ‘8387815000000000619’).
string
required
Unique identifier of the user to update. Format: numeric string (e.g., ‘8387815000000093001’). Obtain this by calling the ZOHO_BOOKS_LIST_USERS action.
string
required
Unique numeric identifier for the Zoho Books organization. Obtain this by calling the ZOHO_BOOKS_LIST_ORGANIZATIONS action. Format: numeric string (e.g., ‘913373484’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_UPDATE_VENDOR_PAYMENT_REFUNDTool to update a vendor payment refund in Zoho Books. Use when you need to modify an existing refund’s details such as amount, date, or reference information.

Input Parameters

string
required
Date of the refund in YYYY-MM-DD format.
number
required
The refund amount.
string
required
Unique identifier of the vendor payment.
string
Details about the refund.
string
Method of refund (e.g., Cash, Check, Bank Transfer). Maximum 50 characters.
number
Currency conversion rate. Defaults to 1 if not provided.
string
required
ID of the organization. Required for users belonging to multiple organizations.
string
Reference identifier for the refund. Maximum 100 characters.
string
required
Unique identifier of the vendor payment refund to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_VOID_INVOICETool to mark an invoice as Void. Use when you need to void an existing invoice after reviewing any outstanding payments.

Input Parameters

string
required
Unique identifier of the invoice to void
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BOOKS_WRITE_OFF_INVOICETool to write off an invoice. Use when an invoice amount is not expected to be recovered and should be treated as bad debt.

Input Parameters

string
required
Unique identifier of the invoice to write off
string
required
ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not