Skip to main content
Glama
beel-es

BeeL MCP server

Official
by beel-es
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

beel_list_recurring_invoices

Read-onlyIdempotent

Lists recurring invoice templates for a company, with filters by status, customer, or pause reason, plus sorting and pagination.

Instructions

Lists the recurring invoice templates of this company, with filters and pagination. Only the templates of the company in the path are returned.

Endpoint: GET /v1/companies/{company_id}/recurring-invoices

⚠️ Read before calling:

  • Fiscal rules, domains simplified, taxes: beel_rules_list with domain, or resource beel://guardrails/.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number, starting at 1. The response echoes it back as `pagination.current_page`.
limitNoHow many items to return per page. The response echoes it back as `pagination.items_per_page`.
statusNoKeeps only the schedules in this lifecycle state. Omitted, every state is listed.
sort_byNoField to sort by. Defaults to `created_at` when omitted.
company_idYesUnique identifier (UUID) of the company the operation acts on — its identifier, not its NIF. It is the only source of context: the account that owns it is derived from it, and the `BeeL-Active-Company` header plays no part. A company you do not reach answers `403`, and so does a company that does not exist, so the existence of a company in another account is never disclosed.
sort_orderNoSort direction. Defaults to `desc` when omitted.
customer_idNoKeeps only the schedules that invoice this customer of the company.
pause_reasonNoKeeps only the schedules stopped for this reason — the same value the response returns in `pause.reason`. A single value; repeating the parameter is rejected. It combines with `status` as an AND, with no special case: `status=ACTIVE` together with any `pause_reason` answers `200` with an empty list, because an active schedule has no pause to have a reason. Sending it alone already implies `PAUSED`, since that is the only state that records one.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.9.0
    • addedInput schema / $defs / RecurringInvoicePauseReason
      Added value: +{
+  "description": "Who stopped the schedule. `USER` a person did, from the API or the dashboard; `DOWNGRADE` the\naccount lost the recurring-invoices feature; `GENERATION_FAILURE` an unattended run failed with\nsomething waiting will not fix — that one carries a `blocker`.\n",
+  "enum": [
+    "USER",
+    "DOWNGRADE",
+    "GENERATION_FAILURE"
+  ],
+  "type": "string"
+}
    • addedInput schema / $defs / RecurringInvoiceSortBy / description
      Added value: +"Field to sort by: `name` the template name, `next_generation` the next scheduled\ngeneration date, `status` the lifecycle state, `created_at` the creation instant.\n\n`next_generation` orders by the schedule stored on the template, which is not always the\ndate the response publishes: a template that carries `null` — `COMPLETED`, or `PAUSED` with\na date already behind — is still ordered by the date it keeps. The ordering is stable and\nthe same for two requests of the same page; it does not depend on today's date.\n"
    • changedInput schema / $defs / RecurringInvoiceStatus / description
      Previous value: -"Lifecycle state of a recurring invoice schedule."New value: +"Lifecycle state of a recurring invoice schedule.\n\n- `ACTIVE`: invoices are generated on schedule.\n- `PAUSED`: automatic generation is stopped and the schedule is kept; `pause` says who\n  stopped it. It can be resumed.\n- `COMPLETED`: the schedule has ended for good and generates nothing more; `completion`\n  says why. Terminal: it cannot be resumed or paused.\n"
    • addedInput schema / properties / customer_id / description
      Added value: +"Keeps only the schedules that invoice this customer of the company."
    • addedInput schema / properties / pause_reason
      Added value: +{
+  "$ref": "#/$defs/RecurringInvoicePauseReason",
+  "description": "Keeps only the schedules stopped for this reason — the same value the response returns\nin `pause.reason`. A single value; repeating the parameter is rejected.\n\nIt combines with `status` as an AND, with no special case: `status=ACTIVE` together with\nany `pause_reason` answers `200` with an empty list, because an active schedule has no\npause to have a reason. Sending it alone already implies `PAUSED`, since that is the\nonly state that records one.\n"
+}
    • addedInput schema / properties / status / description
      Added value: +"Keeps only the schedules in this lifecycle state. Omitted, every state is listed."
  2. Changed3 schema fields changedv0.5.0
    • removedInput schema / $defs / RecurringInvoiceStatus / example
      Removed value: -"ACTIVE"
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / company_id / description
      Previous value: -"NIF (company) the operation acts on. It is the only source of context: the account that owns it is derived from it, and the `BeeL-Active-Company` header plays no part. A NIF you do not reach answers `403`, and so does a NIF that does not exist, so the existence of a NIF in another account is never disclosed."New value: +"Unique identifier (UUID) of the company the operation acts on — its identifier, not its NIF. It is the only source of context: the account that owns it is derived from it, and the `BeeL-Active-Company` header plays no part. A company you do not reach answers `403`, and so does a company that does not exist, so the existence of a company in another account is never disclosed."
  3. First observedv0.3.1

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is fully covered. The description adds the company-scoping constraint, which is useful but already implied by the path/schema; it says nothing about pagination behavior, list size, or what the response contains.

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?

Two concise sentences plus a short endpoint line and a focused cross-reference block; the core purpose is front-loaded. The endpoint string is somewhat redundant with the schema but costs little.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/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 should carry more of the return-shape burden for an 8-parameter list tool, yet it stops at scoping. The rich schema and full annotation coverage compensate enough that the definition is callable, but it is not complete on its own.

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 one of the 8 parameters is documented in the schema itself, including the AND-combination quirk of status+pause_reason. The description adds no parameter meaning beyond what the schema already states, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names a specific verb+resource ('Lists the recurring invoice templates of this company') and adds scope ('Only the templates of the company in the path are returned'). It is distinguishable from sibling list tools (beel_list_invoices, beel_list_customers, beel_list_series), though it never explicitly contrasts itself with them or with beel_get_recurring_invoice.

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

Usage Guidelines3/5

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

Usage is implied by the resource name and the filters described in the schema, but there is no explicit 'use this when / use X instead' guidance versus siblings like beel_get_recurring_invoice or beel_get_recurring_invoice_stats. The ⚠️ block only routes the agent to beel_rules_list for fiscal rules, which is supplementary rather than selection guidance.

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