Update Customer with QuickBooks API

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

Trigger workflow on

HTTP requests, schedules and app events

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#

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

Configure the Update Customer action
1. Connect your QuickBooks 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 Currency Reference Value
9. Optional- Configure Currency Reference Name
10. Optional- Configure Active
11. Optional- Configure Alternate Phone Free Form Number
12. Optional- Configure Ar Account Ref Name
13. Optional- Configure Ar Account Ref Value
14. Optional- Configure Balance
15. Optional- Configure Balance With Job
16. Optional- Configure Bill Addr City
17. Optional- Configure Bill Addr Country
18. Optional- Configure Bill Addr Country Sub Division Code
19. Optional- Configure Bill Addr Id
20. Optional- Configure Bill Addr Late
21. Optional- Configure Bill Addr Line 1
22. Optional- Configure Bill Addr Line 2
23. Optional- Configure Bill Addr Line 3
24. Optional- Configure Bill Addr Line 4
25. Optional- Configure Bill Addr Line 5
26. Optional- Configure Bill Addr Long
27. Optional- Configure Bill Addr Postal Code
28. Optional- Configure Bill With Parent
29. Optional- Configure Business Number
30. Optional- Configure Company Name
31. Configure Customer Id
32. Optional- Configure Customer Type Ref Value
33. Optional- Configure Default Tax Code Name
34. Optional- Configure Default Tax Code Value
35. Optional- Configure Fax Free Form Number
36. Optional- Configure G S T I N
37. Optional- Select a Gst Registration Type
38. Optional- Configure Is Project
39. Optional- Configure Job
40. Optional- Configure Mobile Free Form Number
41. Optional- Configure Notes
42. Optional- Configure Open Balance Date
43. Optional- Configure Parent Ref Name
44. Optional- Configure Parent Ref Value
45. Optional- Configure Payment Method Ref Name
46. Optional- Configure Payment Method Ref Value
47. Optional- Select a Preferred Delivery Method
48. Optional- Configure Primary Email Addr
49. Optional- Configure Primary Phone Free Form Number
50. Optional- Configure Primary Tax Identifier
51. Optional- Configure Print On Check Name
52. Optional- Configure Resale Num
53. Optional- Configure Sale Term Ref Name
54. Optional- Configure Sale Term Ref Value
55. Optional- Configure Secondary Tax Identifier
56. Optional- Configure Ship Addr City
57. Optional- Configure Ship Addr Country
58. Optional- Configure Ship Addr Country Sub Division Code
59. Optional- Configure Ship Addr Id
60. Optional- Configure Ship Addr Late
61. Optional- Configure Ship Addr Line 1
62. Optional- Configure Ship Addr Line 2
63. Optional- Configure Ship Addr Line 3
64. Optional- Configure Ship Addr Line 4
65. Optional- Configure Ship Addr Line 5
66. Optional- Configure Ship Addr Long
67. Optional- Configure Ship Addr Postal Code
68. Configure Sparse Update
69. Configure Sync Token
70. Optional- Configure Taxable
71. Optional- Select a Tax Exemption Reason Id
72. Optional- Configure Web Addr
73. Optional- Configure Minor Version
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#

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

HTTP / Webhook + QuickBooks

Try it

Update Customer with Quickbooks API on New Item in Feed from RSS API

RSS + QuickBooks

Try it

Update Customer with Quickbooks API on New Message from Discord API

Discord + QuickBooks

Try it

Update Customer with Quickbooks API on New Message In Channels from Slack API

Slack + QuickBooks

Try it

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

Discord Bot + QuickBooks

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.

Update Customer on QuickBooks

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

Version:0.1.6

Key:quickbooks-update-customer

View on GitHub

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 docs here](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/customer#full-update-a-customer)",
  version: "0.1.6",
  type: "action",
  props: {
    quickbooks,
    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,
        "currencyRefValue",
      ],
    },
    currencyRefName: {
      propDefinition: [
        quickbooks,
        "currencyRefName",
      ],
    },
    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: "string",
    },
    alternatePhoneFreeFormNumber: {
      description: "Specifies the alternate phone number in free form.",
      label: "Alternate Phone Free Form Number",
      optional: true,
      type: "string",
    },
    arAccountRefName: {
      description: "Name 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.Name` from that object for `ARAccountRef.name`.",
      label: "Ar Account Ref Name",
      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",
      optional: true,
      type: "string",
    },
    balance: {
      description: "Specifies the open balance amount or the amount unpaid by the customer. For the create operation, this represents the opening balance for the customer. When returned in response to the query request it represents the current open balance (unpaid amount) for that customer. Write-on-create.",
      label: "Balance",
      optional: true,
      type: "string",
    },
    balanceWithJob: {
      description: "Cumulative open balance amount for the Customer (or Job) and all its sub-jobs. Cannot be written to QuickBooks.",
      label: "Balance With Job",
      optional: true,
      type: "string",
    },
    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",
    },
    billAddrId: {
      description: "Unique identifier of the QuickBooks object for the billing address, used for modifying the address. \nThe BillAddr object represents the default billing 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: "Bill Addr Id",
      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",
    },
    customerId: {
      description: "Unique identifier for the customer object to be updated.",
      label: "Customer Id",
      type: "string",
    },
    customerTypeRefValue: {
      description: "Id referencing to the customer type assigned to a customer. This field is only returned if the customer is assigned a customer type.",
      label: "Customer Type Ref Value",
      optional: true,
      type: "string",
    },
    defaultTaxCodeName: {
      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.Name` from that object for `DefaultTaxCodeRef.name`.",
      label: "Default Tax Code Name",
      optional: true,
      type: "string",
    },
    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",
    },
    isProject: {
      description: "If true, indicates this is a Project.",
      label: "Is Project",
      optional: true,
      type: "boolean",
    },
    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",
    },
    openBalanceDate: {
      description: "Date of the Open Balance for the create operation. Write-on-create.",
      label: "Open Balance Date",
      optional: true,
      type: "string",
    },
    parentRefName: {
      description: "Name referencing to a Customer object that is the immediate parent of the Sub-Customer/Job in the hierarchical Customer:Job list. Required for the create operation if this object is a sub-customer or Job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use `Customer.Name` from that object for `ParentRef.name`.",
      label: "Parent Ref Name",
      optional: true,
      type: "string",
    },
    parentRefValue: {
      description: "Id referencing to a Customer object that is the immediate parent of the Sub-Customer/Job in the hierarchical Customer:Job list. Required for the create operation if this object is a sub-customer or Job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use `Customer.Id` from that object for `ParentRef.value`.",
      label: "Parent Ref Value",
      optional: true,
      type: "string",
    },
    paymentMethodRefName: {
      description: "Id referencing a PaymentMethod object associated with this Customer object. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use `PaymentMethod.Name` from that object for `PaymentMethodRef.name`.",
      label: "Payment Method Ref Name",
      optional: true,
      type: "string",
    },
    paymentMethodRefValue: {
      description: "Id referencing a PaymentMethod object associated with this Customer object. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use `PaymentMethod.Id` from that object for `PaymentMethodRef.value`.",
      label: "Payment Method Ref Value",
      optional: true,
      type: "string",
    },
    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",
    },
    saleTermRefName: {
      description: "Name 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.Name` from that object for `SalesTermRef.name`.",
      label: "Sale Term Ref Name",
      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`.",
      label: "Sale Term Ref Value",
      optional: true,
      type: "string",
    },
    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",
    },
    sparseUpdate: {
      description: "When set to `true`, sparse updating provides the ability to update a subset of properties for a given object; only elements specified in the request are updated. Missing elements are left untouched.",
      label: "Sparse Update",
      type: "string",
    },
    syncToken: {
      description: "Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.",
      label: "Sync Token",
      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: "string",
    },
    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",
    },
    minorVersion: {
      propDefinition: [
        quickbooks,
        "minorVersion",
      ],
    },
  },
  async run({ $ }) {
    //See Quickbooks API docs at: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/customer#full-update-a-customer

    if (
      !this.displayName &&
      (!this.title && !this.givenName && !this.middleName && !this.familyName && !this.suffix) ||
      !this.customerId || !this.syncToken || this.sparseUpdate === undefined
    ) {
      throw new ConfigurationError("Must provide displayName or at least one of title, givenName, middleName, familyName, or suffix, and customerId, syncToken parameters.");
    }

    const response = await this.quickbooks.updateCustomer({
      $,
      data: {
        sparse: this.sparseUpdate,
        Id: this.customerId,
        DisplayName: this.displayName,
        Suffix: this.suffix,
        Title: this.title,
        MiddleName: this.middleName,
        FamilyName: this.familyName,
        GivenName: this.givenName,
        SyncToken: this.syncToken,
        PrimaryEmailAddr: this.primaryEmailAddr,
        ResaleNum: this.resaleNum,
        SecondaryTaxIdentifier: this.secondaryTaxIdentifier,
        ARAccountRef: {
          value: this.arAccountRefValue,
          name: this.arAccountRefName,
        },
        DefaultTaxCodeRef: {
          value: this.defaultTaxCodeValue,
          name: this.defaultTaxCodeName,
        },
        PreferredDeliveryMethod: this.preferredDeliveryMethod,
        GSTIN: this.GSTIN,
        SalesTermRef: {
          value: this.saleTermRefValue,
          name: this.saleRermRefName,
        },
        CustomerTypeRef: {
          value: this.customerRypeRefValue,
        },
        Fax: {
          FreeFormNumber: this.faxFreeFormNumber,
        },
        BusinessNumber: this.businessNumber,
        BillWithParent: this.billWithParent,
        CurrencyRef: {
          value: this.currencyRefValue,
          name: this.currencyRefName,
        },
        Mobile: {
          FreeFormNumber: this.mobileFreeFormNumber,
        },
        Job: this.job,
        BalanceWithJobs: this.balanceWithJob,
        PrimaryPhone: {
          FreeFormNumber: this.primaryPhoneFreeFormNumber,
        },
        OpenBalanceDate: this.openBalanceDate,
        Taxable: this.taxable,
        AlternatePhone: {
          FreeFormNumber: this.alternatePhoneFreeFormNumber,
        },
        ParentRef: {
          value: this.parentRefValue,
          name: this.parentRefName,
        },
        Notes: this.notes,
        WebAddr: this.webAddr,
        Active: this.active,
        Balance: this.balance,
        ShipAddr: {
          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: {
          value: this.paymentMethodRefValue,
          name: this.paymentMethodRefName,
        },
        IsProject: this.isProject,
        CompanyName: this.companyName,
        PrimaryTaxIdentifier: this.primaryTaxIdentifier,
        GSTRegistrationType: this.gstRegistrationType,
        PrintOnCheckName: this.printOnCheckName,
        BillAddr: {
          Id: this.billAddrId,
          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,
      },
      params: {
        minorversion: this.minorVersion,
      },
    });

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

    return response;
  },
};

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	`quickbooks`	`app`	This component uses the QuickBooks app.
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 Reference Value	`currencyRefValue`	`string`	A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support here. Required if multicurrency is enabled for the company.
Currency Reference Name	`currencyRefName`	`string`	The full name of the currency.
Active	`active`	`string`	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 Name	`arAccountRefName`	`string`	Name 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.Name` from that object for `ARAccountRef.name`.
Ar Account Ref Value	`arAccountRefValue`	`string`	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`.
Balance	`balance`	`string`	Specifies the open balance amount or the amount unpaid by the customer. For the create operation, this represents the opening balance for the customer. When returned in response to the query request it represents the current open balance (unpaid amount) for that customer. Write-on-create.
Balance With Job	`balanceWithJob`	`string`	Cumulative open balance amount for the Customer (or Job) and all its sub-jobs. Cannot be written to QuickBooks.
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 Id	`billAddrId`	`string`	Unique identifier of the QuickBooks object for the billing address, used for modifying the address. The BillAddr object represents the default billing 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.
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 Id	`customerId`	`string`	Unique identifier for the customer object to be updated.
Customer Type Ref Value	`customerTypeRefValue`	`string`	Id referencing to the customer type assigned to a customer. This field is only returned if the customer is assigned a customer type.
Default Tax Code Name	`defaultTaxCodeName`	`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.Name` from that object for `DefaultTaxCodeRef.name`.
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`
Is Project	`isProject`	`boolean`	If true, indicates this is a Project.
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.
Open Balance Date	`openBalanceDate`	`string`	Date of the Open Balance for the create operation. Write-on-create.
Parent Ref Name	`parentRefName`	`string`	Name referencing to a Customer object that is the immediate parent of the Sub-Customer/Job in the hierarchical Customer:Job list. Required for the create operation if this object is a sub-customer or Job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use `Customer.Name` from that object for `ParentRef.name`.
Parent Ref Value	`parentRefValue`	`string`	Id referencing to a Customer object that is the immediate parent of the Sub-Customer/Job in the hierarchical Customer:Job list. Required for the create operation if this object is a sub-customer or Job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use `Customer.Id` from that object for `ParentRef.value`.
Payment Method Ref Name	`paymentMethodRefName`	`string`	Id referencing a PaymentMethod object associated with this Customer object. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use `PaymentMethod.Name` from that object for `PaymentMethodRef.name`.
Payment Method Ref Value	`paymentMethodRefValue`	`string`	Id referencing a PaymentMethod object associated with this Customer object. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use `PaymentMethod.Id` from that object for `PaymentMethodRef.value`.
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.
Sale Term Ref Name	`saleTermRefName`	`string`	Name 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.Name` from that object for `SalesTermRef.name`.
Sale Term Ref Value	`saleTermRefValue`	`string`	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`.
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.
Sparse Update	`sparseUpdate`	`string`	When set to `true`, sparse updating provides the ability to update a subset of properties for a given object; only elements specified in the request are updated. Missing elements are left untouched.
Sync Token	`syncToken`	`string`	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.
Taxable	`taxable`	`string`	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.
Minor Version	`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 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