Skip to main content
Glama
beel-es

BeeL MCP server

Official
by beel-es
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

beel_get_recurring_invoice_history

Read-onlyIdempotent

Retrieve the full history of a recurring invoice schedule—including generated, skipped, failed, and paused periods—to see why an invoice is missing; paginated newest first.

Instructions

Returns every entry in this schedule's history, newest first: the invoices it generated and, just as important, the periods it did not — a failed unattended run, a slot a user skipped, or the schedule being paused. Each entry carries its type, the origin of who asked for it, a translated reason when there is one, and requested_by for a skip. That is what lets you answer "why is there no invoice for March?" without reading logs.

Only GENERATED entries have an invoice_id; for the rest it is null.

Paginated with the usual page/limit, and the usual defaults: without them you get the 20 most recent entries, not the whole history — which grows with every cycle the template runs. Read data.pagination to walk the rest.

The deprecated flat alias GET /v1/recurring-invoices/{recurring_invoice_id}/history does not paginate and returns only generated invoices: it is frozen as it shipped until its Sunset date. Only this route returns every entry type.

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

⚠️ 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`.
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.
recurring_invoice_idYesUnique identifier (UUID) of the recurring invoice template, as returned when it is created or listed. A template of another company answers `404` with `RECURRING_NOT_FOUND`, exactly like one that does not exist.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.9.0
    • addedInput schema / properties / recurring_invoice_id / description
      Added value: +"Unique identifier (UUID) of the recurring invoice template, as returned when it is created or listed. A template of another company answers `404` with `RECURRING_NOT_FOUND`, exactly like one that does not exist."
  2. Changed4 schema fields changedv0.5.0
    • 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."
    • addedInput schema / properties / limit
      Added value: +{
+  "default": 20,
+  "description": "How many items to return per page. The response echoes it back as `pagination.items_per_page`.",
+  "maximum": 100,
+  "minimum": 1,
+  "type": "integer"
+}
    • addedInput schema / properties / page
      Added value: +{
+  "default": 1,
+  "description": "Page number, starting at 1. The response echoes it back as `pagination.current_page`.",
+  "minimum": 1,
+  "type": "integer"
+}
  3. First observedv0.3.1

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), yet the description adds substantial behavior: entries include non-generated periods with translated reason and origin, invoice_id is null unless GENERATED, pagination defaults to 20 newest entries, and the deprecated alias is frozen until Sunset. This is context an agent could not infer from annotations alone.

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 key capability, then pagination, then the deprecated-alias caveat, using bold to mark the load-bearing points. Slightly long with the trailing fiscal-rules warning, but nearly every sentence carries distinct information.

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 fully carries the burden of explaining return shape — entry fields (type, origin, reason, requested_by, nullable invoice_id) and pagination traversal via data.pagination. For a read tool with rich annotations, nothing an agent needs to invoke and interpret it 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 documents page, limit, company_id, and recurring_invoice_id (including 403/404 behavior). The description reinforces pagination meaning ('without them you get the 20 most recent, not the whole history') but adds no field-level syntax beyond what the schema provides, so baseline 3 is 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?

The description states a specific verb and resource — returns every entry in a recurring-invoice schedule's history — and explicitly scopes it beyond generated invoices to skipped, failed, and paused periods. It cleanly distinguishes this tool from the deprecated flat alias, so an agent can tell them apart without opening schemas.

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?

It names the alternative route (the deprecated flat alias) and states the exact condition that selects this one ('Only this route returns every entry type'), including the Sunset caveat. It also routes fiscal-rule questions to beel_rules_list, covering both when-to-use and where-not-to-look.

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