Create Customer with Quickbooks Sandbox API on New Requests (Payload Only) from HTTP / Webhook API

Pipedream makes it easy to connect APIs for Quickbooks Sandbox, HTTP / Webhook and 1000+ other apps remarkably fast.

Trigger workflow on

New Requests (Payload Only) from the HTTP / Webhook API

Next, do this

Create Customer with the Quickbooks Sandbox API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a HTTP / Webhook 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 Requests (Payload Only) trigger
1. Connect your HTTP / Webhook account
Configure the Create Customer action
1. Connect your Quickbooks Sandbox account
2. Optional- Configure display_name
3. Optional- Configure title
4. Optional- Configure given_name
5. Optional- Configure middle_name
6. Optional- Configure family_name
7. Optional- Configure suffix
8. 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 Requests (Payload Only) on HTTP / Webhook

Description:Get a URL and emit the HTTP body as an event on every request

Version:0.1.1

Key:http-new-requests-payload-only

View on GitHub

Trigger Code#

import http from "../../http.app.mjs";

// Core HTTP component
// Returns a 200 OK response, emits the HTTP payload as an event
export default {
  key: "http-new-requests-payload-only",
  name: "New Requests (Payload Only)",
  // eslint-disable-next-line
  description: "Get a URL and emit the HTTP body as an event on every request",
  version: "0.1.1",
  type: "source",
  props: {
    // eslint-disable-next-line
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    http,
  },
  async run(event) {
    const { body } = event;
    this.httpInterface.respond({
      status: 200,
      body,
    });
    // Emit the HTTP payload
    this.$emit({
      body,
    });
  },
};

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	`httpInterface`	`$.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.
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Create Customer on Quickbooks Sandbox

Description:Creates a customer.

Version:0.1.1

Key:quickbooks_sandbox-create-customer

View on GitHub

Quickbooks Sandbox Overview#

QuickBooks Sandbox API provides a powerful and reliable platform to develop,
customize, and test applications related to accounting and finance. The API
allows developers to access a variety of features, such as:

Create, read, update and delete financial data.
Create and manage Invoices, Estimates, Orders, Payments and other objects.
Log in and manage customers, vendors, and suppliers.
Record and manage expenses, taxes, banking transactions and other financial
transactions.

With the Quickbooks Sandbox API, you can build the following applications:

A financial record-keeping and reporting app.
An expense manager and budget tracker.
A customer, vendor & supplier management system.
A payments & receipts processing application.
An invoicing & estimate management system.
An accounts receivable & payable system.
A multi-currency payment processing system.
A tax calculation and reporting tool.
A virtual banking application.
A dynamic accounting dashboard.

Action Code#

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

export default {
  key: "quickbooks_sandbox-create-customer",
  name: "Create Customer",
  description: "Creates a customer.",
  version: "0.1.1",
  type: "action",
  props: {
    quickbooks_sandbox: {
      type: "app",
      app: "quickbooks_sandbox",
    },
    display_name: {
      type: "string",
      description: "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`.",
      optional: true,
    },
    title: {
      type: "string",
      description: "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.",
      optional: true,
    },
    given_name: {
      type: "string",
      description: "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.",
      optional: true,
    },
    middle_name: {
      type: "string",
      description: "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.",
      optional: true,
    },
    family_name: {
      type: "string",
      description: "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.",
      optional: true,
    },
    suffix: {
      type: "string",
      description: "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.",
      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/customer#create-a-customer

    if (!this.display_name && (!this.title && !this.given_name && !this.middle_name && !this.family_name && !this.suffix)) {
      throw new Error("Must provide display_name or at least one of title, given_name, middle_name, family_name, or suffix parameters.");
    }

    return await axios($, {
      method: "post",
      url: `https://sandbox-quickbooks.api.intuit.com/v3/company/${this.quickbooks_sandbox.$auth.company_id}/customer`,
      headers: {
        "Authorization": `Bearer ${this.quickbooks_sandbox.$auth.oauth_access_token}`,
        "accept": "application/json",
        "content-type": "application/json",
      },
      data: {
        DisplayName: this.display_name,
        Suffix: this.suffix,
        Title: this.title,
        MiddleName: this.middle_name,
        FamilyName: this.family_name,
        GivenName: this.given_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.
display_name	`display_name`	`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	`given_name`	`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	`middle_name`	`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	`family_name`	`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.
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.accounting

About Quickbooks Sandbox#

Online accounting software