Diferencia entre revisiones de «API Articulos/Grupos Contables»

De WikiSerpi
Ir a la navegación Ir a la búsqueda
Edición siguiente →
VisualWikitexto
Created page with "'''Descripción:''' Este reporte entrega una visión completa de la gestión del agente al resumir individualmente la actividad del asesor indicando el total de las llamadas gestionadas (inbound/ outbound/ internal), el tiempo que ha usado en cada fase de la atención al cliente (tiempo de Ring, ACW y AHT), fecha y hora de Log In/Log Out, además la cantidad de hits y RPC. '''Autorización:''' Se requiere autenticación para todas las solicitudes. Las credenciales de au..."
 
Línea 19: Línea 19:
== Métodos ==
== Métodos ==
<Tabs>
<Tabs>
<!-- ***************** GET ****************** -->
<!-- ************************************************************** GET ********************************************************************** -->
<Tab name = "API Consulta (GET)  ">
<Tab name = "API Consulta (GET)  ">
'''GET/users'''


'''EndPoint:'''
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/TipoIdentidad
<nowiki>https://www.apis.serpi.com.co/api/v1/GrupoCont</nowiki>


'''EndPoint con parámetros:'''
'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Tercero?limite=50&pagina=1&identificacion=123456789&fechaCreadoDesde=2020-01-01%2000:00:00&fechaCreadoHasta=2020-12-31%2023:59:59
<nowiki>https://www.apis.serpi.com.co/api/v1/GrupoCont?limite=50&pagina=1</nowiki>


''' Headers '''
{| class="wikitable"
{| class="wikitable left"
|+ Headers
|-
! Header !! Descripción  
! Header !! Descripción  
|-
|-
Línea 37: Línea 37:


'''Authorization:'''
'''Authorization:'''
<syntaxhighlight line="1">
<syntaxhighlight >
Usar Bearer. Ejemplo “bearer {{token}}”.
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>
</syntaxhighlight>


'''Parámetros'''
{| class="wikitable"
{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Tipo de dato !! Requerido !! Descripción
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
|-
Línea 49: Línea 50:
|-
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|-
| Identificacion || int || No || Cedula o nit del tercero a filtrar
|-
| FechaCreadoDesde || Date || No || Fecha inicial para filtrar por fecha de creación del tercero
|-
| FechaCreadoHasta || Date || No || Fecha final para filtrar por fecha de creación del tercero
|}
|}


'''Response'''
'''Response'''
<syntaxhighlight lang="JSON" line="1">
<syntaxhighlight lang="JSON">
{
{
"success": true
    "success": true,
"code": 200,
    "code": 200,
"message": "x registro(s) encontrados",
    "errors": null,
"result": [
    "message": "1 registro(s) encontrados",
{
    "result": [
        {
             "id": 1,
             "id": 1,
             "tipoidentidad": "CC",
             "codigo": "1",
             "identificacion": "123456789",
             "descripcion": "GRUPO CONTABLE DEMO",
             "dv": 0,
             "tipoproducto": 1,
            "tipopersona": 2,
             "aplica_recaudo_tercero": true,
             "primernombre": "PEDRO",
             "aplica_impuesto_venta": true,
            "segundonombre": "LUIS",
             "impuesto_venta": 5.00000,
            "primerapellido": "PEREZ",
             "descripcion_impuesto_venta": "IVA COMPRA 5%",
            "segundoapellido": "LOPEZ",
             "aplica_impuesto_compra": true,
            "nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
             "impuesto_compra": 19.00000,
            "razonsocial": null,
             "descripcion_impuesto_compra": "IVA COMPRA 19%",
            "escliente": true,
             "aplica_impoconsumo": true,
             "esproveedor": true,
             "valor_impoconsumo": 0,
             "esempleado": false,
             "aux_cuenta_impoconsumo": 1234567,
             "esvendedor": false,
             "aux_cuenta_gastoxcompra": 1234567,
            "esotro": false,
             "aux_cuenta_ingresoventa": 1234567,
             "escobrador": false,
             "aux_cuenta_devolucionventa": 1234567,
             "cumple_dia": 0,
             "aux_cuenta_costo": 1234567,
            "cumplea_mes": 0,
             "aux_cuenta_cartera": 1234567,
            "cumplea_ano": 0,
             "aux_cuenta_ajuste": 1234567,
             "genero": "N",
             "aux_cuenta_desperdicio": 1234567,
             "direccion": "CRA 1 25 05",
             "centro_costo": "01",
            "direccion2": null,
             "aplica_retencion": true
            "telefono": null,
        }
            "ext": 0,
            "movil": null,
            "pais": "COLOMBIA",
            "departamento": "VALLE",
            "ciudad": "SANTIAGO DE CALI",
            "codciudad": "76001",
            "zona": 0,
            "email": "prueba@mail.com",
            "activo": true,
             "cupocredito": 0.00,
             "periodopago": 0,
             "codigociiu": null,
             "descuentoventa": 0,
             "categoriatercero": 1,
             "formapago": 0,
            "listaprecios": 2,
            "grupoventas": 1,
             "grupocompras": 2,
             "vendedor": 0,
             "cobrador": 0,
             "fechacreacion": "2020-01-04 10:16:30",
             "regimen": 2,
            "banco": 0,
            "tipo_cuenta": null,
            "cuenta_bancaria": null,
            "limite_credito": 0.00000,
            "camposcliente": {
                "ACTIVIDADECONOMICAMUNICIPAL": "BC44",
                "Comentarios": "Cliente proveedor de software",
                "Comuna": 11,
                "FechaAniversario": "2016-06-01",
                "ClienteNacional": true,
                "Ranking": "2",
                "TieneAsesor": "N",
                "Vetado": "3",
                "TipodeEmpresa": [
                    "b",
                    "c"
                ],
                "continente": ""
            }
 
]
]
}
}


{
{
    "success": true,
"success": true
    "code": 204,
"code": 201,
    "message": "No se encontraron registros",
"message": "No se encontraron registros",
"result": []
}
}
{
    "success": false,
    "code": 400,
    "message": "El formato de las fechas es invalido. Ejemplo 2023-01-20 00:00:00",
}
</syntaxhighlight>
</syntaxhighlight>


'''Campo de resultados'''
{| class="wikitable"
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
! Campo !! Tipo de dato !! Descripción
|-
|-
| Id || int || Corresponde al identificador del tercero
| id || int || Corresponde al identificador del tipo de retención
|-
| tipoidentidad || string || Codigo del tipo de indentidad
|-
| identificacion || string || Numero de identificacion
|-
| dv || int || Digito de verificacion
|-
| tipopersona || int || Codigo del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || string || Primer nombre
|-
| segundonombre || bool || Segundo nombre
|-
| primerapellido || string || Primer apellido
|-
| segundoapellido || string || Segundo apellido
|-
| nombrecompleto || string || Nombre completo
|-
| razonsocial || string || razon social
|-
| escliente || bool || Seleccionar si el tercero es cliente
|-
| esproveedor || bool || Seleccionar si el tercero es proveedor
|-
| esempleado || bool || Seleccionar si el tercero es empleado
|-
| esvendedor || bool || Seleccionar si el tercero es vendedor
|-
| esotro || bool || Seleccionar si el tercero es otro
|-
| escobrador || bool || Seleccionar si el tercero es cobrador
|-
| cumple_dia || int || Dia del cumpleaños
|-
| cumplea_mes || int || Mes del cumpleaños
|-
| cumplea_ano || int || Año del cumpleaños
|-
| genero || string || Genero del tercero (M=Masculino, F=Femenino)
|-
| direccion || string || Direccion
|-
| direccion2 || string || Direccion complementaria
|-
| telefono || string || Numero de telefono
|-
|-
| ext || int || Numero extension
| codigo || string || Descripción del tipo de retención
|-
|-
| movil || string || Numero de movil celular
| descripcion || string || Descripción del tipo de retención
|-
|-
| pais || string || Nombre pais
| tipoproducto || int || Retenedor Rte Fuente
|-
|-
| departamento || string || Nombre del departamento
| aplica_recaudo_tercero || bool|| Base Rte Fuente
|-
|-
| ciudad || string || Nombre de la ciudad
| aplica_impuesto_venta || bool || Retenedor Rte ICA
|-
|-
| codciudad || string || Codigo unico de la ciudad
| impuesto_venta || double || Base Min Rte ICA
|-
|-
| zona || int || id de la zona
| descripcion_impuesto_venta || string || Retenedor IVA
|-
|-
| email || string || cuenta de email
| aplica_impuesto_compra || bool || Retenedor IVA
|-
|-
| activo || bool || Estado del tercero (true=Activo, false=Inactivo)
| impuesto_compra || double || Porcentaje Rte ICA
|-
|-
| cupocredito || decimal || Cupo de credito
| descripcion_impuesto_compra || string || Porcentaje Rte Fuente
|-
|-
| periodopago || int || Periodo de pago en dias para el vencimiento de facturas de venta
| aplica_impoconsumo || bool || Porcentaje Rte IVA
|-
|-
| codigociiu || string || Codigo CIIU, Actividades economicas
| valor_impoconsumo || double || Cuenta Rte. Fuente
|-
|-
| descuentoventa || decimal || Porcentaje para el descuento en ventas
| aux_cuenta_impoconsumo || int || Cuenta Rte. ICA
|-
|-
| categoriatercero || int || Id de la categoria de tercero
| aux_cuenta_gastoxcompra || int || Cuenta Rte. IVA
|-
|-
| formapago || int || Id de la forma pago
| aux_cuenta_ingresoventa || int || Tipo de retención (Ventas o Compras)
|-
|-
| listaprecios || int || Id de la lista de precios
| aux_cuenta_devolucionventa  || int || Si aplica IVA teórico
|-
|-
| grupoventas || int || Id del grupo de retenciones para ventas
| aux_cuenta_costo || int || Base IVA teórico
|-
|-
| grupocompras || int || Id del grupo de retenciones para compras
| aux_cuenta_cartera || int || Porcentaje IVA teórico
|-
|-
| vendedor || int || Numero de identificacion del vendedor
| aux_cuenta_ajuste || int || Cuenta IVA teórico
|-
|-
| cobrador || int || Numero de identificacion del cobrador
| aux_cuenta_desperdicio || int || Cuenta Rte. IVA teórico
|-
|-
| fechacreacion || string || Fecha de creacion del tercero. Ejemplo "2020-05-20 00:00:00"
| centro_costo || string || Cuenta IVA teórico
|-
|-
| regimen || int || Id del regimen tributario
| aplica_retencion || bool || Cuenta Rte. IVA teórico
|-
| banco || int || Id del banco
|-
| tipo cuenta || string || Tipo de cuenta bancaria (A=Cuenta de ahorro, B=Cuenta Corriente)
|-
| cuenta bancaria || string || Numero de cuenta bancaria
|-
| limite credito || decimal || Limite del credito
|-
| camposcliente || Objeto || Objeto con la informacion de campos personalizados
|}
|}
</Tab>
</Tab>


<!-- ***************** POST ****************** -->
<!-- ************************************************************** POST ********************************************************************** -->
<Tab name = "API Creación (POST) ">
<Tab name = "API Creación (POST) ">
'''POST /users'''
'''EndPoint:'''
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/TipoIdentidad
https://www.apis.serpi.com.co/api/v1/GrupoVentas


''' Headers '''
{| class="wikitable"
{| class="wikitable left"
|+ Headers
|-
! Header !! Descripción  
! Header !! Descripción  
|-
|-
Línea 274: Línea 163:


'''Authorization:'''
'''Authorization:'''
<syntaxhighlight line="1">
<syntaxhighlight>
Usar Bearer. Ejemplo “bearer {{token}}”.
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>
</syntaxhighlight>


'''Request'''
'''Request'''
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
{
{
            "tipoidentidad": "CC",
    "descripcion": "Descripcion del tipo de retención",
            "identificacion": "123456789",
    "retenedor_rte_fuente": true,
            "dv": 0,
    "base_rte_fuente": 1000.00000,
            "tipopersona": 2,
    "retenedor_rte_ica": true,
            "primernombre": "PEDRO",
    "base_min_rte_ica": 2000.00000,
            "segundonombre": "LUIS",
    "retenedor_iva": true,
            "primerapellido": "PEREZ",
    "base_rte_iva": 3000.00000,
            "segundoapellido": "LOPEZ",
    "porcentaje_rte_ica": 5.00000,
            "nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
    "porcentaje_rte_fuente": 10.00000,
            "razonsocial": null,
    "porcentaje_rte_iva": 20.00000,
            "escliente": true,
    "cuenta_rte_fuente": null,
            "esproveedor": true,
    "cuenta_rte_ica": 1234567,
            "esempleado": false,
    "cuenta_rte_iva": 1234567,
            "esvendedor": false,
    "tipogrupo": 1,
            "esotro": false,
    "aplica_iva_teorico": true,
            "escobrador": false,
    "base_iva_teorico": 4000.00000,
            "cumple_dia": 0,
    "porcentaje_iva_teorico": 30.00000,
            "cumplea_mes": 0,
    "cuenta_iva_teorico": 1234567,
            "cumplea_ano": 0,
    "cuenta_ret_iva_teorico": 1234567
            "genero": "N",
}
            "direccion": "CRA 1 25 05",
</syntaxhighlight>
            "direccion2": null,
            "telefono": null,
            "ext": 0,
            "movil": null,
            "pais": "COLOMBIA",
            "departamento": "VALLE",
            "ciudad": "SANTIAGO DE CALI",
            "codciudad": "76001",
            "zona": 0,
            "email": "prueba@mail.com",
            "activo": true,
            "cupocredito": 0.00,
            "periodopago": 0,
            "codigociiu": null,
            "descuentoventa": 0,
            "categoriatercero": 1,
            "formapago": 0,
            "listaprecios": 2,
            "grupoventas": 1,
            "grupocompras": 2,
            "vendedor": 0,
            "cobrador": 0,
            "fechacreacion": "2020-01-04 10:16:30",
            "regimen": 2,
            "banco": 0,
            "tipo_cuenta": null,
            "cuenta_bancaria": null,
            "limite_credito": 0.00000,
            "camposcliente": {
                "ACTIVIDADECONOMICAMUNICIPAL": "BC44",
                "Comentarios": "Cliente proveedor de software",
                "Comuna": 11,
                "FechaAniversario": "2016-06-01",
                "ClienteNacional": true,
                "Ranking": "2",
                "TieneAsesor": "N",
                "Vetado": "3",
                "TipodeEmpresa": [
                    "b",
                    "c"
                ],
                "continente": ""
            }




        }
</syntaxhighlight>
''' Campos del request'''
{| class="wikitable"
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|+ Campos del request
|-
|-
| tipoidentidad || String || SI || Código del tipo de identidad
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
|-
| identificacion || String || SI || Número de identificación
| descripcion || string || 50 || Si || Descripción del tipo de retención
|-
|-
| dv || Int || SI || Digito de verificación
| retenedor_rte_fuente || bool || 1 || No || Retenedor Rte Fuente
|-
|-
| tipopersona || Int || SI || Código del tipo de persona (1=JURIDICO, 2=NATURAL)
| base_rte_fuente || double || (18,5) || No || Base Rte Fuente
|-
|-
| primernombre || String || SI (Si tipo persona=NATURAL) || Primer Nombre
| retenedor_rte_ica || bool || 1 || No || Retenedor Rte ICA
|-
|-
| segundonombre || String || NO || Segundo Nombre
| base_min_rte_ica || double || (18,5) || No || Base Min Rte ICA
|-
|-
| primerapellido || String || SI (Si tipo persona=NATURAL) || Primer Apellido
| retenedor_iva || bool || 1 || No || Retenedor IVA
|-
|-
| segundoapellido || String || NO || Segundo Apellido
| base_rte_iva || double || (18,5) || No || Retenedor IVA
|-
|-
| nombrecompleto || String || SI || Nombre Completo
| porcentaje_rte_ica || double || (18,5) || No || Porcentaje Rte ICA
|-
|-
| razonsocial || String || SI (Si tipo persona=JURIDICO) || Razón Social
| porcentaje_rte_fuente || double || (18,5) || No || Porcentaje Rte Fuente
|-
|-
| escliente || Bool || NO || Seleccionar si el tercero es cliente
| porcentaje_rte_iva || double || (18,5) || No || Porcentaje Rte IVA
|-
|-
| esproveedor || Bool || NO || Seleccionar si el tercero es proveedor
| cuenta_rte_fuente || int || 20 || No || Cuenta Rte. Fuente
|-
|-
| esempleado || Bool || NO || Seleccionar si el tercero es empleado
| cuenta_rte_ica || int || 20 || No || Cuenta Rte. ICA
|-
|-
| esvendedor || Bool || NO || Seleccionar si el tercero es vendedor
| cuenta_rte_iva || int || 20 || No || Cuenta Rte. IVA
|-
|-
| esotro || Bool || NO || Seleccionar si el tercero es otro
| tipogrupo || int || 1 || Si || El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)
|-
|-
| escobrador || Bool || NO || Seleccionar si el tercero es cobrador
| aplica_iva_teorico || bool || 1 || No || Si aplica IVA teórico
|-
|-
| cumple_dia || Int || NO || Día del cumpleaños
| base_iva_teorico || double || (18,5) || No || Base IVA teórico
|-
|-
| cumplea_mes || Int || NO || Mes del cumpleaños
| porcentaje_iva_teorico || double || (18,5) || No || Porcentaje IVA teórico
|-
|-
| cumplea_ano || Int || NO || Año del cumpleaños
| cuenta_iva_teorico || int || 20 || No || Cuenta IVA teórico
|-
|-
| genero || String || NO || Género del tercero (M=Masculino, F=Femenino)
| cuenta_ret_iva_teorico || int || 20 || No || Cuenta Rte. IVA teórico
|-
| direccion || String || SI || Dirección
|-
| direccion2 || String || NO || Dirección complementaria
|-
| telefono || String || NO || Número de teléfono
|-
| ext || Int || NO || Número de extensión
|-
| movil || String || SI || Número de móvil celular
|-
| pais || String || Informativo || Nombre País
|-
| departamento || String || Informativo || Nombre del departamento
|-
| ciudad || String || Informativo || Nombre de la ciudad
|-
| codciudad || String || SI || Código único de la ciudad
|-
| zona || Int || NO || ID de la zona
|-
| email || String || SI || Cuenta de email
|-
| activo || Bool || SI || Estado del tercero (true=Activo, false=Inactivo)
|-
| cupocredito || Decimal || NO || Cupo de crédito
|-
| periodopago || Int || NO || Período de pago en días para el vencimiento de facturas de venta
|-
| codigociiu || String || NO || Código CIIU, Actividades económicas
|-
| descuentoventa || Decimal || NO || Porcentaje para el descuento en ventas
|-
| categoriatercero || Int || SI || ID de la categoría de terceros
|-
| formapago || Int || NO || ID de la forma de pago
|-
| listaprecios || Int || NO || ID de la lista de precios
|-
| grupoventas || Int || SI || ID del grupo de retenciones para ventas
|-
| grupocompras || Int || SI || ID del grupo de retenciones para compras
|-
| vendedor || Int || NO || Número de identificación del vendedor
|-
| cobrador || Int || NO || Número de identificación del cobrador
|-
| fechacreacion || String || NO || Fecha de creación del tercero. Ejemplo "2020-05-20 00:00:00"
|-
| regimen || Int || SI || ID del régimen tributario
|-
| banco || Int || NO || ID del banco
|-
| tipo_cuenta || String || NO || Tipo cuenta bancaria. (A=Cuenta de Ahorro, B=Cuenta Corriente)
|-
| cuenta_bancaria || String || NO || Número de cuenta bancaria
|-
| limite_credito || Decimal || NO || Límite del crédito
|-
| camposcliente || Objeto || NO || Objeto con la información de campos personalizados
|}
|}


==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.


'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>


'''Response'''
'''Response'''
<syntaxhighlight lang="JSON" line="1">
<syntaxhighlight lang="JSON">
{
{
     "success": true,
     "success": true,
     "code": 201,
     "code": 201,
     "errors": [],
    "errors": null,
     "message": "Se crearon 10 de 10 terceros"
    "message": "registro creado exitosamente"
}
</syntaxhighlight>
 
'''Validaciones'''
<syntaxhighlight lang="JSON">
{
    "success": false,
    "code": 400,
     "errors": [
        "El campo descripcion es obligatorio",
        "El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)",
        "No existe una cuenta relacionada al numero auxiliar 1"
    ],
     "message": "Se presentaron errores al modificar el registro"
}
}
</syntaxhighlight>
</syntaxhighlight>
</Tab>
</Tab>


<!-- ***************** PUT ****************** -->
<!-- ************************************************************** PUT ********************************************************************** -->
<Tab name = "API Modificar(PUT) ">
<Tab name = "API Modificar(PUT) ">
'''PUT/users'''
'''EndPoint:'''
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/TipoIdentidad
https://www.apis.serpi.com.co/api/v1/GrupoVentas


''' Headers '''
{| class="wikitable"
{| class="wikitable left"
|+ Headers
|-
! Header !! Descripción  
! Header !! Descripción  
|-
|-
Línea 490: Línea 282:


'''Authorization:'''
'''Authorization:'''
<syntaxhighlight line="1">
<syntaxhighlight>
Usar Bearer. Ejemplo “bearer {{token}}”.
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>
</syntaxhighlight>


'''Request'''
'''Request'''
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
{
{
     "id": 1
     "id": 1,
     "abreviatura": "NIT",
    "descripcion": "Descripcion del tipo de retención",
     "descripcion": "NIT",
    "retenedor_rte_fuente": true,
     "codigo": 31,
    "base_rte_fuente": 1000.00000,
     "abreviatura2": " NIT2",
     "retenedor_rte_ica": true,
     "abreviatura3": "",
    "base_min_rte_ica": 2000.00000,
     "excluirImpVentas": false
     "retenedor_iva": true,
    "base_rte_iva": 3000.00000,
    "porcentaje_rte_ica": 5.00000,
    "porcentaje_rte_fuente": 10.00000,
    "porcentaje_rte_iva": 20.00000,
    "cuenta_rte_fuente": null,
    "cuenta_rte_ica": 1234567,
    "cuenta_rte_iva": 1234567,
     "tipogrupo": 1,
     "aplica_iva_teorico": true,
    "base_iva_teorico": 4000.00000,
     "porcentaje_iva_teorico": 30.00000,
    "cuenta_iva_teorico": 1234567,
     "cuenta_ret_iva_teorico": 1234567
}
}
</syntaxhighlight>
</syntaxhighlight>


''' Campos del request'''
 
{| class="wikitable left"
{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
|-
| id || int || 50 || SI || Corresponde al identificador del tipo de identidad
| id || int || 11 || Si || Corresponde al identificador del tipo de retención
|-
| descripcion || string || 50 || Si || Descripción del tipo de retención
|-
| retenedor_rte_fuente || bool || 1 || No || Retenedor Rte Fuente
|-
| base_rte_fuente || double || (18,5) || No || Base Rte Fuente
|-
| retenedor_rte_ica || bool || 1 || No || Retenedor Rte ICA
|-
| base_min_rte_ica || double || (18,5) || No || Base Min Rte ICA
|-
| retenedor_iva || bool || 1 || No || Retenedor IVA
|-
| base_rte_iva || double || (18,5) || No || Retenedor IVA
|-
| porcentaje_rte_ica || double || (18,5) || No || Porcentaje Rte ICA
|-
| porcentaje_rte_fuente || double || (18,5) || No || Porcentaje Rte Fuente
|-
| porcentaje_rte_iva || double || (18,5) || No || Porcentaje Rte IVA
|-
| cuenta_rte_fuente || int || 20 || No || Cuenta Rte. Fuente
|-
| cuenta_rte_ica || int || 20 || No || Cuenta Rte. ICA
|-
| cuenta_rte_iva || int || 20 || No || Cuenta Rte. IVA
|-
|-
| abreviatura || string || 50 || SI || Abreviatura Tipo de identidad
| tipogrupo || int || 1 || Si || El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)
|-
|-
| descripcion|| string || 50 || SI || Descripcion tipo de identidad
| aplica_iva_teorico || bool || 1 || No || Si aplica IVA teórico
|-
|-
| codigo || int || 50 || SI || Codigo numero del tipo de identidad
| base_iva_teorico || double || (18,5) || No || Base IVA teórico
|-
|-
| abreviatura2 || string || 50 || NO || Abreviatura2 Tipo de identidad
| porcentaje_iva_teorico || double || (18,5) || No || Porcentaje IVA teórico
|-
|-
| abreviatura3 || string || 50 || NO || Abreviatura3 Tipo de identidad
| cuenta_iva_teorico || int || 20 || No || Cuenta IVA teórico
|-
|-
| excluirImpVentas|| bool || 50 || NO || true o false. Si el tipo de identidad es excluido del impuesto de ventas
| cuenta_ret_iva_teorico || int || 20 || No || Cuenta Rte. IVA teórico
|}
|}


'''Authorization:'''
==== '''AVISO IMPORTANTE:''' ====
<syntaxhighlight line="1">
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.
Usar Bearer. Ejemplo “bearer {{token}}”.
 
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>


'''Response'''
'''Response'''
<syntaxhighlight lang="JSON" line="1">
<syntaxhighlight lang="JSON">
{
{
"success": true
    "success": true,
    "code": 200,
    "code": 200,
    "message": "registro modificado exitosamente"
    "errors": null,
    "message": "registro modificado exitosamente"
}
}


{
{
    "success": false,
    "success": false,
    "code": 400,
    "code": 204,
    "errors": [
    "errors": null,
        "El campo abreviatura es obligatorio"
    "message": "No se encontraron registros con el id 1"
    ],
    "message": "Se presentaron errores al modificar el registro"
}
}
</syntaxhighlight>


 
'''Validaciones'''
 
<syntaxhighlight lang="JSON">
 
{
{
    "success": false,
    "success": false,
    "code": 204,
    "code": 400,
    "errors": null,
    "errors": [
    "message": "No se encontraron registros con el id xx"
        "El campo id es obligatorio",
        "El campo descripcion es obligatorio",
        "El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)",
        "No existe una cuenta relacionada al numero auxiliar 1"
    ],
    "message": "Se presentaron errores al modificar el registro"
}
}
</syntaxhighlight>
</syntaxhighlight>

Revisión del 12:07 2 jun 2023

Descripción: Este reporte entrega una visión completa de la gestión del agente al resumir individualmente la actividad del asesor indicando el total de las llamadas gestionadas (inbound/ outbound/ internal), el tiempo que ha usado en cada fase de la atención al cliente (tiempo de Ring, ACW y AHT), fecha y hora de Log In/Log Out, además la cantidad de hits y RPC.

Autorización: Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

Beneficio: Este reporte permite hacer una medición de la productividad individual de los agentes teniendo en cuenta el tiempo dedicado a la gestión de llamadas y sus logros (hits y RPC)

Tipos de peticiones: GET, POST, PUT

¿Cómo funciona?

  • El consumo de esta API se realiza por método GET.
  • Para consumir esta API debe reemplazar en la url {ip_ipdialbox} por la nomenclatura del servidor de la operación y el {token} generado desde wolkvox Manager para obtener la información de manera segura.
  • Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
  • En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

Métodos

<Tabs> <Tab name = "API Consulta (GET) ">

EndPoint: https://www.apis.serpi.com.co/api/v1/GrupoCont

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/GrupoCont?limite=50&pagina=1

Headers
Header Descripción
secretkey Secretkey proporcionada al cliente para consumos de las APIs

Authorization: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
Parámetros
Parámetro Tipo de dato Requerido Descripción
Límite int No Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
Página int No Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página

Response 

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "1 registro(s) encontrados",
    "result": [
        {
            "id": 1,
            "codigo": "1",
            "descripcion": "GRUPO CONTABLE DEMO",
            "tipoproducto": 1,
            "aplica_recaudo_tercero": true,
            "aplica_impuesto_venta": true,
            "impuesto_venta": 5.00000,
            "descripcion_impuesto_venta": "IVA COMPRA 5%",
            "aplica_impuesto_compra": true,
            "impuesto_compra": 19.00000,
            "descripcion_impuesto_compra": "IVA COMPRA 19%",
            "aplica_impoconsumo": true,
            "valor_impoconsumo": 0,
            "aux_cuenta_impoconsumo": 1234567,
            "aux_cuenta_gastoxcompra": 1234567,
            "aux_cuenta_ingresoventa": 1234567,
            "aux_cuenta_devolucionventa": 1234567,
            "aux_cuenta_costo": 1234567,
            "aux_cuenta_cartera": 1234567,
            "aux_cuenta_ajuste": 1234567,
            "aux_cuenta_desperdicio": 1234567,
            "centro_costo": "01",
            "aplica_retencion": true
        }
	]
}

{
	"success": true
	"code": 201,
	"message": "No se encontraron registros",
	"result": []
}
Campos de resultados
Campo Tipo de dato Descripción
id int Corresponde al identificador del tipo de retención
codigo string Descripción del tipo de retención
descripcion string Descripción del tipo de retención
tipoproducto int Retenedor Rte Fuente
aplica_recaudo_tercero bool Base Rte Fuente
aplica_impuesto_venta bool Retenedor Rte ICA
impuesto_venta double Base Min Rte ICA
descripcion_impuesto_venta string Retenedor IVA
aplica_impuesto_compra bool Retenedor IVA
impuesto_compra double Porcentaje Rte ICA
descripcion_impuesto_compra string Porcentaje Rte Fuente
aplica_impoconsumo bool Porcentaje Rte IVA
valor_impoconsumo double Cuenta Rte. Fuente
aux_cuenta_impoconsumo int Cuenta Rte. ICA
aux_cuenta_gastoxcompra int Cuenta Rte. IVA
aux_cuenta_ingresoventa int Tipo de retención (Ventas o Compras)
aux_cuenta_devolucionventa int Si aplica IVA teórico
aux_cuenta_costo int Base IVA teórico
aux_cuenta_cartera int Porcentaje IVA teórico
aux_cuenta_ajuste int Cuenta IVA teórico
aux_cuenta_desperdicio int Cuenta Rte. IVA teórico
centro_costo string Cuenta IVA teórico
aplica_retencion bool Cuenta Rte. IVA teórico

</Tab>

<Tab name = "API Creación (POST) "> EndPoint: https://www.apis.serpi.com.co/api/v1/GrupoVentas

Headers
Header Descripción
secretkey Secretkey proporcionada al cliente para consumos de las APIs

Authorization: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP


Request 

{
    "descripcion": "Descripcion del tipo de retención",
    "retenedor_rte_fuente": true,
    "base_rte_fuente": 1000.00000,
    "retenedor_rte_ica": true,
    "base_min_rte_ica": 2000.00000,
    "retenedor_iva": true,
    "base_rte_iva": 3000.00000,
    "porcentaje_rte_ica": 5.00000,
    "porcentaje_rte_fuente": 10.00000,
    "porcentaje_rte_iva": 20.00000,
    "cuenta_rte_fuente": null,
    "cuenta_rte_ica": 1234567,
    "cuenta_rte_iva": 1234567,
    "tipogrupo": 1,
    "aplica_iva_teorico": true,
    "base_iva_teorico": 4000.00000,
    "porcentaje_iva_teorico": 30.00000,
    "cuenta_iva_teorico": 1234567,
    "cuenta_ret_iva_teorico": 1234567
}


Campos del request
Campo Tipo de dato Longitud Requerido Descripción
descripcion string 50 Si Descripción del tipo de retención
retenedor_rte_fuente bool 1 No Retenedor Rte Fuente
base_rte_fuente double (18,5) No Base Rte Fuente
retenedor_rte_ica bool 1 No Retenedor Rte ICA
base_min_rte_ica double (18,5) No Base Min Rte ICA
retenedor_iva bool 1 No Retenedor IVA
base_rte_iva double (18,5) No Retenedor IVA
porcentaje_rte_ica double (18,5) No Porcentaje Rte ICA
porcentaje_rte_fuente double (18,5) No Porcentaje Rte Fuente
porcentaje_rte_iva double (18,5) No Porcentaje Rte IVA
cuenta_rte_fuente int 20 No Cuenta Rte. Fuente
cuenta_rte_ica int 20 No Cuenta Rte. ICA
cuenta_rte_iva int 20 No Cuenta Rte. IVA
tipogrupo int 1 Si El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)
aplica_iva_teorico bool 1 No Si aplica IVA teórico
base_iva_teorico double (18,5) No Base IVA teórico
porcentaje_iva_teorico double (18,5) No Porcentaje IVA teórico
cuenta_iva_teorico int 20 No Cuenta IVA teórico
cuenta_ret_iva_teorico int 20 No Cuenta Rte. IVA teórico

AVISO IMPORTANTE:

Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.


Response 

{
    "success": true,
    "code": 201,
    "errors": null,
    "message": "registro creado exitosamente"
}

Validaciones 

{
    "success": false,
    "code": 400,
    "errors": [
        "El campo descripcion es obligatorio",
        "El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)",
        "No existe una cuenta relacionada al numero auxiliar 1"
    ],
    "message": "Se presentaron errores al modificar el registro"
}

</Tab>

<Tab name = "API Modificar(PUT) "> EndPoint: https://www.apis.serpi.com.co/api/v1/GrupoVentas

Headers
Header Descripción
secretkey Secretkey proporcionada al cliente para consumos de las APIs

Authorization: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP


Request 

{
    "id": 1,
    "descripcion": "Descripcion del tipo de retención",
    "retenedor_rte_fuente": true,
    "base_rte_fuente": 1000.00000,
    "retenedor_rte_ica": true,
    "base_min_rte_ica": 2000.00000,
    "retenedor_iva": true,
    "base_rte_iva": 3000.00000,
    "porcentaje_rte_ica": 5.00000,
    "porcentaje_rte_fuente": 10.00000,
    "porcentaje_rte_iva": 20.00000,
    "cuenta_rte_fuente": null,
    "cuenta_rte_ica": 1234567,
    "cuenta_rte_iva": 1234567,
    "tipogrupo": 1,
    "aplica_iva_teorico": true,
    "base_iva_teorico": 4000.00000,
    "porcentaje_iva_teorico": 30.00000,
    "cuenta_iva_teorico": 1234567,
    "cuenta_ret_iva_teorico": 1234567
}


Campos del request
Campo Tipo de dato Longitud Requerido Descripción
id int 11 Si Corresponde al identificador del tipo de retención
descripcion string 50 Si Descripción del tipo de retención
retenedor_rte_fuente bool 1 No Retenedor Rte Fuente
base_rte_fuente double (18,5) No Base Rte Fuente
retenedor_rte_ica bool 1 No Retenedor Rte ICA
base_min_rte_ica double (18,5) No Base Min Rte ICA
retenedor_iva bool 1 No Retenedor IVA
base_rte_iva double (18,5) No Retenedor IVA
porcentaje_rte_ica double (18,5) No Porcentaje Rte ICA
porcentaje_rte_fuente double (18,5) No Porcentaje Rte Fuente
porcentaje_rte_iva double (18,5) No Porcentaje Rte IVA
cuenta_rte_fuente int 20 No Cuenta Rte. Fuente
cuenta_rte_ica int 20 No Cuenta Rte. ICA
cuenta_rte_iva int 20 No Cuenta Rte. IVA
tipogrupo int 1 Si El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)
aplica_iva_teorico bool 1 No Si aplica IVA teórico
base_iva_teorico double (18,5) No Base IVA teórico
porcentaje_iva_teorico double (18,5) No Porcentaje IVA teórico
cuenta_iva_teorico int 20 No Cuenta IVA teórico
cuenta_ret_iva_teorico int 20 No Cuenta Rte. IVA teórico

AVISO IMPORTANTE:

Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.


Response 

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "registro modificado exitosamente"
}

{
    "success": false,
    "code": 204,
    "errors": null,
    "message": "No se encontraron registros con el id 1"
}

Validaciones 

{
    "success": false,
    "code": 400,
    "errors": [
        "El campo id es obligatorio",
        "El campo descripcion es obligatorio",
        "El campo tipo grupo retencion debe ser 0 (Grupo Ventas) o 1 (Grupo Compras)",
        "No existe una cuenta relacionada al numero auxiliar 1"
    ],
    "message": "Se presentaron errores al modificar el registro"
}

</Tab> </Tabs>

¿Cómo consumir la API?

<Tabs>

<Tab name = "Java"> Request 

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://wv9901.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}")
  .method("GET", null)
  .addHeader("wolkvox-token", "{{token}}")
  .build();
Response response = client.newCall(request).execute();

Response 

{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}

</Tab>

<Tab name = "Python"> Request 

import requests

url = "https://wv9901.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}"

payload={}
headers = {
  'wolkvox-token': '{{token}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Response 

{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}

</Tab>

</Tabs>

Códigos de estado HTTP

Código Descripción
200 La solicitud ha sido exitosa
201 La solicitud ha tenido éxito y ha llevado a la creación de un recurso
204 La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta
400 El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente
401 La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso
403 El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso
404 El recurso solicitado no se ha encontrado en el servidor
500 Internal Server Error
503 El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal
Obtenido de «https://www.wikiserpi.com/index.php?title=API_Articulos/Grupos_Contables&oldid=436»