Referencia de la APICalendarios de nómina
Listar
Descripcion general
Este endpoint permite obtener un listado paginado de los calendarios de nómina de tu organización. Los resultados se devuelven en formato JSON e incluyen metadatos de paginación. Un calendario es por razón social: sus periodos son específicos de la razón social a la que pertenece. Los calendarios eliminados se excluyen automáticamente.
Endpoint
GET
https://app.integranom.com/api/v1/payroll-calendarsConsulta multiples calendarios de nomina
Devuelve todos los calendarios de la organización, paginados de 20 en 20. Puedes acotar el listado por frecuencia o por su flag activo.
Query params
| Parametro | Tipo | Requerido | Default | Descripcion |
|---|---|---|---|---|
page | integer ≥ 1 | No | 1 | Página solicitada. El tamaño de página es fijo en 20. |
frequency | weekly | biweekly | semimonthly | monthly | No | - | Filtra por la frecuencia del calendario. |
active | "true" | "false" | No | - | Filtra por el flag is_active. |
Consulta calendarios de una razon social
Se puede buscar un calendario particular por su número, o filtrar por la razón social a la que pertenecen. Ambos filtros hacen coincidencia exacta.
Query params
| Parametro | Tipo | Requerido | Default | Descripcion |
|---|---|---|---|---|
payroll_calendar_number | integer | No | - | Filtra por número de calendario exacto. |
legal_entity_number | integer | No | - | Filtra por la razón social del calendario. |
Errores
| Status | Causa |
|---|---|
400 | Valor inválido en algún filtro (payroll_calendar_number, legal_entity_number, frequency o active). |
401 | API key ausente o inválida. |