Skip to main content
El servicio permite a los usuarios registrar el documento de nómina individual de ajuste de tipo eliminar, que anula una nómina individual registrada previamente en la plataforma, en línea en formato JSON. El documento de eliminación se genera con el prefijo de eliminación configurado en la nómina, con un consecutivo asignado automáticamente y con valores en cero, referenciando la nómina individual original. El método de solicitud es POST y se requiere un encabezado “Authorization” para la autenticación, que debe contener un token JWT obtenido previamente del servicio de autenticación.

​
Prerequisitos

Antes de realizar la eliminación de una nómina individual, se debe contar con los siguientes datos:
  • Token solicitado mediante el API de autenticación
  • Prefijo y consecutivo de la nómina individual que se va a eliminar
  • Prefijo de eliminación de nómina electrónica configurado en la nómina

​
Eliminar nómina individual

Request URL: https://{{Ambiente}}/API_FE/api/DocumentosElectronicos/NominaEliminar
Tipo: POST
Content Type: application/json
​
string
required
Prefijo y consecutivo de la nómina individual que se va a eliminar, unidos sin separador (ej. “NE245”).
​
string
required
Email del usuario de la plataforma con el cual se registra el documento.
​
string
Observaciones generales del documento de eliminación (máx. 5000 caracteres).

​
Validaciones

El servicio realiza las siguientes validaciones antes de registrar el documento. Si alguna no se cumple, no se registra la eliminación y se retorna el error correspondiente.
  • La nómina referenciada (prefijo y consecutivo) debe estar registrada en la plataforma.
  • La nómina referenciada debe ser una nómina individual normal, no un documento de novedad.
  • La nómina referenciada no debe tener ya un documento de eliminación registrado.
  • Los datos del contrato del empleado deben ser válidos para la emisión del documento.

​
Respuesta

​
string
Resultado de la operación: “OK” o “Error”.
​
int
Código único del documento de eliminación registrado (ID). Retorna -1 cuando ocurre un error.
​
string
“Transacción Exitosa” cuando el registro es correcto, o el detalle del error precedido de “Error:”.