Create Bill Payment with Quickbooks Sandbox API on New Coupon Event (Instant) from WooCommerce API

Pipedream makes it easy to connect APIs for Quickbooks Sandbox, WooCommerce and 2,400+ other apps remarkably fast.

Trigger workflow on

New Coupon Event (Instant) from the WooCommerce API

Next, do this

Create Bill Payment with the Quickbooks Sandbox 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 WooCommerce trigger and Quickbooks Sandbox action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Coupon Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Create Bill Payment action
1. Connect your Quickbooks Sandbox account
2. Configure total_amt
3. Configure vendor_ref_value
4. Configure line
5. Select a pay_type
6. Optional- Configure vendor_ref_name
7. Optional- Configure currency_ref_value
8. Optional- Configure currency_ref_name
9. Optional- Configure cc_account_ref_value
10. Optional- Configure cc_account_ref_name
11. Optional- Configure bank_account_ref_value
12. Optional- Configure bank_account_ref_name
13. Optional- Configure minorversion
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 Coupon Event (Instant) on WooCommerce

Description:Emit new event each time the specified coupon event(s) occur

Version:0.0.3

Key:woocommerce-new-coupon-event

View on GitHub

WooCommerce Overview#

WooCommerce is a customizable, open-source eCommerce platform built on WordPress. With the WooCommerce API, you can tap into the heart of your eCommerce store to read, create, update, and delete products, orders, and customers. On Pipedream, you can harness this API to automate routine tasks, sync data across platforms, and enhance customer experiences. By connecting WooCommerce to a wide array of apps and services, you can streamline operations, trigger personalized marketing, and analyze your sales data with greater ease.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "woocommerce-new-coupon-event",
  name: "New Coupon Event (Instant)",
  description: "Emit new event each time the specified coupon event(s) occur",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ perPage }) {
      return this.woocommerce.listCoupons({
        per_page: perPage,
        orderby: "date",
      });
    },
    getTopic(topicType) {
      return `coupon.${topicType}`;
    },
    generateMeta(eventType, {
      id, date_modified: dateModified,
    }) {
      const ts = Date.parse(dateModified);
      return {
        id: `${id}${ts}`,
        summary: `Coupon ID: ${id} ${eventType}`,
        ts,
      };
    },
  },
};

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
WooCommerce	`woocommerce`	`app`	This component uses the WooCommerce app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Event topics	`topics`	`string[]`	Select a value from the drop down menu:`createdupdateddeleted`

Trigger Authentication#

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

Find your API key at WooCommerce > Settings > Advanced > REST API. See the WooCommerce docs for more info. Enter the Key and Secret below.

About WooCommerce#

WooCommerce is the open-source ecommerce platform for WordPress.

Action#

Create Bill Payment on Quickbooks Sandbox

Description:Creates a bill payment.

Version:0.1.1

Key:quickbooks_sandbox-create-payment

View on GitHub

Quickbooks Sandbox Overview#

QuickBooks Sandbox API provides a robust platform for developers to test QuickBooks Online integrations without affecting live data. With Pipedream, you can harness this API to automate various accounting tasks, simulate financial scenarios, or validate app behavior pre-deployment. Imagine syncing invoice statuses with your CRM, triggering alerts based on financial thresholds, or reconciling payments programmatically—all in a safe, isolated environment before going live.

Action Code#

// legacy_hash_id: a_l0i8d0
import { axios } from "@pipedream/platform";

export default {
  key: "quickbooks_sandbox-create-payment",
  name: "Create Bill Payment",
  description: "Creates a bill payment.",
  version: "0.1.1",
  type: "action",
  props: {
    quickbooks_sandbox: {
      type: "app",
      app: "quickbooks_sandbox",
    },
    total_amt: {
      type: "string",
      description: "Indicates the total amount of the associated with this payment. This includes the total of all the payments from the BillPayment Details.",
    },
    vendor_ref_value: {
      type: "string",
      description: "The id of the vendor reference for this transaction.",
    },
    line: {
      type: "any",
      description: "Individual line items representing zero or more `Bill`, `VendorCredit`, and `JournalEntry` objects linked to this BillPayment object.. Valid Line type for create: `LinkedTxnLine`.",
    },
    pay_type: {
      type: "string",
      description: "The payment type. Valid values include: `Check`, `CreditCard`",
      options: [
        "Check",
        "CreditCard",
      ],
    },
    vendor_ref_name: {
      type: "string",
      description: "The name of the vendor reference for this transaction.",
      optional: true,
    },
    currency_ref_value: {
      type: "string",
      description: "A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company.\nMulticurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support [here](https://developer.intuit.com/docs?RedirectID=MultCurrencies). Required if multicurrency is enabled for the company.",
      optional: true,
    },
    currency_ref_name: {
      type: "object",
      description: "The full name of the currency.",
      optional: true,
    },
    cc_account_ref_value: {
      type: "string",
      description: "The id of the credit card account reference. Required when `PayType` is `CreditCard`. Query the Account name list resource to determine the appropriate Account object for this reference. Use `Account.Id` from that object for `CCAccountRef.value`. The specified account must have `Account.AccountType` set to `Credit Card` and `Account.AccountSubType` set to `CreditCard`. Inject with data only if the payment was transacted through Intuit Payments API.",
      optional: true,
    },
    cc_account_ref_name: {
      type: "string",
      description: "The name of the credit card account reference. Query the Account name list resource to determine the appropriate Account object for this reference. Use `Account.Name` from that object for `CCAccountRef.name`. The specified account must have `Account.AccountType` set to `Credit Card` and `Account.AccountSubType` set to `CreditCard`. Inject with data only if the payment was transacted through Intuit Payments API.",
      optional: true,
    },
    bank_account_ref_value: {
      type: "string",
      description: "The id of the bank account reference. Required when `PayType` is `Check`. Query the Account name list resource to determine the appropriate Account object for this reference. Use `Account.Id` from that object for `APAccountRef.value`. The specified account must have `Account.AccountType` set to `Bank` and `Account.AccountSubType` set to `Checking`.",
      optional: true,
    },
    bank_account_ref_name: {
      type: "string",
      description: "The name of the bank account reference. Query the Account name list resource to determine the appropriate Account object for this reference. Use `Account.Name` from that object for `APAccountRef.name`. The specified account must have `Account.AccountType` set to `Bank` and `Account.AccountSubType` set to `Checking`.",
      optional: true,
    },
    minorversion: {
      type: "string",
      description: "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:\n`https://quickbooks.api.intuit.com/v3/company/<realmId>/journalentry/entityId?minorversion=1`",
      optional: true,
    },
  },
  async run({ $ }) {
  // See Quickbooks API docs at: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/billpayment#create-a-billpayment

    if (!this.total_amt || !this.vendor_ref_value || !this.line || !this.pay_type) {
      throw new Error("Must provide total_amt, and vendor_ref_value, line, and pay_type parameters.");
    }

    return await axios($, {
      method: "post",
      url: `https://sandbox-quickbooks.api.intuit.com/v3/company/${this.quickbooks_sandbox.$auth.company_id}/billpayment`,
      headers: {
        "Authorization": `Bearer ${this.quickbooks_sandbox.$auth.oauth_access_token}`,
        "accept": "application/json",
        "content-type": "application/json",
      },
      data: {
        TotalAmt: this.total_amt,
        VendorRef: {
          value: this.vendor_ref_value,
          name: this.vendor_ref_name,
        },
        Line: this.line,
        PayType: this.pay_type,
        CurrencyRef: {
          value: this.currency_ref_value,
          name: this.currency_ref_name,
        },
        CreditCardPayment: {
          CCAccountRef: {
            value: this.cc_account_ref_value,
            name: this.cc_account_ref_name,
          },
        },
        CheckPayment: {
          BankAccountRef: {
            value: this.bank_account_ref_value,
            name: this.bank_account_ref_name,
          },
        },
      },
      params: {
        minorversion: this.minorversion,
      },
    });
  },
};

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 Sandbox	`quickbooks_sandbox`	`app`	This component uses the Quickbooks Sandbox app.
total_amt	`total_amt`	`string`	Indicates the total amount of the associated with this payment. This includes the total of all the payments from the BillPayment Details.
vendor_ref_value	`vendor_ref_value`	`string`	The id of the vendor reference for this transaction.
line	`line`	`any`	Individual line items representing zero or more `Bill`, `VendorCredit`, and `JournalEntry` objects linked to this BillPayment object.. Valid Line type for create: `LinkedTxnLine`.
pay_type	`pay_type`	`string`	Select a value from the drop down menu:`CheckCreditCard`
vendor_ref_name	`vendor_ref_name`	`string`	The name of the vendor reference for this transaction.
currency_ref_value	`currency_ref_value`	`string`	A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support here. Required if multicurrency is enabled for the company.
currency_ref_name	`currency_ref_name`	`object`	The full name of the currency.
cc_account_ref_value	`cc_account_ref_value`	`string`	The id of the credit card account reference. Required when `PayType` is `CreditCard`. Query the Account name list resource to determine the appropriate Account object for this reference. Use `Account.Id` from that object for `CCAccountRef.value`. The specified account must have `Account.AccountType` set to `Credit Card` and `Account.AccountSubType` set to `CreditCard`. Inject with data only if the payment was transacted through Intuit Payments API.
cc_account_ref_name	`cc_account_ref_name`	`string`	The name of the credit card account reference. Query the Account name list resource to determine the appropriate Account object for this reference. Use `Account.Name` from that object for `CCAccountRef.name`. The specified account must have `Account.AccountType` set to `Credit Card` and `Account.AccountSubType` set to `CreditCard`. Inject with data only if the payment was transacted through Intuit Payments API.
bank_account_ref_value	`bank_account_ref_value`	`string`	The id of the bank account reference. Required when `PayType` is `Check`. Query the Account name list resource to determine the appropriate Account object for this reference. Use `Account.Id` from that object for `APAccountRef.value`. The specified account must have `Account.AccountType` set to `Bank` and `Account.AccountSubType` set to `Checking`.
bank_account_ref_name	`bank_account_ref_name`	`string`	The name of the bank account reference. Query the Account name list resource to determine the appropriate Account object for this reference. Use `Account.Name` from that object for `APAccountRef.name`. The specified account must have `Account.AccountType` set to `Bank` and `Account.AccountSubType` set to `Checking`.
minorversion	`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 Sandbox uses OAuth authentication. When you connect your Quickbooks Sandbox account, Pipedream will open a popup window where you can sign into Quickbooks Sandbox 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 Sandbox API.

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

com.intuit.quickbooks.accountingopenidprofileemail