Zoho Books

Zoho Books is cloud-based accounting software for managing your accounting tasks and organizing your transactions.

Categories: Accounting

Type: zohoBooks/v1

Connections

Version: 1

OAuth2 Authorization Code

Properties

Name	Label	Type	Required
region	Region	STRING Options zoho.eu, zoho.com, zoho.com.au, zoho.jp, zoho.in, zohocloud.ca	true
organization_id	Organization Id	STRING	true
clientId	Client Id	STRING	true
clientSecret	Client Secret	STRING	true

Connection Setup

Create OAuth 2.0 Application

Creation of OAuth 2.0 application is documented here.

Create organization ID

Login to your account at https://www.zoho.com/books/.
Fill in the required fields:
- Organization Name: Enter a name for your organization (e.g., bytechef).
- Organization Location: Choose a location for your organization.
Set up your organization profile and click Get Started.
Click on your organization and copy Organization ID.
In Bytechef, choose your region based on Zoho Books domain you are using.

Actions

Create Contact

Name: createContact

Create a contact.

Properties

Name	Label	Type	Description	Required
contact_name	Contact Name	STRING	Display name of the contact.	true
company_name	Company Name	STRING	Company name of the contact.	false
website	Website	STRING	Website of the contact.	false
contact_type	Contact Type	STRING Options customer, vendor	Contact type of the contact.	true
customer_sub_type	Customer Sub Type	STRING Options business, individual	Type of the customer.	true
currency_id	Currency ID	STRING	Currency ID of the customer's currency.	false
billing_address	Billing Address	OBJECT Properties {STRING(attention), STRING(address), STRING(street2), STRING(state_code), STRING(city), STRING(state), STRING(zip), STRING(country), STRING(fax), STRING(phone)}	Billing address of the contact.	false
shipping_address	Shipping Address	OBJECT Properties {STRING(attention), STRING(address), STRING(street2), STRING(state_code), STRING(city), STRING(state), STRING(zip), STRING(country), STRING(fax), STRING(phone)}	Shipping address of the contact.	false

Example JSON Structure

{
  "label" : "Create Contact",
  "name" : "createContact",
  "parameters" : {
    "contact_name" : "",
    "company_name" : "",
    "website" : "",
    "contact_type" : "",
    "customer_sub_type" : "",
    "currency_id" : "",
    "billing_address" : {
      "attention" : "",
      "address" : "",
      "street2" : "",
      "state_code" : "",
      "city" : "",
      "state" : "",
      "zip" : "",
      "country" : "",
      "fax" : "",
      "phone" : ""
    },
    "shipping_address" : {
      "attention" : "",
      "address" : "",
      "street2" : "",
      "state_code" : "",
      "city" : "",
      "state" : "",
      "zip" : "",
      "country" : "",
      "fax" : "",
      "phone" : ""
    }
  },
  "type" : "zohoBooks/v1/createContact"
}

Output

Type: OBJECT

Properties

Name	Type	Description
code	NUMBER	Zoho Books error code. This will be zero for a success response and non-zero in case of an error.
message	STRING	Message for the invoked API.
contact	OBJECT Properties {}	Created contact.

Output Example

{
  "code" : 0.0,
  "message" : "",
  "contact" : { }
}

Create Invoice

Name: createInvoice

Create an invoice for your customer.

Properties

Name	Label	Type	Description	Required
customer_id	Customer ID	STRING	ID of the customer the invoice has to be created.	true
use_custom_invoice_number	Use Custom Invoice Number	BOOLEAN Options true, false	If true, create custom invoice number, if false, use auto invoice number generation.	true
invoice_number	Invoice Number	STRING	Number of invoice.	true
line_items	Line Items	ARRAY Items [{STRING(item_id), NUMBER(quantity)}]	Items in invoice.	true
currency_id	Currency ID	STRING	Currency ID of the customer's currency.	false
date	Invoice Date	DATE	The date of the invoice.	false
payment_terms	Payment Terms	INTEGER	Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this.	false

Example JSON Structure

{
  "label" : "Create Invoice",
  "name" : "createInvoice",
  "parameters" : {
    "customer_id" : "",
    "use_custom_invoice_number" : false,
    "invoice_number" : "",
    "line_items" : [ {
      "item_id" : "",
      "quantity" : 0.0
    } ],
    "currency_id" : "",
    "date" : "2021-01-01",
    "payment_terms" : 1
  },
  "type" : "zohoBooks/v1/createInvoice"
}

Output

Type: OBJECT

Properties

Name	Type	Description
code	NUMBER	Zoho Books error code. This will be zero for a success response and non-zero in case of an error.
message	STRING	Message for the invoked API.
invoice	OBJECT Properties {}	Created invoice.

Output Example

{
  "code" : 0.0,
  "message" : "",
  "invoice" : { }
}

Create Sales Order

Name: createSalesOrder

Create a sales order for your customer.

Properties

Name	Label	Type	Description	Required
customer_id	Customer ID	STRING	ID of the customer the invoice has to be created.	true
use_custom_sales_order_number	Use Custom Sales Order Number	BOOLEAN Options true, false	If true, create custom sales order number, if false, use auto sales order number generation.	true
salesorder_number	Sales Order Number	STRING	Number of sales order.	true
line_items	Line Items	ARRAY Items [{STRING(item_id), NUMBER(quantity)}]	Items in invoice.	true
currency_id	Currency ID	STRING	Currency ID of the customer's currency.	false
date	Sales Order Date	DATE	The date the sales order was created.	false
shipment_date	Sales Order Shipment Date	DATE	Shipping date of sales order.	false
payment_terms	Payment Terms	INTEGER	Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this.	false

Example JSON Structure

{
  "label" : "Create Sales Order",
  "name" : "createSalesOrder",
  "parameters" : {
    "customer_id" : "",
    "use_custom_sales_order_number" : false,
    "salesorder_number" : "",
    "line_items" : [ {
      "item_id" : "",
      "quantity" : 0.0
    } ],
    "currency_id" : "",
    "date" : "2021-01-01",
    "shipment_date" : "2021-01-01",
    "payment_terms" : 1
  },
  "type" : "zohoBooks/v1/createSalesOrder"
}

Output

Type: OBJECT

Properties

Name	Type	Description
code	NUMBER	Zoho Books error code. This will be zero for a success response and non-zero in case of an error.
message	STRING	Message for the invoked API.
salesorder	OBJECT Properties {}	Created sales order.

Output Example

{
  "code" : 0.0,
  "message" : "",
  "salesorder" : { }
}

On this page