Skip to main content
Glama

get_client_invoice

Read-only

Get the full financial and delivery summary for one issued client invoice, including subtotal, markup, tax, advance applied, balance due, dates, status, source report, and private Google Doc/PDF/DOCX links when available. Provide invoiceId or invoiceNumber — one is required; invoiceNumber is accepted only when it is unique. Read-only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
invoiceIdNoStable invoice ID from list_client_invoices. Required unless invoiceNumber is supplied.
clientEmailNoClient account email. Accountants may use this only for an accepted ExpenseBot client.
invoiceNumberNoHuman invoice number when invoiceId is unavailable; it must identify one unique invoice.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
invoiceNoThe invoice record. Absent only on the error branch (not-found), which never carries structuredContent.
messageNo
successYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "properties": {
      +    "invoice": {
      +      "additionalProperties": true,
      +      "description": "The invoice record. Absent only on the error branch (not-found), which never carries structuredContent.",
      +      "properties": {
      +        "advanceApplied": {
      +          "type": "number"
      +        },
      +        "balanceDue": {
      +          "type": "number"
      +        },
      +        "billClientUrl": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "clientName": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "clientTag": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "currency": {
      +          "type": "string"
      +        },
      +        "deliveryStatus": {
      +          "type": "string"
      +        },
      +        "displayStatus": {
      +          "description": "Derived: overdue is computed from status + dueDate, not stored.",
      +          "enum": [
      +            "open",
      +            "overdue",
      +            "paid",
      +            "void",
      +            "superseded",
      +            "needs_review"
      +          ],
      +          "type": "string"
      +        },
      +        "documentUrl": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "dueDate": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "grandTotal": {
      +          "type": "number"
      +        },
      +        "invoiceId": {
      +          "description": "Durable invoice identity.",
      +          "type": "string"
      +        },
      +        "invoiceNumber": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "issueDate": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "paidAmount": {
      +          "description": "null until paid.",
      +          "type": [
      +            "number",
      +            "null"
      +          ]
      +        },
      +        "paidDate": {
      +          "description": "null until paid.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "pdfUrl": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "reportUrl": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "status": {
      +          "description": "Stored status, e.g. \"open\", \"paid\", \"void\".",
      +          "type": "string"
      +        },
      +        "subtotal": {
      +          "type": "number"
      +        },
      +        "taxAmount": {
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "message": {
      +      "type": "string"
      +    },
      +    "success": {
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "success"
      +  ],
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -{
      -  "additionalProperties": true,
      -  "description": "Standard ExpenseBot tool result envelope. `message` is the human-readable summary the AI cites; `data` is the structured payload (totals, breakdowns, ids, etc.). On failure, `success` is false and `error` carries a code/message/hint triple.",
      -  "properties": {
      -    "data": {
      -      "additionalProperties": true,
      -      "description": "Structured payload. Shape varies per tool — common keys: total, breakdown, comparison, sampleMeta, ids, expenseId, reportId, signupUrl, results.",
      -      "type": "object"
      -    },
      -    "error": {
      -      "additionalProperties": true,
      -      "description": "Present only when success === false.",
      -      "properties": {
      -        "code": {
      -          "type": "string"
      -        },
      -        "hint": {
      -          "type": "string"
      -        },
      -        "message": {
      -          "type": "string"
      -        }
      -      },
      -      "type": "object"
      -    },
      -    "message": {
      -      "description": "Human-readable result text. Always present on success; prefer rendering this verbatim before any further reasoning.",
      -      "type": "string"
      -    },
      -    "sampleMeta": {
      -      "additionalProperties": true,
      -      "description": "Set when the underlying dataset was truncated. isTruncated=true means the agent saw a sample of `sampleCount` of `totalCount` rows; aggregate totals are still accurate.",
      -      "properties": {
      -        "isTruncated": {
      -          "type": "boolean"
      -        },
      -        "sampleCount": {
      -          "type": "integer"
      -        },
      -        "totalCount": {
      -          "type": "integer"
      -        }
      -      },
      -      "type": "object"
      -    },
      -    "success": {
      -      "description": "False on tool errors; check before reading `data`.",
      -      "type": "boolean"
      -    }
      -  },
      -  "type": "object"
      -}New value: +null
  3. Changed2 schema fields changed
    • changedInput schema / properties / invoiceId / description
      Previous value: -"Stable invoice ID from list_client_invoices."New value: +"Stable invoice ID from list_client_invoices. Required unless invoiceNumber is supplied."
    • changedInput schema / properties / invoiceNumber / description
      Previous value: -"Human invoice number when invoiceId is unavailable."New value: +"Human invoice number when invoiceId is unavailable; it must identify one unique invoice."
  4. Added

TDQS

A4.2/5.0
Behavior4/5

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

Description explicitly states read-only behavior, consistent with the annotation, and adds detail about return contents and the 'when available' caveat for private document links.

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?

Front-loaded purpose, enumerates the key returned fields, states the input requirement and read-only nature. Dense but efficient; no filler.

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?

The description explains what data is returned, how to identify the invoice, availability caveats, and read-only safety. Combined with schema and annotations, nothing essential is missing for a getter.

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 descriptions already fully document the parameters; tool description reinforces the one-required rule and uniqueness condition but adds little beyond schema. No contradiction.

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?

Uses a specific verb ('Get') and a clear resource ('full financial and delivery summary for one issued client invoice'), and enumerates the returned fields. This distinguishes it from list/prepare/update invoice siblings.

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?

Provides clear guidance on the required identifier, the one-required rule, and the uniqueness constraint on invoiceNumber. Does not explicitly name alternatives, but the usage context is clear.

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.