docs: documentar parametros de los endpoints tras unificar anio/mes

Solo cubre parametros de entrada; la estructura de las respuestas no cambio.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AyxL2mSnUE9XyUFHw8zDmM
parent fa02dd40
# Parámetros de los endpoints — renta de quinta categoría
Solo documenta parámetros de entrada (query/path). Las respuestas no cambiaron de estructura.
Base: `/api/v1/renta-quinta`
`anio` y `mes` son los nombres usados en **todos** los endpoints — antes `/listado` usaba
`periodo`/`mesCorte`, ahora unificado.
## GET `/listado`
Grilla paginada de retenciones, con cálculo.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| `anio` | Integer | sí | Periodo (año) de la grilla |
| `mes` | Integer (1-12) | sí | Mes de corte |
| `sede` | Integer | no | Filtro de catálogo (comparado como texto) |
| `tipoPlanilla` | Integer | no | Filtro de catálogo (comparado como texto) |
| `areaGeneral` | Integer | no | Filtro de catálogo (comparado como texto) |
| `subArea` | Integer | no | Filtro de catálogo (comparado como texto) |
| `cargo` | Integer | no | Filtro de catálogo (comparado como texto) |
| `documentoOApellidos` | String | no | `numero_documento` o apellidos + nombres, `LIKE` en mayúsculas |
| `page` | Integer | no (default 0) | Página |
| `size` | Integer | no (default 20, tope 100) | Tamaño de página |
## GET `/{id}`
Boleta completa por `id_renta_quinta`.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| `id` (path) | Long | sí | `id_renta_quinta` |
## GET `/detallado`
Detalle completo del cálculo (boleta del mes + historial de ingresos, parámetros SUNAT,
liquidación anual, escala por tramos y control de retenciones).
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| `numeroDocumento` | String | sí | Documento del trabajador |
| `anio` | Integer | sí | Periodo (año) |
| `mes` | Integer (1-12) | sí | Mes de corte |
## GET `/boleta`
Boleta puntual por `codper` + `anio` + `mes`.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| `codper` | Integer | sí | Código de personal |
| `anio` | Integer | sí | Periodo (año) |
| `mes` | Integer (1-12) | sí | Mes de la boleta |
## GET `/historial/{codper}/{anio}`
Meses del trabajador en el periodo.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| `codper` (path) | Integer | sí | Código de personal |
| `anio` (path) | Integer | sí | Periodo (año) |
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment