Prerequisitos
Antes de realizar la consulta de nóminas, se debe contar con los siguientes datos:- Token solicitado mediante el API de autenticación
Consultar nóminas
Request URL: https://{{Ambiente}}/API_FE/api/DocumentosElectronicos/NominasConsultarTipo: POST
Content Type: application/json
int
Página de consulta, por defecto (1).
int
Cantidad de registros por página de consulta, por defecto (10). El máximo permitido es 30 registros por página.
GUID
Filtro de búsqueda por identificador único del documento.
string
Filtro de búsqueda por prefijo de nómina electrónica del documento.
int
Filtro de búsqueda por consecutivo del documento.
int
Filtro de búsqueda por rango de consecutivos, desde el consecutivo indicado (inclusive).
int
Filtro de búsqueda por rango de consecutivos, hasta el consecutivo indicado (inclusive).
int
Filtro de búsqueda por tipo de documento.
string
Filtro de búsqueda por fecha de generación del documento, desde la fecha indicada (inclusive). Solo se tiene en cuenta la fecha, no la hora.
string
Filtro de búsqueda por fecha de generación del documento, hasta la fecha indicada (inclusive). Solo se tiene en cuenta la fecha, no la hora.
string
Filtro de búsqueda por cualquier parte del nombre del trabajador.
string
Filtro de búsqueda por número de identificación exacto del trabajador.
string
Filtro de búsqueda por código del trabajador.
string
Filtro de búsqueda por email del usuario que registró el documento.
string
Campo de consulta múltiple. El criterio de búsqueda depende del valor enviado:
- Numérico: consulta por el consecutivo del documento o por el número de identificación del trabajador.
- Otro texto: consulta por cualquier parte del nombre o del email del trabajador.
Respuesta
El servicio retorna el listado de documentos de nómina ordenado por consecutivo de forma descendente. Cada registro derows contiene los siguientes campos:
int
Código único del documento de nómina (ID).
string
Prefijo de nómina electrónica del documento.
int
Consecutivo del documento.
GUID
Identificador único del documento.
int
Código del tipo de documento (1: Nómina individual, 2: Ajuste - Reemplazar, 3: Ajuste - Eliminar).
string
Nombre del tipo de documento.
bool
Indica si el documento corresponde a una novedad de nómina.
string
Prefijo y consecutivo del documento de origen (ej. “NE - 245”), cuando el documento es una novedad o un ajuste.
datetime
Fecha de generación del documento en la plataforma.
date
Fecha de inicio del periodo de liquidación.
date
Fecha de fin del periodo de liquidación.
decimal
Valor total de los devengos del documento.
decimal
Valor total de las deducciones del documento.
string
Nombre completo del trabajador.
string
Número de identificación del trabajador.
string
Tipo y número de identificación del trabajador con formato (ej. “C.C. 52,123,456”).
string
Correo electrónico del trabajador.
int
Cantidad total de registros que cumplen con los filtros de la consulta.