API docs by Redocly

Nomineros API (1.0.0)

Download OpenAPI specification:

URL: https://nomineros.com License: Uso propietario - Nomineros S.A.S.

API pública de nomineros.com para la integración de sistemas de terceros con la nómina de una empresa (empleador).

Esta documentación cubre dos conjuntos de endpoints:

  • Empleador: operan sobre los datos de toda la empresa cliente.
  • Self-service: el portal del empleado, donde cada persona consulta y actualiza únicamente sus propios datos.

Los endpoints administrativos internos de Nomineros no están incluidos.

Autenticación

La API usa JWT enviado en el header Authorization: Bearer <token>. Hay dos tipos de token distintos y no intercambiables, cada uno con su propio login:

1. Token de empleador

  1. Llama a POST /api/v1/login/direct con email, password y slug (identificador de la empresa). La respuesta trae un JWT ya asociado a la empresa.
  2. Envía ese token en el header Authorization: Bearer <token>.

El token identifica al usuario y a la empresa, por eso ningún endpoint recibe el identificador del empleador como parámetro: se toma siempre del token.

Es el token que usan todos los endpoints de esta documentación salvo los de self-service.

2. Token de self-service

  1. Llama a POST /api/v1/self-service/public/login con el tipo y número de identificación del empleado y su contraseña. La respuesta trae un JWT propio del empleado.
  2. Envía ese token en el mismo header Authorization: Bearer <token>.

Aunque viaja igual, es un token diferente: su campo issuer vale SELF SERVICE y lleva embebido el employeeID. Solo da acceso a los datos del empleado dueño del token.

Los dos tokens no se mezclan

Las rutas de self-service validan el emisor del token además de la firma. Usar un token de empleador en una ruta de self-service —o al revés— devuelve 401, aunque el token sea válido. Una integración que necesite ambos alcances debe mantener las dos sesiones por separado.

Los tres endpoints bajo /api/v1/self-service/public/ (login, recuperación y cambio de contraseña) son públicos y no requieren ningún token.

Formato de respuesta

Todas las respuestas JSON usan el mismo envoltorio:

{
  "data": { },
  "messages": [{ "code": "ok", "message": "¡listo!" }]
}

Y en caso de error:

{
  "errors": [{ "code": "failure", "message": "descripción del error" }]
}

Algunos endpoints de reportes devuelven un archivo binario (Excel, PDF o texto plano) en lugar de JSON; en esos casos se indica en la respuesta del endpoint.

Autenticación

Inicio de sesión y obtención del token de acceso.

Inicia sesión y selecciona la empresa en una sola petición

Autentica al usuario con su correo y contraseña y, al mismo tiempo, lo asocia a la empresa identificada por su slug. Está pensado para que aplicaciones de terceros se conecten a la API sin tener que hacer dos peticiones de login.

El token devuelto es el que debe enviarse en el header Authorization: Bearer <token> en todas las demás peticiones de esta documentación. Ese token ya lleva embebidos el usuario y la empresa, por eso ningún otro endpoint recibe el identificador del empleador.

Request Body schema: application/json
required
email
required
string <email>

Correo del usuario.

password
required
string <password>

Contraseña del usuario.

slug
required
string

Identificador corto y único de la empresa dentro de Nomineros.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "email": "integracion@empresa.com",
  • "password": "pa$$word",
  • "slug": "mi-empresa"
}

Response samples

Content type
application/json
{
  • "data": {
    • "user": {
      },
    • "employer": {
      },
    • "role": "string",
    • "token": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Empresa

Datos básicos y configuración de nómina de la empresa.

Obtiene la información básica de la empresa

Obtiene la información básica (nombre, nit, web, etc.) de la empresa asociada al token de la sesión actual. La empresa se toma del token, no se recibe ningún identificador por parámetro.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "nit": "string",
    • "dv": "string",
    • "business_name": "string",
    • "short_name": "string",
    • "web": "string",
    • "picture": "string",
    • "created_by": 0,
    • "first_pay_period": "2019-08-24T14:15:22Z",
    • "first_pay_period_migration": "2019-08-24T14:15:22Z",
    • "thumbnail": "string",
    • "country_id": 0,
    • "not_include_decimals_in_calculation": true,
    • "type": "string",
    • "main_branch_office_id": 0,
    • "slug": "string",
    • "is_demo": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Sucursales

Sucursales o agencias de la empresa.

Crea una sucursal

Crea una sucursal (sede) para la empresa autenticada.

Authorizations:
bearerAuth
Request Body schema: application/json
required
description
required
string
code
required
string <= 10 characters

Máximo 10 caracteres.

department_id
required
integer
address
string
phone
string
municipality_id
required
integer
municipality_code
string
municipality_description
string
ccf_id
integer

Requerido si el pais de la empresa es Colombia.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "department_id": 0,
  • "address": "string",
  • "phone": "string",
  • "municipality_id": 0,
  • "municipality_code": "string",
  • "municipality_description": "string",
  • "ccf_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "description": "string",
    • "code": "string",
    • "department_id": 0,
    • "address": "string",
    • "phone": "string",
    • "municipality_id": 0,
    • "municipality_code": "string",
    • "municipality_description": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "ccf_id": 0,
    • "ccf_name": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Lista las sucursales

Lista todas las sucursales de la empresa autenticada.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Actualiza una sucursal

Actualiza los datos de una sucursal existente.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Identificador numerico de la sucursal

Request Body schema: application/json
required
description
required
string
code
required
string <= 10 characters

Máximo 10 caracteres.

department_id
required
integer
address
string
phone
string
municipality_id
required
integer
municipality_code
string
municipality_description
string
ccf_id
integer

Requerido si el pais de la empresa es Colombia.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "department_id": 0,
  • "address": "string",
  • "phone": "string",
  • "municipality_id": 0,
  • "municipality_code": "string",
  • "municipality_description": "string",
  • "ccf_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "description": "string",
    • "code": "string",
    • "department_id": 0,
    • "address": "string",
    • "phone": "string",
    • "municipality_id": 0,
    • "municipality_code": "string",
    • "municipality_description": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "ccf_id": 0,
    • "ccf_name": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Marca una sucursal como sede principal

Marca una sucursal como la sede principal de la empresa (desmarca cualquier otra que lo fuera).

Authorizations:
bearerAuth
path Parameters
id
required
integer

Identificador numerico de la sucursal a marcar como principal

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Centros de trabajo

Centros de trabajo asociados al riesgo laboral (ARL).

Crea un centro de trabajo

Crea un centro de trabajo (workplace) para la empresa autenticada.

Authorizations:
bearerAuth
Request Body schema: application/json
required
employer_id
integer

Se sobreescribe con el empleador del token.

code
required
integer
description
required
string
economic_activity_risk_id
required
integer
created_at
string <date-time>
updated_at
string <date-time>

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "employer_id": 0,
  • "code": 0,
  • "description": "string",
  • "economic_activity_risk_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "code": 0,
    • "description": "string",
    • "economic_activity_risk_id": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "level_risk_id": 0,
    • "level_risk": 0,
    • "level_risk_description": "string",
    • "level_risk_rate": 0,
    • "economic_activity_code": "string",
    • "economic_activity_code_ciiu": "string",
    • "economic_activity_description": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Lista los centros de trabajo

Lista todos los centros de trabajo de la empresa autenticada.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Actualiza un centro de trabajo

Actualiza un centro de trabajo existente de la empresa autenticada.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del centro de trabajo

Request Body schema: application/json
required
code
required
integer
description
required
string
economic_activity_risk_id
required
integer

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "code": 0,
  • "description": "string",
  • "economic_activity_risk_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "code": 0,
    • "description": "string",
    • "economic_activity_risk_id": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "level_risk_id": 0,
    • "level_risk": 0,
    • "level_risk_description": "string",
    • "level_risk_rate": 0,
    • "economic_activity_code": "string",
    • "economic_activity_code_ciiu": "string",
    • "economic_activity_description": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina un centro de trabajo

Elimina un centro de trabajo de la empresa autenticada.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del centro de trabajo

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Obtiene un centro de trabajo por id

Obtiene un centro de trabajo por id, dentro de la empresa autenticada.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del centro de trabajo

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "code": 0,
    • "description": "string",
    • "economic_activity_risk_id": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "level_risk_id": 0,
    • "level_risk": 0,
    • "level_risk_description": "string",
    • "level_risk_rate": 0,
    • "economic_activity_code": "string",
    • "economic_activity_code_ciiu": "string",
    • "economic_activity_description": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Cuentas bancarias

Cuentas bancarias de la empresa para el pago de nómina.

Crea una cuenta bancaria de la empresa

Crea una cuenta bancaria para la empresa. Si es la primera cuenta registrada, se marca automaticamente como activa (is_active = true).

Authorizations:
bearerAuth
Request Body schema: application/json
required
bank_id
required
integer
account_type
required
string
Enum: "CUENTA DE AHORROS" "CUENTA CORRIENTE" "EMAIL"
account_number
required
string
is_active
boolean

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "bank_id": 0,
  • "account_type": "CUENTA DE AHORROS",
  • "account_number": "string",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "bank_id": 0,
    • "account_type": "CUENTA DE AHORROS",
    • "account_number": "string",
    • "is_active": true,
    • "created_at": "2019-08-24",
    • "updated_at": "2019-08-24"
    },
  • "messages": [
    • {
      }
    ]
}

Lista las cuentas bancarias de la empresa

Lista todas las cuentas bancarias registradas para la empresa autenticada.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Actualiza una cuenta bancaria de la empresa

Actualiza una cuenta bancaria existente de la empresa autenticada.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id numérico de la cuenta bancaria

Request Body schema: application/json
required
bank_id
required
integer
account_type
required
string
Enum: "CUENTA DE AHORROS" "CUENTA CORRIENTE" "EMAIL"
account_number
required
string
is_active
boolean

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "bank_id": 0,
  • "account_type": "CUENTA DE AHORROS",
  • "account_number": "string",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "bank_id": 0,
    • "account_type": "CUENTA DE AHORROS",
    • "account_number": "string",
    • "is_active": true,
    • "created_at": "2019-08-24",
    • "updated_at": "2019-08-24"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina una cuenta bancaria de la empresa

Elimina una cuenta bancaria de la empresa autenticada.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id numérico de la cuenta bancaria

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Cargos de empresa

Catálogo de cargos definidos por la empresa.

Crea un cargo para la empresa

Crea un cargo (job) para la empresa autenticada.

Authorizations:
bearerAuth
Request Body schema: application/json
required
code
required
string
description
required
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "code": "string",
    • "employer_id": 0,
    • "description": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Lista los cargos de la empresa

Lista todos los cargos (jobs) de la empresa autenticada.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Actualiza un cargo de la empresa

Actualiza un cargo (job) de la empresa autenticada.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del cargo

Request Body schema: application/json
required
code
required
string
description
required
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "code": "string",
    • "employer_id": 0,
    • "description": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina un cargo de la empresa

Elimina un cargo (job) de la empresa autenticada.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del cargo

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Obtiene un cargo por id

Obtiene un cargo (job) por id, validado contra la empresa autenticada.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del cargo

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "code": "string",
    • "employer_id": 0,
    • "description": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Busca cargos por descripción

Busca cargos de la empresa autenticada cuya descripción coincida (sin distinguir mayúsculas/minúsculas) con el texto indicado.

Authorizations:
bearerAuth
path Parameters
description
required
string

Texto de busqueda sobre la descripción del cargo

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Usuarios

Usuarios con acceso a la empresa dentro de Nomineros.

Lista los usuarios de la empresa

Lista los usuarios (no staff) asociados a la empresa del empleador actual.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Crea un usuario de la empresa

Crea un nuevo usuario para la empresa del empleador actual, con un rol asignado.

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
email
required
string <email>
password
required
string

Debe cumplir la politica de contrasenas

role
required
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "password": "string",
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "name": "string",
    • "email": "string",
    • "confirmed_email": true,
    • "is_active": true,
    • "picture": "string",
    • "is_staff": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "role_id": 0,
    • "role": "string",
    • "employer_id": 0
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza un usuario de la empresa

Actualiza los datos de un usuario existente de la empresa (nombre, email, rol, estado activo y opcionalmente la contraseña).

Authorizations:
bearerAuth
Request Body schema: application/json
required
user_id
required
integer
name
required
string
email
required
string <email>
is_active
boolean
role
required
string
is_change_password
boolean
password
string

Requerido si is_change_password = true; debe cumplir la politica de contrasenas

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "name": "string",
  • "email": "user@example.com",
  • "is_active": true,
  • "role": "string",
  • "is_change_password": true,
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "name": "string",
    • "email": "string",
    • "confirmed_email": true,
    • "is_active": true,
    • "picture": "string",
    • "is_staff": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "role_id": 0,
    • "role": "string",
    • "employer_id": 0
    },
  • "messages": [
    • {
      }
    ]
}

Empleados y contratos

Alta, consulta y actualización de empleados y sus contratos.

Lista paginada de empleados/contratos

Lista paginada de empleados/contratos del empleador, con filtros por busqueda, ids de contrato, estados de contrato y frecuencia de pago.

Authorizations:
bearerAuth
query Parameters
limit
required
integer

Tamaño de pagina

page
required
integer

Número de pagina

contract_ids
string

Lista de ids de contrato separados por coma (ej. 12,45,50).

filter
integer

Id de un solo estado de contrato (compatibilidad con versión anterior del frontend). Estados posibles: CREADO, ACTIVO, EN RETIRO, RETIRADO, ANULADO.

contract_statuses_id
string

Lista de ids de estado de contrato separados por coma (ej. 1,2). Mismo catálogo que filter.

pay_frequency_id
integer

Id de frecuencia de pago.

search
string

Texto de búsqueda parcial. Busca en nombre, apellidos, número de identificación, hash del empleado/contrato y códigos alternos.

sort
string
Enum: "id" "first_name" "last_name"

Campo de orden ascendente.

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Crea un empleado con su primer contrato

Crea un nuevo empleado junto con su primer contrato y datos relacionados (salario, cuenta bancaria, entidades de seguridad social, cargo, dependiente).

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (EmployeeRelationEmployeeCreateInput)

Datos personales del empleado nuevo. id no se recibe: si ya existe un empleado con el mismo identification_type_id + identification_number, se reutiliza en vez de crear uno duplicado.

required
object (EmployeeRelationContractCreateInput)

Datos del primer contrato del empleado. contract_status_id, sequence y hash los asigna el servidor: contract_status_id siempre queda en el estado inicial "creado".

required
object (EmployeeRelationSalaryCreateInput)

Salario inicial del contrato. Queda con begins_at igual a contract.hire_date y como salario vigente (is_current: true).

object

Requerido únicamente si contract.payment_method es TRANSFERENCIA; en cualquier otro caso se ignora aunque se envíe.

Array of objects (EmployeeRelationEntityHistoryCreateInput)

Afiliaciones a entidades de seguridad social (EPS, AFP, ARL, caja de compensación, etc.). Cuáles son requeridas depende de la configuración del contract_type_id elegido (por ejemplo, AFP no aplica si el empleado es pensionado o extranjero sin pensión); faltar una entidad obligatoria para ese tipo de contrato devuelve 400.

object

Requerido únicamente si contract.is_tax_dependents es true; en cualquier otro caso se ignora aunque se envíe.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "employee": {
    • "identification_type_id": 0,
    • "identification_number": "string",
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "surname": "string",
    • "email": "string",
    • "address": "string",
    • "phone": "string",
    • "mobile": "string",
    • "gender": "string",
    • "birthdate": "2019-08-24",
    • "birthplace": "string",
    • "marital_status": "string",
    • "picture": "string",
    • "thumbnail": "string",
    • "social_networks": {
      }
    },
  • "contract": {
    • "contract_type_id": 0,
    • "hire_date": "2019-08-24",
    • "expiration_date": "2019-08-24",
    • "trial_period_date": "2019-08-24",
    • "pay_frequency_id": 0,
    • "workplace_id": 0,
    • "is_foreigner_without_pension": true,
    • "payment_method": "string",
    • "mandatory_rest_day": 0,
    • "additional_rest_day": 0,
    • "month_hours": 0,
    • "place_labor_municipality_id": 0,
    • "alternate_code": "string",
    • "is_remote_worker": true,
    • "branch_office_id": 0,
    • "tax_relief_health": 0,
    • "tax_relief_living_place": 0,
    • "is_tax_dependents": true,
    • "method_taxes": 0,
    • "rate_taxes": 0,
    • "notes": "string",
    • "organizational_struct_id": "string",
    • "is_pensioner": true,
    • "is_colombian_living_abroad": true,
    • "afp_commission_type": "string",
    • "has_family_allowance": true,
    • "mapping": {
      },
    • "formulator_data": {
      },
    • "partner_alternate_code": "string",
    • "dimensions": {
      },
    • "job_id": 0
    },
  • "salary": {
    • "salary_type_id": 0,
    • "value": 0
    },
  • "bank_account_history": {
    • "bank_id": 0,
    • "account_number": "string",
    • "account_type": "string"
    },
  • "entities": [
    • {
      }
    ],
  • "dependent": {
    • "identification_type_id": 0,
    • "identification_number": "string",
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "surname": "string",
    • "relationship_type": "string"
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "employee": {
      },
    • "contract": {
      },
    • "salary": {
      },
    • "bank_account_history": {
      },
    • "entities": [
      ],
    • "job": {
      },
    • "dependent": {
      }
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza la información básica de un empleado

Actualiza la información básica (datos personales) de un empleado del empleador.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del empleado

Request Body schema: application/json
required
identification_type_id
integer
identification_number
string
first_name
string
middle_name
string
last_name
string
surname
string
email
string
address
string
phone
string
mobile
string
gender
string
birthdate
string <date>
birthplace
string
marital_status
string
picture
string
thumbnail
string
hash
string
object (EmployeeRelationSocialNetworks)

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "identification_type_id": 0,
  • "identification_number": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "surname": "string",
  • "email": "string",
  • "address": "string",
  • "phone": "string",
  • "mobile": "string",
  • "gender": "string",
  • "birthdate": "2019-08-24",
  • "birthplace": "string",
  • "marital_status": "string",
  • "picture": "string",
  • "thumbnail": "string",
  • "hash": "string",
  • "social_networks": {
    • "facebook": "string",
    • "twitter": "string",
    • "instagram": "string",
    • "linked_in": "string"
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "identification_type_id": 0,
    • "identification_number": "string",
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "surname": "string",
    • "email": "string",
    • "address": "string",
    • "phone": "string",
    • "mobile": "string",
    • "gender": "string",
    • "birthdate": "2019-08-24",
    • "birthplace": "string",
    • "marital_status": "string",
    • "picture": "string",
    • "thumbnail": "string",
    • "hash": "string",
    • "social_networks": {
      },
    • "employer_id": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Obtiene un contrato por su hash público

Devuelve los datos completos de un contrato del empleador a partir de su hash público.

Authorizations:
bearerAuth
path Parameters
id
required
string

Hash público del contrato. En esta operación el segmento de ruta es el hash (cadena), no el id numérico que reciben las operaciones PUT de esta misma ruta.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "employee_id": 0,
    • "contract_type_id": 0,
    • "hire_date": "2019-08-24",
    • "termination_date": "2019-08-24",
    • "termination_reason_id": 0,
    • "expiration_date": "2019-08-24",
    • "trial_period_date": "2019-08-24",
    • "pay_frequency_id": 0,
    • "workplace_id": 0,
    • "is_foreigner_without_pension": true,
    • "payment_method": "string",
    • "mandatory_rest_day": 0,
    • "additional_rest_day": 0,
    • "place_labor_municipality_id": 0,
    • "alternate_code": "string",
    • "contract_status_id": 0,
    • "month_hours": 0,
    • "is_remote_worker": true,
    • "branch_office_id": 0,
    • "tax_relief_health": 0,
    • "tax_relief_living_place": 0,
    • "is_tax_dependents": true,
    • "method_taxes": 0,
    • "rate_taxes": 0,
    • "sequence": 0,
    • "hash": "string",
    • "termination_notes": "string",
    • "notes": "string",
    • "organizational_struct_id": "string",
    • "is_pensioner": true,
    • "is_colombian_living_abroad": true,
    • "afp_commission_type": "string",
    • "has_family_allowance": true,
    • "mapping": {
      },
    • "formulator_data": {
      },
    • "partner_alternate_code": "string",
    • "dimensions": {
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza parcialmente un contrato

Actualiza parcialmente los datos de un contrato del empleador (solo se modifican los campos enviados, tipo PATCH).

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del contrato

Request Body schema: application/json
required
employee_id
integer
contract_type_id
integer
hire_date
string <date>
termination_date
string <date>
termination_reason_id
integer
expiration_date
string <date>
trial_period_date
string <date>
pay_frequency_id
integer
workplace_id
integer
is_foreigner_without_pension
boolean
payment_method
string
mandatory_rest_day
integer
additional_rest_day
integer
place_labor_municipality_id
integer
alternate_code
string
contract_status_id
integer
month_hours
integer
is_remote_worker
boolean
branch_office_id
integer
tax_relief_health
number
tax_relief_living_place
number
is_tax_dependents
boolean
method_taxes
integer
rate_taxes
number
sequence
integer
hash
string
termination_notes
string
notes
string
organizational_struct_id
string
is_pensioner
boolean
afp_commission_type
string
has_family_allowance
boolean
object (EmployeeRelationMapping)
is_colombian_living_abroad
boolean
partner_alternate_code
string
object

Responses

Response Schema: application/json
object (EmployeeRelationContractPatchResponse)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "employee_id": 0,
  • "contract_type_id": 0,
  • "hire_date": "2019-08-24",
  • "termination_date": "2019-08-24",
  • "termination_reason_id": 0,
  • "expiration_date": "2019-08-24",
  • "trial_period_date": "2019-08-24",
  • "pay_frequency_id": 0,
  • "workplace_id": 0,
  • "is_foreigner_without_pension": true,
  • "payment_method": "string",
  • "mandatory_rest_day": 0,
  • "additional_rest_day": 0,
  • "place_labor_municipality_id": 0,
  • "alternate_code": "string",
  • "contract_status_id": 0,
  • "month_hours": 0,
  • "is_remote_worker": true,
  • "branch_office_id": 0,
  • "tax_relief_health": 0,
  • "tax_relief_living_place": 0,
  • "is_tax_dependents": true,
  • "method_taxes": 0,
  • "rate_taxes": 0,
  • "sequence": 0,
  • "hash": "string",
  • "termination_notes": "string",
  • "notes": "string",
  • "organizational_struct_id": "string",
  • "is_pensioner": true,
  • "afp_commission_type": "string",
  • "has_family_allowance": true,
  • "mapping": {
    • "pila": {
      }
    },
  • "is_colombian_living_abroad": true,
  • "partner_alternate_code": "string",
  • "dimensions": {
    • "property1": "string",
    • "property2": "string"
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "employee_id": 0,
    • "contract_type_id": 0,
    • "hire_date": "2019-08-24",
    • "termination_date": "2019-08-24",
    • "termination_reason_id": 0,
    • "expiration_date": "2019-08-24",
    • "trial_period_date": "2019-08-24",
    • "pay_frequency_id": 0,
    • "workplace_id": 0,
    • "is_foreigner_without_pension": true,
    • "payment_method": "string",
    • "mandatory_rest_day": 0,
    • "additional_rest_day": 0,
    • "place_labor_municipality_id": 0,
    • "alternate_code": "string",
    • "contract_status_id": 0,
    • "month_hours": 0,
    • "is_remote_worker": true,
    • "branch_office_id": 0,
    • "tax_relief_health": 0,
    • "tax_relief_living_place": 0,
    • "is_tax_dependents": true,
    • "method_taxes": 0,
    • "rate_taxes": 0,
    • "sequence": 0,
    • "hash": "string",
    • "termination_notes": "string",
    • "notes": "string",
    • "organizational_struct_id": "string",
    • "is_pensioner": true,
    • "afp_commission_type": "string",
    • "has_family_allowance": true,
    • "mapping": {
      },
    • "is_colombian_living_abroad": true,
    • "partner_alternate_code": "string",
    • "dimensions": {
      },
    • "id": 0,
    • "employer_id": 0
    },
  • "messages": [
    • {
      }
    ]
}

Obtiene ids de contrato a partir de un Excel de identificaciones

Sube un archivo Excel con números de identificación y devuelve los ids de contrato del empleador que coinciden, junto con estadisticas de procesamiento (usado para seleccion masiva de contratos).

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
required
file
required
string <binary>

Archivo Excel con identificaciones

max_rows
integer

Máximo de filas a procesar (default 10000)

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "contract_ids": [
      ],
    • "total_rows": 0,
    • "matched_rows": 0,
    • "unmatched_rows": 0
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza el metodo de pago de un contrato

Actualiza el metodo de pago (transferencia bancaria u otro) de un contrato.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del contrato

Request Body schema: application/json
required
payment_method
required
string
object (EmployeeRelationWireTransfer)

Responses

Response Schema: application/json
object (EmployeeRelationPaymentMethodResponse)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "payment_method": "string",
  • "wire_transfer": {
    • "bank_id": 0,
    • "account_number": "string",
    • "account_type": "string"
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "payment_method": "string",
    • "wire_transfer": {
      },
    • "contract_id": 0,
    • "employer_id": 0
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza la retención en la fuente de un contrato

Actualiza la configuración de retención en la fuente (impuestos) y el dependiente fiscal asociado a un contrato.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del contrato

Request Body schema: application/json
required
tax_relief_health
number or null
tax_relief_living_place
number or null
is_tax_dependents
boolean or null
method_taxes
integer or null
rate_taxes
number or null
object (EmployeeRelationTaxesDependent)

Responses

Response Schema: application/json
object (EmployeeRelationTaxesResponse)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "tax_relief_health": 0,
  • "tax_relief_living_place": 0,
  • "is_tax_dependents": true,
  • "method_taxes": 0,
  • "rate_taxes": 0,
  • "dependent": {
    • "id": 0,
    • "identification_type_id": 0,
    • "identification_number": "string",
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "surname": "string",
    • "relationship_type": "string"
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "tax_relief_health": 0,
    • "tax_relief_living_place": 0,
    • "is_tax_dependents": true,
    • "method_taxes": 0,
    • "rate_taxes": 0,
    • "dependent": {
      },
    • "contract_id": 0,
    • "employer_id": 0
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza los datos de seguridad social de un contrato

Actualiza los datos de seguridad social (pension, condicion de pensionado, residencia) y el mapeo PILA de un contrato.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del contrato

Request Body schema: application/json
required
workplace_id
integer
is_foreigner_without_pension
boolean or null
is_pensioner
boolean or null
is_colombian_living_abroad
boolean or null
object (EmployeeRelationPilaMapping)

Responses

Response Schema: application/json
object (EmployeeRelationSocialSecurityResponse)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "workplace_id": 0,
  • "is_foreigner_without_pension": true,
  • "is_pensioner": true,
  • "is_colombian_living_abroad": true,
  • "pila": {
    • "contributor": 0,
    • "subcontributor": 0
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "workplace_id": 0,
    • "is_foreigner_without_pension": true,
    • "is_pensioner": true,
    • "is_colombian_living_abroad": true,
    • "pila": {
      },
    • "contract_id": 0,
    • "employer_id": 0
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza las notas de un contrato

Actualiza las notas/observaciones de un contrato.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del contrato

Request Body schema: application/json
required
notes
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "contract_id": 0,
    • "employer_id": 0,
    • "notes": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Lista los empleados que cumplen años en un mes

Lista los empleados del empleador que cumplen años en el mes indicado.

Authorizations:
bearerAuth
path Parameters
month
required
integer

Mes (1-12)

query Parameters
limit
integer

Tamaño de pagina

page
integer

Número de pagina

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Panel de un empleado con todos sus contratos

Devuelve la vista de panel de un empleado (datos personales y todos sus contratos con su información relacionada) a partir del hash público del empleado.

Authorizations:
bearerAuth
path Parameters
hash
required
string

Hash público del empleado

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "employee": {
      },
    • "contracts": [
      ]
    },
  • "messages": [
    • {
      }
    ]
}

Lista empleados sin metodo de pago configurado

Lista los empleados de un proceso de nómina del empleador que no tienen un metodo de pago configurado (validación previa al pago).

Authorizations:
bearerAuth
query Parameters
processID
required
integer

Id del proceso de nómina

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Lista empleados de un proceso que aun no han sido pagados

Lista los empleados de un proceso de nómina del empleador que aun no han sido pagados, opcionalmente filtrando por metodo de pago, incluyendo el valor neto a pagar y datos bancarios.

Authorizations:
bearerAuth
path Parameters
processID
required
integer

Id del proceso de nómina

query Parameters
payment-method
string

Abreviatura del metodo de pago para filtrar

Responses

Response Schema: application/json
Array of objects (EmployeeRelationUnpaidEmployee)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Lista empleados/contratos de un proceso de nómina

Lista los empleados/contratos del empleador filtrados ademas por el hash de un proceso de nómina especifico (usado para mostrar el detalle de empleados incluidos en un proceso).

Authorizations:
bearerAuth
path Parameters
hash
required
string

Hash del proceso de nómina

query Parameters
limit
required
integer

Tamaño de pagina

page
required
integer

Número de pagina

contract_ids
string

Lista de ids de contrato separados por coma

filter
integer

Id de estado de contrato

contract_statuses_id
string

Lista de ids de estado de contrato separados por coma

pay_frequency_id
integer

Id de frecuencia de pago

search
string

Texto de busqueda

sort
string

Campo de orden

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Salarios

Historial de salarios por contrato.

Lista el histórico de salarios de un contrato

Lista el histórico de salarios asociados a un contrato del empleador autenticado.

Authorizations:
bearerAuth
path Parameters
contract-id
required
integer

ID del contrato

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Crea un registro de salario

Crea un nuevo registro de salario para un contrato del empleador autenticado.

Authorizations:
bearerAuth
Request Body schema: application/json
required
contract_id
required
integer
salary_type_id
required
integer
value
required
number
begins_at
required
string <date-time>
note
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "salary_type_id": 0,
  • "value": 0,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "contract_id": 0,
    • "salary_type_id": 0,
    • "value": 0,
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "retroactive_date": "2019-08-24T14:15:22Z",
    • "is_adjustment": true,
    • "note": "string",
    • "is_current": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza un registro de salario

Actualiza un registro de salario existente del empleador autenticado.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del salario a actualizar

Request Body schema: application/json
required
contract_id
required
integer
salary_type_id
required
integer
value
required
number
begins_at
required
string <date-time>
note
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "salary_type_id": 0,
  • "value": 0,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "contract_id": 0,
    • "salary_type_id": 0,
    • "value": 0,
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "retroactive_date": "2019-08-24T14:15:22Z",
    • "is_adjustment": true,
    • "note": "string",
    • "is_current": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina un registro de salario de un contrato

Elimina un registro de salario especifico de un contrato del empleador autenticado.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del salario

contract-id
required
integer

ID del contrato al que pertenece

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Genera el libro de salarios

Genera el libro de salarios (Excel) del empleador autenticado, filtrable por contratos.

Authorizations:
bearerAuth
query Parameters
contract_ids
string

Lista de IDs de contrato separados por comas

employee_fields
required
string

Lista separada por comas de campos de empleado a incluir en el reporte

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Historial de cargos

Cambios de cargo de los empleados.

Registra un cambio de cargo en el historial laboral

Registra un cambio de cargo (job) en el historial laboral de un contrato del empleador; opcionalmente actualiza el cargo actual del contrato.

Authorizations:
bearerAuth
Request Body schema: application/json
required
is_update_current_job_id
boolean
contract_id
integer
employer_job_id
required
integer
begins_at
required
string <date>
ends_at
string <date>

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "is_update_current_job_id": true,
  • "contract_id": 0,
  • "employer_job_id": 0,
  • "begins_at": "2019-08-24",
  • "ends_at": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Histórico de entidades del empleado

Afiliaciones a EPS, AFP, ARL y cajas de compensación.

Lista el histórico de entidades de seguridad social de un contrato

Lista el histórico de entidades de seguridad social (EPS, AFP, ARL, cesantias, etc.) de un contrato para un tipo de entidad dado, ordenado por begins_at ascendente. Filtra siempre por la empresa del token. Si no hay registros devuelve un arreglo vacio.

Authorizations:
bearerAuth
path Parameters
contract-id
required
integer

ID del contrato del empleado

type-id
required
integer

ID del tipo de entidad de seguridad social (EPS, AFP, ARL, cesantías, etc.)

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Crea un registro de entidad para un contrato

Crea un nuevo registro de entidad para un contrato (cambio de EPS/AFP/etc.). Cierra automáticamente el registro vigente anterior y activa el nuevo registro como vigente; si el contrato tiene fecha de terminación, el nuevo registro la hereda como fecha de fin.

begins_at debe ser el primer día de un mes posterior al del registro vigente, y estar dentro del rango de vigencia del contrato. El tipo de entidad debe aplicar al tipo de contrato, y no se permite AFP para contratos pensionados o extranjeros sin pensión.

Authorizations:
bearerAuth
Request Body schema: application/json
required
contract_id
required
integer
entity_type_id
required
integer
social_security_entity_id
required
integer
begins_at
required
string <date-time>

Debe ser el dia 1 del mes

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "entity_type_id": 0,
  • "social_security_entity_id": 0,
  • "begins_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "entity_type_id": 0,
    • "social_security_entity_id": 0,
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "is_current": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza un registro de entidad

Actualiza el registro de entidad indicado. En la practica solo cambia la entidad de seguridad social (social_security_entity_id) del registro; solo se puede actualizar el registro vigente (is_current = true).

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del registro de histórico a actualizar

Request Body schema: application/json
required
contract_id
required
integer
social_security_entity_id
required
integer

Único campo que realmente se persiste

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "social_security_entity_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "entity_type_id": 0,
    • "social_security_entity_id": 0,
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "is_current": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina un registro de entidad

Elimina el registro de entidad indicado y reactiva el registro anterior del mismo contrato y tipo de entidad (lo vuelve vigente). Solo se puede eliminar el registro vigente y siempre que exista al menos un registro previo (no se puede borrar el único registro de la entidad).

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del registro de histórico a eliminar

contract-id
required
integer

ID del contrato al que pertenece el registro

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Terceros

Terceros a los que se giran descuentos de nómina.

Crea un tercero

Crea un tercero (persona o empresa relacionada, ej. EPS, AFP, bancos, otros terceros) para la empresa autenticada.

Authorizations:
bearerAuth
Request Body schema: application/json
required
identification_type_id
required
integer
identification_number
required
string
dv
string

Dígito de verificación del NIT.

first_name
string
middle_name
string
last_name
string
surname
string
business_name
string

Razón social, si el tercero es una empresa.

short_name
required
string

Nombre para mostrar del tercero.

email
string
address
string
phone
string
mobile
string
picture
string
code
required
string

Código del tercero usado en la interfaz contable.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "identification_type_id": 0,
  • "identification_number": "string",
  • "dv": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "surname": "string",
  • "business_name": "string",
  • "short_name": "string",
  • "email": "string",
  • "address": "string",
  • "phone": "string",
  • "mobile": "string",
  • "picture": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "identification_type_id": 0,
    • "identification_number": "string",
    • "dv": "string",
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "surname": "string",
    • "business_name": "string",
    • "short_name": "string",
    • "email": "string",
    • "address": "string",
    • "phone": "string",
    • "mobile": "string",
    • "picture": "string",
    • "country_id": 0,
    • "code": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Lista los terceros de la empresa

Lista paginada de terceros de la empresa autenticada (filtrados también por pais de la empresa), con busqueda por nombre corto/razon social/identificación y orden configurable.

Authorizations:
bearerAuth
query Parameters
search
string

Busqueda (ILIKE) sobre short_name, business_name o identification_number

sort
string

Campo de orden (default business_name)

sort_direction
string
Enum: "ASC" "DESC"

Direccion de orden (default ASC)

page
integer

Número de pagina (default 1)

limit
integer

Tamano de pagina (default 5)

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Actualiza un tercero

Actualiza un tercero de la empresa autenticada.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del tercero

Request Body schema: application/json
required
identification_type_id
required
integer
identification_number
required
string
dv
string

Dígito de verificación del NIT.

first_name
string
middle_name
string
last_name
string
surname
string
business_name
string

Razón social, si el tercero es una empresa.

short_name
required
string

Nombre para mostrar del tercero.

email
string
address
string
phone
string
mobile
string
picture
string
code
required
string

Código del tercero usado en la interfaz contable.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "identification_type_id": 0,
  • "identification_number": "string",
  • "dv": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "surname": "string",
  • "business_name": "string",
  • "short_name": "string",
  • "email": "string",
  • "address": "string",
  • "phone": "string",
  • "mobile": "string",
  • "picture": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "identification_type_id": 0,
    • "identification_number": "string",
    • "dv": "string",
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "surname": "string",
    • "business_name": "string",
    • "short_name": "string",
    • "email": "string",
    • "address": "string",
    • "phone": "string",
    • "mobile": "string",
    • "picture": "string",
    • "country_id": 0,
    • "code": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Periodos de pago

Consulta de periodos de pago por rango de fechas.

Lista los periodos de pago dentro de un rango de fechas

Obtiene los periodos de pago (pay periods) que caen dentro de un rango de fechas.

Authorizations:
bearerAuth
query Parameters
begins_at
required
string <date>

Fecha inicial del rango (YYYY-MM-DD)

ends_at
required
string <date>

Fecha final del rango (YYYY-MM-DD)

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Relaciones de periodos de pago

Periodos de pago vigentes y recientes de la empresa.

Obtiene los periodos de pago activos del empleador

Devuelve los periodos de pago activos del empleador, uno por cada frecuencia de pago activa.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Obtiene los periodos de pago del empleador para un año y mes

Devuelve los periodos de pago (con su frecuencia) del empleador para un año y mes dados.

Authorizations:
bearerAuth
query Parameters
year
required
integer

Año a consultar

month
required
integer

Mes a consultar

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Obtiene los últimos periodos de pago del empleador

Devuelve los últimos periodos de pago del empleador para una frecuencia y fecha de referencia dadas.

Authorizations:
bearerAuth
query Parameters
frequency-id
required
integer

Id de la frecuencia de pago

date
required
string <date-time>

Fecha de referencia (RFC3339)

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Periodos de pago del empleador

Cierre y reapertura de periodos de pago.

Cierra un periodo de pago del empleador

Cierra el periodo de pago indicado para el empleador autenticado.

Authorizations:
bearerAuth
path Parameters
pay-period-id
required
integer

Id numerico del periodo de pago a cerrar

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Reabre un periodo de pago del empleador previamente cerrado

Reabre un periodo de pago previamente cerrado. Requiere el permiso del modulo de reapertura (REOPEN), separado del modulo de gestión de periodos.

Authorizations:
bearerAuth
path Parameters
pay-period-id
required
integer

Id numerico del periodo de pago a reabrir

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Meses del empleador

Mes activo de la empresa, su cierre y su reapertura.

Obtiene el mes activo del empleador

Obtiene el mes activo actual del empleador. Responde 204 sin contenido si no hay mes activo.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "month_number": 0,
    • "year_number": 0,
    • "is_active": true,
    • "employee_headcount": 0,
    • "is_migrated": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Cierra el mes del empleador

Cierra el mes indicado del empleador y avanza al siguiente mes, devolviendo el nuevo mes (siguiente). Requiere permiso del modulo EMPLOYER_MONTH.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del mes del empleador (employer_month)

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "month_number": 0,
    • "year_number": 0,
    • "is_active": true,
    • "employee_headcount": 0,
    • "is_migrated": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Reabre el mes del empleador

Reabre el mes indicado (debe ser inmediatamente anterior al mes activo) y notifica a toda la empresa. Requiere permiso del modulo REOPEN (separado de EMPLOYER_MONTH).

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del mes del empleador (employer_month)

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "month_number": 0,
    • "year_number": 0,
    • "is_active": true,
    • "employee_headcount": 0,
    • "is_migrated": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Procesos de nómina

Creación, ejecución, aprobación, reapertura y borrado de procesos.

Crea un proceso de nómina

Crea un nuevo proceso de nómina (payroll) para un tipo de proceso, periodo y conjunto de contratos.

Authorizations:
bearerAuth
Request Body schema: application/json
required
process_type_code
required
string

Código del tipo de proceso, ej. MONTHLY/SETTLEMENT.

pay_frequency_id
required
integer
application_pay_period_id
integer

Requerido en procesos de liquidación.

description
string

Requerido en procesos de liquidación; para los demás se genera automáticamente si se omite.

Array of objects (ProcessContractInput)

Requerido (no vacío) en procesos de liquidación.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "process_type_code": "string",
  • "pay_frequency_id": 0,
  • "application_pay_period_id": 0,
  • "description": "string",
  • "contracts": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "process_type_id": 0,
    • "process_type_description": "string",
    • "process_type_code": "string",
    • "pay_frequency_id": 0,
    • "pay_period_id": 0,
    • "application_pay_period_id": 0,
    • "description": "string",
    • "status": "string",
    • "is_paid_full": true,
    • "stage": "string",
    • "hash": "string",
    • "created_by": 0,
    • "contract_ids": [
      ],
    • "is_migrated": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "month": 0,
    • "year": 0,
    • "sequence_period": 0,
    • "begins_at_application_period": "2019-08-24T14:15:22Z",
    • "ends_at_application_period": "2019-08-24T14:15:22Z",
    • "month_application_period": 0,
    • "year_application_period": 0,
    • "sequence_application_period": 0
    },
  • "messages": [
    • {
      }
    ]
}

Ejecuta o aprueba un proceso de nómina

Ejecuta un proceso (accion RUN) o lo aprueba (accion APPROVE), identificado por su hash. La accion enviada en el body debe ser RUN o APPROVE; cualquier otra es rechazada.

Authorizations:
bearerAuth
Request Body schema: application/json
required
process_type
required
string

Código del tipo de proceso

action
required
string
Enum: "RUN" "APPROVE"
hash
required
string

Hash del proceso

contracts
Array of integers

Contratos a incluir, opcional

is_re_execute
boolean

Re-ejecutar tras un fallo previo

run_with_debugger
boolean

Enviar logs por websocket

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "process_type": "string",
  • "action": "RUN",
  • "hash": "string",
  • "contracts": [
    • 0
    ],
  • "is_re_execute": true,
  • "run_with_debugger": true
}

Response samples

Content type
application/json
{
  • "data": {
    • "exec_status": "string",
    • "header": {
      },
    • "record": {
      },
    • "alerts": [
      ]
    },
  • "messages": [
    • {
      }
    ]
}

Edita un proceso de nómina existente

Edita los contratos de un proceso de liquidación existente antes de ejecutarlo. Solo implementado para procesos de tipo liquidación (SETTLEMENT).

Authorizations:
bearerAuth
Request Body schema: application/json
required
process_type_code
required
string
hash
required
string

Hash del proceso a editar.

required
Array of objects (ProcessContractInput)

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "process_type_code": "string",
  • "hash": "string",
  • "contracts": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "process_type_id": 0,
    • "process_type_description": "string",
    • "process_type_code": "string",
    • "pay_frequency_id": 0,
    • "pay_period_id": 0,
    • "application_pay_period_id": 0,
    • "description": "string",
    • "status": "string",
    • "is_paid_full": true,
    • "stage": "string",
    • "hash": "string",
    • "created_by": 0,
    • "contract_ids": [
      ],
    • "is_migrated": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "month": 0,
    • "year": 0,
    • "sequence_period": 0,
    • "begins_at_application_period": "2019-08-24T14:15:22Z",
    • "ends_at_application_period": "2019-08-24T14:15:22Z",
    • "month_application_period": 0,
    • "year_application_period": 0,
    • "sequence_application_period": 0
    },
  • "messages": [
    • {
      }
    ]
}

Reabre un proceso de nómina

Reabre un proceso ya ejecutado/aprobado (accion REOPEN), identificado por su hash, para permitir volver a correrlo.

Authorizations:
bearerAuth
Request Body schema: application/json
required
process_type
required
string
action
required
string
Value: "REOPEN"
hash
required
string

Hash del proceso

contracts
Array of integers
is_re_execute
boolean
run_with_debugger
boolean

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "process_type": "string",
  • "action": "REOPEN",
  • "hash": "string",
  • "contracts": [
    • 0
    ],
  • "is_re_execute": true,
  • "run_with_debugger": true
}

Response samples

Content type
application/json
{
  • "data": {
    • "exec_status": "string",
    • "header": {
      },
    • "record": {
      },
    • "alerts": [
      ]
    },
  • "messages": [
    • {
      }
    ]
}

Elimina un proceso de nómina

Elimina físicamente un proceso de nómina identificado por su hash, o solo algunos de sus contratos si el tipo de proceso admite borrado parcial (ver contracts en el body). El borrado no deja registro del proceso (ni de los contratos quitados, si es parcial); el usuario que ejecuta la acción se registra para auditoría.

Authorizations:
bearerAuth
path Parameters
hash
required
string

Hash único del proceso a eliminar

Request Body schema: application/json
required
process_type_code
required
string
Array of objects
includes_all_contracts
boolean

Indica que contracts incluye todos los contratos del proceso.

Responses

Request samples

Content type
application/json
{
  • "process_type_code": "string",
  • "contracts": [
    • {
      }
    ],
  • "includes_all_contracts": true
}

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Encabezados de proceso de nómina

Consulta y edición de los encabezados de proceso.

Obtiene un encabezado de proceso de nómina por id

Obtiene un encabezado de proceso de nómina por id. Devuelve 204 sin contenido si no existe.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del proceso

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "process_type_id": 0,
    • "process_type_description": "string",
    • "process_type_code": "string",
    • "pay_frequency_id": 0,
    • "pay_period_id": 0,
    • "application_pay_period_id": 0,
    • "description": "string",
    • "status": "string",
    • "is_paid_full": true,
    • "stage": "string",
    • "hash": "string",
    • "created_by": 0,
    • "contract_ids": [
      ],
    • "is_migrated": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "month": 0,
    • "year": 0,
    • "sequence_period": 0,
    • "begins_at_application_period": "2019-08-24T14:15:22Z",
    • "ends_at_application_period": "2019-08-24T14:15:22Z",
    • "month_application_period": 0,
    • "year_application_period": 0,
    • "sequence_application_period": 0
    },
  • "messages": [
    • {
      }
    ]
}

Marca un proceso de nómina como pagado en su totalidad

Marca un proceso de nómina como pagado en su totalidad (is_paid_full = true).

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del proceso

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Lista los encabezados de proceso de nómina

Lista todos los encabezados de proceso de nómina del empleador autenticado.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Obtiene un encabezado de proceso de nómina por hash

Obtiene un encabezado de proceso de nómina por su hash único. Devuelve 204 sin contenido si no existe.

Authorizations:
bearerAuth
path Parameters
hash
required
string

Hash del proceso

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "process_type_id": 0,
    • "process_type_description": "string",
    • "process_type_code": "string",
    • "pay_frequency_id": 0,
    • "pay_period_id": 0,
    • "application_pay_period_id": 0,
    • "description": "string",
    • "status": "string",
    • "is_paid_full": true,
    • "stage": "string",
    • "hash": "string",
    • "created_by": 0,
    • "contract_ids": [
      ],
    • "is_migrated": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "month": 0,
    • "year": 0,
    • "sequence_period": 0,
    • "begins_at_application_period": "2019-08-24T14:15:22Z",
    • "ends_at_application_period": "2019-08-24T14:15:22Z",
    • "month_application_period": 0,
    • "year_application_period": 0,
    • "sequence_application_period": 0
    },
  • "messages": [
    • {
      }
    ]
}

Obtiene los procesos de nómina del mes activo del empleador

Obtiene los procesos de nómina del mes activo del empleador, agrupados con el mes y año. Devuelve 204 sin contenido si no existe mes activo.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "month": 0,
    • "year": 0,
    • "processes": [
      ]
    },
  • "messages": [
    • {
      }
    ]
}

Lista los encabezados de proceso para un año y mes

Lista los encabezados de proceso de nómina del empleador para un año y mes dados.

Authorizations:
bearerAuth
path Parameters
year
required
integer

Año

month
required
integer

Mes

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Historial de procesos

Historial de acciones ejecutadas sobre un proceso.

Obtiene el último historial de una accion sobre un proceso

Obtiene el último registro de historial para una acción específica (ejecutar, aprobar o reabrir) sobre un proceso identificado por su hash. Devuelve 204 si no hay historial para esa acción.

Authorizations:
bearerAuth
query Parameters
hash
required
string

Hash del proceso

action
required
string
Enum: "RUN" "APPROVE" "REOPEN"

Accion del historial a consultar

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "process_id": 0,
    • "user_id": 0,
    • "action": "RUN",
    • "status": "FAILURE",
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "duration": "string",
    • "contract_quantity": 0,
    • "alerts": 0,
    • "contract_ids": [
      ],
    • "steps": [
      ],
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "employees": [
      ]
    },
  • "messages": [
    • {
      }
    ]
}

Bloqueo de procesos

Procesos bloqueados por ejecución en curso.

Obtiene el bloqueo de proceso vigente de la empresa

Devuelve el bloqueo de proceso de nómina vigente de la empresa autenticada, con el usuario que lo generó. Si no hay ningún bloqueo activo, responde 204 sin contenido.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "user_id": 0,
    • "code": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "user_name": "string",
    • "user_picture": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Conceptos

Conceptos de nómina de la empresa, su orden y sus sobreescrituras.

Crea un concepto

Crea un nuevo concepto (item de nómina) para el empleador; asigna código automático, pais heredado del empleador y clasificacion por defecto OCCASIONAL_NOVELTY si no se envia.

Authorizations:
bearerAuth
Request Body schema: application/json
required
concept_type_id
required
integer
description
required
string
formula
required
string

Formula del motor de formulacion

is_fixed
boolean
note
string
quantity_param
string

Letras mayusculas [A-Z_Ñ]

rate_param
string
begins_at_param
string
ends_at_param
string
base_param
string
classification
string
Enum: "ABSENCE" "OCCASIONAL_NOVELTY" "N/A"
object (ConceptRelationClassificationMetadata)

Responses

Response Schema: application/json
object (ConceptRelation)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "concept_type_id": 0,
  • "description": "string",
  • "formula": "string",
  • "is_fixed": true,
  • "note": "string",
  • "quantity_param": "string",
  • "rate_param": "string",
  • "begins_at_param": "string",
  • "ends_at_param": "string",
  • "base_param": "string",
  • "classification": "ABSENCE",
  • "classification_metadata": {
    • "absence": {
      }
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "concept_type_id": 0,
    • "code": "string",
    • "employer_id": 0,
    • "description": "string",
    • "formula": "string",
    • "is_fixed": true,
    • "note": "string",
    • "quantity_param": "string",
    • "rate_param": "string",
    • "begins_at_param": "string",
    • "ends_at_param": "string",
    • "base_param": "string",
    • "country_id": 0,
    • "is_blocked": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "concept_type_description": "string",
    • "is_standard": true,
    • "classification": "string",
    • "is_override": true,
    • "override": {
      },
    • "classification_metadata": {
      }
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza un concepto

Actualiza un concepto existente del empleador (descripción, formula, parámetros, clasificacion).

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del concepto

Request Body schema: application/json
required
concept_type_id
required
integer
description
required
string
formula
required
string

Formula del motor de formulacion

is_fixed
boolean
note
string
quantity_param
string

Letras mayusculas [A-Z_Ñ]

rate_param
string
begins_at_param
string
ends_at_param
string
base_param
string
classification
string
Enum: "ABSENCE" "OCCASIONAL_NOVELTY" "N/A"
object (ConceptRelationClassificationMetadata)

Responses

Response Schema: application/json
object (ConceptRelation)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "concept_type_id": 0,
  • "description": "string",
  • "formula": "string",
  • "is_fixed": true,
  • "note": "string",
  • "quantity_param": "string",
  • "rate_param": "string",
  • "begins_at_param": "string",
  • "ends_at_param": "string",
  • "base_param": "string",
  • "classification": "ABSENCE",
  • "classification_metadata": {
    • "absence": {
      }
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "concept_type_id": 0,
    • "code": "string",
    • "employer_id": 0,
    • "description": "string",
    • "formula": "string",
    • "is_fixed": true,
    • "note": "string",
    • "quantity_param": "string",
    • "rate_param": "string",
    • "begins_at_param": "string",
    • "ends_at_param": "string",
    • "base_param": "string",
    • "country_id": 0,
    • "is_blocked": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "concept_type_description": "string",
    • "is_standard": true,
    • "classification": "string",
    • "is_override": true,
    • "override": {
      },
    • "classification_metadata": {
      }
    },
  • "messages": [
    • {
      }
    ]
}

Lista todos los conceptos configurados del empleador

Lista todos los conceptos configurados del empleador con su relación completa (override, clasificacion).

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects (ConceptRelation)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Crea un override de un concepto

Personaliza la fórmula o los parámetros de un concepto del catálogo estándar para este empleador. No aplica a conceptos creados por el propio empleador (esos se editan directamente).

Authorizations:
bearerAuth
Request Body schema: application/json
required
concept_id
required
integer
formula
required
string
quantity_param
string
rate_param
string
begins_at_param
string
ends_at_param
string
base_param
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "concept_id": 0,
  • "formula": "string",
  • "quantity_param": "string",
  • "rate_param": "string",
  • "begins_at_param": "string",
  • "ends_at_param": "string",
  • "base_param": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "concept_id": 0,
    • "formula": "string",
    • "quantity_param": "string",
    • "rate_param": "string",
    • "begins_at_param": "string",
    • "ends_at_param": "string",
    • "base_param": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza el override de un concepto

Actualiza la personalización de un concepto del catálogo estándar para este empleador. No aplica a conceptos creados por el propio empleador.

Authorizations:
bearerAuth
path Parameters
concept-id
required
integer

ID del concepto sobrescrito

Request Body schema: application/json
required
formula
required
string
quantity_param
string
rate_param
string
begins_at_param
string
ends_at_param
string
base_param
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "formula": "string",
  • "quantity_param": "string",
  • "rate_param": "string",
  • "begins_at_param": "string",
  • "ends_at_param": "string",
  • "base_param": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "concept_id": 0,
    • "formula": "string",
    • "quantity_param": "string",
    • "rate_param": "string",
    • "begins_at_param": "string",
    • "ends_at_param": "string",
    • "base_param": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina el override de un concepto

Elimina la personalización de un concepto del catálogo estándar para este empleador (vuelve a usar la fórmula estándar).

Authorizations:
bearerAuth
path Parameters
concept-id
required
integer

ID del concepto sobrescrito

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Obtiene el orden de prioridad de los conceptos

Obtiene la lista de conceptos del empleador ordenados según la prioridad configurada.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Actualiza el orden de prioridad de los conceptos

Actualiza el orden de prioridad de los conceptos del empleador.

Authorizations:
bearerAuth
Request Body schema: application/json
required
country_id
integer
priority_list
required
Array of integers

Lista ordenada de IDs de concepto

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "country_id": 0,
  • "priority_list": [
    • 0
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Conceptos por tipo de proceso

Conceptos asociados a cada tipo de proceso.

Lista los tipos de proceso asociados a un concepto

Obtiene los tipos de proceso (process types) que tienen asociado un concepto dado.

Authorizations:
bearerAuth
path Parameters
concept-id
required
integer

ID del concepto

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Asocia un concepto a un tipo de proceso

Asocia (agrega) un concepto a un tipo de proceso.

Authorizations:
bearerAuth
Request Body schema: application/json
required
process_type_id
required
integer
concept_id
required
integer

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "process_type_id": 0,
  • "concept_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    • "employer_id": 0,
    • "process_type_id": 0,
    • "concept_id": 0
    },
  • "messages": [
    • {
      }
    ]
}

Quita la asociacion de un concepto de un tipo de proceso

Quita la asociacion de un concepto de un tipo de proceso.

Authorizations:
bearerAuth
path Parameters
process-type-id
required
integer

ID del tipo de proceso

concept-id
required
integer

ID del concepto

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "employer_id": 0,
    • "process_type_id": 0,
    • "concept_id": 0
    },
  • "messages": [
    • {
      }
    ]
}

Bases

Catálogo de bases de cotización/liquidación.

Lista las bases de cotización/liquidación

Devuelve las bases de cotización/liquidación configuradas para el empleador autenticado.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Bases de conceptos

Bases de cálculo asociadas a cada concepto.

Obtiene las bases configuradas de un concepto

Obtiene las bases de cotización asociadas a un concepto de la empresa autenticada (un concepto puede tener más de una base asociada).

Authorizations:
bearerAuth
path Parameters
concept-id
required
integer

Id del concepto

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Crea la relación entre una base y un concepto

Crea la relación entre una base y un concepto para la empresa autenticada.

Authorizations:
bearerAuth
Request Body schema: application/json
required
base_id
integer
concept_id
integer
classification
string
created_at
string <date-time>
updated_at
string <date-time>
employer_id
integer

Se sobreescribe con el del contexto.

base
string
accumulation_type
string
country_id
integer
description
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "base_id": 0,
  • "concept_id": 0,
  • "classification": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "employer_id": 0,
  • "base": "string",
  • "accumulation_type": "string",
  • "country_id": 0,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "base_id": 0,
    • "concept_id": 0,
    • "classification": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "employer_id": 0,
    • "base": "string",
    • "accumulation_type": "string",
    • "country_id": 0,
    • "description": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina la relación entre una base y un concepto

Elimina la relación entre una base y un concepto de la empresa autenticada.

Authorizations:
bearerAuth
path Parameters
base-id
required
integer

Id de la base

concept-id
required
integer

Id del concepto

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Dimensiones de concepto

Dimensiones configuradas para los conceptos.

Lista las dimensiones de concepto configuradas

Lista las dimensiones de concepto configuradas por la empresa junto con sus valores posibles.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Novedades ocasionales

Novedades que aplican una sola vez.

Crea una novedad ocasional

Crea una novedad ocasional de nómina (valor puntual asociado a un contrato, concepto y periodo de pago).

Authorizations:
bearerAuth
Request Body schema: application/json
required
contract_id
required
integer

No se puede cambiar al actualizar.

concept_id
required
integer
pay_period_id
required
integer
quantity
number
value
number
process_id
integer
notes
string
origin
required
string

No se puede cambiar al actualizar.

origin_description
string
external_id
string

No se puede cambiar al actualizar.

object

Códigos de dimensión contable (por ejemplo centro de costo). No se puede cambiar al actualizar.

batch_id
string

No se puede cambiar al actualizar.

novelty_date
string <date-time>

Si se omite, se usa la fecha y hora actuales.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "concept_id": 0,
  • "pay_period_id": 0,
  • "quantity": 0,
  • "value": 0,
  • "process_id": 0,
  • "notes": "string",
  • "origin": "string",
  • "origin_description": "string",
  • "external_id": "string",
  • "dimensions": {
    • "property1": "string",
    • "property2": "string"
    },
  • "batch_id": "string",
  • "novelty_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "concept_id": 0,
    • "pay_period_id": 0,
    • "quantity": 0,
    • "value": 0,
    • "status": "string",
    • "process_id": 0,
    • "notes": "string",
    • "origin": "string",
    • "origin_description": "string",
    • "external_id": "string",
    • "dimensions": {
      },
    • "batch_id": "string",
    • "novelty_date": "2019-08-24T14:15:22Z",
    • "salary_base": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza una novedad ocasional

Actualiza una novedad ocasional existente del empleador.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID de la novedad ocasional

Request Body schema: application/json
required
contract_id
required
integer

No se puede cambiar al actualizar.

concept_id
required
integer
pay_period_id
required
integer
quantity
number
value
number
process_id
integer
notes
string
origin
required
string

No se puede cambiar al actualizar.

origin_description
string
external_id
string

No se puede cambiar al actualizar.

object

Códigos de dimensión contable (por ejemplo centro de costo). No se puede cambiar al actualizar.

batch_id
string

No se puede cambiar al actualizar.

novelty_date
string <date-time>

Si se omite, se usa la fecha y hora actuales.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "concept_id": 0,
  • "pay_period_id": 0,
  • "quantity": 0,
  • "value": 0,
  • "process_id": 0,
  • "notes": "string",
  • "origin": "string",
  • "origin_description": "string",
  • "external_id": "string",
  • "dimensions": {
    • "property1": "string",
    • "property2": "string"
    },
  • "batch_id": "string",
  • "novelty_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "concept_id": 0,
    • "pay_period_id": 0,
    • "quantity": 0,
    • "value": 0,
    • "status": "string",
    • "process_id": 0,
    • "notes": "string",
    • "origin": "string",
    • "origin_description": "string",
    • "external_id": "string",
    • "dimensions": {
      },
    • "batch_id": "string",
    • "novelty_date": "2019-08-24T14:15:22Z",
    • "salary_base": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina una novedad ocasional

Elimina una novedad ocasional del empleador.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID de la novedad ocasional

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Obtiene una novedad ocasional por ID

Obtiene una novedad ocasional por ID con datos relacionados de empleado y concepto. Responde 204 si no existe.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID de la novedad ocasional

Responses

Response Schema: application/json
object (OccasionalNoveltyRelation)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "concept_id": 0,
    • "pay_period_id": 0,
    • "quantity": 0,
    • "value": 0,
    • "status": "string",
    • "process_id": 0,
    • "notes": "string",
    • "origin": "string",
    • "origin_description": "string",
    • "external_id": "string",
    • "dimensions": {
      },
    • "batch_id": "string",
    • "novelty_date": "2019-08-24T14:15:22Z",
    • "salary_base": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "surname": "string",
    • "thumbnail": "string",
    • "identification_number": "string",
    • "identification_type_id": 0,
    • "identification_type": "string",
    • "gender": "string",
    • "partner_alternate_code": "string",
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "concept_type_id": 0,
    • "concept_code": "string",
    • "concept_description": "string",
    • "concept_type_description": "string",
    • "edition_type": "NOT_ALLOWED"
    },
  • "messages": [
    • {
      }
    ]
}

Lista novedades ocasionales según estrategia

Lista novedades ocasionales según la estrategia de busqueda: "by-process" (requiere hash-process) trae las novedades de un proceso, "by-date-range" filtra por rango de fechas del periodo de pago. Soporta filtros y paginacion.

Authorizations:
bearerAuth
path Parameters
strategy-name
required
string
Enum: "by-process" "by-date-range"

Estrategia de busqueda

query Parameters
hash-process
string

Hash del proceso (requerido si strategy=by-process)

begins_at
string <date>

Fecha inicial del rango (requerido si strategy=by-date-range)

ends_at
string <date>

Fecha final del rango (requerido si strategy=by-date-range)

contract_id
integer

Filtra por ID del contrato

concept_id
integer

Filtra por ID del concepto

sort
string

Campo de ordenamiento (por defecto "id")

sort_direction
string
Enum: "ASC" "DESC"

Direccion del ordenamiento

page
integer

Número de pagina (por defecto 1)

limit
integer

Cantidad de resultados por pagina (por defecto 5)

Responses

Response Schema: application/json
Array of objects (OccasionalNoveltyRelation)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Descarga el reporte de novedades ocasionales según estrategia

Genera y descarga un reporte (archivo) de novedades ocasionales según la estrategia ("by-process" o "by-date-range"), sin paginacion.

Authorizations:
bearerAuth
path Parameters
strategy-name
required
string
Enum: "by-process" "by-date-range"

Estrategia de busqueda

query Parameters
hash-process
string

Hash del proceso (requerido si strategy=by-process)

begins_at
string <date>

Fecha inicial del rango (requerido si strategy=by-date-range)

ends_at
string <date>

Fecha final del rango (requerido si strategy=by-date-range)

contract_id
integer

Filtra por ID del contrato

concept_id
integer

Filtra por ID del concepto

sort
string

Campo de ordenamiento (por defecto "id")

sort_direction
string
Enum: "ASC" "DESC"

Direccion del ordenamiento

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Novedades recurrentes

Novedades que se repiten periodo tras periodo.

Crea una novedad recurrente

Crea una novedad recurrente para un contrato/concepto de nómina. El employer_id lo asigna el servidor y no debe enviarse en el body.

Authorizations:
bearerAuth
Request Body schema: application/json
required
contract_id
required
integer
concept_id
required
integer
begins_at
required
string <date>
ends_at
string <date>
value
required
number <double>
is_override
boolean
formula
string

Requerida si is_custom_formula es true

notes
string
is_custom_formula
boolean
application_period_sequence
string
Enum: "FIRST_PERIOD" "LAST_PERIOD" "ALL_PERIODS"

Requerido si is_override=true y is_custom_formula=false

standard_behavior
string
Enum: "APPLY_BY_SALARY_DAYS" "APPLY_BY_SALARY_DAYS_AND_VACATIONS" "APPLY_BY_SALARY_DAYS_AND_LEAVES" "APPLY_BY_SALARY_DAYS_AND_ABSENCES" "APPLY_BY_SALARY_DAYS_AND_ABSENTEEISM" "APPLY_BY_CONTRACT_DAYS" "APPLY_BY_FIX_VALUE"

Requerido si is_override=true y is_custom_formula=false

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "concept_id": 0,
  • "begins_at": "2019-08-24",
  • "ends_at": "2019-08-24",
  • "value": 0.1,
  • "is_override": true,
  • "formula": "string",
  • "notes": "string",
  • "is_custom_formula": true,
  • "application_period_sequence": "FIRST_PERIOD",
  • "standard_behavior": "APPLY_BY_SALARY_DAYS"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "concept_id": 0,
    • "begins_at": "2019-08-24",
    • "ends_at": "2019-08-24",
    • "value": 0.1,
    • "is_override": true,
    • "formula": "string",
    • "notes": "string",
    • "is_custom_formula": true,
    • "application_period_sequence": "FIRST_PERIOD",
    • "standard_behavior": "APPLY_BY_SALARY_DAYS",
    • "has_history": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza una novedad recurrente existente

Actualiza una novedad recurrente existente. El id se toma del path y el employer_id del contexto/token.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Identificador de la novedad recurrente

Request Body schema: application/json
required
contract_id
required
integer
concept_id
required
integer
begins_at
required
string <date>
ends_at
string <date>
value
required
number <double>
is_override
boolean
formula
string

Requerida si is_custom_formula es true

notes
string
is_custom_formula
boolean
application_period_sequence
string
Enum: "FIRST_PERIOD" "LAST_PERIOD" "ALL_PERIODS"

Requerido si is_override=true y is_custom_formula=false

standard_behavior
string
Enum: "APPLY_BY_SALARY_DAYS" "APPLY_BY_SALARY_DAYS_AND_VACATIONS" "APPLY_BY_SALARY_DAYS_AND_LEAVES" "APPLY_BY_SALARY_DAYS_AND_ABSENCES" "APPLY_BY_SALARY_DAYS_AND_ABSENTEEISM" "APPLY_BY_CONTRACT_DAYS" "APPLY_BY_FIX_VALUE"

Requerido si is_override=true y is_custom_formula=false

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "concept_id": 0,
  • "begins_at": "2019-08-24",
  • "ends_at": "2019-08-24",
  • "value": 0.1,
  • "is_override": true,
  • "formula": "string",
  • "notes": "string",
  • "is_custom_formula": true,
  • "application_period_sequence": "FIRST_PERIOD",
  • "standard_behavior": "APPLY_BY_SALARY_DAYS"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "concept_id": 0,
    • "begins_at": "2019-08-24",
    • "ends_at": "2019-08-24",
    • "value": 0.1,
    • "is_override": true,
    • "formula": "string",
    • "notes": "string",
    • "is_custom_formula": true,
    • "application_period_sequence": "FIRST_PERIOD",
    • "standard_behavior": "APPLY_BY_SALARY_DAYS",
    • "has_history": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina una novedad recurrente

Elimina una novedad recurrente del empleador.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Identificador de la novedad recurrente

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Obtiene el detalle de una novedad recurrente

Obtiene el detalle de una novedad recurrente por su id. Devuelve 204 si no existe.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Identificador de la novedad recurrente

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "concept_id": 0,
    • "begins_at": "2019-08-24",
    • "ends_at": "2019-08-24",
    • "value": 0.1,
    • "is_override": true,
    • "formula": "string",
    • "notes": "string",
    • "is_custom_formula": true,
    • "application_period_sequence": "FIRST_PERIOD",
    • "standard_behavior": "APPLY_BY_SALARY_DAYS",
    • "has_history": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Lista novedades recurrentes según estrategia

Lista las novedades recurrentes del empleador según una estrategia de busqueda (por proceso de nómina o por rango de fechas), con filtros, orden y paginacion.

Authorizations:
bearerAuth
path Parameters
strategy-name
required
string
Enum: "by-process" "by-date-range"

Estrategia de busqueda: by-process o by-date-range

query Parameters
hash-process
string

Hash del proceso de nómina, requerido si strategy=by-process

begins_at
string <date>

Fecha inicial (YYYY-MM-DD), requerida si strategy=by-date-range

ends_at
string <date>

Fecha final (YYYY-MM-DD), requerida si strategy=by-date-range

contract_id
integer

Filtra por contrato

concept_id
integer

Filtra por concepto

sort
string

Campo de orden, por ejemplo: id, concept_description, first_name

sort_direction
string
Enum: "ASC" "DESC"

Direccion del orden

page
integer
Default: 1

Número de pagina (por defecto 1)

limit
integer
Default: 5

Cantidad de resultados por pagina (por defecto 5)

kind
string

Si es distinto de "report" aplica paginacion por defecto

Responses

Response Schema: application/json
Array of objects (RecurrentNoveltyG2WithEmployeeItem)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Genera un reporte de novedades recurrentes según estrategia

Genera y descarga un reporte (archivo) de novedades recurrentes según la estrategia (por proceso o por rango de fechas), aplicando los mismos filtros que el listado.

Authorizations:
bearerAuth
path Parameters
strategy-name
required
string
Enum: "by-process" "by-date-range"

Estrategia de busqueda: by-process o by-date-range

query Parameters
hash-process
string

Hash del proceso de nómina, requerido si strategy=by-process

begins_at
string <date>

Fecha inicial, requerida si strategy=by-date-range

ends_at
string <date>

Fecha final, requerida si strategy=by-date-range

contract_id
integer

Filtra por contrato

concept_id
integer

Filtra por concepto

sort
string

Campo de orden

sort_direction
string
Enum: "ASC" "DESC"

Direccion del orden

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Ausentismos

Ausencias e incapacidades de los empleados.

Crea una novedad de ausentismo

Crea una novedad de ausentismo (incapacidad/suspension/ausencia) para un contrato. El servidor resuelve absence_type_id a partir del concept_id, calcula days/total_days con la ley de 360 dias, valida solapamiento con otras novedades y genera los absence_per_periods correspondientes.

Authorizations:
bearerAuth
Request Body schema: application/json
required
contract_id
required
integer
concept_id
required
integer
begins_at
required
string <date-time>
ends_at
required
string <date-time>

Debe ser mayor o igual a begins_at

origin
required
string
Enum: "APP_NOMINEROS" "INTEGRATION_NBC" "MASSIVE_UPLOAD"
code
string
note
string
has_discount_rest_day
boolean
date_rest_day
string <date-time>
can_pause_contract
boolean
origin_description
string
external_id
string
batch_id
string <uuid>

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "concept_id": 0,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "origin": "APP_NOMINEROS",
  • "code": "string",
  • "note": "string",
  • "has_discount_rest_day": true,
  • "date_rest_day": "2019-08-24T14:15:22Z",
  • "can_pause_contract": true,
  • "origin_description": "string",
  • "external_id": "string",
  • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "absence_type_id": 0,
    • "concept_id": 0,
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "days": 0,
    • "code": "string",
    • "note": "string",
    • "has_discount_rest_day": true,
    • "date_rest_day": "2019-08-24T14:15:22Z",
    • "total_days": 0,
    • "can_pause_contract": true,
    • "origin": "APP_NOMINEROS",
    • "origin_description": "string",
    • "external_id": "string",
    • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza una novedad de ausentismo

Actualiza una novedad de ausentismo existente del empleador autenticado. Recalcula dias, valida solapamiento y regenera los periodos afectados.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID de la novedad de ausentismo

Request Body schema: application/json
required
contract_id
required
integer
concept_id
required
integer
begins_at
required
string <date-time>
ends_at
required
string <date-time>

Debe ser mayor o igual a begins_at

origin
required
string
Enum: "APP_NOMINEROS" "INTEGRATION_NBC" "MASSIVE_UPLOAD"
code
string
note
string
has_discount_rest_day
boolean
date_rest_day
string <date-time>
can_pause_contract
boolean
origin_description
string
external_id
string
batch_id
string <uuid>

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "concept_id": 0,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "origin": "APP_NOMINEROS",
  • "code": "string",
  • "note": "string",
  • "has_discount_rest_day": true,
  • "date_rest_day": "2019-08-24T14:15:22Z",
  • "can_pause_contract": true,
  • "origin_description": "string",
  • "external_id": "string",
  • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "absence_type_id": 0,
    • "concept_id": 0,
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "days": 0,
    • "code": "string",
    • "note": "string",
    • "has_discount_rest_day": true,
    • "date_rest_day": "2019-08-24T14:15:22Z",
    • "total_days": 0,
    • "can_pause_contract": true,
    • "origin": "APP_NOMINEROS",
    • "origin_description": "string",
    • "external_id": "string",
    • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina una novedad de ausentismo

Elimina una novedad de ausentismo del empleador autenticado junto con sus registros por periodo.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID de la novedad de ausentismo

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Consulta el detalle de una novedad de ausentismo

Consulta el detalle de una novedad de ausentismo, con datos del empleado, del concepto y el desglose por periodo de nómina. Devuelve 204 sin contenido si no existe la novedad para ese empleador.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID de la novedad de ausentismo

Responses

Response Schema: application/json
object (AbsenceRelationDetail)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "absence_type_id": 0,
    • "concept_id": 0,
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "days": 0,
    • "code": "string",
    • "note": "string",
    • "has_discount_rest_day": true,
    • "date_rest_day": "2019-08-24T14:15:22Z",
    • "total_days": 0,
    • "can_pause_contract": true,
    • "origin": "APP_NOMINEROS",
    • "origin_description": "string",
    • "external_id": "string",
    • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "surname": "string",
    • "thumbnail": "string",
    • "identification_number": "string",
    • "identification_type_id": 0,
    • "identification_type": "string",
    • "gender": "string",
    • "partner_alternate_code": "string",
    • "absence_type_description": "string",
    • "concept_code": "string",
    • "concept_description": "string",
    • "edition_type": "NOT_ALLOWED",
    • "absence_per_periods": [
      ]
    },
  • "messages": [
    • {
      }
    ]
}

Lista paginada de novedades de ausentismo por estrategia

Lista paginada de novedades de ausentismo del empleador, filtradas según la estrategia: por proceso de nómina (by-process) o por rango de fechas (by-date-range).

Authorizations:
bearerAuth
path Parameters
strategy-name
required
string
Enum: "by-process" "by-date-range"

Estrategia de consulta: by-process o by-date-range

query Parameters
hash-process
string

Hash del proceso de nómina; requerido solo si strategy-name=by-process

begins_at
string <date>

Inicio del rango (YYYY-MM-DD); requerido solo si strategy-name=by-date-range. Filtra novedades cuyo ends_at >= begins_at.

ends_at
string <date>

Fin del rango (YYYY-MM-DD); requerido solo si strategy-name=by-date-range. Filtra novedades cuyo begins_at <= ends_at. Debe ser >= begins_at.

contract_id
integer

Filtra por contrato; 0 se ignora

absence_type_id
integer

Filtra por tipo de ausencia; 0 se ignora

sort
string
Default: "id"

Campo de ordenamiento (default id); admite concept_description y first_name

sort_direction
string
Default: "asc"
Enum: "asc" "desc"

Direccion de ordenamiento (default asc)

page
integer
Default: 1

Pagina (default 1)

limit
integer
Default: 5

Registros por pagina (default 5)

Responses

Response Schema: application/json
Array of objects (AbsenceRelationItem)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Descarga el reporte Excel de novedades de ausentismo

Descarga en Excel el reporte de novedades de ausentismo del empleador, usando la misma estrategia y filtros del listado, pero sin paginacion (exporta todos los resultados). Los parámetros page y limit se ignoran.

Authorizations:
bearerAuth
path Parameters
strategy-name
required
string
Enum: "by-process" "by-date-range"

Estrategia de consulta: by-process o by-date-range

query Parameters
hash-process
string

Hash del proceso de nómina; requerido solo si strategy-name=by-process

begins_at
string <date>

Inicio del rango (YYYY-MM-DD); requerido solo si strategy-name=by-date-range

ends_at
string <date>

Fin del rango (YYYY-MM-DD); requerido solo si strategy-name=by-date-range

contract_id
integer

Filtra por contrato; 0 se ignora

absence_type_id
integer

Filtra por tipo de ausencia; 0 se ignora

sort
string
Default: "id"

Campo de ordenamiento

sort_direction
string
Default: "asc"
Enum: "asc" "desc"

Direccion de ordenamiento

Responses

Response Headers
Content-Disposition
string

attachment; filename="ausentismos.xlsx"

X-File-Name
string

Nombre del archivo generado

Response Schema: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Incapacidades y licencias

Licencias y permisos de los empleados.

Lista las incapacidades/licencias de un contrato

Obtiene las incapacidades/licencias (leaves) de un contrato, de un tipo especifico, anteriores a una fecha dada.

Authorizations:
bearerAuth
path Parameters
contract-id
required
integer

ID del contrato

query Parameters
leave-type-id
required
integer

ID del tipo de incapacidad/licencia

before
required
string <date>

Fecha limite (YYYY-MM-DD); se buscan leaves con fecha anterior a esta

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Crea una incapacidad o licencia

Crea una incapacidad/licencia (leave) para un contrato del empleador autenticado. El employer_id se asigna automaticamente desde el token, no se envia en el body.

Authorizations:
bearerAuth
Request Body schema: application/json
required
contract_id
required
integer
leave_type_id
required
integer
begins_at
required
string <date-time>
ends_at
required
string <date-time>

No puede ser anterior a begins_at

days
integer
is_extends
boolean
extends_leave_id
integer

Requerido si is_extends es true

historical_days
integer
total_days
integer
medical_diagnosis
string
support_code
string
description
string
origin
string
origin_description
string
external_id
string
real_begins_at
string <date-time>
real_ends_at
string <date-time>
base
number <double>
batch_id
string <uuid>

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "leave_type_id": 0,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "days": 0,
  • "is_extends": true,
  • "extends_leave_id": 0,
  • "historical_days": 0,
  • "total_days": 0,
  • "medical_diagnosis": "string",
  • "support_code": "string",
  • "description": "string",
  • "origin": "string",
  • "origin_description": "string",
  • "external_id": "string",
  • "real_begins_at": "2019-08-24T14:15:22Z",
  • "real_ends_at": "2019-08-24T14:15:22Z",
  • "base": 0.1,
  • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "leave_type_id": 0,
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "days": 0,
    • "is_extends": true,
    • "extends_leave_id": 0,
    • "historical_days": 0,
    • "total_days": 0,
    • "medical_diagnosis": "string",
    • "support_code": "string",
    • "description": "string",
    • "origin": "string",
    • "origin_description": "string",
    • "external_id": "string",
    • "real_begins_at": "2019-08-24T14:15:22Z",
    • "real_ends_at": "2019-08-24T14:15:22Z",
    • "base": 0.1,
    • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza una incapacidad o licencia existente

Actualiza una incapacidad/licencia existente. El id y el employer_id se toman del path y del token respectivamente.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id de la incapacidad/licencia

Request Body schema: application/json
required
contract_id
required
integer
leave_type_id
required
integer
begins_at
required
string <date-time>
ends_at
required
string <date-time>

No puede ser anterior a begins_at

days
integer
is_extends
boolean
extends_leave_id
integer

Requerido si is_extends es true

historical_days
integer
total_days
integer
medical_diagnosis
string
support_code
string
description
string
origin
string
origin_description
string
external_id
string
real_begins_at
string <date-time>
real_ends_at
string <date-time>
base
number <double>
batch_id
string <uuid>

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "leave_type_id": 0,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "days": 0,
  • "is_extends": true,
  • "extends_leave_id": 0,
  • "historical_days": 0,
  • "total_days": 0,
  • "medical_diagnosis": "string",
  • "support_code": "string",
  • "description": "string",
  • "origin": "string",
  • "origin_description": "string",
  • "external_id": "string",
  • "real_begins_at": "2019-08-24T14:15:22Z",
  • "real_ends_at": "2019-08-24T14:15:22Z",
  • "base": 0.1,
  • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "leave_type_id": 0,
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "days": 0,
    • "is_extends": true,
    • "extends_leave_id": 0,
    • "historical_days": 0,
    • "total_days": 0,
    • "medical_diagnosis": "string",
    • "support_code": "string",
    • "description": "string",
    • "origin": "string",
    • "origin_description": "string",
    • "external_id": "string",
    • "real_begins_at": "2019-08-24T14:15:22Z",
    • "real_ends_at": "2019-08-24T14:15:22Z",
    • "base": 0.1,
    • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina una incapacidad o licencia

Elimina una incapacidad/licencia por id, validando que pertenezca al empleador autenticado.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id de la incapacidad/licencia

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Obtiene el detalle de una incapacidad o licencia

Obtiene el detalle de una incapacidad/licencia por id. Devuelve 204 sin contenido si no existe.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id de la incapacidad/licencia

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "leave_type_id": 0,
    • "begins_at": "2019-08-24T14:15:22Z",
    • "ends_at": "2019-08-24T14:15:22Z",
    • "days": 0,
    • "is_extends": true,
    • "extends_leave_id": 0,
    • "historical_days": 0,
    • "total_days": 0,
    • "medical_diagnosis": "string",
    • "support_code": "string",
    • "description": "string",
    • "origin": "string",
    • "origin_description": "string",
    • "external_id": "string",
    • "real_begins_at": "2019-08-24T14:15:22Z",
    • "real_ends_at": "2019-08-24T14:15:22Z",
    • "base": 0.1,
    • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Lista incapacidades o licencias según estrategia

Lista las incapacidades/licencias del empleador, filtradas según la estrategia (por proceso de nómina o por rango de fechas), incluyendo datos del empleado.

Authorizations:
bearerAuth
path Parameters
strategy-name
required
string
Enum: "by-process" "by-date-range"

Estrategia de busqueda: by-process o by-date-range

query Parameters
hash-process
string

Hash del proceso de nómina, requerido si strategy=by-process

begins_at
string <date>

Fecha inicial, requerida si strategy=by-date-range

ends_at
string <date>

Fecha final, requerida si strategy=by-date-range

Responses

Response Schema: application/json
Array of objects (LeaveRelationG2WithEmployeeItem)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Genera un reporte de incapacidades o licencias según estrategia

Genera y descarga un reporte (archivo) de incapacidades/licencias filtradas por la estrategia indicada (por proceso o por rango de fechas).

Authorizations:
bearerAuth
path Parameters
strategy-name
required
string
Enum: "by-process" "by-date-range"

Estrategia de busqueda: by-process o by-date-range

query Parameters
hash-process
string

Hash del proceso de nómina, requerido si strategy=by-process

begins_at
string <date>

Fecha inicial, requerida si strategy=by-date-range

ends_at
string <date>

Fecha final, requerida si strategy=by-date-range

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Vacaciones

Solicitudes y disfrute de vacaciones.

Crea una novedad de vacaciones

Crea una novedad de vacaciones para un contrato. El employer_id lo asigna el servidor.

Authorizations:
bearerAuth
Request Body schema: application/json
required
contract_id
required
integer

No se puede cambiar al actualizar.

vacation_type_id
required
integer
begins_at
required
string <date>
working_days
number <double>

Requerido salvo que el tipo de vacación sea "en dinero" (no aplica a ese caso).

origin
required
string

No se puede cambiar al actualizar.

origin_description
string
external_id
string

No se puede cambiar al actualizar.

has_custom_base
boolean
base_custom
number <double>

Requerido y mayor que 0 si has_custom_base es true.

batch_id
string <uuid>

No se puede cambiar al actualizar.

is_advance
boolean

Solo se respeta si override_is_advance es true; si no, se toma de la configuración de la empresa.

override_is_advance
boolean

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "vacation_type_id": 0,
  • "begins_at": "2019-08-24",
  • "working_days": 0.1,
  • "origin": "string",
  • "origin_description": "string",
  • "external_id": "string",
  • "has_custom_base": true,
  • "base_custom": 0.1,
  • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
  • "is_advance": true,
  • "override_is_advance": true
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "vacation_type_id": 0,
    • "begins_at": "2019-08-24",
    • "ends_at": "2019-08-24",
    • "calendar_days": 0.1,
    • "working_days": 0.1,
    • "non_working_days": 0.1,
    • "origin": "string",
    • "origin_description": "string",
    • "external_id": "string",
    • "base": 0.1,
    • "has_custom_base": true,
    • "base_custom": 0.1,
    • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
    • "is_advance": true,
    • "override_is_advance": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza una novedad de vacaciones existente

Actualiza una novedad de vacaciones existente.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Identificador de la novedad de vacaciones

Request Body schema: application/json
required
contract_id
required
integer

No se puede cambiar al actualizar.

vacation_type_id
required
integer
begins_at
required
string <date>
working_days
number <double>

Requerido salvo que el tipo de vacación sea "en dinero" (no aplica a ese caso).

origin
required
string

No se puede cambiar al actualizar.

origin_description
string
external_id
string

No se puede cambiar al actualizar.

has_custom_base
boolean
base_custom
number <double>

Requerido y mayor que 0 si has_custom_base es true.

batch_id
string <uuid>

No se puede cambiar al actualizar.

is_advance
boolean

Solo se respeta si override_is_advance es true; si no, se toma de la configuración de la empresa.

override_is_advance
boolean

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "vacation_type_id": 0,
  • "begins_at": "2019-08-24",
  • "working_days": 0.1,
  • "origin": "string",
  • "origin_description": "string",
  • "external_id": "string",
  • "has_custom_base": true,
  • "base_custom": 0.1,
  • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
  • "is_advance": true,
  • "override_is_advance": true
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "vacation_type_id": 0,
    • "begins_at": "2019-08-24",
    • "ends_at": "2019-08-24",
    • "calendar_days": 0.1,
    • "working_days": 0.1,
    • "non_working_days": 0.1,
    • "origin": "string",
    • "origin_description": "string",
    • "external_id": "string",
    • "base": 0.1,
    • "has_custom_base": true,
    • "base_custom": 0.1,
    • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
    • "is_advance": true,
    • "override_is_advance": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina una novedad de vacaciones

Elimina una novedad de vacaciones del empleador. Solo se puede eliminar si ninguno de sus periodos de nómina asociados ya fue liquidado.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Identificador de la novedad de vacaciones

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Obtiene el detalle de una novedad de vacaciones

Obtiene el detalle de una novedad de vacaciones, incluyendo su distribucion por periodos de pago. Devuelve 204 si no existe.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Identificador de la novedad de vacaciones

Responses

Response Schema: application/json
object (VacationRelationG2DetailItem)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "contract_id": 0,
    • "vacation_type_id": 0,
    • "begins_at": "2019-08-24",
    • "ends_at": "2019-08-24",
    • "calendar_days": 0.1,
    • "working_days": 0.1,
    • "non_working_days": 0.1,
    • "origin": "string",
    • "origin_description": "string",
    • "external_id": "string",
    • "base": 0.1,
    • "has_custom_base": true,
    • "base_custom": 0.1,
    • "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
    • "is_advance": true,
    • "override_is_advance": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "surname": "string",
    • "thumbnail": "string",
    • "identification_number": "string",
    • "identification_type_id": 0,
    • "identification_type": "string",
    • "gender": "string",
    • "partner_alternate_code": "string",
    • "vacation_type_description": "string",
    • "vacation_is_in_money": true,
    • "edition_type": "string",
    • "vacation_per_periods": [
      ]
    },
  • "messages": [
    • {
      }
    ]
}

Lista novedades de vacaciones según estrategia

Lista las novedades de vacaciones del empleador según estrategia (por proceso de nómina o por rango de fechas), con filtros, orden y paginacion.

Authorizations:
bearerAuth
path Parameters
strategy-name
required
string
Enum: "by-process" "by-date-range"

Estrategia de busqueda: by-process o by-date-range

query Parameters
hash-process
string

Hash del proceso de nómina, requerido si strategy=by-process

begins_at
string <date>

Fecha inicial (YYYY-MM-DD), requerida si strategy=by-date-range; intersecta con el rango de la vacación

ends_at
string <date>

Fecha final (YYYY-MM-DD), requerida si strategy=by-date-range

contract_id
integer

Filtra por contrato

vacation_type_id
integer

Filtra por tipo de vacación

sort
string

Campo de orden

sort_direction
string
Enum: "ASC" "DESC"

Direccion del orden

page
integer

Número de pagina

limit
integer

Cantidad de resultados por pagina

kind
string

Si es "report" omite la paginacion

Responses

Response Schema: application/json
Array of objects (VacationRelationG2WithEmployeeItem)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Genera un reporte de novedades de vacaciones según estrategia

Genera y descarga un reporte (archivo) de novedades de vacaciones según la estrategia, aplicando los mismos filtros que el listado.

Authorizations:
bearerAuth
path Parameters
strategy-name
required
string
Enum: "by-process" "by-date-range"

Estrategia de busqueda: by-process o by-date-range

query Parameters
hash-process
string

Hash del proceso de nómina, requerido si strategy=by-process

begins_at
string <date>

Fecha inicial, requerida si strategy=by-date-range

ends_at
string <date>

Fecha final, requerida si strategy=by-date-range

contract_id
integer

Filtra por contrato

vacation_type_id
integer

Filtra por tipo de vacación

sort
string

Campo de orden

sort_direction
string

Direccion del orden

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Comprobantes de pago

Comprobantes de nómina por empleado y su envío por correo.

Lista los empleados de un proceso para comprobantes de pago

Lista paginada de los empleados de un proceso de nómina, con búsqueda y orden, para mostrarlos en la sección de comprobantes de pago.

Authorizations:
bearerAuth
path Parameters
hash
required
string

Hash del proceso

query Parameters
limit
required
integer

Tamano de pagina

page
required
integer

Número de pagina

search
string

Busqueda por nombre/identificación

sort
string

Campo de orden

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Obtiene el resumen de un proceso para comprobantes de pago

Obtiene el resumen (alertas del proceso, total de empleados, total a pagar) de un proceso de nómina para el panel de comprobantes de pago.

Authorizations:
bearerAuth
path Parameters
hash
required
string

Hash del proceso

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "process_alerts": [
      ],
    • "total_employees": 0,
    • "total_to_pay": 0
    },
  • "messages": [
    • {
      }
    ]
}

Genera el reporte/comprobante de pago de un proceso

Genera el comprobante de pago de uno o varios contratos de un proceso, en el formato solicitado (PDF, Excel o HTML). Si no se envían contract_ids, genera el comprobante de todos los contratos del proceso. Si el formato es distinto de HTML devuelve el archivo como descarga; si es HTML devuelve el contenido embebido directamente en la respuesta (no usa el formato estándar data/messages).

Authorizations:
bearerAuth
path Parameters
hash
required
string

Hash del proceso (sobrescribe el process_hash del cuerpo)

Request Body schema: application/json
required
contract_ids
Array of integers

Si se omite, incluye todos los contratos del proceso.

format_file
required
string
Enum: "PDF" "EXCEL" "EXCEL_OLD" "HTML"

Formato del archivo a generar

kind
string
Enum: "zip" "one_file"

Modo de empaquetado. Solo aplica cuando format_file es PDF y hay más de un contrato; si se omite, el archivo se entrega comprimido en zip.

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema:
string <binary>

Request samples

Content type
application/json
{
  • "contract_ids": [
    • 0
    ],
  • "format_file": "PDF",
  • "kind": "zip"
}

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Envia por correo los comprobantes de pago de un proceso

Envía por correo electrónico el comprobante de pago a los empleados de un proceso (a todos, a los pendientes de envío, o a una selección de contratos). Solo se envía a los contratos que tienen un correo electrónico registrado.

Authorizations:
bearerAuth
path Parameters
hash
required
string

Hash del proceso (sobrescribe el process_hash del cuerpo)

Request Body schema: application/json
required
contract_ids
Array of integers

Se usa cuando send_type es SELECTION; si se omite en ese caso, se envía a todos los contratos con correo registrado (igual que ALL).

send_type
required
string
Enum: "ALL" "PENDING" "SELECTION"

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "contract_ids": [
    • 0
    ],
  • "send_type": "ALL"
}

Response samples

Content type
application/json
{
  • "data": {
    • "message": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Depósitos de pago

Pagos y giros asociados a un proceso de nómina.

Crea un deposito de pago

Crea un depósito de pago (agrupación de nómina neta a pagar) para un proceso. Si is_all_contracts es true incluye todos los contratos del proceso que aún no tienen depósito asignado; si es false, solo los contract_ids indicados (falla si alguno no pertenece al proceso o ya está pagado). Con método de pago TRANSFERENCIA BANCARIA, todos los contratos incluidos deben tener ese método de pago y un banco asignado.

Authorizations:
bearerAuth
Request Body schema: application/json
required
process_id
integer

Requerido al crear. Se ignora al actualizar.

payment_method
required
string
Enum: "TRANSFERENCIA BANCARIA" "CHEQUE" "EFECTIVO"

Al actualizar, debe coincidir con el método de pago actual del depósito.

employer_bank_id
integer

Requerido si payment_method es TRANSFERENCIA BANCARIA.

bank_file_id
integer

Requerido si payment_method es TRANSFERENCIA BANCARIA.

pay_date
required
string <date-time>
is_all_contracts
boolean

Se ignora al actualizar.

contract_ids
Array of integers

Requerido (no vacío) al crear si is_all_contracts es false. Se ignora al actualizar.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "process_id": 0,
  • "payment_method": "TRANSFERENCIA BANCARIA",
  • "employer_bank_id": 0,
  • "bank_file_id": 0,
  • "pay_date": "2019-08-24T14:15:22Z",
  • "is_all_contracts": true,
  • "contract_ids": [
    • 0
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "code": "string",
    • "employer_id": 0,
    • "employees": 0,
    • "total": 0,
    • "bank_id": 0,
    • "bank_account_number": "string",
    • "bank_account_type": "CUENTA DE AHORROS",
    • "pay_date": "2019-08-24T14:15:22Z",
    • "payment_method": "TRANSFERENCIA BANCARIA",
    • "bank_file_id": 0,
    • "is_paid": true,
    • "process_id": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza un deposito de pago

Actualiza la fecha de pago y, si aplica, el banco o archivo plano de un depósito de pago existente. El método de pago no se puede cambiar una vez creado el depósito. Esta operación no modifica los contratos incluidos en el depósito.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del deposito de pago a actualizar

Request Body schema: application/json
required
process_id
integer

Requerido al crear. Se ignora al actualizar.

payment_method
required
string
Enum: "TRANSFERENCIA BANCARIA" "CHEQUE" "EFECTIVO"

Al actualizar, debe coincidir con el método de pago actual del depósito.

employer_bank_id
integer

Requerido si payment_method es TRANSFERENCIA BANCARIA.

bank_file_id
integer

Requerido si payment_method es TRANSFERENCIA BANCARIA.

pay_date
required
string <date-time>
is_all_contracts
boolean

Se ignora al actualizar.

contract_ids
Array of integers

Requerido (no vacío) al crear si is_all_contracts es false. Se ignora al actualizar.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "process_id": 0,
  • "payment_method": "TRANSFERENCIA BANCARIA",
  • "employer_bank_id": 0,
  • "bank_file_id": 0,
  • "pay_date": "2019-08-24T14:15:22Z",
  • "is_all_contracts": true,
  • "contract_ids": [
    • 0
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "code": "string",
    • "employer_id": 0,
    • "employees": 0,
    • "total": 0,
    • "bank_id": 0,
    • "bank_account_number": "string",
    • "bank_account_type": "CUENTA DE AHORROS",
    • "pay_date": "2019-08-24T14:15:22Z",
    • "payment_method": "TRANSFERENCIA BANCARIA",
    • "bank_file_id": 0,
    • "is_paid": true,
    • "process_id": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Lista los depositos de pago de un proceso

Lista todos los depositos de pago de un proceso para la empresa autenticada.

Authorizations:
bearerAuth
path Parameters
processID
required
integer

ID del proceso de nómina

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Obtiene el resumen de pago de un proceso

Devuelve el resumen de pago del proceso: cuantos empleados hay en total, cuantos son pagables, cuantos ya tienen deposito asignado y cuantos estan pagados.

Authorizations:
bearerAuth
path Parameters
processID
required
integer

ID del proceso de nómina

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "total_employees": 0,
    • "employees_payable": 0,
    • "employees_with_deposit": 0,
    • "employees_paid": 0
    },
  • "messages": [
    • {
      }
    ]
}

Aprueba un deposito de pago

Aprueba (marca como pagado) un deposito de pago de la empresa autenticada.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del deposito de pago a aprobar

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Elimina un deposito de pago de un proceso

Elimina un deposito de pago de un proceso y libera las nóminas netas asociadas. Falla si el deposito ya esta pagado.

Authorizations:
bearerAuth
path Parameters
processID
required
integer

ID del proceso de nómina

depositPaymentID
required
integer

ID del deposito de pago a eliminar

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Descarga el archivo plano bancario de un depósito de pago

Genera y descarga el archivo plano que se carga al banco para ejecutar un depósito de pago por transferencia bancaria. Solo aplica a depósitos con payment_method TRANSFERENCIA BANCARIA que tengan un banco/archivo plano configurado.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del depósito de pago

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el reporte de detalle de pagos de un depósito de pago

Genera y descarga un reporte (Excel) con el detalle de los pagos incluidos en un depósito de pago: empleado, banco, tipo y número de cuenta, método de pago y valor transferido.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del depósito de pago

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Reportes de nómina

Reportes del proceso de nómina, del histórico, y de saldos e impuestos.

Descarga el reporte mensual de retenciones/impuestos

Descarga el reporte mensual de retenciones/impuestos de la empresa autenticada para un año y mes especificos.

Authorizations:
bearerAuth
query Parameters
year
required
integer

Año del reporte

month
required
integer

Mes del reporte

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el detalle de impuestos/retenciones en un rango de fechas

Descarga el detalle de impuestos/retenciones de la empresa autenticada en un rango de fechas.

Authorizations:
bearerAuth
Request Body schema: application/json
required
employer_id
integer

Se sobreescribe con el empleador del token.

begins_at
required
string <date-time>
ends_at
required
string <date-time>

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Request samples

Content type
application/json
{
  • "employer_id": 0,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "ends_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el certificado de retención en la fuente de un contrato

Descarga el certificado/anexo de retención en la fuente de un contrato para un proceso especifico.

Authorizations:
bearerAuth
query Parameters
contract-id
required
integer

Id del contrato

process-hash
required
string

Hash del proceso de nómina

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el libro de vacaciones de los contratos indicados

Descarga el libro de vacaciones de los contratos indicados, con opcion de incluir retirados, a una fecha de corte.

Authorizations:
bearerAuth
Request Body schema: application/json
required
employer_id
integer

Se sobreescribe con el empleador del token.

request_date
string <date-time>
contract_ids
Array of integers
add_retired
boolean

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Request samples

Content type
application/json
{
  • "employer_id": 0,
  • "request_date": "2019-08-24T14:15:22Z",
  • "contract_ids": [
    • 0
    ],
  • "add_retired": true
}

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el reporte de saldo de prima de servicios

Descarga el reporte de saldo de prima de servicios de la empresa autenticada para un proceso.

Authorizations:
bearerAuth
query Parameters
process-hash
required
string

Hash del proceso de nómina

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el reporte de saldo de cesantias e intereses

Descarga el reporte de saldo de cesantias (y sus intereses) de la empresa autenticada para un proceso.

Authorizations:
bearerAuth
query Parameters
process-hash
required
string

Hash del proceso de nómina

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el reporte de saldo de vacaciones

Descarga el reporte de saldo de vacaciones de la empresa autenticada para un proceso.

Authorizations:
bearerAuth
query Parameters
process-hash
required
string

Hash del proceso de nómina

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el reporte de recalculo de retención en la fuente

Descarga el reporte de recalculo de retención en la fuente de la empresa autenticada para un proceso.

Authorizations:
bearerAuth
query Parameters
process-hash
required
string

Hash del proceso de nómina

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el reporte de pago a fondo de cesantias

Descarga el reporte de pago a fondo de cesantias de la empresa autenticada para un proceso.

Authorizations:
bearerAuth
query Parameters
process-hash
required
string

Hash del proceso de nómina

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Planilla de nómina

Genera el comprobante de nómina (Excel) del proceso identificado por su hash, para todos los empleados del proceso.

Authorizations:
bearerAuth
path Parameters
process-hash
required
string

Hash del proceso de nómina

query Parameters
employee_fields
required
string

Lista separada por comas de campos de empleado a incluir (puede incluir dimensión:<código>)

concept_types
required
string

Lista separada por comas de prefijos de tipos de concepto a incluir

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Genera el reporte de pagos de prima o bonificaciones

Genera el reporte (Excel) de pagos de prima/bonificaciones del proceso. Disponible solo para empresas de Colombia.

Authorizations:
bearerAuth
path Parameters
process-hash
required
string

Hash del proceso de nómina

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Genera el reporte de conceptos resumidos del proceso

Genera el reporte (Excel) de conceptos resumidos (totales por concepto) del proceso.

Authorizations:
bearerAuth
path Parameters
process-hash
required
string

Hash del proceso de nómina

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Genera el reporte histórico de nómina

Genera el reporte histórico (Excel) de nómina para un rango de fechas y, opcionalmente, un conjunto de contratos.

Authorizations:
bearerAuth
query Parameters
from
required
string <date>

Fecha inicial

to
required
string <date>

Fecha final

contract_ids
string

Lista de IDs de contrato separados por comas

employee_fields
required
string

Campos de empleado a incluir

concept_types
required
string

Prefijos de tipos de concepto a incluir

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Genera el reporte maestro de empleados

Genera el reporte maestro (Excel) de empleados, filtrable por estados de contrato.

Authorizations:
bearerAuth
query Parameters
statuses
string

Lista de estados de contrato separados por comas

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Genera el reporte de impuestos contingentes

Genera el reporte (Excel) de impuestos contingentes de la empresa autenticada para un rango de fechas.

Authorizations:
bearerAuth
query Parameters
begins_at
required
string <date>

Fecha inicial del rango (YYYY-MM-DD). No puede ser posterior a ends_at.

ends_at
required
string <date>

Fecha final del rango (YYYY-MM-DD)

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Genera el reporte de mínimo vital del proceso

Genera el reporte (Excel) de mínimo vital del proceso identificado por su hash.

Authorizations:
bearerAuth
path Parameters
process-hash
required
string

Hash del proceso de nómina

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Reportes personalizados

Ejecución de reportes configurables de la empresa.

Ejecuta y descarga un reporte personalizado registrado

Ejecuta y descarga un reporte configurable registrado para la empresa, identificado por su nombre (report), filtrable por proceso o contrato según lo que ese reporte requiera.

Authorizations:
bearerAuth
Request Body schema: application/json
required
process_hash
string

Requerido u opcional según el reporte solicitado (report).

contract_hash
string

Requerido u opcional según el reporte solicitado (report).

report
required
string

Nombre técnico del reporte a ejecutar, definido al registrarlo para la empresa.

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Request samples

Content type
application/json
{
  • "process_hash": "string",
  • "contract_hash": "string",
  • "report": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Interfaz contable

Generación y consulta de la interfaz contable.

Genera la salida de la interfaz contable

Genera la salida de la interfaz contable de la empresa para un ano/mes (y opcionalmente unos procesos especificos). Según el tipo de salida, descarga un archivo Excel o envia la información a una API REST externa y devuelve el resultado de ese envio.

La respuesta tiene dos formas según el output_type resuelto (del request, o el de la configuración contable si el request lo omite):

  • FILE: responde el archivo binario (sin envelope).
  • API_REST: responde JSON 200 con el envelope estandar y el objeto ApiResult en data.
Authorizations:
bearerAuth
Request Body schema: application/json
required
account_interface_configuration_id
required
string <uuid>

ID de la configuración de interfaz contable

year
required
integer

Ano del periodo a generar

month
required
integer

Mes del periodo a generar (1-12)

process_hashs
Array of strings

Hashes de los procesos de nómina a incluir; si se omite toma todos los del periodo

output_type
string
Enum: "FILE" "API_REST"

Tipo de salida; si se omite se usa el configurado en la configuración contable

Responses

Response Headers
Content-Disposition
string

attachment; filename=".xlsx" (solo cuando output_type=FILE)

X-File-Name
string

Nombre del archivo generado (solo cuando output_type=FILE)

Response Schema:
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "account_interface_configuration_id": "257ee726-9000-4c24-abba-d65a3e00e883",
  • "year": 0,
  • "month": 0,
  • "process_hashs": [
    • "string"
    ],
  • "output_type": "FILE"
}

Response samples

Content type
{
  • "data": {
    • "success": true,
    • "response": "string",
    • "status_code": 0,
    • "api_id": "string",
    • "processed_data": {
      }
    },
  • "messages": [
    • {
      }
    ]
}

Genera la interfaz contable

Genera la interfaz contable para la empresa autenticada, a partir de una configuración, procesos (hashes) o rango año/mes.

Authorizations:
bearerAuth
Request Body schema: application/json
required
accounting_interface_configuration_id
string <uuid>
process_hashes
Array of strings
year
integer
month
integer

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "accounting_interface_configuration_id": "dd0334f3-6149-49dd-8b93-96c8c8983a28",
  • "process_hashes": [
    • "string"
    ],
  • "year": 0,
  • "month": 0
}

Response samples

Content type
application/json
{
  • "data": {
    • "message": "ok"
    },
  • "messages": [
    • {
      }
    ]
}

Lista las interfaces contables generadas por año y mes

Obtiene las interfaces contables generadas de la empresa autenticada para un año y mes especificos.

Authorizations:
bearerAuth
query Parameters
year
required
integer

Año a consultar

month
required
integer

Mes a consultar

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Lista las interfaces contables de un proceso de nómina

Obtiene las interfaces contables generadas asociadas a un proceso de nómina (por hash).

Authorizations:
bearerAuth
path Parameters
hash
required
string

Hash del proceso de nómina

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Descarga el reporte de conceptos contables resumidos

Descarga un reporte (archivo) con los conceptos contables resumidos entre un rango de fechas, agrupados según parámetro, con o sin discriminar terceros.

Authorizations:
bearerAuth
query Parameters
from
required
string

Fecha de inicio

to
required
string

Fecha de fin

group_by
required
string

Criterio de agrupacion

has_third_party
string

Indica si discrimina por tercero ("true"/"false")

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el reporte de interfaz contable por configuración

Descarga el reporte de interfaz contable generado con base en una configuración especifica.

Authorizations:
bearerAuth
path Parameters
configuration-id
required
string <uuid>

Id de la configuración de interfaz contable

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el reporte detallado de la interfaz contable

Descarga el reporte detallado de la interfaz contable para año/mes, filtrable por hashes de proceso y/o configuraciones de interfaz contable.

Authorizations:
bearerAuth
Request Body schema: application/json
required
year
required
integer
month
required
integer
process_hashes
Array of strings
accounting_interface_configuration_ids
Array of strings <uuid> [ items <uuid > ]

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string <binary>

Request samples

Content type
application/json
{
  • "year": 0,
  • "month": 0,
  • "process_hashes": [
    • "string"
    ],
  • "accounting_interface_configuration_ids": [
    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Archivo interfaz contable

Plantilla del archivo de interfaz contable (columnas, orden, agrupación).

Lista los archivos de interfaz contable

Lista los archivos de interfaz contable del empleador autenticado, ordenados por nombre.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Crea un archivo de interfaz contable

Crea un nuevo archivo de interfaz contable para el empleador. Inicializa order_by, group_by y header_groups vacios y has_header en true.

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
format
required
string
Enum: "EXCEL" "FIXED_SIZE" "CSV_SEPARATOR"
separator_character
string

Requerido si format es CSV_SEPARATOR; se ignora para los demás formatos.

is_active
boolean
system
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "name": "string",
  • "format": "EXCEL",
  • "separator_character": "string",
  • "is_active": true,
  • "system": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "name": "string",
    • "format": "EXCEL",
    • "has_header": true,
    • "order_by": [
      ],
    • "separator_character": "string",
    • "is_active": true,
    • "group_by": {
      },
    • "system": "string",
    • "header_groups": [
      ],
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Obtiene un archivo de interfaz contable

Obtiene un archivo de interfaz contable con sus columnas (detalle) completas, resolviendo el orden desde order_by.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del archivo de interfaz contable

Responses

Response Schema: application/json
object (AccountingInterfaceFileDetailFull)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "name": "string",
    • "format": "EXCEL",
    • "has_header": true,
    • "order_by": [
      ],
    • "separator_character": "string",
    • "is_active": true,
    • "group_by": {
      },
    • "system": "string",
    • "header_groups": [
      ],
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "columns": [
      ]
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza un archivo de interfaz contable

Actualiza nombre, formato, estado activo y caracter separador de un archivo de interfaz contable (preserva order_by, group_by y header_groups existentes).

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del archivo de interfaz contable

Request Body schema: application/json
required
name
required
string
format
required
string
Enum: "EXCEL" "FIXED_SIZE" "CSV_SEPARATOR"
separator_character
string

Requerido si format es CSV_SEPARATOR; se ignora para los demás formatos.

is_active
boolean

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "name": "string",
  • "format": "EXCEL",
  • "separator_character": "string",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "name": "string",
    • "format": "EXCEL",
    • "has_header": true,
    • "order_by": [
      ],
    • "separator_character": "string",
    • "is_active": true,
    • "group_by": {
      },
    • "system": "string",
    • "header_groups": [
      ],
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza el orden de las columnas de un archivo de interfaz contable

Actualiza el orden de las columnas (order_by) del archivo, validando que coincidan con las columnas existentes y sin duplicados.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del archivo de interfaz contable

Request Body schema: application/json
required
data
required
Array of strings

Lista ordenada de códigos de columna. Debe incluir todos los códigos del archivo, sin duplicados.

Responses

Response Schema: application/json
data
Array of strings

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "data": [
    • "string"
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    • "string"
    ],
  • "messages": [
    • {
      }
    ]
}

Actualiza la agrupacion de un archivo de interfaz contable

Actualiza la agrupacion (group_by) y agregaciones del archivo; si se envian agregaciones vacias, se limpia el group_by.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del archivo de interfaz contable

Request Body schema: application/json
required
required
object (AccountingInterfaceFileGroupBy)

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "data": {
    • "columns": [
      ],
    • "aggregations": [
      ]
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "columns": [
      ],
    • "aggregations": [
      ]
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza los grupos de encabezado de un archivo de interfaz contable

Actualiza los grupos de encabezado (header_groups) del archivo; solo permitido para archivos de formato EXCEL, valida rangos de columnas sin solapamiento.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del archivo de interfaz contable

Request Body schema: application/json
required
required
Array of objects (AccountingInterfaceFileHeaderGroup)

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "data": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Crea una columna en un archivo de interfaz contable

Crea una nueva columna (detalle) en el archivo de interfaz contable; genera el código a partir del label (con sufijo numerico si ya existe) y la agrega al final de order_by (y de group_by si aplica).

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del archivo de interfaz contable

Request Body schema: application/json
required
label
required
string
column_type
required
string
Enum: "STRING" "FLOAT" "INTEGER"
field
string

Requerido salvo que is_fixed o is_function sean true (en esos casos se ignora y queda vacío).

length_field
integer

Requerido (mayor que 0) si el archivo es de formato FIXED_SIZE.

alignment
string
Enum: "L" "R"

Requerido, salvo en archivos EXCEL donde se autocompleta a L si se omite.

filling_character
string

Requerido si el archivo es de formato FIXED_SIZE.

is_fixed
boolean
default_value
string

Requerido si is_fixed es true.

is_mapping
boolean
object

Requerido (no vacío) si is_mapping es true.

is_function
boolean
func
string

Requerido si is_function es true.

notes
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "label": "string",
  • "column_type": "STRING",
  • "field": "string",
  • "length_field": 0,
  • "alignment": "L",
  • "filling_character": "string",
  • "is_fixed": true,
  • "default_value": "string",
  • "is_mapping": true,
  • "mapping": { },
  • "is_function": true,
  • "func": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "accounting_interface_file_id": 0,
    • "register_type": "HEADER",
    • "code": "string",
    • "label": "string",
    • "column_type": "string",
    • "field": "string",
    • "length_field": 0,
    • "alignment": "string",
    • "filling_character": "string",
    • "is_fixed": true,
    • "default_value": "string",
    • "is_mapping": true,
    • "mapping": { },
    • "is_function": true,
    • "func": "string",
    • "notes": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza una columna de un archivo de interfaz contable

Actualiza una columna existente del archivo (el código y el ID se preservan, no pueden cambiarse).

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del archivo de interfaz contable

column-code
required
string

Código de la columna

Request Body schema: application/json
required
label
required
string
column_type
required
string
Enum: "STRING" "FLOAT" "INTEGER"
field
string

Requerido salvo que is_fixed o is_function sean true (en esos casos se ignora y queda vacío).

length_field
integer

Requerido (mayor que 0) si el archivo es de formato FIXED_SIZE.

alignment
string
Enum: "L" "R"

Requerido, salvo en archivos EXCEL donde se autocompleta a L si se omite.

filling_character
string

Requerido si el archivo es de formato FIXED_SIZE.

is_fixed
boolean
default_value
string

Requerido si is_fixed es true.

is_mapping
boolean
object

Requerido (no vacío) si is_mapping es true.

is_function
boolean
func
string

Requerido si is_function es true.

notes
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "label": "string",
  • "column_type": "STRING",
  • "field": "string",
  • "length_field": 0,
  • "alignment": "L",
  • "filling_character": "string",
  • "is_fixed": true,
  • "default_value": "string",
  • "is_mapping": true,
  • "mapping": { },
  • "is_function": true,
  • "func": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "accounting_interface_file_id": 0,
    • "register_type": "HEADER",
    • "code": "string",
    • "label": "string",
    • "column_type": "string",
    • "field": "string",
    • "length_field": 0,
    • "alignment": "string",
    • "filling_character": "string",
    • "is_fixed": true,
    • "default_value": "string",
    • "is_mapping": true,
    • "mapping": { },
    • "is_function": true,
    • "func": "string",
    • "notes": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina una columna de un archivo de interfaz contable

Elimina una columna del archivo y la remueve de order_by y group_by (columnas y agregaciones).

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del archivo de interfaz contable

column-code
required
string

Código de la columna

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Configuración contable

Configuraciones de la interfaz contable.

Crea una configuración de interfaz contable

Crea una configuración de interfaz contable para la empresa autenticada (define como se genera/envia la información contable: por archivo o por API REST).

Authorizations:
bearerAuth
Request Body schema: application/json
required
description
required
string
country_id
integer
accounting_interface_file_id
required
integer
is_active
boolean
has_porcentual_allocation
boolean
code
required
string
output_type
required
string
Enum: "FILE" "API_REST"
object

Requerido solo si output_type es API_REST.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "description": "string",
  • "country_id": 0,
  • "accounting_interface_file_id": 0,
  • "is_active": true,
  • "has_porcentual_allocation": true,
  • "code": "string",
  • "output_type": "FILE",
  • "api_rest_config": {
    • "method": "string",
    • "endpoint": "string",
    • "content_type": "string",
    • "payload": "string",
    • "auth": {
      }
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "employer_id": 0,
    • "description": "string",
    • "country_id": 0,
    • "accounting_interface_file_id": 0,
    • "is_active": true,
    • "has_porcentual_allocation": true,
    • "code": "string",
    • "output_type": "FILE",
    • "api_rest_config": {
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Lista las configuraciones de interfaz contable

Lista las configuraciones de interfaz contable de la empresa autenticada.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Obtiene una configuración de interfaz contable

Obtiene el detalle de una configuración de interfaz contable por su ID, validando que pertenezca a la empresa autenticada.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Identificador de la configuración

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "employer_id": 0,
    • "description": "string",
    • "country_id": 0,
    • "accounting_interface_file_id": 0,
    • "is_active": true,
    • "has_porcentual_allocation": true,
    • "code": "string",
    • "output_type": "FILE",
    • "api_rest_config": {
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza una configuración de interfaz contable

Actualiza una configuración de interfaz contable existente.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Identificador de la configuración a actualizar

Request Body schema: application/json
required
description
required
string
country_id
integer
accounting_interface_file_id
required
integer
is_active
boolean
has_porcentual_allocation
boolean
code
required
string
output_type
required
string
Enum: "FILE" "API_REST"
object

Requerido solo si output_type es API_REST.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "description": "string",
  • "country_id": 0,
  • "accounting_interface_file_id": 0,
  • "is_active": true,
  • "has_porcentual_allocation": true,
  • "code": "string",
  • "output_type": "FILE",
  • "api_rest_config": {
    • "method": "string",
    • "endpoint": "string",
    • "content_type": "string",
    • "payload": "string",
    • "auth": {
      }
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "employer_id": 0,
    • "description": "string",
    • "country_id": 0,
    • "accounting_interface_file_id": 0,
    • "is_active": true,
    • "has_porcentual_allocation": true,
    • "code": "string",
    • "output_type": "FILE",
    • "api_rest_config": {
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Crea una configuración de detalle de interfaz contable

Crea una configuración de detalle de interfaz contable para un concepto de la empresa (mapeo contable y de dimensiones).

Authorizations:
bearerAuth
Request Body schema: application/json
required
accounting_interface_configuration_id
string <uuid>

Id de la configuración de interfaz contable

concept_id
integer

Id del concepto

object (AccountingInterfaceConfigurationDetailBody)
object

Mapa de dimensiones aplicadas

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "accounting_interface_configuration_id": "dd0334f3-6149-49dd-8b93-96c8c8983a28",
  • "concept_id": 0,
  • "detail": {
    • "accounting_details": [
      ],
    • "third_party_details": [
      ]
    },
  • "dimensions": {
    • "property1": "string",
    • "property2": "string"
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "employer_id": 0,
    • "accounting_interface_configuration_id": "dd0334f3-6149-49dd-8b93-96c8c8983a28",
    • "concept_id": 0,
    • "detail": {
      },
    • "dimensions": {
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza la configuración de detalle contable de un concepto

Actualiza la configuración de detalle de interfaz contable para un concepto especifico.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Id de la configuración de interfaz contable

concept-id
required
integer

Id del concepto

Request Body schema: application/json
required
object (AccountingInterfaceConfigurationDetailBody)
object

Mapa de dimensiones aplicadas

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "detail": {
    • "accounting_details": [
      ],
    • "third_party_details": [
      ]
    },
  • "dimensions": {
    • "property1": "string",
    • "property2": "string"
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "employer_id": 0,
    • "accounting_interface_configuration_id": "dd0334f3-6149-49dd-8b93-96c8c8983a28",
    • "concept_id": 0,
    • "detail": {
      },
    • "dimensions": {
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Obtiene el detalle contable de un concepto especifico

Obtiene el detalle de configuración contable de un concepto especifico dentro de una configuración de interfaz contable.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Id de la configuración de interfaz contable

concept-id
required
integer

Id del concepto

Responses

Response Schema: application/json
object (AccountingInterfaceConfigurationDetailWithConcept)

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "employer_id": 0,
    • "accounting_interface_configuration_id": "dd0334f3-6149-49dd-8b93-96c8c8983a28",
    • "concept_id": 0,
    • "detail": {
      },
    • "dimensions": {
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "concept_description": "string",
    • "concept_code": "string",
    • "concept_type_id": 0,
    • "concept_type_description": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina la configuración de detalle contable de un concepto

Elimina la configuración de detalle de interfaz contable de un concepto especifico.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Id de la configuración de interfaz contable

concept-id
required
integer

Id del concepto

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Lista los detalles contables de una configuración de interfaz contable

Obtiene todos los detalles de configuración contable asociados a una configuración de interfaz contable.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Id de la configuración de interfaz contable

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Lista los conceptos configurados de una configuración de interfaz contable

Lista los conceptos configurados (con su tipo) para una configuración de interfaz contable.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Id de la configuración de interfaz contable

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Nómina electrónica

Documentos de nómina electrónica ante la DIAN.

Habilita a la empresa en el proveedor de nómina electrónica

Registra/habilita la empresa (employer) en el proveedor de nómina electrónica (Alegra).

Authorizations:
bearerAuth

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "company_id": "string",
    • "is_enabled": true,
    • "sequence": 0,
    • "is_processing": true,
    • "access_key": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Envia un documento de prueba de nómina electrónica

Envia un documento de prueba de nómina electrónica al proveedor gubernamental.

Authorizations:
bearerAuth
query Parameters
government-id
required
string

Identificador del ambiente/gobierno destino de la prueba

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Prepara los documentos de nómina electrónica de un periodo

Prepara (genera) los documentos de nómina electrónica de los contratos de un periodo (ano/mes) para su posterior envio.

Authorizations:
bearerAuth
Request Body schema: application/json
required
year
required
integer

Ano del periodo

month
required
integer

Mes del periodo

contract_ids
Array of integers

Contratos a incluir (opcional)

exclude_contract_ids
Array of integers

Contratos a excluir (opcional)

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "year": 0,
  • "month": 0,
  • "contract_ids": [
    • 0
    ],
  • "exclude_contract_ids": [
    • 0
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Envia los documentos de nómina electrónica preparados

Envia al proveedor gubernamental los documentos de nómina electrónica previamente preparados.

Authorizations:
bearerAuth
Request Body schema: application/json
required
year
required
integer

Ano del periodo

month
required
integer

Mes del periodo

document_ids
Array of integers

Documentos especificos a procesar (opcional)

Responses

Response Schema: application/json
data
string

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "year": 0,
  • "month": 0,
  • "document_ids": [
    • 0
    ]
}

Response samples

Content type
application/json
{
  • "data": "string",
  • "messages": [
    • {
      }
    ]
}

Reenvia los documentos de nómina electrónica fallidos

Reenvia los documentos de nómina electrónica que quedaron en estado fallido.

Authorizations:
bearerAuth
Request Body schema: application/json
required
year
required
integer

Ano del periodo

month
required
integer

Mes del periodo

document_ids
Array of integers

Documentos especificos a procesar (opcional)

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "year": 0,
  • "month": 0,
  • "document_ids": [
    • 0
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Regenera los documentos rechazados por la DIAN

Regenera los documentos de nómina electrónica que fueron rechazados por la DIAN.

Authorizations:
bearerAuth
Request Body schema: application/json
required
year
required
integer

Ano del periodo

month
required
integer

Mes del periodo

contract_ids
Array of integers

Contratos a incluir (opcional)

exclude_contract_ids
Array of integers

Contratos a excluir (opcional)

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "year": 0,
  • "month": 0,
  • "contract_ids": [
    • 0
    ],
  • "exclude_contract_ids": [
    • 0
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Crea documentos de reemplazo de nómina electrónica

Crea documentos de reemplazo (nota de ajuste) para documentos de nómina electrónica ya emitidos.

Authorizations:
bearerAuth
Request Body schema: application/json
required
year
required
integer

Ano del periodo

month
required
integer

Mes del periodo

document_ids
Array of integers

Documentos especificos a procesar (opcional)

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "year": 0,
  • "month": 0,
  • "document_ids": [
    • 0
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Reversa documentos de reemplazo de nómina electrónica

Reversa (anula) documentos de reemplazo de nómina electrónica.

Authorizations:
bearerAuth
Request Body schema: application/json
required
year
required
integer

Ano del periodo

month
required
integer

Mes del periodo

document_ids
Array of integers

Documentos especificos a procesar (opcional)

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "year": 0,
  • "month": 0,
  • "document_ids": [
    • 0
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Prepara los documentos de reemplazo para su envio

Prepara los documentos de reemplazo generados previamente para su envio.

Authorizations:
bearerAuth
Request Body schema: application/json
required
year
required
integer

Ano del periodo

month
required
integer

Mes del periodo

contract_ids
Array of integers

Contratos a incluir (opcional)

exclude_contract_ids
Array of integers

Contratos a excluir (opcional)

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "year": 0,
  • "month": 0,
  • "contract_ids": [
    • 0
    ],
  • "exclude_contract_ids": [
    • 0
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Envia los documentos de reemplazo preparados

Envia al proveedor gubernamental los documentos de reemplazo preparados.

Authorizations:
bearerAuth
Request Body schema: application/json
required
year
required
integer

Ano del periodo

month
required
integer

Mes del periodo

document_ids
Array of integers

Documentos especificos a procesar (opcional)

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "year": 0,
  • "month": 0,
  • "document_ids": [
    • 0
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Lista los empleados con sus documentos de nómina electrónica

Lista paginada de empleados/contratos con sus documentos de nómina electrónica de un periodo, con filtros de busqueda, estado y orden.

Authorizations:
bearerAuth
query Parameters
year
required
integer

Ano del periodo

month
required
integer

Mes del periodo

limit
required
integer

Tamano de pagina

page
required
integer

Número de pagina

filter
string

Filtro de estado

search
string

Busqueda por nombre/identificación

sort
string

Campo de orden

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Obtiene los documentos de nómina electrónica de un contrato

Obtiene los documentos de nómina electrónica de un contrato (identificado por su hash) en un periodo dado.

Authorizations:
bearerAuth
path Parameters
hash
required
string

Hash del contrato

query Parameters
year
required
integer

Ano del periodo

month
required
integer

Mes del periodo

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Obtiene el resumen de nómina electrónica de un periodo

Devuelve el resumen (conteo de documentos agrupado por estado) de nómina electrónica de un periodo. Devuelve 204 sin contenido si no hay datos.

Authorizations:
bearerAuth
query Parameters
year
required
integer

Ano del periodo

month
required
integer

Mes del periodo

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "property1": 0,
    • "property2": 0
    },
  • "messages": [
    • {
      }
    ]
}

Obtiene el contenido XML de un documento de nómina electrónica

Obtiene el contenido XML del documento de nómina electrónica indicado.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del documento

Responses

Response Schema: application/json
data
string

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": "string",
  • "messages": [
    • {
      }
    ]
}

Actualiza las notas de un documento de nómina electrónica

Actualiza las notas de usuario asociadas a un documento de nómina electrónica.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id del documento

Request Body schema: application/json
required
notes
Array of strings

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "notes": [
    • "string"
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Descarga el reporte detallado de nómina electrónica

Descarga un reporte detallado (archivo) de la nómina electrónica de un periodo, opcionalmente filtrado por contratos.

Authorizations:
bearerAuth
query Parameters
year
required
integer

Ano del periodo

month
required
integer

Mes del periodo

contract_ids
string

Lista de ids de contrato separados por coma

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el listado de documentos de nómina electrónica

Descarga un listado (archivo) de los documentos de nómina electrónica de un periodo, opcionalmente filtrado por contratos.

Authorizations:
bearerAuth
query Parameters
year
required
integer

Ano del periodo

month
required
integer

Mes del periodo

contract_ids
string

Lista de ids de contrato separados por coma

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el reporte de configuración de nómina electrónica

Descarga un reporte (archivo) de la configuración de nómina electrónica de la empresa.

Authorizations:
bearerAuth

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Nómina electrónica - mapeo de conceptos

Equivalencias entre conceptos propios y conceptos DIAN.

Lista el mapeo de conceptos de nómina electrónica

Lista el mapeo de conceptos de nómina electrónica (etiqueta Alegra/NIE) configurado para el empleador.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Crea el mapeo de nómina electrónica de un concepto

Crea el mapeo de nómina electrónica (etiqueta Alegra) para un concepto del empleador.

Authorizations:
bearerAuth
Request Body schema: application/json
required
concept_id
integer
tag
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "concept_id": 0,
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "concept_id": 0,
    • "mapping": {
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "code": "string",
    • "description": "string",
    • "tag": "string",
    • "nie": "string",
    • "concept_type_id": 0,
    • "concept_type_description": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Obtiene el mapeo de nómina electrónica de un concepto

Obtiene el mapeo de nómina electrónica de un concepto especifico del empleador.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del concepto

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "concept_id": 0,
    • "mapping": {
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "code": "string",
    • "description": "string",
    • "tag": "string",
    • "nie": "string",
    • "concept_type_id": 0,
    • "concept_type_description": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza el mapeo de nómina electrónica de un concepto

Actualiza la etiqueta (tag) de mapeo de nómina electrónica para un concepto del empleador.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del concepto

Request Body schema: application/json
required
tag
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "concept_id": 0,
    • "mapping": {
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "code": "string",
    • "description": "string",
    • "tag": "string",
    • "nie": "string",
    • "concept_type_id": 0,
    • "concept_type_description": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina el mapeo de nómina electrónica de un concepto

Elimina el mapeo de nómina electrónica de un concepto del empleador.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID del concepto

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Formulario 220 (DIAN)

Certificado de ingresos y retenciones (formulario 220).

Popula los datos base del formulario 220 para un año

Popula (genera/precalcula) los datos base del formulario 220 de la DIAN para el empleador y año indicados, a partir del histórico de nómina.

Authorizations:
bearerAuth
path Parameters
year
required
integer

Año fiscal a poblar

Responses

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Genera el certificado del formulario 220

Genera el certificado/reporte del formulario 220 (uno o varios contratos) en el formato solicitado (PDF, Excel u HTML) y lo entrega como archivo o HTML embebido.

Authorizations:
bearerAuth
Request Body schema: application/json
required
employer_id
required
integer

Se sobrescribe con el id del empleador del JWT.

year
required
integer >= 2022

Año fiscal del formulario.

contract_ids
Array of integers

Ids de los contratos a incluir en el reporte.

format_file
required
string
Enum: "pdf" "xlsx" "xls" "html"

Formato del archivo a generar.

kind
string
Enum: "zip" "one_file"

Modo de empaquetado cuando hay varios contratos.

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema:
string <binary>

Request samples

Content type
application/json
{
  • "employer_id": 0,
  • "year": 2022,
  • "contract_ids": [
    • 0
    ],
  • "format_file": "pdf",
  • "kind": "zip"
}

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Lista los empleados/contratos para el formulario 220 de un año

Lista paginada de empleados/contratos del empleador con la información necesaria para elaborar el formulario 220 de un año, con busqueda y orden.

Authorizations:
bearerAuth
query Parameters
year
required
integer

Año fiscal

limit
integer

Tamaño de pagina (default 20)

page
integer

Número de pagina (default 1)

search
string

Texto de busqueda

sort
string

Campo de orden

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Resumen del formulario 220 de un año

Devuelve el número de empleados/contratos incluidos en el formulario 220 del empleador para el año indicado.

Authorizations:
bearerAuth
path Parameters
year
required
integer

Año fiscal

Responses

Response Schema: application/json
data
integer

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": 0,
  • "messages": [
    • {
      }
    ]
}

Descarga el reporte de detalle del formulario 220

Genera y descarga un reporte Excel con el detalle de los valores del formulario 220 del empleador para el año indicado.

Authorizations:
bearerAuth
path Parameters
year
required
integer

Año fiscal

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el archivo de medios magneticos formato 1101

Genera y descarga el archivo de medios magneticos formato 1101 (información laboral) exigido por la DIAN, para el año indicado.

Authorizations:
bearerAuth
path Parameters
year
required
integer

Año fiscal

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Descarga el archivo de medios magneticos formato 1003

Genera y descarga el archivo de medios magneticos formato 1003 (pagos y retenciones a terceros) exigido por la DIAN, para el año indicado.

Authorizations:
bearerAuth
path Parameters
year
required
integer

Año fiscal

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Envia por correo el certificado del formulario 220

Envia por correo electrónico a los empleados el certificado del formulario 220 correspondiente al año, según el tipo de envio (todos, pendientes o seleccion de contratos). Requiere que el periodo/año este cerrado para el empleador.

Authorizations:
bearerAuth
path Parameters
year
required
integer

Año fiscal (se copia también al body)

Request Body schema: application/json
required
employer_id
required
integer

Se sobrescribe con el id del empleador del JWT.

contract_ids
Array of integers

Requerido si send_type es SELECTION.

year
required
integer

Se sobrescribe con el año del path.

send_type
required
string
Enum: "ALL" "PENDING" "SELECTION"

Tipo de envio del certificado por correo.

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "employer_id": 0,
  • "contract_ids": [
    • 0
    ],
  • "year": 0,
  • "send_type": "ALL"
}

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Formulario 220 (DIAN) - configuración

Configuración anual del formulario 220.

Crea la configuración del formulario DIAN 220

Crea la configuración del formulario DIAN 220 para el año vigente de la empresa autenticada (a partir de plantillas/valores por defecto).

Authorizations:
bearerAuth

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "year": 0,
    • "setting": {
      },
    • "is_closed": true,
    • "status_template": "string",
    • "group_by": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Edita la configuración del formulario DIAN 220

Edita la configuración del formulario DIAN 220 de un año especifico para la empresa autenticada.

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
integer
year
required
integer >= 2022
object
is_closed
boolean
status_template
string
group_by
string
created_at
string <date-time>
updated_at
string <date-time>

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "id": 0,
  • "year": 2022,
  • "setting": {
    • "property1": null,
    • "property2": null
    },
  • "is_closed": true,
  • "status_template": "string",
  • "group_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "year": 0,
    • "setting": {
      },
    • "is_closed": true,
    • "status_template": "string",
    • "group_by": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Lista las configuraciones del formulario DIAN 220

Lista todas las configuraciones del formulario DIAN 220 (todos los años) de la empresa autenticada.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Cierra la configuración del formulario DIAN 220 de un año

Cierra (bloquea edicion) la configuración del formulario DIAN 220 de un año para la empresa autenticada.

Authorizations:
bearerAuth
path Parameters
year
required
integer

Año a cerrar

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Obtiene la configuración del formulario DIAN 220 de un año

Obtiene la configuración del formulario DIAN 220 de la empresa autenticada para un año especifico.

Authorizations:
bearerAuth
path Parameters
year
required
integer

Año a consultar

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "year": 0,
    • "setting": {
      },
    • "is_closed": true,
    • "status_template": "string",
    • "group_by": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Descarga el reporte de la configuración del formulario DIAN 220

Descarga el reporte (archivo) de la configuración del formulario DIAN 220 de un año.

Authorizations:
bearerAuth
path Parameters
year
required
integer

Año del reporte

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

PILA

Planilla integrada de liquidación de aportes.

Genera la planilla PILA

Genera la planilla PILA (aportes a seguridad social) del empleador para un año, mes y tipo de planilla dados.

Authorizations:
bearerAuth
Request Body schema: application/json
required
year
required
integer

Debe ser mayor a 2021

month
required
integer

Mes entre 1 y 12

pila_type
required
string
Enum: "E" "K"
format
string
Enum: "pdf" "xls" "xlsx" "zip" "txt" "csv" "html"

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "year": 0,
  • "month": 0,
  • "pila_type": "E",
  • "format": "pdf"
}

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Descarga el archivo de la planilla PILA

Descarga el archivo/reporte de la planilla PILA generada para un año, mes, formato y tipo dados.

Authorizations:
bearerAuth
query Parameters
year
required
integer

Año de la planilla

month
required
integer

Mes de la planilla

format
string

Formato del archivo ("pdf","xlsx","txt", etc.)

type
string
Enum: "E" "K"

Tipo de PILA

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Obtiene el resumen de la planilla PILA

Obtiene el resumen de la planilla PILA (totales por tipo de entidad: EPS, AFP, ARL, etc.) de un año y mes. Responde 204 si no existe.

Authorizations:
bearerAuth
query Parameters
year
required
integer

Año de la planilla

month
required
integer

Mes de la planilla

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Descarga el reporte del resumen de la planilla PILA

Descarga el reporte (archivo) del resumen de la planilla PILA de un año y mes.

Authorizations:
bearerAuth
query Parameters
year
required
integer

Año de la planilla

month
required
integer

Mes de la planilla

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Notas del empleador

Notas internas de la empresa.

Crea una nota del empleador

Crea una nota del empleador (nota asociada al mes del empleador, por ejemplo una observacion interna).

Authorizations:
bearerAuth
Request Body schema: application/json
required
employer_month_id
required
integer
title
required
string
description
required
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "employer_month_id": 0,
  • "title": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "employer_month_id": 0,
    • "user_id": 0,
    • "title": "string",
    • "description": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "picture": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza una nota del empleador

Actualiza una nota del empleador existente.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID de la nota

Request Body schema: application/json
required
employer_month_id
required
integer
title
required
string
description
required
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "employer_month_id": 0,
  • "title": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "employer_id": 0,
    • "employer_month_id": 0,
    • "user_id": 0,
    • "title": "string",
    • "description": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "picture": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Elimina una nota del empleador

Elimina una nota del empleador.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID de la nota

Responses

Response Schema: application/json
data
any

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": null,
  • "messages": [
    • {
      }
    ]
}

Carga masiva de archivos

Cargue masivo de información mediante archivos.

Procesa un archivo masivo para crear novedades en lote

Procesa un archivo masivo (Excel en base64) para crear en lote vacaciones, licencias, ausencias o novedades ocasionales, según la configuración indicada. Aunque la respuesta sea 200, revisa status_name y error_descriptions en los datos devueltos: el archivo puede terminar en estado FAIL con el detalle de errores por fila.

Authorizations:
bearerAuth
Request Body schema: application/json
required
config_id
required
string <uuid>
file
required
string

Archivo en base64, formato data:mime/type;base64,... o solo base64.

country_code
string
file_name
required
string
period_id
integer

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "config_id": "d1d31429-d888-4f1c-b9c1-4e842f9bce5b",
  • "file": "string",
  • "country_code": "string",
  • "file_name": "string",
  • "period_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "employer_id": 0,
    • "massive_upload_config_id": "78ac7084-77c5-410c-aa1d-addaf33942b2",
    • "file_name": "string",
    • "file_url": "string",
    • "user_uploader": 0,
    • "status_name": "string",
    • "total_records": 0,
    • "processed_records": 0,
    • "failed_records": 0,
    • "error_descriptions": {
      },
    • "processing_time_ms": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actividades económicas y riesgo

Búsqueda de actividades económicas y su nivel de riesgo.

Busca actividades económicas CIIU con nivel y tarifa de riesgo

Busca actividades económicas (CIIU) con su nivel y tarifa de riesgo asociados, con filtro de texto libre, orden y paginacion.

Authorizations:
bearerAuth
query Parameters
search
string

Texto a buscar por coincidencia parcial en descripción, código CIIU o código

sort
string

Campo por el cual ordenar (por defecto: description)

sort_direction
string
Enum: "ASC" "DESC"

Direccion de orden: ASC o DESC (por defecto ASC)

page
integer

Número de pagina (por defecto 1)

limit
integer

Tamano de pagina (por defecto 20)

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Self-service - autenticación

Ingreso del empleado al portal de self-service y recuperación de contraseña.

Login del empleado en el portal self-service

Inicia sesión del empleado en el portal self-service usando su tipo y número de identificación junto con su contraseña. Devuelve un token de sesión y los datos del empleado y su empresa. Endpoint público, no requiere autenticación.

Request Body schema: application/json
required
identification_type_id
required
integer

ID del tipo de identificación del empleado

identification_number
required
string

Número de identificación del empleado

password
required
string

Si el empleado aún no tiene contraseña configurada, primero debe usar forgot-password.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "identification_type_id": 0,
  • "identification_number": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "employee_relation": {
      },
    • "employer": {
      },
    • "token": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Inicia el flujo de recuperacion de contraseña del empleado

Envía un código de verificación al correo registrado del empleado para iniciar el flujo de recuperación de contraseña. Endpoint público, no requiere autenticación.

Request Body schema: application/json
required
identification_type_id
required
integer
identification_number
required
string

Responses

Response Schema: application/json
data
string

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "identification_type_id": 0,
  • "identification_number": "string"
}

Response samples

Content type
application/json
{
  • "data": "Hemos enviado a tu correo el codigo de verificacion",
  • "messages": [
    • {
      }
    ]
}

Cambia la contraseña del empleado usando el código recibido por correo

Valida el código recibido por correo y actualiza la contraseña del empleado. Parte final del flujo de recuperación de contraseña. Endpoint público, no requiere autenticación.

Request Body schema: application/json
required
identification_type_id
required
integer
identification_number
required
string
otp
required
string

Código recibido por correo desde forgot-password.

password
required
string

Mínimo 8 caracteres, con mayúscula, minúscula, número y carácter especial.

Responses

Response Schema: application/json
data
string

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "identification_type_id": 0,
  • "identification_number": "string",
  • "otp": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "data": "Tu contrasena ha sido actualizada, ahora puedes iniciar sesion",
  • "messages": [
    • {
      }
    ]
}

Obtiene los datos de login/perfil del empleado autenticado

Devuelve empleado + empresa del usuario autenticado, usados por el portal tras iniciar sesión o refrescar el token. Requiere el token de self-service obtenido en POST /api/v1/self-service/public/login.

Authorizations:
selfServiceAuth

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": {
    • "employee_relation": {
      },
    • "employer": {
      },
    • "token": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Self-service - empleado

Consulta y actualización de los datos propios del empleado.

Genera el certificado laboral en PDF del empleado autenticado

Genera el certificado laboral en PDF del empleado autenticado para la empresa indicada. Requiere el token de self-service obtenido en POST /api/v1/self-service/public/login.

Authorizations:
selfServiceAuth
path Parameters
employerID
required
integer

ID de la empresa

query Parameters
templateName
required
string

Nombre de la plantilla a usar para el certificado

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/pdf
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Lista los cumpleanos de companeros de la empresa para el mes indicado

Vista self-service de cumpleanos de companeros de la empresa. Requiere el token de self-service obtenido en POST /api/v1/self-service/public/login.

Authorizations:
selfServiceAuth
path Parameters
month
required
integer

Número de mes (1-12)

query Parameters
employer-id
required
integer

ID de la empresa

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Lista los aniversarios laborales de companeros de la empresa para el mes indicado

Vista self-service de aniversarios laborales de companeros de la empresa. Requiere el token de self-service obtenido en POST /api/v1/self-service/public/login.

Authorizations:
selfServiceAuth
path Parameters
month
required
integer

Número de mes (1-12)

query Parameters
employer-id
required
integer

ID de la empresa

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Actualiza la información básica de perfil del empleado autenticado

El empleado actualiza su propia información básica de perfil (datos personales, direccion, contacto). El ID se sobreescribe con el del token, ignorando el enviado. Requiere el token de self-service obtenido en POST /api/v1/self-service/public/login.

Authorizations:
selfServiceAuth
Request Body schema: application/json
required
first_name
string
middle_name
string
last_name
string
surname
string
email
string
address
string
phone
string
mobile
string
gender
string
birthdate
string <date-time>
birthplace
string
marital_status
string
picture
string
thumbnail
string

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "surname": "string",
  • "email": "string",
  • "address": "string",
  • "phone": "string",
  • "mobile": "string",
  • "gender": "string",
  • "birthdate": "2019-08-24T14:15:22Z",
  • "birthplace": "string",
  • "marital_status": "string",
  • "picture": "string",
  • "thumbnail": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "identification_type_id": 0,
    • "identification_number": "string",
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "surname": "string",
    • "email": "string",
    • "address": "string",
    • "phone": "string",
    • "mobile": "string",
    • "gender": { },
    • "birthdate": "2019-08-24T14:15:22Z",
    • "birthplace": "string",
    • "marital_status": { },
    • "picture": "string",
    • "thumbnail": "string",
    • "hash": "string",
    • "social_networks": {
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    },
  • "messages": [
    • {
      }
    ]
}

Actualiza las redes sociales del empleado autenticado

El empleado actualiza sus redes sociales (facebook, twitter, instagram, linkedin). Solo se usa el campo social_networks; el ID se toma del token. Requiere el token de self-service obtenido en POST /api/v1/self-service/public/login.

Authorizations:
selfServiceAuth
Request Body schema: application/json
required
object (SelfServiceSocialNetworks)

Redes sociales del empleado.

Responses

Response Schema: application/json
object

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
{
  • "social_networks": {
    • "facebook": "string",
    • "twitter": "string",
    • "instagram": "string",
    • "linked_in": "string"
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "facebook": "string",
    • "twitter": "string",
    • "instagram": "string",
    • "linked_in": "string"
    },
  • "messages": [
    • {
      }
    ]
}

Sube imagenes asociadas al empleado autenticado

Sube una o varias imagenes (en base64) asociadas al empleado, por ejemplo su foto de perfil, para la empresa indicada. Requiere el token de self-service obtenido en POST /api/v1/self-service/public/login.

Authorizations:
selfServiceAuth
path Parameters
employerID
required
integer

ID de la empresa (0 permitido para avatares/logos sin empresa)

Request Body schema: application/json
required
Array
id
string

Identificador de la imagen

file
string

Contenido de la imagen en base64

folder
string

Carpeta destino de la imagen

is_public
boolean
is_original
boolean
width
integer

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Request samples

Content type
application/json
[
  • {
    • "id": "string",
    • "file": "string",
    • "folder": "string",
    • "is_public": true,
    • "is_original": true,
    • "width": 0
    }
]

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Self-service - documentos

Descarga de comprobantes, certificados y reportes propios del empleado.

Lista los procesos de nómina disponibles para un contrato del empleado

Lista los procesos de nómina (comprobantes de pago) disponibles para un contrato del empleado autenticado. Requiere el token de self-service obtenido en POST /api/v1/self-service/public/login.

Authorizations:
selfServiceAuth
query Parameters
contract-id
required
integer

ID del contrato del empleado

Responses

Response Schema: application/json
Array of objects

Contenido de la respuesta. Su forma depende del endpoint.

Array of objects (Message)

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "messages": [
    • {
      }
    ]
}

Genera y descarga el comprobante de pago del empleado

Genera y descarga el comprobante de pago (payslip) en PDF del empleado para un contrato y proceso especificos. Requiere el token de self-service obtenido en POST /api/v1/self-service/public/login.

Authorizations:
selfServiceAuth
query Parameters
contract-id
required
integer

ID del contrato del empleado

process-hash
required
string

Hash del proceso de nómina

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/pdf
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Genera y descarga el certificado de ingresos y retenciones del empleado

Genera y descarga el certificado de ingresos y retenciones (Formulario DIAN 220) del empleado en PDF para un ano gravable y contrato especificos. Requiere el token de self-service obtenido en POST /api/v1/self-service/public/login.

Authorizations:
selfServiceAuth
query Parameters
contract-id
required
integer

ID del contrato del empleado

year
required
integer

Ano gravable

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/pdf
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Genera y descarga el reporte del balance de vacaciones del empleado

Genera y descarga el reporte del balance de vacaciones de un contrato específico del empleado que inició sesión, a una fecha de corte dada. Requiere el token de self-service obtenido en POST /api/v1/self-service/public/login.

Authorizations:
selfServiceAuth
Request Body schema: application/json
required
contract_id
required
integer

ID del contrato del empleado

cutoff_date
required
string <date-time>

Fecha de corte del reporte ("2006-01-02" o RFC3339)

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/pdf
string <binary>

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "cutoff_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Genera y descarga el anexo de retención en la fuente del empleado

Genera y descarga el anexo/certificado de retención en la fuente del empleado para un contrato y proceso especificos. Requiere el token de self-service obtenido en POST /api/v1/self-service/public/login.

Authorizations:
selfServiceAuth
query Parameters
contract-id
required
integer

ID del contrato del empleado

process-hash
required
string

Hash del proceso de nómina

Responses

Response Headers
Content-Disposition
string

Nombre sugerido del archivo

X-File-Name
string

Nombre del archivo generado

Response Schema: application/pdf
string <binary>

Response samples

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}