> ## Documentation Index
> Fetch the complete documentation index at: https://tech.sedierp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Consulta detallada

El servicio permite a los usuarios consultar el listado de documentos soporte de pago de nómina electrónica (nóminas individuales, novedades y documentos de ajuste) en línea en formato JSON.

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](https://tech.sedierp.com/quickstart.md).

## Prerequisitos

Antes de realizar la consulta de nóminas, se debe contar con los siguientes datos:

* Token solicitado mediante el API de [autenticación](https://tech.sedierp.com/quickstart.md)

## Consultar nóminas

**Request URL:** https\://\{\{Ambiente}}/API\_FE/api/DocumentosElectronicos/NominasConsultar\
**Tipo:** POST \
**Content Type:** application/json

**Page** `int`

Página de consulta, por defecto (1).

**Rows** `int`

Cantidad de registros por página de consulta, por defecto (10). El máximo permitido es 30 registros por página.

**UniqueID** `GUID`

Filtro de búsqueda por identificador único del documento.

**PrefijoNomina** `string`

Filtro de búsqueda por prefijo de nómina electrónica del documento.

**Consecutivo** `int`

Filtro de búsqueda por consecutivo del documento.

**ConsecutivoInicial** `int`

Filtro de búsqueda por rango de consecutivos, desde el consecutivo indicado (inclusive).

**ConsecutivoFinal** `int`

Filtro de búsqueda por rango de consecutivos, hasta el consecutivo indicado (inclusive).

**TipoSoportePago** `int`

Filtro de búsqueda por tipo de documento.

| Código | Tipo de documento |
| - | - |
| 1 | Nómina individual |
| 2 | Nómina individual de ajuste - Reemplazar |
| 3 | Nómina individual de ajuste - Eliminar |

**FechaInicio** `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.

**FechaFin** `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.

**Tercero** `string`

Filtro de búsqueda por cualquier parte del nombre del trabajador.

**Identificacion** `string`

Filtro de búsqueda por número de identificación exacto del trabajador.

**Codigo** `string`

Filtro de búsqueda por código del trabajador.

**UsuarioEmail** `string`

Filtro de búsqueda por email del usuario que registró el documento.

**FullSearch** `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.

```bash theme={null}
curl --location 'https://nsx.sedierp.com/API_FE/api/DocumentosElectronicos/NominasConsultar' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN_JWT>' \
--data '{
	"Page": 1,
	"Rows": 10,
	"UniqueID": null,
	"PrefijoNomina": null,
	"Consecutivo": null,
	"ConsecutivoInicial": null,
	"ConsecutivoFinal": null,
	"TipoSoportePago": null,
	"FechaInicio": null,
	"FechaFin": null,
	"Tercero": null,
	"Identificacion": "52123456",
	"Codigo": null,
	"UsuarioEmail": null,
	"FullSearch": null
}'
```

### Respuesta

El servicio retorna el listado de documentos de nómina ordenado por consecutivo de forma descendente. Cada registro de `rows` contiene los siguientes campos:

**SoportePagoID** `int`

Código único del documento de nómina (ID).

**PrefijoNominaElectronica** `string`

Prefijo de nómina electrónica del documento.

**Consecutivo** `int`

Consecutivo del documento.

**UniqueID** `GUID`

Identificador único del documento.

**TipoSoportePagoID** `int`

Código del tipo de documento (1: Nómina individual, 2: Ajuste - Reemplazar, 3: Ajuste - Eliminar).

**TipoSoportePagoNombre** `string`

Nombre del tipo de documento.

**DocumentoNovedad** `bool`

Indica si el documento corresponde a una novedad de nómina.

**OrigenSoportePago** `string`

Prefijo y consecutivo del documento de origen (ej. "NE - 245"), cuando el documento es una novedad o un ajuste.

**FechaGeneracion** `datetime`

Fecha de generación del documento en la plataforma.

**FechaInicial** `date`

Fecha de inicio del periodo de liquidación.

**FechaFinal** `date`

Fecha de fin del periodo de liquidación.

**TotalDevengos** `decimal`

Valor total de los devengos del documento.

**TotalDeducidos** `decimal`

Valor total de las deducciones del documento.

**NombreCompleto** `string`

Nombre completo del trabajador.

**Documento** `string`

Número de identificación del trabajador.

**AbreviaturaDocumento** `string`

Tipo y número de identificación del trabajador con formato (ej. "C.C. 52,123,456").

**Email** `string`

Correo electrónico del trabajador.

**TotalRows** `int`

Cantidad total de registros que cumplen con los filtros de la consulta.

```json Request theme={null}
{
  "Page": 1,
  "Rows": 10,
  "UniqueID": null,
  "PrefijoNomina": null,
  "Consecutivo": null,
  "ConsecutivoInicial": null,
  "ConsecutivoFinal": null,
  "TipoSoportePago": null,
  "FechaInicio": null,
  "FechaFin": null,
  "Tercero": null,
  "Identificacion": "52123456",
  "Codigo": null,
  "UsuarioEmail": null,
  "FullSearch": null
}
```

```json Response theme={null}
{
    "total": 2,
    "rows": [
        {
            "SoportePagoID": 98214,
            "Consecutivo": 245,
            "FechaGeneracion": "2026-10-31T16:22:10.483",
            "TipoSoportePagoID": 1,
            "NombreCompleto": "MARIA FERNANDA GOMEZ RUIZ",
            "Documento": "52123456",
            "Email": "maria.gomez@correo.com",
            "FechaInicial": "2026-10-01",
            "FechaFinal": "2026-10-31",
            "DocumentoNovedad": false,
            "TotalDevengos": 2742614,
            "TotalDeducidos": 350000,
            "UniqueID": "f2a9c614-83d7-4b0e-a5c1-9e47d30b6a82",
            "AbreviaturaDocumento": "C.C. 52,123,456",
            "PrefijoNominaElectronica": "NE",
            "OrigenSoportePago": null,
            "TipoSoportePagoNombre": "Nómina individual",
            "TotalRows": 2
        },
        {
            "SoportePagoID": 98230,
            "Consecutivo": 12,
            "FechaGeneracion": "2026-11-04T14:30:12.120",
            "TipoSoportePagoID": 3,
            "NombreCompleto": "MARIA FERNANDA GOMEZ RUIZ",
            "Documento": "52123456",
            "Email": "maria.gomez@correo.com",
            "FechaInicial": "2026-10-01",
            "FechaFinal": "2026-10-31",
            "DocumentoNovedad": false,
            "TotalDevengos": 0,
            "TotalDeducidos": 0,
            "UniqueID": "7c51e0b8-2d46-4f93-b8a7-15e3f9d2c064",
            "AbreviaturaDocumento": "C.C. 52,123,456",
            "PrefijoNominaElectronica": "NAE",
            "OrigenSoportePago": "NE - 245",
            "TipoSoportePagoNombre": "Nómina individual de ajuste - Eliminar",
            "TotalRows": 2
        }
    ],
    "result": 1
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.