Create Estimate with Zoho Books API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Create Estimate 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 Typeform 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 Submission trigger
1. Connect your Typeform account
2. Select a Form
Configure the Create Estimate action
1. Connect your Zoho Books account
2. Select a Customer Id
3. Optional- Select a Currency Id
4. Optional- Select one or more Contact Persons
5. Optional- Configure Template Id
6. Optional- Select a Place Of Supply
7. Optional- Select a GST Treatment
8. Optional- Configure GST No
9. Optional- Configure Estimate Number
10. Optional- Configure Reference Number
11. Optional- Configure Date
12. Optional- Configure Expiry Date
13. Optional- Configure Exchange Rate
14. Optional- Configure Discount
15. Optional- Configure Is Discount Before Tax
16. Optional- Select a Discount Type
17. Optional- Configure Is Inclusive Tax
18. Optional- Configure Custom Body
19. Optional- Configure Custom Subject
20. Optional- Configure Salesperson Name
21. Optional- Configure Custom Fields
22. Configure Line Items
23. Optional- Configure Notes
24. Optional- Configure Terms
25. Optional- Configure Shipping Charge
26. Optional- Configure Adjustment
27. Optional- Configure Adjustment Description
28. Optional- Select a Tax Id
29. Optional- Select a Tax Exemption Id
30. Optional- Select a Tax Authority Id
31. Optional- Configure Avatax Use Code
32. Optional- Select a Tax Exemption Id
33. Optional- Configure VAT Treatment
34. Optional- Select a Tax Treatment
35. Optional- Configure Is Reverse Charge Applied.
36. Optional- Select a Item Id
37. Optional- Configure Line Item Id
38. Optional- Configure Name
39. Optional- Configure Description
40. Optional- Configure Rate
41. Optional- Configure Unit
42. Optional- Configure Quantity
43. Optional- Configure Project Id
44. Optional- Configure Accept Retainer
45. Optional- Configure Retainer Percentage
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 Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  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
Typeform	`typeform`	`app`	This component uses the Typeform 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.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

Action#

Create Estimate on Zoho Books

Description:Creates a new estimate. [See the documentation](https://www.zoho.com/books/api/v3/estimates/#create-an-estimate)

Version:0.0.1

Key:zoho_books-create-estimate

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

export default {
  key: "zoho_books-create-estimate",
  name: "Create Estimate",
  description: "Creates a new estimate. [See the documentation](https://www.zoho.com/books/api/v3/estimates/#create-an-estimate)",
  version: "0.0.1",
  type: "action",
  props: {
    zohoBooks,
    customerId: {
      propDefinition: [
        zohoBooks,
        "customerId",
      ],
    },
    currencyId: {
      propDefinition: [
        zohoBooks,
        "currencyId",
      ],
      optional: true,
    },
    contactPersons: {
      propDefinition: [
        zohoBooks,
        "contactPersons",
        ({ customerId }) => ({
          customerId,
        }),
      ],
      description: "Array if contact person(S) for whom estimate has to be sent.",
      optional: true,
    },
    templateId: {
      propDefinition: [
        zohoBooks,
        "pdfTemplateId",
      ],
      optional: true,
    },
    placeOfSupply: {
      propDefinition: [
        zohoBooks,
        "placeOfSupply",
      ],
      optional: true,
    },
    gstTreatment: {
      propDefinition: [
        zohoBooks,
        "gstTreatment",
      ],
      optional: true,
    },
    gstNo: {
      propDefinition: [
        zohoBooks,
        "gstNo",
      ],
      optional: true,
    },
    estimateNumber: {
      type: "string",
      label: "Estimate Number",
      description: "Search estimates by estimate number.",
      optional: true,
    },
    referenceNumber: {
      type: "string",
      label: "Reference Number",
      description: "Search estimates by reference number.",
      optional: true,
    },
    date: {
      type: "string",
      label: "Date",
      description: "Search estimates by estimate date.",
      optional: true,
    },
    expiryDate: {
      type: "string",
      label: "Expiry Date",
      description: "The date of expiration of the estimates.",
      optional: true,
    },
    exchangeRate: {
      propDefinition: [
        zohoBooks,
        "exchangeRate",
      ],
      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,
    },
    customBody: {
      propDefinition: [
        zohoBooks,
        "customBody",
      ],
      optional: true,
    },
    customSubject: {
      propDefinition: [
        zohoBooks,
        "customSubject",
      ],
      optional: true,
    },
    salespersonName: {
      propDefinition: [
        zohoBooks,
        "salespersonName",
      ],
      optional: true,
    },
    customFields: {
      propDefinition: [
        zohoBooks,
        "customFields",
      ],
      description: "A list of Additional field objects for the payments. **Example: {\"index\": 1, \"value\": \"value\"}**",
      optional: true,
    },
    lineItems: {
      propDefinition: [
        zohoBooks,
        "lineItems",
      ],
      description: "A list of line items objects of an estimate. **Example: {\"item_id\": \"1352827000000156060\", \"name\": \"name\", \"description\": \"description\", \"quantity\": \"1\" }** [See the documentation](https://www.zoho.com/books/api/v3/sales-order/#create-a-sales-order) for further details.",
    },
    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,
    },
    taxId: {
      propDefinition: [
        zohoBooks,
        "taxId",
      ],
      description: "ID of the tax to be associated to the estimate.",
      optional: true,
    },
    taxExemptionId: {
      propDefinition: [
        zohoBooks,
        "taxExemptionId",
      ],
      optional: true,
    },
    taxAuthorityId: {
      propDefinition: [
        zohoBooks,
        "taxAuthorityId",
      ],
      optional: true,
    },
    avataxUseCode: {
      propDefinition: [
        zohoBooks,
        "avataxUseCode",
      ],
      optional: true,
    },
    avataxExemptNo: {
      propDefinition: [
        zohoBooks,
        "taxExemptionId",
      ],
      optional: true,
    },
    vatTreatment: {
      propDefinition: [
        zohoBooks,
        "vatTreatment",
      ],
      optional: true,
    },
    taxTreatment: {
      propDefinition: [
        zohoBooks,
        "taxTreatment",
      ],
      description: "VAT treatment for the estimate.",
      optional: true,
    },
    isReverseChargeApplied: {
      type: "boolean",
      label: "Is Reverse Charge Applied.",
      description: "Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.",
      optional: true,
    },
    itemId: {
      propDefinition: [
        zohoBooks,
        "itemId",
      ],
      optional: true,
    },
    lineItemId: {
      type: "string",
      label: "Line Item Id",
      description: "ID of the line item. Mandatory, if the existing line item has to be updated. If empty, a new line item will be created.",
      optional: true,
    },
    name: {
      type: "string",
      label: "Name",
      description: "Name of the line item.",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description of the line item.",
      optional: true,
    },
    rate: {
      type: "string",
      label: "Rate",
      description: "Rate of the line item.",
      optional: true,
    },
    unit: {
      type: "string",
      label: "Unit",
      description: "Unit of the line item. E.g. kgs, Nos",
      optional: true,
    },
    quantity: {
      type: "integer",
      label: "Quantity",
      description: "The quantity of line item.",
      optional: true,
    },
    projectId: {
      type: "string",
      label: "Project Id",
      description: "Id of the project",
      optional: true,
    },
    acceptRetainer: {
      type: "boolean",
      label: "Accept Retainer",
      description: "The \"Accept Retainer\" node should be passed for the retainer invoice to be created automatically, provided that the customer has accepted the quote.",
      optional: true,
    },
    retainerPercentage: {
      type: "integer",
      label: "Retainer Percentage",
      description: "Pass the \"Retainer Percentage\" node to create the retainer invoice automatically.",
      min: 1,
      max: 100,
      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.createEstimate({
      $,
      params: {
        send: this.send,
        ignore_auto_number_generation: this.ignoreAutoNumberGeneration,
      },
      data: {
        customer_id: this.customerId,
        currency_id: this.currencyId,
        contact_persons: parseObject(this.contactPersons),
        template_id: this.templateId,
        place_of_supply: this.placeOfSupply,
        gst_treatment: this.gstTreatment,
        gst_no: this.gstNo,
        estimate_number: this.estimateNumber,
        reference_number: this.referenceNumber,
        date: this.date,
        expiry_date: this.expiryDate,
        exchange_rate: this.exchangeRate && parseFloat(this.exchangeRate),
        discount: this.discount && parseFloat(this.discount),
        is_discount_before_tax: this.isDiscountBeforeTax,
        discount_type: this.discountType,
        is_inclusive_tax: this.isInclusiveTax,
        custom_body: this.customBody,
        custom_subject: this.customSubject,
        salesperson_name: this.salespersonName,
        custom_fields: parseObject(this.customFields),
        line_items: parseObject(this.lineItems),
        notes: this.notes,
        terms: this.terms,
        shipping_charge: this.shippingCharge,
        adjustment: this.adjustment && parseFloat(this.adjustment),
        adjustment_description: this.adjustmentDescription,
        tax_id: this.taxId,
        tax_exemption_id: this.taxExemptionId,
        tax_authority_id: this.taxAuthorityId,
        avatax_use_code: this.avataxUseCode,
        avatax_exempt_no: this.avataxExemptNo,
        vat_treatment: this.vatTreatment,
        tax_treatment: this.taxTreatment,
        is_reverse_charge_applied: this.isReverseChargeApplied,
        item_id: this.itemId,
        line_item_id: this.lineItemId,
        name: this.name,
        description: this.description,
        rate: this.rate && parseFloat(this.rate),
        unit: this.unit,
        quantity: this.quantity,
        project_id: this.projectId,
        accept_retainer: this.acceptRetainer,
        retainer_percentage: this.retainerPercentage,
      },
    });

    $.export("$summary", `Item successfully created with Id: ${response.estimate.estimate_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.
Currency Id	`currencyId`	`string`	Select a value from the drop down menu.
Contact Persons	`contactPersons`	`string[]`	Select a value from the drop down menu.
Template Id	`templateId`	`string`	ID of the PDF template.
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" }`
GST Treatment	`gstTreatment`	`string`	Select a value from the drop down menu:`business_gstbusiness_noneoverseasconsumer`
GST No	`gstNo`	`string`	15 digit GST identification number of the customer.
Estimate Number	`estimateNumber`	`string`	Search estimates by estimate number.
Reference Number	`referenceNumber`	`string`	Search estimates by reference number.
Date	`date`	`string`	Search estimates by estimate date.
Expiry Date	`expiryDate`	`string`	The date of expiration of the estimates.
Exchange Rate	`exchangeRate`	`string`	Exchange rate of the currency.
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.
Custom Body	`customBody`	`string`
Custom Subject	`customSubject`	`string`
Salesperson Name	`salespersonName`	`string`	Name of the sales person.
Custom Fields	`customFields`	`string[]`	A list of Additional field objects for the payments. Example: {"index": 1, "value": "value"}
Line Items	`lineItems`	`string[]`	A list of line items objects of an estimate. Example: {"item_id": "1352827000000156060", "name": "name", "description": "description", "quantity": "1" } See the documentation for further details.
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`
Tax Id	`taxId`	`string`	Select a value from the drop down menu.
Tax Exemption Id	`taxExemptionId`	`string`	Select a value from the drop down menu.
Tax Authority Id	`taxAuthorityId`	`string`	Select a value from the drop down menu.
Avatax Use Code	`avataxUseCode`	`string`	Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule.
Tax Exemption Id	`avataxExemptNo`	`string`	Select a value from the drop down menu.
VAT Treatment	`vatTreatment`	`string`	Enter vat treatment.
Tax Treatment	`taxTreatment`	`string`	Select a value from the drop down menu:`vat_registeredvat_not_registeredgcc_vat_not_registeredgcc_vat_registerednon_gccdz_vat_registereddz_vat_not_registeredhome_country_mexicoborder_region_mexiconon_mexicovat_registered` `vat_not_registered` `non_kenyavat_registeredvat_not_registeredoverseas`
Is Reverse Charge Applied.	`isReverseChargeApplied`	`boolean`	Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.
Item Id	`itemId`	`string`	Select a value from the drop down menu.
Line Item Id	`lineItemId`	`string`	ID of the line item. Mandatory, if the existing line item has to be updated. If empty, a new line item will be created.
Name	`name`	`string`	Name of the line item.
Description	`description`	`string`	Description of the line item.
Rate	`rate`	`string`	Rate of the line item.
Unit	`unit`	`string`	Unit of the line item. E.g. kgs, Nos
Quantity	`quantity`	`integer`	The quantity of line item.
Project Id	`projectId`	`string`	Id of the project
Accept Retainer	`acceptRetainer`	`boolean`	The "Accept Retainer" node should be passed for the retainer invoice to be created automatically, provided that the customer has accepted the quote.
Retainer Percentage	`retainerPercentage`	`integer`	Pass the "Retainer Percentage" node to create the retainer invoice automatically.
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