Zoho Books connector for AI agents

Tools your accounting agent reaches for on Zoho Books, scoped per user.

CALL ANY TOOL

119 tools for accounting in Zoho Books: create and email invoices and estimates, record bills, expenses, and payments, post manual journals, and read bank transactions and the chart of accounts.

zohobooks_bank_account_get

Get bank account

Get one bank or credit card account by ID, including its balance and bank details. Returns a bankaccount object with account_id, account_name, account_code, currency_id, currency_code, currency_symbol. Use this when you have an account_id. Use bank_accounts_list to find accounts. Requires an organization_id from zohobooks_organizations_list.

Parameters

Name

Type

Required

Description

account_id

string

Required

Unique identifier of the bank account. Example: 460000000050127

organization_id

string

Required

ID of the Zoho Books organization to act on. Get it from zohobooks_organizations_list (organization_id field). Example: 10234695

zohobooks_bank_accounts_list

List bank accounts

zohobooks_bank_transaction_create

Create bank transaction

Record a bank transaction such as a deposit, transfer, owner contribution or card payment. Returns a banktransaction object with transaction_id, from_account_id, from_account_name, to_account_id, to_account_name, transaction_type. Use this to record money moving through a bank account. Use expense_create or customer_payment_create for those specific transaction types. Requires an organization_id from zohobooks_organizations_list.

Parameters

Name

Type

Required

Description

organization_id

string

Required

ID of the Zoho Books organization to act on. Get it from zohobooks_organizations_list (organization_id field). Example: 10234695

transaction_type

string

Required

Type of the transaction. Allowed transaction types : deposit, refund(*Supported only in Credit Card accounts), transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return Note: You will not be able to create the following module-specific transaction types under Bank Transaction endpoints : Expense, Vendor Advance/Vendor Payment/Bill Payment, Vendor Credit Refund, Vendor Payment Refund, Customer Advance/Customer Payment, Credit Note Refund, Payment Refund. Hence, refer them in their repective modules. Example: deposit

amount

number

Optional

Amount of the transaction Example: 2000

bank_charges

number

Optional

Bank Charges applied to the transaction Example: 0

currency_id

string

Optional

The currency ID involved in the transaction. Example: 460000000000097

custom_fields

array

Optional

List of custom fields associated with the transaction.

customer_id

string

Optional

ID of the customer or vendor. Example: 460000000000111

date

string

Optional

Transaction date. Example: 2013-10-01

description

string

Optional

A brief description about the transaction.

documents

array

Optional

List of files to be attached to a particular transaction.

exchange_rate

integer

Optional

The foreign currency exchange rate value. Example: 1

from_account_id

string

Optional

The account ID from which money will be transferred(Mandatory for specific type of transactions). These accounts differ with respect to transaction_type. Ex: To a bank account, from-account can be: bank , card, income, refund. To a card account, from account can be: bank, card, refund. Example: 460000000070003

from_account_tags

array

Optional

Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis. Example: [{"tag_id":"460000000000567","tag_option_id":"460000000014044"}]

is_inclusive_tax

boolean

Optional

Check if transaction is tax Inclusive Example: False

payment_mode

string

Optional

Mode of payment for the transaction. (not applicable for transfer_fund, card_payment, owner_drawings). Ex:cash, cheque, etc., Example: Cash

reference_number

string

Optional

Reference Number of the transaction Example: Ref-121

tags

array

Optional

Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis. Example: [{"tag_id":"460000000000567","tag_option_id":"460000000014044"}]

tax_id

string

Optional

ID of the tax or tax group applied

to_account_id

string

Optional

ID of the account to which the money gets transferred(Mandatory for specific type of transactions). Ex: From a bank account, to-account can be: bank, card, drawings, expense,credit notes. From a card account, to-account can be: card, bank, expense. Example: 460000000048001

to_account_tags

array

Optional

Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis. Example: [{"tag_id":"460000000000567","tag_option_id":"460000000014044"}]

user_id

string

Optional

ID of the User involved in the Transaction

zohobooks_bill_mark_open

Open bill mark

zohobooks_bill_update

Update bill

Update an existing bill's vendor, line items, dates or terms. Returns a bill object with bill_id, entity_type, purchaseorder_ids, vendor_id, vendor_name, pricebook_id. Use this to change a bill you have the bill_id for. Use bill_create for a new bill. Requires an organization_id from zohobooks_organizations_list.

Parameters

Name

Type

Required

Description

bill_id

string

Required

Unique identifier of the bill. Example: 460000000098765

bill_number

string

Required

Unique sequential identifier for the bill. Used for tracking and reference purposes. Format varies by organization settings. Can be auto-generated or manually entered. Must be unique within the organization. Example: 00454

organization_id

string

Required

ID of the Zoho Books organization to act on. Get it from zohobooks_organizations_list (organization_id field). Example: 10234695

vendor_id

string

Required

Unique identifier for the vendor who supplied the goods/services. Can be fetched from the Get Contacts API. Example: 460000000038029

adjustment

number

Optional

Additional amount added to or subtracted from bill total. Positive values increase total, negative values decrease total. Used for discounts, surcharges, rounding adjustments, or other modifications. Affects final bill amount, tax calculations, and payment processing. Example: 0

adjustment_description

string

Optional

Text description explaining the reason for bill adjustment. Examples: "Early payment discount", "Volume discount", "Rounding adjustment", "Handling fee". Helps in audit trails and reporting. Required when adjustment amount is non-zero. Used in financial reports, tax returns, and vendor communications. Should be clear and specific for compliance purposes.

approvers

array

Optional

List of approvers for the bill.

attachment

string

Optional

File to attach. Allowed Extensions: gif, png, jpeg, jpg, bmp and pdf.

currency_id

string

Optional

Unique identifier for the currency used in the bill transaction. Can be fetched from the Currencies API if multi-currency is enabled. Example: 460000000000099

custom_fields

array

Optional

List of custom fields for the bill.

date

string

Optional

Date when the bill was issued by the vendor. Format: yyyy-mm-dd. Used for payment terms and aging calculations. This date determines when payment terms begin and affects aging reports, late payment calculations, and financial reporting. Example: 2013-09-11

documents

array

Optional

List of documents attached to the bill.

due_date

string

Optional

Date when payment is due for the bill. Used for payment tracking, aging reports, and overdue calculations. Calculated based on bill date and payment terms. Bills become overdue after this date, affecting vendor relationships and cash flow planning. Example: 2013-09-26

entity_type

string

Optional

Type of the bill entity. Allowed values: bill, self_billed_invoice. Example: bill. One of: `bill`, `self_billed_invoice`.

exchange_rate

number

Optional

Exchange rate from bill currency to organization base currency. Used for multi-currency transactions. 1.0 indicates same as base currency. Required when currency differs from organization default. Affects financial reporting, profit/loss calculations, and tax computations. Can be manually set or auto-fetched from currency exchange services. Example: 1.23

is_inclusive_tax

boolean

Optional

Flag indicating whether line item rates include tax amounts. When true, tax is calculated on top of displayed rates. When false, tax is added separately. Affects total calculations and tax reporting. Common in countries where tax-inclusive pricing is standard. Impacts customer-facing documents and tax return preparation. Example: False

is_item_level_tax_calc

boolean

Optional

Flag indicating whether taxes are calculated at individual line item level rather than bill total. Enables different tax rates for different items. Provides more accurate tax calculations for mixed tax scenarios. When enabled, each line item can have different tax rates based on item type, location, or tax rules. Improves tax compliance and reporting accuracy. Example: False

is_update_customer

boolean

Optional

Flag to determine if customer information should be updated when creating the bill. Example: False

line_items

array

Optional

Line items of a bill. Example: [{"item_id":"460000000054135","account_id":"460000000000403","rate":10,"quantity":1}]

location_id

string

Optional

Unique identifier for the business location where the bill transaction occurs. Used for multi-location organizations to track expenses by location. Affects reporting and tax calculations based on location-specific rules. Can be fetched from the Locations API. Required for organizations with multiple locations. Influences tax rates, reporting structures, and approval workflows based on location-specific configurations. Example: 460000000038080

notes

string

Optional

Additional information or comments about the bill. Used for internal communication, vendor instructions, or special handling requirements. Visible to vendors and included in bill communications. Useful for tracking special arrangements or payment instructions. Example: Thanks for your business.

payment_terms

integer

Optional

Numeric identifier for payment terms configuration. Defines when payment is due relative to bill date. 0 = Due on Receipt, positive numbers = days after bill date, negative numbers = days before bill date. Common values: 0 (Due on Receipt), 15 (Net 15), 30 (Net 30), 45 (Net 45). Affects due date calculation and aging reports. Example: 0

payment_terms_label

string

Optional

Label of the Payment Terms Example: Due on Receipt

pricebook_id

string

Optional

Identifier for the price book containing item rates and pricing rules. Used to apply standardized pricing across bills. If not specified, default pricing from items will be used. Helps maintain consistent pricing across multiple transactions. Example: 460000000038090

purchaseorder_ids

array

Optional

Array of purchase order identifiers linked to this bill for tracking purposes. Example: [460000000068231,460000000068233]

recurring_bill_id

string

Optional

Identifier linking this bill to a recurring bill template. Used for bills that are automatically generated on a schedule (weekly, monthly, quarterly, etc.). Enables automated bill generation, consistent billing cycles, and reduces manual data entry. Can be modified to change recurring schedule.

reference_number

string

Optional

External reference number from vendor invoice or purchase order. Used for cross-referencing with vendor documents. Helps in reconciliation and tracking payments. Can include invoice numbers, PO references, or any vendor-specific identifiers. Example: 4321133

tags

array

Optional

Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis. Example: [{"tag_id":"460000000000567","tag_option_id":"460000000014044"}]

taxes

array

Optional

List of taxes applied to the bill. Example: [{"tax_id":"460000000027005","tax_name":"VAT (12.5%)","tax_amount":1.25}]

terms

string

Optional

Terms and conditions that apply to the bill transaction. Includes payment terms, delivery conditions, warranty information, or other contractual obligations. Displayed on bill documents and vendor communications. Important for legal compliance and vendor relationship management. Example: Terms and conditions apply.

zohobooks_contact_create

Create contact

Create a customer or vendor in Zoho Books, optionally with addresses, contact persons, payment terms and currency. Returns a contact object with contact_id, contact_name, company_name, has_transaction, contact_type, customer_sub_type. Use this to add a new customer or vendor. Use contact_update to change an existing contact. Requires an organization_id from zohobooks_organizations_list.

Parameters

Name

Type

Required

Description

contact_name

string

Required

Display name for the contact. It is used for searching and displaying contacts. Example: Bowman and Co

organization_id

string

Required

ID of the Zoho Books organization to act on. Get it from zohobooks_organizations_list (organization_id field). Example: 10234695

billing_address

object

Optional

Billing address information for the contact. Example: {"address":"4900 Hopyard Rd","city":"Pleasanton","state":"CA","zip":94588}

company_name

string

Optional

Legal or registered contact's company name. Used for legal documents and formal communications. Max-length [200]. Example: Bowman and Co

contact_number

string

Optional

Contact number associated with the contact for internal tracking and identification purposes. Max-length [50]. Example: CNT-001234

contact_persons

array

Optional

The list of contact persons associated with the contact. Example: [{"first_name":"Will","email":"willsmith@bowmanfurniture.com","salutation":"Mr","last_name":"Smith"}]

contact_type

string

Optional

Determines how the contact is treated in the system. Allowed values: customer, vendor. Example: customer. One of: `customer`, `vendor`.

credit_limit

number

Optional

For Customer Only : The maximum credit amount that can be allowed for the customer. Once the customer's outstanding receivables reach this limit, the system will restrict the customer from creating any further transactions. Example: 1000

currency_id

string

Optional

Unique identifier for the currency assigned to this contact. The currency_id must correspond to a valid currency configuration in the system. Note: This value is a set of numeric characters. Example: 460000000000097

custom_fields

array

Optional

Custom fields of the contact. Example: [{"value":"GBGD078","index":1}]

customer_sub_type

string

Optional

For Customer Only : Additional classification for customers. Allowed values: individual, business. Example: business. One of: `individual`, `business`.

default_templates

object

Optional

Default Templates value. Example: {"invoice_template_id":460000000052069,"estimate_template_id":460000000000179,"creditnote_template_id":460000000000211,"purchaseorder_template_id":460000000000213}

facebook

string

Optional

Facebook profile URL for the contact. Max-length [100]. Example: zoho

ignore_auto_number_generation

boolean

Optional

Indicates whether the auto generation contact_number is ignored or not for the contact. Allowed values: true, false. Example: False

is_portal_enabled

boolean

Optional

Indicates whether portal access is enabled for the primary contact person. Allowed value: true and false. Example: True

language_code

string

Optional

Preferred language for the contact. Determines portal language. Allowed values: de,en,es,fr,it,ja,nl,pt,pt_br,sv,zh,en_gb Example: en. One of: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pt`, `pt_br`, `sv`, `zh`, `en_gb`.

notes

string

Optional

Additional comments or notes about the contact. Example: Payment option : Through check

opening_balances

array

Optional

List of opening balances for the contact. Example: [{"location_id":"460000000038080","exchange_rate":1,"opening_balance_amount":1200}]

owner_id

string

Optional

For Customer Only : Unique identifier for the user assigned as the owner of the contact. This field specifies which user in the organization is responsible for managing the business relationship with this contact. Note: This value is a set of numeric characters. Example: 460000000016051

payment_terms

integer

Optional

Number of days allowed for payment after the invoice date. Example: 15

payment_terms_label

string

Optional

Human-readable label of payment terms displayed on invoices and other transactions. Max-length [200]. Example: Net 15

pricebook_id

string

Optional

Pricebook id which is associated with the contact. Note: This value is a set of numeric characters. Example: 460000000000123

shipping_address

object

Optional

Shipping address information for the contact. Example: {"address":"4900 Hopyard Rd","city":"Pleasanton","state":"CA","zip":94588}

tags

array

Optional

Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis. Example: [{"tag_id":"460000000000567","tag_option_id":"460000000014044"}]

tax_authority_name

string

Optional

Display name of the tax authority responsible for the customer's tax jurisdiction. Example: California Tax Authority

twitter

string

Optional

X profile URL for the contact. Max-length [100]. Example: zoho

website

string

Optional

Official website URL of the contact. Example: www.bowmanfurniture.com

zohobooks_contact_get

Get contact

zohobooks_contact_mark_inactive

Contact mark inactive

zohobooks_contact_persons_list

List contact persons

zohobooks_credit_note_update

Update credit note

Update an existing credit note's customer, line items, dates or notes. Returns a creditnote object with creditnote_id, creditnote_number, date, vat_reg_no, status, customer_id. Use this to change a credit note you have the creditnote_id for. Use credit_note_create for a new one. Requires an organization_id from zohobooks_organizations_list.

Parameters

Name

Type

Required

Description

creditnote_id

string

Required

Unique identifier of the credit note. Example: 90300000072369

creditnote_number

string

Required

Unique credit note number displayed in the interface. Auto-generated with CN prefix unless ignore_auto_number_generation is true. Max-Length [100] Example: CN-29

customer_id

string

Required

Unique identifier for the customer contact. Retrieve customer IDs from the Get Customers API endpoint in the contacts section. This ID links the credit note to the specific customer record. Example: 903000000000099

date

string

Required

The date on which the credit note is raised. Must be in yyyy-mm-dd format. This date determines the accounting period and affects tax calculations. Example: 2016-06-05

line_items

array

Required

Line items of a credit note. Example: [{"item_id":"90300000081501","account_id":"903000000000388","name":"Basic Monthly","description":"prorated amount for items"}]

organization_id

string

Required

ID of the Zoho Books organization to act on. Get it from zohobooks_organizations_list (organization_id field). Example: 10234695

reason_for_credit_debit_note

string

Required

Reason for issuing the credit note. For UAE Edition, this field is required. Allowed values: tax_treatment_error, supply_cancellation, change_of_tax_treatment, consideration_adjustment, return_of_goods_or_services, volume_discount, others. Max-length [200]. Example: change_of_tax_treatment. One of: `tax_treatment_error`, `supply_cancellation`, `change_of_tax_treatment`, `consideration_adjustment`, `return_of_goods_or_services`, `volume_discount`, `others`.

account_id

string

Optional

Unique identifier for the chart of accounts entry. Retrieve account IDs from the List Chart of Accounts API endpoint. Determines which account the line item affects for accounting purposes. Example: 903000000000388

contact_persons_associated

array

Optional

Contact Persons associated with the transaction. Example: [{"contact_person_id":982000000567003}]

currency_id

string

Optional

Unique identifier for the currency used in the credit note. Can differ from customer currency if multi-currency is enabled. Retrieve currency IDs from the List Currencies API endpoint in the currency section. Example: 982000000567240

custom_fields

array

Optional

Additional fields for the Credit-Notes.

description

string

Optional

Detailed description of the line item. Provides additional information about the product or service being credited. Displayed on the credit note document. Example: prorated amount for items

exchange_rate

string

Optional

Exchange rate for converting the credit note currency to base currency. Required when currency differs from base currency. Retrieve rates from currency exchange rate APIs. Example: 5.5

ignore_auto_number_generation

boolean

Optional

Set to true if you need to provide your own credit note number. Example: False

is_draft

boolean

Optional

Set to true to create the credit note in draft status. Draft credit notes are not finalized and can be modified before sending to customers. Example: True

is_inclusive_tax

boolean

Optional

Used to specify whether the line item rates are inclusive or exclusive of tax. Example: False

item_id

string

Optional

Unique identifier for the item in the line item. Retrieve item IDs from the List Items API endpoint in the items section. Links the line item to a specific product or service. Example: 90300000081501

location_id

string

Optional

Unique identifier for the business location associated with the line item. Retrieve location IDs from the List Locations API endpoint in the locations section. Determines tax settings and business rules for this line item. Example: 460000000038080

name

string

Optional

Name or title of the line item. Describes the product or service being credited. This name is displayed on the credit note document. Example: Basic Monthly

notes

string

Optional

Additional notes or comments for the credit note. Displayed on the credit note document for customer reference. Max-length [5000] Example: Offer for the referral

quantity

integer

Optional

Number of units being credited for this line item. Must be a positive number. Used to calculate the total amount for the line item. Example: 1

rate

number

Optional

Rate of the line item. Example: 0

reference_number

string

Optional

Optional reference number for tracking purposes. Can be any custom string or auto-generated. Useful for linking to external systems or internal tracking. Max-Length [100] Example: INV-384

tags

array

Optional

Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis. Example: [{"tag_id":"460000000000567","tag_option_id":"460000000014044"}]

tax_id

string

Optional

Unique identifier for the tax applied to the line item. Retrieve tax IDs from the List Taxes API endpoint in the taxes section. Determines tax calculations for this specific line item. Example: 903000000000356

template_id

string

Optional

Unique identifier for the credit note PDF template. Retrieve template IDs from the List Credit Note Templates API endpoint. Determines the visual layout and branding of the credit note document. Example: 90300000001336

terms

string

Optional

Terms and conditions displayed on the credit note document. Include payment terms, return policies, or other business conditions. Max-length [10000]

unit

string

Optional

Unit of the line item. E.g: kgs, Nos. Example: kgs

zohobooks_estimate_create

Create estimate

Create an estimate (quote) for a customer with line items, dates, terms and notes. Returns an estimate object with estimate_id, estimate_number, date, reference_number, status, customer_id. Use this to quote a customer. Use invoice_create to bill them directly. Requires an organization_id from zohobooks_organizations_list.

Parameters

Name

Type

Required

Description

customer_id

string

Required

The ID of the customer (contact) for whom the estimate is created. This must be a valid contact ID from your organization; obtain it using the Contacts API (GET /contacts) or the Create Contact response. Note: This value is a set of numeric characters. Example: 982000000567001

line_items

array

Required

Line items of an estimate. Example: [{"name":"Hard Drive","description":"500GB, USB 2.0 interface 1400 rpm, protective hard case.","rate":120,"quantity":1}]

organization_id

string

Required

ID of the Zoho Books organization to act on. Get it from zohobooks_organizations_list (organization_id field). Example: 10234695

accept_retainer

boolean

Optional

Boolean flag indicating whether a retainer invoice should be automatically created if the customer accepts this estimate. When set to true, a retainer invoice is generated upon acceptance, streamlining the process for upfront payments or deposits. Allowed values: true and false. Example: True

adjustment

number

Optional

Additional charge or credit amount applied to the estimate total. This can be used for rounding adjustments, handling fees, or any other one-time charges/credits. Positive values add to the total, negative values reduce the total. This amount is applied after tax calculation and affects the final estimate total. Example: 0

adjustment_description

string

Optional

Text description explaining the reason for the adjustment amount. This description appears on the estimate document to explain why the adjustment was applied. Common examples include "Rounding adjustment", "Handling fee", "Early payment discount", or "Late payment fee". This helps customers understand the purpose of the adjustment.

contact_persons_associated

array

Optional

Contact Persons associated with the estimate. Example: [{"contact_person_id":982000000567003}]

currency_id

string

Optional

The ID of the currency in which the estimate will be created. Use this to specify the customer's preferred currency for transactions. Fetch valid currency IDs using the Currency API (GET /currencies). Note: This value is a set of numeric characters. Example: 982000000000190

custom_body

string

Optional

Custom body for the email to be sent.

custom_fields

array

Optional

Custom fields for an estimate. Example: [{"value":"15 Dec 2013","index":1}]

custom_subject

string

Optional

Custom subject for the email to be sent.

date

string

Optional

Date the estimate is created. This date appears on the estimate document and is used for record-keeping, reporting, and determining the validity period. Format: YYYY-MM-DD. Example: 2013-11-18

description

string

Optional

Detailed description of the product or service in this line item. Use this field to provide specifications, features, or any other relevant information that helps the customer understand about the line item. Example: 500GB, USB 2.0 interface 1400 rpm, protective hard case.

discount

number

Optional

Discount applied to the estimate, which can be either a percentage or a flat amount. For percentage discounts, the value should include the % symbol (e.g., 10%). For example, on Rs.1000, a 10% discount results in Rs.900, while a flat Rs.200 discount results in Rs.800.

discount_type

string

Optional

Specifies how the discount is applied: at the entity (entire estimate) level or item (line item) level. Allowed values: "entity_level", "item_level". This setting determines whether the discount is distributed across all items or applied to specific items only. Example: item_level

estimate_number

string

Optional

Unique identifier for the estimate. If not provided, the system auto-generates one. This number is used for tracking, referencing, and communicating the estimate to customers. It appears on the estimate PDF and in all customer communications. Example: EST-00002

exchange_rate

number

Optional

Exchange rate used to convert the estimate amount to the base currency of your organization. Required for multi-currency transactions. The exchange rate affects the total amount and reporting in the base currency. Example: 1

expiry_date

string

Optional

Date when the estimate expires. After this date, the estimate is no longer valid for acceptance. Used to set deadlines for customer response and manage time-sensitive offers. Format: YYYY-MM-DD. Example: 2013-11-30

ignore_auto_number_generation

boolean

Optional

Ignore auto estimate number generation for this estimate. This mandates the estimate number. Example: False

is_discount_before_tax

boolean

Optional

Indicates whether the discount is applied before or after tax calculation. When true, the discount is applied to the subtotal before tax. When false, the discount is applied after tax is calculated. Example: True

is_inclusive_tax

boolean

Optional

Used to specify whether the line item rates are inclusive or exclusive of tax. Example: False

item_id

string

Optional

Unique identifier of the item (product or service) being quoted in this line item. Use the `item_id` returned by the Items API for the same organization. This links the line item to a specific product or service in your catalog. Note: This value is a set of numeric characters.

line_item_id

string

Optional

Unique identifier of the line item within the estimate. Required when updating or referencing a specific line item. If omitted during creation, a new line item will be added. Note: This value is a set of numeric characters. Example: 982000000567021

location_id

string

Optional

Unique identifier of the business location associated with the estimate. Use the `location_id` returned by the Locations API for the same organization. This links the estimate to a specific business location, which may affect tax calculations, reporting, and business operations. Required if your organization has multiple locations configured. Note: This value is a set of numeric characters. Example: 460000000038080

name

string

Optional

Name of the product or service for this line item. This is displayed on the estimate document and helps the customer identify what is being quoted. Example: Hard Drive

notes

string

Optional

Additional information or comments to be displayed on the estimate document. This field is typically used for thank you messages, special instructions, or any other information you want to communicate to the customer. The notes appear on the estimate PDF and are visible to customers. Example: Looking forward for your business.

project_id

string

Optional

Unique identifier of the project associated with this estimate. Use the project_id returned by the Projects API for the same organization. Linking an estimate to a project helps with project-based billing, tracking, and reporting. Note: This value is a set of numeric characters. Example: 90300000087378

quantity

number

Optional

Number of units of the product or service being quoted in this line item. This value is multiplied by the rate to calculate the line item total. Example: 1

rate

number

Optional

Unit price or rate for the product or service in this line item. This value is multiplied by the quantity to determine the line item total before taxes and discounts. Example: 120

reference_number

string

Optional

External reference associated with the estimate. Use this field to link the estimate to external systems, customer requests, or internal workflows. The reference number appears on the estimate document for customer and internal tracking. Example: QRT-12346

retainer_percentage

integer

Optional

Percentage of the estimate amount to be collected as a retainer (upfront payment) when the estimate is accepted. Specify a value between 0 and 100. This determines the portion of the total estimate that will be invoiced as a retainer. Example: 10

salesperson_name

string

Optional

Name of the sales person. Example: Will smith

send

boolean

Optional

Send the estimate to the contact person(s) associated with the estimate.Allowed Values: true and false

shipping_address

object

Optional

Address of the party the goods are shipped to. Use this field to provide a one-time shipping address that is not saved under the customer. When using this field, do not provide shipping_address_id in the same request. Example: {"address":"4900 Hopyard Rd, Suite 310","city":"Pleasanton","state":"CA","zip":94588}

shipping_charge

string

Optional

Additional shipping or delivery charges applied to the estimate. Must be specified as a fixed amount (e.g., "25.00"). This amount is added to the estimate total and is subject to tax calculation. Example: 0

tags

array

Optional

Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis. Example: [{"tag_id":"460000000000567","tag_option_id":"460000000014044"}]

tax_id

string

Optional

Unique identifier of the tax to be applied to this line item. Use the `tax_id` returned by the Taxes API for the same organization. This determines which tax rate and rules are applied to the line item, affecting the final tax calculation and compliance reporting. Note: This value is a set of numeric characters. Example: 982000000557028

template_id

string

Optional

The ID of the template used for generating the estimate PDF. Use this to apply custom branding or formats. Fetch template IDs using the Templates API (GET /estimates/templates). Note: This value is a set of numeric characters. Example: 982000000000143

terms

string

Optional

Defines the terms and conditions to be included in the estimate document. This field can be used to specify payment terms, delivery schedules, return policies, or other transactional details. The terms appear on the estimate PDF and helps communicate key conditions related to the estimate. Example: Terms & Conditions apply

unit

string

Optional

Unit of measurement for the product or service in this line item (e.g., kgs, Nos., hours). Helps clarify the quantity being quoted.

zohobooks_estimate_get

Get estimate

zohobooks_estimate_mark_accepted

Estimate mark accepted

zohobooks_expenses_list

List expenses

List expenses, with filters for status, account, customer, vendor, dates and free-text search. Returns an expenses array (each with expense_id, date, account_name, description, currency_id, currency_code), a page_context array (each with sort_column, filter_by, search_text, applied_filter, page, per_page). Use this to browse expenses. Use expense_get for one expense's full details. Requires an organization_id from zohobooks_organizations_list.

Parameters

Name

Type

Required

Description

organization_id

string

Required

ID of the Zoho Books organization to act on. Get it from zohobooks_organizations_list (organization_id field). Example: 10234695

account_name

string

Optional

Search expenses by expense account name. Variants account_name_startswith and account_name_contains. Max-length [100] Example: Rent

amount

number

Optional

Search expenses by amount. Variants: amount_less_than, amount_less_equals, amount_greater_than and amount_greater_than Example: 112.5

customer_id

string

Optional

ID of the expense account. Note: This value is a set of numeric characters. Example: 982000000567001

customer_name

string

Optional

Search expenses by customer name. Variants: customer_name_startswith and customer_name_contains. Max-length [100] Example: Bowman & Co

date

string

Optional

Search expenses by expense date. Variants date_start, date_end, date_before and date_after. Format [yyyy-mm-dd] Example: 2013-11-18 00:00:00+00:00

description

string

Optional

Search expenses by description.Variants description_startswith and description_contains. Max-length [100] Example: Marketing

filter_by

string

Optional

Filter expenses by expense status. Allowed Values Status.All, Status.Billable, Status.Nonbillable, Status.Reimbursed, Status.Invoicedand Status.Unbilled Example: Status.Billable. One of: `Status.All`, `Status.Billable`, `Status.Nonbillable`, `Status.Reimbursed`, `Status.Invoiced`, `Status.Unbilled`.

page

integer

Optional

Page number to be fetched. Default value is 1. Example: 1

paid_through_account_id

string

Optional

Search expenses by paid through account id. Note: This value is a set of numeric characters. Example: 982000000567250

per_page

integer

Optional

Number of records to be fetched per page. Example: 10

project_id

string

Optional

Search expenses by specific project ID. Accepts the unique identifier for a project to retrieve all expenses associated with that particular project. Example: 460000000038030

recurring_expense_id

string

Optional

Search expenses by recurring expense id. Note: This value is a set of numeric characters. Example: 982000000000190

reference_number

string

Optional

Search expenses by reference number. Variants reference_number_startswith and reference_number_contains. Max-length [100]

search_text

string

Optional

Search expenses by account name or description or customer name or vendor name. Max-length [100] Example: Rent

sort_column

string

Optional

Sort expenses.Allowed Values date, account_name, total, bcy_total, reference_number, customer_name and created_time Example: total. One of: `date`, `account_name`, `total`, `bcy_total`, `reference_number`, `customer_name`, `created_time`.

status

string

Optional

Search expenses by expense status. Allowed Values unbilled, invoiced, reimbursed, non-billable and billable Example: unbilled. One of: `unbilled`, `invoiced`, `reimbursed`, `non-billable`, `billable`.

vendor_id

string

Optional

ID of the vendor the expense is made. Note: This value is a set of numeric characters.

vendor_name

string

Optional

Search expenses by vendor name. Variants: vendor_name_startswith and vendor_name_contains.

zohobooks_invoice_comment_add

Add invoice comment

zohobooks_invoice_email

Invoice email

zohobooks_invoice_payment_reminder_send

Send invoice payment reminder

zohobooks_invoice_update

Update invoice

Update an existing invoice's customer, line items, dates, terms or notes. Returns an invoice object with invoice_id, ach_payment_initiated, invoice_number, vat_reg_no, date, status. Use this to change an invoice you have the invoice_id for. Use invoice_create for a new invoice. Requires an organization_id from zohobooks_organizations_list.

Parameters

Name

Type

Required

Description

customer_id

string

Required

Unique identifier of the customer in the current organization for whom this invoice is created. Required when creating an invoice. Use the `customer_id` returned by the get Customers API. Must belong to the organization specified by the `organization_id` parameter. Note: This value is a set of numeric characters. Example: 982000000567001

invoice_id

string

Required

Unique identifier of the invoice. Note: This value is a set of numeric characters. Example: 982000000567114

line_items

array

Required

List of line items in the invoice. Example: [{"item_id":982000000030049,"name":"Hard Drive","description":"500GB, USB 2.0 interface 1400 rpm, protective hard case.","rate":120}]

organization_id

string

Required

ID of the Zoho Books organization to act on. Get it from zohobooks_organizations_list (organization_id field). Example: 10234695

adjustment

number

Optional

Additional charge or credit amount applied to the invoice total. This can be used for rounding adjustments, handling fees, or any other one-time charges/credits. Positive values add to the total, negative values reduce the total. This amount is applied after tax calculation and affects the final invoice total. Example: 0

adjustment_description

string

Optional

Text description explaining the reason for the adjustment amount. This description appears on the invoice document to explain why the adjustment was applied. Common examples include "Rounding adjustment", "Handling fee", "Early payment discount", or "Late payment fee". This helps customers understand the purpose of the adjustment.

allow_partial_payments

boolean

Optional

Boolean flag that determines whether customers can make partial payments against this invoice. When true, customers can pay less than the full invoice amount, and the invoice will remain open with a remaining balance. When false, customers must pay the full amount to complete the invoice. This setting affects payment processing and invoice status tracking. Example: True

contact_persons_associated

array

Optional

Contact Persons associated with the transaction. Example: [{"contact_person_id":982000000567003}]

currency_id

string

Optional

Unique identifier of the currency in which the invoice will be created for the customer. Use the `currency_id` returned by the Currencies API for the same organization. This sets the currency for all monetary amounts on the invoice; if it differs from the organization's base currency, an appropriate `exchange_rate` may be required. Note: This value is a set of numeric characters. Example: 982000000000190

custom_body

string

Optional

The custom body of the email.

custom_fields

array

Optional

Custom fields for an invoice. Example: [{"customfield_id":"46000000012845","value":"Normal"}]

custom_subject

string

Optional

The custom subject of the email.

date

string

Optional

The date on which the invoice is created. Use the format yyyy-mm-dd (e.g., 2013-11-17). This date appears on the invoice document and is used for accounting purposes. When searching invoices, supports variants: date_start, date_end, date_before and date_after. Example: 2013-11-17

discount

number

Optional

Discount applied to the invoice, which can be either a percentage or a flat amount. For percentage discounts, the value should include the % symbol (e.g., 10%). For example, on Rs.1000, a 10% discount results in Rs.900, while a flat Rs.200 discount results in Rs.800.

discount_type

string

Optional

Specifies the scope of discount application. entity_level applies the discount to the entire invoice total. item_level applies the discount to individual line items. This determines how the discount amount is distributed across the invoice items. Example: item_level

due_date

string

Optional

The date by which payment is due for the invoice. Use the format yyyy-mm-dd (e.g., 2013-12-03). This date is typically calculated as invoice date + payment_terms days, but can be overridden with a custom date. When searching invoices, supports variants: due_date_start, due_date_end, due_date_before and due_date_after. Example: 2013-12-03

exchange_rate

number

Optional

Exchange rate used to convert amounts from the invoice currency to the organization's base currency. Required when the invoice currency differs from the organization's base currency. For example, if base currency is USD and invoice currency is EUR, set the EUR to USD exchange rate (e.g., 1.18). Default value is 1.0 when invoice currency matches base currency.

expense_id

string

Optional

Unique identifier of the billable expense to be converted to an invoice line item. This converts a previously recorded expense into a billable line item on the invoice, enabling expense-to-invoice conversion. Note: This value is a set of numeric characters. Example: 460000000028080

ignore_auto_number_generation

boolean

Optional

Ignore auto invoice number generation for this invoice. This mandates the invoice number. Allowed values true and false

invoice_number

string

Optional

Unique identifier or reference number for the invoice. When creating an invoice, this can be a custom number (requires `ignore_auto_number_generation=true` query parameter) or left empty for auto-generation. When searching invoices, supports variants: invoice_number_startswith and invoice_number_contains. Maximum length is 100 characters. Must be unique within the organization. Example: INV-00003

invoiced_estimate_id

string

Optional

Unique identifier of the estimate that was converted to create this invoice. Use this field when creating an invoice from an existing estimate. The `invoiced_estimate_id` links this invoice back to its source estimate, enabling tracking of the conversion process and maintaining the relationship between estimates and invoices. Note: This value is a set of numeric characters.

is_discount_before_tax

boolean

Optional

Boolean flag that determines when the discount is applied in relation to tax calculation. When true, discount is applied before tax calculation (discount reduces the taxable amount). When false, discount is applied after tax calculation (discount reduces the final total including tax). This affects the final invoice total and tax amounts. Example: True

is_inclusive_tax

boolean

Optional

Boolean flag that indicates whether line item rates include tax. When true, the specified rates are inclusive of tax (tax is already included in the rate). When false, the rates are exclusive of tax (tax will be added to the rate). This affects how tax calculations are performed on line items. Example: False

line_item_id

string

Optional

The line item id. Note: This value is a set of numeric characters. Example: 982000000567021

location_id

string

Optional

Unique identifier of the business location associated with the invoice. Use the `location_id` returned by the Locations API for the same organization. This links the invoice to a specific business location, which may affect tax calculations, reporting, and business operations. Required if your organization has multiple locations configured. Note: This value is a set of numeric characters. Example: 460000000038080

notes

string

Optional

Additional information or comments to be displayed on the invoice document. This field is typically used for thank you messages, special instructions, or any other information you want to communicate to the customer. The notes appear on the invoice PDF and are visible to customers Example: Looking forward for your business.

payment_options

object

Optional

Payment options for the invoice, online payment gateways and bank accounts. Will be displayed in the pdf.

payment_terms

integer

Optional

Number of days allowed for payment (e.g., 15, 30, 60). This value determines the invoice due date by adding the specified number of days to the invoice date. For example, if invoice date is 2023-11-17 and payment_terms is 15, the due_date will be 2023-12-02. Maximum value is 100 days.

payment_terms_label

string

Optional

Custom label for payment terms that appears on the invoice document. Used to override the default system-generated label. For example, instead of the default "Net 15 Days", you can set this to "Net 15", "Due in 15 days", or any custom text. This label is displayed to customers on the invoice. Maximum length is 100 characters.

reason

string

Optional

The reason for generating the invoice.

recurring_invoice_id

string

Optional

Unique identifier of the recurring invoice template that generated this invoice. Use this field when creating an invoice from a recurring invoice template. The `recurring_invoice_id` links this invoice back to its source recurring invoice, enabling tracking of which template generated it and maintaining the recurring invoice relationship. Note: This value is a set of numeric characters.

reference_number

string

Optional

External reference number or identifier for the invoice, such as a purchase order number, contract number, or any other business reference. When converting from an estimate or sales order, this field can be used to reference the original document number.

salesorder_item_id

string

Optional

Unique identifier of the sales order line item that is being converted to this invoice line item. Use this field when creating an invoice from an existing sales order. The `salesorder_item_id` links this invoice line item back to its source sales order line item, enabling tracking of the conversion process and maintaining the relationship between sales orders and invoices. Note: This value is a set of numeric characters.

salesperson_name

string

Optional

Name of the salesperson. Max-length [200]

shipping_charge

string

Optional

Additional shipping or delivery charges applied to the invoice. Must be specified as a fixed amount (e.g., "25.00"). This amount is added to the invoice total and is subject to tax calculation. Example: 0

tags

array

Optional

Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis. Example: [{"tag_id":"460000000000567","tag_option_id":"460000000014044"}]

tax_id

string

Optional

template_id

string

Optional

Unique identifier of the PDF template linked to the invoice. Obtain this value from the `template_id` field in the response of the GET `/invoices/templates` API for your organization. Determines which template is used for the invoice PDF. Note: This value is a set of numeric characters. Example: 982000000000143

terms

string

Optional

Terms and conditions text to be displayed on the invoice document. This field is used to specify payment terms, delivery conditions, return policies, or any other legal or business terms that apply to this transaction. The terms appear on the invoice PDF and are legally binding. Example: Terms & Conditions apply

zohobooks_item_mark_active

Item mark active

zohobooks_journal_create

Create journal

zohobooks_journal_publish

Publish journal

zohobooks_organization_get

Get organization

zohobooks_organizations_list

List organizations

zohobooks_purchase_order_mark_open

Open purchase order mark

zohobooks_purchase_order_update

Update purchase order

Update an existing purchase order's vendor, line items, dates or terms. Returns a purchaseorder object with purchaseorder_id, documents, pricebook_id, pricebook_name, purchaseorder_number, date. Use this to change a purchase order you have the purchaseorder_id for. Use purchase_order_create for a new one. Requires an organization_id from zohobooks_organizations_list.

Parameters

Name

Type

Required

Description

line_items

array

Required

Line items of purchase order. Example: [{"item_id":"460000000027009","account_id":"460000000074003","name":"Hard Drive","rate":112}]

organization_id

string

Required

ID of the Zoho Books organization to act on. Get it from zohobooks_organizations_list (organization_id field). Example: 10234695

purchaseorder_id

string

Required

Unique identifier of the purchase order. Note: This value is a set of numeric characters. Example: 460000000062001

vendor_id

string

Required

Unique identifier of the vendor for whom the purchase order is being created. This value is mandatory to associate the purchase order with a specific vendor in your organization. You can obtain the vendor ID by listing all vendors using the contacts API. Ensure the vendor exists before referencing their ID here. Note: This value is a set of numeric characters. Example: 460000000026049

attachment

string

Optional

Allowed Extensions: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc and docx.

attention

string

Optional

The name or designation of the specific person who should be contacted or notified regarding the delivery of goods or services from this purchase order. This field is typically used to specify the primary contact person at the delivery location, such as a warehouse manager, office administrator, or project coordinator who will receive and process the delivered items.

billing_address_id

string

Optional

Unique identifier of the billing address to be used for this purchase order. The billing address determines where invoices and related documents will be sent. This field is optional and if not specified, the default billing address from your organization settings will be used. You can obtain the billing address ID by listing all available addresses in your organization. Ensure the address exists and contains the correct billing information before referencing its ID here. Note: This value is a set of numeric characters. Example: 460000000017491

contact_persons_associated

array

Optional

Contact Persons associated with the transaction. Example: [{"contact_person_id":460000000031001}]

crm_custom_reference_id

string

Optional

ID of CRM Custom Reference. Note: This value is a set of numeric characters.

crm_owner_id

string

Optional

Unique identifier of the CRM owner assigned to this purchase order. This field links the purchase order to a specific CRM user who is responsible for managing the vendor relationship and overseeing the procurement process. The CRM owner can track, follow up, and manage all aspects of this purchase order within the CRM system. Note: This value is a set of numeric characters.

currency_id

string

Optional

Unique identifier of the currency for the purchase order. This value is mandatory to specify the currency in which the purchase order amounts will be displayed and processed. You can obtain the currency ID by listing all available currencies using the GET /settings/currencies API. Ensure the currency exists and is properly configured in your organization before referencing its ID here. Note: This value is a set of numeric characters. Example: 460000000000099

custom_fields

array

Optional

Custom fields for purchase order. Example: [{"customfield_id":"46000000012845","value":"Normal"}]

date

string

Optional

The date when the purchase order was created or issued. This is the official date that appears on the purchase order document and is used for record-keeping, reporting, and tracking purposes. The date should be in YYYY-MM-DD format and typically represents when the purchase order was authorized and sent to the vendor. Example: 2014-02-10

delivery_customer_id

string

Optional

Unique identifier of the customer for whom the goods or services in this purchase order are being procured. This field is used when the purchase order is created on behalf of a customer, such as in drop-shipping scenarios or when procuring items for specific customer projects. The customer information may be displayed on the purchase order for vendor reference. Note: This value is a set of numeric characters.

delivery_date

string

Optional

The expected delivery date when the goods or services ordered in this purchase order should be received. This date is used for planning, scheduling, and tracking deliveries. It helps in managing inventory, coordinating with vendors, and ensuring timely receipt of ordered items. The date should be in YYYY-MM-DD format and is typically communicated to the vendor as part of the purchase order terms. Example: 2014-02-10

delivery_org_address_id

string

Optional

Unique identifier of the organization address where the goods or services from this purchase order should be delivered. This field specifies the delivery location within your organization, such as a warehouse, office, or branch location. The address details are retrieved from your organization's address book and displayed on the purchase order for vendor reference. Note: This value is a set of numeric characters.

discount

string

Optional

Discount applied to the purchase order, which can be either a percentage or a flat amount. For percentage discounts, the value should include the % symbol (e.g., 10%). For example, on Rs.1000, a 10% discount results in Rs.900, while a flat Rs.200 discount results in Rs.800.

discount_account_id

string

Optional

Unique identifier of the accounting account where the discount amount will be recorded. This account is used to track and categorize discount expenses in your general ledger. The discount account should be configured as an expense or contra-revenue account to properly reflect the impact of discounts on your financial statements. Note: This value is a set of numeric characters. Example: 460000000011105

documents

array

Optional

Array of documents attached to the purchase order.

due_date

string

Optional

exchange_rate

number

Optional

The currency exchange rate used to convert the purchase order amounts from the vendor's currency to your organization's base currency. This rate is applied when the purchase order is created in a foreign currency. A value of 1 indicates the same currency as your base currency. This rate affects all monetary calculations and reporting for this purchase order. Example: 1

ignore_auto_number_generation

boolean

Optional

Ignore auto purchase order number generation for this purchase order. This mandates the purchase order number. Example: False

is_discount_before_tax

boolean

Optional

Boolean flag that determines whether the discount is applied before or after tax calculations. When set to true, the discount is applied to the subtotal before tax is calculated, resulting in tax being calculated on the discounted amount. When set to false, the discount is applied after tax calculations, which may affect the final total differently depending on your tax configuration. Example: True

is_inclusive_tax

boolean

Optional

Boolean flag that specifies whether the line item rates include or exclude tax amounts. When set to true, the specified rates are inclusive of tax, meaning the tax amount is already included in the rate. When set to false, the rates are exclusive of tax, and tax will be calculated and added separately. This setting affects how tax calculations are performed and displayed on the purchase order. Example: False

is_update_customer

string

Optional

Check if customer should be updated

location_id

string

Optional

Unique identifier of the business location or branch where this purchase order is being created and managed. This field is used to associate the purchase order with a specific location within your organization, enabling location-based reporting, inventory tracking, and multi-location business operations. The location information affects how the purchase order is processed and where inventory is received. Note: This value is a set of numeric characters. Example: 460000000038080

notes

string

Optional

Additional information, instructions, or comments to be displayed on the purchase order document. This field is typically used for delivery instructions, special requirements, vendor communications, or any other information relevant to the purchase order. The notes appear on the purchase order PDF and are visible to the vendor. Example: Please deliver as soon as possible.

notes_default

string

Optional

Default notes for purchase order

pricebook_id

string

Optional

Unique identifier of the pricebook to be used for this purchase order. The pricebook contains predefined pricing information for items and services. This field is optional and if not specified, the default pricebook will be used. You can obtain the pricebook ID by listing all available pricebooks in your organization. Ensure the pricebook exists and contains the relevant pricing information before referencing its ID here. Note: This value is a set of numeric characters. Example: 460000000026089

purchaseorder_number

string

Optional

Unique identifier for the purchase order. This field is mandatory when auto number generation is disabled for your organization. If auto numbering is enabled, this field can be left empty as the system will automatically generate a sequential purchase order number. When manually specifying a number, ensure it follows your organization's numbering convention and is unique across all purchase orders. Example: PO-00001

reference_number

string

Optional

External reference number or identifier for the purchase order. This field is optional and can be used to store additional reference information such as vendor order numbers, internal tracking codes, or any other external system identifiers. This reference number will be displayed on the purchase order document and can be used for cross-referencing with external systems or internal tracking purposes. Example: ER/0034

salesorder_id

string

Optional

Unique identifier of the sales order that is linked to this purchase order. This field establishes a connection between the sales order and purchase order, typically used in drop-shipping scenarios where you need to procure items to fulfill a customer's sales order. The linked sales order information may be displayed on the purchase order for vendor reference and internal tracking purposes. Note: This value is a set of numeric characters. Example: 460000124728314

ship_via

string

Optional

Shipment Preference

tags

array

Optional

Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis. Example: [{"tag_id":"460000000000567","tag_option_id":"460000000014044"}]

template_id

string

Optional

Unique identifier of the PDF template linked to the purchase order. Obtain this value from the `template_id` field in the response of the GET `/purchaseorders/templates` API for your organization. Determines which template is used for the purchase order PDF document, controlling the layout, formatting, and visual appearance of the generated purchase order. Note: This value is a set of numeric characters. Example: 460000000011003

terms

string

Optional

Terms and conditions text to be displayed on the purchase order document. This field is used to specify payment terms, delivery conditions, return policies, warranty information, or any other legal or business terms that apply to this transaction. The terms appear on the purchase order PDF and form part of the contractual agreement with the vendor. Example: Thanks for your business.

terms_default

string

Optional

Default terms for Purchase Orders

zohobooks_recurring_invoice_stop

Stop recurring invoice

zohobooks_retainer_invoice_get

Get retainer invoice

zohobooks_sales_orders_list

List sales orders

List sales orders in a Zoho Books organization, with filters for status, customer, dates and free-text search. Returns a salesorders array (each with salesorder_id, zcrm_potential_id, zcrm_potential_name, customer_name, customer_id, status). Use this to browse or search sales orders. Use sales_order_get for one order's line items. Requires an organization_id from zohobooks_organizations_list.

Parameters

Name

Type

Required

Description

organization_id

string

Required

ID of the Zoho Books organization to act on. Get it from zohobooks_organizations_list (organization_id field). Example: 10234695

created_date

string

Optional

Search sales orders by creation date. Filters sales orders based on the date they were created. Use yyyy-mm-dd format. Supports variants: created_date_start, created_date_end. Useful for finding sales orders created within specific time periods or date ranges. Example: 2013-11-17

customer_id

string

Optional

Filter sales orders by specific customer identifier. Retrieves all sales orders associated with a particular customer account for customer relationship management, order history tracking, and customer-specific reporting and analysis purposes. Note: This value is a set of numeric characters. Example: 460000000017138

customer_name

string

Optional

Filter sales orders by customer name using various matching operators. Available variants include customer_name_startswith, customer_name_not_in, customer_name_in, and customer_name_contains. Maximum search length: 100 characters. Example: SAF Instruments Inc

customview_id

string

Optional

ID of the customview. Note: This value is a set of numeric characters. Example: 460000004000597

date

string

Optional

Search sales orders by sales order date. Filters sales orders based on the date they were created. Use yyyy-mm-dd format. Supports variants: date_start, date_end, date_before and date_after. Useful for finding sales orders within date ranges or specific time periods. Example: 2013-11-17

string

Optional

Search sales orders by customer email address. Filters sales orders based on the email address of the customer or contact person. Maximum length is 100 characters. Useful for finding sales orders for specific customers or generating customer segment reports. Example: john@bowmanfurniture.com

expiry_date_after

string

Optional

Filter sales orders by sales order shipment date strictly after the specified date (exclusive). Use yyyy-mm-dd format. Example: 2013-11-17

expiry_date_before

string

Optional

Filter sales orders by sales order shipment date strictly before the specified date (exclusive). Use yyyy-mm-dd format. Example: 2013-11-17

expiry_date_end

string

Optional

Filter sales orders by sales order shipment date on or before the specified date. Useful for defining the end of a date range. Use yyyy-mm-dd format. Example: 2013-11-30

expiry_date_start

string

Optional

Filter sales orders by sales order shipment date on or after the specified date. Useful for defining the start of a date range. Use yyyy-mm-dd format. Example: 2013-11-01

filter_by

string

Optional

Filter sales order by status. Allowed Values: Status.All, Status.Open, Status.Draft, Status.OverDue, Status.PartiallyInvoiced, Status.Invoiced, Status.Void and Status.Closed. One of: `Status.All`, `Status.Draft`, `Status.Open`, `Status.Invoiced`, `Status.InvoicedNotShipped`, `Status.Confirmed`, `Status.UnFulfilled`, `Status.MarketPlaceSalesOrder`, `Status.ThisCycle`, `Status.PreviousCycle`, `Status.PartiallyInvoiced`, `Status.Void`, `Status.Closed`, `Status.Pending`, `Status.Approved`, `Status.OverDue`, `Status.Shipped`, `Status.ShippedNotInvoiced`, `Status.ToBeShipped`, `Status.ToBeInvoiced`, `Status.Fulfilled`, `Status.ManuallyFulfilled`, `Status.BackOrdered`, `Status.OnHold`, `Status.DropShipped`, `Status.ToBePacked`, `Status.AvalaraSyncFailed`, `Status.TaxAutomationFailed`, `Status.Network`, `Status.NetworkPending`, `Status.MyApprovals`, `Status.Unconfirmed`, `Status.Portal`, `Status.Cancelled`, `Status.NotConfirmed`, `Status.PendingOrders`, `Status.ShippedNotCancelledOrFailed`, `Status.Delivered`, `Status.CancelledOrFailed`, `Status.Viewed`, `Status.BBPSPendingApproval`, `Status.BBPSAccepted`, `Status.BBPSAcceptFailed`, `Status.BBPSRejected`, `Status.BBPSRejectFailed`, `Status.BBPSReturned`, `Status.BBPSReturnFailed`, `WithAttachment`, `WithoutAttachment`, `ExceptionList`.

item_description

string

Optional

Search sales orders by item description. Filters sales orders based on detailed descriptions of products or services in line items. Supports item_description_startswith and item_description_contains variants. Maximum length is 100 characters. Useful for finding sales orders with specific item descriptions or technical specifications. Example: 500GB, USB 2.0 interface

item_id

string

Optional

Filter sales orders by specific line item identifier. Retrieves all sales orders containing a particular product or service item based on its unique identifier for inventory tracking and item-based reporting purposes. Note: This value is a set of numeric characters. Example: 460000000017088

item_name

string

Optional

Search sales orders by item name. Filters sales orders based on product or service names in sales order line items. Supports item_name_startswith and item_name_contains variants. Maximum length is 100 characters. Useful for finding sales orders with specific products or services. Example: Desktop Units

last_modified_time

string

Optional

Last Modified time of the Sales Order Example: 2014-08-25T11:23:26+0530

location_ids

string

Optional

List of location IDs to filter sales orders by their associated locations. Use this parameter to retrieve sales orders linked to specific business locations. Note: This value is a comma-separated list of numeric location IDs. Example: 460000000038080,460000000038081

page

integer

Optional

Specify the page number for paginated results retrieval. Controls which subset of sales order records to return, enabling efficient data handling for large result sets. Default value is 1 for the first page. Example: 1

per_page

integer

Optional

Specify the maximum number of sales order records to return per page. Controls result set size for optimal performance, memory usage, and user experience. Example: 10

reference_number

string

Optional

Filter sales orders by external reference number using various matching operators. Available variants include reference_number_startswith, reference_number_not_in, reference_number_in, and reference_number_contains. Example: REF-001

salesorder_ids

string

Optional

ID's of the salesorder [Comma seperated values] . Maximum Length : 200. Note: This value is a set of numeric characters separated by comma. Example: 460108000000072000

salesorder_number

string

Optional

Filter sales orders by sales order number using various matching operators. Available variants include salesorder_number_startswith, salesorder_number_not_in, salesorder_number_in, and salesorder_number_contains. Maximum search length: 100 characters. Example: SO-001

salesperson_id

string

Optional

Filter sales orders by specific sales representative identifier. Retrieves all sales orders assigned to a particular salesperson for performance tracking, commission calculations, sales territory management, and individual sales reporting purposes. Note: This value is a set of numeric characters. Example: 460000000000097

search_text

string

Optional

General search parameter for cross-field text matching across sales order number, reference number, and customer name fields. Enables unified search functionality for quick order identification and customer order lookup operations.

shipment_date

string

Optional

Search sales order by sales order shipment date. Variants: shipment_date_start, shipment_date_end, shipment_date_before and shipment_date_after. Default date format : yyyy-mm-dd

sort_column

string

Optional

Specify the column field for sorting sales order results. Available options include customer_name, salesorder_number, shipment_date, last_modified_time, reference_number, total, date, and created_time. Example: created_time. One of: `customer_name`, `salesorder_number`, `reference_number`, `shipment_date`, `total`, `date`, `created_time`, `last_modified_time`, `subscription_number`, `first_name`, `company_name`, `cf_(\w+)`.

status

string

Optional

Search sales order by sales order status. Allowed Values: draft, open, invoiced, partially_invoiced, void and overdue. Example: open. One of: `draft`, `pending_approval`, `approved`, `open`, `invoiced`, `invoiced_not_shipped`, `shipped_not_invoiced`, `partially_invoiced`, `not_invoiced`, `to_be_invoiced`, `paid`, `partially_paid`, `unpaid`, `cancelled`, `void`, `pending`, `overdue`, `closed`, `confirmed`, `onhold`, `network_pending_approval`, `rejected`.

total

string

Optional

Search sales orders by total amount. Filters sales orders based on the final sales order amount including taxes, discounts, and adjustments. Useful for finding sales orders within specific price ranges or identifying high-value transactions. Example: 40.6

zcrm_potential_id

string

Optional

Unique identifier of the potential in CRM. Note: This value is a set of numeric characters. Example: 460000000033001

zohobooks_sales_receipt_create

Create sales receipt

zohobooks_time_entry_get

Get time entry

For more tools, view docs.

Build your Agent

Same auth pattern across LangChain, OpenAI, Anthropic, and Google ADK.

import { ScalekitClient } from "@scalekit-sdk/node";
import { createReactAgent } from "@langchain/langgraph/prebuilt";

const sk = new ScalekitClient(env.SCALEKIT_ENV_URL, env.SCALEKIT_CLIENT_ID, env.SCALEKIT_CLIENT_SECRET);

// Zoho Books tools scoped to this user
const { tools } = await sk.tools.listScopedTools("user_123", {
  filter: { connectionNames: ["zohobooks"], toolNames: [
    "zohobooks_invoices_list",
    "zohobooks_invoice_payment_reminder_send",
    "zohobooks_customer_payment_create"] },
  pageSize: 100,
});

const agent = createReactAgent({ llm, tools });
await agent.invoke({ messages: [{ role: "user", content: "Send payment reminders for every overdue invoice from Acme Corp" }] });

import OpenAI from "openai";
import { ScalekitClient } from "@scalekit-sdk/node";

const sk = new ScalekitClient(env.SCALEKIT_ENV_URL, env.SCALEKIT_CLIENT_ID, env.SCALEKIT_CLIENT_SECRET);
const openai = new OpenAI();

const { tools } = await sk.tools.listScopedTools("user_123", {
  filter: { connectionNames: ["zohobooks"] }, pageSize: 100,
});

const res = await openai.chat.completions.create({
  model: "gpt-5",
  messages: [{ role: "user", content: "Send payment reminders for every overdue invoice from Acme Corp" }],
  tools,
});

// Execute the tool call with the user's vaulted Zoho Books OAuth token
await sk.tools.executeTool(res.choices[0].message.tool_calls[0], "user_123");

import Anthropic from "@anthropic-ai/sdk";
import { ScalekitClient } from "@scalekit-sdk/node";

const sk = new ScalekitClient(env.SCALEKIT_ENV_URL, env.SCALEKIT_CLIENT_ID, env.SCALEKIT_CLIENT_SECRET);
const anthropic = new Anthropic();

const { tools } = await sk.tools.listScopedTools("user_123", {
  filter: { connectionNames: ["zohobooks"] }, pageSize: 100,
});

const msg = await anthropic.messages.create({
  model: "claude-sonnet-5",
  max_tokens: 1024,
  messages: [{ role: "user", content: "Send payment reminders for every overdue invoice from Acme Corp" }],
  tools,
});

// Tool call runs with the user's vaulted Zoho Books OAuth token
await sk.tools.executeTool(msg.content, "user_123");

import { Agent } from "@google/adk/agents";
import { ScalekitClient } from "@scalekit-sdk/node";

const sk = new ScalekitClient(env.SCALEKIT_ENV_URL, env.SCALEKIT_CLIENT_ID, env.SCALEKIT_CLIENT_SECRET);

const { tools } = await sk.tools.listScopedTools("user_123", {
  filter: { connectionNames: ["zohobooks"] }, pageSize: 100,
});

const agent = new Agent({
  name: "accounting_agent",
  model: "gemini-2.5-pro",
  instruction: "Zoho Books tools scoped to this user",
  tools,
});

await agent.run("Send payment reminders for every overdue invoice from Acme Corp");

Try these prompts

Copy any prompt into your agent. Each maps directly to a Zoho Books tool. Click to copy, paste into your agent, done.

Invoicing

Copy the prompt

Copied

Create an invoice for Acme Corp for 20 hours of consulting at $150.

Copy the prompt

Copied

Send a payment reminder for every overdue invoice from Acme Corp.

Copy the prompt

Copied

Record a $3,000 payment from Acme Corp against INV-00412.

Payables

Copy the prompt

Copied

Record a $1,240 bill from Northwind Hosting due on the 30th.

Copy the prompt

Copied

List unpaid bills due this week.

Copy the prompt

Copied

Log an $86 team lunch expense against Meals and Entertainment.

Ledger and projects

Copy the prompt

Copied

Show the transactions posted to the Office Supplies account last month.

Copy the prompt

Copied

Create a manual journal to accrue $5,000 of December rent.

Copy the prompt

Copied

Log 3 hours on the Website Redesign project for today.

SEE HOW AUTH WORKS

Each user signs in to Zoho Books once, and Scalekit stores and refreshes their tokens. Credentials stay vaulted, every call is scope checked, and every action is logged.

Authorize

Your user connects

Zoho Books

once. We tie it to their identity and the meetings they approved — no shared bot account, no org-wide access

Who:

user ‘A’

when:

Once per user

access:

Limited to user

Store

Their

Zoho Books

token lives in a vault scoped to them. User A's meetings are never reachable by an agent acting for user B, even on the same connection

vault:

encrypted

scope:

per-user

tokens:

auto-refreshed

Resolve

When your agent calls a

Zoho Books

tool, we fetch the right token server-side. It never touches your agent, never appears in the LLM context, never shows up in your logs

speed:

~40ms

check:

before every call

seen by:

nobody

Audit

Every

Zoho Books

tool call is logged — who triggered it, which meeting was fetched, what came back. 90 days of history, tied to the user who authorized it

history:

90 days

export:

SIEM-ready

logged:

every call

Test other agents

See the same per-user auth pattern across other accounting and finance connectors.

GTM and RevOps Teams

Revenue forecast commentary

Pulls open pipeline from Salesforce and HubSpot, calculates coverage against quota, flags at-risk stages, posts commentary to Slack, and logs every snapshot to Google Sheets.

GTM and RevOps Teams

CRM AI agent

Reads the Granola transcript after every call, extracts next steps and updates the HubSpot record, drafts the follow-up in Gmail, and confirms in Slack, all on the rep's own delegated OAuth.

Why Scalekit

Secure your agent's access. Connectors ship in minutes

01.

Shared tokens break per-user analytics

A shared Zoho Books token looks fine in a demo. In production every invoice, payment, and journal entry looks like one service account, and you cannot tell which user triggered it. Scalekit resolves the credential of the actual user who triggered the agent, never a shared bot.

// shared token
audit → bot_service_account

// scalekit
audit → user_abc ✓

02.

Authentication is not authorization

03.

Multi-tenancy is architectural

04.

Zoho Books today. Ten connectors tomorrow.

“Our agents act across Salesforce, Gong, Google Drive, and more, on behalf of every customer. Scalekit behind the scenes meant we can keep adding tools without ever rebuilding how credentials or tool calling work.”

Venu Madhav Kattagoni

Head of Engineering / Von

FAQs

Frequently Asked Questions

Does the agent access Zoho Books as the user or through a shared service account?

As the user. Each user signs in to Zoho Books once, and Scalekit stores and refreshes their tokens. Invoices, payments, and journal entries the agent records are attributed to that user in your audit trail, not a shared service account.

Where is the Zoho Books OAuth token stored?

In Scalekit's managed AES-256 token vault, namespaced per tenant. Refresh is automatic. Revocation is a single dashboard action. Credentials never appear in prompts, logs, or LLM context.

Can I limit what the agent does in Zoho Books?

Yes. Filter by tool name in listScopedTools to expose only what you want, for example the list and get tools without zohobooks_invoice_email or zohobooks_invoice_mark_void, which send or void customer invoices. Scalekit also enforces scope checks before every API call.

What happens when a user revokes Zoho Books access?

The connection is invalidated on the next tool call. Subsequent requests for that user fail closed with a clear error. Other users in the tenant remain unaffected. The event is logged for audit.

Which Zoho Books organization does the agent work in?

A Zoho Books user can belong to more than one organization. zohobooks_organizations_list returns the organizations the connected user belongs to, and the agent works in the one you pick, with that user's own Zoho Books role.