Search Invoices with QuickBooks API on New SMS Message Received from Bird API

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

Trigger workflow on

New SMS Message Received from the Bird API

Next, do this

Search Invoices 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 Bird 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 SMS Message Received trigger
1. Connect your Bird account
2. Configure timer
Configure the Search Invoices action
1. Connect your QuickBooks account
2. Configure Include Clause
3. Optional- Configure Max Results
4. Optional- Configure Order Clause
5. Optional- Configure Start Position
6. Configure Where Clause
7. Optional- Configure Minor Version
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 SMS Message Received on Bird

Description:Emit new event when a new SMS message is received. [See the documentation](https://developers.messagebird.com/api/sms-messaging/#list-messages)

Version:0.0.1

Key:message_bird-new-sms-message-received

View on GitHub

Bird Overview#

Message Bird is a communications platform offering a suite of API solutions for sending messages, making voice calls, and conducting video conferences. With Pipedream, you can harness these capabilities to automate personalized notifications, streamline customer support, and facilitate global communication workflows. Message Bird's API on Pipedream allows you to send real-time alerts, trigger voice messages based on customer actions, and integrate with other services to create powerful, multi-channel communication systems.

Trigger Code#

import messagebird from "../../message_bird.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "message_bird-new-sms-message-received",
  name: "New SMS Message Received",
  description: "Emit new event when a new SMS message is received. [See the documentation](https://developers.messagebird.com/api/sms-messaging/#list-messages)",
  version: "0.0.1",
  dedupe: "unique",
  type: "source",
  props: {
    messagebird,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    _getLastTs() {
      return this.db.get("lastTs");
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    generateMeta(message) {
      return {
        id: message.id,
        summary: `New Message ID: ${message.id}`,
        ts: Date.parse(message.createdDatetime),
      };
    },
  },
  async run() {
    let lastTs = this._getLastTs();

    const { items } = await this.messagebird.listSMSMessages({
      params: {
        direction: "mo", // mt = sent, mo = received
        type: "sms",
        from: lastTs,
      },
    });

    if (!items?.length) {
      return;
    }

    for (const message of items) {
      const meta = this.generateMeta(message);
      this.$emit(message, meta);

      if (!lastTs || Date.parse(message.createdDatetime) > Date.parse(lastTs)) {
        lastTs = message.createdDatetime;
      }
    }

    this._setLastTs(lastTs);
  },
};

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

Trigger Authentication#

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

Once you sign in, the API key information are available in the Developer Settings, which is shown as Manage API Keys in the middle right of the Dashboard

About Bird#

Business in a box. Grow, Manage, Automate your company. Everything you need in one app.

Action#

Search Invoices on QuickBooks

Description:Searches for invoices. [See docs here](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/invoice#query-an-invoice)

Version:0.1.6

Key:quickbooks-sandbox-search-invoices

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";

export default {
  key: "quickbooks-sandbox-search-invoices",
  name: "Search Invoices",
  description: "Searches for invoices. [See docs here](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/invoice#query-an-invoice)",
  version: "0.1.6",
  type: "action",
  props: {
    quickbooks,
    includeClause: {
      propDefinition: [
        quickbooks,
        "includeClause",
      ],
      optional: false,
    },
    maxResults: {
      propDefinition: [
        quickbooks,
        "maxResults",
      ],
    },
    orderClause: {
      propDefinition: [
        quickbooks,
        "orderClause",
      ],
    },
    startPosition: {
      description: "The starting count of the response for pagination.",
      label: "Start Position",
      optional: true,
      type: "string",
    },
    whereClause: {
      propDefinition: [
        quickbooks,
        "whereClause",
      ],
      optional: false,
    },
    minorVersion: {
      propDefinition: [
        quickbooks,
        "minorVersion",
      ],
    },
  },
  async run({ $ }) {
    if (!this.includeClause || !this.whereClause) {
      throw new ConfigurationError("Must provide includeClause, whereClause parameters.");
    }

    //Prepares OrderBy clause,start position, max results
    // parameters to be used in the request's query parameter.
    var orderClause = "";
    if (this.orderClause) {
      orderClause = ` ORDERBY  ${this.orderClause}`;
    }

    var startPosition = "";
    if (this.startPosition) {
      startPosition = ` STARTPOSITION  ${this.startPosition}`;
    }

    var maxResults = "";
    if (this.maxResults) {
      maxResults = ` MAXRESULTS ${this.maxResults}` || "";
    }

    //Prepares the request's query parameter
    const query = `select ${this.includeClause} from Invoice where ${this.whereClause}${orderClause}${startPosition}${maxResults}`;

    const response = await this.quickbooks.query({
      $,
      params: {
        minorversion: this.minorVersion,
        query,
      },
    });

    if (response) {
      $.export("summary", "Successfully retrieved invoices");
    }

    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.
Include Clause	`includeClause`	`string`	Fields to use in the select clause of the data query. See query language syntax, limitations, and other specifications on Data queries
Max Results	`maxResults`	`string`	The number of entity elements in the response.
Order Clause	`orderClause`	`string`	The `orderClause` is for sorting the result. Include the property to sort by. The default sort order is ascending; to indicate descending sort order, include DESC, for example: `Name DESC`
Start Position	`startPosition`	`string`	The starting count of the response for pagination.
Where Clause	`whereClause`	`string`	Filters to use in the where clause of the data query. Note: Multiple clauses (filters) are AND'd. The OR operation is not supported.
Minor Version	`minorVersion`	`string`	Use the `minorversion` query parameter in REST API requests to access a version of the API other than the generally available version. For example, to invoke minor version 1 of the JournalEntry entity, issue the following request: `https://quickbooks.api.intuit.com/v3/company/<realmId>/journalentry/entityId?minorversion=1`

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

Search Invoices with QuickBooks API on New SMS Message Received from Bird API

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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