Skip to main content
Glama

Caribooks (QuickBooks Online)

get customer balance detail

get_customer_balance_detail
Read-only

Generate the QuickBooks customer 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, ...); aging_method (Report_Date|Current); start_duedate, end_duedate (YYYY-MM-DD); customer, department, term, shipvia, arpaid (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

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is known. The description adds valuable behavioral details: how rows are structured (type, depth, values), the meaning of 'id' and its alignment on detail vs summary reports, the omission of all-zero rows (counted in hidden_zero_rows), the 'filters' field reflecting applied parameters, and 'no_data' flag. This goes beyond annotations and clarifies output behavior.

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 a single dense sentence but packs in essential details about the return format and behavioral quirks. It is front-loaded with the purpose, then explains the output structure. While it could be broken into shorter sentences for readability, it contains no fluff and each clause adds value.

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?

Given the tool's complexity (many parameters, a detailed report) and the absence of an output schema, the description explains the return structure thoroughly: columns, column_types, rows with type/depth/values, id alignment, hidden_zero_rows, filters, and no_data. This is sufficient for an agent to understand what the tool returns. Minor gaps exist (e.g., does not describe what the report contains beyond 'balance detail'), but the core context is covered.

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?

The schema description coverage is 100%, meaning all parameters (report_date, date_macro, aging_method, customer, columns, etc.) are already documented in the input schema. The description does not add any parameter-specific semantics beyond what the schema provides. Since the schema carries the full burden, a baseline of 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 clearly states the tool's purpose: 'Generate the QuickBooks customer balance detail report.' This is a specific verb (generate) and resource (customer balance detail report), distinguishing it from summary reports like get_customer_balance by the word 'detail.' The purpose is unambiguous and matches the tool name.

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 does not explicitly state when to use this tool versus alternatives. It focuses on the output structure and behavior but provides no guidance on when to choose this over get_customer_balance, get_aged_receivable_detail, or other report tools. Usage is implied by the name and the fact it generates a specific report, but there is no explicit context or exclusions.

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