Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create customer

create_customer
Read-onlyIdempotent

Adds a customer, or a job under one: set parent_ref to the customer and the job's full_name becomes Parent:Job. name is required. QuickBooks keeps customers, vendors, employees and other names in one name space, so a name any of them already uses fails with 3100 name_in_use. The ensure workflow template adds the customer only if it isn't there yet, and on a clash finds out what holds the name and asks.

The customer_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).

Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>"
    },
    "name": "create_customer"
  }
}

Input Schema

NameRequiredDescriptionDefault
ccNoEmail address that would be carbon copied or CC.
faxNoFax number.
nameYesName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
emailNoE-mail address.
notesNoNot supported.
pagerNo
phoneNoThe telephone number.
mobileNo
suffixNo
contactNoThe name of a contact person for a customer or vendor.
contactsNo
job_descNoA short job description for a sub-customer; used in reports.
print_asNo
alt_phoneNoA telephone number given as an alternative to Phone.
class_refNoUse classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks.
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
job_titleNoThe job title of a customer, vendor, employee, or person on the “other names” list.
last_nameNoThe last name of a customer, vendor, employee, or person on the “other names” list.
terms_refNoRefers to the payment terms associated with this entity. (This will be an item on the DateDrivenTerms or StandardTerms list.)
first_nameNoThe first name of a customer, vendor, employee, or person on the “other names” list.
job_statusNo`job_status` Status information about a sub-customer; used in reports.
parent_refNoA reference to the list object that is one level above this one.
request_idNoYour own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
salutationNoA formal reference, such as Mr. or Dr., that precedes a name.
alt_contactNoThe name of an alternate contact person for a vendor, customer, or “other name” entry.
middle_nameNoThe middle name of a customer, vendor, employee, or person on the “other names” list.
bill_addressNoThis aggregate supports at most five address lines. You can provide a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode (Addr1-Addr5 only).
company_nameNoThe name of the QuickBooks user’s business, as specified in QuickBooks. `company_name` and Address are used on invoices, checks, and other forms.
credit_limitNoSet and returned as a positive number that indicates a customer’s or vendor’s credit limit. If no value has been defined, there is no credit limit.
currency_refNoA currency record defines how QuickBooks stores and displays a currency. Built-in currency name/code values are fixed; formatting and active status can vary by settings and workflow.
job_end_dateNoThe date on which work for a sub-customer was completed; used in reports.
job_type_refNoJob type can be used to separate jobs into any categories that are meaningful to the business. A `job_type_ref` aggregate refers to a job type on the JobType list.
open_balanceNoThe opening balance of this customer’s account. A positive number indicates money owed by the customer.
ship_addressNoThis aggregate supports at most five address lines. You can provide a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode (Addr1-Addr5 only).
external_guidNoAllows for the attachment of a user defined GUID value.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
resale_numberNoThe customer’s resale number, if they have one. This number won’t affect reports or sales tax calculations.
sales_rep_refNoA sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms.
account_numberNoAccount numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs.
job_start_dateNoThe date on which work for a sub-customer was started; used in reports.
delivery_methodNo
price_level_refNoPrice levels let you apply custom pricing rules for selected customers. Once assigned, QuickBooks uses those prices automatically on supported sales forms unless explicitly overridden.
ship_to_addressNo
additional_notesNo
credit_card_infoNoCustomer’s credit-card information.
customer_type_refNoCustomer types allow business owners to categorize customers in ways that are meaningful for their businesses.
open_balance_dateNoThe date of the opening balance for this customer.
sales_tax_countryNoCountry that sales tax is collected for.
item_sales_tax_refNoAn ItemSalesTax entry represents one tax rate paid to one tax agency. Use it when a transaction needs a single tax calculation. For multi-rate scenarios, use a sales-tax group instead.
sales_tax_code_refNo`sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it.
include_ret_elementNo
additional_contact_refNo
job_projected_end_dateNoThe date on which work for a sub-customer is expected to be complete; used in reports.
tax_registration_numberNoTax registration number used in CA and UK.
is_statement_with_parentNo
preferred_delivery_methodNoPreference for how invoices are delivered.
preferred_payment_method_refNoRefers to a PaymentMethod object. In a request, if a `preferred_payment_method_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.

Output Schema

NameRequiredDescriptionDefault
urlYesReplace {connection_id} with the customer's connection.
bodyYesThe JSON body: the arguments you passed.
qbxmlNoThe qbXML it compiles to. Only with include_qbxml.
methodYes
headersYesSend with the request. Resent unchanged when no 201 came back, it answers with the request already queued.
webhookYesJSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the annotations: it discloses the shared QuickBooks name space across customers/vendors/employees, the resulting 3100 `name_in_use` failure mode, that `customer_add` qbXML wrappers are accepted, and that the call returns a v2 request plus a webhook-shaped payload. Minor tension: 'Adds a customer' reads as a write while `readOnlyHint` is true, but the sentence about returning the request to send largely reconciles it.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core behavior, which is good, but it then dumps 22 error codes verbatim while conceding 'the call result explains each' — bulk that the agent is told it does not need. Tightening that block would sharpen the definition.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 57-parameter create tool with an output schema and full annotations, the description covers the high-risk facts (required name, uniqueness scope, parent/job naming, main error paths, return shape). Missing pieces like pagination of `include_ret_element` or auth requirements are low-risk given the annotations and output schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 81%, so the baseline is 3; the description earns above that by explaining that `name` is required and case-insensitively unique within its hierarchy scope, and by spelling out how `parent_ref` + `full_name` compose into a job name. It adds nothing about `include_qbxml` or `include_ret_element`, which remain schema-only.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb and resource ('Adds a customer, or a job under one') and immediately explains the job sub-case via `parent_ref` producing `Parent:Job`. An agent can tell this tool creates customer/Job records rather than customer types or messages, without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives concrete when-to-use context: single-record add, job creation under a parent, and the `ensure` workflow template as the alternative for 'add only if absent'. It does not name a sibling for updating an existing customer (e.g. update_customer), leaving that inference to the agent.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources