Guides
Signup For Free

Zohobook API Integration Vol.1

Suggest Edits

These are the list of integration use cases supported by Knit for Zohobook API as part of the ACCOUNTING category

Create a retainerinvoice

  • ID: create_a_retainerinvoice
  • Operation: write
  • Entities: line item, retainer invoice, customer
  • Summary: This API creates a retainer invoice for a customer in Zoho Books. It requires the customer ID and line items as mandatory fields. Optional fields include reference number, date, contact persons, custom fields, notes, terms, payment options, template ID, and place of supply. The API supports OAuth for authorization. The response includes details of the created retainer invoice, such as invoice ID, number, date, status, customer details, line items, taxes, payment options, and addresses.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a vendor credit

  • ID: create_a_vendor_credit
  • Operation: write
  • Entities: vendor credit, line item, vendor
  • Summary: The 'Create a vendor credit' API allows you to create a vendor credit for a vendor in Zoho Books. It requires an OAuth token for authorization. The API accepts various parameters including vendor_id (required), currency_id, vat_treatment, vendor_credit_number, gst_treatment, tax_treatment, gst_no, source_of_supply, destination_of_supply, place_of_supply, pricebook_id, reference_number, is_update_customer, date, exchange_rate, is_inclusive_tax, line_items, notes, documents, and custom_fields. The response includes details of the created vendor credit such as vendor_credit_id, vendor_credit_number, date, source_of_supply, destination_of_supply, place_of_supply, gst_no, gst_treatment, tax_treatment, pricebook_id, is_reverse_charge_applied, status, reference_number, vendor_id, vendor_name, currency_id, currency_code, exchange_rate, price_precision, vat_treatment, filed_in_vat_return_id, filed_in_vat_return_name, filed_in_vat_return_type, is_inclusive_tax, line_items, acquisition_vat_summary, acquisition_vat_total, reverse_charge_vat_summary, reverse_charge_vat_total, documents, custom_fields, sub_total, total, total_credits_used, total_refunded_amount, balance, notes, comments, vendor_credit_refunds, bills_credited, created_time, and last_modified_time.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a base currency adjustment

  • ID: create_base_currency_adjustment
  • Operation: write
  • Entities: base currency adjustment, currency, account
  • Summary: This API creates a base currency adjustment for a specified currency. It requires the currency ID, adjustment date, exchange rate, and notes as input parameters. The request must include the organization ID and account IDs as query parameters. The response includes a confirmation message and details of the adjustment, such as the adjustment ID, date, exchange rate, currency ID, and account balances.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Bank account

  • ID: delete_a_bank_account
  • Operation: write
  • Entities: product, account, transaction
  • Summary: The 'Delete an account' API allows users to delete a specified account from the Zoho Books system. The account to be deleted must not be associated with any transactions or products. The API requires an OAuth token for authorization, which should be included in the request headers. The account ID to be deleted is specified in the path parameters, and the organization ID is specified as a query parameter. Upon successful deletion, the API returns a response with a code and message indicating the account has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a bill

  • ID: delete_a_bill
  • Operation: write
  • Entities: bill, authorization, organization
  • Summary: The 'Delete a bill' API allows users to delete an existing bill in the Zoho Books system. It requires the bill ID and organization ID as path and query parameters, respectively. The request must include an Authorization header with a valid OAuth token. The API responds with a code and message indicating whether the bill was successfully deleted. Note that bills with payments applied cannot be deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a comment

  • ID: delete_a_comment
  • Operation: write
  • Entities: comment, organization, vendor credit
  • Summary: This API deletes a comment associated with a vendor credit in Zoho Books. It requires the vendor credit ID and comment ID as path parameters, and the organization ID as a query parameter. The request must include an Authorization header with a valid OAuth token. Upon successful deletion, the API returns a response with a code and message indicating the comment has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Contact

  • ID: delete_a_contact
  • Operation: write
  • Entities: contact
  • Summary: The 'Delete a Contact' API allows users to delete an existing contact from their Zoho Books account. The API requires an OAuth token for authorization, which should be included in the request headers. The contact to be deleted is specified by the 'contact_id' path parameter, and the organization is identified by the 'organization_id' query parameter. Upon successful deletion, the API returns a response with a code and a message indicating that the contact has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a contact person

  • ID: delete_a_contact_person
  • Operation: write
  • Entities: contact
  • Summary: This API deletes an existing contact person in the Zoho Books system. It requires the contact person's ID and the organization ID as path and query parameters, respectively. The request must include an Authorization header with a valid OAuth token. Upon successful deletion, the API returns a response with a code of 0 and a message indicating that the contact person has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a credit note

  • ID: delete_a_credit_note
  • Operation: write
  • Entities: credit note, organization
  • Summary: This API deletes an existing credit note in the Zoho Books system. It requires the credit note ID and organization ID as path and query parameters, respectively. The request must include an Authorization header with a valid OAuth token. Upon successful deletion, the API returns a response with a code of 0 and a message indicating that the credit note has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a currency

  • ID: delete_a_currency
  • Operation: write
  • Entities: currency, organization, transaction
  • Summary: The 'Delete a currency' API allows users to delete a specified currency from the Zoho Books settings. It requires an OAuth token for authorization, the currency ID to specify which currency to delete, and the organization ID to specify the organization context. The API uses the DELETE method and returns a response code and message indicating whether the currency was successfully deleted. Note that currencies associated with transactions cannot be deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a journal

  • ID: delete_a_journal
  • Operation: write
  • Entities: authorization, organization, journal
  • Summary: The 'Delete a journal' API allows users to delete a specific journal entry from their Zoho Books account. The API requires an OAuth token for authorization, which should be included in the request headers. The journal ID to be deleted must be specified in the path parameters, and the organization ID must be provided as a query parameter. Upon successful deletion, the API returns a response with a code and a message indicating that the journal entry has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a payment

  • ID: delete_a_payment
  • Operation: write
  • Entities: payment, organization, customer
  • Summary: The 'Delete a payment' API allows users to delete an existing payment in the Zoho Books system. It requires an OAuth token for authorization, the payment ID of the payment to be deleted, and the organization ID as query parameters. The API uses the DELETE method and returns a response code and message indicating the success or failure of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a receipt

  • ID: delete_a_receipt
  • Operation: write
  • Entities: receipt, organization, expense
  • Summary: The 'Delete a receipt' API allows users to delete the receipt attached to a specific expense in Zoho Books. The API requires an OAuth token for authorization, which should be included in the request headers. The expense ID must be specified in the path parameters, and the organization ID must be included as a query parameter. Upon successful deletion, the API returns a response with a code and a message indicating that the receipt has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a recurring bill

  • ID: delete_a_recurring_bill
  • Operation: write
  • Entities: recurring bill, organization
  • Summary: This API deletes an existing recurring bill in the Zoho Books system. It requires the recurring bill ID and the organization ID as path and query parameters, respectively. The request must include an Authorization header with a valid OAuth token. Upon successful deletion, the API returns a response with a code and message indicating the operation's success.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a recurring expense

  • ID: delete_a_recurring_expense
  • Operation: write
  • Entities: recurring expense, organization
  • Summary: This API endpoint is used to delete an existing recurring expense in Zoho Books. It requires the recurring expense ID and the organization ID as path and query parameters, respectively. The request must include an Authorization header with a valid OAuth token. Upon successful deletion, the API returns a response with a code and message indicating the recurring expense has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Recurring Invoice

  • ID: delete_a_recurring_invoice
  • Operation: write
  • Entities: organization, recurring invoice
  • Summary: This API deletes an existing recurring invoice in the Zoho Books system. It requires the invoice ID and organization ID as path and query parameters, respectively. The request must include an Authorization header with a valid OAuth token. Upon successful deletion, the API returns a response with a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Refund

  • ID: delete_a_refund
  • Operation: write
  • Entities: refund, organization, customer payment
  • Summary: The 'Delete a Refund' API allows you to delete a refund associated with an existing customer payment in Zoho Books. To use this API, you need to provide the OAuth token in the Authorization header. The API requires the payment ID as a path parameter and the organization ID as a query parameter. Upon successful deletion, the API returns a response code of 0 and a message indicating that the refund has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a retainer invoice

  • ID: delete_a_retainer_invoice
  • Operation: write
  • Entities: payment, credit note, retainer invoice
  • Summary: This API deletes an existing retainer invoice in Zoho Books. It requires the invoice ID and organization ID as path and query parameters, respectively. The request must include an Authorization header with a valid OAuth token. The API will return a response code and message indicating whether the deletion was successful. Note that invoices with payments or credit notes applied cannot be deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a rule

  • ID: delete_a_rule
  • Operation: write
  • Entities: rule, transaction, bank account
  • Summary: The 'Delete a rule' API allows users to delete a specific rule from their account, making it no longer applicable to transactions. The API requires an OAuth token for authorization, which should be included in the request headers. The rule to be deleted is specified by the 'rule_id' path parameter, and the organization is identified by the 'organization_id' query parameter. Upon successful deletion, the API returns a response with a code and message indicating the rule has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a tax

  • ID: delete_a_tax
  • Operation: write
  • Entities: tax, organization
  • Summary: The 'Delete a tax' API allows users to delete a simple or compound tax from their Zoho Books account. It requires an OAuth token for authorization, which must be included in the request headers. The API endpoint requires the tax ID as a path parameter and the organization ID as a query parameter. Upon successful deletion, the API returns a response code and a message indicating that the record has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a tax group

  • ID: delete_a_tax_group
  • Operation: delete
  • Entities: transaction, organization, tax group
  • Summary: This API deletes a specified tax group in Zoho Books. The tax group to be deleted must not be associated with any transactions. The request requires an OAuth token for authorization, the tax group ID as a path parameter, and the organization ID as a query parameter. Upon successful deletion, the API returns a response code and message indicating the tax group has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a transaction

  • ID: delete_a_transaction
  • Operation: write
  • Entities: organization, transaction, account
  • Summary: This API deletes a specified transaction from the chart of accounts in Zoho Books. It requires an OAuth token for authorization, the transaction ID as a path parameter, and the organization ID as a query parameter. Upon successful deletion, it returns a response code and message indicating the transaction has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Additional Address

  • ID: delete_additional_address
  • Operation: write
  • Entities: address, organization, contact
  • Summary: The 'Delete Additional Address' API allows you to delete an additional address associated with a contact in Zoho Books. To use this API, you need to provide the contact ID and address ID as path parameters, and the organization ID as a query parameter. The request must include an Authorization header with a valid OAuth token. Upon successful deletion, the API returns a response with a code and message indicating the address has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an account

  • ID: delete_an_account
  • Operation: write
  • Entities: product, account, transaction
  • Summary: The 'Delete an account' API allows users to delete a specified account from the Zoho Books system. The account to be deleted must not be associated with any transactions or products. The API requires an OAuth token for authorization, which should be included in the request headers. The account ID to be deleted is specified in the path parameters, and the organization ID is specified as a query parameter. Upon successful deletion, the API returns a response with a code and message indicating the account has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an attachment

  • ID: delete_an_attachment
  • Operation: write
  • Entities: invoice, attachment, organization
  • Summary: The 'Delete an attachment' API allows users to delete a file attached to a specific invoice in Zoho Books. The API requires an OAuth token for authorization, which should be included in the request headers. The invoice ID from which the attachment is to be deleted is specified as a path parameter, and the organization ID is provided as a query parameter. Upon successful deletion, the API returns a response with a code and a message indicating that the file is no longer attached to the invoice.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an employee

  • ID: delete_an_employee
  • Operation: write
  • Entities: organization, employee
  • Summary: The 'Delete an employee' API allows you to delete an existing employee from the Zoho Books system. It requires an OAuth token for authorization, which should be included in the request headers. The organization_id must be specified as a query parameter to identify the organization from which the employee is to be deleted. Upon successful deletion, the API returns a response with a code and a message indicating that the employee has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Estimate

  • ID: delete_an_estimate
  • Operation: write
  • Entities: organization, estimate
  • Summary: The 'Delete an Estimate' API allows users to delete an existing estimate in the Zoho Books application. The API requires an OAuth token for authorization, which must be included in the request headers. The request URL must include the estimate ID as a path parameter and the organization ID as a query parameter. Upon successful deletion, the API returns a response with a code and a message indicating that the estimate has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Expense

  • ID: delete_an_expense
  • Operation: write
  • Entities: authorization, organization, expense
  • Summary: The 'Delete an Expense' API allows users to delete an existing expense in the Zoho Books application. It requires an OAuth token for authorization, which should be included in the request headers. The API endpoint requires the expense ID as a path parameter and the organization ID as a query parameter. Upon successful deletion, the API returns a response with a code and a message indicating that the expense has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an invoice

  • ID: delete_an_invoice
  • Operation: write
  • Entities: payment, invoice, credit note
  • Summary: The 'Delete an invoice' API allows users to delete an existing invoice in the Zoho Books system. It requires the invoice ID and organization ID as path and query parameters, respectively. The request must include an Authorization header with a valid OAuth token. The API responds with a code and message indicating the success or failure of the operation. Invoices with payments or credit notes applied cannot be deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an item

  • ID: delete_an_item
  • Operation: write
  • Entities: item, transaction, organization
  • Summary: This API deletes an item from Zoho Books. The item to be deleted is specified by the item_id in the path parameters. The organization_id must be provided as a query parameter. The request requires an Authorization header with a valid OAuth token. The API responds with a code and message indicating the success or failure of the operation. Items that are part of a transaction cannot be deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete applied credit

  • ID: delete_applied_credit
  • Operation: write
  • Entities: credit, invoice
  • Summary: The 'Delete applied credit' API allows users to delete a specific credit that has been applied to an invoice in Zoho Books. The API requires the invoice ID and the credit ID as path parameters, and the organization ID as a query parameter. The request must include an Authorization header with a valid OAuth token. Upon successful deletion, the API returns a response with a code and a message indicating that the credits applied to the invoice have been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a base currency adjustment

  • ID: delete_base_currency_adjustment
  • Operation: write
  • Entities: base currency adjustment, organization
  • Summary: This API deletes a specified base currency adjustment in Zoho Books. It requires an OAuth token for authorization, the ID of the base currency adjustment to be deleted, and the organization ID as query parameters. The response includes a code and a message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete bills credited

  • ID: delete_bills_credited
  • Operation: delete
  • Entities: bill, vendor credit
  • Summary: The 'Delete bills credited' API deletes the credits applied to a specific bill. To use this API, you must provide the 'vendor_credit_bill_id' as a path parameter, which can be obtained from the 'Get vendor credits > bills credited > vendor_credit_bill_id' section. The request requires an OAuth token for authorization, which should be included in the headers. The 'organization_id' must be provided as a query parameter. Upon successful deletion, the API returns a response with a code and a message indicating that the credits have been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete comment

  • ID: delete_comment
  • Operation: write
  • Entities: project, comment, organization
  • Summary: The 'Delete comment' API allows users to delete a specific comment from a project in Zoho Books. The API requires the project ID and comment ID as path parameters, and the organization ID as a query parameter. The request must include an Authorization header with a valid OAuth token. Upon successful deletion, the API returns a response with a code and message indicating the comment has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete credit note refund

  • ID: delete_credit_note_refund
  • Operation: write
  • Entities: credit note refund, organization
  • Summary: The 'Delete credit note refund' API allows users to delete a specific refund associated with a credit note in Zoho Books. The API requires the credit note ID, refund ID, and organization ID as path and query parameters, respectively. The request must include an Authorization header with a valid OAuth token. Upon successful deletion, the API returns a response with a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Custom Modules

  • ID: delete_custom_modules
  • Operation: write
  • Entities: custom module, authorization, organization
  • Summary: The 'Delete Custom Modules' API allows users to delete a custom module in Zoho Books. It requires an OAuth token for authorization, which should be included in the request headers. The API endpoint is 'https://www.zohoapis.com/books/v3/cm_debtor', and it uses the DELETE method. The request must include the 'organization_id' as a query parameter to specify which organization's module is to be deleted. Upon successful deletion, the API returns a response with a code and a message indicating that the module record has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an exchange rate

  • ID: delete_exchange_rate
  • Operation: write
  • Entities: exchange rate, currency, organization
  • Summary: This API deletes an exchange rate for a specified currency in the Zoho Books application. It requires an OAuth token for authorization, and the request must include the currency ID and exchange rate ID as path parameters, as well as the organization ID as a query parameter. The API responds with a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete the expense receipt

  • ID: delete_expense_receipt
  • Operation: write
  • Entities: invoice, receipt, expense
  • Summary: This API deletes the expense receipts attached to an invoice which is raised from an expense. It requires an OAuth token for authorization and the organization ID as a query parameter. The API responds with a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete individual records

  • ID: delete_individual_records
  • Operation: write
  • Entities: module, organization, record
  • Summary: The 'Delete individual records' API allows you to delete a specific record from a custom module in Zoho Books. To use this API, you need to provide the record ID in the path parameters and the organization ID as a query parameter. The request must include an 'Authorization' header with a valid OAuth token. Upon successful deletion, the API returns a response with a code of 0 and a message indicating success.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete invoices credited

  • ID: delete_invoices_credited
  • Operation: write
  • Entities: invoice, credit note, organization
  • Summary: The 'Delete invoices credited' API allows users to delete credits that have been applied to a specific invoice. The API requires the credit note ID and invoice ID as path parameters, and the organization ID as a query parameter. The request must include an Authorization header with a valid OAuth token. Upon successful deletion, the API returns a response with a code and message indicating that the credits have been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete last imported statement

  • ID: delete_last_imported_statement
  • Operation: delete
  • Entities: statement, organization, bank account
  • Summary: The 'Delete last imported statement' API allows users to delete the last imported bank statement for a specified bank account in Zoho Books. The API requires an OAuth token for authorization, and the request must include the bank account ID, statement ID, and organization ID as path and query parameters. Upon successful deletion, the API returns a response code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete opening balance

  • ID: delete_opening_balance
  • Operation: write
  • Entities: organization, opening balance
  • Summary: The 'Delete opening balance' API allows users to delete an entered opening balance for a specified organization in Zoho Books. The API requires an OAuth token for authorization, which must be included in the request headers. The organization ID must be provided as a query parameter. Upon successful deletion, the API returns a response with a code and a message indicating that the opening balance has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete project

  • ID: delete_project
  • Operation: write
  • Entities: project, authorization, organization
  • Summary: The 'Delete project' API allows users to delete an existing project in Zoho Books. It requires the project ID and organization ID as path and query parameters, respectively. The request must include an 'Authorization' header with a valid OAuth token. Upon successful deletion, the API returns a response with a code of 0 and a message indicating that the project has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete purchase order

  • ID: delete_purchase_order
  • Operation: write
  • Entities: purchase order, authorization
  • Summary: The 'Delete purchase order' API allows users to delete an existing purchase order in the Zoho Books system. It requires an OAuth token for authorization, which must be included in the request headers. The organization ID must be specified as a query parameter. Upon successful deletion, the API returns a response with a code and a message indicating that the purchase order has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a sales order

  • ID: delete_sales_order
  • Operation: write
  • Entities: organization, sales order
  • Summary: This API deletes an existing sales order in the Zoho Books system. It requires the sales order ID and the organization ID as path and query parameters, respectively. The request must include an Authorization header with a valid OAuth token. The API responds with a code and message indicating the success or failure of the operation. Note that invoiced sales orders cannot be deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Task

  • ID: delete_task
  • Operation: write
  • Entities: project, organization, task
  • Summary: The Delete Task API allows you to delete a specific task from a project in Zoho Books. To use this API, you need to provide the project ID and task ID as path parameters, and the organization ID as a query parameter. The request must include an Authorization header with a valid OAuth token. Upon successful deletion, the API returns a response with a code and a message indicating that the task has been deleted successfully.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a tax authority [US and CA Edition only]

  • ID: delete_tax_authority_us_and_ca_edition_only
  • Operation: write
  • Entities: setting, tax authority, organization
  • Summary: This API deletes a tax authority in Zoho Books for US and CA editions only. It requires an OAuth token for authorization. The request must include the tax authority ID as a path parameter and the organization ID as a query parameter. Upon successful deletion, the API returns a response code and a message indicating that the tax authority has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a tax exemption [US Edition only]

  • ID: delete_tax_exemption_us_edition_only
  • Operation: write
  • Entities: setting, tax exemption, organization
  • Summary: This API deletes a tax exemption for a specified organization in the US edition of Zoho Books. It requires an OAuth token for authorization, the tax exemption ID as a path parameter, and the organization ID as a query parameter. Upon successful deletion, it returns a response code and a message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete time entries

  • ID: delete_time_entries
  • Operation: delete
  • Entities: project, time entry, organization
  • Summary: The 'Delete time entries' API allows users to delete time entries from a project in Zoho Books. It requires an OAuth token for authorization, which should be included in the request headers. The organization_id must be specified as a query parameter to identify the organization from which the time entries are to be deleted. Upon successful deletion, the API returns a response with a code and a message indicating that the selected timesheet entries have been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete time entry

  • ID: delete_time_entry
  • Operation: write
  • Entities: project, time entry
  • Summary: The 'Delete time entry' API allows users to delete a specific time entry from a project in Zoho Books. The API requires an OAuth token for authentication, which should be included in the 'Authorization' header. The 'time_entry_id' is a path parameter that specifies the ID of the time entry to be deleted, and 'organization_id' is a query parameter that specifies the ID of the organization. Upon successful deletion, the API returns a response with a code and message indicating the time entry has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete user

  • ID: delete_user
  • Operation: write
  • Entities: project, organization, user
  • Summary: The 'Delete user' API is used to remove a user from a specified project within an organization in Zoho Books. The API requires an OAuth token for authorization, which must be included in the request headers. The request URL must include the project ID and user ID as path parameters, and the organization ID as a query parameter. Upon successful execution, the API returns a response code and message indicating that the user has been removed from the project.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete vendor credit

  • ID: delete_vendor_credit
  • Operation: delete
  • Entities: vendor credit
  • Summary: The 'Delete vendor credit' API allows you to delete a specific vendor credit in Zoho Books. To use this API, you need to provide the vendor credit ID as a path parameter and the organization ID as a query parameter. The request must include an 'Authorization' header with a valid OAuth token. Upon successful deletion, the API returns a response with a code and a message indicating that the vendor credit has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete vendor credit refund

  • ID: delete_vendor_credit_refund
  • Operation: write
  • Entities: vendor credit, refund, organization
  • Summary: The 'Delete vendor credit refund' API allows you to delete a specific refund associated with a vendor credit in Zoho Books. To use this API, you need to provide the vendor credit ID and the refund ID as path parameters, and the organization ID as a query parameter. The request must include an Authorization header with a valid OAuth token. Upon successful deletion, the API returns a response with a code and a message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a vendor payment

  • ID: delete_vendor_payment
  • Operation: write
  • Entities: vendor payment
  • Summary: This API deletes an existing vendor payment in Zoho Books. It requires the vendor payment ID and organization ID as path and query parameters, respectively. The request must include an Authorization header with a valid OAuth token. Upon successful deletion, the API returns a response code of 0 and a message indicating that the payment has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a bill

  • ID: get_a_bill
  • Operation: read
  • Entities: bill, purchase order, vendor
  • Summary: The 'Get a bill' API retrieves the details of a specific bill from Zoho Books. It requires an OAuth token for authorization, which should be included in the request headers. The API endpoint requires the bill ID as a path parameter and the organization ID as a query parameter. The response includes detailed information about the bill, such as vendor details, VAT treatment, status, line items, payments, and more. The response is structured in a JSON format with a 'code' indicating success or failure and a 'message' providing additional information. The 'bill' object contains comprehensive details about the bill, including its ID, vendor information, line items, taxes, payments, and other related data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a bill attachment

  • ID: get_a_bill_attachment
  • Operation: read
  • Entities: bill, attachment
  • Summary: The 'Get a bill attachment' API retrieves the file attached to a specified bill in Zoho Books. It requires an OAuth token for authorization, which should be included in the request headers. The API endpoint requires the bill ID as a path parameter and the organization ID as a query parameter. An optional query parameter 'preview' can be used to request a thumbnail of the attachment. The response includes a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a contact person

  • ID: get_a_contact_person
  • Operation: read
  • Entities: contact person, contact
  • Summary: The 'Get a contact person' API retrieves the details of a specific contact person associated with a contact in Zoho Books. It requires an OAuth token for authorization, and the contact ID, contact person ID, and organization ID as parameters. The response includes details such as the contact person's name, email, phone numbers, designation, department, and whether they are the primary contact or added in the portal.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a credit note

  • ID: get_a_credit_note
  • Operation: read
  • Entities: line item, credit note, customer
  • Summary: The 'Get a credit note' API retrieves the details of an existing credit note from Zoho Books. It requires an OAuth token for authorization and the credit note ID as a path parameter. The API supports optional query parameters such as 'print' to export the credit note as a PDF and 'accept' to specify the format of the response (json, pdf, or html). The response includes detailed information about the credit note, such as its ID, number, date, status, customer details, line items, invoices, taxes, and addresses. The API is useful for obtaining comprehensive information about a specific credit note in a specified format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a Currency

  • ID: get_a_currency
  • Operation: read
  • Entities: setting, currency, organization
  • Summary: The 'Get a Currency' API retrieves the details of a specific currency using its currency ID. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes the currency ID, code, name, symbol, price precision, format, and a flag indicating if it is the base currency.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a project

  • ID: get_a_project
  • Operation: read
  • Entities: project, task, customer
  • Summary: The 'Get a project' API retrieves the details of a specific project from Zoho Books. It requires an OAuth token for authentication, which should be included in the request headers. The API endpoint requires the project ID as a path parameter and the organization ID as a query parameter. The response includes detailed information about the project, such as project ID, name, customer details, currency, description, status, billing type, rate, budget, hours, amounts, and associated tasks. The response also indicates if the project is shown in the dashboard and if there are any recurring invoices associated with it.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a purchase order

  • ID: get_a_purchase_order
  • Operation: read
  • Entities: purchase order, line item, vendor
  • Summary: The 'Get a purchase order' API retrieves the details of a specific purchase order from Zoho Books. It requires an OAuth token for authorization, which should be included in the request headers. The API requires a path parameter 'purchaseOrderId' to specify the purchase order to retrieve. It also supports optional query parameters such as 'print' to print the exported PDF and 'accept' to specify the format of the response (json, pdf, or html). The default response format is JSON. The response includes detailed information about the purchase order, such as purchase order ID, vendor details, line items, billing and delivery addresses, and various tax and discount details. The API is useful for obtaining comprehensive information about purchase orders for further processing or analysis.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a recurring bill

  • ID: get_a_recurring_bill
  • Operation: read
  • Entities: line item, recurring bill, vendor
  • Summary: The 'Get a recurring bill' API retrieves the details of a specific recurring bill from Zoho Books. It requires an OAuth token for authorization and the recurring bill ID as a path parameter. The organization ID must be provided as a query parameter. The API returns detailed information about the recurring bill, including vendor details, status, currency, supply details, tax information, line items, and custom fields. The response includes a success code and message, along with the full details of the recurring bill.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a recurring expense

  • ID: get_a_recurring_expense
  • Operation: read
  • Entities: recurring expense, account, customer
  • Summary: The 'Get a recurring expense' API retrieves the details of a specific recurring expense from Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The API returns detailed information about the recurring expense, including its ID, recurrence name, start and end dates, tax details, account information, and customer details. The response includes a comprehensive breakdown of the expense, including line items and tax summaries.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a Recurring Invoice

  • ID: get_a_recurring_invoice
  • Operation: read
  • Entities: recurring invoice, line item, customer
  • Summary: The 'Get a Recurring Invoice' API retrieves the details of a specific recurring invoice using its ID. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes detailed information about the recurring invoice, such as customer details, line items, billing and shipping addresses, and payment options. The API also provides pagination context for the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a retainer invoice

  • ID: get_a_retainer_invoice
  • Operation: read
  • Entities: payment, retainer invoice, customer
  • Summary: The 'Get a retainer invoice' API retrieves the details of a specific retainer invoice using its ID. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes comprehensive details about the retainer invoice such as invoice number, date, status, customer details, line items, taxes, payment information, and addresses. The API is useful for obtaining detailed information about a retainer invoice for a given organization.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a rule

  • ID: get_a_rule
  • Operation: read
  • Entities: rule, bank account, customer
  • Summary: The 'Get a rule' API retrieves details of a specific rule in the Zoho Books banking module. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes details such as the rule ID, name, order, criteria, and associated account and customer information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a sales order

  • ID: get_a_sales_order
  • Operation: read
  • Entities: sales order, line item, customer
  • Summary: The 'Get a sales order' API retrieves the details of a specific sales order from Zoho Books. It requires an OAuth token for authorization and the sales order ID as a path parameter. The organization ID is a mandatory query parameter, while 'print' and 'accept' are optional query parameters that control the output format and whether to print the PDF. The response includes detailed information about the sales order, such as customer details, billing and shipping addresses, tax information, line items, and custom fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a task

  • ID: get_a_task
  • Operation: read
  • Entities: project, task
  • Summary: The 'Get a task' API retrieves the details of a specific task within a project in Zoho Books. It requires an OAuth token for authorization, and the request must include the project ID and task ID as path parameters, as well as the organization ID as a query parameter. The response includes the task details such as project ID, project name, task ID, task name, description, rate, status, and whether the task is billable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a tax

  • ID: get_a_tax
  • Operation: read
  • Entities: tax, tax authority, organization
  • Summary: The 'Get a tax' API retrieves the details of a specific tax, which can be either simple or compound. It requires an OAuth token for authorization and the organization ID as a query parameter. The API returns a response containing the tax details, including tax ID, name, percentage, type, authority details, and more. The response code and message indicate the success or failure of the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a tax group

  • ID: get_a_tax_group
  • Operation: read
  • Entities: tax, tax authority, tax group
  • Summary: The 'Get a tax group' API retrieves the details of a specific tax group using its ID. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes the tax group ID, name, percentage, and details of the taxes within the group, such as tax ID, name, percentage, type, factor, and authority information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a time entry

  • ID: get_a_time_entry
  • Operation: read
  • Entities: project, time entry, customer
  • Summary: The 'Get a time entry' API retrieves details of a specific time entry from Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes detailed information about the time entry, such as the project and customer details, task information, user details, log times, billing status, and other relevant metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a User

  • ID: get_a_user
  • Operation: read
  • Entities: project, organization, user
  • Summary: The 'Get a User' API retrieves details of a specific user within a project. It requires an OAuth token for authorization, and the request must include the project ID and user ID as path parameters, as well as the organization ID as a query parameter. The response includes the user's ID, name, email, role, and cost rate, along with a success message and code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get account details

  • ID: get_account_details
  • Operation: read
  • Entities: organization, bank, account
  • Summary: The 'Get account details' API provides detailed information about a specified bank account. It requires an OAuth token for authorization, the organization ID as a query parameter, and the account ID as a path parameter. The API returns a comprehensive set of details about the bank account, including its ID, name, currency details, account type, balance, bank name, and other attributes. The response includes a success code and message, along with the bank account details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List account details for base currency adjustment

  • ID: get_account_details_for_base_currency_adjustment
  • Operation: read
  • Entities: adjustment, currency, account
  • Summary: This API lists the account details for a base currency adjustment. It requires the organization ID, currency ID, adjustment date, exchange rate, and notes as query parameters. The API returns a list of accounts affected by the given exchange rate adjustment, including details such as account ID, account name, balances in base and foreign currencies, adjusted balance, and gain or loss from the adjustment. The response also includes the adjustment date, exchange rate, currency ID, and notes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get an account

  • ID: get_an_account
  • Operation: read
  • Entities: custom field, currency, account
  • Summary: The 'Get an account' API retrieves the details of a specific account using the account ID. It requires an OAuth token for authorization, the account ID as a path parameter, and the organization ID as a query parameter. The response includes detailed information about the account such as account ID, name, code, type, currency details, description, and various flags indicating the account's status and involvement in transactions. Custom fields, closing balance, parent account ID, associated documents, and timestamps for creation and last modification are also provided in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get an employee

  • ID: get_an_employee
  • Operation: read
  • Entities: organization, employee
  • Summary: The 'Get an employee' API retrieves the details of an employee from the Zoho Books system. It requires an OAuth token for authorization, which should be included in the request headers. The API endpoint requires the organization_id as a query parameter to specify which organization's employee details are being requested. Upon a successful request, the API returns a response with a code indicating success, a message, and the employee's details including their ID, name, and email.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get an estimate

  • ID: get_an_estimate
  • Operation: read
  • Entities: line item, estimate, customer
  • Summary: The 'Get an estimate' API retrieves the details of a specific estimate from Zoho Books. It requires an OAuth token for authentication and the estimate ID as a path parameter. The organization ID is a required query parameter, while 'print' and 'accept' are optional query parameters that control the output format and whether to print the PDF. The response includes detailed information about the estimate, such as estimate number, date, customer details, line items, taxes, and addresses. The API supports multiple response formats including JSON, PDF, and HTML.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get an Expense

  • ID: get_an_expense
  • Operation: read
  • Entities: tax, account, expense
  • Summary: The 'Get an Expense' API retrieves the details of a specific expense from Zoho Books. It requires an OAuth token for authorization, which should be included in the request headers. The API endpoint requires the 'expense_id' as a path parameter and 'organization_id' as a query parameter. The response includes detailed information about the expense, such as transaction type, GST details, tax amounts, account information, and more. The response is structured with a 'code' indicating success or failure, a 'message', and an 'expense' object containing all the relevant details of the expense.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get an invoice

  • ID: get_an_invoice
  • Operation: read
  • Entities: item, invoice, customer
  • Summary: The 'Get an invoice' API retrieves the details of a specific invoice from Zoho Books. It requires an OAuth token for authorization and the invoice ID as a path parameter. The organization ID is a mandatory query parameter. Optional query parameters include 'print' to print the exported PDF and 'accept' to specify the format of the invoice details (json, pdf, html). The response includes a detailed invoice object with fields such as invoice ID, customer details, line items, taxes, and payment information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get an item

  • ID: get_an_item
  • Operation: read
  • Entities: item, warehouse, tax
  • Summary: The 'Get an item' API retrieves details of an existing item from Zoho Books. It requires an OAuth token for authorization, which should be included in the request headers. The API endpoint requires the organization ID as a query parameter. Upon a successful request, the API returns a response containing the item details, including item ID, name, status, description, rate, unit, tax information, SKU, product type, and warehouse details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a base currency adjustment

  • ID: get_base_currency_adjustment
  • Operation: read
  • Entities: base currency adjustment, currency, account
  • Summary: This API retrieves the details of a base currency adjustment for a specified organization in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes the adjustment ID, date, exchange rate, currency ID, account details, notes, and currency code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Bulk export estimates

  • ID: get_bulk_export_estimates
  • Operation: read
  • Entities: organization, pdf, estimate
  • Summary: The Bulk export estimates API allows users to export up to 25 estimates in a single PDF document. It requires an OAuth token for authorization and takes query parameters including 'organization_id' and 'estimate_ids'. The 'estimate_ids' parameter is a comma-separated list of estimate IDs to be exported. The API returns a response code and message indicating the success or failure of the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Bulk export Invoices

  • ID: get_bulk_export_invoices
  • Operation: read
  • Entities: invoice, pdf, organization
  • Summary: The Bulk export Invoices API allows users to export up to 25 invoices in a single PDF document. It requires an OAuth token for authorization and takes query parameters including 'organization_id' and 'invoice_ids'. The 'invoice_ids' parameter is a comma-separated list of invoice IDs to be exported. The API returns a response with a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Bulk export sales orders

  • ID: get_bulk_export_sales_orders
  • Operation: read
  • Entities: pdf, organization, sales order
  • Summary: The Bulk export sales orders API allows users to export up to 25 sales orders in a single PDF document. The API requires an OAuth token for authorization, which should be included in the request headers. The organization_id must be specified as a query parameter to identify the organization whose sales orders are to be exported. Upon successful execution, the API returns a response with a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Bulk print estimates

  • ID: get_bulk_print_estimates
  • Operation: read
  • Entities: organization, estimate
  • Summary: The Bulk print estimates API allows users to export estimates as PDF and print them. A maximum of 25 estimates can be printed at a time. The API requires an OAuth token for authorization and takes query parameters including 'organization_id' and 'estimate_ids'. The 'estimate_ids' parameter is a comma-separated list of estimate IDs to be printed. The response includes a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Bulk print invoices

  • ID: get_bulk_print_invoices
  • Operation: read
  • Entities: invoice, pdf, organization
  • Summary: The Bulk print invoices API allows users to export and print up to 25 invoices as a PDF. It requires an OAuth token for authorization, and the organization ID and a comma-separated list of invoice IDs as query parameters. The API returns a response code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Bulk print sales orders

  • ID: get_bulk_print_sales_orders
  • Operation: read
  • Entities: organization, sales order
  • Summary: The Bulk print sales orders API allows users to export and print up to 25 sales orders as a PDF. It requires an OAuth token for authorization, which should be included in the request headers. The organization_id must be specified as a query parameter to identify the organization whose sales orders are to be printed. The API responds with a success message and a code indicating the result of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List comments

  • ID: get_comments_for_project
  • Operation: read
  • Entities: project, comment
  • Summary: The 'List comments' API retrieves comments for a specified project within an organization. It requires an OAuth token for authorization, the project ID as a path parameter, and the organization ID as a query parameter. The response includes a list of comments with details such as comment ID, project ID, description, user information, and timestamps.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Contact

  • ID: get_contact
  • Operation: read
  • Entities: shipping address, billing address, contact
  • Summary: The Get Contact API retrieves the details of a specific contact from Zoho Books. It requires an OAuth token for authorization, which should be included in the request headers. The API endpoint requires a contact ID as a path parameter and an organization ID as a query parameter. The response includes detailed information about the contact, such as contact name, company name, contact type, tax details, billing and shipping addresses, contact persons, and default templates. The response also includes metadata such as creation and last modified times.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Contact Addresses

  • ID: get_contact_addresses
  • Operation: read
  • Entities: address, contact
  • Summary: The Get Contact Addresses API retrieves all addresses associated with a specific contact in Zoho Books, including shipping, billing, and additional addresses. It requires an OAuth token for authorization, a contact ID as a path parameter, and an organization ID as a query parameter. The response includes a list of addresses with details such as address ID, attention, street address, city, state, ZIP code, country, fax, and phone number.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Convert PO to Bill

  • ID: get_convert_po_to_bill
  • Operation: write
  • Entities: bill, purchase order, vendor
  • Summary: The 'Convert PO to Bill' API allows users to create a bill for selected purchase orders. It requires the purchase order IDs and organization ID as query parameters. The API uses OAuth for authorization, requiring an 'Authorization' header with a valid token. The response includes details of the created bill, such as bill ID, vendor details, tax information, line items, and payment details. The API is useful for automating the conversion of purchase orders into bills within the Zoho Books platform.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List credit note comments & history

  • ID: get_credit_note_comments_history
  • Operation: read
  • Entities: comment, credit note, history
  • Summary: This API retrieves the comments and history of a specific credit note. It requires an OAuth token for authorization and the credit note ID as a path parameter. The organization ID must be provided as a query parameter. The response includes a list of comments with details such as the comment ID, description, the person who commented, and the type of operation performed.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get credit note refund

  • ID: get_credit_note_refund
  • Operation: read
  • Entities: credit note refund, credit note, customer
  • Summary: The 'Get credit note refund' API retrieves the refund details of a specific credit note. It requires the credit note ID and the refund ID as path parameters, and the organization ID as a query parameter. The request must include an Authorization header with a valid OAuth token. The response includes details such as the refund ID, credit note ID, refund date, mode, payment form, reference number, amount, customer name, and a description.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List credit note template

  • ID: get_credit_note_template
  • Operation: read
  • Entities: credit note, organization, template
  • Summary: The 'List credit note template' API retrieves all available credit note PDF templates for a specified organization. It requires an OAuth token for authorization, which should be included in the request headers. The organization ID must be provided as a query parameter. The API responds with a list of templates, each containing the template name, ID, and type. A successful response will have a code of 0 and a message indicating success.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get current running timer

  • ID: get_current_running_timer
  • Operation: read
  • Entities: project, time entry, customer
  • Summary: The 'Get current running timer' API retrieves the current running timer for the authenticated user in a specified organization. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes details about the time entry such as the time entry ID, project details, customer details, task details, user details, log times, billing status, and any notes or custom fields associated with the timesheet.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get current user

  • ID: get_current_user
  • Operation: read
  • Entities: organization, user, role
  • Summary: The 'Get current user' API retrieves the details of the current user associated with the specified organization in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes the user's ID, name, email addresses, status, role, type, and other relevant details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Details of a refund

  • ID: get_details_of_a_refund
  • Operation: read
  • Entities: refund, vendor payment, account
  • Summary: This API retrieves the details of a specific refund for a vendor payment in Zoho Books. It requires the vendor payment ID and the refund ID as path parameters, and the organization ID as a query parameter. The request must include an Authorization header with a valid OAuth token. The response includes details such as the refund ID, vendor payment ID, date, refund mode, reference number, amount, exchange rate, account details, and a description.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get email content of a credit note

  • ID: get_email_content_of_a_credit_note
  • Operation: read
  • Entities: email template, credit note, customer
  • Summary: The 'Get email content of a credit note' API retrieves the email content associated with a specific credit note in Zoho Books. It requires an OAuth token for authorization and the credit note ID as a path parameter. The organization ID is a mandatory query parameter, while the email template ID is optional. If the email template ID is not provided, the default template will be used. The API returns the email content details, including the body, subject, associated email templates, recipient contacts, and sender details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Email history

  • ID: get_email_history
  • Operation: read
  • Entities: email history, credit note
  • Summary: The 'Email history' API retrieves the email history of a specific credit note. It requires an OAuth token for authorization and the credit note ID as a path parameter. The organization ID must be provided as a query parameter. The API returns a list of email history records, each containing details such as the sender's email, recipient email addresses, subject, and date of the email.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get estimate email content

  • ID: get_estimate_email_content
  • Operation: read
  • Entities: email template, estimate, customer
  • Summary: The 'Get estimate email content' API retrieves the email content for a specific estimate in Zoho Books. It requires an OAuth token for authorization and the estimate ID as a path parameter. The organization ID and email template ID are required query parameters. The response includes the email body, subject, list of email templates, contacts, and other related information. If the email template ID is not provided, the default template associated with the customer is used.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get an exchange rate

  • ID: get_exchange_rate
  • Operation: read
  • Entities: exchange rate, currency, organization
  • Summary: This API retrieves the details of an exchange rate associated with a specific currency. It requires an OAuth token for authorization. The request must include the currency ID and exchange rate ID as path parameters, and the organization ID as a query parameter. The response includes a code indicating success or failure, a message, and the exchange rate value.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List expense History & Comments

  • ID: get_expense_history_comments
  • Operation: read
  • Entities: comment, organization, expense
  • Summary: This API retrieves the history and comments of a specific expense in Zoho Books. It requires an OAuth token for authorization and the expense ID as a path parameter. The organization ID must be provided as a query parameter. The response includes a list of comments with details such as comment ID, expense ID, description, the user who commented, and the time of the comment.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get an expense receipt

  • ID: get_expense_receipt
  • Operation: read
  • Entities: receipt, organization, expense
  • Summary: The 'Get an expense receipt' API retrieves the receipt attached to a specified expense in Zoho Books. It requires an OAuth token for authorization, and the expense ID must be provided as a path parameter. The organization ID is a required query parameter, and an optional 'preview' query parameter can be used to request a thumbnail of the receipt. The API returns a response with a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Generate payment link

  • ID: get_generate_payment_link
  • Operation: read
  • Entities: invoice, transaction, payment link
  • Summary: The 'Generate payment link' API generates a payment link for a specified invoice with an expiry date. It requires an OAuth token for authorization and takes several query parameters: 'transaction_id' (the ID of the transaction), 'transaction_type' (the type of transaction, e.g., Invoice), 'link_type' (the type of link, either Private or Public), 'expiry_time' (the expiry date of the link in yyyy-MM-dd format), and 'organization_id' (the ID of the organization). The API returns a response with a code and message indicating success or failure, and if successful, it provides a 'share_link' which is the generated payment link.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Individual Record Details

  • ID: get_individual_record_details
  • Operation: read
  • Entities: comment, debtor, user
  • Summary: The 'Get Individual Record Details' API retrieves the details of a specific debtor record from Zoho Books. It requires an OAuth token for authorization, which should be included in the request headers. The API endpoint requires the debtor ID as part of the URL and the organization ID as a query parameter. The response includes detailed information about the debtor record, including comments, module fields, and user details. The response body contains a code and message indicating the success of the operation, along with the module record and hash details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get an invoice attachment

  • ID: get_invoice_attachment
  • Operation: read
  • Entities: invoice, attachment, organization
  • Summary: The 'Get an invoice attachment' API retrieves the file attached to a specified invoice. It requires an OAuth token for authorization, which should be included in the request headers. The API endpoint requires the invoice ID as a path parameter and the organization ID as a query parameter. An optional query parameter 'preview' can be used to request a thumbnail of the attachment. The response includes a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List invoice comments & history

  • ID: get_invoice_comments_history
  • Operation: read
  • Entities: comment, invoice, history
  • Summary: The 'List invoice comments & history' API retrieves the complete history and comments of a specified invoice. It requires an OAuth token for authorization and the invoice ID as a path parameter. The organization ID must be provided as a query parameter. The response includes a list of comments with details such as comment ID, invoice ID, description, commenter details, comment type, operation type, date, time, transaction ID, and transaction type.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get invoice email content

  • ID: get_invoice_email_content
  • Operation: read
  • Entities: email template, invoice, customer
  • Summary: The 'Get invoice email content' API retrieves the email content for a specified invoice. It requires an OAuth token for authorization and the invoice ID as a path parameter. The organization ID is a required query parameter, while the email template ID is optional. If the email template ID is not provided, the default or customer-associated template will be used. The response includes details such as the email body, customer name, subject, and associated documents. It also provides information about the email templates and contacts involved.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List invoice templates

  • ID: get_invoice_templates
  • Operation: read
  • Entities: invoice, organization, template
  • Summary: The 'List invoice templates' API retrieves all invoice PDF templates available for a specified organization. It requires an OAuth token for authorization, which must be included in the request headers. The organization ID must be provided as a query parameter. The API responds with a list of templates, each containing a template name, ID, and type, along with a response code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get journal

  • ID: get_journal
  • Operation: read
  • Entities: tax, line item, journal
  • Summary: The 'Get journal' API retrieves the details of a specific journal entry in Zoho Books. It requires an OAuth token for authorization, the journal entry ID as a path parameter, and the organization ID as a query parameter. The API returns a detailed response containing the journal's ID, entry number, reference number, notes, currency details, journal date, type, VAT treatment, line items, total amounts, taxes, creation and modification times, status, and any custom fields associated with the journal.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get journal list

  • ID: get_journal_list
  • Operation: read
  • Entities: journal
  • Summary: The 'Get journal list' API retrieves a list of journals from Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. Optional query parameters include entry_number, reference_number, date, notes, last_modified_time, total, customer_id, vendor_id, filter_by, and sort_column, which allow for filtering and sorting the journal list. The response includes a code, message, and an array of journal objects, each containing details such as journal_id, journal_date, entry_number, reference_number, currency_id, notes, journal_type, entity_type, total, bcy_total, and custom_field.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get last imported statement

  • ID: get_last_imported_statement
  • Operation: read
  • Entities: statement, transaction, bank account
  • Summary: The 'Get last imported statement' API retrieves the details of the most recently imported statement for a specified bank account. It requires an OAuth token for authorization, the bank account ID as a path parameter, and the organization ID as a query parameter. The response includes a list of statements with details such as statement ID, date range, source, and transactions. Each transaction includes information like transaction ID, type, date, customer ID, payee, reference number, amount, and status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List a retainer invoices

  • ID: get_list_a_retainer_invoices
  • Operation: read
  • Entities: project, retainer invoice, customer
  • Summary: The 'List a retainer invoices' API allows users to retrieve a list of retainer invoices with pagination support. It requires an OAuth token for authorization and the organization ID as a query parameter. Optional query parameters include print, sort_column, filter_by, sort_order, and page. The response includes a list of retainer invoices with details such as invoice ID, customer name, status, total amount, and more, along with pagination context.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Credit Notes

  • ID: get_list_all_credit_notes
  • Operation: read
  • Entities: item, credit note, customer
  • Summary: The 'List all Credit Notes' API allows users to retrieve a list of all credit notes associated with a specified organization in Zoho Books. The API requires an OAuth token for authorization and the organization ID as a mandatory query parameter. Optional query parameters include credit note number, date, status, total, reference number, customer name, item name, customer ID, item description, item ID, line item ID, tax ID, filter by status, search text, and sort column. The response includes details of the credit notes such as credit note ID, number, status, reference number, date, total, balance, customer ID, customer name, currency ID, currency code, created time, last modified time, and whether the credit note was emailed.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Recurring Invoice

  • ID: get_list_all_recurring_invoice
  • Operation: read
  • Entities: item, recurring invoice, customer
  • Summary: This API retrieves the details of all recurring invoices for a specified organization. It requires an OAuth token for authorization and the organization ID as a query parameter. Optional query parameters include recurrence name, item name, item description, customer name, line item ID, item ID, tax ID, notes, start date, end date, customer ID, status, filter by, search text, and sort column. The response includes a list of recurring invoices with details such as invoice ID, recurrence name, customer details, currency, start and end dates, custom fields, billing and shipping addresses, and pagination context.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List base currency adjustment

  • ID: get_list_base_currency_adjustment
  • Operation: read
  • Entities: exchange rate, base currency adjustment, currency
  • Summary: The 'List base currency adjustment' API retrieves a list of base currency adjustments for a specified organization. It requires an OAuth token for authorization and the organization ID as a query parameter. Optional query parameters include 'filter_by' to filter the list by date, 'sort_column' to sort the list by various fields, and 'last_modified_time' to search by the last modified time. The response includes a code and message indicating success or failure, and a list of base currency adjustments with details such as adjustment ID, date, exchange rate, currency ID and code, notes, and gain or loss.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List bill comments & history

  • ID: get_list_bill_comments_history
  • Operation: read
  • Entities: bill, comment, history
  • Summary: The 'List bill comments & history' API retrieves the complete history and comments of a specified bill. It requires an OAuth token for authorization and the unique identifiers for the bill and organization as input parameters. The API returns a list of comments associated with the bill, including details such as the comment ID, bill ID, description, commenter details, comment type, date, time, operation type, and transaction details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List bill payments

  • ID: get_list_bill_payments
  • Operation: read
  • Entities: bill, vendor, payment
  • Summary: The 'List bill payments' API retrieves a list of payments made for a specific bill in Zoho Books. It requires an OAuth token for authorization, the bill ID as a path parameter, and the organization ID as a query parameter. The response includes a list of payments with details such as payment ID, bill ID, vendor information, payment mode, date, amount, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List bills

  • ID: get_list_bills
  • Operation: read
  • Entities: bill, vendor, item
  • Summary: The 'List bills' API allows users to retrieve a list of bills with pagination support. It requires an OAuth token for authorization and the organization ID as a mandatory query parameter. Users can filter and search bills using various query parameters such as bill number, reference number, date, status, description, vendor name, total, vendor ID, item ID, recurring bill ID, purchase order ID, last modified time, and more. The API also supports sorting by columns like vendor name, bill number, date, due date, total, balance, and created time. The response includes a list of bills with details such as bill ID, vendor ID, vendor name, status, bill number, reference number, date, due date, currency information, total amount, balance, and timestamps. Additionally, the response provides pagination context with information about the current page, items per page, and sorting details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List bills credited

  • ID: get_list_bills_credited
  • Operation: read
  • Entities: bill, vendor credit
  • Summary: The 'List bills credited' API retrieves a list of bills to which a vendor credit is applied. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes a list of credited bills with details such as vendor credit ID, bill ID, vendor credit bill ID, date, and bill number.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List chart of accounts

  • ID: get_list_chart_of_accounts
  • Operation: read
  • Entities: organization, transaction, account
  • Summary: The 'List chart of accounts' API retrieves a list of all chart of accounts for a specified organization, with options for pagination and filtering. It requires an OAuth token for authorization. The API accepts query parameters such as 'organization_id' (required), 'showbalance', 'filter_by', 'sort_column', and 'last_modified_time' to customize the response. The response includes a list of accounts with details like account ID, name, type, balance, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List child expenses created

  • ID: get_list_child_expenses_created
  • Operation: read
  • Entities: page context, recurring expense, expense
  • Summary: The 'List child expenses created' API retrieves a list of child expenses created from a recurring expense. It requires an OAuth token for authorization. The API supports sorting the expenses by various columns such as next_expense_date, account_name, total, etc. The response includes a list of expenses with details like expense_id, date, account_name, customer_name, total, status, vendor_name, and paid_through_account_name. Additionally, it provides page context information such as the sort column, filter applied, and search text used.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Comments

  • ID: get_list_comments
  • Operation: read
  • Entities: comment, transaction, contact
  • Summary: The List Comments API retrieves recent activities or comments associated with a specific contact in Zoho Books. It requires an OAuth token for authorization and the contact ID as a path parameter. The organization ID must be provided as a query parameter. The response includes a list of comments with details such as comment ID, contact name, commenter details, date, time, and transaction information. Pagination details are also included in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List contact persons

  • ID: get_list_contact_persons
  • Operation: read
  • Entities: contact person, organization, contact
  • Summary: The 'List contact persons' API retrieves a list of contact persons associated with a specific contact in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes a list of contact persons with details such as contact person ID, name, email, phone, and other attributes. Pagination details are also provided in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Contacts

  • ID: get_list_contacts
  • Operation: read
  • Entities: status, company, contact
  • Summary: The List Contacts API allows you to retrieve a list of contacts with pagination support. It requires an OAuth token for authorization and supports various query parameters for filtering and sorting the contacts. The response includes a list of contacts with details such as contact name, company name, contact type, status, payment terms, currency information, and contact person's details. The pagination context is also provided in the response to navigate through the pages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List credit note refunds

  • ID: get_list_credit_note_refunds
  • Operation: read
  • Entities: credit note refund, page context, customer
  • Summary: The 'List credit note refunds' API retrieves a list of all credit note refunds with pagination support. It requires an OAuth token for authorization and the organization ID as a query parameter. Optional query parameters include customer_id to filter refunds by customer and sort_column to sort the list by various fields such as refund_mode, reference_number, date, etc. The response includes a list of credit note refunds with details such as refund ID, credit note ID, date, refund mode, and amounts in base and foreign currencies. Pagination details are also provided in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List credits applied

  • ID: get_list_credits_applied
  • Operation: read
  • Entities: credit, invoice, organization
  • Summary: The 'List credits applied' API retrieves a list of credits that have been applied to a specific invoice. It requires an OAuth token for authorization and takes the invoice ID as a path parameter and the organization ID as a query parameter. The response includes a list of credits with details such as credit note ID, associated invoice ID, credit note number, credited date, and the amount applied.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Currencies

  • ID: get_list_currencies
  • Operation: read
  • Entities: currency
  • Summary: The List Currencies API retrieves a list of currencies configured in the Zoho Books account. It requires an OAuth token for authorization and the organization ID as a query parameter. Optionally, you can filter the currencies to exclude the base currency using the 'filter_by' query parameter. The response includes a list of currencies with details such as currency ID, code, name, symbol, price precision, format, whether it is the base currency, exchange rate, and effective date.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Customer Payments

  • ID: get_list_customer_payments
  • Operation: read
  • Entities: payment, customer
  • Summary: The 'List Customer Payments' API allows users to retrieve a list of payments made by customers. It requires an OAuth token for authorization and the organization ID as a mandatory query parameter. Users can filter the payments using various optional query parameters such as customer name, reference number, date, amount, notes, payment mode, and customer ID. The response includes a list of customer payments with details such as payment ID, payment number, invoice number, date, payment mode, amount, and base currency amount.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List employees

  • ID: get_list_employees
  • Operation: read
  • Entities: page context, organization, employee
  • Summary: The 'List employees' API retrieves a list of employees for a specified organization with pagination support. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes a list of employees with their IDs, names, and emails, along with pagination context such as the current page, number of records per page, and applied filters.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List estimate comments & history

  • ID: get_list_estimate_comments_history
  • Operation: read
  • Entities: comment, estimate, history
  • Summary: The 'List estimate comments & history' API retrieves the complete history and comments associated with a specific estimate. It requires an OAuth token for authorization and the estimate ID as a path parameter. The organization ID must be provided as a query parameter. The API returns a list of comments, each containing details such as the comment ID, estimate ID, description, commenter details, comment type, date, time, operation type, and transaction details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Estimate Template

  • ID: get_list_estimate_template
  • Operation: read
  • Entities: estimate template, authorization, organization
  • Summary: The List Estimate Template API retrieves all estimate PDF templates available for a specified organization in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes a list of templates, each with a name, ID, and type.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List estimates

  • ID: get_list_estimates
  • Operation: read
  • Entities: item, estimate, customer
  • Summary: The 'List estimates' API allows users to retrieve a list of estimates with pagination support. It requires an OAuth token for authorization and the organization ID as a mandatory query parameter. Users can filter and search estimates using various optional query parameters such as estimate number, reference number, customer name, total amount, customer ID, item ID, item name, item description, custom fields, expiry date, estimate date, status, and more. The response includes a list of estimates with details such as estimate ID, customer name, status, estimate number, reference number, date, currency, total amount, creation and modification times, and more. The response also includes pagination details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List exchange rates

  • ID: get_list_exchange_rates
  • Operation: read
  • Entities: exchange rate, currency
  • Summary: The 'List exchange rates' API retrieves a list of exchange rates configured for a specific currency. It requires an OAuth token for authorization and accepts query parameters such as 'from_date' to specify the starting date for exchange rate details, 'is_current_date' to filter rates available for the current date, and 'sort_column' to sort the results by a specific column like 'effective_date'. The response includes a list of exchange rates with details such as 'exchange_rate_id', 'currency_id', 'currency_code', 'effective_date', and 'rate'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Expenses

  • ID: get_list_expenses
  • Operation: read
  • Entities: expense, vendor, customer
  • Summary: The List Expenses API allows users to retrieve a list of expenses with pagination support. It requires an OAuth token for authorization and the organization ID as a mandatory query parameter. Users can filter and sort expenses based on various criteria such as description, reference number, date, status, amount, account name, customer name, vendor name, and more. The response includes a list of expenses with details such as expense ID, date, account name, description, currency, total amounts, billable status, customer details, and more. Pagination details are also provided in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List invoice payments

  • ID: get_list_invoice_payments
  • Operation: read
  • Entities: payment, invoice, organization
  • Summary: The 'List invoice payments' API retrieves a list of payments made for a specified invoice. It requires an OAuth token for authorization and the invoice ID as a path parameter. The organization ID must be provided as a query parameter. The response includes a list of payments with details such as payment ID, payment number, invoice ID, payment mode, date, amount, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List invoices

  • ID: get_list_invoices
  • Operation: read
  • Entities: item, invoice, customer
  • Summary: The 'List invoices' API allows users to retrieve a list of invoices with pagination support. It requires an OAuth token for authorization and the organization ID as a mandatory query parameter. The API supports various query parameters to filter and search invoices, such as invoice number, item name, customer name, status, and more. The response includes detailed information about each invoice, such as invoice ID, customer name, status, total amount, balance, and custom fields. The API also provides pagination details in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List invoices credited

  • ID: get_list_invoices_credited
  • Operation: read
  • Entities: invoice, credit note
  • Summary: The 'List invoices credited' API retrieves a list of invoices to which a specific credit note has been applied. It requires an OAuth token for authorization, the credit note ID as a path parameter, and the organization ID as a query parameter. The response includes a success code and message, along with an array of credited invoices, each containing details such as credit note ID, invoice ID, credit note invoice ID, date, invoice number, credit note number, and the credited amount.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List items

  • ID: get_list_items
  • Operation: read
  • Entities: item, tax rule, account
  • Summary: The 'List items' API retrieves a list of all active items with pagination support. It requires an OAuth token for authorization and the organization ID as a query parameter. Optional query parameters allow filtering and sorting of items by name, description, rate, tax details, account association, and more. The response includes a list of items with details such as item ID, name, status, rate, tax information, and custom fields, along with pagination context.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List of transactions for an account

  • ID: get_list_of_transactions_for_an_account
  • Operation: read
  • Entities: transaction, account, customer
  • Summary: This API lists all involved transactions for a given account in Zoho Books. It requires an OAuth token for authorization and the organization ID and account ID as query parameters. Optional query parameters include date range, amount range, account type and status filter, transaction type, and sort column. The response includes a list of transactions with details such as transaction type, status, date, account ID, customer ID, payee, description, entry number, currency, and amounts.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List projects

  • ID: get_list_projects
  • Operation: read
  • Entities: project, page_context, customer
  • Summary: The 'List projects' API allows users to retrieve a list of projects with pagination support. It requires an OAuth token for authorization and the organization ID as a mandatory query parameter. Optional query parameters include 'filter_by' to filter projects by status, 'customer_id' to search projects by customer ID, and 'sort_column' to sort the projects by specified columns. The response includes a list of projects with details such as project ID, name, customer details, status, billing type, rate, and time information, along with pagination context.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List purchase orders

  • ID: get_list_purchase_orders
  • Operation: read
  • Entities: item, purchase order, vendor
  • Summary: The 'List purchase orders' API allows users to retrieve a list of purchase orders from Zoho Books. It requires an OAuth token for authorization and the organization ID as a mandatory query parameter. Users can filter the purchase orders using various optional query parameters such as purchase order number, reference number, date, status, item description, vendor name, total, vendor ID, last modified time, item ID, filter by status, search text, sort column, and custom field. The response includes a list of purchase orders with details such as purchase order ID, vendor ID, vendor name, status, purchase order number, reference number, date, delivery date, currency ID, currency code, price precision, total amount, attachment status, creation time, last modified time, and custom fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List recurring bills

  • ID: get_list_recurring_bills
  • Operation: read
  • Entities: recurring bill, currency, vendor
  • Summary: The 'List recurring bills' API allows users to retrieve a list of recurring bills with pagination. It requires an OAuth token for authorization and the organization ID as a mandatory query parameter. Optional query parameters include recurring bill ID, vendor ID, vendor name, status, recurrence name, currency details, start and end dates, supply details, GST and VAT treatments, and more. The response includes details of each recurring bill such as IDs, vendor information, status, currency, supply details, tax treatments, line items, and custom fields. The API is useful for managing and tracking recurring bills within an organization.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List recurring expenses

  • ID: get_list_recurring_expenses
  • Operation: read
  • Entities: recurring expense, account, customer
  • Summary: The 'List recurring expenses' API allows users to retrieve a list of recurring expenses with pagination support. It requires an OAuth token for authorization and the organization ID as a mandatory query parameter. Users can filter and sort the expenses using various optional query parameters such as recurrence name, last created date, next expense date, status, account name, amount, customer name, and more. The response includes details of each recurring expense, such as the ID, recurrence name, frequency, account name, total amount, customer name, and status, along with pagination context.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Refunds

  • ID: get_list_refunds
  • Operation: read
  • Entities: refund, credit note, contact
  • Summary: The List Refunds API retrieves the refund history of a specified contact in Zoho Books. It requires an OAuth token for authorization and the contact ID as a path parameter. The organization ID must be provided as a query parameter. The API returns a list of credit note refunds, including details such as refund ID, credit note ID, date, refund mode, reference number, credit note number, customer name, description, and amounts in both base and foreign currencies. Pagination details are also included in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List refunds of a credit note

  • ID: get_list_refunds_of_a_credit_note
  • Operation: read
  • Entities: credit note, refund
  • Summary: This API lists all refunds of an existing credit note. It requires an OAuth token for authorization and the credit note ID as a path parameter. The organization ID must be provided as a query parameter. The response includes a list of refunds with details such as refund ID, date, mode, reference number, and amounts in base and foreign currencies. Pagination details are also included in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List refunds of a customer payment

  • ID: get_list_refunds_of_a_customer_payment
  • Operation: read
  • Entities: refund, organization, customer payment
  • Summary: This API lists all the refunds pertaining to an existing customer payment. It requires an OAuth token for authorization and the payment ID as a path parameter. The organization ID must be provided as a query parameter. The response includes a list of payment refunds with details such as refund ID, payment ID, date, refund mode, reference number, payment number, customer name, and amounts in base and foreign currencies. Pagination details are also included in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List refunds of a vendor credit

  • ID: get_list_refunds_of_a_vendor_credit
  • Operation: read
  • Entities: vendor credit, refund
  • Summary: This API lists all refunds associated with a specific vendor credit in Zoho Books. It requires an OAuth token for authorization and the vendor credit ID as a path parameter. The organization ID must be provided as a query parameter. The response includes a list of refunds with details such as refund ID, date, mode, reference number, amount, and customer name.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List refunds of a vendor payment

  • ID: get_list_refunds_of_a_vendor_payment
  • Operation: read
  • Entities: vendor payment, refund
  • Summary: This API lists all the refunds associated with a specific vendor payment. It requires an OAuth token for authorization, the vendor payment ID as a path parameter, and the organization ID as a query parameter. The response includes a list of refunds with details such as refund ID, date, mode, reference number, description, and amounts in both base and foreign currencies.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List sales order templates

  • ID: get_list_sales_order_templates
  • Operation: read
  • Entities: template, sales order
  • Summary: The 'List sales order templates' API retrieves all sales order PDF templates for a specified organization. It requires an OAuth token for authorization, which should be included in the request headers. The organization ID must be provided as a query parameter. The API returns a list of templates, each with a name, ID, and type, along with a response code and message indicating the success of the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List sales orders

  • ID: get_list_sales_orders
  • Operation: read
  • Entities: item, sales order, customer
  • Summary: The 'List sales orders' API allows users to retrieve a list of sales orders from Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. Users can sort, search, and filter sales orders using various query parameters such as sales order number, customer name, item name, and status. The response includes details of each sales order, such as sales order ID, customer name, status, total amount, and custom fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List tasks

  • ID: get_list_tasks
  • Operation: read
  • Entities: project, task, customer
  • Summary: The 'List tasks' API retrieves a list of tasks associated with a specific project in Zoho Books. It requires an OAuth token for authentication, which should be included in the request headers. The API endpoint requires the project ID as a path parameter and the organization ID as a query parameter. The response includes a list of tasks with details such as task ID, task name, project name, customer name, billed hours, and more. Pagination details are also provided in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List tax authorities [US Edition only]

  • ID: get_list_tax_authorities_us_edition_only
  • Operation: read
  • Entities: setting, tax authority, organization
  • Summary: This API retrieves a list of tax authorities for the US edition of Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes a list of tax authorities with details such as tax authority ID, name, description, registration number, and registration number label.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List tax exemptions [US Edition only]

  • ID: get_list_tax_exemptions_us_edition_only
  • Operation: read
  • Entities: tax exemption
  • Summary: The 'List tax exemptions [US Edition only]' API retrieves a list of tax exemptions for a specified organization in the US edition of Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes a list of tax exemptions, each with a unique ID, code, description, and type.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List taxes

  • ID: get_list_taxes
  • Operation: read
  • Entities: page context, tax, organization
  • Summary: The 'List taxes' API retrieves a list of simple and compound taxes with pagination support. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes a list of taxes with details such as tax ID, name, percentage, type, authority, and account information. Pagination details are also provided in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List time entries

  • ID: get_list_time_entries
  • Operation: read
  • Entities: project, time entry, user
  • Summary: The 'List time entries' API allows users to retrieve a list of time entries with pagination support. It requires an OAuth token for authorization. Users can filter the time entries by date range, status, project ID, user ID, and sort them by various columns such as project name, task name, and log date. The response includes a list of time entries with details such as project name, customer name, task name, user name, log date, and billing status, along with pagination context.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Users

  • ID: get_list_users
  • Operation: read
  • Entities: project, organization, user
  • Summary: The List Users API retrieves a list of users associated with a specific project in Zoho Books. It requires an OAuth token for authorization, the project ID as a path parameter, and the organization ID as a query parameter. The response includes a list of users with details such as user ID, name, email, role, status, rate, budget hours, and cost rate.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List vendor credits

  • ID: get_list_vendor_credits
  • Operation: read
  • Entities: item, vendor credit, vendor
  • Summary: The 'List vendor credits' API allows users to retrieve a list of vendor credits with various filtering and sorting options. It requires an OAuth token for authorization and the organization ID as a mandatory query parameter. Users can filter vendor credits by number, date, status, total amount, reference number, customer name, item name, item description, notes, custom fields, last modified time, customer ID, line item ID, item ID, and tax ID. The API also supports sorting by vendor name, vendor credit number, balance, total, date, and created time. The response includes a list of vendor credits with details such as vendor credit ID, number, status, reference number, date, total, balance, vendor ID, vendor name, currency ID, currency code, creation time, last modified time, attachment status, and exchange rate.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List vendor payments

  • ID: get_list_vendor_payments
  • Operation: read
  • Entities: bill, vendor payment, vendor
  • Summary: The 'List vendor payments' API allows users to retrieve a list of all payments made to vendors. It requires an OAuth token for authorization and supports various query parameters to filter the results, such as vendor name, reference number, payment number, date, amount, payment mode, and more. The response includes detailed information about each payment, including payment ID, vendor ID, vendor name, payment mode, amount, balance, and other relevant details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List view of accounts

  • ID: get_list_view_of_accounts
  • Operation: read
  • Entities: organization, bank account, credit card account
  • Summary: The 'List view of accounts' API allows you to list all bank and credit card accounts for your organization. It requires an OAuth token for authorization and the organization ID as a query parameter. Optional query parameters include 'filter_by' to filter accounts by status and 'sort_column' to sort the accounts by name, type, or code. The response includes a list of bank accounts with details such as account ID, name, type, balance, and bank information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get matching transactions

  • ID: get_matching_transactions
  • Operation: read
  • Entities: payment, transaction, contact
  • Summary: The 'Get matching transactions' API allows users to search for matching uncategorized transactions based on various criteria such as transaction ID, type, date range, amount range, contact name, and reference number. The API requires an OAuth token for authorization. It returns a list of matching transactions, which may include invoices, bills, or credit notes. The response includes details such as transaction ID, date, type, reference number, amount, debit or credit status, transaction number, contact name, and whether it is the best match.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get opening balance

  • ID: get_opening_balance
  • Operation: read
  • Entities: organization, account, opening balance
  • Summary: The 'Get opening balance' API retrieves the opening balance details for a specified organization in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes the opening balance ID, date, price precision, account details, and the total opening balance amount.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get payment reminder mail content

  • ID: get_payment_reminder_mail_content
  • Operation: read
  • Entities: payment reminder, email template, invoice
  • Summary: The 'Get payment reminder mail content' API retrieves the content of a payment reminder email for a specific invoice. It requires an OAuth token for authorization and the organization ID as a query parameter. The API returns a detailed response including the email body, customer details, associated documents, and email templates. The response also indicates if payment gateways are configured and associated, and provides lists of BCC and CC email addresses, along with other metadata related to the email.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a purchase order attachment

  • ID: get_purchase_order_attachment
  • Operation: read
  • Entities: purchase order, attachment
  • Summary: The 'Get a purchase order attachment' API retrieves the file attached to a specified purchase order. It requires an OAuth token for authorization, which should be included in the request headers. The API endpoint requires the purchase order ID as a path parameter and the organization ID as a query parameter. An optional query parameter 'preview' can be used to request a thumbnail of the attachment. The response includes a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List purchase order comments & history

  • ID: get_purchase_order_comments_history
  • Operation: read
  • Entities: purchase order, comment, history
  • Summary: This API retrieves the complete history and comments of a specified purchase order. It requires an OAuth token for authorization and the purchase order ID as a path parameter. The organization ID must be provided as a query parameter. The response includes a list of comments with details such as comment ID, description, commenter information, comment type, date, time, operation type, and transaction details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get purchase order email content

  • ID: get_purchase_order_email_content
  • Operation: read
  • Entities: purchase order, email template, organization
  • Summary: The 'Get purchase order email content' API retrieves the email content of a specified purchase order. It requires an OAuth token for authorization and the purchase order ID as a path parameter. The organization ID must be provided as a query parameter. Optionally, an email template ID can be specified to customize the email content. If not provided, the default or customer-associated template will be used. The API returns a response code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List purchase order templates

  • ID: get_purchase_order_templates
  • Operation: read
  • Entities: purchase order, template
  • Summary: The 'List purchase order templates' API retrieves all purchase order PDF templates available for a specified organization. It requires an OAuth token for authorization, which should be included in the request headers. The organization ID must be provided as a query parameter. The API responds with a list of templates, each containing a template name, ID, and type, along with a response code and message indicating the success of the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Record List of a Custom Module

  • ID: get_record_list_of_a_custom_module
  • Operation: read
  • Entities: page context, custom module, module record
  • Summary: This API retrieves a list of records from a custom module in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes a list of module records with details such as record ID, API name, creation and modification times, creator and modifier IDs, record name, and debt amount. The response also includes pagination details like current page, records per page, and sorting information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List recurring bill history

  • ID: get_recurring_bill_history
  • Operation: read
  • Entities: comment, recurring bill, organization
  • Summary: The 'List recurring bill history' API retrieves the history and comments of a specified recurring bill. It requires an OAuth token for authorization, the recurring bill ID as a path parameter, and the organization ID as a query parameter. The API returns a response code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List recurring expense history

  • ID: get_recurring_expense_history
  • Operation: read
  • Entities: recurring expense, comment
  • Summary: The 'List recurring expense history' API retrieves the history and comments associated with a specific recurring expense. It requires an OAuth token for authorization and the recurring expense ID as a path parameter. The organization ID must be provided as a query parameter. The response includes details about the comments such as the comment ID, recurring expense ID, description, commenter details, date, time, operation type, transaction ID, and transaction type.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Recurring Invoice History

  • ID: get_recurring_invoice_history
  • Operation: read
  • Entities: comment, recurring invoice, history
  • Summary: The 'List Recurring Invoice History' API retrieves the complete history and comments of a specified recurring invoice. It requires an OAuth token for authorization, the recurring invoice ID as a path parameter, and the organization ID as a query parameter. The response includes a list of comments with details such as comment ID, description, user information, and transaction details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a retainer invoice attachment

  • ID: get_retainer_invoice_attachment
  • Operation: read
  • Entities: attachment, organization, retainer invoice
  • Summary: This API retrieves the file attached to a specified retainer invoice. It requires an OAuth token for authorization, the retainer invoice ID as a path parameter, and the organization ID as a query parameter. The response includes a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List retainer invoice comments & history

  • ID: get_retainer_invoice_comments_history
  • Operation: read
  • Entities: comment, retainer invoice, history
  • Summary: This API retrieves the complete history and comments of a specified retainer invoice. It requires an OAuth token for authorization and the retainer invoice ID as a path parameter. The organization ID must be provided as a query parameter. The response includes a list of comments with details such as comment ID, description, commenter information, and transaction details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get retainer invoice email content

  • ID: get_retainer_invoice_email_content
  • Operation: read
  • Entities: retainer invoice, email, customer
  • Summary: The 'Get retainer invoice email content' API retrieves the email content for a specified retainer invoice. It requires an OAuth token for authorization and the invoice ID as a path parameter. The organization ID must be provided as a query parameter. The API returns the email content, including the subject, body, and recipient details. The response includes information about the invoice, such as the invoice number, date, and amount, as well as the sender and recipient contact details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List retainer invoice templates

  • ID: get_retainer_invoice_templates
  • Operation: read
  • Entities: template, organization, retainer invoice
  • Summary: The 'List retainer invoice templates' API retrieves all retainer invoice PDF templates available for a specified organization. It requires an OAuth token for authorization, which should be included in the request headers. The organization ID must be provided as a query parameter. The API responds with a list of templates, each containing details such as the template name, ID, and type.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a payment

  • ID: get_retrieve_a_payment
  • Operation: read
  • Entities: payment, invoice, customer
  • Summary: The 'Retrieve a payment' API allows users to fetch details of an existing payment in Zoho Books. It requires an OAuth token for authorization, a payment ID as a path parameter, and an organization ID as a query parameter. The response includes detailed information about the payment such as payment mode, amount, date, status, customer details, associated invoices, and any custom fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Rules List

  • ID: get_rules_list
  • Operation: read
  • Entities: criterion, rule, bank account
  • Summary: The Get Rules List API fetches all the rules created for a specified bank or credit card account ID. It requires an OAuth token for authorization and the account ID as a query parameter. The response includes a list of rules with details such as rule ID, name, order, criteria, and the account they apply to. This API is useful for retrieving rules associated with a specific bank account in Zoho Books.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a sales order attachment

  • ID: get_sales_order_attachment
  • Operation: read
  • Entities: attachment, organization, sales order
  • Summary: The 'Get a sales order attachment' API retrieves the file attached to a specified sales order. It requires an OAuth token for authorization, and the sales order ID must be provided as a path parameter. The organization ID is a required query parameter. Optional query parameters include 'preview' to check if a preview of the sales order is needed and 'inline' to check if an inline response is required. The API returns a response code and message indicating the success or failure of the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List sales order comments & history

  • ID: get_sales_order_comments_history
  • Operation: read
  • Entities: sales order, comment, history
  • Summary: This API retrieves the complete history and comments of a specified sales order. It requires an OAuth token for authorization, the sales order ID as a path parameter, and the organization ID as a query parameter. The response includes a code and message indicating success or failure, and a list of comments associated with the sales order.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get sales order email content

  • ID: get_sales_order_email_content
  • Operation: read
  • Entities: sales order, email template, customer
  • Summary: The 'Get sales order email content' API retrieves the email content of a specified sales order. It requires an OAuth token for authorization and the sales order ID as a path parameter. The organization ID is a required query parameter, while the email template ID is optional. If the email template ID is not provided, the default template associated with the customer will be used. The response includes details such as the email body, subject, customer name, and associated documents.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Statement Mail Content

  • ID: get_statement_mail_content
  • Operation: read
  • Entities: statement, contact, email
  • Summary: The 'Get Statement Mail Content' API retrieves the email content for a statement of transactions for a specified contact within a given organization. The API requires an OAuth token for authorization and accepts query parameters for the organization ID, start date, and end date. If the start and end dates are not provided, the current month's statement is sent. The response includes the email body, subject, recipient contact details, and any attached file names.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a tax authority [US and CA Edition only]

  • ID: get_tax_authority_us_and_ca_edition_only
  • Operation: read
  • Entities: tax authority, organization, registration number
  • Summary: This API retrieves the details of a tax authority for the US and CA editions only. It requires an OAuth token for authorization and takes the tax authority ID as a path parameter and the organization ID as a query parameter. The response includes the tax authority's ID, name, description, registration number, and registration number label.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a tax exemption [US Edition only]

  • ID: get_tax_exemption_us_edition_only
  • Operation: read
  • Entities: tax exemption, organization, customer
  • Summary: The 'Get a tax exemption [US Edition only]' API retrieves the details of a specific tax exemption for a given organization. It requires an OAuth token for authorization and the organization ID as a query parameter. The response includes the tax exemption ID, code, description, and type. This API is specifically for the US edition of Zoho Books.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get transaction

  • ID: get_transaction
  • Operation: read
  • Entities: transaction, account, customer
  • Summary: The 'Get transaction' API fetches the details of a specific bank transaction by using the transaction_id. It requires an OAuth token for authorization, which should be included in the request headers. The API endpoint is 'https://www.zohoapis.com/books/v3/banktransactions/' and requires the organization_id as a query parameter. The response includes detailed information about the transaction, such as transaction_id, account details, transaction type, currency, payment mode, date, customer and vendor details, reference number, description, tax details, and associated documents. The response also includes any imported transactions, tags, and line items related to the transaction.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get transactions list

  • ID: get_transactions_list
  • Operation: read
  • Entities: transaction, account, customer
  • Summary: The 'Get transactions list' API retrieves all transaction details involved in an account. It requires an OAuth token for authorization and the organization ID as a query parameter. Optional query parameters include account ID, transaction type, date range, amount range, status, reference number, filter type, sort column, transaction status, and search text. The response includes a list of transactions with details such as transaction ID, date, amount, type, status, source, account details, customer ID, payee, description, currency details, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get vendor credit

  • ID: get_vendor_credit
  • Operation: read
  • Entities: vendor credit, line item, document
  • Summary: The 'Get vendor credit' API retrieves details of a specific vendor credit using its ID. It requires an OAuth token for authorization. The API accepts query parameters such as 'organization_id' (required), 'print', and 'accept' to specify the format of the response. The response includes detailed information about the vendor credit, including its ID, number, date, status, vendor details, currency, line items, tax information, and more. The response is structured in a JSON format by default, but can be requested in other formats like XML, CSV, etc.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List vendor credit comments & history

  • ID: get_vendor_credit_comments_history
  • Operation: read
  • Entities: comment, vendor credit, history
  • Summary: This API retrieves the history and comments of a specific vendor credit. It requires an OAuth token for authorization and the vendor credit ID as a path parameter. The organization ID must be provided as a query parameter. The response includes a list of comments with details such as comment ID, description, user who commented, date, time, and transaction details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get vendor credit refund

  • ID: get_vendor_credit_refund
  • Operation: read
  • Entities: vendor credit, transaction, refund
  • Summary: The 'Get vendor credit refund' API retrieves the refund details of a specific vendor credit. It requires the vendor credit ID and vendor credit refund ID as path parameters, and the organization ID as a query parameter. The request must include an Authorization header with a valid OAuth token. The response includes details such as the refund ID, vendor credit ID, refund date, mode, amount, and associated account information. It also provides details of any imported transactions related to the refund.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List vendor credit refunds

  • ID: get_vendor_credit_refunds
  • Operation: read
  • Entities: vendor credit, vendor credit refund, customer
  • Summary: The 'List vendor credit refunds' API allows users to retrieve a list of vendor credit refunds with pagination support. It requires an OAuth token for authorization and accepts query parameters such as 'customer_id', 'last_modified_time', and 'sort_column' to filter and sort the results. The 'organization_id' is a mandatory query parameter. The response includes a list of vendor credit refunds with details such as refund ID, vendor credit ID, date, refund mode, reference number, amount, vendor credit number, customer name, description, and amounts in base and foreign currencies.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a vendor payment

  • ID: get_vendor_payment
  • Operation: read
  • Entities: bill, vendor payment, vendor
  • Summary: The 'Get a vendor payment' API retrieves the details of a specific vendor payment using the payment ID. It requires an OAuth token for authentication and the organization ID as a query parameter. Optional query parameters include fetchTaxInfo, fetchstatementlineinfo, print, and is_bill_payment_id to customize the response. The response includes detailed information about the vendor payment, such as payment mode, amount, vendor details, and associated bills and refunds.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Activate account

  • ID: post_activate_account
  • Operation: write
  • Entities: bank account, authorization, account
  • Summary: The Activate account API is used to mark a bank account as active in the Zoho Books application. It requires an OAuth token for authorization, the bank account ID as a path parameter, and the organization ID as a query parameter. The API does not require a request body. Upon successful activation, it returns a response code and a message indicating that the account has been marked as active.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Activate project

  • ID: post_activate_project
  • Operation: write
  • Entities: project, organization
  • Summary: The 'Activate project' API marks a specified project as active in the Zoho Books system. It requires an OAuth token for authorization, the project ID as a path parameter, and the organization ID as a query parameter. The API does not require a request body. Upon successful activation, it returns a response code and message indicating the project has been marked as active.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add a comment

  • ID: post_add_a_comment
  • Operation: write
  • Entities: comment, credit note, organization
  • Summary: The 'Add a comment' API allows users to add a comment to an existing credit note in Zoho Books. The API requires an OAuth token for authentication and the content type must be specified as 'application/json'. The request URL includes the credit note ID as a path parameter and the organization ID as a query parameter. The request body must contain a description of the comment. Upon successful execution, the API returns a response code and message indicating that the comment has been added.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Additional Address

  • ID: post_add_additional_address
  • Operation: write
  • Entities: address, organization, contact
  • Summary: The 'Add Additional Address' API allows users to add an additional address for a contact in Zoho Books. It requires an OAuth token for authorization and accepts various address-related parameters such as attention, address, street2, city, state, zip, country, fax, and phone. The API returns a response indicating the success of the operation along with the details of the created address.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add attachment to a bill

  • ID: post_add_attachment_to_a_bill
  • Operation: write
  • Entities: bill, attachment, organization
  • Summary: This API allows you to attach a file to a specific bill in Zoho Books. You need to provide the bill ID as a path parameter and the organization ID as a query parameter. The request must include an OAuth token in the headers for authorization. The file to be attached should be included in the request body and can be of types gif, png, jpeg, jpg, bmp, or pdf. Upon successful attachment, the API returns a response code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add attachment to an invoice

  • ID: post_add_attachment_to_invoice
  • Operation: write
  • Entities: file, invoice, attachment
  • Summary: This API allows you to attach a file to a specified invoice in Zoho Books. The request requires an OAuth token for authorization and the invoice ID as a path parameter. The organization ID must be provided as a query parameter. Optionally, you can specify if the attachment should be sent with the invoice when emailed using the 'can_send_in_mail' query parameter. The file to be attached must be included in the request body and can be of types gif, png, jpeg, jpg, bmp, or pdf. Upon successful attachment, the API returns a response code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add attachment to a journal

  • ID: post_add_attachment_to_journal
  • Operation: write
  • Entities: attachment, journal, document
  • Summary: The 'Add attachment to a journal' API allows users to attach a file to a specific journal entry in Zoho Books. It requires an OAuth token for authorization, which should be included in the request headers. The API accepts several optional query parameters, including 'attachment' for the file to be attached, 'doc' for the document to be attached, 'totalFiles' for the total number of files, and 'document_ids' for the IDs of the documents. Upon successful execution, the API returns a response code and a message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add attachment to a purchase order

  • ID: post_add_attachment_to_purchase_order
  • Operation: write
  • Entities: purchase order, attachment, organization
  • Summary: This API allows you to attach a file to a specific purchase order in Zoho Books. To use this API, you need to provide the purchase order ID as a path parameter and the organization ID as a query parameter. The request must include an OAuth token in the headers for authorization. The file to be attached should be included in the request body, and it must be one of the allowed file types: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc, or docx. Upon successful attachment, the API returns a response code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add attachment to a retainer invoice

  • ID: post_add_attachment_to_retainer_invoice
  • Operation: write
  • Entities: invoice, attachment, retainer invoice
  • Summary: This API allows you to attach a file to a retainer invoice in Zoho Books. It requires an OAuth token for authorization and the content type must be specified as 'application/json'. The request must include the invoice ID as a path parameter and the organization ID as a query parameter. The body of the request should contain a boolean 'can_send_in_mail' indicating if the attachment can be sent in mail, and the 'attachment' which is the file to be attached. The response will include a code and a message indicating the success or failure of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add attachment to a sales order

  • ID: post_add_attachment_to_sales_order
  • Operation: write
  • Entities: file, attachment, sales order
  • Summary: This API allows you to attach a file to a specific sales order in Zoho Books. You need to provide the sales order ID and organization ID as path and query parameters, respectively. The request must include an Authorization header with a valid OAuth token. Optional query parameters include the file to be attached, whether it can be sent in mail, the document name, total number of files, and document IDs. The response will indicate whether the attachment was successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated 7 days ago