View as Markdown
QuickBooks icon

QuickBooks ACTION

Update Customer

Updates a customer. See the documentation
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's QuickBooks account once, then configure and run Update Customer from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "quickbooks-update-customer",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    quickbooks: { authProvisionId: "apn_xxxxxxx" },
    customerId: "Customer Reference",
    displayName: "Display Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Update Customer inputs
Property Type Description
customerId Customer Reference string
Reference to a customer or job
Required Dynamic
displayName 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.
Optional
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.
Optional
givenName 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.
Optional
middleName 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.
Optional
familyName 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.
Optional
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.
Optional
currencyRefValue Currency Code 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.
Optional Dynamic
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.
Optional
alternatePhoneFreeFormNumber Alternate Phone Free Form Number string
Specifies the alternate phone number in free form.
Optional
arAccountRefValue AR Account Ref Value 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.
Optional Dynamic
billAddrCity Bill Addr City string
City name for the billing address.
Optional
billAddrCountry Bill Addr Country string
Country name. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country.
Optional
billAddrCountrySubDivisionCode Bill Addr Country Sub Division Code string
Region within a country for the billing address. For example, state name for USA, province name for Canada.
Optional
billAddrLate Bill Addr Late string
Latitude coordinate of Geocode (Geospacial Entity Object Code). INVALID is returned for invalid addresses.
Optional
billAddrLine1 Bill Addr Line 1 string
First line of the billing address.
Optional
billAddrLine2 Bill Addr Line 2 string
Second line of the billing address.
Optional
billAddrLine3 Bill Addr Line 3 string
Third line of the billing address.
Optional
billAddrLine4 Bill Addr Line 4 string
Fourth line of the billing address.
Optional
billAddrLine5 Bill Addr Line 5 string
Fifth line of the billing address.
Optional
billAddrLong Bill Addr Long string
Longitude coordinate of Geocode (Geospacial Entity Object Code). INVALID is returned for invalid addresses.
Optional
billAddrPostalCode Bill Addr Postal Code string
Postal code for the billing address. For example, zip code for USA and Canada.
Optional
billWithParent Bill With Parent 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.
Optional
businessNumber Business Number 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.
Optional
companyName Company Name string
The name of the company associated with the person or organization.
Optional
customerTypeRefValue Customer Type string
ID referencing the customer type assigned to a customer
Optional Dynamic
defaultTaxCodeValue Default Tax Code Value 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.
Optional
faxFreeFormNumber Fax Free Form Number string
Specifies the fax number in free form.
Optional
GSTIN G S T I N string
GSTIN is an identification number assigned to every GST registered business.
Optional
gstRegistrationType Gst Registration Type string

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'. Possible values are listed below, for their description See the API Docs.

  • GST_REG_REG
  • GST_REG_COMP
  • GST_UNREG
  • CONSUMER
  • OVERSEAS
  • SEZ
  • DEEMED
Optional
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.
Optional
mobileFreeFormNumber Mobile Free Form Number string
Specifies the mobile phone number in free form.
Optional
notes Notes string
Free form text describing the Customer.
Optional
paymentMethodRefValue Payment Method string
ID referencing a PaymentMethod object associated with this Customer object
Optional Dynamic
preferredDeliveryMethod Preferred Delivery Method string
Preferred delivery method. Values are Print, Email, or None.
Optional
primaryEmailAddr Primary Email Addr string
Primary email address.
Optional
primaryPhoneFreeFormNumber Primary Phone Free Form Number string
Specifies the primary phone number in free form.
Optional
primaryTaxIdentifier Primary Tax Identifier 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.
Optional
printOnCheckName Print On Check Name 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.
Optional
resaleNum Resale Num string
Resale number or some additional info about the customer.
Optional
saleTermRefValue Term IDs 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.
Optional Dynamic
secondaryTaxIdentifier Secondary Tax Identifier 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
Optional
shipAddrCity Ship Addr City string
City name for the shipping address.
Optional
shipAddrCountry Ship Addr Country string
Country name. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country.
Optional
shipAddrCountrySubDivisionCode Ship Addr Country Sub Division Code string
Region within a country for the shipping address. For example, state name for USA, province name for Canada.
Optional
shipAddrId Ship Addr Id 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.
Optional
shipAddrLate Ship Addr Late string
Latitude coordinate of Geocode (Geospacial Entity Object Code). INVALID is returned for invalid addresses.
Optional
shipAddrLine1 Ship Addr Line 1 string
First line of the shipping address.
Optional
shipAddrLine2 Ship Addr Line 2 string
Second line of the shipping address.
Optional
shipAddrLine3 Ship Addr Line 3 string
Third line of the shipping address.
Optional
shipAddrLine4 Ship Addr Line 4 string
Fourth line of the shipping address.
Optional
shipAddrLine5 Ship Addr Line 5 string
Fifth line of the shipping address.
Optional
shipAddrLong Ship Addr Long string
Longitude coordinate of Geocode (Geospacial Entity Object Code). INVALID is returned for invalid addresses.
Optional
shipAddrPostalCode Ship Addr Postal Code string
Postal code for the shipping address. For example, zip code for USA and Canada.
Optional
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.
Optional
taxExemptionReasonId Tax Exemption Reason Id string

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: Id Reason

  • 1 Federal government
  • 2 State government
  • 3 Local government
  • 4 Tribal government
  • 5 Charitable organization
  • 6 Religious organization
  • 7 Educational organization
  • 8 Hospital
  • 9 Resale
  • 10 Direct pay permit
  • 11 Multiple points of use
  • 12 Direct mail
  • 13 Agricultural production
  • 14 Industrial production / manufacturing
  • 15 Foreign diplomat
Optional
webAddr Web Addr string
Website address.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
quickbooks-update-customer
Version
0.1.13
App
QuickBooks
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes