Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create workers comp code

create_workers_comp_code
Read-onlyIdempotent

Adds a workers’ compensation code with one or more rate entries (each rate entry has an effective date and a rate). You can assign effective dates in the past, present or future. However, only one future date will be used. If a future date exists and you write a new one (using the Mod request) then the most recently written code wins; if you have multiple future dates in the Add request, the last one wins.

The workers_comp_code_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, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 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>",
      "rate_entry": "<rate_entry>"
    },
    "name": "create_workers_comp_code"
  }
}

Input Schema

NameRequiredDescriptionDefault
descNoA descriptive text field.
nameYesName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
rate_entryYes
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.
include_ret_elementNo

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.4/5.0
Behavior5/5

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

Substantial disclosure beyond the annotations: effective dates may be past/present/future, only one future date is honored, and the last-written future date wins across both Add and Mod. It also states the return contract (a v2 request plus the webhook payload the answer arrives in), accepts the qbXML `workers_comp_code_add` wrapper, and enumerates 15 error codes including permission/subscription cases that map directly to auth prerequisites. The description's "Adds" framing is reconciled with readOnlyHint=true because it explains the tool compiles and returns a request rather than performing the mutation itself.

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

Conciseness4/5

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

Well front-loaded: the create semantics and date rules come first, then the return contract, then errors. The 15-item error enumeration is a long trailing block that a reader must scan, but each entry carries a code/name pair an agent can act on, so it earns most of its space.

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

Completeness5/5

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

For a create tool with an output schema and full annotations, nothing material is missing: input shape, date-replacement rules, alternate qbXML wrapper, return contract, and the error surface are all covered. Return-value detail is rightly delegated to the 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 71%, so most parameters are documented already, but the description adds real meaning the schema lacks: the effective-date semantics (past/future allowed, only one future date survives, last one wins) directly govern how `rate_entry.effective_date` is populated. It does not touch `include_qbxml`, `include_ret_element`, or `request_id`, which the schema covers adequately.

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?

Specific verb plus resource: "Adds a workers' compensation code with one or more rate entries (each rate entry has an effective date and a rate)." It also implies the shape of the payload (parent plus child rate entries), which lets an agent distinguish it from update_workers_comp_code and find_workers_comp_codes 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 Guidelines3/5

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

Usage is implied rather than stated: "Adds" signals creation, and the mention of "using the Mod request" hints that edits belong to a different tool, but no sibling is named and no when-not-to-use condition is given. The date rules are behavioral constraints, 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