Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create vendor

create_vendor
Read-onlyIdempotent

Adds a vendor: a person or company the business buys from, including its banks and tax agencies. name is required. QuickBooks keeps vendors, customers, employees and other names in one name space, so a name any of them already uses fails with 3100 name_in_use.

The vendor_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_vendor"
  }
}

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.
notesNoAdditional information about this vendor.
pagerNo
phoneNoThe telephone number.
mobileNo
suffixNo
contactNoThe name of a contact person for a customer or vendor.
contactsNo
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.
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.
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.
open_balanceNoThe opening balance of this vendor’s account. A positive number indicates money owed to this vendor.
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.
is_tax_on_taxNoFor vendor in CA or UK, is there tax charged on top of tax.
name_on_checkNoThe vendor’s name as it will appear on checks sent to the vendor. (Corresponds in the QuickBooks user interface to the “Print on Check as” field of the Edit Vendor and New Vendor windows.)
account_numberNoAccount numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs.
vendor_addressNoIf an address request fails, some combination of address fields might be too long.
vendor_type_refNoVendor types allow business owners to categorize vendors in ways that are meaningful for their businesses.
additional_notesNo
billing_rate_refNoBilling rates are used to override the service item rate in a time transaction (TimeTrackingAdd) based on the employee or vendor performing the work.
reporting_periodNoVendor reporting period for CA or UK. This can be monthly or quarterly.
vendor_tax_identNoA character string that identifies a vendor.
open_balance_dateNoThe date of the opening balance for this vendor.
sales_tax_countryNoThe country that sales tax is collected for.
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
is_sales_tax_agencyNoIndicates whether the entity is a sales tax agency.
prefill_account_refNo
sales_tax_return_refNoSales tax return information.
additional_contact_refNo
is_tax_tracked_on_salesNoThis flag is used for CA or UK and whether tax is tracked on sales.
tax_registration_numberNoThe tax registration number used in CA and UK.
tax_on_sales_account_refNoAccount used for taxes on sales in CA or UK.
is_vendor_eligible_for1099NoIf `is_vendor_eligible_for1099` is set to true, `vendor_tax_ident` and `vendor_address` are required in a vendor add request message. Otherwise, `vendor_tax_ident` and `vendor_address` are optional.
is_tax_tracked_on_purchasesNoThis flag is used for CA or UK and whether tax is tracked on purchases.
tax_on_purchases_account_refNoAccount used for taxes on purchases in CA or UK.

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

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is supplied. The description adds real context beyond that: the shared name space and error 3100, acceptance of the qbXML `vendor_add` wrapper, and the fact that the return carries the v2 request plus the webhook payload shape. However, it never resolves the central ambiguity of whether calling this actually creates the vendor or merely produces a request, which is exactly the behavioral detail an agent needs. The 27-code error enumeration adds breadth but little depth, since each code's meaning is deferred to the call result.

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?

The lead sentence and the namespace warning are front-loaded and earn their place. The long comma-separated dump of 27 error codes is low-density padding that consumes significant tokens while explicitly telling the reader the call result explains each anyway, and the return-shape sentence in the middle is dense enough to slow parsing.

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 52-parameter, deeply nested tool with an output schema, the description covers what matters most: the required field, the uniqueness constraint that causes the most likely failure, and what the return contains (v2 request, webhook payload, response_json shape and status codes). It does not need to restate return values, but the unresolved write-vs-compile semantics leaves one meaningful gap.

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

Parameters3/5

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

Schema description coverage is 85% across 52 parameters, so the schema does the heavy lifting and the baseline is 3. The description only adds that `name` is required and must be unique across the shared name space; it says nothing about the many conditional fields (for example the is_vendor_eligible_for1099 requirement) or the address block-vs-structured mode beyond what the schema already states.

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

Purpose4/5

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

The first sentence names a specific verb and resource and even defines the entity ('a person or company the business buys from'), which distinguishes it from create_customer or create_vendor_type siblings. What keeps it from a 5 is that the tool's actual effect is muddled: 'Adds a vendor' reads as a database write, while 'Returns the v2 request to send' suggests it only compiles a request payload.

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

Usage Guidelines3/5

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

There is no explicit statement of when to use this versus update_vendor or the customer/employee counterparts, so the agent must infer from the name. The namespace warning ('a name any of them already uses fails with 3100') is useful implied guidance about checking for collisions before calling, but it is a constraint, not routing guidance.

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