Skip to main content
Glama

Record invoice payment

crunch_add_invoice_payment

Record a full or partial customer payment against an issued invoice to track receivables; this does not reconcile the matching bank statement entry.

Instructions

Record a payment received from a customer against an issued invoice (full or part payment). This records the payment but doesn't reconcile the matching bank statement entry. Existing payments are kept.

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": {
      "invoice_id": "<invoice_id>",
      "date": "<date>",
      "amount": "<amount>"
    },
    "name": "crunch_add_invoice_payment"
  }
}

Input Schema

NameRequiredDescriptionDefault
dateYesDate the customer paid (YYYY-MM-DD)
amountYesAmount received, for example 120.00
dry_runNoPreview: return the request that would be sent (for an update, the fields that would change) without sending it
invoice_idYesInvoice ID (see crunch_list_invoices)
payment_methodNoPayment method name (default EFT; see crunch_list_payment_methods for=invoices)
bank_account_idNoBank account the money went into (defaults to the invoice's bank account)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.7.0

TDQS

A4/5.0
Behavior3/5

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

The description adds real value beyond the annotations by disclosing that existing payments are kept (additive, not a replacement) and that bank-statement reconciliation is out of scope. However, annotations declare idempotentHint=false, and the description never warns that retries will create duplicate payments, nor does it say what happens on overpayment or how the invoice status changes.

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

Conciseness5/5

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

Three short sentences, front-loaded with what the tool does, then the reconciliation caveat, then the non-destructive behavior. Nothing is redundant with the name or title.

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 six-parameter mutation tool with no output schema, the definition covers purpose, scope, and two key behavioral caveats. The remaining gap is what a successful call returns (payment ID, updated invoice balance), which the agent cannot learn from any structured field.

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 every parameter is already documented in structured form, including the dry_run preview and the defaulting rules for payment_method and bank_account_id. The description only adds the full/part-payment framing for the amount, so the 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?

States a specific verb and resource ('Record a payment ... against an issued invoice') plus the scope ('full or part payment'), which distinguishes it from the expense-payment sibling by naming the customer/invoice direction of the money flow. An agent can identify the operation 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 Guidelines4/5

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

Gives a clear usage context (payment received from a customer against an issued invoice) and one explicit boundary — it does not reconcile the matching bank statement entry — which steers the agent away from assuming a reconciliation tool. It stops short of naming an alternative tool or stating prerequisites such as the invoice needing to be issued/not already paid.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools