NominexDocs
Referencia de la APICalendarios de nómina

Eliminar

Elimina un calendario de nómina.

Descripcion general

Este endpoint realiza el borrado del calendario de nómina: a partir de ese momento deja de aparecer en GET /api/v1/payroll-calendars y se trata como no encontrada en PATCH/DELETE (404). El borrado no es destructivo: las corridas de nómina ya cerradas siguen siendo reproducibles. Si hay empleados activos o pendientes asignados al calendario, la solicitud falla — primero debes reasignarlos a otro calendario.

Endpoint

DELETEhttps://app.integranom.com/api/v1/payroll-calendars/{payroll_calendar_number}

Path param: payroll_calendar_number — entero positivo, el número de calendario dentro de la organización.

Solicitud


Sin cuerpo. La API responde 204 No Content si el borrado tuvo éxito.

Comportamiento

  • Rechaza la solicitud (409) si hay empleados activos o pendientes asignados al calendario — la respuesta incluye affected_count. Reasígnalos a otro calendario y reintenta.
  • Marca el calendario como eliminado. La fila deja de aparecer en GET /api/v1/payroll-calendars.
  • Conserva el historial para lectura: las corridas ya cerradas siguen siendo reproducibles.

Errores

StatusCausa
400payroll_calendar_number inválido en la URL.
404El calendario no existe o ya fue eliminado en esta organización.
409Hay empleados activos o pendientes asignados — la respuesta incluye affected_count.

Ejemplo de cuerpo 409:

{
  "message": "Cannot deactivate a payroll calendar while active or pending employees are assigned to it. Reassign them first.",
  "affected_count": 12
}
Abrir Nominex