Create Customer with Quickbooks Sandbox API

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

Trigger workflow on

HTTP requests, schedules and app events

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#

Create a workflow to Create Customer with the Quickbooks Sandbox API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

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

HTTP / Webhook + Quickbooks Sandbox

Try it

Create Customer with Quickbooks Sandbox API on New Item in Feed from RSS API

RSS + Quickbooks Sandbox

Try it

Create Customer with Quickbooks Sandbox API on New Message from Discord API

Discord + Quickbooks Sandbox

Try it

Create Customer with Quickbooks Sandbox API on New Message In Channels from Slack API

Slack + Quickbooks Sandbox

Try it

Create Customer with Quickbooks Sandbox API on New Message in Channel from Discord Bot API

Discord Bot + Quickbooks Sandbox

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Create Customer on Quickbooks Sandbox

Description:Creates a customer.

Version:0.1.1

Key:quickbooks_sandbox-create-customer

View on GitHub

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,
      },
    });
  },
};

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
Quickbooks Sandbox	`quickbooks_sandbox`	`app`	This component uses the Quickbooks Sandbox app.
	`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`	`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`	`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`	`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`	`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`	`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`	`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`

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