API docs by Redocly

Softland Api Gateway (v2)

Download OpenAPI specification:Download

URL: https://gruposoftland.com

Documentación de Api Expuestos (Plugins) por Grupo Softland

Version

ApiGateway Info

Obtiene Versión de ApiGateway

Version ApiGateway

Authorizations:
ApiKey

Responses

AccionesPersonal

Controller para Acciones de Personal. Cuenta con un EndPoint que permite realizar el registro de nuevas acciones de personal, incluyendo todos los atributos del empleado que son modificables por medio de una acción.

Crear acciones de personal: Crea una nueva acción de personal para un empleado en estado “No Aprobada”. El número de acción de personal se genera automaticamente y se retonará en el JSON de respuesta.

Crear acciones de personal: Crea una nueva acción de personal para un empleado en estado “No Aprobada”. El número de acción de personal se genera automaticamente y se retonará en el JSON de respuesta.

Authorizations:
ApiKey
Request Body schema:
Array of objects or null (AccionPersonal)
outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Request samples

Content type
{
  • "coleccion": [
    ],
  • "outputFormat": 0
}

Response samples

Content type
No sample

Empleados

Controller para Empleados. Cuenta con un conjunto de EndPoints que permitirán crear, modificar y consultar empleados.

Obtener Empleados: Permite obtener los empleados de una compañía con la totalidad de campos con los que cuenta la tabla EMPLEADO.

Obtener Empleados: Permite obtener los empleados de una compañía con la totalidad de campos con los que cuenta la tabla EMPLEADO.

Authorizations:
ApiKey
query Parameters
Compania
string

Compañía en la cual se procesará el registro (Long.Max = 10). Requerido.

Atributos
string

Permite personalizar los atributos que se desean obtener, se debe utilizarla unicamente columnas que existan en la tabla EMPLEADO, caso contrario generará error. (Long.Max = 4000). Opcional.

Filtro
string

Permite enviar un filtro en formato SQL para que el método lo ejecute al momento de obtener los datos respectivos, se debe utilizarla unicamente columnas que existan en la tabla EMPLEADO, caso contrario generará error (Long.Max = 1500). Opcional.

outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Response samples

Content type
No sample

Crear empleados: Permite crear un Empleado, toma en cuenta los parámetros del módulo de Gestión de Nómia para validar si se debe generar de forma automáticas la acción de contratación del empleado.

Crear empleados: Permite crear un Empleado, toma en cuenta los parámetros del módulo de Gestión de Nómia para validar si se debe generar de forma automáticas la acción de contratación del empleado.

Authorizations:
ApiKey
Request Body schema:
Array of objects or null (Empleado)
outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Request samples

Content type
{
  • "coleccion": [
    ],
  • "outputFormat": 0
}

Response samples

Content type
No sample

Actualizar empleados: Permite actualizar empleados, se debe tomar en cuenta que se pueden modificar unicamente aquellas propiedades que se pueden modificar directamente en el mantenimiento de empleados, aquellas que solo se pueden modificar por medio de acciones de personal no pueden ser gestionadas por este EndPoint.

Actualizar empleados: Permite actualizar empleados, se debe tomar en cuenta que se pueden modificar unicamente aquellas propiedades que se pueden modificar directamente en el mantenimiento de empleados, aquellas que solo se pueden modificar por medio de acciones de personal no pueden ser gestionadas por este EndPoint.

Authorizations:
ApiKey
Request Body schema:
Array of objects or null (EmpleadoActualizar)
outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Request samples

Content type
{
  • "coleccion": [
    ],
  • "outputFormat": 0
}

Response samples

Content type
No sample

Nomina

Controller para Nóminas. Maneja un conjunto de EndPoints que permite cargar conceptos a una nómina que se encuentre en proceso y consultar conceptos calculados en una nómina. Además, permite generar el asiento, transferencia y comprobantes de pago de una nómina directamente a un formato JSON, es decir, estos no serán generados ni consultados en tablas del ERP, sino que el mismo EndPoint se debe encargar procesar la información de la nómina y exponer los datos.

Cargar conceptos: Permite cargar datos a una nómina en proceso.

Cargar conceptos: Permite cargar datos a una nómina en proceso.

Authorizations:
ApiKey
Request Body schema:
Array of objects or null (ConceptoNomina)
outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Request samples

Content type
{
  • "coleccion": [
    ],
  • "outputFormat": 0
}

Response samples

Content type
No sample

Generar asiento: Permite generar un asiento de nómina previamente aplicada en formato JSON.

Generar asiento: Permite generar un asiento de nómina previamente aplicada en formato JSON.

Authorizations:
ApiKey
query Parameters
Nomina
string

Clase de nómina a la cual se le generará el asiento (Long.Max = 4). Requerido.

NumeroNomina
integer <int32>

Consecutivo de nómina a la cual se le generará el asiento. Requerido.

Contabilidad
string

Indica la contabilidad para la generación del asiento. Posibles valores: F (Fiscal) C (Corporativo) A (Ambas). El valor por defecto es F. En caso de indicar A se generarán dos asientos (Long.Max = 1). Opcional.

Compania
string

Compañía en la cual se procesará el registro (Long.Max = 10). Requerido.

outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Response samples

Content type
No sample

Consulta conceptos: Permite obtener los conceptos de nóminas en proceso e históricas.

Consulta conceptos: Permite obtener los conceptos de nóminas en proceso e históricas.

Authorizations:
ApiKey
query Parameters
Compania
string

Compañía en la cual se procesará el registro (Long.Max = 10). Requerido.

Atributos
string

Permite personalizar los atributos que se desean obtener (Long.Max = 4000). Se puede utilizar columnas de las tabla EMPLEADO_CONC_NOMI y NOMINA_HISTORICO usando los alias ECN y NH respectivamente. Opcional.

Filtro
string

Permite enviar un filtro en formato SQL para que el método lo ejecute al momento de obtener los datos respectivos (Long.Max = 1500). Se puede utilizar columnas de las tabla EMPLEADO_CONC_NOMI y NOMINA_HISTORICO usando los alias ECN y NH respectivamente. Opcional.

Nomina
string

Clase de nómina que se desea consultar (Long.Max = 4). Opcional.

NumeroNomina
integer <int32>

Número de nómina a consultar. Opcional.

Concepto
string

Código del concepto a consultar (Long.Max = 20) . Opcional

Empleado
string

Código del empleado a consultar (Long.Max = 20). Opcional

FechaInicio
string <date-time>

Fecha de inicio de la nómina. Opcional.

FechaFin
string <date-time>

Fecha fin de la nómina. Opcional

Periodo
string <date-time>

Periodo de la nómina. Opcional.

outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Response samples

Content type
No sample

Generar transferencia: Permite obtener los datos de las transferencias de las nóminas.

Generar transferencia: Permite obtener los datos de las transferencias de las nóminas.

Authorizations:
ApiKey
query Parameters
Compania
string

Compañía en la cual se procesará el registro (Long.Max = 10). Requerido.

Atributos
string

Permite personalizar los atributos que se desean obtener (Long.Max = 4000). Se puede utilizar columnas de las tablas EMPLEADO, EMPLEADO_NOMI_NETO y NOMINA con los alias E, ENN y N respectivamente. Opcional.

Filtro
string

Permite enviar un filtro en formato SQL para que el método lo ejecute al momento de obtener los datos respectivos (Long.Max = 1500). Se puede utilizar columnas de las tablas EMPLEADO, EMPLEADO_NOMI_NETO y NOMINA con los alias E, ENN y N respectivamente. Opcional.

Nomina
string

Clase de nómina que se desea consultar (Long.Max = 4) . Opcional.

NumeroNomina
integer <int32>

Número de nómina a consultar . Opcional.

outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Response samples

Content type
No sample

Generar comprobantes de pago: Permite generar los comprobantes de pago para una nómina en formato JSON, PDF o DOCX

Generar comprobantes de pago: Permite generar los comprobantes de pago para una nómina en formato JSON, PDF o DOCX

Authorizations:
ApiKey
query Parameters
Nomina
string

Clase de nómina para la generación de los comprobantes (Long.Max = 4). Requerido.

NumeroNomina
integer <int32>

Consecutivo de nómina. Requerido.

Filtro
string

Filtro para la generación de reportes. En formato SQL, se puede utilizar la tabla empleado sin alias, es decir se debe colocar por ejemplo EMPLEADO.EMPLEADO, EMPLEADO.CENTRO_COSTO, etc (Long.Max = 2000). Opcional.

TipoArchivo
string

Indica el formato en el que se generará el comprobante de pago. Posibles Valores: DC: DOC Columnar (Word) DS: DOC Secuencial (Word) PC: PDF Columnar PS: PDF Secuencial J: JSON En el caso de ser en PDF o Word se utilizará la misma forma de envió que se utiliza actualmente en SCH que es un base64 (Long.Max = 2). Reqeurido.

Formato
string

Es requerido únicamente si se va a utilizar la generación a Word o PDF. Si no se especifica se utilizarán los formatos estándar del sistema (Long.Max = 100). Requerido.

IncluirCentrosCosto
string

Indica si se incluyen los centros del costo en el detalle del comprobante de pago. Posibles Valores: S: Si N:No (Long.Max = 1). Requerido.

IncluirTotalesCero
string

Indica si se incluyen conceptos con el total en cero. Posibles Valores: S: Si N:No (Long.Max = 1). Requerido.

IncluirNotasNomina
string

Indica si se las notas de la nómina en el comprobante de pago. Posibles Valores: S: Si N:No (Long.Max = 1). Requerido.

Compania
string

Compañía en la cual se procesará el registro (Long.Max = 10). Requerido.

outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Response samples

Content type
No sample

Liquidacion

Controller para Liquidaciones de Empleados.Provee EndPoints para obtener y cargar registros de conceptos de liquidaciones, generar asientos y transferencias de liquidaciones.

Consultar Conceptos - Detalle: Permite obtener los detalles de los conceptos de liquidaciones.

Consultar Conceptos - Detalle: Permite obtener los detalles de los conceptos de liquidaciones.

Authorizations:
ApiKey
query Parameters
Compania
string

Compañía en la cual se procesará el registro (Long.Max = 10). Requerido.

Atributos
string

Permite personalizar los atributos que se desean obtener (Long.Max = 4000).Se puede utilizar columnas de las tablas LIQUIDACION_CONCEP y LIQUIDACION, con alias LC y L respectivamente. Opcional.

Filtro
string

Permite enviar un filtro en formato SQL para que el método lo ejecute al momento de obtener los datos respectivos (Long.Max = 1500). Se puede utilizar columnas de las tablas LIQUIDACION_CONCEP y LIQUIDACION, con alias LC y L respectivamente. Opcional.

Liquidacion
integer <int32>

Número de liquidación a consultar. Opcional.

Concepto
string

Código del concepto a consultar (Long.Max = 20). Opcional.

Empleado
string

Código del empleado a consultar (Long.Max = 20). Opcional.

outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Response samples

Content type
No sample

Consultar Conceptos - Aportes: Permite obtener los detalles de los aportes de las liquidaciones.

Consultar Conceptos - Aportes: Permite obtener los detalles de los aportes de las liquidaciones.

Authorizations:
ApiKey
query Parameters
Compania
string

Compañía en la cual se procesará el registro (Long.Max = 10). Requerido.

Atributos
string

Permite personalizar los atributos que se desean obtener (Long.Max = 4000). Se puede utilizar columnas de las tablas LIQUIDACION_APORTE y LIQUIDACION, con alias LA y L respectivamente. Opcional.

Filtro
string

Permite enviar un filtro en formato SQL para que el método lo ejecute al momento de obtener los datos respectivos (Long.Max = 1500). Se puede utilizar columnas de las tablas LIQUIDACION_APORTE y LIQUIDACION, con alias LA y L respectivamente. Opcional.

Liquidacion
integer <int32>

Número de Liquidación a consultar. Opcional

Concepto
string

Código del concepto a consultar (Long.Max = 20) . Opcional.

Empleado
string

Código del empleado a Consultar (Long.Max = 20). Opcional

outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Response samples

Content type
No sample

Generar transferencias: Permite generar la información de las transferencias de las liquidaciones.

Generar transferencias: Permite generar la información de las transferencias de las liquidaciones.

Authorizations:
ApiKey
query Parameters
Compania
string

Compañía en la cual se procesará el registro (Long.Max = 10). Requerido.

Atributos
string

Permite personalizar los atributos que se desean obtener (Long.Max = 4000). Se puede utilizar columnas de la tabla LIQUIDACION con el alias L. Opcional.

Filtro
string

Permite enviar un filtro en formato SQL para que el método lo ejecute al momento de obtener los datos respectivos (Long.Max = 1500). Se puede utilizar columnas de la tabla LIQUIDACION con el alias L. Opcional.

Liquidacion
integer <int32>

Número de liquidación al cual se le generará la transferencia. Opcional.

Empleado
string

Empleado al que pertenece la liquidación (Long.Max = 20). Opcional

outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Response samples

Content type
No sample

Cargar Conceptos - Detalle: Permite cargar datos en el detalle de una liquidación en proceso.

Cargar Conceptos - Detalle: Permite cargar datos en el detalle de una liquidación en proceso.

Authorizations:
ApiKey
Request Body schema:
Array of objects or null (ConceptoLiquidacion)
outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Request samples

Content type
{
  • "coleccion": [
    ],
  • "outputFormat": 0
}

Response samples

Content type
No sample

Cargar Conceptos - Aportes: Permite cargar datos en el detalle de aportes de una liquidación en proceso.

Cargar Conceptos - Aportes: Permite cargar datos en el detalle de aportes de una liquidación en proceso.

Authorizations:
ApiKey
Request Body schema:
Array of objects or null (AporteLiquidacion)
outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Request samples

Content type
{
  • "coleccion": [
    ],
  • "outputFormat": 0
}

Response samples

Content type
No sample

Generar Asiento: Permite generar el asiento de liquidación previamente aplicada

Generar Asiento: Permite generar el asiento de liquidación previamente aplicada

Authorizations:
ApiKey
query Parameters
Liquidacion
integer <int32>

Liquidación a la cual se le generará el asiento. Requerido.

Contabilidad
string

Indica la contabilidad para la generación del asiento. Posibles valores: F (Fiscal) C (Corporativo) A (Ambas). El valor por defecto es F. En caso de indicar A se generarán dos asientos (Long.Max = 1). Opcional.

Compania
string

Compañía en la cual se procesará el registro (Long.Max = 10). Requerido.

outputFormat
integer <int32> (OutputFormat)
Enum: 0 1

Formato de salida, 0 = Json, 1 = Xml

Responses

Response samples

Content type
No sample