Create Purchase Order with QuickBooks API on Link Clicked from Mailchimp API

Pipedream makes it easy to connect APIs for QuickBooks, Mailchimp and 2,800+ other apps remarkably fast.

Trigger workflow on

Link Clicked from the Mailchimp API

Next, do this

Create Purchase Order 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 Mailchimp 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 Link Clicked trigger
1. Connect your Mailchimp account
2. Configure timer
3. Select a Campaign ID
4. Select a Campaign Link
5. Configure Unique Clicks Only?
Configure the Create Purchase Order action
1. Connect your QuickBooks account
2. Select a Account ID
3. Select a Vendor Reference
4. Optional- Configure Due Date
5. Optional- Select a Currency Code
6. Optional- Configure Document Number
7. Optional- Configure Shipping Street Address
8. Optional- Configure Shipping City
9. Optional- Configure Shipping State
10. Optional- Configure Shipping Zip
11. Optional- Configure Shipping Latitude
12. Optional- Configure Shipping Longitude
13. Optional- Configure Memo
14. 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#

Link Clicked on Mailchimp

Description:Emit new event when a recipient clicks a pre-specified link in an specific campaign.

Version:0.0.2

Key:mailchimp-link-clicked

View on GitHub

Mailchimp Overview#

The Mailchimp API taps into the heart of your email marketing efforts, allowing you to manage subscribers, campaigns, and reports. With the API, you can automate tasks like syncing subscriber lists, segmenting contacts based on behavior, and personalizing email content to match user profiles. It's a powerful tool for marketers looking to fine-tune their email strategy and maximize engagement.

Trigger Code#

import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "mailchimp-link-clicked",
  name: "Link Clicked",
  description: "Emit new event when a recipient clicks a pre-specified link in an specific campaign.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    campaignId: {
      propDefinition: [
        common.props.mailchimp,
        "campaignId",
      ],
      description: "The unique ID of the campaign you'd like to watch for new clicks on links",
    },
    linkId: {
      propDefinition: [
        common.props.mailchimp,
        "linkId",
        (c) => ({
          campaignId: c.campaignId,
        }),
      ],
    },
    uniqueClicksOnly: {
      type: "boolean",
      label: "Unique Clicks Only?",
      description: "Whether to count every link click or only count clicks coming from each user only once",
      default: false,
    },
  },
  hooks: {
    async deploy() {
      // Emits sample events on the first run during deploy.
      return this.emitReportSampleEvents(this.campaignId, this.linkId, (Date.now()));
    },
  },
  methods: {
    ...common.methods,
    getEventTypes() {
      return [
        "clicks",
      ];
    },
    generateMeta({
      eventPayload,
      diff: clickDiff,
      timestamp: ts,
    }) {
      const { id: linkId } = eventPayload;
      return {
        id: `${linkId}-${ts}`,
        summary: `${clickDiff} new clicks`,
        ts,
      };
    },
    getCachedCampaignDetails() {
      return this.getDbServiceVariable("recipientClicks");
    },
    async getCampaignDetails() {
      return this.mailchimp.getCampaignClickDetailsForLink(
        this.campaignId,
        this.linkId,
      );
    },
    getNodataErrorMessage() {
      return "No data found for specified campaign and link.";
    },
    getCurrentCampaignDetails(report) {
      return this.uniqueClicksOnly
        ? report.unique_clicks
        : report.total_clicks;
    },
    getDetailsDiff(currentRecipientClicks, recipientClicks) {
      return currentRecipientClicks - recipientClicks;
    },
    cacheCampaignDetails(currentRecipientClicks) {
      if (isNaN(currentRecipientClicks)) {
        if (this.uniqueClicksOnly) {
          this.setDbServiceVariable("recipientClicks", currentRecipientClicks.unique_clicks);
        } else {
          this.setDbServiceVariable("recipientClicks", currentRecipientClicks.total_clicks);
        }
      } else {
        this.setDbServiceVariable("recipientClicks", currentRecipientClicks);
      }
    },
    clearCampaignDetailsCache() {
      this.setDbServiceVariable("recipientClicks", 0);
    },
  },
  async run() {
    return this.emitReportEvents();
  },
};

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.
Mailchimp	`mailchimp`	`app`	This component uses the Mailchimp app.
	`timer`	`$.interface.timer`
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.
Campaign Link	`linkId`	`string`	Select a value from the drop down menu.
Unique Clicks Only?	`uniqueClicksOnly`	`boolean`	Whether to count every link click or only count clicks coming from each user only once

Trigger Authentication#

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

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

About Mailchimp#

Mailchimp is a marketing automation and email marketing platform.

Action#

Create Purchase Order on QuickBooks

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

Version:0.0.2

Key:quickbooks-create-purchase-order

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,
  buildPurchaseLineItems,
} from "../../common/utils.mjs";

export default {
  key: "quickbooks-create-purchase-order",
  name: "Create Purchase Order",
  description: "Creates a purchase order. [See the documentation](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/purchaseorder#create-a-purchaseorder)",
  version: "0.0.2",
  type: "action",
  props: {
    quickbooks,
    accountId: {
      type: "string",
      label: "Account ID",
      description: "The ID of the account to use for the purchase order",
      async options() {
        const { QueryResponse: queryResponse } = await this.quickbooks.query({
          params: {
            query: "select * from Account where Classification = 'Liability' AND AccountSubType = 'AccountsPayable'",
          },
        });
        return queryResponse.Account.map(({
          Id, Name,
        }) => ({
          value: Id,
          label: Name,
        }));
      },
    },
    vendorRefValue: {
      propDefinition: [
        quickbooks,
        "vendor",
      ],
    },
    dueDate: {
      type: "string",
      label: "Due Date",
      description: "Date when the purchase order is due (YYYY-MM-DD)",
      optional: true,
    },
    currencyRefValue: {
      propDefinition: [
        quickbooks,
        "currency",
      ],
    },
    docNumber: {
      type: "string",
      label: "Document Number",
      description: "Reference number for the transaction",
      optional: true,
    },
    shippingStreetAddress: {
      propDefinition: [
        quickbooks,
        "shippingStreetAddress",
      ],
    },
    shippingCity: {
      propDefinition: [
        quickbooks,
        "shippingCity",
      ],
    },
    shippingState: {
      propDefinition: [
        quickbooks,
        "shippingState",
      ],
    },
    shippingZip: {
      propDefinition: [
        quickbooks,
        "shippingZip",
      ],
    },
    shippingLatitude: {
      propDefinition: [
        quickbooks,
        "shippingLatitude",
      ],
    },
    shippingLongitude: {
      propDefinition: [
        quickbooks,
        "shippingLongitude",
      ],
    },
    memo: {
      type: "string",
      label: "Memo",
      description: "Memo or note for the purchase order",
      optional: true,
    },
    lineItemsAsObjects: {
      propDefinition: [
        quickbooks,
        "lineItemsAsObjects",
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.lineItemsAsObjects) {
      props.lineItems = {
        type: "string[]",
        label: "Line Items",
        description: "Line items of a purchase order. DetailType is `ItemBasedExpenseLineDetail`. Example: `{ \"DetailType\": \"ItemBasedExpenseLineDetail\", \"Amount\": 100.0, \"ItemBasedExpenseLineDetail\": { \"ItemRef\": { \"name\": \"Services\", \"value\": \"1\" } } }` [See the documentation](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/purchaseorder#create-a-purchaseorder) 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/Account ID`,
        options: async ({ page }) => {
          const options = await this.quickbooks.getPropOptions({
            page,
            resource: "Item",
            mapper: ({
              Id: value, Name: label, ExpenseAccountRef,
            }) => {
              if (ExpenseAccountRef) {
                return {
                  value,
                  label,
                };
              }
              return null;
            },
          });
          return options.filter((option) => option !== null);
        },
      };
      props[`amount_${i}`] = {
        type: "string",
        label: `Line ${i} - Amount`,
      };
      props[`quantity_${i}`] = {
        type: "string",
        label: `Line ${i} - Quantity`,
      };
    }
    return props;
  },
  methods: {
    buildLineItems() {
      return buildPurchaseLineItems(this.numLineItems, this);
    },
  },
  async run({ $ }) {
    if (!this.vendorRefValue) {
      throw new ConfigurationError("Vendor is required to create a purchase order.");
    }

    if (!this.numLineItems && !this.lineItemsAsObjects) {
      throw new ConfigurationError("At least one line item is required. Either specify the number of line items or provide line items as objects.");
    }

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

    if (!lines || lines.length === 0) {
      throw new ConfigurationError("No valid line items were provided.");
    }

    const hasShippingAddress = this.shippingStreetAddress
      || this.shippingCity
      || this.shippingState
      || this.shippingZip
      || this.shippingLatitude
      || this.shippingLongitude;

    const data = {
      Line: lines,
      VendorRef: {
        value: this.vendorRefValue,
      },
      DueDate: this.dueDate,
      DocNumber: this.docNumber,
      ShipAddr: hasShippingAddress
        ? {
          Line1: this.shippingStreetAddress,
          City: this.shippingCity,
          CountrySubDivisionCode: this.shippingState,
          PostalCode: this.shippingZip,
          Lat: this.shippingLatitude,
          Long: this.shippingLongitude,
        }
        : undefined,
      Memo: this.memo,
      APAccountRef: {
        value: this.accountId,
      },
    };

    if (this.currencyRefValue) {
      data.CurrencyRef = {
        value: this.currencyRefValue,
      };
    }

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

    if (response) {
      $.export("$summary", `Successfully created purchase order with ID ${response.PurchaseOrder.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.
Account ID	`accountId`	`string`	Select a value from the drop down menu.
Vendor Reference	`vendorRefValue`	`string`	Select a value from the drop down menu.
Due Date	`dueDate`	`string`	Date when the purchase order is due (YYYY-MM-DD)
Currency Code	`currencyRefValue`	`string`	Select a value from the drop down menu.
Document Number	`docNumber`	`string`	Reference number for the transaction
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
Memo	`memo`	`string`	Memo or note for the purchase order
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 Purchase Order with QuickBooks API on Link Clicked from Mailchimp API

Pipedream makes it easy to connect APIs for QuickBooks, Mailchimp and 2,800+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

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