Guides
Signup For Free

Zohobook API Integration Vol.3

Suggest Edits

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

Update a payment using a custom field's unique value

  • ID: put_update_payment_using_custom_field_unique_value
  • Operation: write
  • Entities: payment, invoice, customer
  • Summary: This API allows updating a payment 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 payment is created if the necessary details are provided. The request requires headers for authorization and content type, and a body containing payment details such as customer ID, payment mode, amount, and associated invoices. The response includes the updated payment details, including payment ID, mode, amount, status, and any custom fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update project

  • ID: put_update_project
  • Operation: write
  • Entities: project, task, user
  • Summary: The 'Update project' API allows you to update the details of an existing project in Zoho Books. It requires an OAuth token for authorization and accepts a variety of parameters in the request body, including project name, customer ID, billing type, and user details. The API updates the project with the provided information and returns a response containing the updated project details, including project ID, name, customer information, billing details, and associated tasks and users.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a project using a custom field's unique value

  • ID: put_update_project_using_custom_field_unique_value
  • Operation: write
  • Entities: project, task, user
  • Summary: This API allows you to update a project 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 project will be created if the necessary payload details are available. The request requires headers for authorization and content type, and the body must include project details such as project name, customer ID, billing type, and user ID. The response includes a code, message, and details of the updated project, including project ID, name, customer details, billing information, and associated tasks and users.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a purchase order using a custom field's unique value

  • ID: put_update_purchase_order_custom_field
  • Operation: write
  • Entities: custom field, purchase order, vendor
  • Summary: This API allows you to update a purchase order 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 purchase order will be created if the necessary payload details are available. The API requires an OAuth token for authorization. The request body includes various parameters such as vendor_id, currency_id, contact_persons, purchaseorder_number, gst_treatment, tax_treatment, and line_items, among others. The response includes details of the updated purchase order, including its ID, documents, VAT treatment, GST number, source and destination of supply, line items, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update purchase order template

  • ID: put_update_purchase_order_template
  • Operation: write
  • Entities: purchase order, organization, template
  • Summary: This API updates the PDF template associated with a specific purchase order in Zoho Books. It requires the purchase order 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 a recurring bill using a custom field's unique value

  • ID: put_update_recurring_bill_using_custom_field
  • Operation: write
  • Entities: line item, recurring bill, vendor
  • Summary: This API allows you to update a recurring bill using a custom field's unique value. You must 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 recurring bill will be created if the necessary details are provided. The request requires an OAuth token for authorization and accepts various parameters such as vendor_id, recurrence_name, start_date, and more. The response returns a code and message indicating the success or failure of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a recurring expense using a custom field's unique value

  • ID: put_update_recurring_expense_custom_field
  • Operation: write
  • Entities: custom field, recurring expense, line item
  • Summary: This API allows updating a recurring expense 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 recurring expense is created if the necessary details are provided. The request requires an OAuth token for authorization. The body of the request includes details such as account_id, recurrence_name, start_date, recurrence_frequency, and line_items, among others. The response includes the updated recurring expense details, including account_id, recurrence_name, start_date, and various tax-related fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Recurring Invoice

  • ID: put_update_recurring_invoice
  • Operation: write
  • Entities: recurring invoice, line item, customer
  • Summary: The Update Recurring Invoice API allows users to update details of an existing 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 part of the request body. The API updates the recurring invoice with the provided details and returns a response containing the updated invoice information, including line items, billing and shipping addresses, and payment options.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a recurring invoice using a custom field's unique value

  • ID: put_update_recurring_invoice_custom_field
  • Operation: write
  • Entities: recurring invoice, line item, customer
  • Summary: This API allows you to update a recurring invoice 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 custom field's unique value is not found, a new recurring invoice will be created if the necessary payload details are available. The request requires an OAuth token for authorization. The body of the request includes details such as recurrence name, customer ID, currency ID, start and end dates, line items, and more. The response includes the updated or newly created recurring invoice details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Recurring Invoice Template

  • ID: put_update_recurring_invoice_template
  • Operation: write
  • Entities: template, recurring invoice
  • Summary: This API updates the PDF template associated with a recurring invoice in Zoho Books. It requires the unique IDs of the recurring invoice and the template as path parameters, and the organization ID as a query parameter. The request must include an OAuth token in the headers for authorization. The body can contain custom fields to be updated. The response returns a code and a message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update retainer invoice template

  • ID: put_update_retainer_invoice_template
  • Operation: write
  • Entities: template, organization, retainer invoice
  • Summary: The 'Update retainer invoice template' API allows users to update the PDF template associated with a specific retainer invoice in Zoho Books. The API requires an OAuth token for authorization, which should be included in the request headers. The request URL must include the retainer invoice ID and the template ID as path parameters, and the organization ID as a query parameter. No request body is needed. Upon successful execution, the API returns a response code and a message indicating that the retainer invoice information has been updated.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a sales order using a custom field's unique value

  • ID: put_update_sales_order_custom_field
  • Operation: write
  • Entities: custom field, line item, sales order
  • Summary: This API allows updating a sales order using a custom field's unique value. The custom field must be configured to not accept duplicate values. The API requires the custom field's API name in the 'X-Unique-Identifier-Key' header and its value in the 'X-Unique-Identifier-Value' header to identify the sales order. An optional 'X-Upsert' header can be used to create a new sales order if the unique value is not found. The request body includes various parameters such as 'customer_id', 'currency_id', 'contact_persons', 'date', 'shipment_date', 'custom_fields', 'line_items', and more. The response includes details of the updated sales order, such as 'salesorder_id', 'customer_name', 'currency_code', 'line_items', 'total', and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update sales order template

  • ID: put_update_sales_order_template
  • Operation: write
  • Entities: organization, template, sales order
  • Summary: The 'Update sales order template' API allows users to update the PDF template associated with a specific sales order in Zoho Books. The API requires a PUT request to the specified URL with the sales order 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 response will include a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update shipping address

  • ID: put_update_shipping_address
  • Operation: write
  • Entities: address, invoice, organization
  • Summary: The 'Update shipping address' API updates the shipping address for a specific invoice. It requires an OAuth token for authorization and accepts a JSON body with the new shipping address details, including address, street2, city, state, zip, country, and fax. The API responds with a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a tax authority [US and CA Edition only]

  • ID: put_update_tax_authority_us_ca_edition
  • Operation: write
  • Entities: description, tax authority, registration number
  • Summary: This API updates the details of a tax authority for US and CA editions only. It requires an OAuth token for authorization and accepts a JSON body with the tax authority's name, description, registration number, and registration number label. The organization ID must be provided as a query parameter. Upon successful update, it returns a response with a code, message, and the updated tax authority details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a tax exemption [US Edition only]

  • ID: put_update_tax_exemption_us_edition
  • Operation: write
  • Entities: item, tax exemption, customer
  • Summary: This API updates the details of 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 code and message indicating the success of the operation, along with the updated tax exemption details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update time entry

  • ID: put_update_time_entry
  • Operation: write
  • Entities: project, task, user
  • Summary: The 'Update time entry' API allows users to update a logged time entry in 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 uses OAuth for authorization and expects a JSON body with the specified parameters. Upon successful update, it returns a response with the updated time entry details including project, task, and user information, along with log times and billing status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update User Details

  • ID: put_update_user_details
  • Operation: write
  • Entities: project, organization, user
  • Summary: The Update User Details API allows you to update the details of a user in a specific project within an organization. The API requires the project ID, user ID, and organization ID as path and query parameters. The request must include an OAuth token for authorization and a JSON body with optional fields such as user_name, user_role, rate, budget_hours, and cost_rate. The response returns a code and message indicating the success of the operation, along with the updated user details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update vendor credit

  • ID: put_update_vendor_credit
  • Operation: write
  • Entities: tax, vendor credit, line item
  • Summary: The 'Update vendor credit' API allows you to update an existing vendor credit in the Zoho Books system. This API requires the vendor credit ID and organization ID as path and query parameters respectively. The request must include an authorization header with a valid OAuth token. The body of the request can include various parameters such as vendor ID, currency ID, VAT treatment, vendor credit number, GST treatment, tax treatment, and more. The response will include details of the updated vendor credit, including its ID, number, date, source and destination of supply, GST number, and more. The response also includes line items, taxes, documents, custom fields, and any comments or refunds associated with the vendor credit.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update vendor credit refund

  • ID: put_update_vendor_credit_refund
  • Operation: write
  • Entities: vendor credit, refund, account
  • Summary: The 'Update vendor credit refund' API allows you to update the details of a refunded transaction in Zoho Books. It requires an OAuth token for authorization and accepts a PUT request to the specified URL. The request body must include the date of the vendor credit, the amount, and the account ID, while other fields like refund mode, reference number, exchange rate, and description are optional. The response includes a confirmation message and details of the updated vendor credit refund, including any imported transactions associated with it.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a vendor payment

  • ID: put_update_vendor_payment
  • Operation: write
  • Entities: bill, vendor, payment
  • Summary: The 'Update a vendor payment' API allows you to update an existing vendor payment in Zoho Books. This API requires an OAuth token for authorization and supports updating various details of a vendor payment, including the vendor ID, bill details, payment date, exchange rate, total amount, payment mode, and more. The request must include the payment ID as a path parameter and the total amount of the vendor payment in the body. Other fields such as vendor ID, bills, and custom fields are optional. The response includes the updated details of the vendor payment, such as payment ID, vendor name, payment mode, and associated bills. This API is useful for modifying the amount applied to bills and updating payment details in Zoho Books.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a bill

  • ID: update_a_bill
  • Operation: write
  • Entities: bill, line item, vendor
  • Summary: The 'Update a bill' API allows you to update the details of an existing bill in the Zoho Books system. It requires the vendor ID and bill number as mandatory fields. The API supports various optional fields such as currency ID, VAT treatment, purchase order IDs, and more. You can also attach files to the bill. The response includes the updated bill details, including line items, taxes, and payment information. The API uses OAuth for authorization and requires the 'ZohoBooks.bills.UPDATE' scope.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a sales order

  • ID: update_a_sales_order
  • Operation: write
  • Entities: sales order, line item, customer
  • Summary: The 'Update a sales order' API allows you to update an existing sales order in Zoho Books. You can modify various details of the sales order such as customer information, currency, contact persons, dates, custom fields, line items, and more. The API requires the sales order ID and organization ID as path and query parameters respectively. The request body can include a wide range of optional fields to update the sales order details. The response returns a confirmation message along with the updated sales order details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a contact using a custom field's unique value

  • ID: update_contact_using_custom_field_unique_value
  • Operation: write
  • Entities: shipping address, billing address, contact
  • Summary: This API allows you to update a contact 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 contact will be created if the necessary payload details are available. The request includes various parameters such as contact name, company name, payment terms, contact type, currency ID, and more. The response returns 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 custom field in existing estimates

  • ID: update_custom_field_in_existing_estimates
  • Operation: write
  • Entities: custom field, organization, estimate
  • Summary: This API updates the value of a custom field in existing estimates in Zoho Books. It requires an OAuth token for authorization and the organization ID as a query parameter. The request body must include the custom field ID and the new value to update. The API returns a response code and message indicating whether the update was successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update custom field in existing purchaseorders

  • ID: update_custom_field_in_existing_purchaseorders
  • Operation: write
  • Entities: custom field, purchase order, organization
  • Summary: This API updates the value of a custom field in existing purchase orders 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 objects, each containing a 'customfield_id' and the new 'value' for that field. The API responds with a code and message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update custom field in existing salesorders

  • ID: update_custom_field_in_existing_salesorders
  • Operation: write
  • Entities: custom field, salesorder, organization
  • Summary: This API updates the value of a custom field in existing sales orders in Zoho Books. It requires the organization ID as a query parameter and the custom field details 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 a vendor payment using a custom field's unique value

  • ID: update_vendor_payment_using_custom_field_unique_value
  • Operation: write
  • Entities: bill payment, custom field, vendor payment
  • Summary: This API allows you to update a vendor payment 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 vendor payment will be created if the necessary payload details are available. The request requires an OAuth token for authorization and the organization ID as a query parameter. The body of the request can include details such as vendor ID, bills, date, exchange rate, amount, payment mode, and custom fields. The response includes the updated vendor payment details, including payment ID, vendor name, payment mode, custom fields, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated about 1 month ago