Skip to main content
Glama

Invoice Ninja: Record payment

invoice-ninja_record_payment

Invoice Ninja: Record money received against an invoice, with date, type and bank reference. Records a payment for the invoice client and applies it to the invoice. Without an amount it covers the full balance. A smaller amount leaves the invoice in Partial status, and an amount above the balance leaves the extra on the payment as an unapplied balance. Payment date defaults to today; set it to the day the money arrived, because reports use it. Send email is on by default, as in Invoice Ninja, and sends the client a payment confirmation. By default you confirm each call; you can switch that off for this tool. Reaches other people: confirm with the user before each call. Needs the user's Cotlet API key with access to this app.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
amountNoAmount received. Default: the full invoice balance.
companyNoCompany name, for accounts with several companies. Default: the company open when you signed in.
send_emailNoSend the client a payment confirmation. Default: true.
payment_dateNoDay the money arrived. Default: today.
payment_typeNoPayment type as listed in Invoice Ninja, e.g. Bank Transfer, Cash or Cheque.
private_notesNoInternal note, never shown to the client.
invoice_numberYesInvoice number from list_invoices or create_invoice, e.g. INV-0038.
transaction_referenceNoBank reference or cheque number.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations only declare readOnly=false, destructive=false, openWorld=true. The description goes well beyond: it explains the partial/unapplied-balance consequences of amount, that send_email triggers an outbound client confirmation, that a confirmation step is applied by default, and that a Cotlet API key with app access is required.

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 with the core action and amount behavior, then defaults and safety notes. Mostly every sentence earns its place, though 'Records a payment for the invoice client and applies it to the invoice' partially restates the opening line.

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 mutation tool with external side effects (client email, invoice status changes, confirmation gating, auth requirement) and no output schema, the description covers everything an agent needs to invoke it safely and correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 100% and documents most defaults, but the description adds real semantics the schema lacks: the downstream invoice-status effect of an amount below vs. above the balance, and why the payment_date matters for reports.

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?

Opens with a specific verb+resource ('Record money received against an invoice') and immediately names the key fields involved (date, type, bank reference). It is clearly distinguishable from siblings like list_payments or send_invoice without opening any 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 concrete usage context: the amount rules (default full balance, partial, overpayment), the payment_date guidance tied to reporting, and the send_email default. It never names a sibling alternative explicitly, so it stops short of a 5.

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