Create Invoice with Zoho Books API on New Contact from Twilio SendGrid API

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

Trigger workflow on

New Contact from the Twilio SendGrid 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 Twilio SendGrid 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 Contact trigger
1. Connect your Twilio SendGrid account
2. Configure timer
Configure the Create Invoice action
1. Connect your Zoho Books account
2. Select a Customer Id
3. Optional- Configure Invoice Number
4. Optional- Select a Place Of Supply
5. Optional- Configure VAT Treatment
6. Optional- Configure Reference Number
7. Optional- Select a Template Id
8. Optional- Configure Date
9. Optional- Configure Payment Terms
10. Optional- Configure Payment Terms Label
11. Optional- Configure Due Date
12. Optional- Configure Discount
13. Optional- Configure Is Discount Before Tax
14. Optional- Select a Discount Type
15. Optional- Configure Is Inclusive Tax
16. Optional- Configure Exchange Rate
17. Optional- Select a Recurring Invoice Id
18. Optional- Configure Invoiced Estimate Id
19. Optional- Configure Salesperson Name
20. Optional- Configure Custom Fields
21. Optional- Configure Line Items
22. Optional- Configure Payment Options
23. Optional- Configure Allow Partial Payments
24. Optional- Configure Custom Body
25. Optional- Configure Custom Subject
26. Optional- Configure Notes
27. Optional- Configure Terms
28. Optional- Configure Shipping Charge
29. Optional- Configure Adjustment
30. Optional- Configure Adjustment Description
31. Optional- Configure Reason
32. Optional- Select a Tax Authority Id
33. Optional- Select a Tax Exemption Id
34. Optional- Select a Tax Id
35. Optional- Select a Expense Id
36. Optional- Configure Salesorder Item Id
37. Optional- Configure Avatax Tax Code
38. Optional- Select one or more Time Entry Ids
39. Optional- Configure Send
40. 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 Contact on Twilio SendGrid

Description:Emit new event when a new contact is created

Version:0.0.7

Key:sendgrid-new-contact

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import orderBy from "lodash/orderBy.js";
import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "sendgrid-new-contact",
  name: "New Contact",
  description: "Emit new event when a new contact is created",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  hooks: {
    async activate() {
      const currentTimestamp = Date.now();
      const state = {
        processedItems: [],
        lowerTimestamp: currentTimestamp,
        upperTimestamp: currentTimestamp,
      };
      this.db.set("state", state);
    },
  },
  methods: {
    ...common.methods,
    _maxDelayTime() {
      // There is no report from SendGrid as to how much time it takes
      // for a contact to be created and appear in search results, so
      // we're using a rough estimate of 30 minutes here.
      return 30 * 60 * 1000;  // 30 minutes, in milliseconds
    },
    _addDelayOffset(timestamp) {
      return timestamp - this._maxDelayTime();
    },
    _cleanupOldProcessedItems(processedItems, currentTimestamp) {
      return processedItems
        .map((item) => ({
          // We just need to keep track of the record ID and
          // its creation date.
          id: item.id,
          created_at: item.created_at,
        }))
        .filter((item) => {
          const { created_at: createdAt } = item;
          const createdAtTimestamp = Date.parse(createdAt);
          const cutoffTimestamp = this._addDelayOffset(currentTimestamp);
          return createdAtTimestamp > cutoffTimestamp;
        });
    },
    _makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp) {
      const idList = processedItems
        .map((item) => item.id)
        .map((id) => `'${id}'`)
        .join(", ")
      || "''";
      const startTimestamp = this._addDelayOffset(lowerTimestamp);
      const startDate = this.toISOString(startTimestamp);
      const endDate = this.toISOString(upperTimestamp);
      return `
        contact_id NOT IN (${idList}) AND
        created_at BETWEEN
          TIMESTAMP '${startDate}' AND
          TIMESTAMP '${endDate}'
      `;
    },
    generateMeta(data) {
      const {
        item,
        eventTimestamp: ts,
      } = data;
      const {
        id,
        email,
      } = item;
      const slugifiedEmail = this.slugifyEmail(email);
      const summary = `New contact: ${slugifiedEmail}`;
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      // Transform the timer timestamp to milliseconds
      // to be consistent with how Javascript handles timestamps.
      const eventTimestamp = event.timestamp * 1000;

      // Retrieve the current state of the component.
      const {
        processedItems,
        lowerTimestamp,
        upperTimestamp,
      } = this.db.get("state");

      // Search for contacts within a specific timeframe, excluding
      // items that have already been processed.
      const query = this._makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp);
      const {
        result: items,
        contact_count: contactCount,
      } = await this.sendgrid.searchContacts(query);

      // If no contacts have been retrieved via the API,
      // move the time window forward to possibly capture newer contacts.
      if (contactCount === 0) {
        const newState = {
          processedItems: this._cleanupOldProcessedItems(processedItems, lowerTimestamp),
          lowerTimestamp: upperTimestamp,
          upperTimestamp: eventTimestamp,
        };
        this.db.set("state", newState);
        return;
      }

      // We process the searched records from oldest to newest.
      const itemsToProcess = orderBy(items, "created_at");
      itemsToProcess
        .forEach((item) => {
          const meta = this.generateMeta({
            item,
            eventTimestamp,
          });
          this.$emit(item, meta);
        });

      // Use the timestamp of the last processed record as a lower bound for
      // following searches. This bound will be subjected to an offset so in
      // case older records appear in future search results, but have not
      // appeared until now, can be processed. We only adjust it if it means
      // moving forward, not backwards. Otherwise, we might start retrieving
      // older and older records indefinitely (and we're all about *new*
      // records!)
      const newLowerTimestamp = Math.max(
        lowerTimestamp,
        Date.parse(itemsToProcess[0].created_at),
      );

      // If the total contact count is less than 100, it means that during the
      // next iteration the search results count will most likely be less than
      // 50. In that case, if we extend the upper bound of the search time range
      // we might be able to retrieve more records.
      const newUpperTimestamp = contactCount < 100
        ? eventTimestamp
        : upperTimestamp;

      // The list of processed items can grow indefinitely.
      // Since we don't want to keep track of every processed record
      // ever, we need to clean up this list, removing any records
      // that are no longer relevant.
      const newProcessedItems = this._cleanupOldProcessedItems(
        [
          ...processedItems,
          ...itemsToProcess,
        ],
        newLowerTimestamp,
      );

      // Update the state of the component to reflect the computations
      // made above.
      const newState = {
        processedItems: newProcessedItems,
        lowerTimestamp: newLowerTimestamp,
        upperTimestamp: newUpperTimestamp,
      };
      this.db.set("state", newState);
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
	`timer`	`$.interface.timer`

Trigger Authentication#

Twilio SendGrid uses API keys for authentication. When you connect your Twilio SendGrid account, Pipedream securely stores the keys so you can easily authenticate to Twilio SendGrid APIs in both code and no-code steps.

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

Action#

Create Invoice on Zoho Books

Description:Creates an invoice for your customer. [See the documentation](https://www.zoho.com/books/api/v3/invoices/#create-an-invoice)

Version:0.3.0

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 { parseObject } from "../../common/utils.mjs";
import zohoBooks from "../../zoho_books.app.mjs";

export default {
  key: "zoho_books-create-invoice",
  name: "Create Invoice",
  description: "Creates an invoice for your customer. [See the documentation](https://www.zoho.com/books/api/v3/invoices/#create-an-invoice)",
  version: "0.3.0",
  type: "action",
  props: {
    zohoBooks,
    customerId: {
      propDefinition: [
        zohoBooks,
        "customerId",
      ],
      description: "ID of the customer the invoice has to be created.",
    },
    invoiceNumber: {
      type: "string",
      label: "Invoice Number",
      description: "Search invoices by invoice number. Max-length [100]",
      optional: true,
    },
    placeOfSupply: {
      propDefinition: [
        zohoBooks,
        "placeOfSupply",
      ],
      optional: true,
    },
    vatTreatment: {
      propDefinition: [
        zohoBooks,
        "vatTreatment",
      ],
      optional: true,
    },
    referenceNumber: {
      type: "string",
      label: "Reference Number",
      description: "The reference number of the invoice.",
      optional: true,
    },
    templateId: {
      propDefinition: [
        zohoBooks,
        "templateId",
      ],
      optional: true,
    },
    date: {
      type: "string",
      label: "Date",
      description: "Search invoices by invoice date. Default date format is yyyy-mm-dd.",
      optional: true,
    },
    paymentTerms: {
      propDefinition: [
        zohoBooks,
        "paymentTerms",
      ],
      optional: true,
    },
    paymentTermsLabel: {
      propDefinition: [
        zohoBooks,
        "paymentTermsLabel",
      ],
      optional: true,
    },
    dueDate: {
      type: "string",
      label: "Due Date",
      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,
    },
    discount: {
      propDefinition: [
        zohoBooks,
        "discount",
      ],
      optional: true,
      description: "Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190. Max-length [100]",
    },
    isDiscountBeforeTax: {
      propDefinition: [
        zohoBooks,
        "isDiscountBeforeTax",
      ],
      optional: true,
    },
    discountType: {
      propDefinition: [
        zohoBooks,
        "discountType",
      ],
      optional: true,
    },
    isInclusiveTax: {
      propDefinition: [
        zohoBooks,
        "isInclusiveTax",
      ],
      optional: true,
    },
    exchangeRate: {
      type: "string",
      label: "Exchange Rate",
      description: "Exchange rate of the currency.",
      optional: true,
    },
    recurringInvoiceId: {
      propDefinition: [
        zohoBooks,
        "recurringInvoiceId",
        ({ customerId }) => ({
          customerId,
        }),
      ],
      optional: true,
    },
    invoicedEstimateId: {
      type: "string",
      label: "Invoiced Estimate Id",
      description: "ID of the invoice from which the invoice is created.",
      optional: true,
    },
    salespersonName: {
      propDefinition: [
        zohoBooks,
        "salespersonName",
      ],
      optional: true,
    },
    customFields: {
      propDefinition: [
        zohoBooks,
        "customFields",
      ],
      description: "A list of custom fields objects for an invoice. **Example: {\"customfield_id\": 123123, \"value\": \"value\"}**",
      optional: true,
    },
    lineItems: {
      propDefinition: [
        zohoBooks,
        "lineItems",
      ],
      optional: true,
      description: "A list of line items objects of an estimate. **Example: {\"item_id\": \"1352827000000156060\", \"notes\": \"note\", \"name\": \"Item name\", \"quantity\": \"1\" }** [See the documentation](https://www.zoho.com/books/api/v3/invoices/#create-an-invoice) for further details.",
    },
    paymentOptions: {
      type: "object",
      label: "Payment Options",
      description: "Payment options for the invoice, online payment gateways and bank accounts. Will be displayed in the pdf. **Example: {\"payment_gateways\": [\"configured\": true, \"additional_field1\": \"standard\", \"gateway_name\": \"paypal\"]}** [See the documentation](https://www.zoho.com/books/api/v3/invoices/#create-an-invoice) for further details.",
      optional: true,
    },
    allowPartialPayments: {
      type: "boolean",
      label: "Allow Partial Payments",
      description: "Boolean to check if partial payments are allowed for the contact",
      optional: true,
    },
    customBody: {
      propDefinition: [
        zohoBooks,
        "customBody",
      ],
      optional: true,
    },
    customSubject: {
      propDefinition: [
        zohoBooks,
        "customSubject",
      ],
      optional: true,
    },
    notes: {
      propDefinition: [
        zohoBooks,
        "notes",
      ],
      description: "The notes added below expressing gratitude or for conveying some information.",
      optional: true,
    },
    terms: {
      propDefinition: [
        zohoBooks,
        "terms",
      ],
      optional: true,
    },
    shippingCharge: {
      propDefinition: [
        zohoBooks,
        "shippingCharge",
      ],
      optional: true,
    },
    adjustment: {
      propDefinition: [
        zohoBooks,
        "adjustment",
      ],
      optional: true,
    },
    adjustmentDescription: {
      propDefinition: [
        zohoBooks,
        "adjustmentDescription",
      ],
      optional: true,
    },
    reason: {
      type: "string",
      label: "Reason",
      optional: true,
    },
    taxAuthorityId: {
      propDefinition: [
        zohoBooks,
        "taxAuthorityId",
      ],
      optional: true,
    },
    taxExemptionId: {
      propDefinition: [
        zohoBooks,
        "taxExemptionId",
      ],
      optional: true,
    },
    taxId: {
      propDefinition: [
        zohoBooks,
        "taxId",
      ],
      optional: true,
    },
    expenseId: {
      propDefinition: [
        zohoBooks,
        "expenseId",
      ],
      optional: true,
    },
    salesorderItemId: {
      type: "string",
      label: "Salesorder Item Id",
      description: "ID of the sales order line item which is invoices.",
      optional: true,
    },
    avataxTaxCode: {
      type: "string",
      label: "Avatax Tax Code",
      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,
    },
    timeEntryIds: {
      propDefinition: [
        zohoBooks,
        "timeEntryIds",
      ],
      optional: true,
    },
    send: {
      propDefinition: [
        zohoBooks,
        "send",
      ],
      optional: true,
    },
    ignoreAutoNumberGeneration: {
      propDefinition: [
        zohoBooks,
        "ignoreAutoNumberGeneration",
      ],
      optional: true,
      description: "Ignore auto estimate number generation for this estimate. This mandates the estimate number.",
    },
  },
  async run({ $ }) {
    const response = await this.zohoBooks.createInvoice({
      $,
      params: {
        send: this.send,
        ignore_auto_number_generation: this.ignoreAutoNumberGeneration,
      },
      data: {
        customer_id: this.customerId,
        invoice_number: this.invoiceNumber,
        place_of_supply: this.placeOfSupply,
        vat_treatment: this.vatTreatment,
        reference_number: this.referenceNumber,
        template_id: this.templateId,
        date: this.date,
        payment_terms: this.paymentTerms,
        payment_terms_label: this.paymentTermsLabel,
        due_date: this.dueDate,
        discount: this.discount && parseFloat(this.discount),
        is_discount_before_tax: this.isDiscountBeforeTax,
        discount_type: this.discountType,
        is_inclusive_tax: this.isInclusiveTax,
        exchange_rate: this.exchangeRate && parseFloat(this.exchangeRate),
        recurring_invoice_id: this.recurringInvoiceId,
        invoiced_estimate_id: this.invoicedEstimateId,
        salesperson_name: this.salespersonName,
        custom_fields: parseObject(this.customFields),
        line_items: parseObject(this.lineItems),
        payment_options: parseObject(this.paymentOptions),
        allow_partial_payments: this.allowPartialPayments,
        custom_body: this.customBody,
        custom_subject: this.customSubject,
        notes: this.notes,
        terms: this.terms,
        shipping_charge: this.shippingCharge && parseFloat(this.shippingCharge),
        adjustment: this.adjustment && parseFloat(this.adjustment),
        adjustment_description: this.adjustmentDescription,
        reason: this.reason,
        tax_authority_id: this.taxAuthorityId,
        tax_exemption_id: this.taxExemptionId,
        tax_id: this.taxId,
        expense_id: this.expenseId,
        salesorder_item_id: this.salesorderItemId,
        avatax_tax_code: this.avataxTaxCode,
        time_entry_ids: parseObject(this.timeEntryIds),
      },
    });

    $.export("$summary", `Invoice successfully created with Id: ${response.invoice.invoice_id}`);
    return response;
  },
};

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	`zohoBooks`	`app`	This component uses the Zoho Books app.
Customer Id	`customerId`	`string`	Select a value from the drop down menu.
Invoice Number	`invoiceNumber`	`string`	Search invoices by invoice number. Max-length [100]
Place Of Supply	`placeOfSupply`	`string`	Select a value from the drop down menu:`{ "label": "Abu Dhabi (UAE Supported)", "value": "AB" }{ "label": "Ajman (UAE Supported)", "value": "AJ" }{ "label": "Dubai (UAE Supported)", "value": "DU" }{ "label": "Fujairah (UAE Supported)", "value": "FU" }{ "label": "Ras al-Khaimah (UAE Supported)", "value": "RA" }{ "label": "Sharjah (UAE Supported)", "value": "SH" }{ "label": "Umm al-Quwain (UAE Supported)", "value": "UM" }{ "label": "United Arab Emirates (GCC Supported)", "value": "AE" }{ "label": "Saudi Arabia (GCC Supported)", "value": "SA" }{ "label": "Bahrain (GCC Supported)", "value": "BH" }{ "label": "Kuwait (GCC Supported)", "value": "KW" }{ "label": "Oman (GCC Supported)", "value": "OM" }{ "label": "Qatar (GCC Supported)", "value": "QA" }`
VAT Treatment	`vatTreatment`	`string`	Enter vat treatment.
Reference Number	`referenceNumber`	`string`	The reference number of the invoice.
Template Id	`templateId`	`string`	Select a value from the drop down menu.
Date	`date`	`string`	Search invoices by invoice date. Default date format is yyyy-mm-dd.
Payment Terms	`paymentTerms`	`integer`	Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this. Max-length [100]
Payment Terms Label	`paymentTermsLabel`	`string`	Used to override the default payment terms label. Default value for 15 days is "Net 15 Days". Max-length [100]
Due Date	`dueDate`	`string`	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`
Discount	`discount`	`string`	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	`isDiscountBeforeTax`	`boolean`	Used to specify how the discount has to applied. Either before or after the calculation of tax.
Discount Type	`discountType`	`string`	Select a value from the drop down menu:`entity_levelitem_level`
Is Inclusive Tax	`isInclusiveTax`	`boolean`	Used to specify whether the line item rates are inclusive or exclusive of tax.
Exchange Rate	`exchangeRate`	`string`	Exchange rate of the currency.
Recurring Invoice Id	`recurringInvoiceId`	`string`	Select a value from the drop down menu.
Invoiced Estimate Id	`invoicedEstimateId`	`string`	ID of the invoice from which the invoice is created.
Salesperson Name	`salespersonName`	`string`	Name of the sales person.
Custom Fields	`customFields`	`string[]`	A list of custom fields objects for an invoice. Example: {"customfield_id": 123123, "value": "value"}
Line Items	`lineItems`	`string[]`	A list of line items objects of an estimate. Example: {"item_id": "1352827000000156060", "notes": "note", "name": "Item name", "quantity": "1" } See the documentation for further details.
Payment Options	`paymentOptions`	`object`	Payment options for the invoice, online payment gateways and bank accounts. Will be displayed in the pdf. Example: {"payment_gateways": ["configured": true, "additional_field1": "standard", "gateway_name": "paypal"]} See the documentation for further details.
Allow Partial Payments	`allowPartialPayments`	`boolean`	Boolean to check if partial payments are allowed for the contact
Custom Body	`customBody`	`string`
Custom Subject	`customSubject`	`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	`shippingCharge`	`string`	Shipping charges applied to the invoice.
Adjustment	`adjustment`	`string`
Adjustment Description	`adjustmentDescription`	`string`
Reason	`reason`	`string`
Tax Authority Id	`taxAuthorityId`	`string`	Select a value from the drop down menu.
Tax Exemption Id	`taxExemptionId`	`string`	Select a value from the drop down menu.
Tax Id	`taxId`	`string`	Select a value from the drop down menu.
Expense Id	`expenseId`	`string`	Select a value from the drop down menu.
Salesorder Item Id	`salesorderItemId`	`string`	ID of the sales order line item which is invoices.
Avatax Tax Code	`avataxTaxCode`	`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	`timeEntryIds`	`string[]`	Select a value from the drop down menu.
Send	`send`	`boolean`	Send the estimate to the contact person(s) associated with the estimate.
Ignore Auto Number Generation	`ignoreAutoNumberGeneration`	`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

Create Invoice with Zoho Books API on New Contact from Twilio SendGrid API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular