Create Invoice with Zoho Books API on New Item Updated (Instant) from Microsoft Excel API

Pipedream makes it easy to connect APIs for Zoho Books, Microsoft Excel and 2,400+ other apps remarkably fast.

Trigger workflow on

New Item Updated (Instant) from the Microsoft Excel API

Next, do this

Create Invoice with the Zoho Books API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Microsoft Excel trigger and Zoho Books action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Item Updated (Instant) trigger
1. Connect your Microsoft Excel account
Configure the Create Invoice action
1. Connect your Zoho Books account
2. Configure organization_id
3. Configure customer_id
4. Optional- Configure line_items
5. Optional- Configure contact_persons
6. Optional- Configure invoice_number
7. Optional- Configure place_of_supply
8. Optional- Configure vat_treatment
9. Optional- Configure tax_treatment
10. Optional- Select a gst_treatment
11. Optional- Configure gst_no
12. Optional- Configure reference_number
13. Optional- Configure template_id
14. Optional- Configure date
15. Optional- Configure payment_terms
16. Optional- Configure payment_terms_label
17. Optional- Select a due_date
18. Optional- Configure discount
19. Optional- Configure is_discount_before_tax
20. Optional- Select a discount_type
21. Optional- Configure is_inclusive_tax
22. Optional- Configure exchange_rate
23. Optional- Configure recurring_invoice_id
24. Optional- Configure invoiced_estimate_id
25. Optional- Configure salesperson_name
26. Optional- Configure custom_fields
27. Optional- Configure payment_options
28. Optional- Configure allow_partial_payments
29. Optional- Configure custom_body
30. Optional- Configure custom_subject
31. Optional- Configure notes
32. Optional- Configure terms
33. Optional- Configure shipping_charge
34. Optional- Configure adjustment
35. Optional- Configure adjustment_description
36. Optional- Configure reason
37. Optional- Configure tax_authority_id
38. Optional- Configure tax_exemption_id
39. Optional- Configure avatax_use_code
40. Optional- Configure avatax_exempt_no
41. Optional- Configure tax_id
42. Optional- Configure expense_id
43. Optional- Configure salesorder_item_id
44. Optional- Configure avatax_tax_code
45. Optional- Configure time_entry_ids
46. Optional- Configure send
47. Optional- Configure ignore_auto_number_generation
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Item Updated (Instant) on Microsoft Excel

Description:Emit new event when an item is updated.

Version:0.0.4

Key:microsoft_excel-new-item-updated

View on GitHub

Microsoft Excel Overview#

The Microsoft Excel API on Pipedream allows you to automate spreadsheet tasks, manipulate data, and integrate Excel with other apps and services. Through Pipedream, you can create serverless workflows that react to events, perform operations on Excel files like reading, writing, updating cells, and managing worksheets. This API turns Excel into a powerful tool for data analysis, report generation, and task automation without manual intervention.

Trigger Code#

import moment from "moment";
import microsoftExcel from "../../microsoft_excel.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  dedupe: "unique",
  key: "microsoft_excel-new-item-updated",
  name: "New Item Updated (Instant)",
  description: "Emit new event when an item is updated.",
  version: "0.0.4",
  type: "source",
  props: {
    microsoftExcel,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  hooks: {
    async activate() {
      const response = await this.microsoftExcel.createHook({
        data: {
          changeType: "updated",
          notificationUrl: this.http.endpoint,
          resource: "me/drive/root",
          expirationDateTime: moment().add(30, "days"),
        },
      });

      this._setHookId(response.id);
    },
    async deactivate() {
      const id = this._getHookId("hookId");
      await this.microsoftExcel.deleteHook(id);
    },
  },
  methods: {
    emitEvent(body) {
      const meta = this.generateMeta(body);
      this.$emit(body, meta);
    },
    _getHookId() {
      return this.db.get("hookId");
    },
    _setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
    generateMeta(body) {
      const { value } = body;

      const ts = new Date();
      return {
        id: `${value[0].tenantId}${ts}`,
        summary: `The item ${value[0].tenantId
          ? `with TenantId: ${value[0].tenantId} `
          : " "}was updated!`,
        ts: ts,
      };
    },
    async updateSubscription() {
      const hookId = this._getHookId();
      await this.microsoftExcel.updateSubscription({
        hookId,
        data: {
          expirationDateTime: moment().add(30, "days"),
        },
      });
    },
  },
  async run({
    body, query,
  }) {
    if (query.validationToken) {
      this.http.respond({
        status: 200,
        body: query.validationToken,
        headers: {
          "content-type": "text/plan",
        },
      });
      return;
    }

    this.emitEvent(body);
    await this.updateSubscription();
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Microsoft Excel	`microsoftExcel`	`app`	This component uses the Microsoft Excel app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

Microsoft Excel uses OAuth authentication. When you connect your Microsoft Excel account, Pipedream will open a popup window where you can sign into Microsoft Excel and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Microsoft Excel API.

Pipedream requests the following authorization scopes when you connect your account:

User.Reademailoffline_accessopenidprofileFiles.ReadWriteFiles.Read.AllUser.ReadCrossTenantInformation.ReadBasic.All

About Microsoft Excel#

You can use Microsoft Graph to allow web and mobile applications to read and modify Excel workbooks stored in OneDrive for Business, SharePoint site or Group drive.

Action#

Create Invoice on Zoho Books

Description:Creates an invoice for your customer.

Version:0.2.1

Key:zoho_books-create-invoice

View on GitHub

Zoho Books Overview#

Zoho Books API unlocks the potential to automate and streamline accounting tasks by integrating with Pipedream's serverless platform. With this powerful combo, you can automate invoicing, manage your accounts, reconcile bank transactions, and handle contacts and items without manual input. By setting up event-driven workflows, you can ensure data consistency across platforms, trigger notifications, and generate reports, all while saving time and reducing human error.

Action Code#

// legacy_hash_id: a_EVix1V
import { axios } from "@pipedream/platform";

export default {
  key: "zoho_books-create-invoice",
  name: "Create Invoice",
  description: "Creates an invoice for your customer.",
  version: "0.2.1",
  type: "action",
  props: {
    zoho_books: {
      type: "app",
      app: "zoho_books",
    },
    organization_id: {
      type: "string",
      description: "In Zoho Books, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zoho Books Organization with it's own organization ID, base currency, time zone, language, contacts, reports, etc.\n\nThe parameter `organization_id` should be sent in with every API request to identify the organization.\n\nThe `organization_id` can be obtained from the GET `/organizations` API's JSON response. Alternatively, it can be obtained from the **Manage Organizations** page in the admin console.",
    },
    customer_id: {
      type: "string",
      description: "ID of the customer the invoice has to be created.",
    },
    line_items: {
      type: "any",
      description: "Line items of an estimate.",
      optional: true,
    },
    contact_persons: {
      type: "any",
      description: "Array of contact person(s) for whom invoice has to be sent.",
      optional: true,
    },
    invoice_number: {
      type: "string",
      description: "Search invoices by invoice number.Variants: `invoice_number_startswith` and `invoice_number_contains`. Max-length [100]",
      optional: true,
    },
    place_of_supply: {
      type: "string",
      description: "Place where the goods/services are supplied to. (If not given, `place of contact` given for the contact will be taken)\nSupported codes for UAE emirates are :\nAbu Dhabi - AB`,\nAjman - `AJ`,\nDubai - `DU`,\nFujairah - `FU`,\nRas al-Khaimah - `RA`,\nSharjah - `SH`,\nUmm al-Quwain - `UM`\nSupported codes for the GCC countries are :\nUnited Arab Emirates - `AE`,\nSaudi Arabia - `SA`,\nBahrain - `BH`,\nKuwait - `KW`,\nOman - `OM`,\nQatar - `QA`.",
      optional: true,
    },
    vat_treatment: {
      type: "string",
      description: "Enter vat treatment.",
      optional: true,
    },
    tax_treatment: {
      type: "string",
      description: "VAT treatment for the invoice .Choose whether the contact falls under: `vat_registered`, `vat_not_registered`, `gcc_vat_not_registered`, `gcc_vat_registered`, `non_gcc` , `dz_vat_registered` and `dz_vat_not_registered` supported only for UAE.",
      optional: true,
    },
    gst_treatment: {
      type: "string",
      description: "Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are `business_gst`, `business_none`, `overseas`, `consumer`.",
      optional: true,
      options: [
        "business_gst",
        "business_none",
        "overseas",
        "consumer",
      ],
    },
    gst_no: {
      type: "string",
      description: "15 digit GST identification number of the customer.",
      optional: true,
    },
    reference_number: {
      type: "string",
      description: "The reference number of the invoice.",
      optional: true,
    },
    template_id: {
      type: "string",
      description: "ID of the pdf template associated with the invoice.",
      optional: true,
    },
    date: {
      type: "string",
      description: "Search invoices by invoice date. Default date format is yyyy-mm-dd. `Variants: due_date_start, due_date_end, due_date_before and due_date_after.`",
      optional: true,
    },
    payment_terms: {
      type: "string",
      description: "Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this. Max-length [100]",
      optional: true,
    },
    payment_terms_label: {
      type: "boolean",
      description: "Used to override the default payment terms label. Default value for 15 days is \"Net 15 Days\". Max-length [100]",
      optional: true,
    },
    due_date: {
      type: "string",
      description: "Search invoices by due date. Default date format is yyyy-mm-dd. `Variants: due_date_start, due_date_end, due_date_before and due_date_after`",
      optional: true,
      options: [
        "entity_level",
        "item_level",
      ],
    },
    discount: {
      type: "boolean",
      description: "Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190. Max-length [100]",
      optional: true,
    },
    is_discount_before_tax: {
      type: "boolean",
      description: "Used to specify how the discount has to applied. Either before or after the calculation of tax.",
      optional: true,
    },
    discount_type: {
      type: "string",
      description: "How the discount is specified. Allowed values: `entity_level` and `item_level`.",
      optional: true,
      options: [
        "entity_level",
        "item_level",
      ],
    },
    is_inclusive_tax: {
      type: "string",
      description: "Used to specify whether the line item rates are inclusive or exclusivr of tax.",
      optional: true,
    },
    exchange_rate: {
      type: "any",
      description: "Exchange rate of the currency.",
      optional: true,
    },
    recurring_invoice_id: {
      type: "string",
      description: "ID of the recurring invoice from which the invoice is created.",
      optional: true,
    },
    invoiced_estimate_id: {
      type: "string",
      description: "The notes added below expressing gratitude or for conveying some information.",
      optional: true,
    },
    salesperson_name: {
      type: "string",
      description: "ID of the invoice from which the invoice is created.",
      optional: true,
    },
    custom_fields: {
      type: "any",
      description: "Custom fields for an invoice.",
      optional: true,
    },
    payment_options: {
      type: "object",
      description: "Payment options for the invoice, online payment gateways and bank accounts. Will be displayed in the pdf.",
      optional: true,
    },
    allow_partial_payments: {
      type: "boolean",
      description: "Boolean to check if partial payments are allowed for the contact",
      optional: true,
    },
    custom_body: {
      type: "string",
      optional: true,
    },
    custom_subject: {
      type: "string",
      optional: true,
    },
    notes: {
      type: "string",
      description: "The notes added below expressing gratitude or for conveying some information.",
      optional: true,
    },
    terms: {
      type: "string",
      description: "The terms added below expressing gratitude or for conveying some information.",
      optional: true,
    },
    shipping_charge: {
      type: "string",
      description: "Shipping charges applied to the invoice. Max-length [100]",
      optional: true,
    },
    adjustment: {
      type: "string",
      optional: true,
    },
    adjustment_description: {
      type: "string",
      description: "Adjustments made to the invoice.",
      optional: true,
    },
    reason: {
      type: "string",
      optional: true,
    },
    tax_authority_id: {
      type: "string",
      description: "ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.",
      optional: true,
    },
    tax_exemption_id: {
      type: "string",
      description: "ID of the tax exemption.",
      optional: true,
    },
    avatax_use_code: {
      type: "string",
      description: "Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Max-length [25]",
      optional: true,
    },
    avatax_exempt_no: {
      type: "string",
      description: "Exemption certificate number of the customer. Max-length [25]",
      optional: true,
    },
    tax_id: {
      type: "string",
      description: "ID of the tax.",
      optional: true,
    },
    expense_id: {
      type: "string",
      optional: true,
    },
    salesorder_item_id: {
      type: "string",
      description: "ID of the sales order line item which is invoices.",
      optional: true,
    },
    avatax_tax_code: {
      type: "string",
      description: "A tax code is a unique label used to group Items (products, services, or charges) together. Refer the [link][2] for more deails. Max-length [25]",
      optional: true,
    },
    time_entry_ids: {
      type: "any",
      description: "IDs of the time entries associated with the project.",
      optional: true,
    },
    send: {
      type: "boolean",
      description: "Send the estimate to the contact person(s) associated with the estimate.Allowed Values: `true` and `false`",
      optional: true,
    },
    ignore_auto_number_generation: {
      type: "boolean",
      description: "Ignore auto estimate number generation for this estimate. This mandates the estimate number.",
      optional: true,
    },
  },
  async run({ $ }) {
  //See the API docs: https://www.zoho.com/books/api/v3/#Invoices_Create_an_invoice

    if (!this.organization_id || !this.customer_id || !this.line_items) {
      throw new Error("Must provide organization_id, customer_id, and line_items parameters.");
    }

    return await axios($, {
      method: "post",
      url: `https://books.${this.zoho_books.$auth.base_api_uri}/api/v3/invoices?organization_id=${this.organization_id}`,
      headers: {
        Authorization: `Zoho-oauthtoken ${this.zoho_books.$auth.oauth_access_token}`,
      },
      data: {
        customer_id: this.customer_id,
        contact_persons: this.contact_persons,
        invoice_number: this.invoice_number,
        place_of_supply: this.place_of_supply,
        vat_treatment: this.vat_treatment,
        tax_treatment: this.tax_treatment,
        gst_treatment: this.gst_treatment,
        gst_no: this.gst_no,
        reference_number: this.reference_number,
        template_id: this.template_id,
        date: this.date,
        payment_terms: this.payment_terms,
        payment_terms_label: this.payment_terms_label,
        due_date: this.due_date,
        discount: this.discount,
        is_discount_before_tax: this.is_discount_before_tax,
        discount_type: this.discount_type,
        is_inclusive_tax: this.is_inclusive_tax,
        exchange_rate: this.exchange_rate,
        recurring_invoice_id: this.recurring_invoice_id,
        invoiced_estimate_id: this.invoiced_estimate_id,
        salesperson_name: this.salesperson_name,
        custom_fields: this.custom_fields,
        line_items: this.line_items,
        payment_options: this.payment_options,
        allow_partial_payments: this.allow_partial_payments,
        custom_body: this.custom_body,
        custom_subject: this.custom_subject,
        notes: this.notes,
        terms: this.terms,
        shipping_charge: this.shipping_charge,
        adjustment: this.adjustment,
        adjustment_description: this.adjustment_description,
        reason: this.reason,
        tax_authority_id: this.tax_authority_id,
        tax_exemption_id: this.tax_exemption_id,
        avatax_use_code: this.avatax_use_code,
        avatax_exempt_no: this.avatax_exempt_no,
        tax_id: this.tax_id,
        expense_id: this.expense_id,
        salesorder_item_id: this.salesorder_item_id,
        avatax_tax_code: this.avatax_tax_code,
        time_entry_ids: this.time_entry_ids,
      },
      params: {
        send: this.send,
        ignore_auto_number_generation: this.ignore_auto_number_generation,
      },
    });
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Zoho Books	`zoho_books`	`app`	This component uses the Zoho Books app.
organization_id	`organization_id`	`string`	In Zoho Books, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zoho Books Organization with it's own organization ID, base currency, time zone, language, contacts, reports, etc. The parameter `organization_id` should be sent in with every API request to identify the organization. The `organization_id` can be obtained from the GET `/organizations` API's JSON response. Alternatively, it can be obtained from the Manage Organizations page in the admin console.
customer_id	`customer_id`	`string`	ID of the customer the invoice has to be created.
line_items	`line_items`	`any`	Line items of an estimate.
contact_persons	`contact_persons`	`any`	Array of contact person(s) for whom invoice has to be sent.
invoice_number	`invoice_number`	`string`	Search invoices by invoice number.Variants: `invoice_number_startswith` and `invoice_number_contains`. Max-length [100]
place_of_supply	`place_of_supply`	`string`	Place where the goods/services are supplied to. (If not given, `place of contact` given for the contact will be taken) Supported codes for UAE emirates are : Abu Dhabi - AB`, Ajman -` AJ`, Dubai -` DU`, Fujairah -` FU`, Ras al-Khaimah -` RA`, Sharjah -` SH`, Umm al-Quwain -` UM`Supported codes for the GCC countries are : United Arab Emirates -`AE`, Saudi Arabia -` SA`, Bahrain -` BH`, Kuwait -` KW`, Oman -` OM`, Qatar -` QA`.
vat_treatment	`vat_treatment`	`string`	Enter vat treatment.
tax_treatment	`tax_treatment`	`string`	VAT treatment for the invoice .Choose whether the contact falls under: `vat_registered`, `vat_not_registered`, `gcc_vat_not_registered`, `gcc_vat_registered`, `non_gcc` , `dz_vat_registered` and `dz_vat_not_registered` supported only for UAE.
gst_treatment	`gst_treatment`	`string`	Select a value from the drop down menu:`business_gstbusiness_noneoverseasconsumer`
gst_no	`gst_no`	`string`	15 digit GST identification number of the customer.
reference_number	`reference_number`	`string`	The reference number of the invoice.
template_id	`template_id`	`string`	ID of the pdf template associated with the invoice.
date	`date`	`string`	Search invoices by invoice date. Default date format is yyyy-mm-dd. `Variants: due_date_start, due_date_end, due_date_before and due_date_after.`
payment_terms	`payment_terms`	`string`	Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this. Max-length [100]
payment_terms_label	`payment_terms_label`	`boolean`	Used to override the default payment terms label. Default value for 15 days is "Net 15 Days". Max-length [100]
due_date	`due_date`	`string`	Select a value from the drop down menu:`entity_levelitem_level`
discount	`discount`	`boolean`	Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190. Max-length [100]
is_discount_before_tax	`is_discount_before_tax`	`boolean`	Used to specify how the discount has to applied. Either before or after the calculation of tax.
discount_type	`discount_type`	`string`	Select a value from the drop down menu:`entity_levelitem_level`
is_inclusive_tax	`is_inclusive_tax`	`string`	Used to specify whether the line item rates are inclusive or exclusivr of tax.
exchange_rate	`exchange_rate`	`any`	Exchange rate of the currency.
recurring_invoice_id	`recurring_invoice_id`	`string`	ID of the recurring invoice from which the invoice is created.
invoiced_estimate_id	`invoiced_estimate_id`	`string`	The notes added below expressing gratitude or for conveying some information.
salesperson_name	`salesperson_name`	`string`	ID of the invoice from which the invoice is created.
custom_fields	`custom_fields`	`any`	Custom fields for an invoice.
payment_options	`payment_options`	`object`	Payment options for the invoice, online payment gateways and bank accounts. Will be displayed in the pdf.
allow_partial_payments	`allow_partial_payments`	`boolean`	Boolean to check if partial payments are allowed for the contact
custom_body	`custom_body`	`string`
custom_subject	`custom_subject`	`string`
notes	`notes`	`string`	The notes added below expressing gratitude or for conveying some information.
terms	`terms`	`string`	The terms added below expressing gratitude or for conveying some information.
shipping_charge	`shipping_charge`	`string`	Shipping charges applied to the invoice. Max-length [100]
adjustment	`adjustment`	`string`
adjustment_description	`adjustment_description`	`string`	Adjustments made to the invoice.
reason	`reason`	`string`
tax_authority_id	`tax_authority_id`	`string`	ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
tax_exemption_id	`tax_exemption_id`	`string`	ID of the tax exemption.
avatax_use_code	`avatax_use_code`	`string`	Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Max-length [25]
avatax_exempt_no	`avatax_exempt_no`	`string`	Exemption certificate number of the customer. Max-length [25]
tax_id	`tax_id`	`string`	ID of the tax.
expense_id	`expense_id`	`string`
salesorder_item_id	`salesorder_item_id`	`string`	ID of the sales order line item which is invoices.
avatax_tax_code	`avatax_tax_code`	`string`	A tax code is a unique label used to group Items (products, services, or charges) together. Refer the [link][2] for more deails. Max-length [25]
time_entry_ids	`time_entry_ids`	`any`	IDs of the time entries associated with the project.
send	`send`	`boolean`	Send the estimate to the contact person(s) associated with the estimate.Allowed Values: `true` and `false`
ignore_auto_number_generation	`ignore_auto_number_generation`	`boolean`	Ignore auto estimate number generation for this estimate. This mandates the estimate number.

Action Authentication#

Zoho Books uses OAuth authentication. When you connect your Zoho Books account, Pipedream will open a popup window where you can sign into Zoho Books and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Zoho Books API.

Pipedream requests the following authorization scopes when you connect your account:

ZohoBooks.fullaccess.all