Listar pagos recibidos

Herramienta MCP: incomePayments_getIncomePayments.

Devuelve los pagos registrados en el libro de pagos de ingresos, con paginación (hasta 30 por página) y filtros. Por defecto devuelve una versión ligera de cada pago; con detail: true devuelve el payload completo.

Ejemplo de llamada JSON-RPC:

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

Paginación con start (cantidad de resultados a omitir) y limit (máximo 30 por página). Ordena con order_direction (ASC o DESC), busca por texto con query y filtra por dirección del pago con type: in para pagos recibidos (de clientes) o out para pagos salidas registrados en este mismo libro de pagos; úsala para listar "pagos" o "recibos" en cualquiera de las dos direcciones. Con fields amplías los campos de la respuesta y con metadata: true la respuesta se envuelve como { data: [...], metadata: { total } } en lugar de un arreglo plano. Con detail: false (valor por defecto) cada pago viene en versión ligera (ids, fechas, estado, número, cliente y montos); pide detail: true solo cuando el usuario pida el payload completo.

Para localizar un pago que el usuario identifica por su número visible, filtra con number: es una coincidencia por subcadena (por ejemplo "380" también coincide con "1000380"), no exacta, y NO es el id interno que usa incomePayments_getIncomePaymentById. Envía siempre el número completo que dio el usuario y, antes de usar el id devuelto, verifica que la respuesta tenga exactamente un resultado (metadata.total === 1) y que su campo number coincida exactamente con el buscado; si hay varias coincidencias, muéstralas y pide al usuario desambiguar.

Úsala para descubrir los id de los pagos que necesita incomePayments_getIncomePaymentById.

Solo lectura.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
≤ 30

Cantidad máxima de resultados a devolver. Máximo 30 por página.

integer

Cantidad de resultados a omitir para la paginación.

string
enum

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

Allowed:
string

Texto de búsqueda para filtrar los pagos.

string

Filtra por el número visible o consecutivo del pago (por ejemplo "1000380" o el prefijo más número como se muestra al usuario, "RC380"). Es una coincidencia por SUBCADENA, no exacta, y NO es el id interno que usa incomePayments_getIncomePaymentById (por ejemplo, el número visible "1000380" corresponde al id interno "2483"). Envía siempre el número completo que dio el usuario y, antes de usar el id devuelto, verifica que metadata.total === 1 y que el campo number coincida exactamente; si hay varias coincidencias, lista y pide desambiguar.

string
enum

Filtra por tipo de pago: in para pagos recibidos de clientes o out para pagos salidas registrados en este mismo libro de pagos.

Allowed:
string

Lista de campos separados por comas a incluir en la respuesta. Valores aceptados pendientes de verificar con una llamada real.

boolean

Si es true, la respuesta se envuelve como { data: [...], metadata: { total } } en lugar de devolver un arreglo plano.

boolean
Defaults to false

Cuando es false (valor por defecto), devuelve una versión ligera de cada pago (ids, fechas, estado, número, cliente y montos). Configúrala en true solo si el usuario pide el payload completo.

Responses

401

No autorizado (token de Alegra inválido o expirado).

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json