Retentions

Listar retenciones

Herramienta MCP: retentions_getRetentions.

Devuelve las retenciones fiscales configuradas en la empresa, con paginación, búsqueda, filtro por estado y por tipo.

Ejemplo de llamada JSON-RPC:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "retentions_getRetentions",
    "arguments": { "start": 0, "limit": 30 }
  }
}

Paginación con start (índice desde el cual se comienza a devolver resultados, desde 0) y limit (cantidad máxima de retenciones a devolver). Filtra por texto con query (busca por nombre u otros atributos), por estado con status (ACTIVE o INACTIVE) y por categoría de tipo con type (valores pendientes de verificar con una llamada real).

Ordena con order_direction (ASC o DESC, en mayúsculas).

Úsala para descubrir los id de las retenciones que necesitan las herramientas de facturación u otras consultas.

Solo lectura.

post/tools/retentions_getRetentions

Request

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

Request body

startinteger

Índice desde el cual se comienzan a devolver retenciones para la paginación (desde 0).

limitinteger

Cantidad máxima de retenciones a devolver.

order_direction'ASC' | 'DESC'

Dirección de ordenamiento: ASC o DESC (en mayúsculas).

querystring

Texto de búsqueda para filtrar retenciones por nombre u otros atributos.

status'ACTIVE' | 'INACTIVE'

Filtra los resultados por estado de la retención: ACTIVE o INACTIVE.

typestring

Filtra los resultados por categoría de tipo de retención. Valores pendientes de verificar con una llamada real.

Response

Lista de retenciones

Changes

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