VIPS 3.0

Documentación API REST

Consideraciones iniciales

Esta es una documentación general de API REST. Existen personalizaciones que no se encuentran en esta documentación. Contactar con soporte en caso de cualquier duda o incidencia.

Es necesario dos parámetros para las credenciales.

  • ID: El identificador de cliente, por ejemplo: A12345.
  • TOKEN: El token de seguridad del usuario, por ejemplo: VhP2uXMLxgXp
  • Los resultados están limitados a 100 resultados por defecto, puede usar el parámetro LIMIT.

Ejemplos:

  • Obtener los primeros 5 registros:
    https://api.vipsweb.online/v2/employee?ID=A12345&TOKEN=123456&Limit=5
  • Obtener los siguientes 5 registros:
    https://api.vipsweb.online/v2/employee?ID=12345&TOKEN=123456&Limit=5&User_ID=5

Descripción de entidades

1. Empleados

Datos del modelo

«User_ID»: Código del trabajador. Tipo entero. Longitud: 8.*
«Name»: Nombre. Tipo texto. Longitud: 150.*
«LastName»: Apellidos. Tipo: Texto. Longitud: 150.*
«Type_Identification»: Tipo de documento de identidad. Tipo: Texto. Longitud: 15.
«Identification»: Documento de identidad. Tipo: Entero. Longitud: 15.
«NSS»: Número seguridad social. Tipo: Texto. Longitud: 15.
«Address»: Dirección. Tipo: Texto.
«Email»: Dirección de correo. Tipo: Texto.
«Salary»: Salario mensual. Tipo: Decimal. Longitud: 15.
«Currency»: Divisa del salario. Tipo: Texto. Longitud: 3.
«Enabled»: Empleado activo(1) o inactivo(0). Tipo: entero: Valor: 0/1.*
«Job_Table_ID»: Tabla de posiciones o puestos al que pertenece el trabajador.
«Job_ID»: Posición o puesto. Tipo Entero.
«BirthDate»: Fecha de nacimiento. Tipo entero. Formato aaaammdd
«BirthPlace»: País de nacimiento. Tipo texto. Longitud: 2.
«Nationality«: Nacionalidad.
«MaritalStatus»: Estado civil. Tipo texto. Longitud: 10. Valor: Single, Married, Union, Divorced, Widower
«Sex»: Sexo. Tipo texto. Longitud: 6. Valor: Male, Female
«Disability»:  Tipo de discapacidad.
«Town»: Ciudad. Tipo entero. Longitud: 5.
«Phone»: Teléfono. Tipo texto. Longitud: 12.
«Mobile»: Teléfono. Tipo texto. Longitud: 12.
«Company»: Compañía. Tipo Entero.*
«Branch»: Sucursal. Tipo Entero.*
«Departament»: Departamento. Tipo Entero.*
«Section»: Sección. Tipo Entero.*
«HireDate»: Fecha de contratación. Tipo entero. Formato aaaammdd.
«CompanyHireDate»: Fecha de contratación en la cadena. Tipo entero. Formato aaaammdd.
«FireDate»: Fecha de salida. Formato aaaammdd.
«PayrollPeriodicity»: Periodicidad de la nómina.
«Voucher»: Forma de envío del comprobante de nómina.
«Payment»: Forma de cobro de la nómina.
«BankAccount»: Cuenta bancaria.
«AccountType»: Tipo de cuenta bancaria.

Endpoint

GET: https://api.vipsweb.online/v2/employee?ID=12345&TOKEN=123456&Limit=1
Nota: Se puede filtrar por los campos señalados con *.

RESPUESTA:

2. Seccionamiento

El seccionamiento se refiere a la estructura empresarial. Puede obtener un listado de compañías, o el detalle de la compañía con el parámetro «Company_ID» que coincide con el parámetro «Company» del endpoint «Empleados».

Datos del modelo

«Company_ID»: Código de Cadena. Tipo entero. Longitud: 3.
«Company:  Cadena. Tipo texto. Longitud: 150.

Endpoint

GET: https://api.vipsweb.online/v2/departments?ID=12345&TOKEN=123456

RESPUESTA:

Datos del modelo

«Company_ID»: Código de cadena. Tipo entero. Longitud: 3.
«Company»: Cadena. Tipo texto. Longitud: 150.
«Branch_ID»: Códgio de Sucursal. Tipo entero. Longitud: 3.
«Branch»: Sucursal. Tipo texto. Longitud: 150.
«Department_ID»: Código de Departamento. Tipo entero. Longitud: 3.
«Department «: Código de departamento. Tipo texto. Longitud: 150.
«Section_ID»: Código de sección. Tipo entero. Longitud: 3.
«Section»: Sección. Tipo texto. Longitud: 150.

Endpoint

GET: https://api.vipsweb.online/v2/dapartments?ID=12345&TOKEN=12345&Company_ID=1

RESPUESTA:

3. Rol

El rol se refiere al puesto de trabajo, posición o rol dentro de la empresa. Puede obtener una lista de las tablas de roles, o el detalle de las tablas con el parámetro «Job_Table_ID», que corresponde al parámetro «Job_Table_ID» del endpoint «empleado».

Datos del modelo

«Job_Table_ID»: Código de la tabla de roles. Tipo entero. Longitud: 3.
«Job_Table»: Nombre de la tabla de roles. Tipo texto. Longitud: 150.

Endpoint

GET: https://api.vipsweb.online/v2/rol?ID=1234&TOKEN=1234

RESPUESTA:

Datos del modelo

«Job_Table_ID»: Código de la tabla de roles. Tipo entero. Longitud: 3.
«Job_Table»: Nombre de la tabla de roles. Tipo texto. Longitud: 150.
«Job»: Nombre del rol. Tipo texto. Longitud 150.

Endpoint

GET: https://api.vipsweb.online/v2/rol?ID=1234&TOKEN=1234&Job_Table_ID=1

RESPUESTA:

4. Locations

Es la lista de países. Puede obtener el nombre de un país con el parámetro «Country_ID».

Datos del modelo

«Country_ID»: Código de cadena. Tipo entero. Longitud: 3.
«Country»: Cadena. Tipo texto. Longitud: 150.

Endpoint

GET: https://api.vipsweb.online/v2/locations?ID=12345&TOKEN=12345

RESPUESTA:

4. Payroll

Datos del reporte de nómina. Para obtener los datos del reporte de nómina debe generarse desde VIPS 3.0

Datos del modelo

Los datos del reporte de nómina varían según la configuración del reporte de nómina que cada cliente configure en VIPS 3.0. Para que esta información se pueda mostrar antes debe generar el reporte de nómina en VIPS 3.0.

Existen 6 tipos de nóminas:

  • Nómina general
  • Nómina periódica
  • Nómina de salida
  • Nómina de vacaciones
  • Nómina de regalía
  • Nómina de bonificación

Nómina General:

Number:  Número del reporte de nómina.  Valores: 1 – 9999.
Type: Tipo de nómina. Valores: G.
Year: Año
Month: Mes. Valores: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12.
Period: Periodo de nómina. Valores:

  • 1Q (Primera quincena del mes)
  • 2Q (Segunda quincena del mes)
  • M (Mensual)
  • 1S (Primera semana del mes)
  • 2S (Segunda semana del mes)
  • 3S (Tercera semana del mes)
  • 4S (Cuarta semana del mes)
  • 5S (Quina semana del mes)
  • 1B (Primeras dos semanas del mes)
  • 2B (Las semanas 3 y 4 del mes)
  • 3B (La quinta semana de mes)

Endpoint

GET: https://api.vipsweb.online/v2/payroll?ID=1234&TOKEN=1234&Number=7&Letter=G&Year=2024&Month=02&Period=2Q

RESPUESTA:

4. Voucher

Datos del recibo o comprobante de nómina. El recibo de nómina se puede consultar una vez generado.

Datos del modelo

«codigo»: Código de empleado. Tipo string.
«empresa»: Empresa. Tipo string.
«sucursal»: Sucursal. Tipo string.
«departamento»: Departamento. Tipo string.
«seccion»: Sección. Tipo string.
«unidad»: Unidad. Tipo string.
«nombre»: Nombre completo. Tipo string.
«codigoNombre»: Código de empleado y nombre. Tipo string.
«puesto»: Puesto o posición. Tipo string.
«fechaIngreso»: Fecha ingreso. Formato: DD/MM/AAAA.
«sueldo»: Sueldo o salario. Tipo float.
«periodo»: Perido en formato texto largo. Tipo string.
«cedula»: Cédula. Tipo string.
«cuenta»: Cuenta bancaria. Tipo string.

Transacciones:

«linea»: Número de transacción. Tipo integer.
«concepto»: Concepto del justificante. Tipo string.
«conceptoUnidad»: Concepto detallado. Tipo string.
«monto»: Monto. Tipo float.
«pagado»: Pagado, puede tener valor vacío. Tipo string.
«prestamoPagado»: Prestamo pagado, puede tener valor vacío. Tipo string.
«prestamoPendiente»: Prestamo pendiente, puede tener valor vacío. Tipo string.
«divisa:» Divisa. Tipo string.

Existen 6 tipos de nóminas, la llamada será diferente según el tipo de nómina:

  • Nómina general
  • Nómina periódica
  • Nómina de salida
  • Nómina de vacaciones
  • Nómina de regalía
  • Nómina de bonificación

Nómina General:

Type: Tipo de nómina. Valores: G.
Year: Año
Month: Mes. Valores: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12.
Period: Periodo de nómina. Valores:

  • 1Q (Primera quincena del mes)
  • 2Q (Segunda quincena del mes)
  • M (Mensual)
  • 1S (Primera semana del mes)
  • 2S (Segunda semana del mes)
  • 3S (Tercera semana del mes)
  • 4S (Cuarta semana del mes)
  • 5S (Quina semana del mes)
  • 1B (Primeras dos semanas del mes)
  • 2B (Las semanas 3 y 4 del mes)
  • 3B (La quinta semana de mes)

Endpoint

GET: https://api.vipsweb.online/v2/voucher?ID=1234&TOKEN=1234&Type=G&Year=2024&Month=03&Period=1Q

Respuesta:

Nómina Periódica:

Type: Tipo de nómina. Valores: H.
Número: Número de nómina adocional
Year: Año
Month: Mes. Valores: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12.
Period: Periodo de nómina. Valores:

  • 1Q (Primera quincena del mes)
  • 2Q (Segunda quincena del mes)
  • M (Mensual)
  • 1S (Primera semana del mes)
  • 2S (Segunda semana del mes)
  • 3S (Tercera semana del mes)
  • 4S (Cuarta semana del mes)
  • 5S (Quina semana del mes)
  • 1B (Primeras dos semanas del mes)
  • 2B (Las semanas 3 y 4 del mes)
  • 3B (La quinta semana de mes)

Endpoint

GET: https://api.vipsweb.online/v2/voucher?ID=1234&TOKEN=1234&Type=H1&Year=2024&Month=03&Period=1Q

Nómina de salida:

Type: Tipo de nómina. Valores: F.
Year: Año
Month: Mes. Valores: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12.

Endpoint

GET: https://api.vipsweb.online/v2/voucher?ID=1234&TOKEN=1234&Type=F&Year=2024&Month=03

Nómina de vacaciones:

Type: Tipo de nómina. Valores: V.
Year: Año
Month: Mes. Valores: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12.

Endpoint

GET: https://api.vipsweb.online/v2/voucher?ID=1234&TOKEN=1234&Type=V&Year=2024&Month=03

Nómina de regalia:

Type: Tipo de nómina. Valores: R.
Year: Año

Endpoint

GET: https://api.vipsweb.online/v2/voucher?ID=1234&TOKEN=1234&Type=R&Year=2024

Nómina de bonificación:

Type: Tipo de nómina. Valores: X.
Year: Año

Endpoint

GET: https://api.vipsweb.online/v2/voucher?ID=1234&TOKEN=1234&Type=X&Year=2024

Documentación propiedad de Asesoweb Profesional y Ho-Tech de Caribe. Para cualquier duda contactar con r.ortega@asesoweb.com