Zohobook API Integration Vol.2

Suggest Edits

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

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

Add comment to a bill

ID: post_add_comment_to_bill
Operation: write
Entities: bill, comment
Summary: This API allows you to add a comment to a specific bill in Zoho Books. It requires an OAuth token for authentication and the organization ID as a query parameter. The request body must include a description of the comment. Upon successful execution, it returns a response with a code and message indicating the success of the operation, along with details of the comment added, such as comment ID, bill ID, description, and information about the user who commented.
Input Fields: Input Fields
Output Fields: Output Fields

Add comment to an invoice

ID: post_add_comment_to_invoice
Operation: write
Entities: comment, invoice, client
Summary: This API allows you to add a comment to a specific invoice in Zoho Books. You need to provide the invoice ID as a path parameter and the organization ID as a query parameter. Optionally, you can include a description of the comment, the expected payment date, and a boolean to indicate if the comment should be visible to clients. The request must include an Authorization header with a valid OAuth token. The response will include a code and a message indicating whether the comment was successfully added.
Input Fields: Input Fields
Output Fields: Output Fields

Add comment to a journal

ID: post_add_comment_to_journal
Operation: write
Entities: comment, journal
Summary: This API allows you to add a comment to a journal in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The request body must include a description of the comment. Upon success, it returns a response code, a message, and details of the comment added, including the comment ID, description, user details, and operation type.
Input Fields: Input Fields
Output Fields: Output Fields

Add comment to purchase order

ID: post_add_comment_to_purchase_order
Operation: write
Entities: purchase order, comment
Summary: This API allows you to add a comment to a specific purchase order in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The request body must include a description of the comment and the expected delivery date of the goods. Upon successful execution, it returns a response with a code, message, and details of the added comment, including the comment ID, purchase order ID, and the user who commented.
Input Fields: Input Fields
Output Fields: Output Fields

Add comment to retainer invoice

ID: post_add_comment_to_retainer_invoice
Operation: write
Entities: comment, retainer invoice
Summary: This API allows you to add a comment to a retainer invoice in Zoho Books. It requires an OAuth token for authentication and the organization ID as a query parameter. The request body can include a description of the comment, an optional payment expected date, and a boolean to indicate if the comment should be visible to clients. The response will include a code and message indicating the success or failure of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Add comment to sales order

ID: post_add_comment_to_sales_order
Operation: write
Entities: comment, organization, sales order
Summary: This API allows you to add a comment to a sales order in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The request body must include a description of the line item. Upon success, it returns a response code, message, and details of the comment added, including the sales order ID, comment ID, description, commenter details, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Add a comment to an existing vendor credit

ID: post_add_comment_to_vendor_credit
Operation: write
Entities: comment, organization, vendor credit
Summary: This API allows you to add a comment to an existing vendor credit in Zoho Books. It requires an OAuth token for authentication and the organization ID as a query parameter. The request body must include a description of the comment. Upon successful execution, it returns a response with a code, message, and details of the comment added, including the comment ID, vendor credit ID, description, the user who commented, and the date of the comment.
Input Fields: Input Fields
Output Fields: Output Fields

Add Comments to Estimate

ID: post_add_comments_to_estimate
Operation: write
Entities: organization, comment, estimate
Summary: This API allows you to add comments to an estimate in Zoho Books. It requires an OAuth token for authentication and the organization ID as a query parameter. The request body must include a description of the line items and a boolean indicating whether to show the comments to clients in the portal. The response will include a code and message indicating the success or failure of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Add receipt to an expense

ID: post_add_receipt_to_expense
Operation: write
Entities: receipt, organization, expense
Summary: This API allows you to attach a receipt to an existing expense in Zoho Books. It requires an OAuth token for authorization. The request must include the expense ID as a path parameter, the organization ID as a query parameter, and the receipt file in the request body. The receipt file can be in various formats such as gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc, and 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 a task

ID: post_add_task
Operation: write
Entities: project, task, customer
Summary: The 'Add a task' API allows users to add a new task to a project in Zoho Books. It requires an OAuth token for authorization and accepts parameters such as task name, description, rate, and budget hours. The task name is mandatory, while other parameters are optional. The API returns a response with a code and message indicating the success of the operation, along with details of the created task, including project ID, task ID, currency ID, customer ID, task name, project name, customer name, billed hours, logged time, and unbilled hours.
Input Fields: Input Fields
Output Fields: Output Fields

Apply credits

ID: post_apply_credits
Operation: write
Entities: payment, invoice, credit note
Summary: The 'Apply credits' API allows users to apply customer credits from credit notes or excess customer payments to an invoice. Multiple credits can be applied at once. The API requires an OAuth token for authorization and expects the invoice ID and organization ID as path parameters. The request body must include arrays of invoice payments and credit notes, each with their respective IDs and the amount to be applied. Upon successful execution, the API returns a response code and message indicating that the credits have been applied to the specified invoice(s).
Input Fields: Input Fields
Output Fields: Output Fields

Apply credits to a bill

ID: post_apply_credits_to_a_bill
Operation: write
Entities: bill, vendor credit
Summary: This API applies vendor credits to existing bills in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The request body must include an array of bills, each with a bill ID and the amount to be applied. The response indicates whether the credits were successfully applied to the specified bills.
Input Fields: Input Fields
Output Fields: Output Fields

Approve a bill

ID: post_approve_a_bill
Operation: write
Entities: bill, authorization, organization
Summary: The 'Approve a bill' API is used to approve a specific bill in the Zoho Books application. It requires an OAuth token for authorization, which must 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. Upon successful approval, the API returns a response with a code of 0 and a message indicating success.
Input Fields: Input Fields
Output Fields: Output Fields

Approve a credit note

ID: post_approve_credit_note
Operation: write
Entities: credit note, organization
Summary: This API approves a credit note in the Zoho Books system. It requires the credit note 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 approval, the API returns a response code and message indicating the credit note has been approved.
Input Fields: Input Fields
Output Fields: Output Fields

Approve an estimate.

ID: post_approve_estimate
Operation: write
Entities: organization, estimate
Summary: This API approves an estimate in the Zoho Books system. It requires an OAuth token for authorization, the estimate ID as a path parameter, 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

Approve an invoice

ID: post_approve_invoice
Operation: write
Entities: invoice, organization
Summary: This API endpoint is used to approve an invoice in the Zoho Books system. It requires an OAuth token for authorization, the invoice ID as a path parameter, and the organization ID as a query parameter. The request is made using the POST method. Upon successful approval, the API returns a response code and a message indicating that the invoice has been approved.
Input Fields: Input Fields
Output Fields: Output Fields

Approve a purchase order

ID: post_approve_purchase_order
Operation: write
Entities: purchase order
Summary: This API approves a specified purchase order in Zoho Books. It requires an OAuth token for authorization, the purchase order ID as a path parameter, 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

Approve a retainer invoice.

ID: post_approve_retainer_invoice
Operation: write
Entities: organization, retainer invoice
Summary: This API endpoint is used to approve a retainer invoice 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 for which the retainer invoice is being approved. The API responds with a code and message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Approve a sales order.

ID: post_approve_sales_order
Operation: write
Entities: organization, sales order
Summary: This API approves a sales order in Zoho Books. It requires an OAuth token for authorization, the sales order ID as a path parameter, and the organization ID as a query parameter. The API sends a POST request to the specified endpoint and returns a response indicating whether the sales order was successfully approved. The response includes a code and a message.
Input Fields: Input Fields
Output Fields: Output Fields

Approve a Vendor credit

ID: post_approve_vendor_credit
Operation: write
Entities: vendor credit, authorization, organization
Summary: The 'Approve a Vendor credit' API is used to approve a vendor credit in the Zoho Books application. This API 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 successful approval, 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

Assign users to a project

ID: post_assign_users_to_project
Operation: write
Entities: project, user
Summary: This API assigns users to a specified project in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The request body must include an array of users with their user IDs and a cost rate. The response returns a code and message indicating success, along with details of the users added to the project.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk invoice reminder

ID: post_bulk_invoice_reminder
Operation: write
Entities: reminder, invoice, customer
Summary: The Bulk invoice reminder API allows users to send reminder emails to customers about unpaid invoices that are in open or overdue status. The API can handle up to 10 invoices at once. It requires an OAuth token for authorization and the organization ID and invoice IDs as query parameters. The response includes a success message, the count of successfully sent reminders, and any errors encountered.
Input Fields: Input Fields
Output Fields: Output Fields

Cancel a purchase order

ID: post_cancel_purchase_order
Operation: write
Entities: purchase order, organization
Summary: This API marks a purchase order as cancelled in the Zoho Books system. It requires an OAuth token for authorization, the purchase order ID as a path parameter, and the organization ID as a query parameter. The API responds with a code and message indicating the success of the cancellation.
Input Fields: Input Fields
Output Fields: Output Fields

Cancel write off

ID: post_cancel_write_off
Operation: write
Entities: invoice, write off, organization
Summary: The 'Cancel write off' API cancels the write off amount of a specified invoice in Zoho Books. It requires an OAuth token for authorization, the invoice ID as a path parameter, and the organization ID as a query parameter. The API is accessed via a POST request to the specified URL. Upon successful cancellation, it returns a response code and a message indicating that the write off has been cancelled.
Input Fields: Input Fields
Output Fields: Output Fields

Categorize as credit note refunds

ID: post_categorize_as_credit_note_refunds
Operation: write
Entities: credit note, refund, transaction
Summary: This API categorizes an uncategorized transaction as a refund from a credit note in Zoho Books. It requires the credit note ID, transaction date, and optionally the refund mode, reference number, amount, exchange rate, from account ID, and a description. The request must include an OAuth token for authorization. The response indicates whether the transaction was successfully categorized.
Input Fields: Input Fields
Output Fields: Output Fields

Categorize as customer payment

ID: post_categorize_as_customer_payment
Operation: write
Entities: invoice, transaction, customer
Summary: The 'Categorize as customer payment' API allows you to categorize an uncategorized transaction as a Customer Payment in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as customer_id, retainerinvoice_id, invoices, payment_mode, description, reference_number, exchange_rate, amount, bank_charges, account_id, custom_fields, documents, date, template_id, and contact_persons. The API returns a response with a code and message indicating the success or failure of the categorization.
Input Fields: Input Fields
Output Fields: Output Fields

Categorize as Customer Payment Refund

ID: post_categorize_as_customer_payment_refund
Operation: write
Entities: transaction, account, payment refund
Summary: The 'Categorize as Customer Payment Refund' API is used to categorize bank transactions as payment refunds in Zoho Books. It requires an OAuth token for authorization and accepts a POST request with a JSON body containing details such as transaction date, refund mode, reference number, amount, exchange rate, from account ID, and a description. The organization ID must be specified as a query parameter. Upon successful categorization, the API returns a response with a code and message indicating the transaction(s) have been categorized.
Input Fields: Input Fields
Output Fields: Output Fields

Categorize as expense

ID: post_categorize_as_expense
Operation: write
Entities: project, transaction, expense
Summary: The 'Categorize as expense' API allows you to categorize an uncategorized transaction as an expense in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as account_id, paid_through_account_id, date, amount, and more. The API supports optional parameters for tax exemption, mileage, and custom fields. The response includes a code and message indicating the success of the categorization.
Input Fields: Input Fields
Output Fields: Output Fields

Categorize as vendor credit refunds

ID: post_categorize_as_vendor_credit_refunds
Operation: write
Entities: vendor credit, transaction, refund
Summary: This API categorizes an uncategorized transaction as a refund from a vendor credit. It requires the vendor credit ID, transaction date, and optionally the refund mode, reference number, amount, exchange rate, account ID, and a description. The request must include an OAuth token in the headers for authorization. The response returns a code and message indicating the success of the categorization.
Input Fields: Input Fields
Output Fields: Output Fields

Categorize as Vendor Payment Refund

ID: post_categorize_as_vendor_payment_refund
Operation: write
Entities: bank transaction, vendor payment, refund
Summary: This API categorizes bank transactions as Vendor Payment Refund in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as vendorpayment_id, date, refund_mode, reference_number, amount, exchange_rate, to_account_id, and description. The organization_id is a required query parameter. The response includes a code and message indicating the result of the categorization.
Input Fields: Input Fields
Output Fields: Output Fields

Categorize an uncategorized transaction

ID: post_categorize_uncategorized_transaction
Operation: write
Entities: tag, transaction, account
Summary: This API categorizes an uncategorized transaction by creating a new transaction in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as from_account_id, to_account_id, transaction_type, amount, date, and more. The transaction_type is mandatory and specifies the type of transaction being categorized. The API returns a response code and message indicating the success or failure of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Categorize a vendor payment

ID: post_categorize_vendor_payment
Operation: write
Entities: bill, vendor, payment
Summary: This API categorizes an uncategorized transaction as a Vendor Payment in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as vendor_id, bills, payment_mode, description, date, reference_number, exchange_rate, paid_through_account_id, amount, custom_fields, is_paid_via_print_check, and check_details. The response returns a code and message indicating the success of the categorization.
Input Fields: Input Fields
Output Fields: Output Fields

Clone project

ID: post_clone_project
Operation: write
Entities: project, task, user
Summary: The Clone project API allows users to clone an existing project in Zoho Books. It requires an OAuth token for authorization and accepts a project name and an optional description as input. The API endpoint is 'https://www.zohoapis.com/books/v3/projects/460000000044019/clone' with a required query parameter 'organization_id'. The response includes a success message and details of the cloned project, such as project ID, name, customer details, status, billing type, and associated tasks and users.
Input Fields: Input Fields
Output Fields: Output Fields

Post comment

ID: post_comment
Operation: write
Entities: project, comment
Summary: The 'Post comment' API allows users to add comments to a specific project in Zoho Books. It requires an OAuth token for authorization and the content type must be 'application/json'. The request body must include a 'description' of the project, which is a required field with a maximum length of 500 characters. The API responds with a code and message indicating the success of the operation, along with a list of comments that were added, including details such as project ID, comment ID, description, commenter details, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Convert Credit Note to Draft

ID: post_convert_credit_note_to_draft
Operation: write
Entities: status, credit note, organization
Summary: This API converts a voided credit note to a draft status in Zoho Books. It requires an OAuth token for authorization, the credit note ID as a path parameter, 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

Convert Credit Note to Open

ID: post_convert_credit_note_to_open
Operation: write
Entities: status, credit note, organization
Summary: This API endpoint is used to convert a credit note from Draft status to Open status in Zoho Books. It requires an OAuth token for authorization, the credit note ID as a path parameter, and the organization ID as a query parameter. The request does not require a body. Upon successful execution, it returns a response code and a message indicating that the status of the credit note has been changed to open.
Input Fields: Input Fields
Output Fields: Output Fields

Convert Vendor Credit Status to Open

ID: post_convert_vendor_credit_status_to_open
Operation: write
Entities: status, vendor credit, organization
Summary: This API changes the status of an existing vendor credit to 'open'. It requires an OAuth token for authorization, the vendor credit ID as a path parameter, 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

Create a bill

ID: post_create_a_bill
Operation: write
Entities: bill, line item, vendor
Summary: The 'Create a bill' API allows users to create a bill received from a vendor in the Zoho Books system. It requires an OAuth token for authorization and accepts various parameters such as vendor ID, currency ID, VAT treatment, bill number, and more. The API supports attaching files and specifying details like source and destination of supply, GST treatment, and line items. The response includes details of the created bill, including its ID, vendor information, line items, taxes, and payment details.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Contact

ID: post_create_a_contact
Operation: write
Entities: address, contact, template
Summary: The 'Create a Contact' API allows users to create a new contact in the Zoho Books system with detailed information. The API requires an OAuth token for authorization and accepts a variety of parameters in the request body, including contact name, company name, website, language code, contact type, and more. The request can also include detailed billing and shipping addresses, contact persons, default templates, custom fields, and tax-related information. The response returns a success message along with the details of the created contact, including contact ID, name, company name, transaction status, and other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Currency

ID: post_create_a_currency
Operation: write
Entities: currency
Summary: The 'Create a Currency' API allows users to create a new currency for transactions in Zoho Books. It requires an OAuth token for authorization and accepts a unique currency code, symbol, price precision, and format as input. The API responds with a success message and details of the newly created currency, including its ID, code, name, symbol, precision, format, and whether it is the base currency.
Input Fields: Input Fields
Output Fields: Output Fields

Create a journal

ID: post_create_a_journal
Operation: write
Entities: tax, line item, journal
Summary: The 'Create a journal' API allows users to create a journal entry in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as journal_date, reference_number, notes, journal_type, and more. The request body must include details like line_items, which contain account_id, customer_id, amount, and debit_or_credit. The API returns a response with the created journal's details, including journal_id, entry_number, currency information, line items, and custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

Create a payment

ID: post_create_a_payment
Operation: write
Entities: payment, invoice, customer
Summary: The 'Create a payment' API allows you to create a new payment in the Zoho Books system. It requires the customer ID, payment mode, amount, date, and a list of invoices with their respective amounts applied. Optional parameters include reference number, description, exchange rate, payment form, bank charges, custom fields, tax amount withheld, account ID, and contact persons. The API returns a response with the payment details including payment ID, mode, amount, status, customer details, associated invoices, and any custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

Create a project

ID: post_create_a_project
Operation: write
Entities: project, task, user
Summary: The 'Create a project' API allows users to create a new project in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as project name, customer ID, billing type, and user ID. Optional parameters include currency ID, project description, rate, budget type, and more. The API also supports adding tasks and users to the project. Upon successful creation, it returns a response with the project details including project ID, name, customer details, billing information, and associated tasks and users.
Input Fields: Input Fields
Output Fields: Output Fields

Create a purchase order

ID: post_create_a_purchase_order
Operation: write
Entities: purchase order, line item, vendor
Summary: This API allows you to create a purchase order for a vendor in Zoho Books. It requires an OAuth token for authorization. The request can include various parameters such as vendor ID, currency ID, contact persons, purchase order number, GST treatment, tax treatment, and more. The response includes details of the created purchase order, such as purchase order ID, documents, VAT treatment, GST number, source and destination of supply, line items, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Create a recurring bill

ID: post_create_a_recurring_bill
Operation: write
Entities: line item, recurring bill, vendor
Summary: The 'Create a recurring bill' API allows users to create a recurring bill in the Zoho Books system. It requires an OAuth token for authorization and accepts various parameters such as vendor_id, currency_id, recurrence_name, start_date, and more. The API supports different tax treatments and line items, allowing for detailed bill creation. The response includes details of the created recurring bill, including its ID, vendor details, status, and line items.
Input Fields: Input Fields
Output Fields: Output Fields

Create a recurring expense

ID: post_create_a_recurring_expense
Operation: write
Entities: custom field, recurring expense, line item
Summary: The 'Create a recurring expense' API allows users to create a recurring expense in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as account_id, recurrence_name, start_date, and recurrence_frequency. Optional parameters include end_date, gst_no, source_of_supply, and destination_of_supply. The API also supports line items with attributes like line_item_id, account_id, description, and amount. The response includes details of the created recurring expense, such as account_id, recurrence_name, start_date, and various tax-related information.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Recurring Invoice

ID: post_create_a_recurring_invoice
Operation: write
Entities: recurring invoice, line item, customer
Summary: This API is used to create a new recurring invoice in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as recurrence_name, customer_id, and recurrence_frequency as required fields. Optional fields include reference_number, currency_id, contact_persons, and more. The request body can include detailed information about line items, billing and shipping addresses, and custom fields. The response includes a code, message, and details of the created recurring invoice, including its ID, customer name, and line items.
Input Fields: Input Fields
Output Fields: Output Fields

Create a rule

ID: post_create_a_rule
Operation: write
Entities: rule, bank account, credit card account
Summary: The 'Create a rule' API allows users to create a rule and apply it on deposit/withdrawal for bank accounts and on refund/charges for credit card accounts. The API requires an OAuth token for authorization and accepts various parameters such as rule_name, target_account_id, apply_to, criteria_type, and criterion among others. The response includes details of the created rule such as rule_id, rule_name, apply_to, criteria_type, and other related information.
Input Fields: Input Fields
Output Fields: Output Fields

Create a tax

ID: post_create_a_tax
Operation: write
Entities: item, tax, tax authority
Summary: The 'Create a tax' API allows users to create a tax that can be associated with an item in Zoho Books. The API requires an OAuth token for authorization and accepts various parameters such as tax name, percentage, type, and other optional parameters specific to different countries. The request is made to the specified URL with a POST method, and the response includes a code, message, and details of the created tax.
Input Fields: Input Fields
Output Fields: Output Fields

Create a tax group

ID: post_create_a_tax_group
Operation: write
Entities: tax, tax authority, tax group
Summary: The 'Create a tax group' API allows users to create a new tax group by associating multiple taxes. It requires an OAuth token for authorization and the organization ID as a query parameter. The request body must include the name of the tax group and a comma-separated list of tax IDs to be associated with the group. Upon successful creation, the API returns the details of the created tax group, including its ID, name, percentage, and associated taxes.
Input Fields: Input Fields
Output Fields: Output Fields

Create a user

ID: post_create_a_user
Operation: write
Entities: organization, user
Summary: The 'Create a user' API allows you to create a new user for your organization in Zoho Books. It requires an OAuth token for authorization and accepts a POST request to the specified URL. The request must include the user's name and email as required fields in the body, while role_id and cost_rate are optional. The organization_id must be specified as a query parameter. The response returns a code and a message indicating the success or failure of the user creation.
Input Fields: Input Fields
Output Fields: Output Fields

Create an account

ID: post_create_an_account
Operation: write
Entities: custom field, currency, account
Summary: The 'Create an account' API allows users to create a new account in the Zoho Books system with specified details such as account name, code, type, currency, and description. The API requires an OAuth token for authorization and accepts various parameters in the request body, including optional custom fields and parent account ID. The response includes the details of the created account, such as account ID, name, type, currency, and timestamps for creation and last modification.
Input Fields: Input Fields
Output Fields: Output Fields

Create an employee

ID: post_create_an_employee
Operation: write
Entities: organization, employee, expense
Summary: This API endpoint is used to create a new employee for an expense in the Zoho Books application. It requires an OAuth token for authorization and the organization ID as a query parameter. The request body must include the name and email of the employee to be created. Upon successful creation, the API returns a response with a code indicating success, a message, and the details of the created employee including their ID, name, and email.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Estimate

ID: post_create_an_estimate
Operation: write
Entities: line item, estimate, customer
Summary: The 'Create an Estimate' API allows users to create an estimate for a customer in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as customer_id, currency_id, contact_persons, template_id, and more. The API supports optional query parameters like 'send' and 'ignore_auto_number_generation'. The request body includes detailed information about the estimate, including line items, discounts, taxes, and custom fields. Upon successful creation, the API returns a response with the estimate details, including estimate_id, estimate_number, customer information, line items, and total amounts. This API is useful for businesses to generate estimates for their customers efficiently.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Expense

ID: post_create_an_expense
Operation: write
Entities: tax, account, expense
Summary: The 'Create an Expense' API allows users to create billable or non-billable expenses in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as account_id, date, amount, and optional parameters like tax_id, source_of_supply, and destination_of_supply. The API supports additional details like line items, taxes, and custom fields. The response includes details of the recorded expense, such as expense_id, transaction_type, gst_no, and tax_amount, along with other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Create an invoice

ID: post_create_an_invoice
Operation: write
Entities: invoice, line item, customer
Summary: The 'Create an invoice' API allows users to create an invoice for a customer in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as customer_id, currency_id, contact_persons, invoice_number, and more. The API supports optional query parameters like 'send' and 'ignore_auto_number_generation'. The request body can include detailed invoice information such as line items, payment options, custom fields, and addresses. Upon successful creation, the API returns a response with the invoice details, including invoice_id, invoice_number, customer information, line items, and payment options.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Item

ID: post_create_an_item
Operation: write
Entities: item, tax, account
Summary: The 'Create an Item' API allows users to create a new item in the Zoho Books system. It requires an OAuth token for authorization and accepts various parameters such as name, rate, description, tax details, SKU, product type, and more. The API supports additional fields for specific regions like India and Mexico, and integrations like Avalara. The response includes a confirmation message and details of the created item, including its ID, name, status, rate, and associated tax and custom field information.
Input Fields: Input Fields
Output Fields: Output Fields

Create a bank account

ID: post_create_bank_account
Operation: write
Entities: currency, bank account, paypal account
Summary: This API allows you to create a bank account or a credit card account for your organization in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as account name, type, number, currency details, and bank information. The response includes details of the created account, such as account ID, name, type, balance, and other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Create a contact person

ID: post_create_contact_person
Operation: write
Entities: contact person, contact
Summary: The 'Create a contact person' API allows you to create a new contact person for a contact in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as contact_id, salutation, first_name, last_name, email, phone, mobile, skype, designation, department, and enable_portal. The first_name is a required field. The API returns a response with a code and message indicating the success of the operation, along with details of the created contact person including contact_id, contact_person_id, salutation, first_name, last_name, email, phone, mobile, is_primary_contact, skype, designation, department, and is_added_in_portal.
Input Fields: Input Fields
Output Fields: Output Fields

Create a credit note

ID: post_create_credit_note
Operation: write
Entities: line item, credit note, customer
Summary: This API endpoint allows you to create a credit note in Zoho Books. It requires an OAuth token for authorization. The request must include the customer ID, date, line items, and a unique credit note number. Optional parameters include currency ID, contact persons, exchange rate, and various tax-related fields. The response includes details of the created credit note, such as its ID, number, date, status, customer information, line items, and associated invoices and taxes.
Input Fields: Input Fields
Output Fields: Output Fields

Create Custom Modules

ID: post_create_custom_modules
Operation: write
Entities: field, module, record
Summary: The 'Create Custom Modules' API allows users to create a custom module in Zoho Books. It requires an OAuth token for authorization and accepts a JSON body with 'record_name' and 'cf_debt_amount' as parameters. The API responds with a success message and details of the created module record, including its ID, API name, timestamps, and formatted values.
Input Fields: Input Fields
Output Fields: Output Fields

Create an exchange rate

ID: post_create_exchange_rate
Operation: write
Entities: exchange rate, currency
Summary: This API creates an exchange rate for a specified currency. It requires an OAuth token for authorization and the content type must be 'application/json'. The request must include the 'effective_date' and 'rate' in the body, which specify the date the exchange rate is applicable and the rate of exchange with respect to the base currency, respectively. The organization ID must be provided as a query parameter. Upon success, the API returns a response code, a message indicating the exchange rate has been added, and the exchange rate value.
Input Fields: Input Fields
Output Fields: Output Fields

Create an instant invoice

ID: post_create_instant_invoice
Operation: write
Entities: item, invoice, sales order
Summary: The 'Create an instant invoice' API allows users to create an invoice for confirmed sales orders. It requires the sales order ID and organization ID as input in the request body. The request must include an authorization header with a valid OAuth token. The API responds with a detailed invoice object, including invoice ID, number, status, customer details, line items, taxes, and payment options. The response also includes the invoice URL for secure payment. This API is useful for automating the invoicing process for sales orders in Zoho Books.
Input Fields: Input Fields
Output Fields: Output Fields

Create opening balance

ID: post_create_opening_balance
Operation: write
Entities: account, opening balance
Summary: The 'Create opening balance' API allows users to create an opening balance for specified accounts on a given date. The API requires an OAuth token for authorization and accepts a JSON body containing the date and a list of accounts with their respective details such as account ID, debit or credit type, exchange rate, currency ID, and amount. The response includes a success code, message, and details of the created opening balance, including the opening balance ID, date, accounts involved, and the total amount.
Input Fields: Input Fields
Output Fields: Output Fields

Create a sales order

ID: post_create_sales_order
Operation: write
Entities: item, sales order, customer
Summary: This API creates a sales order for a customer in Zoho Books. It requires the customer ID as a mandatory field and allows various optional fields such as currency ID, contact persons, date, shipment date, custom fields, place of supply, salesperson ID, merchant ID, GST treatment, GST number, and line items among others. The API also supports query parameters to control auto number generation and email sending capabilities. The response includes details of the created sales order, including sales order ID, customer details, line items, and financial information.
Input Fields: Input Fields
Output Fields: Output Fields

Create a tax authority [US and CA Edition only]

ID: post_create_tax_authority_us_ca_edition
Operation: write
Entities: tax authority
Summary: This API is used to create a tax authority in the US and CA editions of Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The request body must include the name of the tax authority and can optionally include a description, registration number, and registration number label (for Canada only). The response includes a code and message indicating success or failure, and details of the created tax authority.
Input Fields: Input Fields
Output Fields: Output Fields

Create a tax exemption [US Edition only]

ID: post_create_tax_exemption_us_edition
Operation: write
Entities: response, tax exemption, request
Summary: This API creates a tax exemption for the US edition in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The request body must include the tax exemption code and type, with an optional description. The response includes a success code and message, along with details of the created tax exemption.
Input Fields: Input Fields
Output Fields: Output Fields

Create a transaction for an account

ID: post_create_transaction_for_account
Operation: write
Entities: bank, transaction, account
Summary: This API allows you to create a bank transaction for an account based on the allowed transaction types. It requires an OAuth token for authorization. The request includes various parameters such as from_account_id, to_account_id, transaction_type, amount, payment_mode, exchange_rate, date, customer_id, reference_number, description, currency_id, tax_id, is_inclusive_tax, tags, from_account_tags, to_account_tags, documents, bank_charges, user_id, tax_authority_id, tax_exemption_id, and custom_fields. The response returns a code, message, and details of the bank transaction including transaction_id, from_account_id, from_account_name, to_account_id, to_account_name, transaction_type, currency_id, currency_code, payment_mode, exchange_rate, date, customer_id, customer_name, vendor_id, vendor_name, reference_number, description, bank_charges, tax_id, documents, is_inclusive_tax, tax_name, tax_percentage, tax_amount, sub_total, tax_authority_id, tax_authority_name, tax_exemption_id, tax_exemption_code, total, bcy_total, amount, vat_treatment, product_type, acquisition_vat_id, acquisition_vat_name, acquisition_vat_percentage, acquisition_vat_amount, reverse_charge_vat_id, reverse_charge_vat_name, reverse_charge_vat_percentage, reverse_charge_vat_amount, filed_in_vat_return_id, filed_in_vat_return_name, filed_in_vat_return_type, imported_transactions, tags, and line_items.
Input Fields: Input Fields
Output Fields: Output Fields

Create a vendor payment

ID: post_create_vendor_payment
Operation: write
Entities: bill, vendor, payment
Summary: The 'Create a vendor payment' API allows users to create a payment to a vendor and apply it to bills either partially or fully. The API requires an OAuth token for authorization and accepts various parameters such as vendor_id, bills, date, exchange_rate, amount, and more. The request body must include the total amount of the vendor payment. The response includes details about the payment, such as the amount, balance, billing address, bills, check details, comments, and more. This API is useful for managing vendor payments and ensuring accurate financial records.
Input Fields: Input Fields
Output Fields: Output Fields

Credit to an invoice

ID: post_credit_to_an_invoice
Operation: write
Entities: invoice, credit note, organization
Summary: This API applies a credit note to existing invoices in Zoho Books. It requires an OAuth token for authorization and the content type must be set to application/json. The request body must include a list of invoices with their respective invoice IDs and the amount to be applied from the credit note. The API responds with a code and message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Deactivate account

ID: post_deactivate_account
Operation: write
Entities: organization, bank account, account
Summary: This API is used to deactivate a bank account in Zoho Books. 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 marks the specified bank account as inactive. The response includes a code and a message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Disable payment reminder

ID: post_disable_payment_reminder
Operation: write
Entities: payment reminder, invoice, organization
Summary: The 'Disable payment reminder' API is used to disable automated payment reminders for a specific invoice in Zoho Books. The API requires an OAuth token for authentication, which should be included in the 'Authorization' header. The 'invoice_id' is a path parameter that specifies the invoice for which the reminder is to be disabled. The 'organization_id' is a query parameter that specifies the organization to which the invoice belongs. The API does not require a request body. Upon successful execution, the API returns a response with a code and a message indicating that the reminders have been stopped.
Input Fields: Input Fields
Output Fields: Output Fields

Disable Payment Reminders

ID: post_disable_payment_reminders
Operation: write
Entities: payment reminder, organization, contact
Summary: The Disable Payment Reminders API allows users to disable automated payment reminders for a specific contact in Zoho Books. The API requires an OAuth token for authorization, a contact ID as a path parameter, and an organization ID as a query parameter. The request is made using the POST method. Upon successful execution, the API returns a response code and a message indicating that all reminders associated with the specified contact have been stopped.
Input Fields: Input Fields
Output Fields: Output Fields

Email a credit note

ID: post_email_a_credit_note
Operation: write
Entities: credit note, email, customer
Summary: The 'Email a credit note' API allows users to send a credit note via email to specified recipients. The API requires the credit note ID and organization ID as path and query parameters, respectively. The request must include an authorization token in the headers. The body of the request should contain the email addresses of the recipients (to_mail_ids), optional CC recipients (cc_mail_ids), the subject, and the body of the email. The response will indicate whether the email was successfully sent.
Input Fields: Input Fields
Output Fields: Output Fields

Email an estimate

ID: post_email_an_estimate
Operation: write
Entities: organization, estimate, email
Summary: The 'Email an estimate' API allows users to send an estimate to a customer via email. The API requires an OAuth token for authorization and supports sending emails from the organization's email address. The request can include recipient email addresses, CC email addresses, a subject, and a body for the email. Attachments can also be included as query parameters. The response indicates whether the email was successfully sent.
Input Fields: Input Fields
Output Fields: Output Fields

Email Contact

ID: post_email_contact
Operation: write
Entities: attachment, contact, email
Summary: The Email Contact API allows you to send an email to a specified contact. It requires an OAuth token for authorization and accepts email details such as recipient addresses, subject, body, and optional attachments. The API also supports sending a customer statement PDF with the email. The response indicates whether the email was successfully sent.
Input Fields: Input Fields
Output Fields: Output Fields

Email an invoice

ID: post_email_invoice
Operation: write
Entities: invoice, email, customer
Summary: The 'Email an invoice' API allows users to send an invoice to a customer via email. The API requires an OAuth token for authorization and accepts various parameters including the recipient's email addresses, subject, and body of the email. The email can be sent from the organization's email address if specified. Optional query parameters allow for sending customer statements and invoice attachments. The API responds with a code and message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Email invoices

ID: post_email_invoices
Operation: write
Entities: invoice, contact
Summary: The Email invoices API allows you to send invoices to your customers via email. You can send a maximum of 10 invoices at once. The API requires an OAuth token for authorization and expects the organization ID and a comma-separated list of invoice IDs as query parameters. The request body should include an array of contacts and a contact ID for whom the email or snail mail has to be sent. 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

Email multiple estimates

ID: post_email_multiple_estimates
Operation: write
Entities: estimate, customer
Summary: The 'Email multiple estimates' API allows users to send up to 10 estimates to their customers via email. 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 emailed. 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

Email a purchase order

ID: post_email_purchase_order
Operation: write
Entities: purchase order, vendor, email
Summary: This API allows you to email a purchase order to a vendor. The request can include various parameters such as sending from the organization's email, specifying the from address ID, and listing the recipient email addresses. The body of the email and any documents to be attached can also be specified. The API requires an OAuth token for authorization and supports sending attachments with the email. The response indicates whether the email was successfully sent.
Input Fields: Input Fields
Output Fields: Output Fields

Email a retainer invoice

ID: post_email_retainer_invoice
Operation: write
Entities: retainer invoice, email, customer
Summary: This API allows you to email a retainer invoice to a customer. The request can include optional JSON input to customize the email content, such as the subject and body of the email, as well as the recipients' email addresses. The API requires an OAuth token for authorization. The response indicates whether the email was successfully sent.
Input Fields: Input Fields
Output Fields: Output Fields

Email a sales order

ID: post_email_sales_order
Operation: write
Entities: sales order, email, customer
Summary: This API emails a sales order to the customer. It requires the sales order ID and organization ID as path and query parameters respectively. The request body can include details such as the from address, recipient email addresses, subject, and body of the email. The email can also include documents and invoice ID. The response indicates whether the sales order was successfully sent.
Input Fields: Input Fields
Output Fields: Output Fields

Email Statement to Contact

ID: post_email_statement_to_contact
Operation: write
Entities: email statement, organization, contact
Summary: The Email Statement API sends an email statement to a specified contact. If the JSONString is not provided, the email will be sent with default content. The API requires an OAuth token for authorization and accepts various parameters including the recipient email addresses, subject, and body of the email. Optional query parameters allow specifying a date range for the statement. The response indicates whether the email was successfully sent.
Input Fields: Input Fields
Output Fields: Output Fields

Enable payment reminder

ID: post_enable_payment_reminder
Operation: write
Entities: payment reminder, invoice, organization
Summary: The 'Enable payment reminder' API allows users to enable automated payment reminders for a specific invoice in Zoho Books. The API requires an OAuth token for authorization, the invoice ID as a path parameter, and the organization ID as a query parameter. The request is made using the POST method. Upon successful execution, the API returns a response code and a message indicating that the reminders have been enabled.
Input Fields: Input Fields
Output Fields: Output Fields

Enable Payment Reminders

ID: post_enable_payment_reminders
Operation: write
Entities: payment reminder, organization, contact
Summary: The 'Enable Payment Reminders' API enables automated payment reminders for a specified contact in Zoho Books. It requires an OAuth token for authorization, a contact ID as a path parameter, and an organization ID as a query parameter. The API does not require a request body. Upon successful execution, it returns a response code and a message indicating that all reminders associated with the contact have been enabled.
Input Fields: Input Fields
Output Fields: Output Fields

Enable Portal Access

ID: post_enable_portal_access
Operation: write
Entities: portal access, organization, contact
Summary: The 'Enable Portal Access' API allows enabling portal access for a contact in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The request body must include an array of contact persons with their IDs. Upon successful execution, it returns a response code and a message indicating that the client portal preferences have been updated.
Input Fields: Input Fields
Output Fields: Output Fields

Exclude a transaction

ID: post_exclude_transaction
Operation: write
Entities: transaction, bank account, credit card account
Summary: This API is used to exclude a transaction from a bank or credit card account in Zoho Books. It requires an OAuth token for authorization and the transaction ID as a path parameter. The organization ID must be provided as a query parameter. The API responds with a code and message indicating whether the transaction was successfully excluded.
Input Fields: Input Fields
Output Fields: Output Fields

Import a Bank/Credit Card Statement

ID: post_import_bank_credit_card_statement
Operation: write
Entities: statement, transaction, bank account
Summary: This API allows users to import their bank or credit card statements into their account. The request requires the account ID of the bank or credit card, and a list of transactions with details such as transaction ID, date, debit or credit indicator, amount, payee, description, and reference number. The API responds with a code and message indicating the success of the import operation.
Input Fields: Input Fields
Output Fields: Output Fields

Import a customer using the CRM account ID

ID: post_import_customer_crm_account_id
Operation: write
Entities: contact, account, customer
Summary: This API imports a customer from Zoho CRM into Zoho Books using the CRM account ID. It requires Zoho Books to be integrated with Zoho CRM using Accounts and Contacts sync or Accounts only sync. The API requires an OAuth token for authorization and the organization ID as a query parameter. Upon successful import, it returns a response with a code, message, and the contact ID of the imported customer.
Input Fields: Input Fields
Output Fields: Output Fields

Import a customer using CRM contact ID

ID: post_import_customer_using_crm_contact_id
Operation: write
Entities: CRM, contact, customer
Summary: This API imports a customer into Zoho Books using a CRM contact ID. It requires Zoho Books to be integrated with Zoho CRM using Contacts only sync. The request must include an OAuth token in the Authorization header and the organization ID as a query parameter. The response returns a success message and the contact ID of the imported customer.
Input Fields: Input Fields
Output Fields: Output Fields

Import a vendor using the CRM vendor ID

ID: post_import_vendor_using_crm_vendor_id
Operation: write
Entities: vendor, organization, crm
Summary: This API imports a vendor from Zoho CRM into Zoho Books using the CRM vendor ID. It requires the Zoho Books and Zoho CRM to be integrated with Vendor only sync. The request must include an OAuth token in the Authorization header and the organization_id as a query parameter. The response includes a code and message indicating success or failure, and the contact_id of the imported vendor in Zoho Books.
Input Fields: Input Fields
Output Fields: Output Fields

Inactivate a project

ID: post_inactivate_a_project
Operation: write
Entities: project, organization
Summary: This API is used to mark a project as inactive 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 API does not require a request body. Upon successful execution, it returns a response code and message indicating that the project has been marked as inactive.
Input Fields: Input Fields
Output Fields: Output Fields

Invite a user

ID: post_invite_user
Operation: write
Entities: organization, user
Summary: The 'Invite a user' API sends an invitation email to a specified user. It requires an OAuth token for authorization, the user ID of the person to be invited, and the organization ID as query parameters. The API does not require a request body. Upon successful execution, it returns a response code and a message indicating that the invitation has been sent.
Input Fields: Input Fields
Output Fields: Output Fields

Invite User to Project

ID: post_invite_user_to_project
Operation: write
Entities: project, user
Summary: This API endpoint is used to invite a user to a project in Zoho Books. It requires the user's name, email, and optionally their role, rate, budget hours, and cost rate. The request must include an OAuth token for authorization. The response includes a code and message indicating the success of the operation, along with details of the users added.
Input Fields: Input Fields
Output Fields: Output Fields

Log time entries

ID: post_log_time_entries
Operation: write
Entities: project, time entry, task
Summary: The 'Log time entries' API allows users to log time entries for specific tasks within a project. It requires the project ID, task ID, user ID, and log date as mandatory fields. Optional fields include log time, begin and end times, billable status, notes, start timer, and cost rate. The API returns a response indicating the success of the operation, along with details of the time entry such as time entry ID, project and task details, user information, log times, billing status, and creation time.
Input Fields: Input Fields
Output Fields: Output Fields

Mark a bill as open

ID: post_mark_a_bill_as_open
Operation: write
Entities: bill, status, organization
Summary: This API marks a void bill as open in the Zoho Books system. It requires an OAuth token for authentication, the bill ID as a path parameter, and the organization ID as a query parameter. The API does not require a request body. Upon successful execution, it returns a response code and a message indicating that the status of the bill has been changed to open.
Input Fields: Input Fields
Output Fields: Output Fields

Mark an account as active

ID: post_mark_account_as_active
Operation: write
Entities: status, organization, account
Summary: This API marks a specified account as active in the Zoho Books application. It requires an OAuth token for authorization, the account ID as a path parameter, 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

Mark an account as inactive

ID: post_mark_account_as_inactive
Operation: write
Entities: organization, response, account
Summary: This API marks a specified account as inactive in the Zoho Books system. It requires an OAuth token for authorization, the account ID as a path parameter, 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

Mark as Active

ID: post_mark_as_active
Operation: write
Entities: organization, contact
Summary: The 'Mark as Active' API is used to mark a contact as active in the Zoho Books application. It requires an OAuth token for authorization, which should be included in the request headers. The API endpoint includes a path parameter 'contact_id' to specify the contact to be marked as active, and a query parameter 'organization_id' to specify the organization. The API responds with a code and message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Mark as billed

ID: post_mark_as_billed
Operation: write
Entities: status, purchase order, organization
Summary: The 'Mark as billed' API marks a specified purchase order as billed in the Zoho Books system. It requires an OAuth token for authorization, the purchase order ID as a path parameter, and the organization ID as a query parameter. The request is made using the POST method and does not require a request body. Upon successful execution, the API returns a response code and a message indicating that the purchase order has been marked as billed.
Input Fields: Input Fields
Output Fields: Output Fields

Mark as draft

ID: post_mark_as_draft
Operation: write
Entities: invoice
Summary: The 'Mark as draft' API allows users to change the status of a voided invoice to draft in Zoho Books. This API requires an OAuth token for authorization, which should be included in the request headers. The invoice ID must be specified in the path parameters, and the organization ID must be included as a query parameter. The API does not require a request body. Upon successful execution, the API returns a response code and a message indicating that the status of the invoice has been changed from void to draft.
Input Fields: Input Fields
Output Fields: Output Fields

Mark as Inactive

ID: post_mark_as_inactive
Operation: write
Entities: organization, contact
Summary: The 'Mark as Inactive' API is used to mark a contact as inactive in the Zoho Books application. It requires an OAuth token for authorization, the contact ID of the contact to be marked as inactive, and the organization ID. The API is accessed via a POST request to the specified URL, with the contact ID included in the path and the organization ID as a query parameter. Upon successful execution, the API returns a response code and message indicating that the contact has been marked as inactive.
Input Fields: Input Fields
Output Fields: Output Fields

Mark as primary contact person

ID: post_mark_as_primary_contact_person
Operation: write
Entities: contact person, contact
Summary: This API marks a specified contact person as the primary contact person for a given organization in Zoho Books. It requires an OAuth token for authorization, the contact person's ID as a path parameter, 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

Mark an estimate as accepted

ID: post_mark_estimate_as_accepted
Operation: write
Entities: estimate, customer
Summary: This API marks a sent estimate as accepted if the customer has accepted it. It requires an OAuth token for authorization, the estimate ID as a path parameter, and the organization ID as a query parameter. The API does not require a request body. Upon successful execution, it returns a response code and a message indicating that the estimate status has been changed to Accepted.
Input Fields: Input Fields
Output Fields: Output Fields

Mark an estimate as declined

ID: post_mark_estimate_as_declined
Operation: write
Entities: organization, estimate, customer
Summary: This API marks a sent estimate as declined if the customer has rejected it. It requires an OAuth token for authorization and the unique identifiers for both the estimate and the organization. The request is made using a POST method to the specified URL with the estimate ID in the path and the organization ID as a query parameter. Upon successful execution, it returns a response code and a message indicating that the estimate status has been changed to Declined.
Input Fields: Input Fields
Output Fields: Output Fields

Mark an estimate as sent

ID: post_mark_estimate_as_sent
Operation: write
Entities: status, organization, estimate
Summary: This API marks a draft estimate as sent in the Zoho Books application. It requires an OAuth token for authorization, the estimate ID as a path parameter, and the organization ID as a query parameter. The API does not require a request body. Upon successful execution, it returns a response code and a message indicating that the estimate status has been changed to 'Sent'.
Input Fields: Input Fields
Output Fields: Output Fields

Mark an invoice as sent

ID: post_mark_invoice_as_sent
Operation: write
Entities: status, invoice, organization
Summary: This API marks a draft invoice as sent in the Zoho Books system. It requires an OAuth token for authorization, the invoice ID as a path parameter, and the organization ID as a query parameter. The request does not require a body. Upon successful execution, it returns a response code and message indicating that the invoice status has been changed to 'Sent'.
Input Fields: Input Fields
Output Fields: Output Fields

Mark a journal as published

ID: post_mark_journal_as_published
Operation: write
Entities: status, organization, journal
Summary: This API marks a draft journal as published in the Zoho Books application. It requires an OAuth token for authentication, which should be included in the request headers. The API endpoint requires the journal ID as a path parameter and the organization ID as a query parameter. Upon successful execution, it returns a response with a code and message indicating that the journal has been published.
Input Fields: Input Fields
Output Fields: Output Fields

Mark a purchase order as open

ID: post_mark_purchase_order_as_open
Operation: write
Entities: status, purchase order, organization
Summary: This API marks a draft purchase order as open in the Zoho Books system. It requires an OAuth token for authorization, the purchase order ID as a path parameter, 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

Mark a retainer invoice as sent

ID: post_mark_retainer_invoice_as_sent
Operation: write
Entities: status, organization, retainer invoice
Summary: This API marks a draft retainer invoice as sent in the Zoho Books system. It requires an OAuth token for authorization, the invoice ID as a path parameter, and the organization ID as a query parameter. The request does not require a body. Upon successful execution, it returns a response code and message indicating that the retainer invoice status has been changed to 'Sent'.
Input Fields: Input Fields
Output Fields: Output Fields

Mark a sales order as open

ID: post_mark_sales_order_as_open
Operation: write
Entities: status, organization, sales order
Summary: This API marks a draft sales order as open in the Zoho Books system. It requires an OAuth token for authorization, the sales order ID as a path parameter, and the organization ID as a query parameter. The API does not require a request body. Upon successful execution, it returns a response code and a message indicating that the sales order status has been changed to open.
Input Fields: Input Fields
Output Fields: Output Fields

Mark a sales order as void

ID: post_mark_sales_order_as_void
Operation: write
Entities: status, organization, sales order
Summary: This API marks a sales order as void in the Zoho Books system. It requires an OAuth token for authentication and the organization ID as a query parameter. The request body must include a reason for voiding the sales order, with a maximum length of 500 characters. Upon successful execution, the API returns a response code and a message indicating that the sales order status has been changed to void.
Input Fields: Input Fields
Output Fields: Output Fields

Mark user as active

ID: post_mark_user_as_active
Operation: write
Entities: organization, user
Summary: This API marks an inactive user as active in the Zoho Books system. It requires an OAuth token for authorization, the user ID of the user to be activated, and the organization ID as query parameters. The API responds with a code and message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Mark user as inactive

ID: post_mark_user_as_inactive
Operation: write
Entities: organization, user
Summary: This API marks an active user as inactive in the Zoho Books system. It requires an OAuth token for authorization, the user ID of the user to be marked as inactive, and the organization ID as query parameters. The API responds with a code and message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Match a transaction

ID: post_match_transaction
Operation: write
Entities: organization, transaction, account
Summary: The 'Match a transaction' API allows users to match an uncategorized transaction with an existing transaction in the account. It requires an OAuth token for authorization and the account ID as a query parameter. The request body must include an array of transactions to be matched, each with a transaction ID and type. The API supports various transaction types such as deposit, refund, transfer_fund, and more. Upon successful matching, the API returns a response code and message indicating the transaction has been matched.
Input Fields: Input Fields
Output Fields: Output Fields

Refund Credit Note

ID: post_refund_credit_note
Operation: write
Entities: refund, credit note, account
Summary: The Refund Credit Note API allows users to refund a credit note amount. It requires an OAuth token for authorization and accepts various parameters such as the date of the credit note, refund mode, payment form, reference number, amount, exchange rate, from account ID, and a description. The API returns a response indicating the success or failure of the refund operation, along with details of the refunded credit note.
Input Fields: Input Fields
Output Fields: Output Fields

Refund an excess customer payment

ID: post_refund_excess_customer_payment
Operation: write
Entities: payment, refund, account
Summary: This API refunds the excess amount paid by a customer. It requires the date of payment, the amount to be refunded, and the account from which the refund is made. Optional parameters include the refund mode, reference number, exchange rate, payment form, and a description. The response includes a code and message indicating the success of the operation, along with details of the payment refunds.
Input Fields: Input Fields
Output Fields: Output Fields

Refund an excess vendor payment

ID: post_refund_excess_vendor_payment
Operation: write
Entities: refund, vendor payment, account
Summary: This API refunds the excess amount paid to a vendor. It requires the date of the refund, the amount, and the account to which the refund is made as mandatory fields. Optional fields include the refund mode, reference number, exchange rate, and a description. The API returns a response code and message, along with details of the vendor payment refund, including the refund ID, payment ID, date, mode, reference number, amount, exchange rate, account ID, account name, and description.
Input Fields: Input Fields
Output Fields: Output Fields

Refund a vendor credit

ID: post_refund_vendor_credit
Operation: write
Entities: vendor credit, refund, account
Summary: The 'Refund a vendor credit' API allows users to refund a specified amount for a vendor credit in Zoho Books. It requires an OAuth token for authorization and accepts parameters such as the date of refund, refund mode, reference number, amount, exchange rate, account ID, and description. The API returns a response indicating the success of the operation, along with details of the vendor credit refund, including the refund ID, vendor credit ID, date, refund mode, amount, and associated account details.
Input Fields: Input Fields
Output Fields: Output Fields

Remind Customer

ID: post_remind_customer
Operation: write
Entities: invoice, email, customer
Summary: The 'Remind Customer' API allows you to send an email reminder to customers about unpaid invoices. The reminder is sent only for invoices that are in open or overdue status. The API requires an OAuth token for authorization and accepts various parameters including recipient email addresses, subject, and body of the email. Optional query parameters allow you to send a customer statement PDF and attach files to the email. The response includes a code and message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Restore a transaction

ID: post_restore_transaction
Operation: write
Entities: organization, transaction, account
Summary: The 'Restore a transaction' API allows users to restore an excluded transaction in their Zoho Books account. It requires an OAuth token for authorization and the organization ID as a query parameter. The API is accessed via a POST request to the specified URL. Upon successful execution, it returns a response code and message indicating that the excluded transaction(s) have been restored.
Input Fields: Input Fields
Output Fields: Output Fields

Resume a Recurring Invoice

ID: post_resume_a_recurring_invoice
Operation: write
Entities: invoice, organization, recurring invoice
Summary: This API resumes a stopped recurring invoice in Zoho Books. It requires the unique ID of the recurring invoice 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 response returns a code and message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Resume a recurring Bill

ID: post_resume_recurring_bill
Operation: write
Entities: recurring bill, organization
Summary: This API resumes a stopped recurring bill in Zoho Books. 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 sends a POST request to the specified URL and returns a response indicating whether the recurring bill has been successfully activated.
Input Fields: Input Fields
Output Fields: Output Fields

Resume a recurring Expense

ID: post_resume_recurring_expense
Operation: write
Entities: recurring expense
Summary: This API resumes a stopped recurring expense in Zoho Books. It requires an OAuth token for authorization, the recurring expense ID as a path parameter, and the organization ID as a query parameter. The API sends a POST request to the specified URL and returns a response indicating whether the recurring expense has been successfully activated.
Input Fields: Input Fields
Output Fields: Output Fields

Start timer

ID: post_start_timer
Operation: write
Entities: project, time entry, task
Summary: The 'Start timer' API is used to start tracking time spent on a specific project task in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The API is accessed via a POST request to the specified URL. Upon successful execution, it returns a response with a code and message indicating the timer has been started, along with detailed information about the time entry, including project and task details, user information, log times, and billing status.
Input Fields: Input Fields
Output Fields: Output Fields

Stop a Recurring Invoice

ID: post_stop_a_recurring_invoice
Operation: write
Entities: status, organization, recurring invoice
Summary: This API stops an active recurring invoice in Zoho Books. It requires the unique ID of the recurring invoice 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 response returns a code and message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Stop a recurring bill

ID: post_stop_recurring_bill
Operation: write
Entities: recurring bill, organization
Summary: This API stops an active recurring bill in Zoho Books. It requires an OAuth token for authorization, the ID of the recurring bill to be stopped, and the organization ID as query parameters. The API responds with a code and message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Stop a recurring expense

ID: post_stop_recurring_expense
Operation: write
Entities: recurring expense, organization
Summary: This API stops an active recurring expense in Zoho Books. It requires an OAuth token for authorization, the recurring expense ID as a path parameter, and the organization ID as a query parameter. The API method is POST, and it returns a response code and message indicating the result of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Stop timer

ID: post_stop_timer
Operation: write
Entities: project, time entry, task
Summary: The 'Stop timer' API is used to stop tracking time for a project, such as when taking a break or leaving. It requires an OAuth token for authorization and the organization ID as a query parameter. The API sends a POST request to the specified URL and returns a response indicating the success of the operation. The response includes details about the time entry, such as the time entry ID, project ID, project name, customer ID, customer name, task ID, task name, user ID, user name, log date, begin time, end time, log time, billable status, billed status, and other related information.
Input Fields: Input Fields
Output Fields: Output Fields

Submit a bill for approval

ID: post_submit_bill_for_approval
Operation: write
Entities: bill, approval, organization
Summary: This API endpoint is used to submit a bill for approval 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 request is made using the POST method. Upon successful submission, the API returns a response code and a message indicating that the bill has been submitted for approval.
Input Fields: Input Fields
Output Fields: Output Fields

Submit a credit note for approval

ID: post_submit_credit_note_for_approval
Operation: write
Entities: approval, credit note
Summary: This API endpoint is used to submit a credit note for approval in the Zoho Books application. The request requires an OAuth token for authorization, the credit note ID as a path parameter, and the organization ID as a query parameter. No request body is needed. Upon successful submission, the API returns a response code and a message indicating the credit note has been submitted for approval.
Input Fields: Input Fields
Output Fields: Output Fields

Submit an estimate for approval

ID: post_submit_estimate_for_approval
Operation: write
Entities: organization, estimate
Summary: This API endpoint is used to submit an estimate for approval in the Zoho Books application. The request requires an OAuth token for authorization, the unique identifier of the estimate to be submitted as a path parameter, and the organization ID as a query parameter. The request does not require a body. Upon successful submission, the API returns a response code and a message indicating that the estimate has been successfully submitted for approval.
Input Fields: Input Fields
Output Fields: Output Fields

Submit an invoice for approval

ID: post_submit_invoice_for_approval
Operation: write
Entities: invoice, organization
Summary: This API endpoint is used to submit an invoice for approval in Zoho Books. It requires an OAuth token for authorization, the invoice ID as a path parameter, and the organization ID as a query parameter. The request is made using the POST method. Upon successful submission, the API returns a response code and a message indicating that the invoice has been submitted for approval.
Input Fields: Input Fields
Output Fields: Output Fields

Submit a purchase order for approval

ID: post_submit_purchase_order_for_approval
Operation: write
Entities: purchase order, approval, organization
Summary: This API endpoint is used to submit a purchase order for approval in Zoho Books. It requires an OAuth token for authorization, the purchase order ID as a path parameter, and the organization ID as a query parameter. The request does not require a body. Upon successful submission, it returns a response with a code and message indicating the purchase order has been submitted for approval.
Input Fields: Input Fields
Output Fields: Output Fields

Submit a retainer invoice for approval

ID: post_submit_retainer_invoice_for_approval
Operation: write
Entities: approval, retainer invoice
Summary: This API endpoint is used to submit a retainer invoice for approval in Zoho Books. 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 to specify the organization for which the invoice is being submitted. The API responds with a code and message indicating the success or failure of the submission.
Input Fields: Input Fields
Output Fields: Output Fields

Submit a sales order for approval

ID: post_submit_sales_order_for_approval
Operation: write
Entities: approval, sales order
Summary: This API endpoint is used to submit a sales order for approval in Zoho Books. The request requires an OAuth token for authorization, the sales order ID as a path parameter, and the organization ID as a query parameter. No request body is needed. Upon successful submission, the API returns a response code and a message indicating that the sales order has been successfully submitted for approval.
Input Fields: Input Fields
Output Fields: Output Fields

Submit a Vendor credit for approval

ID: post_submit_vendor_credit_for_approval
Operation: write
Entities: vendor credit, organization
Summary: This API endpoint is used to submit a vendor credit for approval 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. The API does not require a request body. Upon successful submission, it returns a response with a code and a message indicating that the vendor credit has been submitted for approval.
Input Fields: Input Fields
Output Fields: Output Fields

Track a contact for 1099 reporting

ID: post_track_contact_1099_reporting
Operation: write
Entities: organization, contact, track 1099
Summary: This API enables 1099 tracking for a specified contact within an organization. It requires the contact ID and organization ID as path and query parameters, respectively. The request must include an Authorization header with a valid OAuth token. Upon successful execution, the API returns a response code and message indicating that 1099 tracking has been enabled for the contact.
Input Fields: Input Fields
Output Fields: Output Fields

Uncategorize a categorized transaction

ID: post_uncategorize_transaction
Operation: write
Entities: organization, transaction, account
Summary: This API uncategorizes a previously categorized transaction in Zoho Books. It requires the transaction 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 execution, the API returns a response code and a message indicating that the transaction(s) have been uncategorized.
Input Fields: Input Fields
Output Fields: Output Fields

Unmatch a matched transaction

ID: post_unmatch_a_matched_transaction
Operation: write
Entities: transaction, account
Summary: This API allows you to unmatch a previously matched transaction, making it uncategorized. It requires an OAuth token for authorization and the transaction ID as a path parameter. The organization ID must be provided as a query parameter. Upon successful execution, it returns a response code and message indicating that the transaction has been unmatched.
Input Fields: Input Fields
Output Fields: Output Fields

Untrack 1099

ID: post_untrack_1099
Operation: write
Entities: payment, vendor
Summary: The Untrack 1099 API is used to stop tracking payments to a vendor for 1099 reporting in the Zoho Books application. This API is only available for organizations based in the U.S.A. To use this API, you need to provide the OAuth token in the Authorization header. The API requires the contact ID as a path parameter and the organization ID as a query parameter. Upon successful execution, the API returns a response code and message indicating that 1099 tracking has been disabled for the specified contact.
Input Fields: Input Fields
Output Fields: Output Fields

Update a sales order sub status

ID: post_update_sales_order_sub_status
Operation: write
Entities: sub status, organization, sales order
Summary: This API updates the substatus of a specified sales order in Zoho Books. It requires the sales order ID and the new substatus 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 returns a code and message indicating whether the update was successful.
Input Fields: Input Fields
Output Fields: Output Fields

Void a bill

ID: post_void_a_bill
Operation: write
Entities: bill, status
Summary: The 'Void a bill' API marks a bill as void in the Zoho Books system. It requires an OAuth token for authorization, the bill ID as a path parameter, and the organization ID as a query parameter. The API does not require a request body. Upon successful execution, it returns a response code and a message indicating that the bill has been marked as void.
Input Fields: Input Fields
Output Fields: Output Fields

Void an invoice

ID: post_void_an_invoice
Operation: write
Entities: payment, credit, invoice
Summary: The 'Void an invoice' API marks an invoice as void in the Zoho Books system. When an invoice is voided, any payments and credits associated with it are unassociated and moved to customer credits. This API 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 request does not require a body. Upon successful execution, the API returns a response code and a message indicating that the invoice status has been changed to void.
Input Fields: Input Fields
Output Fields: Output Fields

Void a Credit Note

ID: post_void_credit_note
Operation: write
Entities: credit note, organization
Summary: This API marks a specified credit note as void in the Zoho Books system. It requires an OAuth token for authorization, the credit note ID as a path parameter, 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

Void a retainer invoice

ID: post_void_retainer_invoice
Operation: write
Entities: payment, credit, invoice
Summary: This API is used to mark a retainer invoice as void in the Zoho Books system. When an invoice is voided, any payments and credits associated with it are unassociated and moved to customer credits. The API requires an OAuth token for authorization, the invoice ID as a path parameter, and the organization ID as a query parameter. The response includes a code and a message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Void vendor credit

ID: post_void_vendor_credit
Operation: write
Entities: vendor credit, organization
Summary: The 'Void vendor credit' API marks an existing vendor credit as void in the Zoho Books system. It requires an OAuth token for authorization, the vendor credit ID to specify which credit to void, 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

Write off invoice

ID: post_write_off_invoice
Operation: write
Entities: invoice, balance amount, organization
Summary: The 'Write off invoice' API allows you to write off the balance amount of a specified invoice in Zoho Books. To use this API, you need to provide the invoice 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. The API does not require a request body. Upon successful execution, the API returns a response with a code and message indicating that the invoice has been written off.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Update Custom Module

ID: put_bulk_update_custom_module
Operation: write
Entities: field, custom module, record
Summary: The Bulk Update Custom Module API allows users to update existing custom module records in bulk. It requires an OAuth token for authorization and accepts a JSON body with fields such as 'cf_debt_amount', 'module_record_id', and 'record_name'. The 'record_name' is a required field. The API responds with a JSON object containing a response code, message, and details of the updated module records, including their IDs, names, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Edit Additional Address

ID: put_edit_additional_address
Operation: write
Entities: address, contact
Summary: The Edit Additional Address API allows you to update the additional address of a contact in Zoho Books. You need to provide the contact ID and address ID as path parameters, and the organization ID as a query parameter. The request body can include details such as attention, address, street2, city, state, zip, country, fax, and phone. The API requires an OAuth token for authorization. Upon success, it returns a response code and message, along with the updated address information.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Contact

ID: put_update_a_contact
Operation: write
Entities: contact person, contact, default template
Summary: The 'Update a Contact' API allows you to update an existing contact in Zoho Books. It requires an OAuth token for authorization and accepts a variety of parameters to update the contact details. The request includes a path parameter 'contactId' to specify which contact to update, and a query parameter 'organization_id'. The request body includes fields such as contact name, company name, payment terms, contact type, currency ID, and more. You can also update addresses, contact persons, and default templates. The response returns a success message along with the updated contact details, including contact ID, name, company name, credit limit, tax details, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Update a contact person

ID: put_update_a_contact_person
Operation: write
Entities: contact person, organization, contact
Summary: The 'Update a contact person' API allows you to update the details of an existing contact person in Zoho Books. It requires the contact person ID and organization ID as path parameters. The request must include an OAuth token in the headers for authorization. The body of the request can include various fields such as contact ID, salutation, first name, last name, email, phone, mobile, skype, designation, department, enable portal, and is primary contact. The response returns a code and message indicating the success of the operation, along with the updated contact person details.
Input Fields: Input Fields
Output Fields: Output Fields

Update a credit note

ID: put_update_a_credit_note
Operation: write
Entities: line item, credit note, customer
Summary: The 'Update a credit note' API allows users to update details of an existing credit note in Zoho Books. It requires an OAuth token for authorization. The API accepts various parameters including customer_id, date, line_items, and creditnote_number as required fields. Optional fields include currency_id, contact_persons, exchange_rate, and more. The API returns a response with the updated credit note details, including creditnote_id, creditnote_number, customer_name, total amount, and line items. The response also includes billing and shipping addresses, custom fields, and associated invoices and taxes.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Currency

ID: put_update_a_currency
Operation: write
Entities: currency
Summary: The 'Update a Currency' API allows users to update the details of a currency in the Zoho Books application. It requires an OAuth token for authorization and accepts parameters such as 'currency_code', 'currency_symbol', 'price_precision', and 'currency_format'. The 'currency_code' and 'currency_format' are mandatory fields. The API returns a response indicating the success or failure of the operation, along with the updated currency details.
Input Fields: Input Fields
Output Fields: Output Fields

Update a journal

ID: put_update_a_journal
Operation: write
Entities: tax, line item, journal
Summary: The 'Update a journal' API allows you to update an existing journal entry in Zoho Books with the provided information. The API requires an OAuth token for authorization and accepts a variety of parameters in the request body, including journal date, reference number, notes, journal type, VAT treatment, currency details, line items, and custom fields. The path parameter 'journalEntryId' is required to specify the journal entry to be updated. The response includes a confirmation message and details of the updated journal entry, such as journal ID, entry number, reference number, currency details, line items, and custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

Update a payment

ID: put_update_a_payment
Operation: write
Entities: payment, invoice, customer
Summary: The 'Update a payment' API allows you to update existing payment information in Zoho Books. It requires the payment ID as a path parameter, and customer ID, payment mode, amount, and a list of invoices as mandatory fields. Optional fields include date, reference number, description, exchange rate, payment form, bank charges, custom fields, tax amount withheld, and account ID. The API returns a response with the updated payment details, including payment ID, mode, amount, status, customer details, and associated invoices.
Input Fields: Input Fields
Output Fields: Output Fields

Update a purchase order

ID: put_update_a_purchase_order
Operation: write
Entities: purchase order, line item, vendor
Summary: The 'Update a purchase order' API allows you to update an existing purchase order in the Zoho Books system. This API requires an OAuth token for authorization and accepts a variety of parameters to update the purchase order details. The request can include headers, a required path parameter 'purchaseOrderId', required query parameter 'organization_id', optional query parameters, and a JSON body with detailed information about the purchase order, such as vendor ID, currency ID, contact persons, purchase order number, GST treatment, tax treatment, and line items. The response returns a JSON object with the updated purchase order details, including the purchase order ID, documents, VAT treatment, GST number, source and destination of supply, and line items. The API is designed to handle complex purchase order updates with support for various international tax treatments and custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

Update a recurring bill

ID: put_update_a_recurring_bill
Operation: write
Entities: line item, recurring bill, vendor
Summary: This API updates a recurring bill in Zoho Books. It requires the recurring bill ID and organization ID as path and query parameters, respectively. The request body must include the vendor ID, recurrence name, start date, and recurrence frequency, among other optional parameters such as currency ID, status, and line items. The response returns a code and message indicating the success of the update operation.
Input Fields: Input Fields
Output Fields: Output Fields

Update a recurring expense

ID: put_update_a_recurring_expense
Operation: write
Entities: custom field, recurring expense, line item
Summary: The 'Update a recurring expense' API allows users to update details of an existing recurring expense in Zoho Books. The API requires the recurring expense ID and organization ID as path and query parameters, respectively. The request body must include details such as account ID, recurrence name, start date, recurrence frequency, and line items. Optional fields include GST number, source and destination of supply, and custom fields. The API returns a response with the updated recurring expense details, including account ID, recurrence name, start date, and tax information.
Input Fields: Input Fields
Output Fields: Output Fields

Update a refund

ID: put_update_a_refund
Operation: write
Entities: payment, refund, account
Summary: The 'Update a refund' API allows you to update the details of a refunded transaction in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as the date of payment, refund mode, reference number, amount, exchange rate, payment form, description, and the account from which the payment is refunded. The API returns a response indicating the success or failure of the operation, along with details of the payment refunds.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Retainer Invoice

ID: put_update_a_retainer_invoice
Operation: write
Entities: payment option, retainer invoice, customer
Summary: This API updates an existing retainer invoice in the Zoho Books system. It requires the customer ID and line items as mandatory fields. The API allows updating various details of the invoice such as reference number, date, contact persons, custom fields, notes, terms, payment options, template ID, place of supply, and project ID. The response includes the updated details of the retainer invoice, including its ID, number, date, status, customer details, line items, taxes, payment options, and addresses. The API requires an OAuth token for authorization.
Input Fields: Input Fields
Output Fields: Output Fields

Update a rule

ID: put_update_a_rule
Operation: write
Entities: rule, account, customer
Summary: The 'Update a rule' API allows users to modify an existing rule in the Zoho Books banking module. The API requires the rule name, target account ID, application type (deposits, withdrawals, etc.), criteria type (and/or), and a list of criteria. Additional optional parameters include account ID, customer ID, tax ID, reference number, VAT treatment, product type, tax authority ID, and tax exemption ID. The response includes a confirmation message and details of the updated rule, such as rule ID, name, order, application type, criteria, account details, and tax information.
Input Fields: Input Fields
Output Fields: Output Fields

Update a task

ID: put_update_a_task
Operation: write
Entities: project, task, customer
Summary: The 'Update a task' API allows you to update the details of a specific task within a project in Zoho Books. It requires an OAuth token for authorization and accepts parameters such as task name, description, rate, and budget hours. The API responds with a confirmation message and details of the updated task, including project ID, task ID, currency ID, customer ID, task name, project name, customer name, billed hours, logged time, and unbilled hours.
Input Fields: Input Fields
Output Fields: Output Fields

Update a tax

ID: put_update_a_tax
Operation: write
Entities: tax, tax authority, recurring invoice
Summary: The 'Update a tax' API allows users to update the details of a simple or compound tax in the Zoho Books application. It requires an OAuth token for authorization and accepts various parameters such as tax_id, tax_name, tax_percentage, tax_type, and others to specify the tax details. The API endpoint is a PUT request to the Zoho Books API with the organization ID as a query parameter. The request body includes detailed tax information, and the response returns a confirmation message along with the updated tax details.
Input Fields: Input Fields
Output Fields: Output Fields

Update a tax group

ID: put_update_a_tax_group
Operation: write
Entities: tax, tax group
Summary: This API updates the details of a tax group in Zoho Books. It requires an OAuth token for authorization and the content type must be 'application/json'. The request must include the organization ID as a query parameter. The body of the request should contain the name of the tax group and a comma-separated list of tax IDs to be associated with the tax group. The response includes a code and message indicating success or failure, and details of the updated tax group including its ID, name, percentage, and associated taxes.
Input Fields: Input Fields
Output Fields: Output Fields

Update a transaction

ID: put_update_a_transaction
Operation: write
Entities: transaction, account, customer
Summary: The 'Update a transaction' API allows users to modify the details of an existing transaction in Zoho Books. The API requires an OAuth token for authorization and accepts a variety of parameters to specify the transaction details. These parameters include account IDs, transaction type, amount, payment mode, exchange rate, date, customer ID, reference number, description, currency ID, tax details, tags, documents, bank charges, user ID, tax authority ID, tax exemption ID, custom fields, and line items. The response includes a confirmation message and the updated transaction details, such as transaction ID, account names, transaction type, currency details, payment mode, date, customer and vendor information, reference number, description, bank charges, tax details, total amounts, VAT treatment, and any associated tags and line items.
Input Fields: Input Fields
Output Fields: Output Fields

Update a user

ID: put_update_a_user
Operation: write
Entities: cost rate, user, role
Summary: The 'Update a user' API allows you to update the details of a user in the Zoho Books application. It requires an OAuth token for authorization and accepts user details such as name, email, role ID, and cost rate in the request body. The organization ID must be provided as a query parameter. Upon successful update, it returns a response code and message indicating the status of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Update an account

ID: put_update_an_account
Operation: write
Entities: custom field, currency, account
Summary: The 'Update an account' API allows you to update the information of an existing account in Zoho Books. It requires an OAuth token for authorization and the content type must be 'application/json'. The API accepts various parameters such as account name, account code, account type, currency ID, description, and custom fields. The account type has specific allowed values. The response includes a code, message, and the updated details of the account including its ID, name, code, type, currency, description, and custom fields. The account ID is a required path parameter.
Input Fields: Input Fields
Output Fields: Output Fields

Update an Estimate

ID: put_update_an_estimate
Operation: write
Entities: line item, estimate, customer
Summary: The 'Update an Estimate' API allows users to update an existing estimate in the Zoho Books system. It requires an OAuth token for authorization and accepts various parameters such as customer_id, currency_id, contact_persons, template_id, and more. The API supports updating line items, applying discounts, and specifying tax treatments. The response includes the updated estimate details, including estimate_id, estimate_number, customer information, line items, and tax details. This API is useful for managing and modifying estimates efficiently.
Input Fields: Input Fields
Output Fields: Output Fields

Update an Expense

ID: put_update_an_expense
Operation: write
Entities: tax, line item, expense
Summary: The 'Update an Expense' API allows users to update an existing expense in the Zoho Books system. It requires the account ID, date, and amount as mandatory fields. Optional fields include tax ID, source and destination of supply, place of supply, GST number, and more. The API supports line items and taxes as arrays, allowing detailed expense breakdowns. The response includes the updated expense details, such as expense ID, transaction type, GST and tax treatments, and more. The API uses OAuth for authorization and requires a valid token in the request headers.
Input Fields: Input Fields
Output Fields: Output Fields

Update an invoice

ID: put_update_an_invoice
Operation: write
Entities: tax, invoice, line item
Summary: The 'Update an invoice' API allows you to update an existing invoice in the Zoho Books system. It requires the customer ID and line items as mandatory fields. The API supports a wide range of optional parameters including currency ID, contact persons, invoice number, place of supply, VAT treatment, tax treatment, GST treatment, and more. The request body can include details such as payment terms, discount, exchange rate, custom fields, and line items with their respective attributes. The API also supports query parameters to control invoice number generation. The response includes the updated invoice details such as invoice ID, number, status, customer details, line items, and financial summaries. This API requires an OAuth token for authorization.
Input Fields: Input Fields
Output Fields: Output Fields

Update an item

ID: put_update_an_item
Operation: write
Entities: item, tax, account
Summary: The 'Update an item' API allows you to update the details of an existing item in Zoho Books. It requires an OAuth token for authorization and accepts a variety of parameters to specify the details of the item being updated. The request body must include the item's name and rate, while other fields such as description, tax details, SKU, product type, and custom fields are optional. The API returns a response indicating the success of the operation, along with the updated item details, including its ID, name, status, description, rate, and tax information.
Input Fields: Input Fields
Output Fields: Output Fields

Update attachment preference

ID: put_update_attachment_preference
Operation: write
Entities: attachment, sales order
Summary: The 'Update attachment preference' API allows users to set whether they want to send the attached file while emailing a sales order. It requires an OAuth token for authorization and takes the sales order ID as a path parameter. The organization ID and a boolean indicating if the file can be sent in mail are required query parameters. The API responds with a code and message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Update bank account

ID: put_update_bank_account
Operation: write
Entities: bank account, currency, account
Summary: The 'Update bank account' API allows you to modify the details of an existing bank account in Zoho Books. It requires an OAuth token for authorization and accepts various parameters such as account name, type, number, currency details, and more. The API updates the account details and returns a response indicating the success of the operation along with the updated account details. The accountId is a required path parameter that specifies the bank account to be updated.
Input Fields: Input Fields
Output Fields: Output Fields

Update a bill using a custom field's unique value

ID: put_update_bill_using_custom_field
Operation: write
Entities: bill, line item, vendor
Summary: This API allows updating a bill using a custom field's unique value. The custom field's API name is provided in the X-Unique-Identifier-Key header, and its value is provided in the X-Unique-Identifier-Value header. If the X-Upsert header is set to true and the unique value is not found, a new bill is created if the necessary payload details are available. The request requires an OAuth token for authorization. The request body includes various parameters such as vendor_id, currency_id, bill_number, and line_items, among others. The response includes details of the updated bill, such as bill_id, vendor_id, bill_number, and line_items.
Input Fields: Input Fields
Output Fields: Output Fields

Update billing address

ID: put_update_billing_address
Operation: write
Entities: address, invoice, organization
Summary: The 'Update billing address' API updates the billing address for a specific invoice. It requires an OAuth token for authorization and the content type must be 'application/json'. The request includes the billing address details such as address, city, state, zip, country, and fax number. The organization ID is passed as a query parameter. Upon successful update, the API returns a response code and message indicating the billing address has been updated.
Input Fields: Input Fields
Output Fields: Output Fields

Update comment

ID: put_update_comment
Operation: write
Entities: comment, sales order
Summary: The 'Update comment' API allows you to update an existing comment on a sales order in Zoho Books. It requires the sales order ID, comment ID, and organization ID as path and query parameters. The request must include an OAuth token in the headers for authorization. The body of the request should contain the updated description of the comment. Upon successful execution, the API returns a response code, message, and details of the updated comment, including the sales order ID, comment ID, description, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Update a credit note using a custom field's unique value

ID: put_update_credit_note_custom_field
Operation: write
Entities: line item, credit note, customer
Summary: This API allows you to update a credit note using a custom field's unique value. You must provide the API name of the custom field in the 'X-Unique-Identifier-Key' header and its value in the 'X-Unique-Identifier-Value' header. If the 'X-Upsert' header is set to true and the unique value is not found, a new credit note will be created if the necessary payload details are available. The request body includes details such as customer_id, date, line_items, and creditnote_number, among others. The response includes the updated credit note details, including creditnote_id, creditnote_number, customer_name, total, and line_items.
Input Fields: Input Fields
Output Fields: Output Fields

Update credit note refund

ID: put_update_credit_note_refund
Operation: write
Entities: credit note refund, credit note, customer
Summary: The 'Update credit note refund' API allows you to update the details of a refunded transaction for a specific credit note. It requires authorization via an OAuth token and accepts various parameters such as the date of the refund, refund mode, payment form, reference number, amount, exchange rate, from account ID, and a description. The API responds with a confirmation message and details of the updated credit note refund, including the refund ID, credit note ID, date, refund mode, payment form, reference number, amount, customer name, and description.
Input Fields: Input Fields
Output Fields: Output Fields

Update a credit note template

ID: put_update_credit_note_template
Operation: write
Entities: credit note, organization, template
Summary: This API updates the PDF template associated with a specific credit note in Zoho Books. It requires the credit note ID, template ID, and organization ID as path and query parameters. The request must include an Authorization header with a valid OAuth token. The response returns a code and message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Update custom field in existing bills

ID: put_update_custom_field_in_existing_bills
Operation: write
Entities: bill, custom field, organization
Summary: This API updates the value of a custom field in existing bills in Zoho Books. It requires the bill ID as a path parameter and the organization ID as a query parameter. The request body should contain an array of custom fields with their IDs, indices, labels, and values to be updated. The request must include an Authorization header with a valid OAuth token and a content-type header set to application/json. Upon successful update, the API returns a response code and message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Update custom field in existing customerpayments

ID: put_update_custom_field_in_existing_customerpayments
Operation: write
Entities: custom field, organization, customer payment
Summary: This API updates the value of a custom field in an existing customer payment in Zoho Books. It requires the customer payment ID as a path parameter and the organization ID as a query parameter. The request must include an OAuth token in the headers for authentication. The body of the request should contain an array of objects, each specifying a custom field ID and the new value for that field. Upon successful update, the API returns a response code and a message indicating success.
Input Fields: Input Fields
Output Fields: Output Fields

Update custom field in existing invoices

ID: put_update_custom_field_in_existing_invoices
Operation: write
Entities: custom field, invoice, organization
Summary: This API updates the value of a custom field in an existing invoice. It requires the invoice ID as a path parameter, the organization ID as a query parameter, and an OAuth token in the headers for authorization. The request body should contain an array of objects, each specifying a custom field ID and its new value. The response returns a code and message indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Update custom field in existing items

ID: put_update_custom_field_in_existing_items
Operation: write
Entities: custom field, organization, item
Summary: This API updates the value of a custom field in existing items in Zoho Books. It requires the item ID as a path parameter, the organization ID as a query parameter, and the custom field ID and its new value in the request body. The request must include an OAuth token in the headers for authorization. The response indicates whether the update was successful.
Input Fields: Input Fields
Output Fields: Output Fields

Update Custom Module

ID: put_update_custom_module
Operation: write
Entities: field, custom module, record
Summary: The 'Update Custom Module' API allows you to update an existing custom module in Zoho Books. It requires an OAuth token for authorization and the content type must be 'application/json'. The API endpoint includes the organization ID as a query parameter. The request body must include the 'record_name' as a required field and 'cf_debt_amount' as an optional field. Upon successful update, the API returns a response code, message, and details of the updated module record including its ID, API name, timestamps, and formatted values.
Input Fields: Input Fields
Output Fields: Output Fields

Update an Estimate using a Custom Field's Unique Value

ID: put_update_estimate_custom_field
Operation: write
Entities: line item, estimate, customer
Summary: This API allows you to update an estimate using a custom field's unique value. The custom field must be configured to not accept duplicate values. You provide the custom field's API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header. If the X-Upsert header is set to true and the custom field's unique value is not found, a new estimate will be created if the necessary payload details are available. The API requires an OAuth token for authorization. The request body can include various parameters such as customer_id, currency_id, contact_persons, template_id, place_of_supply, gst_treatment, gst_no, estimate_number, reference_number, date, expiry_date, exchange_rate, discount, is_discount_before_tax, discount_type, is_inclusive_tax, custom_body, custom_subject, salesperson_name, custom_fields, line_items, notes, terms, shipping_charge, adjustment, adjustment_description, tax_id, tax_exemption_id, tax_authority_id, avatax_use_code, avatax_exempt_no, vat_treatment, tax_treatment, project_id, accept_retainer, and retainer_percentage. The response includes the updated estimate details such as estimate_id, estimate_number, date, reference_number, is_pre_gst, place_of_supply, gst_no, gst_treatment, tax_treatment, status, customer_id, customer_name, contact_persons, currency_id, currency_code, exchange_rate, expiry_date, discount, is_discount_before_tax, discount_type, is_inclusive_tax, line_items, shipping_charge, adjustment, adjustment_description, sub_total, total, tax_total, price_precision, taxes, billing_address, shipping_address, notes, terms, custom_fields, template_id, template_name, created_time, last_modified_time, salesperson_id, salesperson_name, and project.
Input Fields: Input Fields
Output Fields: Output Fields

Update estimate template

ID: put_update_estimate_template
Operation: write
Entities: organization, estimate, template
Summary: The 'Update estimate template' API allows you to update the PDF template associated with a specific estimate in Zoho Books. To use this API, you need to provide the estimate ID and template 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 API does not require a request body. Upon successful execution, the API returns a response code and message indicating that the estimate information has been updated.
Input Fields: Input Fields
Output Fields: Output Fields

Update an exchange rate

ID: put_update_exchange_rate
Operation: write
Entities: exchange rate, currency, organization
Summary: This API updates the details of an exchange rate for a specific currency. It requires an OAuth token for authorization and expects the effective date and rate of exchange in the request body. The request is made to a specific URL with the organization ID as a query parameter. Upon successful update, it returns a response code and message indicating the exchange rate has been updated.
Input Fields: Input Fields
Output Fields: Output Fields

Update an expense using a custom field's unique value

ID: put_update_expense_custom_field
Operation: write
Entities: tax, account, expense
Summary: This API allows you to update an expense in Zoho Books using a custom field's unique value. The custom field must be configured to not accept duplicate values. You provide the custom field's API name in the 'X-Unique-Identifier-Key' header and its value in the 'X-Unique-Identifier-Value' header. If the 'X-Upsert' header is set to true and the unique value is not found, a new expense will be created if the necessary payload details are available. The request requires an OAuth token for authorization and the content type must be 'application/json'. The body of the request includes various parameters such as 'account_id', 'date', 'amount', and optional fields like 'tax_id', 'source_of_supply', 'destination_of_supply', etc. The response includes a code and message indicating the success or failure of the operation, along with the details of the updated expense.
Input Fields: Input Fields
Output Fields: Output Fields

Update an invoice using a custom field's unique value

ID: put_update_invoice_custom_field
Operation: write
Entities: invoice, line item, customer
Summary: This API allows you to update an invoice using a custom field's unique value. The custom field's API name is provided in the 'X-Unique-Identifier-Key' header and its value in the 'X-Unique-Identifier-Value' header. If the 'X-Upsert' header is set to true and the unique value is not found, a new invoice is created if the necessary details are provided. The request requires an OAuth token for authorization. The body of the request includes various parameters such as customer_id, currency_id, contact_persons, invoice_number, and line_items, among others. The response includes details of the updated invoice, such as invoice_id, invoice_number, customer_name, line_items, and total amount.
Input Fields: Input Fields
Output Fields: Output Fields

Update invoice template

ID: put_update_invoice_template
Operation: write
Entities: invoice, organization, template
Summary: The 'Update invoice template' API allows you to update the PDF template associated with a specific invoice in Zoho Books. This API requires an OAuth token for authorization and takes the invoice ID, template ID, and organization ID as parameters. The request is made using the PUT method and does not require a request body. Upon successful execution, the API returns a response code and message indicating that the invoice information has been updated.
Input Fields: Input Fields
Output Fields: Output Fields

Update an item using a custom field's unique value

ID: put_update_item_using_custom_field_unique_value
Operation: write
Entities: item, tax, account
Summary: This API allows you to update an item in Zoho Books using a custom field's unique value. The custom field must be configured to not accept duplicate values. You provide the API name of the custom field in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header. If the X-Upsert header is set to true and the unique value is not found, a new item will be created if the necessary payload details are available. The request requires an OAuth token for authorization and accepts various item details in the body, such as name, rate, description, tax details, and custom fields. The response includes the updated or newly created item's details.
Input Fields: Input Fields
Output Fields: Output Fields

Update opening balance

ID: put_update_opening_balance
Operation: write
Entities: account, opening balance
Summary: The 'Update opening balance' API allows users to update the existing opening balance information for a specified organization. The API requires an OAuth token for authorization and accepts a PUT request to the specified URL. The request body must include the 'opening_balance_id' as a required parameter, along with optional parameters such as 'date' and 'accounts' details. The accounts array can include details like 'account_id', 'account_name', 'debit_or_credit', 'exchange_rate', 'currency_id', 'currency_code', 'bcy_amount', and 'amount'. The response returns a code and message indicating the success of the operation, along with the updated opening balance details.
Input Fields: Input Fields
Output Fields: Output Fields

Updated about 1 month ago