Corridas de nómina
Cálculo del pago de los empleados para un periodo de pago.
- Nombre API:
payrollruns - Dominio: Nómina
- Módulos: Recursos humanos
Campos
El nombre API es el que usan la API, MCP y la CLI.
| Nombre | Nombre API | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
| ID | id | ID de registro | Sí | |
| Nombre | label | Texto I18n | ||
| Folio | uid | Texto | El folio es un identificador único y legible para el registro. | |
| Fecha contable | date | Fecha | Sí | Fecha calendario de este valor. |
| Usuario | userId | Usuario | ||
| Periodo de pago | payrollperiodId | Referencia | Sí | |
| Registro fiscal | taxregistrationId | Referencia | ||
| Tipo | kind | Constante | Sí | |
| Neto | net | Importe con signo | Importe monetario con signo; se permiten valores negativos. | |
| Valores legales | statutoryValueIds | JSON | ||
| Importe a repartir (PTU) | amountDistributable | Moneda | Utilidades repartibles usadas como base de la PTU en esta corrida. | |
| Bruto | gross | Moneda | ||
| Impuesto retenido | taxWithheld | Moneda | ||
| Aportaciones patronales | employerContributions | Moneda | ||
| Deducciones | deductions | Moneda | ||
| Otros pagos | otherPayments | Moneda | ||
| Créditos | credits | Moneda | ||
| Motivo de cancelación | cancelReason | Campo de Texto | Explicación obligatoria al cancelar este registro. | |
| Motivo de reapertura | unapproveReason | Campo de Texto | Explicación obligatoria al revertir la aprobación. | |
| Tags | tagIds | Tags | ||
| Descripción | description | Campo de Texto | ||
| Creado por | createdBy | Usuario | ||
| Creado el | createdAt | Fecha y Hora | Sí | |
| Actualizado por | updatedBy | Usuario | ||
| Actualizado el | updatedAt | Fecha y Hora | Sí | |
| Iniciado por | startedBy | Usuario | ||
| Iniciado el | startedAt | Fecha y Hora | ||
| Procesado por | processedBy | Usuario | ||
| Procesado el | processedAt | Fecha y Hora | ||
| Pagado por | paidBy | Usuario | ||
| Pagado el | paidAt | Fecha y Hora | ||
| Calculado por | calculatedBy | Usuario | ||
| Calculado el | calculatedAt | Fecha y Hora | ||
| Aprobado por | approvedBy | Usuario | ||
| Aprobado el | approvedAt | Fecha y Hora | ||
| Cancelado por | canceledBy | Usuario | ||
| Cancelado el | canceledAt | Fecha y Hora | ||
| Bloqueado por | blockedBy | Usuario | ||
| Bloqueado el | blockedAt | Fecha y Hora | ||
| Archivado por | archivedBy | Usuario | ||
| Archivado el | archivedAt | Fecha y Hora |
Relaciones
Los registros poseídos (línea sólida) se eliminan con su dueño. Los registros agrupados (línea punteada) pueden existir solos.
| Campo | Apunta a | Tipo |
|---|---|---|
Usuario userId | Usuarios | referencia |
Periodo de pago payrollperiodId | Periodos de nómina | referencia |
Registro fiscal taxregistrationId | Registros fiscales | referencia |
Tags tagIds | Tags | referencia |
Acciones
Lo que puedes hacer con un registro. Cada acción también envía el evento de webhook payrollruns.<acción>. Las lecturas (find, get, count) funcionan en toda tabla.
| Nombre | Nombre API | Descripción | Dónde |
|---|---|---|---|
| Crear | create | Crea una corrida. | App · WebMCP · API · MCP · CLI |
| Editar | update | Guarda los cambios de la corrida. | App · WebMCP · API · MCP · CLI |
| Aprobar | approve | Aprueba el documento para que el siguiente paso pueda continuar. | App · WebMCP · API · MCP · CLI |
| Iniciar | start | Marca la corrida como iniciada antes del cálculo. | App · WebMCP · API · MCP · CLI |
| Procesar | process | Registra el documento. No se puede deshacer. | App · WebMCP · API · MCP · CLI |
| Cancelar nómina | cancel | Revierte el efecto registrado de la acción. | App · WebMCP · API · MCP · CLI |
| Calcular | calculate | Calcula percepciones, deducciones e impuestos de todos los recibos de la nómina. | App · API · MCP · CLI |
| Bloquear | block | Impide editar y eliminar la corrida. Sigue visible y puede seguir en documentos existentes. Desbloquéala para volver a cambiarla. | App · WebMCP · API · MCP · CLI |
| Desbloquear | unblock | Permite de nuevo editar y eliminar la corrida. | App · WebMCP · API · MCP · CLI |
| Archivar | archive | Retira la corrida del uso diario. Sale de las listas y los selectores activos, y la mayoría de las acciones se detienen. Desarchívala para restaurarla. | App · WebMCP · API · MCP · CLI |
| Restaurar | unarchive | Devuelve la corrida a las listas y las acciones activas. | App · WebMCP · API · MCP · CLI |
| Eliminar | delete | Elimina la corrida y los datos que le pertenecen. No se puede deshacer. | App · WebMCP · API · MCP · CLI |
Estados
Cómo pasa un registro de un estado a otro. Archivar y bloquear pueden ocurrir en cualquier estado.
| Acción | Nombre API |
|---|---|
| Aprobar | approve |
| Iniciar | start |
| Cancelar nómina | cancel |
| Quitar aprobación | unapprove |
| Procesar | process |
| Calcular | calculate |