Create vendor
create_vendorAdds 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
| Name | Required | Description | Default |
|---|---|---|---|
| cc | No | Email address that would be carbon copied or CC. | |
| fax | No | Fax number. | |
| name | Yes | Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. | |
| No | E-mail address. | ||
| notes | No | Additional information about this vendor. | |
| pager | No | ||
| phone | No | The telephone number. | |
| mobile | No | ||
| suffix | No | ||
| contact | No | The name of a contact person for a customer or vendor. | |
| contacts | No | ||
| alt_phone | No | A telephone number given as an alternative to Phone. | |
| class_ref | No | Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. | |
| is_active | No | If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true. | |
| job_title | No | The job title of a customer, vendor, employee, or person on the “other names” list. | |
| last_name | No | The last name of a customer, vendor, employee, or person on the “other names” list. | |
| terms_ref | No | Refers to the payment terms associated with this entity. (This will be an item on the DateDrivenTerms or StandardTerms list.) | |
| first_name | No | The first name of a customer, vendor, employee, or person on the “other names” list. | |
| request_id | No | Your 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`. | |
| salutation | No | A formal reference, such as Mr. or Dr., that precedes a name. | |
| alt_contact | No | The name of an alternate contact person for a vendor, customer, or “other name” entry. | |
| middle_name | No | The middle name of a customer, vendor, employee, or person on the “other names” list. | |
| company_name | No | The name of the QuickBooks user’s business, as specified in QuickBooks. `company_name` and Address are used on invoices, checks, and other forms. | |
| credit_limit | No | Set 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_ref | No | A 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_balance | No | The opening balance of this vendor’s account. A positive number indicates money owed to this vendor. | |
| ship_address | No | This 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_guid | No | Allows for the attachment of a user defined GUID value. | |
| include_qbxml | No | Also return the qbXML this compiles to, for debugging. Not part of the v2 request. | |
| is_tax_on_tax | No | For vendor in CA or UK, is there tax charged on top of tax. | |
| name_on_check | No | The 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_number | No | Account numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs. | |
| vendor_address | No | If an address request fails, some combination of address fields might be too long. | |
| vendor_type_ref | No | Vendor types allow business owners to categorize vendors in ways that are meaningful for their businesses. | |
| additional_notes | No | ||
| billing_rate_ref | No | Billing rates are used to override the service item rate in a time transaction (TimeTrackingAdd) based on the employee or vendor performing the work. | |
| reporting_period | No | Vendor reporting period for CA or UK. This can be monthly or quarterly. | |
| vendor_tax_ident | No | A character string that identifies a vendor. | |
| open_balance_date | No | The date of the opening balance for this vendor. | |
| sales_tax_country | No | The country that sales tax is collected for. | |
| sales_tax_code_ref | No | `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_element | No | ||
| is_sales_tax_agency | No | Indicates whether the entity is a sales tax agency. | |
| prefill_account_ref | No | ||
| sales_tax_return_ref | No | Sales tax return information. | |
| additional_contact_ref | No | ||
| is_tax_tracked_on_sales | No | This flag is used for CA or UK and whether tax is tracked on sales. | |
| tax_registration_number | No | The tax registration number used in CA and UK. | |
| tax_on_sales_account_ref | No | Account used for taxes on sales in CA or UK. | |
| is_vendor_eligible_for1099 | No | If `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_purchases | No | This flag is used for CA or UK and whether tax is tracked on purchases. | |
| tax_on_purchases_account_ref | No | Account used for taxes on purchases in CA or UK. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Replace {connection_id} with the customer's connection. | |
| body | Yes | The JSON body: the arguments you passed. | |
| qbxml | No | The qbXML it compiles to. Only with include_qbxml. | |
| method | Yes | ||
| headers | Yes | Send with the request. Resent unchanged when no 201 came back, it answers with the request already queued. | |
| webhook | Yes | JSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes). |