← Quickbooks

Get Customer with Quickbooks API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Get Customer with the Quickbooks API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

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

  1. Configure the Get Customer action
    1. Connect your Quickbooks account
    2. Configure customer_id
    3. Optional- Configure minorversion
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source 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.

Get Customer on Quickbooks
Description:Returns info about a customer.
Version:0.3.1
Key:quickbooks-get-customer

Code

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

export default {
  key: "quickbooks-get-customer",
  name: "Get Customer",
  description: "Returns info about a customer.",
  version: "0.3.1",
  type: "action",
  props: {
    quickbooks: {
      type: "app",
      app: "quickbooks",
    },
    customer_id: {
      type: "string",
      description: "Id of the account to get details of.",
    },
    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/most-commonly-used/customer#read-a-customer

    if (!this.customer_id) {
      throw new Error("Must provide customer_id parameter.");
    }

    return await axios($, {
      url: `https://quickbooks.api.intuit.com/v3/company/${this.quickbooks.$auth.company_id}/customer/${this.customer_id}`,
      headers: {
        "Authorization": `Bearer ${this.quickbooks.$auth.oauth_access_token}`,
        "content-type": "application/json",
      },
      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.
LabelPropTypeDescription
QuickbooksquickbooksappThis component uses the Quickbooks app.
customer_idstring

Id of the account to get details of.

minorversionstring

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 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.accounting

About Quickbooks

Online accounting software