Create Estimate with QuickBooks API on New Lead Created from Vtiger CRM API

Pipedream makes it easy to connect APIs for QuickBooks, Vtiger CRM and 2,900+ other apps remarkably fast.

Trigger workflow on

New Lead Created from the Vtiger CRM API

Next, do this

Create Estimate with the QuickBooks 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 Vtiger CRM trigger and QuickBooks action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Lead Created trigger
1. Connect your Vtiger CRM account
2. Configure timer
Configure the Create Estimate action
1. Connect your QuickBooks account
2. Select a Customer Reference
3. Optional- Configure Bill Email
4. Optional- Configure Expiration Date
5. Optional- Configure Accepted By
6. Optional- Configure Accepted Date
7. Optional- Select a Currency Code
8. Optional- Configure Document Number
9. Optional- Configure Billing Street Address
10. Optional- Configure Billing City
11. Optional- Configure Billing State
12. Optional- Configure Billing Zip
13. Optional- Configure Billing Latitude
14. Optional- Configure Billing Longitude
15. Optional- Configure Shipping Street Address
16. Optional- Configure Shipping City
17. Optional- Configure Shipping State
18. Optional- Configure Shipping Zip
19. Optional- Configure Shipping Latitude
20. Optional- Configure Shipping Longitude
21. Optional- Configure Private Note
22. Optional- Configure Customer Memo
23. Optional- Select a Tax Code ID
24. Configure Enter Line Items as Objects
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 Lead Created on Vtiger CRM

Description:Emit new event when a new lead is created in VTiger CRM.

Version:0.0.1

Key:vtiger_crm-new-lead-created

View on GitHub

Vtiger CRM Overview#

The Vtiger CRM API lets you tap into your customer relationship data to create, read, update, and delete records across various entities such as contacts, leads, and opportunities. In Pipedream, you can leverage this API to automate workflows, sync data across platforms, and react to events in real-time, all without the need for dedicated backend code. You can create dynamic workflows that respond to webhooks, schedule tasks, and integrate with 1000+ apps readily available on Pipedream.

Trigger Code#

import base from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...base,
  key: "vtiger_crm-new-lead-created",
  name: "New Lead Created",
  description: "Emit new event when a new lead is created in VTiger CRM.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...base.methods,
    async getResources(modifiedTime) {
      const { result: { updated: leads } } = await this.vtiger.getSync({
        params: {
          modifiedTime,
          elementType: "Leads",
          syncType: "user",
        },
      });
      return leads;
    },
    getTsField() {
      return "createdtime";
    },
    generateMeta(lead) {
      return {
        id: lead.id,
        summary: `New Lead with ID ${lead.id}`,
        ts: Date.parse(lead.createdtime),
      };
    },
  },
  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
Vtiger CRM	`vtiger`	`app`	This component uses the Vtiger CRM app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

To retrieve your Access Key,

Navigate to your Vtiger CRM account and sign in
Click the dropdown on the to right
Go to “My Preferences”

Your instance is 1234.abc if your Vtiger CRM dashboard URL is https://1234.abc.vtiger.com/
Enter the email address you use to log into VTiger CRM as the username

About Vtiger CRM#

Vtiger all-in-one CRM empowers you to align your marketing, sales and support teams with unified customer data powered by One View

Action#

Create Estimate on QuickBooks

Description:Creates an estimate. [See the documentation](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/estimate#create-an-estimate)

Version:0.0.4

Key:quickbooks-create-estimate

View on GitHub

QuickBooks Overview#

The QuickBooks API allows for streamlined financial management within Pipedream's ecosystem, enabling automated accounting and data syncing across various platforms. With this API, you can manipulate invoices, manage sales receipts, handle expenses, and synchronize customer data. It's a robust tool for financial oversight and automation that can save time and reduce errors for businesses of all sizes.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import quickbooks from "../../quickbooks.app.mjs";
import {
  parseLineItems,
  buildSalesLineItems,
} from "../../common/utils.mjs";

export default {
  key: "quickbooks-create-estimate",
  name: "Create Estimate",
  description: "Creates an estimate. [See the documentation](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/estimate#create-an-estimate)",
  version: "0.0.4",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    quickbooks,
    customerRefValue: {
      propDefinition: [
        quickbooks,
        "customer",
      ],
    },
    billEmail: {
      type: "string",
      label: "Bill Email",
      description: "Email address where the estimate should be sent",
      optional: true,
    },
    expirationDate: {
      type: "string",
      label: "Expiration Date",
      description: "Date when the estimate expires (YYYY-MM-DD)",
      optional: true,
    },
    acceptedBy: {
      type: "string",
      label: "Accepted By",
      description: "Name of the customer who accepted the estimate",
      optional: true,
    },
    acceptedDate: {
      type: "string",
      label: "Accepted Date",
      description: "Date when the estimate was accepted (YYYY-MM-DD)",
      optional: true,
    },
    currencyRefValue: {
      propDefinition: [
        quickbooks,
        "currency",
      ],
      optional: true,
    },
    docNumber: {
      type: "string",
      label: "Document Number",
      description: "Reference number for the transaction",
      optional: true,
    },
    billingStreetAddress: {
      propDefinition: [
        quickbooks,
        "billingStreetAddress",
      ],
    },
    billingCity: {
      propDefinition: [
        quickbooks,
        "billingCity",
      ],
    },
    billingState: {
      propDefinition: [
        quickbooks,
        "billingState",
      ],
    },
    billingZip: {
      propDefinition: [
        quickbooks,
        "billingZip",
      ],
    },
    billingLatitude: {
      propDefinition: [
        quickbooks,
        "billingLatitude",
      ],
    },
    billingLongitude: {
      propDefinition: [
        quickbooks,
        "billingLongitude",
      ],
    },
    shippingStreetAddress: {
      propDefinition: [
        quickbooks,
        "shippingStreetAddress",
      ],
    },
    shippingCity: {
      propDefinition: [
        quickbooks,
        "shippingCity",
      ],
    },
    shippingState: {
      propDefinition: [
        quickbooks,
        "shippingState",
      ],
    },
    shippingZip: {
      propDefinition: [
        quickbooks,
        "shippingZip",
      ],
    },
    shippingLatitude: {
      propDefinition: [
        quickbooks,
        "shippingLatitude",
      ],
    },
    shippingLongitude: {
      propDefinition: [
        quickbooks,
        "shippingLongitude",
      ],
    },
    privateNote: {
      type: "string",
      label: "Private Note",
      description: "Private note for internal use",
      optional: true,
    },
    customerMemo: {
      type: "string",
      label: "Customer Memo",
      description: "Memo visible to customer",
      optional: true,
    },
    taxCodeId: {
      propDefinition: [
        quickbooks,
        "taxCodeId",
      ],
    },
    lineItemsAsObjects: {
      propDefinition: [
        quickbooks,
        "lineItemsAsObjects",
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.lineItemsAsObjects) {
      props.lineItems = {
        type: "string[]",
        label: "Line Items",
        description: "Line items of an estimate. Set DetailType to `SalesItemLineDetail`, `GroupLineDetail`, or `DescriptionOnly`. Example: `{ \"DetailType\": \"SalesItemLineDetail\", \"Amount\": 100.0, \"SalesItemLineDetail\": { \"ItemRef\": { \"name\": \"Services\", \"value\": \"1\" } } }` [See the documentation](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/estimate#create-an-estimate) for more information.",
      };
      return props;
    }
    props.numLineItems = {
      type: "integer",
      label: "Number of Line Items",
      description: "The number of line items to enter",
      reloadProps: true,
    };
    if (!this.numLineItems) {
      return props;
    }
    for (let i = 1; i <= this.numLineItems; i++) {
      props[`item_${i}`] = {
        type: "string",
        label: `Line ${i} - Item ID`,
        options: async ({ page }) => {
          return this.quickbooks.getPropOptions({
            page,
            resource: "Item",
            mapper: ({
              Id: value, Name: label,
            }) => ({
              value,
              label,
            }),
          });
        },
      };
      props[`amount_${i}`] = {
        type: "string",
        label: `Line ${i} - Amount`,
      };
    }
    return props;
  },
  methods: {
    buildLineItems() {
      return buildSalesLineItems(this.numLineItems, this);
    },
  },
  async run({ $ }) {
    if ((!this.numLineItems && !this.lineItemsAsObjects) || !this.customerRefValue) {
      throw new ConfigurationError("Must provide lineItems and customerRefValue parameters.");
    }

    const lines = this.lineItemsAsObjects
      ? parseLineItems(this.lineItems)
      : this.buildLineItems();

    lines.forEach((line, index) => {
      if (line.DetailType !== "SalesItemLineDetail" && line.DetailType !== "GroupLineDetail" && line.DetailType !== "DescriptionOnly") {
        throw new ConfigurationError(`Line Item at index ${index + 1} has invalid DetailType '${line.DetailType}'. Must be 'SalesItemLineDetail', 'GroupLineDetail', or 'DescriptionOnly'`);
      }
    });

    const hasBillingAddress = this.billingStreetAddress
      || this.billingCity
      || this.billingState
      || this.billingZip
      || this.billingLatitude
      || this.billingLongitude;
    const hasShippingAddress = this.shippingStreetAddress
      || this.shippingCity
      || this.shippingState
      || this.shippingZip
      || this.shippingLatitude
      || this.shippingLongitude;

    const params = {};
    const data = {
      Line: lines,
      CustomerRef: {
        value: this.customerRefValue,
      },
      ExpirationDate: this.expirationDate,
      AcceptedBy: this.acceptedBy,
      AcceptedDate: this.acceptedDate,
      DocNumber: this.docNumber,
      BillAddr: hasBillingAddress
        ? {
          Line1: this.billingStreetAddress,
          City: this.billingCity,
          CountrySubDivisionCode: this.billingState,
          PostalCode: this.billingZip,
          Lat: this.billingLatitude,
          Long: this.billingLongitude,
        }
        : undefined,
      ShipAddr: hasShippingAddress
        ? {
          Line1: this.shippingStreetAddress,
          City: this.shippingCity,
          CountrySubDivisionCode: this.shippingState,
          PostalCode: this.shippingZip,
          Lat: this.shippingLatitude,
          Long: this.shippingLongitude,
        }
        : undefined,
      PrivateNote: this.privateNote,
    };

    if (this.billEmail) {
      params.include = "estimateLink";
      data.BillEmail = {
        Address: this.billEmail,
      };
    }
    if (this.currencyRefValue) {
      data.CurrencyRef = {
        value: this.currencyRefValue,
      };
    }
    if (this.customerMemo) {
      data.CustomerMemo = {
        value: this.customerMemo,
      };
    }

    const response = await this.quickbooks.createEstimate({
      $,
      params,
      data,
    });

    if (response) {
      $.export("$summary", `Successfully created estimate with ID ${response.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
QuickBooks	`quickbooks`	`app`	This component uses the QuickBooks app.
Customer Reference	`customerRefValue`	`string`	Select a value from the drop down menu.
Bill Email	`billEmail`	`string`	Email address where the estimate should be sent
Expiration Date	`expirationDate`	`string`	Date when the estimate expires (YYYY-MM-DD)
Accepted By	`acceptedBy`	`string`	Name of the customer who accepted the estimate
Accepted Date	`acceptedDate`	`string`	Date when the estimate was accepted (YYYY-MM-DD)
Currency Code	`currencyRefValue`	`string`	Select a value from the drop down menu.
Document Number	`docNumber`	`string`	Reference number for the transaction
Billing Street Address	`billingStreetAddress`	`string`	The street address of the billing address
Billing City	`billingCity`	`string`	The city of the billing address
Billing State	`billingState`	`string`	The state of the billing address
Billing Zip	`billingZip`	`string`	The zip code of the billing address
Billing Latitude	`billingLatitude`	`string`	The latitude of the billing address
Billing Longitude	`billingLongitude`	`string`	The longitude of the billing address
Shipping Street Address	`shippingStreetAddress`	`string`	The street address of the shipping address
Shipping City	`shippingCity`	`string`	The city of the shipping address
Shipping State	`shippingState`	`string`	The state of the shipping address
Shipping Zip	`shippingZip`	`string`	The zip code of the shipping address
Shipping Latitude	`shippingLatitude`	`string`	The latitude of the shipping address
Shipping Longitude	`shippingLongitude`	`string`	The longitude of the shipping address
Private Note	`privateNote`	`string`	Private note for internal use
Customer Memo	`customerMemo`	`string`	Memo visible to customer
Tax Code ID	`taxCodeId`	`string`	Select a value from the drop down menu.
Enter Line Items as Objects	`lineItemsAsObjects`	`boolean`	Enter line items as an array of objects

Action Authentication#

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

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

com.intuit.quickbooks.accountingopenidprofileemail

Create Estimate with QuickBooks API on New Lead Created from Vtiger CRM API

Pipedream makes it easy to connect APIs for QuickBooks, Vtiger CRM and 2,900+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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