Update Customer with Quickbooks Sandbox API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Update Customer 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 Pipedream 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 Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Update Customer action
1. Connect your Quickbooks Sandbox account
2. Select a Customer Reference
3. Optional- Configure Display Name
4. Optional- Configure Title
5. Optional- Configure Given Name
6. Optional- Configure Middle Name
7. Optional- Configure Family Name
8. Optional- Configure Suffix
9. Optional- Select a Currency Code
10. Optional- Configure Active
11. Optional- Configure Alternate Phone Free Form Number
12. Optional- Select a AR Account Ref Value
13. Optional- Configure Bill Addr City
14. Optional- Configure Bill Addr Country
15. Optional- Configure Bill Addr Country Sub Division Code
16. Optional- Configure Bill Addr Late
17. Optional- Configure Bill Addr Line 1
18. Optional- Configure Bill Addr Line 2
19. Optional- Configure Bill Addr Line 3
20. Optional- Configure Bill Addr Line 4
21. Optional- Configure Bill Addr Line 5
22. Optional- Configure Bill Addr Long
23. Optional- Configure Bill Addr Postal Code
24. Optional- Configure Bill With Parent
25. Optional- Configure Business Number
26. Optional- Configure Company Name
27. Optional- Select a Customer Type
28. Optional- Configure Default Tax Code Value
29. Optional- Configure Fax Free Form Number
30. Optional- Configure G S T I N
31. Optional- Select a Gst Registration Type
32. Optional- Configure Job
33. Optional- Configure Mobile Free Form Number
34. Optional- Configure Notes
35. Optional- Select a Payment Method
36. Optional- Select a Preferred Delivery Method
37. Optional- Configure Primary Email Addr
38. Optional- Configure Primary Phone Free Form Number
39. Optional- Configure Primary Tax Identifier
40. Optional- Configure Print On Check Name
41. Optional- Configure Resale Num
42. Optional- Select a Term IDs
43. Optional- Configure Secondary Tax Identifier
44. Optional- Configure Ship Addr City
45. Optional- Configure Ship Addr Country
46. Optional- Configure Ship Addr Country Sub Division Code
47. Optional- Configure Ship Addr Id
48. Optional- Configure Ship Addr Late
49. Optional- Configure Ship Addr Line 1
50. Optional- Configure Ship Addr Line 2
51. Optional- Configure Ship Addr Line 3
52. Optional- Configure Ship Addr Line 4
53. Optional- Configure Ship Addr Line 5
54. Optional- Configure Ship Addr Long
55. Optional- Configure Ship Addr Postal Code
56. Optional- Configure Taxable
57. Optional- Select a Tax Exemption Reason Id
58. Optional- Configure Web Addr
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

Update Customer on Quickbooks Sandbox

Description:Updates a customer. [See the documentation](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/customer#full-update-a-customer)

Version:0.0.1

Key:quickbooks_sandbox-update-customer

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#

import app from "../../quickbooks_sandbox.app.mjs";
import common from "../../../quickbooks/actions/update-customer/update-customer.mjs";

import { adjustPropDefinitions } from "../../common/utils.mjs";

const {
  name, description, type, ...others
} = common;
const props = adjustPropDefinitions(others.props, app);

export default {
  ...others,
  key: "quickbooks_sandbox-update-customer",
  version: "0.0.1",
  name,
  description,
  type,
  props: {
    quickbooks: app,
    ...props,
  },
};

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`	`app`	This component uses the Quickbooks Sandbox app.
Customer Reference	`customerId`	`string`	Select a value from the drop down menu.
Display Name	`displayName`	`string`	The name of the person or organization as displayed. Must be unique across all Customer, Vendor, and Employee objects. Cannot be removed with sparse update. If not supplied, the system generates DisplayName by concatenating customer name components supplied in the request from the following list: `Title`, `GivenName`, `MiddleName`, `FamilyName`, and `Suffix`.
Title	`title`	`string`	Title of the person. This tag supports i18n, all locales. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, `Suffix`, or `FullyQualifiedName` attributes are required during create.
Given Name	`givenName`	`string`	Given name or first name of a person. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, or `Suffix` attributes is required for object create.
Middle Name	`middleName`	`string`	Middle name of the person. The person can have zero or more middle names. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, or `Suffix` attributes is required for object create.
Family Name	`familyName`	`string`	Family name or the last name of the person. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, or `Suffix` attributes is required for object create.
Suffix	`suffix`	`string`	Suffix of the name. For example, `Jr`. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, or `Suffix` attributes is required for object create.
Currency Code	`currencyRefValue`	`string`	Select a value from the drop down menu.
Active	`active`	`boolean`	If true, this entity is currently enabled for use by QuickBooks. If there is an amount in `Customer.Balance` when setting this Customer object to inactive through the QuickBooks UI, a CreditMemo balancing transaction is created for the amount.
Alternate Phone Free Form Number	`alternatePhoneFreeFormNumber`	`string`	Specifies the alternate phone number in free form.
AR Account Ref Value	`arAccountRefValue`	`string`	Select a value from the drop down menu.
Bill Addr City	`billAddrCity`	`string`	City name for the billing address.
Bill Addr Country	`billAddrCountry`	`string`	Country name. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country.
Bill Addr Country Sub Division Code	`billAddrCountrySubDivisionCode`	`string`	Region within a country for the billing address. For example, state name for USA, province name for Canada.
Bill Addr Late	`billAddrLate`	`string`	Latitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.
Bill Addr Line 1	`billAddrLine1`	`string`	First line of the billing address.
Bill Addr Line 2	`billAddrLine2`	`string`	Second line of the billing address.
Bill Addr Line 3	`billAddrLine3`	`string`	Third line of the billing address.
Bill Addr Line 4	`billAddrLine4`	`string`	Fourth line of the billing address.
Bill Addr Line 5	`billAddrLine5`	`string`	Fifth line of the billing address.
Bill Addr Long	`billAddrLong`	`string`	Longitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.
Bill Addr Postal Code	`billAddrPostalCode`	`string`	Postal code for the billing address. For example, zip code for USA and Canada.
Bill With Parent	`billWithParent`	`boolean`	If true, this Customer object is billed with its parent. If false, or null the customer is not to be billed with its parent. This attribute is valid only if this entity is a Job or sub Customer.
Business Number	`businessNumber`	`string`	Also called, PAN (in India) is a code that acts as an identification for individuals, families and corporates, especially for those who pay taxes on their income.
Company Name	`companyName`	`string`	The name of the company associated with the person or organization.
Customer Type	`customerTypeRefValue`	`string`	Select a value from the drop down menu.
Default Tax Code Value	`defaultTaxCodeValue`	`string`	ID of the default tax code associated with this Customer object. Reference is valid if `Customer.Taxable` is set to true; otherwise, it is ignored. If automated sales tax is enabled (`Preferences.TaxPrefs.PartnerTaxEnabled` is set to true) the default tax code is set by the system and can not be overridden. Query the `TaxCode` name list resource to determine the appropriate `TaxCode` object for this reference. Use `TaxCode.Id` from that object for `DefaultTaxCodeRef.value`.
Fax Free Form Number	`faxFreeFormNumber`	`string`	Specifies the fax number in free form.
G S T I N	`GSTIN`	`string`	GSTIN is an identification number assigned to every GST registered business.
Gst Registration Type	`gstRegistrationType`	`string`	Select a value from the drop down menu:`GST_REG_REGGST_REG_COMPGST_UNREGCONSUMEROVERSEASSEZDEEMED`
Job	`job`	`boolean`	If true, this is a Job or sub-customer. If false or null, this is a top level customer, not a Job or sub-customer.
Mobile Free Form Number	`mobileFreeFormNumber`	`string`	Specifies the mobile phone number in free form.
Notes	`notes`	`string`	Free form text describing the Customer.
Payment Method	`paymentMethodRefValue`	`string`	Select a value from the drop down menu.
Preferred Delivery Method	`preferredDeliveryMethod`	`string`	Select a value from the drop down menu:`PrintEmailNone`
Primary Email Addr	`primaryEmailAddr`	`string`	Primary email address.
Primary Phone Free Form Number	`primaryPhoneFreeFormNumber`	`string`	Specifies the primary phone number in free form.
Primary Tax Identifier	`primaryTaxIdentifier`	`string`	Also called Tax Reg. No in ( UK ) , ( CA ) , ( IN ) , ( AU ) represents the tax ID of the Person or Organization. This value is masked in responses, exposing only last five characters. For example, the ID of `123-45-6789` is returned as `XXXXXX56789`.
Print On Check Name	`printOnCheckName`	`string`	Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName. Constraints: Cannot be removed with sparse update.
Resale Num	`resaleNum`	`string`	Resale number or some additional info about the customer.
Term IDs	`saleTermRefValue`	`string`	Select a value from the drop down menu.
Secondary Tax Identifier	`secondaryTaxIdentifier`	`string`	Also called UTR No. in ( UK ) , CST Reg No. ( IN ) also represents the tax registration number of the Person or Organization. This value is masked in responses, exposing only last five characters. For example, the ID of `123-45-6789` is returned as `XXXXXX56789`
Ship Addr City	`shipAddrCity`	`string`	City name for the shipping address.
Ship Addr Country	`shipAddrCountry`	`string`	Country name. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country.
Ship Addr Country Sub Division Code	`shipAddrCountrySubDivisionCode`	`string`	Region within a country for the shipping address. For example, state name for USA, province name for Canada.
Ship Addr Id	`shipAddrId`	`string`	Unique identifier of the QuickBooks object for the shipping address, used for modifying the address. The ShippingAddr object represents the default shipping address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: `Line1` and `Line2` elements are populated with the customer name and company name. Original `Line1` through `Line5` contents, `City`, `SubDivisionCode`, and `PostalCode` flow into `Line3` through `Line5` as a free format strings.
Ship Addr Late	`shipAddrLate`	`string`	Latitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.
Ship Addr Line 1	`shipAddrLine1`	`string`	First line of the shipping address.
Ship Addr Line 2	`shipAddrLine2`	`string`	Second line of the shipping address.
Ship Addr Line 3	`shipAddrLine3`	`string`	Third line of the shipping address.
Ship Addr Line 4	`shipAddrLine4`	`string`	Fourth line of the shipping address.
Ship Addr Line 5	`shipAddrLine5`	`string`	Fifth line of the shipping address.
Ship Addr Long	`shipAddrLong`	`string`	Longitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.
Ship Addr Postal Code	`shipAddrPostalCode`	`string`	Postal code for the shipping address. For example, zip code for USA and Canada.
Taxable	`taxable`	`boolean`	If true, transactions for this customer are taxable. Default behavior with minor version 10 and above: true, if `DefaultTaxCodeRef` is defined or false if `TaxExemptionReasonId` is set.
Tax Exemption Reason Id	`taxExemptionReasonId`	`string`	Select a value from the drop down menu:`123456789101112131415`
Web Addr	`webAddr`	`string`	Website address.

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

About Quickbooks Sandbox#

Online accounting software

More Ways to Connect Quickbooks Sandbox + Pipedream#

Other Popular Integrations#

Create Customer with Quickbooks Sandbox API on New Scheduled Tasks (Alpha) from Pipedream API

Pipedream + Quickbooks Sandbox

Update Customer with Quickbooks Sandbox API on New Scheduled Tasks from Pipedream API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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