Skip to main content
Glama

Caribooks (QuickBooks Online)

get vendor balance detail

get_vendor_balance_detail
Read-only

Generate the QuickBooks vendor balance detail report. Returns { columns, column_types, rows }: each row has a type (section | data | total), a depth, and values aligned to columns (Money cells as numbers, first cell is the label on summary reports); id is the label cell's QuickBooks record id (e.g. the account); on detail reports ids aligns to values instead. All-zero rows are omitted and counted in hidden_zero_rows. filters lists the filters QuickBooks confirms it applied (a parameter it ignored is absent), and no_data: true means the period has nothing to report.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsNoQuickBooks report query parameters: report_date (YYYY-MM-DD, the as-of date; defaults to today) or date_macro (Today, Yesterday, This Week, Last Week, This Month, Last Month, This Month-to-date, This Fiscal Quarter, Last Fiscal Quarter, This Fiscal Year, Last Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year-to-date, ...); accounting_method (Cash|Accrual); start_duedate, end_duedate (YYYY-MM-DD); vendor, department, term, appaid (All|Paid|Unpaid); columns (comma-separated, e.g. tx_date,txn_type,doc_num,name,memo,account_name,other_account,due_date,pmt_mthd,is_cleared,dept_name), sort_by (one of those columns), sort_order (ascend|descend).
companyNoWhich connected QuickBooks company to use (name, realm id, or connection id). Optional when only one company is connected.

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?

The description goes well beyond the readOnlyHint/destructiveHint annotations by disclosing the exact return shape, row types, Money cell representation, id alignment behavior, omission of all-zero rows with hidden_zero_rows count, filter confirmation semantics, and no_data flag. This is rich behavioral context that an agent needs to interpret the response correctly.

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?

The description is dense and information-rich, front-loading the report generation purpose before diving into return-format details. Every sentence adds value, though the long run-on sentence about return structure could be slightly better organized. It is appropriately sized for the complexity of the output format.

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 read-only report tool with no output schema, the description is remarkably complete: it explains the return structure, row types, value alignment, id behavior, zero-row handling, filter confirmation, and no-data signaling. The parameter schema covers all inputs. Nothing an agent needs to call this tool and interpret its response is missing.

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 100%, so the schema already documents all parameters. The description adds context about how filters appear in the response (filters lists confirmed filters, ignored parameters are absent), which helps understand parameter behavior, but it does not add syntax or format details beyond the schema. Baseline 3 is appropriate.

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?

The description states a specific verb ('Generate') and resource ('QuickBooks vendor balance detail report'), and the detailed return-format explanation distinguishes it from sibling report tools like get_vendor_balance, get_aged_payable_detail, and get_vendor_expenses. It clearly identifies what the tool produces and how the output is structured.

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

Usage Guidelines4/5

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

The description implies usage context by naming the report type and listing filter parameters, but it does not explicitly state when to prefer this over sibling report tools (e.g., get_vendor_balance vs get_vendor_balance_detail). The parameter schema provides the filter options, but there is no explicit when/when-not guidance or alternative tool names.

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