Reports

Consultar detalle de retenciones

Herramienta MCP: reports_get_retentions_detail.

Devuelve el detalle de los documentos que componen las retenciones (practicadas o recibidas) de la compañía en un periodo. El parámetro type define la ruta interna y sus valores dependen del país.

Notas por país: para empresas de México usa únicamente retentions-in o retentions-out, que consultan retrieve-all-transactions-with-retentions y devuelven { success, transactions } sin paginación. Para todos los demás países usa sales (retenciones en ventas) o bills (retenciones en compras), que consultan taxes-retentions v2 con paginación por page y limit. Los filtros distintos de las fechas y de type solo aplican fuera de México.

Úsala cuando el usuario pida el detalle documento por documento de las retenciones: qué documentos las generaron, con qué base, porcentaje y valor. Para el reporte agregado del periodo usa reports_get_retentions_report en su lugar.

Ejemplo de llamada JSON-RPC:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "reports_get_retentions_detail",
    "arguments": { "dateFrom": "2026-09-01", "dateTo": "2026-09-30", "type": "bills" }
  }
}

Los parámetros dateFrom, dateTo y type son obligatorios; las fechas van en formato YYYY-MM-DD y type se envía exactamente con los valores indicados, sin traducirlo.

Solo lectura.

post/tools/reports_get_retentions_detail

Request

  • Base URL
    https://mcp.alegra.com
  • URL
    https://mcp.alegra.com/tools/reports_get_retentions_detail
  • Auth
    HTTP bearer

Request body

dateFromstring required

Fecha inicial del periodo, en formato YYYY-MM-DD.

dateTostring required

Fecha final del periodo, en formato YYYY-MM-DD.

type'sales' | 'bills' | 'retentions-in' | 'retentions-out' required

Tipo de retención, exactamente como lo espera cada endpoint: sales (ventas) o bills (compras) en todos los países excepto México; retentions-in o retentions-out solo en México. No traducir.

retentionIdstring

Filtra por una retención específica (idRetention). Solo aplica fuera de México.

customerIdstring

Filtra por tercero/cliente (idClient). Solo aplica fuera de México.

documentNumberstring

Filtra por número de documento. Solo aplica fuera de México.

documentTypestring

Filtra por tipo de documento. Solo aplica fuera de México.

datestring

Filtra por un solo día, en formato YYYY-MM-DD. Solo aplica fuera de México.

economicActivityIdstring

Filtra por actividad económica. Solo aplica fuera de México.

pageinteger

Número de página (base 1). Por defecto 1. Solo aplica fuera de México.

limitinteger

Máximo de resultados por página. Por defecto 10. Solo aplica fuera de México.

Response

Detalle de los documentos que componen las retenciones del periodo

Changes

No recorded changes to this operation across all 1 revision of this API.