Skip to main content
Glama

Invoice Ninja: List payments

invoice-ninja_list_payments
Read-only

Invoice Ninja: Payments with client, date, amount, type, reference and the invoices they were applied to. Lists recorded payments, newest first. Status is Unapplied, Partially Unapplied, Paid or Refunded, as in the Payments list. Each item shows the invoices the payment was applied to and how much went to each. Use it before record_payment to check that a bank transfer was not already entered. Pages hold up to 100 payments; pass next_cursor back as cursor for the next page. Needs the user's Cotlet API key with access to this app.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo1 to 100. Default: 20.
cursorNoNext page cursor from the previous call.
companyNoCompany name, for accounts with several companies. Default: the company open when you signed in.
date_toNoOnly payments dated on or before this day.
client_idNoOnly payments of this client.
date_fromNoOnly payments dated on or after this day.

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?

Annotations cover the safety profile (readOnly/destructive/openWorld), and the description adds ordering (newest first), pagination (up to 100 per page, cursor passthrough), status values, return structure, and an auth requirement (Cotlet API key with app access) — rich context beyond structured fields.

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 purpose and the practical 'check before recording' guidance, but seven sentences is slightly long; the detailed return-field enumeration overlaps with what the list already implies.

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?

With no output schema, the description carries the burden of describing return values, ordering, pagination, statuses, and auth — and it does so completely enough that an agent can call and interpret the result correctly.

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 coverage is 100%, so the schema documents all six parameters. The description only reinforces limit/cursor via the pagination sentence, adding little syntax or format detail beyond what the schema already provides. Baseline 3 applies.

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 ('Lists recorded payments') plus the exact fields returned (client, date, amount, type, reference, applied invoices). It distinguishes itself from the mutating sibling by framing the read use case against record_payment.

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 an explicit use case: 'Use it before record_payment to check that a bank transfer was not already entered.' This routes the agent to a concrete workflow, though it names no alternative read tools or when-not-to-use conditions.

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