Conceptos acumulados

Consultar los conceptos acumulados en un rango de fechas.

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

Versión resumida/agregada por empleado de los conceptos acumulados (a diferencia de Explorador de acumulados por concepto, que desglosa por concepto individual).

Path Params

ParámetroTipoDescripción
fechaDesdestringFecha inicial del rango a consultar, formato AAAA-MM-DD.
fechaHastastringFecha final del rango a consultar, formato AAAA-MM-DD.
isDetalleParaAportesstring ("true"/"false")Si es true, usa la consulta fuente de "detalle para aportes" en vez de la de acumulados genéricos — son dos fuentes de datos distintas, no un simple filtro adicional.

Reglas de negocio

Es de los pocos endpoints de reportes por concepto que sí pagina (offset/size). No valida permisos especiales en el código, a diferencia de su endpoint hermano Explorador de acumulados por concepto.

  • El rango de fechas se aplica sobre la fecha inicial del pago (fechaDesde del pago), no sobre la fecha de pago ni sobre la fecha de cada concepto.
  • Solo considera pagos definitivos; los pagos en preparación o por aprobar no aparecen.
  • La paginación funciona únicamente con offset y size. El parámetro page se acepta en la URL pero el backend lo ignora, sin devolver error: paginar con page retorna siempre la primera página. Para la segunda página de 20 registros, enviar offset=20&size=20.
  • El campo tipoCotizante de la respuesta viene con la descripción del tipo de cotizante (ej. Dependiente), no con el código — a diferencia de otros endpoints de pagos que devuelven el código.
  • Es la alternativa recomendada cuando se necesita la nómina de un mes en un solo llamado, ya que Listar todos los pagos de nómina no acepta filtros por fecha.

Campos de la respuesta

Cada elemento de contenido corresponde a un empleado con sus valores ya sumados en el rango consultado.

CampoTipoDescripción
uuidVinculadostringUuid de la vinculación laboral (contrato) del empleado. Es el identificador que esperan los endpoints de Empleados y Vinculados.
uuidEmpleadostringUuid de la persona (empleado). Corresponde al empleadoUuid de Listar empleados.
idstringNúmero de documento (cédula) del empleado. El nombre del campo viene del modelo de datos; no es un identificador interno.
nombreCompletostringNombre completo del empleado.
tipoCotizantestringDescripción del tipo de cotizante (ej. Dependiente), no el código.
salarioBasenumberSalario base del empleado en el pago.
salarioIntegralbooleantrue si el empleado tiene salario integral.
totalDevengadosnumberSuma de devengados del rango.
totalDeduccionesnumberSuma de deducciones del rango.
totalNetonumberSuma del neto de los comprobantes del rango.

Los importes de 10.000.000 o más se serializan en notación científica — un valor de 18.404.777 llega como 1.8404777E7 — y por debajo de ese umbral en notación decimal normal. Los uuid son texto de 32 caracteres hexadecimales en mayúscula sin guiones. Ver la sección "Formato de la respuesta" de Listar todos los pagos de nómina para el detalle de estas convenciones.

Identificadores del empleado

Este endpoint permite cruzar en un solo llamado la cédula con los dos uuid del empleado, sin consultas adicionales:

NecesitoCampo / endpoint
Cédula del empleadoCampo id de esta respuesta.
Uuid de la personaCampo uuidEmpleado de esta respuesta.
Uuid del contratoCampo uuidVinculado de esta respuesta.
Cédula → uuid, para todos los empleadosListar empleados — GET /empleados. Devuelve empleadoUuid, identificacion, vinculadoUuid y tipoDocumento de cada empleado con contrato vigente.
Cédula → uuid, para un empleado puntualEmpleado por documento — GET /empleados/{tipoDocumento}/{identificacion}.
⚠️

No confundir uuidEmpleado con uuidVinculado. La mayoría de los endpoints de empleado (información laboral, salarial y adicional) esperan el uuid del vinculado, no el del empleado.

Path Params
string
required
string
required
string
required
Query Params
integer

Sin efecto: el backend ignora este parámetro. Paginar con offset y size.

integer

Registro inicial de la página a retornar.

integer

Cantidad máxima de registros a retornar (por defecto 20).

string

Filtro de texto global sobre los campos de la consulta.

string

Campo y dirección de orden, ej: campo,asc o campo,desc.

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