Update Customer with QuickBooks API on New Row Custom Query from PostgreSQL API

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

Trigger workflow on

New Row Custom Query from the PostgreSQL API

Next, do this

Update Customer with the QuickBooks 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 PostgreSQL trigger and QuickBooks action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Row Custom Query trigger
1. Connect your PostgreSQL account
2. Configure Polling Interval
3. Select a Schema
4. Select a Table
5. Select a Column
6. Configure SQL Query
7. Optional- Configure Values
Configure the Update Customer action
1. Connect your QuickBooks 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 Row Custom Query on PostgreSQL

Description:Emit new event when new rows are returned from a custom query that you provide. [See the documentation](https://node-postgres.com/features/queries)

Version:2.0.6

Key:postgresql-new-row-custom-query

View on GitHub

PostgreSQL Overview#

On Pipedream, you can leverage the PostgreSQL app to create workflows that automate database operations, synchronize data across platforms, and react to database events in real-time. Think handling new row entries, updating records from webhooks, or even compiling reports on a set schedule. Pipedream's serverless platform provides a powerful way to connect PostgreSQL with a variety of apps, enabling you to create tailored automation that fits your specific needs.

Trigger Code#

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

export default {
  ...common,
  name: "New Row Custom Query",
  key: "postgresql-new-row-custom-query",
  description: "Emit new event when new rows are returned from a custom query that you provide. [See the documentation](https://node-postgres.com/features/queries)",
  version: "2.0.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    schema: {
      propDefinition: [
        common.props.postgresql,
        "schema",
      ],
    },
    table: {
      propDefinition: [
        common.props.postgresql,
        "table",
        (c) => ({
          schema: c.schema,
        }),
      ],
    },
    column: {
      propDefinition: [
        common.props.postgresql,
        "column",
        (c) => ({
          table: c.table,
          schema: c.schema,
        }),
      ],
    },
    query: {
      propDefinition: [
        common.props.postgresql,
        "query",
      ],
    },
    values: {
      propDefinition: [
        common.props.postgresql,
        "values",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateMeta(row, column) {
      return {
        id: row[column],
        summary: "New Row",
        ts: Date.now(),
      };
    },
  },
  async run() {
    const {
      schema,
      table,
      column,
      query,
      values = [],
    } = this;

    if (!Array.isArray(values)) {
      throw new Error("No valid values provided. The values property must be an array.");
    }

    const numberOfValues = query?.match(/\$/g)?.length || 0;
    if (values.length !== numberOfValues) {
      throw new Error("The number of values provided does not match the number of values in the query.");
    }

    const isColumnUnique = await this.isColumnUnique(schema, table, column);
    if (!isColumnUnique) {
      throw new Error("The column selected contains duplicate values. Column must be unique");
    }

    const rows = await this.postgresql.executeQuery({
      text: query,
      values,
    });
    for (const row of rows) {
      const meta = this.generateMeta(row, column);
      this.$emit(row, meta);
    }
  },
};

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
PostgreSQL	`postgresql`	`app`	This component uses the PostgreSQL app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Schema	`schema`	`string`	Select a value from the drop down menu.
Table	`table`	`string`	Select a value from the drop down menu.
Column	`column`	`string`	Select a value from the drop down menu.
SQL Query	`query`	`string`	Your custom SQL Query using `$1`, `$2`... to represent values (eg. `INSERT INTO users(name, email) VALUES($1, $2)`
Values	`values`	`string[]`	List of values represented in your SQL Query above

Trigger Authentication#

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

Connecting to Restricted Databases

Either enable the shared static IP for this account below, or configure a VPC to deploy any workflow in your workspace to a private network with a dedicated static IP. Learn more in our docs.

SSL Setup

Configure SSL on your PostgreSQL database by providing the CA (Certificate Authority), and choosing between Full Verification, Verify Certificate Authority (CA), or Skip Verification. Skipping verification is not recommended as this has serious security implications.

About PostgreSQL#

PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.

Action#

Update Customer on QuickBooks

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

Key:quickbooks-update-customer

View on GitHub

QuickBooks Overview#

The QuickBooks API allows for streamlined financial management within Pipedream's ecosystem, enabling automated accounting and data syncing across various platforms. With this API, you can manipulate invoices, manage sales receipts, handle expenses, and synchronize customer data. It's a robust tool for financial oversight and automation that can save time and reduce errors for businesses of all sizes.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import quickbooks from "../../quickbooks.app.mjs";

export default {
  key: "quickbooks-update-customer",
  name: "Update Customer",
  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.1.7",
  type: "action",
  props: {
    quickbooks,
    customerId: {
      propDefinition: [
        quickbooks,
        "customer",
      ],
    },
    displayName: {
      propDefinition: [
        quickbooks,
        "displayName",
      ],
    },
    title: {
      propDefinition: [
        quickbooks,
        "title",
      ],
    },
    givenName: {
      propDefinition: [
        quickbooks,
        "givenName",
      ],
    },
    middleName: {
      propDefinition: [
        quickbooks,
        "middleName",
      ],
    },
    familyName: {
      propDefinition: [
        quickbooks,
        "familyName",
      ],
    },
    suffix: {
      propDefinition: [
        quickbooks,
        "suffix",
      ],
    },
    currencyRefValue: {
      propDefinition: [
        quickbooks,
        "currency",
      ],
    },
    active: {
      description: "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.",
      label: "Active",
      optional: true,
      type: "boolean",
    },
    alternatePhoneFreeFormNumber: {
      description: "Specifies the alternate phone number in free form.",
      label: "Alternate Phone Free Form Number",
      optional: true,
      type: "string",
    },
    arAccountRefValue: {
      description: "ID of the accounts receivable account to be used for this customer. Each customer must have his own AR account. Applicable for France companies, only. Available when endpoint is evoked with the minorversion=3 query parameter. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType=Accounts Receivable. Use `Account.Id` from that object for `ARAccountRef.value`.",
      label: "AR Account Ref Value",
      type: "string",
      propDefinition: [
        quickbooks,
        "accountIds",
      ],
    },
    billAddrCity: {
      description: "City name for the billing address.",
      label: "Bill Addr City",
      optional: true,
      type: "string",
    },
    billAddrCountry: {
      description: "Country name. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country.",
      label: "Bill Addr Country",
      optional: true,
      type: "string",
    },
    billAddrCountrySubDivisionCode: {
      description: "Region within a country for the billing address. For example, state name for USA, province name for Canada.",
      label: "Bill Addr Country Sub Division Code",
      optional: true,
      type: "string",
    },
    billAddrLate: {
      description: "Latitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.",
      label: "Bill Addr Late",
      optional: true,
      type: "string",
    },
    billAddrLine1: {
      description: "First line of the billing address.",
      label: "Bill Addr Line 1",
      optional: true,
      type: "string",
    },
    billAddrLine2: {
      description: "Second line of the billing address.",
      label: "Bill Addr Line 2",
      optional: true,
      type: "string",
    },
    billAddrLine3: {
      description: "Third line of the billing address.",
      label: "Bill Addr Line 3",
      optional: true,
      type: "string",
    },
    billAddrLine4: {
      description: "Fourth line of the billing address.",
      label: "Bill Addr Line 4",
      optional: true,
      type: "string",
    },
    billAddrLine5: {
      description: "Fifth line of the billing address.",
      label: "Bill Addr Line 5",
      optional: true,
      type: "string",
    },
    billAddrLong: {
      description: "Longitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.",
      label: "Bill Addr Long",
      optional: true,
      type: "string",
    },
    billAddrPostalCode: {
      description: "Postal code for the billing address. For example, zip code for USA and Canada.",
      label: "Bill Addr Postal Code",
      optional: true,
      type: "string",
    },
    billWithParent: {
      description: "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.",
      label: "Bill With Parent",
      optional: true,
      type: "boolean",
    },
    businessNumber: {
      description: "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.",
      label: "Business Number",
      optional: true,
      type: "string",
    },
    companyName: {
      description: "The name of the company associated with the person or organization.",
      label: "Company Name",
      optional: true,
      type: "string",
    },
    customerTypeRefValue: {
      propDefinition: [
        quickbooks,
        "customerType",
      ],
    },
    defaultTaxCodeValue: {
      description: "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`.",
      label: "Default Tax Code Value",
      optional: true,
      type: "string",
    },
    faxFreeFormNumber: {
      description: "Specifies the fax number in free form.",
      label: "Fax Free Form Number",
      optional: true,
      type: "string",
    },
    GSTIN: {
      description: "GSTIN is an identification number assigned to every GST registered business.",
      label: " G S T I N",
      optional: true,
      type: "string",
    },
    gstRegistrationType: {
      description: "For the filing of GSTR, transactions need to be classified depending on the type of customer to whom the sale is done. To facilitate this, we have introduced a new field as 'GST registration type'.\nPossible values are listed below, for their description [See the API Docs](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/customer#full-update-a-customer).\n* `GST_REG_REG`\n* `GST_REG_COMP`\n* `GST_UNREG`\n* `CONSUMER`\n* `OVERSEAS`\n* `SEZ`\n* `DEEMED`",
      label: "Gst Registration Type",
      optional: true,
      options: [
        "GST_REG_REG",
        "GST_REG_COMP",
        "GST_UNREG",
        "CONSUMER",
        "OVERSEAS",
        "SEZ",
        "DEEMED",
      ],
      type: "string",
    },
    job: {
      description: "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.",
      label: "Job",
      optional: true,
      type: "boolean",
    },
    mobileFreeFormNumber: {
      description: "Specifies the mobile phone number in free form.",
      label: "Mobile Free Form Number",
      optional: true,
      type: "string",
    },
    notes: {
      description: "Free form text describing the Customer.",
      label: "Notes",
      optional: true,
      type: "string",
    },
    paymentMethodRefValue: {
      propDefinition: [
        quickbooks,
        "paymentMethod",
      ],
    },
    preferredDeliveryMethod: {
      description: "Preferred delivery method. Values are `Print`, `Email`, or `None`.",
      label: "Preferred Delivery Method",
      optional: true,
      options: [
        "Print",
        "Email",
        "None",
      ],
      type: "string",
    },
    primaryEmailAddr: {
      description: "Primary email address.",
      label: "Primary Email Addr",
      optional: true,
      type: "string",
    },
    primaryPhoneFreeFormNumber: {
      description: "Specifies the primary phone number in free form.",
      label: "Primary Phone Free Form Number",
      optional: true,
      type: "string",
    },
    primaryTaxIdentifier: {
      description: "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`.",
      label: "Primary Tax Identifier",
      optional: true,
      type: "string",
    },
    printOnCheckName: {
      description: "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.",
      label: "Print On Check Name",
      optional: true,
      type: "string",
    },
    resaleNum: {
      description: "Resale number or some additional info about the customer.",
      label: "Resale Num",
      optional: true,
      type: "string",
    },
    saleTermRefValue: {
      description: "ID of a SalesTerm object associated with this Customer object. Query the Term name list resource to determine the appropriate Term object for this reference. Use `Term.Id` from that object for `SalesTermRef.value`.",
      type: "string",
      propDefinition: [
        quickbooks,
        "termIds",
      ],
    },
    secondaryTaxIdentifier: {
      description: "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`",
      label: "Secondary Tax Identifier",
      optional: true,
      type: "string",
    },
    shipAddrCity: {
      description: "City name for the shipping address.",
      label: "Ship Addr City",
      optional: true,
      type: "string",
    },
    shipAddrCountry: {
      description: "Country name. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country.",
      label: "Ship Addr Country",
      optional: true,
      type: "string",
    },
    shipAddrCountrySubDivisionCode: {
      description: "Region within a country for the shipping address. For example, state name for USA, province name for Canada.",
      label: "Ship Addr Country Sub Division Code",
      optional: true,
      type: "string",
    },
    shipAddrId: {
      description: "Unique identifier of the QuickBooks object for the shipping address, used for modifying the address. \nThe 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:\n* `Line1` and `Line2` elements are populated with the customer name and company name.\n* Original `Line1` through `Line5` contents, `City`, `SubDivisionCode`, and `PostalCode` flow into `Line3` through `Line5` as a free format strings.",
      label: "Ship Addr Id",
      optional: true,
      type: "string",
    },
    shipAddrLate: {
      description: "Latitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.",
      label: "Ship Addr Late",
      optional: true,
      type: "string",
    },
    shipAddrLine1: {
      description: "First line of the shipping address.",
      label: "Ship Addr Line 1",
      optional: true,
      type: "string",
    },
    shipAddrLine2: {
      description: "Second line of the shipping address.",
      label: "Ship Addr Line 2",
      optional: true,
      type: "string",
    },
    shipAddrLine3: {
      description: "Third line of the shipping address.",
      label: "Ship Addr Line 3",
      optional: true,
      type: "string",
    },
    shipAddrLine4: {
      description: "Fourth line of the shipping address.",
      label: "Ship Addr Line 4",
      optional: true,
      type: "string",
    },
    shipAddrLine5: {
      description: "Fifth line of the shipping address.",
      label: "Ship Addr Line 5",
      optional: true,
      type: "string",
    },
    shipAddrLong: {
      description: "Longitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.",
      label: "Ship Addr Long",
      optional: true,
      type: "string",
    },
    shipAddrPostalCode: {
      description: "Postal code for the shipping address. For example, zip code for USA and Canada.",
      label: "Ship Addr Postal Code",
      optional: true,
      type: "string",
    },
    taxable: {
      description: "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.",
      label: "Taxable",
      optional: true,
      type: "boolean",
    },
    taxExemptionReasonId: {
      label: "Tax Exemption Reason Id",
      description: "The tax exemption reason associated with this customer object. Applicable if automated sales tax is enabled (`Preferences.TaxPrefs.PartnerTaxEnabled` is set to `true`) for the company. Set `TaxExemptionReasonId`: to one of the following:\n**Id\tReason**\n* 1\tFederal government\n* 2\tState government\n* 3\tLocal government\n* 4\tTribal government\n* 5\tCharitable organization\n* 6\tReligious organization\n* 7\tEducational organization\n* 8\tHospital\n* 9\tResale\n* 10\tDirect pay permit\n* 11\tMultiple points of use\n* 12\tDirect mail\n* 13\tAgricultural production\n* 14\tIndustrial production / manufacturing\n* 15\tForeign diplomat",
      optional: true,
      options: [
        "1",
        "2",
        "3",
        "4",
        "5",
        "6",
        "7",
        "8",
        "9",
        "10",
        "11",
        "12",
        "13",
        "14",
        "15",
      ],
      type: "string",
    },
    webAddr: {
      description: "Website address.",
      label: "Web Addr",
      optional: true,
      type: "string",
    },
  },
  methods: {
    async getSyncToken($) {
      const { Customer: customer } = await this.quickbooks.getCustomer({
        $,
        customerId: this.customerId,
      });
      return customer.SyncToken;
    },
  },
  async run({ $ }) {
    if (
      !this.displayName &&
      (!this.title && !this.givenName && !this.middleName && !this.familyName && !this.suffix) ||
      !this.customerId
    ) {
      throw new ConfigurationError("Must provide displayName or at least one of title, givenName, middleName, familyName, or suffix, and customerId parameters.");
    }

    const hasBillingAddress = this.billAddrPostalCode
      || this.billAddrCity
      || this.billAddrCountry
      || this.billAddrLine5
      || this.billAddrLine4
      || this.billAddrLine3
      || this.billAddrLine2
      || this.billAddrLine1
      || this.billAddrLate
      || this.billAddrLong
      || this.billAddrCountrySubDivisionCode;

    const hasShippingAddress = this.shipAddrId
      || this.shipAddrPostalCode
      || this.shipAddrCity
      || this.shipAddrCountry
      || this.shipAddrLine5
      || this.shipAddrLine4
      || this.shipAddrLine3
      || this.shipAddrLine2
      || this.shipAddrLine1
      || this.shipAddrLate
      || this.shipAddrLong
      || this.shipAddrCountrySubDivisionCode;

    const response = await this.quickbooks.updateCustomer({
      $,
      data: {
        sparse: true,
        Id: this.customerId,
        DisplayName: this.displayName,
        Suffix: this.suffix,
        Title: this.title,
        MiddleName: this.middleName,
        FamilyName: this.familyName,
        GivenName: this.givenName,
        SyncToken: await this.getSyncToken($),
        PrimaryEmailAddr: this.primaryEmailAddr && {
          Address: this.primaryEmailAddr,
        },
        ResaleNum: this.resaleNum,
        SecondaryTaxIdentifier: this.secondaryTaxIdentifier,
        ARAccountRef: this.arAccountRefValue && {
          value: this.arAccountRefValue,
        },
        DefaultTaxCodeRef: this.defaultTaxCodeValue && {
          value: this.defaultTaxCodeValue,
        },
        PreferredDeliveryMethod: this.preferredDeliveryMethod,
        GSTIN: this.GSTIN,
        SalesTermRef: this.saleTermRefValue && {
          value: this.saleTermRefValue,
        },
        CustomerTypeRef: this.customerTypeRefValue && {
          value: this.customerTypeRefValue,
        },
        Fax: this.faxFreeFormNumber && {
          FreeFormNumber: this.faxFreeFormNumber,
        },
        BusinessNumber: this.businessNumber,
        BillWithParent: this.billWithParent,
        CurrencyRef: this.currencyRefValue && {
          value: this.currencyRefValue,
        },
        Mobile: this.mobileFreeFormNumber && {
          FreeFormNumber: this.mobileFreeFormNumber,
        },
        Job: this.job,
        PrimaryPhone: this.primaryPhoneFreeFormNumber && {
          FreeFormNumber: this.primaryPhoneFreeFormNumber,
        },
        Taxable: this.taxable,
        AlternatePhone: this.alternatePhoneFreeFormNumber && {
          FreeFormNumber: this.alternatePhoneFreeFormNumber,
        },
        Notes: this.notes,
        WebAddr: this.webAddr,
        Active: this.active,
        ShipAddr: hasShippingAddress && {
          Id: this.shipAddrId,
          PostalCode: this.shipAddrPostalCode,
          City: this.shipAddrCity,
          Country: this.shipAddrCountry,
          Line5: this.shipAddrLine5,
          Line4: this.shipAddrLine4,
          Line3: this.shipAddrLine3,
          Line2: this.shipAddrLine2,
          Line1: this.shipAddrLine1,
          Lat: this.shipAddrLate,
          Long: this.shipAddrLong,
          CountrySubDivisionCode: this.shipAddrCountrySubDivisionCode,
        },
        PaymentMethodRef: this.paymentMethodRefValue && {
          value: this.paymentMethodRefValue,
        },
        CompanyName: this.companyName,
        PrimaryTaxIdentifier: this.primaryTaxIdentifier,
        GSTRegistrationType: this.gstRegistrationType,
        PrintOnCheckName: this.printOnCheckName,
        BillAddr: hasBillingAddress && {
          PostalCode: this.billAddrPostalCode,
          City: this.billAddrCity,
          Country: this.billAddrCountry,
          Line5: this.billAddrLine5,
          Line4: this.billAddrLine4,
          Line3: this.billAddrLine3,
          Line2: this.billAddrLine2,
          Line1: this.billAddrLine1,
          Lat: this.billAddrLate,
          Long: this.billAddrLong,
          CountrySubDivisionCode: this.billAddrCountrySubDivisionCode,
        },
        TaxExemptionReasonId: this.taxExemptionReasonId,
      },
    });

    if (response) {
      $.export("summary", `Successfully updated customer with ID ${this.customerId}`);
    }

    return response;
  },
};

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	`quickbooks`	`app`	This component uses the QuickBooks 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 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.accountingopenidprofileemail