Actualizar pago de nómina

Actualizar los datos de un pago de nómina.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Reglas de negocio

  • Si el pago ya está en estado Pagada o Anulado, no se puede modificar bajo ninguna circunstancia, sin importar qué se envíe en el body.
  • Si el pago se paga con varias cuentas bancarias y alguna está suspendida/inactiva o no sincronizada, se rechaza antes de aplicar cualquier cambio.
  • Si se envía estado = "PG" (Pagada) y el pago no tiene sub-pagos por cuenta, se crea automáticamente un detalle de pago único usando la cuenta bancaria por defecto de la compañía.
  • Si tipoActualizacion = "ESTADO", el cambio debe respetar una máquina de estados: desde Por Pagar solo se permite pasar a Pagada; desde Pagada no se permite ningún cambio; cualquier transición inválida se rechaza.
  • Si el tipo de pago no es Liquidación Definitiva, se valida el número de empleados activos contra las licencias contratadas (puede bloquear si se supera el límite del plan).
  • Si el tipo de pago es Liquidación Definitiva y ya existe una transmisión de nómina electrónica con fecha posterior a este pago, se bloquea la actualización.
  • Si actualizarPago=true, se dispara el recálculo: si el pago ya es definitivo (Por Pagar/Pagada) no se recalcula; si el pago tiene más de 1100 empleados, el recálculo se procesa de forma asíncrona (la respuesta indica que se está procesando en un hilo aparte).
  • Al pasar a Pagada: se genera el archivo plano de transferencia solo si el tipo de pago no es Cesantías, si el total neto no es 0, y si el banco de la cuenta de la compañía tiene plano parametrizado; si alguna de estas condiciones falla, no se genera el plano (pero la respuesta es exitosa, con un aviso).
  • Al pasar a Pagada, si corresponde generar automáticamente algún pago especial (cesantías, intereses de cesantías, prima), se incluye un aviso no bloqueante indicándolo — ese pago especial debe generarse aparte.
  • Si actualizarUsuarioNotificacion=true, se inactiva la notificación "antes de pago definitivo" para el usuario (afecta preferencias del usuario, no el pago en sí).
  • Si ordenarArchivoPlano=true, se actualiza una configuración de la compañía (no del pago) para ordenar el archivo plano.
Path Params
string
required
Body Params

DTO ActualizarPagoDTO. Ninguno de sus campos tiene validacion @NotNull en el codigo; todos son opcionales.

string

Compañía asociada al pago; usado solo para actualizar la configuración de orden del archivo plano.

boolean

Incluir el pago de la prima de servicios en este pago.

boolean

Generar la prima de servicios automáticamente.

boolean

Incluir el pago de intereses de cesantías.

string

Cuenta bancaria asociada al pago.

string

Código del nuevo estado del pago (EP=En preparación, PA=Por aprobar, PP=Por pagar, PG=Pagada, RE=Regreso a preparación, AN=Anulado).

date

Fecha en que se realiza el pago.

boolean

Si es true, dispara el recálculo de la nómina del pago.

string

Si se envía "ESTADO", valida la transición de estado (ver Reglas de negocio).

boolean

Si es true, inactiva la notificación de "antes de pago definitivo" para el usuario actual.

boolean

Si se debe ordenar el archivo plano de transferencia de la compañía.

Headers
string
required

Bearer token para la autorización. Consulte la documentación inicial del módulo de nómina para obtener instrucciones sobre cómo generar el token de autenticación.

Responses

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