Skip to main content
Glama

Codat MCP by usefulapi

List bill payments

codat_list_bill_payments
Read-only

List a company's bill payments (money paid out to suppliers) — id, supplierRef, date, currency, totalAmount, lines. Codat API: GET /companies/{companyId}/data/billPayments. Returns the paged envelope.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (default 1).
queryNoCodat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying.
orderByNoField to order results by, e.g. "-modifiedDate" (leading "-" for descending).
pageSizeNoRecords per page (1-2000, default 100).
companyIdYesThe Codat companyId (UUID).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds useful behavioral context beyond that: it names returned fields (id, supplierRef, date, currency, totalAmount, lines), gives the exact API path, and states the response shape as a 'paged envelope'.

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?

The purpose is front-loaded in the first sentence, the endpoint and return shape follow immediately, and every sentence earns its place. There is no wasted text, and the parenthetical field list is compact and useful.

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 read-only list tool with rich schema coverage and an output-less design, the description supplies what structured fields do not: the exact API route, the semantic meaning of 'bill payments', field-level return content, and the paged envelope shape. Nothing an agent needs in order to call it correctly is missing.

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 the schema already fully documents page, query, orderBy, pageSize, and companyId. The description only reinforces companyId via the endpoint path and adds no extra meaning for the pagination or filtering parameters, making the baseline 3 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 ('List') and resource ('bill payments'), and immediately clarifies the resource with '(money paid out to suppliers)' and the returned fields. This distinguishes it from sibling list tools such as codat_list_payments and codat_list_bills without needing to open their schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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

The description gives no explicit when-to-use guidance, no when-not-to-use conditions, and never names an alternative sibling tool. It states what the tool does but leaves the agent to infer that this is the right choice for supplier payments versus customer payments.

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.