Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create vehicle mileage

create_vehicle_mileage
Read-onlyIdempotent

Adds a VehicleMileage transaction involving the specified vehicle for the specified total miles or optionally for the QuickBooks calculated total miles if you supply the odometer start and end.

The vehicle_mileage_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, 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": {
      "vehicle_ref": "<vehicle_ref>"
    },
    "name": "create_vehicle_mileage"
  }
}

Input Schema

NameRequiredDescriptionDefault
notesNoAdditional information.
item_refNo`item_ref` may accept all item types or a restricted subset, depending on the request.
class_refNoUse classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks.
def_macroNo`def_macro` lets you assign a reusable name to a returned `txn_id` or TxnLineID so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
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`.
total_milesNoTotal trip miles. If `total_miles` is specified, you can’t specify `odometer_start` and `odometer_end`. Choose exactly one of: the set (`odometer_end`, `odometer_start`), or `total_miles`. Members of a set combine with each other, not with the other choices.
vehicle_refYesA vehicle for use in VehicleMileage transactions. Each vehicle name must be unique.
customer_refNo`customer_ref` identifies a customer or customer job. If both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit.
odometer_endNoOdometer reading at the end of the trip. `odometer_start` and `odometer_end` must both be specified if `total_miles` isn’t specified. Choose exactly one of: the set (`odometer_end`, `odometer_start`), or `total_miles`. Members of a set combine with each other, not with the other choices.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
trip_end_dateNoDate the trip ended. If left blank, the current date at the time of transaction will be used.
odometer_startNoOdometer reading at the start of the trip. `odometer_start` and `odometer_end` must both be specified if `total_miles` isn’t specified. Choose exactly one of: the set (`odometer_end`, `odometer_start`), or `total_miles`. Members of a set combine with each other, not with the other choices.
billable_statusNoThe billing status of this item line or expense line.
trip_start_dateNoDate the trip began. If left blank, the current date at the time of transaction will be used.
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

A3.7/5.0
Behavior4/5

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

Beyond annotations it discloses what the call actually produces ('the v2 request to send' plus the webhook payload shape) and enumerates 26 error codes with their semantics, which is substantive context for a request-compiling tool. The headline verb 'Adds' sits in tension with readOnlyHint=true, but the sentence about returning the request rather than executing it reconciles the two rather than contradicting them.

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?

Purpose and return behavior are front-loaded in the first two sentences, and the error catalog, while a long numeric dump, is genuinely useful and correctly kept at the end. The first sentence is a run-on that could be split, and the error list could be compressed, but no sentence is pure filler.

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 15-parameter nested-schema tool with an output schema, the definition covers purpose, input-mode rules, return/webhook behavior, and failure modes. The main omission is operational prerequisites and whether the write is actually executed or only compiled into a payload, which matters given readOnlyHint=true.

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 93%, so the schema already carries parameter meaning; the description's added value is limited to restating the total_miles/odometer exclusivity rule and mentioning the wrapper alias. No extra semantics are supplied for the ref objects, dates, billable_status, or include_ret_element.

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 opening sentence names a specific verb and resource ('Adds a VehicleMileage transaction') and scopes it to the given vehicle, plus the two ways mileage can be expressed. It is clearly a create operation distinguishable from the 'find_vehicle_mileages' sibling, though it never names that alternative explicitly.

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?

The description explains the mutually exclusive input modes (total_miles vs the odometer_start/odometer_end pair) and notes the qbXML `vehicle_mileage_add` alias is accepted, which is real usage guidance. It gives no when-to-use/when-not guidance relative to update or find operations, and no prerequisites (vehicle must already exist, mileage feature enabled) are stated.

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