Skip to main content
Glama
nubiia-dev
by nubiia-dev

list_payments

Retrieve paginated payments from the active fiscal year using cursor paging and start/end date filters; use document-level payment details for cross-year audits.

Instructions

List all payments (Holded API v2). Cursor-paginated: pass the previous response nextCursor as cursor. Response fields are snake_case; amounts are strings with decimal comma. NOTE: this endpoint is filtered to the ACTIVE fiscal year, so payments made in a prior year do NOT appear here even if they are linked to documents. For cross-year payment audits, read a document's payments via get_document_payments (the document paymentsDetail). Use start_date/end_date (YYYY-MM-DD) to filter by date — live-verified against v2.

Input Schema

NameRequiredDescriptionDefault
limitNoMax items per page (server-paginated; use limit to control page size)
cursorNoCursor from a previous response nextCursor
endtmpNoLegacy: Unix timestamp (seconds) for end date. Converted to ISO YYYY-MM-DD. Ignored when end_date is also provided.
fieldsNoSelect specific fields to return (e.g., ["id", "name", "days", "discount"]). Reduces response size. If not provided, returns all fields from the API.
summaryNoReturn only count and pagination metadata without items (default: false)
end_dateNoFilter payments on or before this ISO date (YYYY-MM-DD). Forwarded directly to the v2 API.
starttmpNoLegacy: Unix timestamp (seconds) for start date. Converted to ISO YYYY-MM-DD. Ignored when start_date is also provided.
start_dateNoFilter payments on or after this ISO date (YYYY-MM-DD). Forwarded directly to the v2 API.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv2.0.3
    • addedInput schema / properties / cursor
      Added value: +{
      +  "description": "Cursor from a previous response nextCursor",
      +  "type": "string"
      +}
    • addedInput schema / properties / end_date
      Added value: +{
      +  "description": "Filter payments on or before this ISO date (YYYY-MM-DD). Forwarded directly to the v2 API.",
      +  "type": "string"
      +}
    • changedInput schema / properties / endtmp / description
      Previous value: -"Ending timestamp (Unix timestamp) for filtering payments by date"New value: +"Legacy: Unix timestamp (seconds) for end date. Converted to ISO YYYY-MM-DD. Ignored when end_date is also provided."
    • changedInput schema / properties / endtmp / type
      Previous value: -"string"New value: +"number"
    • changedInput schema / properties / fields / description
      Previous value: -"Select specific fields to return (e.g., [\"id\", \"name\", \"days\", \"discount\"]). Reduces response size by 70-90%. If not provided, returns default fields: id, name, days, discount"New value: +"Select specific fields to return (e.g., [\"id\", \"name\", \"days\", \"discount\"]). Reduces response size. If not provided, returns all fields from the API."
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of items to return (default: 50, max: 500)"New value: +"Max items per page (server-paginated; use limit to control page size)"
    • removedInput schema / properties / page
      Removed value: -{
      -  "description": "Page number for pagination (optional)",
      -  "type": "number"
      -}
    • addedInput schema / properties / start_date
      Added value: +{
      +  "description": "Filter payments on or after this ISO date (YYYY-MM-DD). Forwarded directly to the v2 API.",
      +  "type": "string"
      +}
    • changedInput schema / properties / starttmp / description
      Previous value: -"Starting timestamp (Unix timestamp) for filtering payments by date"New value: +"Legacy: Unix timestamp (seconds) for start date. Converted to ISO YYYY-MM-DD. Ignored when start_date is also provided."
    • changedInput schema / properties / starttmp / type
      Previous value: -"string"New value: +"number"
  2. First observedv1.6.0

TDQS

A4.1/5.0
Behavior3/5

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

No annotations exist, so the description carries the full burden. It does well on the big behavioral caveat — the active-fiscal-year scoping that silently hides older payments — plus cursor semantics, snake_case field naming, and decimal-comma amount strings. It says nothing about ordering, auth requirements, or how the fiscal-year restriction interacts with explicit start_date/end_date filters, which is a meaningful gap for a no-annotation tool.

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?

Purpose is front-loaded, followed by pagination, then the critical fiscal-year caveat and the alternative route, which is good ordering. It is dense and every sentence carries information, though the parenthetical API version and 'live-verified against v2' do not help an agent decide or invoke.

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?

With eight optional parameters, no annotations, and no output schema, the description supplies the pitfalls an agent actually needs: the hidden fiscal-year filter, the cursor flow, and the amount/field-naming quirks. It stops short of describing result ordering or whether the date range can override the fiscal-year scope, which matters given no output schema exists.

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 and the baseline is 3. The description reinforces cursor usage and the YYYY-MM-DD date format but adds no meaning beyond the schema for fields, summary, or the legacy starttmp/endtmp parameters. The most valuable parameter insight — whether date filters can escape the fiscal-year filter — is absent.

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 ('List all payments') with the API version, and immediately distinguishes itself from the closest sibling by naming get_document_payments for the cross-year case. An agent can tell list_payments apart from get_payment, create_payment, and get_document_payments 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 Guidelines5/5

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

Explicitly states when-not: prior-year payments do NOT appear because of the active-fiscal-year filter, and names the alternative (get_document_payments via the document's paymentsDetail) for cross-year audits. It also tells the agent how to paginate and how to filter by date, leaving nothing to inference.

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