Skip to main content
Glama
BeeL MCP server

BeeL MCP server

Official
by beel-es

beel_get_recurring_invoice_history

Read-onlyIdempotent

Retrieve all entries in a recurring invoice schedule's history: generated invoices plus skipped, failed, or paused periods to explain missing invoices. Paginate results, 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.

BeeL API endpoint: GET /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}/history (reference: https://docs.beel.es)

⚠️ Read before calling:

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

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "company_id": "<company_id>",
      "recurring_invoice_id": "<recurring_invoice_id>"
    },
    "name": "beel_get_recurring_invoice_history"
  }
}

Input 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 declare readOnly/idempotent/non-destructive, yet the description still adds substantial behavior: newest-first ordering, what entry categories exist (failed unattended run, user skip, paused schedule), that only GENERATED entries carry an invoice_id and the rest are null, and that history grows every cycle. The explicit warning that omitting page/limit yields only the 20 most recent entries is exactly the kind of trap an agent needs disclosed.

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 core behavior and pagination caveat, then the alias distinction, then the endpoint line. Bold emphasis and the trailing fiscal-rules guardrail note are slightly promotional for the value delivered, but nothing is redundant or buried.

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 shape and does so — type, origin, translated reason, requested_by, nullable invoice_id, and pagination metadata. Combined with pagination defaults and the alias caveat, an agent has everything needed to call this correctly and interpret results.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the parameters are already documented; the description adds the consequence of the defaults (20 most recent, not the whole history) and points at data.pagination for walking the rest, which goes beyond the schema's echo-back wording. It does not restate company_id/recurring_invoice_id semantics, which is appropriate since the schema covers them thoroughly.

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?

Opens with a specific verb and resource ("Returns every entry in this schedule's history, newest first") and immediately scopes it beyond generated invoices to failed runs, skips, and pauses. It is clearly distinguishable from beel_list_invoices and beel_get_recurring_invoice by that entry-type scope.

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 a concrete use case ("answer 'why is there no invoice for March?' without reading logs") and explicitly contrasts against the deprecated flat alias route that returns only generated invoices and does not paginate. It stops short of naming sibling MCP tools such as beel_get_recurring_invoice or beel_skip_recurring_invoice, so routing among tools is inferential rather than explicit.

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