Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create billing rate

create_billing_rate
Read-onlyIdempotent

Adds a billing rate to the billing rate level list. After a billing rate is created, it can be assigned to an employee or vendor (VendorAdd/Mod, EmployeeAdd/Mod) via the BillingRateRef element in the appropriate request. Then, once the billing rate is assigned to an employee or vendor, if you use that employee or vendor in a time transaction (TimeTrackingAdd), then the billing rate will override the rate specified by the service item used in the time transaction.

The billing_rate_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_billing_rate"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
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`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
fixed_billing_rateNoYou use `fixed_billing_rate` if you want the rate to override all service items rates. Choose exactly one of: `fixed_billing_rate`, or `billing_rate_per_item`.
include_ret_elementNo
billing_rate_per_itemNoChoose exactly one of: `fixed_billing_rate`, or `billing_rate_per_item`.

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

A3.6/5.0
Behavior4/5

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

The annotations already declare readOnly/idempotent/destructive/openWorld, and the description adds genuinely new behavior: the call compiles and returns a v2 request plus the webhook payload (response_json) that QuickBooks' answer arrives in, accepts a qbXML `billing_rate_add` wrapper, and enumerates 24 concrete error codes/types. That said, the opening verb "Adds" reads as a write while readOnlyHint=true, and the description only implicitly reconciles the two by explaining the request-compilation model rather than stating outright that no data is mutated on this call.

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 structure is sensible and front-loaded (purpose, then lifecycle, then qbXML/return shape, then errors), but the middle paragraph runs long on downstream assignment mechanics while the argument-level guidance stays thin. The 24-code error enumeration is a wall of text that crowds out what an agent needs to call the tool correctly.

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?

An output schema exists and the description still usefully frames the return as a v2 request plus webhook payload with status codes to handle, and the error catalog covers failure modes thoroughly. For a 6-parameter creation tool with a nested rate-per-item array, the main residual gap is the missing note that `name` must be unique in its hierarchy scope, which only lives in the schema.

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 83%, so the schema already carries most parameter meaning; the description does not discuss individual parameters such as `name` uniqueness, `request_id`, `include_qbxml`, or `include_ret_element`. The override narrative gives conceptual grounding for fixed_billing_rate vs billing_rate_per_item, but that ground is already covered by the schema's own descriptions, so this is a baseline 3.

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 states a specific verb and resource ("Adds a billing rate to the billing rate level list") and the following sentences describe the object's downstream role in assignments and time transactions, so an agent knows exactly what is produced. It never names a sibling such as find_billing_rates, so there is no explicit differentiation against alternatives.

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?

Usage is described indirectly through the lifecycle: create a rate, then attach it via BillingRateRef in VendorAdd/EmployeeAdd, then it overrides the service-item rate in TimeTrackingAdd. That tells an agent where this tool sits in a workflow but gives no explicit when-to-use/when-not-to-use rule, no prerequisite (e.g. check for an existing rate first), and no named alternative.

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