WikiSerpi - Contribuciones del usuario [es]

API BI Inventario vs Contabilidad

2023-12-18T22:10:11Z

Lmedina: /* Métodos */

'''Descripción:'''
PENDIENTE

'''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:'''
PENDIENTE

'''Tipos de peticiones:'''
GET

'''¿Cómo funciona?'''
PENDIENTE

== Métodos==
<Tabs>

<Tab name = "API Contabilidad Detalle (GET) ">

'''EndPoint:'''

https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/FlujoCaja

'''EndPoint Con Parametros:'''
https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/FlujoCaja?año=2020&esalterna=0

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

{| class="wikitable"
|+ 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'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"descrip_sub": "OPERATIVO",
"gdtempresaid1": 1,
"descripcion": "NOMINA, APORTES Y LIQUIDACIONES",
"gdtempresaid": 1,
"cate_flujo": "USO",
"gdtflujocajasubid": 1,
"gdtempresaid2": 1,
"numero": 4875,
"fecha": "2021-01-06T00:00:00",
"ano": 2021,
"mes": 1,
"periodo": "202101",
"semana": 1,
"debito": 0.00000,
"credito": 36440973.00000,
"movimiento": -36440973.00000,
"gdtcuentaid": 2114,
"gdtterceroid": 7345,
"gdtcentrocostoid": null,
"naturaleza": "C",
"valor": 36440973.00000,
"gdtflujocajaid": 4,
"detalle_mov": "NÓMINA DAVIENDA",
"gdttipodocid": 6,
"categoria_doc": "CE",
"prefjo": "CE",
"nom_documento": "COMPROBANTE DE EGRESO",
"nom_auxiliar": "DAVIVIENDA CTA CTE ",
"clase": 1,
"grupo": 11,
"cuenta": 1110,
"subcuenta": 111005,
"auxiliar": 11100501,
"nit": "901067734",
"dv": 4,
"nom_tercero": "DEMO2 - GIORGIO "
}
]
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|}
</Tab>


<Tab name = "API Balance(GET) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/Contabilidad

'''EndPoint Con Parametros:'''
https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/Contabilidad?grupo=11&año_desde=2019&año_hasta=2021

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"tipoidentidad": "CC",
"identificacion": "123456789",
"dv": 0,
"tipopersona": 2,
"primernombre": "PEDRO",
"segundonombre": "LUIS",
"primerapellido": "PEREZ",
"segundoapellido": "LOPEZ",
"nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
"razonsocial": null,
"escliente": true,
"esproveedor": true,
"esempleado": false,
"esvendedor": false,
"esotro": false,
"escobrador": false,
"cumple_dia": 0,
"cumplea_mes": 0,
"cumplea_ano": 0,
"genero": "N",
"direccion": "CRA 1 25 05",
"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"
! Campo !! Tipo !! Requerido !! Descripción
|-
| tipoidentidad || String || SI || Código del tipo de identidad
|-
| identificacion || String || SI || Número de identificación
|-
| dv || Int || SI || Digito de verificación
|-
| tipopersona || Int || SI || Código del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || String || SI (Si tipo persona=NATURAL) || Primer Nombre
|-
| segundonombre || String || NO || Segundo Nombre
|-
| primerapellido || String || SI (Si tipo persona=NATURAL) || Primer Apellido
|-
| segundoapellido || String || NO || Segundo Apellido
|-
| nombrecompleto || String || SI || Nombre Completo
|-
| razonsocial || String || SI (Si tipo persona=JURIDICO) || Razón Social
|-
| escliente || Bool || NO || Seleccionar si el tercero es cliente
|-
| esproveedor || Bool || NO || Seleccionar si el tercero es proveedor
|-
| esempleado || Bool || NO || Seleccionar si el tercero es empleado
|-
| esvendedor || Bool || NO || Seleccionar si el tercero es vendedor
|-
| esotro || Bool || NO || Seleccionar si el tercero es otro
|-
| escobrador || Bool || NO || Seleccionar si el tercero es cobrador
|-
| cumple_dia || Int || NO || Día del cumpleaños
|-
| cumplea_mes || Int || NO || Mes del cumpleaños
|-
| cumplea_ano || Int || NO || Año del cumpleaños
|-
| genero || String || NO || Género del tercero (M=Masculino, F=Femenino)
|-
| 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
|-
| camposPersonalizados || Objeto || NO || Objeto con la información de campos personalizados
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 terceros"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Saldo Inventario(GET) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/BIInventarioContabilidad/SaldoInventario

'''EndPoint Con Parametros:'''
https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/Contabilidad?grupo=11&año_desde=2019&año_hasta=2021

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"tipoidentidad": "CC",
"identificacion": "123456789",
"dv": 0,
"tipopersona": 2,
"primernombre": "PEDRO",
"segundonombre": "LUIS",
"primerapellido": "PEREZ",
"segundoapellido": "LOPEZ",
"nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
"razonsocial": null,
"escliente": true,
"esproveedor": true,
"esempleado": false,
"esvendedor": false,
"esotro": false,
"escobrador": false,
"cumple_dia": 0,
"cumplea_mes": 0,
"cumplea_ano": 0,
"genero": "N",
"direccion": "CRA 1 25 05",
"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"
! Campo !! Tipo !! Requerido !! Descripción
|-
| tipoidentidad || String || SI || Código del tipo de identidad
|-
| identificacion || String || SI || Número de identificación
|-
| dv || Int || SI || Digito de verificación
|-
| tipopersona || Int || SI || Código del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || String || SI (Si tipo persona=NATURAL) || Primer Nombre
|-
| segundonombre || String || NO || Segundo Nombre
|-
| primerapellido || String || SI (Si tipo persona=NATURAL) || Primer Apellido
|-
| segundoapellido || String || NO || Segundo Apellido
|-
| nombrecompleto || String || SI || Nombre Completo
|-
| razonsocial || String || SI (Si tipo persona=JURIDICO) || Razón Social
|-
| escliente || Bool || NO || Seleccionar si el tercero es cliente
|-
| esproveedor || Bool || NO || Seleccionar si el tercero es proveedor
|-
| esempleado || Bool || NO || Seleccionar si el tercero es empleado
|-
| esvendedor || Bool || NO || Seleccionar si el tercero es vendedor
|-
| esotro || Bool || NO || Seleccionar si el tercero es otro
|-
| escobrador || Bool || NO || Seleccionar si el tercero es cobrador
|-
| cumple_dia || Int || NO || Día del cumpleaños
|-
| cumplea_mes || Int || NO || Mes del cumpleaños
|-
| cumplea_ano || Int || NO || Año del cumpleaños
|-
| genero || String || NO || Género del tercero (M=Masculino, F=Femenino)
|-
| 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
|-
| camposPersonalizados || Objeto || NO || Objeto con la información de campos personalizados
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 terceros"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Movimiento Inventario (GET) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/BIInventarioContabilidad/MovimientoInventario

'''EndPoint Con Parametros:'''
https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/MovimientoInventario?grupo=11&año_desde=2019&año_hasta=2021

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"tipoidentidad": "CC",
"identificacion": "123456789",
"dv": 0,
"tipopersona": 2,
"primernombre": "PEDRO",
"segundonombre": "LUIS",
"primerapellido": "PEREZ",
"segundoapellido": "LOPEZ",
"nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
"razonsocial": null,
"escliente": true,
"esproveedor": true,
"esempleado": false,
"esvendedor": false,
"esotro": false,
"escobrador": false,
"cumple_dia": 0,
"cumplea_mes": 0,
"cumplea_ano": 0,
"genero": "N",
"direccion": "CRA 1 25 05",
"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"
! Campo !! Tipo !! Requerido !! Descripción
|-
| tipoidentidad || String || SI || Código del tipo de identidad
|-
| identificacion || String || SI || Número de identificación
|-
| dv || Int || SI || Digito de verificación
|-
| tipopersona || Int || SI || Código del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || String || SI (Si tipo persona=NATURAL) || Primer Nombre
|-
| segundonombre || String || NO || Segundo Nombre
|-
| primerapellido || String || SI (Si tipo persona=NATURAL) || Primer Apellido
|-
| segundoapellido || String || NO || Segundo Apellido
|-
| nombrecompleto || String || SI || Nombre Completo
|-
| razonsocial || String || SI (Si tipo persona=JURIDICO) || Razón Social
|-
| escliente || Bool || NO || Seleccionar si el tercero es cliente
|-
| esproveedor || Bool || NO || Seleccionar si el tercero es proveedor
|-
| esempleado || Bool || NO || Seleccionar si el tercero es empleado
|-
| esvendedor || Bool || NO || Seleccionar si el tercero es vendedor
|-
| esotro || Bool || NO || Seleccionar si el tercero es otro
|-
| escobrador || Bool || NO || Seleccionar si el tercero es cobrador
|-
| cumple_dia || Int || NO || Día del cumpleaños
|-
| cumplea_mes || Int || NO || Mes del cumpleaños
|-
| cumplea_ano || Int || NO || Año del cumpleaños
|-
| genero || String || NO || Género del tercero (M=Masculino, F=Femenino)
|-
| 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
|-
| camposPersonalizados || Objeto || NO || Objeto con la información de campos personalizados
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 terceros"
}
</syntaxhighlight>
</Tab>

</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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
|}

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://localhost:4444/api/v1/BIFlujoCajaPeriodo/FlujoCaja")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:4444/api/v1/BIFlujoCajaPeriodo/FlujoCaja");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:4444/api/v1/BIFlujoCajaPeriodo/FlujoCaja');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer {{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API BI Inventario vs Contabilidad

2023-12-18T22:09:08Z

Lmedina: /* Métodos */

'''Descripción:'''
PENDIENTE

'''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:'''
PENDIENTE

'''Tipos de peticiones:'''
GET

'''¿Cómo funciona?'''
PENDIENTE

== Métodos==
<Tabs>


<Tab name = "API Contabilidad Detalle (GET) ">

'''EndPoint:'''

https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/FlujoCaja

'''EndPoint Con Parametros:'''
https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/FlujoCaja?año=2020&esalterna=0

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

{| class="wikitable"
|+ 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'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"descrip_sub": "OPERATIVO",
"gdtempresaid1": 1,
"descripcion": "NOMINA, APORTES Y LIQUIDACIONES",
"gdtempresaid": 1,
"cate_flujo": "USO",
"gdtflujocajasubid": 1,
"gdtempresaid2": 1,
"numero": 4875,
"fecha": "2021-01-06T00:00:00",
"ano": 2021,
"mes": 1,
"periodo": "202101",
"semana": 1,
"debito": 0.00000,
"credito": 36440973.00000,
"movimiento": -36440973.00000,
"gdtcuentaid": 2114,
"gdtterceroid": 7345,
"gdtcentrocostoid": null,
"naturaleza": "C",
"valor": 36440973.00000,
"gdtflujocajaid": 4,
"detalle_mov": "NÓMINA DAVIENDA",
"gdttipodocid": 6,
"categoria_doc": "CE",
"prefjo": "CE",
"nom_documento": "COMPROBANTE DE EGRESO",
"nom_auxiliar": "DAVIVIENDA CTA CTE ",
"clase": 1,
"grupo": 11,
"cuenta": 1110,
"subcuenta": 111005,
"auxiliar": 11100501,
"nit": "901067734",
"dv": 4,
"nom_tercero": "DEMO2 - GIORGIO "
}
]
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|}
</Tab>


<Tab name = "API Balance(GET) ">

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/Contabilidad

'''EndPoint Con Parametros:'''
https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/Contabilidad?grupo=11&año_desde=2019&año_hasta=2021

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"tipoidentidad": "CC",
"identificacion": "123456789",
"dv": 0,
"tipopersona": 2,
"primernombre": "PEDRO",
"segundonombre": "LUIS",
"primerapellido": "PEREZ",
"segundoapellido": "LOPEZ",
"nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
"razonsocial": null,
"escliente": true,
"esproveedor": true,
"esempleado": false,
"esvendedor": false,
"esotro": false,
"escobrador": false,
"cumple_dia": 0,
"cumplea_mes": 0,
"cumplea_ano": 0,
"genero": "N",
"direccion": "CRA 1 25 05",
"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"
! Campo !! Tipo !! Requerido !! Descripción
|-
| tipoidentidad || String || SI || Código del tipo de identidad
|-
| identificacion || String || SI || Número de identificación
|-
| dv || Int || SI || Digito de verificación
|-
| tipopersona || Int || SI || Código del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || String || SI (Si tipo persona=NATURAL) || Primer Nombre
|-
| segundonombre || String || NO || Segundo Nombre
|-
| primerapellido || String || SI (Si tipo persona=NATURAL) || Primer Apellido
|-
| segundoapellido || String || NO || Segundo Apellido
|-
| nombrecompleto || String || SI || Nombre Completo
|-
| razonsocial || String || SI (Si tipo persona=JURIDICO) || Razón Social
|-
| escliente || Bool || NO || Seleccionar si el tercero es cliente
|-
| esproveedor || Bool || NO || Seleccionar si el tercero es proveedor
|-
| esempleado || Bool || NO || Seleccionar si el tercero es empleado
|-
| esvendedor || Bool || NO || Seleccionar si el tercero es vendedor
|-
| esotro || Bool || NO || Seleccionar si el tercero es otro
|-
| escobrador || Bool || NO || Seleccionar si el tercero es cobrador
|-
| cumple_dia || Int || NO || Día del cumpleaños
|-
| cumplea_mes || Int || NO || Mes del cumpleaños
|-
| cumplea_ano || Int || NO || Año del cumpleaños
|-
| genero || String || NO || Género del tercero (M=Masculino, F=Femenino)
|-
| 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
|-
| camposPersonalizados || Objeto || NO || Objeto con la información de campos personalizados
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 terceros"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Saldo Inventario(GET) ">

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/BIInventarioContabilidad/SaldoInventario

'''EndPoint Con Parametros:'''
https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/Contabilidad?grupo=11&año_desde=2019&año_hasta=2021

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"tipoidentidad": "CC",
"identificacion": "123456789",
"dv": 0,
"tipopersona": 2,
"primernombre": "PEDRO",
"segundonombre": "LUIS",
"primerapellido": "PEREZ",
"segundoapellido": "LOPEZ",
"nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
"razonsocial": null,
"escliente": true,
"esproveedor": true,
"esempleado": false,
"esvendedor": false,
"esotro": false,
"escobrador": false,
"cumple_dia": 0,
"cumplea_mes": 0,
"cumplea_ano": 0,
"genero": "N",
"direccion": "CRA 1 25 05",
"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"
! Campo !! Tipo !! Requerido !! Descripción
|-
| tipoidentidad || String || SI || Código del tipo de identidad
|-
| identificacion || String || SI || Número de identificación
|-
| dv || Int || SI || Digito de verificación
|-
| tipopersona || Int || SI || Código del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || String || SI (Si tipo persona=NATURAL) || Primer Nombre
|-
| segundonombre || String || NO || Segundo Nombre
|-
| primerapellido || String || SI (Si tipo persona=NATURAL) || Primer Apellido
|-
| segundoapellido || String || NO || Segundo Apellido
|-
| nombrecompleto || String || SI || Nombre Completo
|-
| razonsocial || String || SI (Si tipo persona=JURIDICO) || Razón Social
|-
| escliente || Bool || NO || Seleccionar si el tercero es cliente
|-
| esproveedor || Bool || NO || Seleccionar si el tercero es proveedor
|-
| esempleado || Bool || NO || Seleccionar si el tercero es empleado
|-
| esvendedor || Bool || NO || Seleccionar si el tercero es vendedor
|-
| esotro || Bool || NO || Seleccionar si el tercero es otro
|-
| escobrador || Bool || NO || Seleccionar si el tercero es cobrador
|-
| cumple_dia || Int || NO || Día del cumpleaños
|-
| cumplea_mes || Int || NO || Mes del cumpleaños
|-
| cumplea_ano || Int || NO || Año del cumpleaños
|-
| genero || String || NO || Género del tercero (M=Masculino, F=Femenino)
|-
| 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
|-
| camposPersonalizados || Objeto || NO || Objeto con la información de campos personalizados
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 terceros"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Movimiento Inventario (GET) ">

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/BIInventarioContabilidad/MovimientoInventario

'''EndPoint Con Parametros:'''
https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/MovimientoInventario?grupo=11&año_desde=2019&año_hasta=2021

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"tipoidentidad": "CC",
"identificacion": "123456789",
"dv": 0,
"tipopersona": 2,
"primernombre": "PEDRO",
"segundonombre": "LUIS",
"primerapellido": "PEREZ",
"segundoapellido": "LOPEZ",
"nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
"razonsocial": null,
"escliente": true,
"esproveedor": true,
"esempleado": false,
"esvendedor": false,
"esotro": false,
"escobrador": false,
"cumple_dia": 0,
"cumplea_mes": 0,
"cumplea_ano": 0,
"genero": "N",
"direccion": "CRA 1 25 05",
"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"
! Campo !! Tipo !! Requerido !! Descripción
|-
| tipoidentidad || String || SI || Código del tipo de identidad
|-
| identificacion || String || SI || Número de identificación
|-
| dv || Int || SI || Digito de verificación
|-
| tipopersona || Int || SI || Código del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || String || SI (Si tipo persona=NATURAL) || Primer Nombre
|-
| segundonombre || String || NO || Segundo Nombre
|-
| primerapellido || String || SI (Si tipo persona=NATURAL) || Primer Apellido
|-
| segundoapellido || String || NO || Segundo Apellido
|-
| nombrecompleto || String || SI || Nombre Completo
|-
| razonsocial || String || SI (Si tipo persona=JURIDICO) || Razón Social
|-
| escliente || Bool || NO || Seleccionar si el tercero es cliente
|-
| esproveedor || Bool || NO || Seleccionar si el tercero es proveedor
|-
| esempleado || Bool || NO || Seleccionar si el tercero es empleado
|-
| esvendedor || Bool || NO || Seleccionar si el tercero es vendedor
|-
| esotro || Bool || NO || Seleccionar si el tercero es otro
|-
| escobrador || Bool || NO || Seleccionar si el tercero es cobrador
|-
| cumple_dia || Int || NO || Día del cumpleaños
|-
| cumplea_mes || Int || NO || Mes del cumpleaños
|-
| cumplea_ano || Int || NO || Año del cumpleaños
|-
| genero || String || NO || Género del tercero (M=Masculino, F=Femenino)
|-
| 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
|-
| camposPersonalizados || Objeto || NO || Objeto con la información de campos personalizados
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 terceros"
}
</syntaxhighlight>
</Tab>

</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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
|}

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://localhost:4444/api/v1/BIFlujoCajaPeriodo/FlujoCaja")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:4444/api/v1/BIFlujoCajaPeriodo/FlujoCaja");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:4444/api/v1/BIFlujoCajaPeriodo/FlujoCaja');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer {{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API BI Inventario vs Contabilidad

2023-12-18T22:06:10Z

Lmedina: /* Métodos */

'''Descripción:'''
PENDIENTE

'''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:'''
PENDIENTE

'''Tipos de peticiones:'''
GET

'''¿Cómo funciona?'''
PENDIENTE

== Métodos==
<Tabs>


<Tab name = "API Contabilidad Detalle (GET) ">

'''EndPoint:'''

https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/FlujoCaja

'''EndPoint Con Parametros:'''
https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/FlujoCaja?año=2020&esalterna=0

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

{| class="wikitable"
|+ 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'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"descrip_sub": "OPERATIVO",
"gdtempresaid1": 1,
"descripcion": "NOMINA, APORTES Y LIQUIDACIONES",
"gdtempresaid": 1,
"cate_flujo": "USO",
"gdtflujocajasubid": 1,
"gdtempresaid2": 1,
"numero": 4875,
"fecha": "2021-01-06T00:00:00",
"ano": 2021,
"mes": 1,
"periodo": "202101",
"semana": 1,
"debito": 0.00000,
"credito": 36440973.00000,
"movimiento": -36440973.00000,
"gdtcuentaid": 2114,
"gdtterceroid": 7345,
"gdtcentrocostoid": null,
"naturaleza": "C",
"valor": 36440973.00000,
"gdtflujocajaid": 4,
"detalle_mov": "NÓMINA DAVIENDA",
"gdttipodocid": 6,
"categoria_doc": "CE",
"prefjo": "CE",
"nom_documento": "COMPROBANTE DE EGRESO",
"nom_auxiliar": "DAVIVIENDA CTA CTE ",
"clase": 1,
"grupo": 11,
"cuenta": 1110,
"subcuenta": 111005,
"auxiliar": 11100501,
"nit": "901067734",
"dv": 4,
"nom_tercero": "DEMO2 - GIORGIO "
}
]
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|-
| id || int || Identificador del país
|-
| nombre || string || Nombre del país
|-
| codigo || string || Código del país
|-
| codigo_alfa || string || Nomenclatura del país
|}
</Tab>


<Tab name = "API Balance(GET) ">

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/Contabilidad

'''EndPoint Con Parametros:'''
https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/Contabilidad?grupo=11&año_desde=2019&año_hasta=2021

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"tipoidentidad": "CC",
"identificacion": "123456789",
"dv": 0,
"tipopersona": 2,
"primernombre": "PEDRO",
"segundonombre": "LUIS",
"primerapellido": "PEREZ",
"segundoapellido": "LOPEZ",
"nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
"razonsocial": null,
"escliente": true,
"esproveedor": true,
"esempleado": false,
"esvendedor": false,
"esotro": false,
"escobrador": false,
"cumple_dia": 0,
"cumplea_mes": 0,
"cumplea_ano": 0,
"genero": "N",
"direccion": "CRA 1 25 05",
"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"
! Campo !! Tipo !! Requerido !! Descripción
|-
| tipoidentidad || String || SI || Código del tipo de identidad
|-
| identificacion || String || SI || Número de identificación
|-
| dv || Int || SI || Digito de verificación
|-
| tipopersona || Int || SI || Código del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || String || SI (Si tipo persona=NATURAL) || Primer Nombre
|-
| segundonombre || String || NO || Segundo Nombre
|-
| primerapellido || String || SI (Si tipo persona=NATURAL) || Primer Apellido
|-
| segundoapellido || String || NO || Segundo Apellido
|-
| nombrecompleto || String || SI || Nombre Completo
|-
| razonsocial || String || SI (Si tipo persona=JURIDICO) || Razón Social
|-
| escliente || Bool || NO || Seleccionar si el tercero es cliente
|-
| esproveedor || Bool || NO || Seleccionar si el tercero es proveedor
|-
| esempleado || Bool || NO || Seleccionar si el tercero es empleado
|-
| esvendedor || Bool || NO || Seleccionar si el tercero es vendedor
|-
| esotro || Bool || NO || Seleccionar si el tercero es otro
|-
| escobrador || Bool || NO || Seleccionar si el tercero es cobrador
|-
| cumple_dia || Int || NO || Día del cumpleaños
|-
| cumplea_mes || Int || NO || Mes del cumpleaños
|-
| cumplea_ano || Int || NO || Año del cumpleaños
|-
| genero || String || NO || Género del tercero (M=Masculino, F=Femenino)
|-
| 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
|-
| camposPersonalizados || Objeto || NO || Objeto con la información de campos personalizados
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 terceros"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Saldo Inventario(GET) ">

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/BIInventarioContabilidad/SaldoInventario

'''EndPoint Con Parametros:'''
https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/Contabilidad?grupo=11&año_desde=2019&año_hasta=2021

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"tipoidentidad": "CC",
"identificacion": "123456789",
"dv": 0,
"tipopersona": 2,
"primernombre": "PEDRO",
"segundonombre": "LUIS",
"primerapellido": "PEREZ",
"segundoapellido": "LOPEZ",
"nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
"razonsocial": null,
"escliente": true,
"esproveedor": true,
"esempleado": false,
"esvendedor": false,
"esotro": false,
"escobrador": false,
"cumple_dia": 0,
"cumplea_mes": 0,
"cumplea_ano": 0,
"genero": "N",
"direccion": "CRA 1 25 05",
"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"
! Campo !! Tipo !! Requerido !! Descripción
|-
| tipoidentidad || String || SI || Código del tipo de identidad
|-
| identificacion || String || SI || Número de identificación
|-
| dv || Int || SI || Digito de verificación
|-
| tipopersona || Int || SI || Código del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || String || SI (Si tipo persona=NATURAL) || Primer Nombre
|-
| segundonombre || String || NO || Segundo Nombre
|-
| primerapellido || String || SI (Si tipo persona=NATURAL) || Primer Apellido
|-
| segundoapellido || String || NO || Segundo Apellido
|-
| nombrecompleto || String || SI || Nombre Completo
|-
| razonsocial || String || SI (Si tipo persona=JURIDICO) || Razón Social
|-
| escliente || Bool || NO || Seleccionar si el tercero es cliente
|-
| esproveedor || Bool || NO || Seleccionar si el tercero es proveedor
|-
| esempleado || Bool || NO || Seleccionar si el tercero es empleado
|-
| esvendedor || Bool || NO || Seleccionar si el tercero es vendedor
|-
| esotro || Bool || NO || Seleccionar si el tercero es otro
|-
| escobrador || Bool || NO || Seleccionar si el tercero es cobrador
|-
| cumple_dia || Int || NO || Día del cumpleaños
|-
| cumplea_mes || Int || NO || Mes del cumpleaños
|-
| cumplea_ano || Int || NO || Año del cumpleaños
|-
| genero || String || NO || Género del tercero (M=Masculino, F=Femenino)
|-
| 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
|-
| camposPersonalizados || Objeto || NO || Objeto con la información de campos personalizados
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 terceros"
}
</syntaxhighlight>
</Tab>

</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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
|}

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://localhost:4444/api/v1/BIFlujoCajaPeriodo/FlujoCaja")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:4444/api/v1/BIFlujoCajaPeriodo/FlujoCaja");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:4444/api/v1/BIFlujoCajaPeriodo/FlujoCaja');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer {{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API BI Inventario vs Contabilidad

2023-12-18T22:00:32Z

Lmedina: Página creada con «'''Descripción:''' PENDIENTE '''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:''' PENDIENTE '''Tipos de peticiones:''' GET '''¿Cómo funciona?''' PENDIENTE == Métodos== <Tabs> <!-- **************************************************************…»

API BI Flujo de Caja

2023-12-18T21:56:21Z

Lmedina: /* Métodos */

API BI Venta Detalle

2023-12-18T21:32:10Z

Lmedina: /* ¿Cómo consumir la API? */

API BI Venta Detalle

2023-12-18T21:27:29Z

Lmedina: Página creada con «'''Descripción:''' PENDIENTE '''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:''' PENDIENTE '''Tipos de peticiones:''' GET '''¿Cómo funciona?''' PENDIENTE == Métodos == <Tabs> <!-- **************************************************************…»

API BI

2023-12-18T21:11:10Z

Lmedina:

Esta es la documentación sobre las APIs relacionadas al '''BI (Business Intelligence)'''

* [[API BI_Cartera| API BI-Cartera]]

* [[API BI_Flujo de Caja| API BI-Flujo de Caja]]

* [[API BI_Inventario vs Contabilidad | API BI_Inventario vs Contabilidad]]

* [[API BI_Venta Detalle| API BI_Venta Detalle]]

API BI

Lmedina:

'''Descripción:'''
Este conjunto de APIs esta dispuesto con el fin de consultar, agregar y modificar los datos correspondientes

'''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 API permite.

'''Tipos de peticiones:'''
GET,

'''¿Cómo funciona?'''
*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) ">
'''GET/users'''

'''EndPoint:'''
https://localhost:44305/api/v1/BICartera

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/BICartera?centroopeid=1&terceroid=10707&cuentaid=2358&fechacorte=2023-12-31&cuenta=2815&grupo=28&limite=100&pagina=1

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Parámetros'''
{| class="wikitable"
! 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
|-
| centroopeid|| int || No || Cedula o nit del tercero a filtrar
|-
| terceroid|| int|| No || Fecha inicial para filtrar por fecha de creación del tercero
|-
| cuentaid|| int|| No || Fecha final para filtrar por fecha de creación del tercero
|-
| fechacorte|| Date || No || Fecha final para filtrar por fecha de creación del tercero
|-
| cuenta|| Date || No || Fecha final para filtrar por fecha de creación del tercero
|-
| grupo|| Date || No || Fecha final para filtrar por fecha de creación del tercero
|}

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true
"code": 200,
"message": "x registro(s) encontrados",
"result": [
{
"id": 1,
"tipoidentidad": "CC",
"identificacion": "123456789",
"dv": 0,
"tipopersona": 2,
"primernombre": "PEDRO",
"segundonombre": "LUIS",
"primerapellido": "PEREZ",
"segundoapellido": "LOPEZ",
"nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
"razonsocial": null,
"escliente": true,
"esproveedor": true,
"esempleado": false,
"esvendedor": false,
"esotro": false,
"escobrador": false,
"cumple_dia": 0,
"cumplea_mes": 0,
"cumplea_ano": 0,
"genero": "N",
"direccion": "CRA 1 25 05",
"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,
"camposPersonalizados": {
"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,
"code": 204,
"message": "No se encontraron registros",
}

{
"success": false,
"code": 400,
"message": "El formato de las fechas es invalido. Ejemplo 2023-12-31",
}

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| Id || int || Corresponde al identificador del tercero
|-
| 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
|-
| movil || string || Numero de movil celular
|-
| pais || string || Nombre pais
|-
| departamento || string || Nombre del departamento
|-
| ciudad || string || Nombre de la ciudad
|-
| codciudad || string || Codigo unico de la ciudad
|-
| zona || int || id de la zona
|-
| email || string || cuenta de email
|-
| activo || bool || Estado del tercero (true=Activo, false=Inactivo)
|-
| cupocredito || decimal || Cupo de credito
|-
| periodopago || int || Periodo de pago en dias para el vencimiento de facturas de venta
|-
| codigociiu || string || Codigo CIIU, Actividades economicas
|-
| descuentoventa || decimal || Porcentaje para el descuento en ventas
|-
| categoriatercero || int || Id de la categoria de tercero
|-
| formapago || int || Id de la forma pago
|-
| listaprecios || int || Id de la lista de precios
|-
| grupoventas || int || Id del grupo de retenciones para ventas
|-
| grupocompras || int || Id del grupo de retenciones para compras
|-
| vendedor || int || Numero de identificacion del vendedor
|-
| cobrador || int || Numero de identificacion del cobrador
|-
| fechacreacion || string || Fecha de creacion del tercero. Ejemplo "2020-05-20 00:00:00"
|-
| regimen || int || Id del regimen tributario
|-
| 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
|-
| camposPersonalizados || Objeto || Objeto con la informacion de campos personalizados
|}
</Tab>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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
|}

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://localhost:44305/api/v1/Tercero")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/Tercero");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/Tercero');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API BI Cartera

2023-12-11T15:51:23Z

Lmedina: Página creada con «'''Descripción:''' Este conjunto de APIs esta dispuesto con el fin de consultar, agregar y modificar los datos correspondientes a terceros en SERPI, como terceros se consideran diferentes actores del procesos como clientes, empleados, vendedores, proveedores y otros. '''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 Authoriza…»

'''Descripción:'''
Este conjunto de APIs esta dispuesto con el fin de consultar, agregar y modificar los datos correspondientes a terceros en SERPI, como terceros se consideran diferentes actores del procesos como clientes, empleados, vendedores, proveedores y otros.

'''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 API permite tener sincronizada la información concerniente a terceros de su plataforma y SERPI .

'''Tipos de peticiones:'''
GET, POST, PUT

'''¿Cómo funciona?'''
*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) ">
'''GET/users'''

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

'''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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Parámetros'''
{| class="wikitable"
! 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
|-
| 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'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true
"code": 200,
"message": "x registro(s) encontrados",
"result": [
{
"id": 1,
"tipoidentidad": "CC",
"identificacion": "123456789",
"dv": 0,
"tipopersona": 2,
"primernombre": "PEDRO",
"segundonombre": "LUIS",
"primerapellido": "PEREZ",
"segundoapellido": "LOPEZ",
"nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
"razonsocial": null,
"escliente": true,
"esproveedor": true,
"esempleado": false,
"esvendedor": false,
"esotro": false,
"escobrador": false,
"cumple_dia": 0,
"cumplea_mes": 0,
"cumplea_ano": 0,
"genero": "N",
"direccion": "CRA 1 25 05",
"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,
"camposPersonalizados": {
"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,
"code": 204,
"message": "No se encontraron registros",
}

{
"success": false,
"code": 400,
"message": "El formato de las fechas es invalido. Ejemplo 2023-01-20 00:00:00",
}

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| Id || int || Corresponde al identificador del tercero
|-
| 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
|-
| movil || string || Numero de movil celular
|-
| pais || string || Nombre pais
|-
| departamento || string || Nombre del departamento
|-
| ciudad || string || Nombre de la ciudad
|-
| codciudad || string || Codigo unico de la ciudad
|-
| zona || int || id de la zona
|-
| email || string || cuenta de email
|-
| activo || bool || Estado del tercero (true=Activo, false=Inactivo)
|-
| cupocredito || decimal || Cupo de credito
|-
| periodopago || int || Periodo de pago en dias para el vencimiento de facturas de venta
|-
| codigociiu || string || Codigo CIIU, Actividades economicas
|-
| descuentoventa || decimal || Porcentaje para el descuento en ventas
|-
| categoriatercero || int || Id de la categoria de tercero
|-
| formapago || int || Id de la forma pago
|-
| listaprecios || int || Id de la lista de precios
|-
| grupoventas || int || Id del grupo de retenciones para ventas
|-
| grupocompras || int || Id del grupo de retenciones para compras
|-
| vendedor || int || Numero de identificacion del vendedor
|-
| cobrador || int || Numero de identificacion del cobrador
|-
| fechacreacion || string || Fecha de creacion del tercero. Ejemplo "2020-05-20 00:00:00"
|-
| regimen || int || Id del regimen tributario
|-
| 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
|-
| camposPersonalizados || Objeto || Objeto con la informacion de campos personalizados
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''POST /users'''

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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"tipoidentidad": "CC",
"identificacion": "123456789",
"dv": 0,
"tipopersona": 2,
"primernombre": "PEDRO",
"segundonombre": "LUIS",
"primerapellido": "PEREZ",
"segundoapellido": "LOPEZ",
"nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
"razonsocial": null,
"escliente": true,
"esproveedor": true,
"esempleado": false,
"esvendedor": false,
"esotro": false,
"escobrador": false,
"cumple_dia": 0,
"cumplea_mes": 0,
"cumplea_ano": 0,
"genero": "N",
"direccion": "CRA 1 25 05",
"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"
! Campo !! Tipo !! Requerido !! Descripción
|-
| tipoidentidad || String || SI || Código del tipo de identidad
|-
| identificacion || String || SI || Número de identificación
|-
| dv || Int || SI || Digito de verificación
|-
| tipopersona || Int || SI || Código del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || String || SI (Si tipo persona=NATURAL) || Primer Nombre
|-
| segundonombre || String || NO || Segundo Nombre
|-
| primerapellido || String || SI (Si tipo persona=NATURAL) || Primer Apellido
|-
| segundoapellido || String || NO || Segundo Apellido
|-
| nombrecompleto || String || SI || Nombre Completo
|-
| razonsocial || String || SI (Si tipo persona=JURIDICO) || Razón Social
|-
| escliente || Bool || NO || Seleccionar si el tercero es cliente
|-
| esproveedor || Bool || NO || Seleccionar si el tercero es proveedor
|-
| esempleado || Bool || NO || Seleccionar si el tercero es empleado
|-
| esvendedor || Bool || NO || Seleccionar si el tercero es vendedor
|-
| esotro || Bool || NO || Seleccionar si el tercero es otro
|-
| escobrador || Bool || NO || Seleccionar si el tercero es cobrador
|-
| cumple_dia || Int || NO || Día del cumpleaños
|-
| cumplea_mes || Int || NO || Mes del cumpleaños
|-
| cumplea_ano || Int || NO || Año del cumpleaños
|-
| genero || String || NO || Género del tercero (M=Masculino, F=Femenino)
|-
| 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
|-
| camposPersonalizados || Objeto || NO || Objeto con la información de campos personalizados
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 terceros"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''PUT/users'''

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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"id": 1,
"tipoidentidad": "CC",
"identificacion": "123456789",
"dv": 0,
"tipopersona": 2,
"primernombre": "PEDRO",
"segundonombre": "LUIS",
"primerapellido": "PEREZ",
"segundoapellido": "LOPEZ",
"nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
"razonsocial": null,
"escliente": true,
"esproveedor": true,
"esempleado": false,
"esvendedor": false,
"esotro": false,
"escobrador": false,
"cumple_dia": 0,
"cumplea_mes": 0,
"cumplea_ano": 0,
"genero": "N",
"direccion": "CRA 1 25 05",
"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 left"
! Campo !! Tipo !! Longitud !! Requerido !! Descripción
|-
| tipoidentidad || String || 50 || SI || Código del tipo de identidad
|-
| identificacion || String || 50 || SI || Número de identificación
|-
| dv || Int || 50 || SI || Digito de verificación
|-
| tipopersona || 50 || Int || SI || Código del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || String || 50 || SI (Si tipo persona=NATURAL) || Primer Nombre
|-
| segundonombre || String || 50 || NO || Segundo Nombre
|-
| primerapellido || String || 50 || SI (Si tipo persona=NATURAL) || Primer Apellido
|-
| segundoapellido || String || 50 || NO || Segundo Apellido
|-
| nombrecompleto || String || 50 || SI || Nombre Completo
|-
| razonsocial || String || 50 || SI (Si tipo persona=JURIDICO) || Razón Social
|-
| escliente || Bool || 50 || NO || Seleccionar si el tercero es cliente
|-
| esproveedor || Bool || 50 || NO || Seleccionar si el tercero es proveedor
|-
| esempleado || Bool || 50 || NO || Seleccionar si el tercero es empleado
|-
| esvendedor || Bool || 50 || NO || Seleccionar si el tercero es vendedor
|-
| esotro || Bool || 50 || NO || Seleccionar si el tercero es otro
|-
| escobrador || Bool || 50 || NO || Seleccionar si el tercero es cobrador
|-
| cumple_dia || Int || 50 || NO || Día del cumpleaños
|-
| cumplea_mes || Int || 50 || NO || Mes del cumpleaños
|-
| cumplea_ano || Int || 50 || NO || Año del cumpleaños
|-
| genero || String || 50 || NO || Género del tercero (M=Masculino, F=Femenino)
|-
| direccion || String || 50 || SI || Dirección
|-
| direccion2 || String || 50 || NO || Dirección complementaria
|-
| telefono || String || 50 || NO || Número de teléfono
|-
| ext || Int || 50 || NO || Número de extensión
|-
| movil || String || 50 || SI || Número de móvil celular
|-
| pais || String || 50 || Informativo || Nombre País
|-
| departamento || String || 50 || Informativo || Nombre del departamento
|-
| ciudad || String || 50 || Informativo || Nombre de la ciudad
|-
| codciudad || String || 50 || SI || Código único de la ciudad
|-
| zona || Int || 50 || NO || ID de la zona
|-
| email || String || 50 || SI || Cuenta de email
|-
| activo || Bool || 50 || SI || Estado del tercero (true=Activo, false=Inactivo)
|-
| cupocredito || Decimal || 50 || NO || Cupo de crédito
|-
| periodopago || Int || 50 || NO || Período de pago en días para el vencimiento de facturas de venta
|-
| codigociiu || String || 50 || NO || Código CIIU, Actividades económicas
|-
| descuentoventa || Decimal || 50 || NO || Porcentaje para el descuento en ventas
|-
| categoriatercero || Int || 50 || SI || ID de la categoría de terceros
|-
| formapago || Int || 50 || NO || ID de la forma de pago
|-
| listaprecios || Int || 50 || NO || ID de la lista de precios
|-
| grupoventas || Int || 50 || SI || ID del grupo de retenciones para ventas
|-
| grupocompras || Int || 50 || SI || ID del grupo de retenciones para compras
|-
| vendedor || Int || 50 || NO || Número de identificación del vendedor
|-
| cobrador || Int || 50 || NO || Número de identificación del cobrador
|-
| fechacreacion || String || 50 || NO || Fecha de creación del tercero. Ejemplo "2020-05-20 00:00:00"
|-
| regimen || Int || 50 || SI || ID del régimen tributario
|-
| banco || Int || 50 || NO || ID del banco
|-
| tipo_cuenta || String || 50 || NO || Tipo cuenta bancaria. (A=Cuenta de Ahorro, B=Cuenta Corriente)
|-
| cuenta_bancaria || String || 50 || NO || Número de cuenta bancaria
|-
| limite_credito || Decimal || 50 || NO || Límite del crédito
|-
| camposPersonalizados || Objeto || 50 || NO || Objeto con la información de campos personalizados
|}

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

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

{
"success": false,
"code": 400,
"errors": [
"El campo abreviatura es obligatorio"
],
"message": "Se presentaron errores al modificar el registro"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id xx"
}
</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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
|}

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://localhost:44305/api/v1/Tercero")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/Tercero");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/Tercero');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API BI

2023-12-11T15:48:26Z

Lmedina:

Esta es la documentación sobre las APIs relacionadas al '''BI (Business Intelligence)'''

* [[API BI_Cartera| API BI - Cartera]]

API Terceros/Categoria Terceros

2023-06-21T13:58:20Z

Lmedina: /* Métodos */

'''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) ">
'''GET/users'''

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

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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Parámetros'''
{| class="wikitable"
! 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'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true
"code": 200,
"message": "x registro(s) encontrados",
"result": [
{
"id": 1,
"descripcion": "TERCEROS",
"cxc_cliente": 13050501,
"descripcion_cxc_cliente": "CLIENTES INSTITUCIONALES",
"cxc_proveedor": 22050501,
"descripcion_cxc_proveedor": "PROVEEDORES NACIONALES"

}
]
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| Id || int || Corresponde al identificador la categoría tercero
|-
| Descripcion || string || Describe la categoría.
|-
| cxc_cliente|| int || Corresponde al código de la cuenta
|-
| cxc_proveedor|| string || Corresponde al código de la cuenta

|}
</Tab>


<Tab name = "API Creación (POST) ">
'''POST'''

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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"descripcion": "TERCERO EXTERIOR 100",
"cxc_cliente": 11050501,
"cxc_proveedor": 22100101

}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| descripcion || string || 100 || SI || Describe la categoría del tercero
|-
| cxc_cliente || int || 20 || SI || Cuenta Por Cobrar Cliente
|-
| cxc_proveedor|| int || 20 || SI || Cuenta Por Pagar Proveedor
|}

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

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

}
{
"success": false,
"code": 400,
"errors": [
"El campo descripcion es obligatorio",
"El campo cxc_cliente 1105050 no existe",
"El campo cxc_proveedor 2210010 no existe"
],
"message": "Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''PUT'''

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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 1
"descripcion": "categoria terceros ",
"cxc_cliente": 11050501,
"cxc_proveedor": 11050501

}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || SI || Hace referencia al id que vamos a hacer la edición
|-
| descripcion|| string || 50 || SI || Describe la categoría del tercero
|-
| cxc_cliente|| int || 20 || SI || Cuenta Por Cobrar Cliente
|-
| cxc_proveedor|| int|| 20 || SI || Cuenta Por Pagar Proveedor
|}

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

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

{
"success": false,
"code": 400,
"errors": [
"El campo descripcion es obligatorio",
"El campo cxc_cliente 110505019 no existe",
"El campo cxc_proveedor 110505019 no existe"
],
"message": "Se presentaron errores al modificar el registro"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id xx"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://localhost:44305/api/v1/CategoriaTercero")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/CategoriaTercero");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/CategoriaTercero');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

''' Observaciones '''
{| class="wikitable left"
! Campos !! Descripción
|-
| cxc_cliente || Cuenta Por Cobrar Cliente ,se bebe enviar el numero de la cuenta como, 11050501
|-
| cxc_proveedor || Cuenta Por Pagar Proveedor ,se bebe enviar el numero de la cuenta como ,11050200
|-
| id || NO se debe enviar el numero identificador de la cuenta.

|}

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]

API Terceros/Forma Pago

2023-06-20T16:53:18Z

Lmedina: /* Métodos */

'''Descripción:'''
Esta API permite la sincronizacion de Formas de pago para los procesos de ventas entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estándar entre las dos plataformas.

'''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:'''

'''Tipos de peticiones:'''
GET, POST, PUT

'''¿Cómo funciona?'''
*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) ">
'''GET'''

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

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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Parámetros'''
{| class="wikitable"
! 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'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true
"code": 200,
"message": "x registro(s) encontrados",
"result": [
{
"id": 1,
"cuenta": 15120501,
"descripcion_cuenta": "MAQUINARIA Y EQUIPO",
"descripcion_fomapago": "PRUEBAS D",
"tipo": "PRUEBAS T",
"informacion_banco": null,
"dias": null,
"aplicafactura": false,
"aplicapuntopago": false,
"tercuenta": false,
"id_formapago_categoria": 1,
"categoria": "CR",
"descripcion_formapago_categoria": "CREDITO"
}
]
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| Id || int || Corresponde al identificador del tipo de identidad
|-
| auxiliar|| int|| Corresponde al código de la cuenta
|-
| descripcion_cuenta|| string || Descripción tipo de cuenta.
|-
| descripcion_fomapago|| string || Descripción de la forma de pago
|-
| tipo|| string || Descripción del tipo de cuenta o acrónimo de la cuenta
|-
| informacion_banco|| string || Descripción del tipo de banco.
|-
| dias|| int|| Dias
|-
| aplicafactura|| bool|| true o false. Si aplica factura
|-
| aplicapuntopago|| bool || true o false. Si el aplica punto de pago
|-
| tercuenta|| bool || true o false. Si el aplica cuenta tercero
|-
| id_formapago_categoria || int || Corresponde al identificador de la categoría forma de pago
|-
| categoria|| string || Abreviatura3 Categoria forma pago
|-
| descripcion_formapago_categoria|| string || Descripción de la categoría forma de pago

|}
</Tab>


<Tab name = "API Creación (POST) ">
'''POST'''

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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id_formapago_categoria" : 4,
"tipo": "p false",
"descripcion_fomapago": "forma false",
"tercuenta": true,
"cuenta": 11050501,
"aplicafactura": true,
"aplicapuntopago": true
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| gdtformapagocatid|| int|| 11 || SI || Identificador único del tipo de categoría para la forma de pago , si es crédito , debito ,contado
|-
| tipo|| string || 100 || SI || tipo de forma de pago como CO. DE, CR
|-
| descripcion_fomapago|| string || 50 || SI || Descripción del tipo de forma de pago
|-
| tercuenta|| bool || 1 || SI || true o false. toma la Cuenta por Cobrar, Tomarla del Tercero y al numero auxiliar
|-
| auxiliar|| string || 15 || NO || Código auxilita de la cuenta, hace referencia a tercuenta según su estado true o false
|-
| aplicafactura|| bool || 1|| NO || true o false. si aplica factura
|-
| aplicapuntopago|| bool || 1|| NO || true o false. si aplica punto pago

|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">

{
"success": true,
"code": 201,
"errors": null,
"message": "registro creado exitosamente"
}
{
"success": false,
"code": 400,
"errors": [
"La cuenta 110505019 no existe"
],
"message": "Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''PUT/users'''

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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 39,
"descripcion_fomapago": "PRUEBAS",
"tipo": "PR",
"tercuenta": false,
"auxiliar": 11050501,
"aplicafactura": false,
"aplicapuntopago": true,
"gdtformapagocatid": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || Corresponde al identificador de la forma de pago
|-
| descripcion_fomapago|| string || 50 || SI || Descripción del tipo de forma de pago
|-
| tipo|| string || 50 || SI || Descripcion tipo de forma pago
|-
| tercuenta || bool || 1 || NO || true o false. toma la Cuenta por Cobrar, Tomarla del Tercero y al numero auxiliar
|-
| auxiliar|| string || 50 || NO || Código auxilita de la cuenta, hace referencia a tercuenta según su estado true o false
|-
| aplicafactura|| string || 50 || NO || true o false. si aplica factura
|-
| aplicapuntopago|| bool || 50 || NO || true o false. si aplica punto pago
|-
| gdtformapagocatid|| int || 50 || SI || Identificador único del tipo de categoría para la forma de pago , si es crédito , debito ,contado
|}

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

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

{
"success": false,
"code": 400,
"errors": [
"El campo descripcion_fomapago es obligatorio"
],
"message": "Se presentaron errores al modificar el registro"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id xx"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
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();
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Python">
'''Request'''
<syntaxhighlight lang="java" line="1">
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)
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

</Tabs>

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]

API Articulos/Marcas

2023-06-20T16:45:55Z

Lmedina: /* ¿Cómo consumir la API? */

'''Descripción:'''
Esta API permite la sincronizacion de Marcas ligadas a los items entre SERPI y la plataforma que lo requiera.

'''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:'''

'''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) ">
'''GET'''

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

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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Parámetros'''
{| class="wikitable"
! 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
|}

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": null,
"message": "x registro(s) encontrados",
"result": [
{
"id": 1,
"codigo": "2",
"descripcion": "GASTOS ENVIO"
},
]

}

{
"success": true,
"code": 204,
"message": "No se encontraron registros",
}

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| Id || int || Corresponde al identificador de la marca
|-
| Código|| string || Corresponde al código de la marca
|-
| description|| string || Descripción de la marca
</Tab>


<Tab name = "API Creación (POST) ">
'''POST'''

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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"codigo" : "A08",
"descripcion": "PRUEBAS"
}

</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| código|| String || SI || Describe el código de la categoría
|-
| descripción|| String || SI || Descripción de la marca
|}

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

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

{
"success": false,
"code": 400,
"errors": [
"El codigo 44 ya existe"
],
"message": "Se presentaron errores al crear el registro"
}

</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''PUT'''

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

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 1,
"codigo": "2",
"descripcion": "GASTOS ENVIO "

}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || Corresponde al identificador de la marca
|-
| codigo|| string || 50 || SI || Describe el código de la marca
|-
| descripcion|| string || 50 || SI || Descripción de la marca
|}

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

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

{
"success": false,
"code": 400,
"errors": [
"El campo codigo es obligatorio"
],
"message": "Se presentaron errores al modificar el registro"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id xx"
}
{
"success": false,
"code": 400,
"errors": [
"La codigo 44 ya esta asociado al id 2"
],
"message": "Se presentaron errores al modificar el registro"
}

</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>
<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://localhost:44305/api/v1/marca")
.method("GET", body)
.addHeader("secretkey", "ABc-zaw3+7uio-*")
.addHeader("Authorization", "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4MDUwMjYzODYiLrl5NCdQfosUBqVeGfWGCXrVcsov2VFBNBiayWxK9Hq0Ws9gqz7egNQ")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>

</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="java" line="1">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/marca");
request.Headers.Add("secretkey", "ABc-xxsse3444.123");
request.Headers.Add("Authorization", "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4MDUwMjYzODYiLCJ1bmlxdWVfeGfWGCXrVcsov2VFBNBiayWxK9Hq0Ws9gqz7egNQ");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

</syntaxhighlight>

</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="java" line="1">

<?php
$client = new http\Client;
$request = new http\Client\Request;
$request->setRequestUrl('https://localhost:44305/api/v1/marca');
$request->setRequestMethod('GET');
$body = new http\Message\Body;
$request->setBody($body);
$request->setOptions(array());
$request->setHeaders(array(
'secretkey' => 'ABc-xyzas234*-.123',
'Authorization' => 'Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4MDUwMjYzODYiLHq0Ws9gqz7egNQ'
));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();

</syntaxhighlight>

</Tab>

</Tabs>

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]

2023-06-03T15:33:39Z

Lmedina: /* ¿Cómo consumir la API? */

'''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:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/CentroCosto</nowiki>

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/CentroCosto?limite=50&pagina=1</nowiki>

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

{| class="wikitable"
|+ 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'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"codigo": "01",
"abreviatura": "ADS",
"descripcion": "ADMINISTRACION"
}
]
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Identificador del centro de costo
|-
| codigo|| string || Abreviatura del centro de costo
|-
| abreviatura || string || Abreviatura del centro de costo
|-
| descripcion || string || Descripción del centro de costo
|}
</Tab>


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

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"codigo": "02",
"abreviatura": "VE",
"descripcion": "VENTAS"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo|| string || 5 || Si || Codigo unico de centro de costo
|-
| abreviatura || string || 5 || Si || Abreviatura unica del centro de costo
|-
| descripcion || string || 200 || Si || Descripción del centro de costo
|}

==== '''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'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [],
"message": "Validaciones exitosas. Registro creado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"La abreviatura CO1 ya existe",
"El campo descripcion es obligatorio",
"El codigo 957 ya existe",
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


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

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 1,
"codigo": "01",
"abreviatura": "ADS",
"descripcion": "ADMINISTRACION"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || Si || Identificador del centro de costo
|-
| codigo|| string || 5 || Si || Codigo unico de centro de costo
|-
| abreviatura || string || 5 || Si || Abreviatura unica del centro de costo
|-
| descripcion || string || 200 || Si || Descripción del centro de costo
|}

==== '''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'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Validaciones exitosas. Registro modificado exitosamente"
}

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

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"La abreviatura CO1 ya esta asociado al id x",
"El campo descripcion es obligatorio",
],
"message": "Problemas de validaciones. Se presentaron errores al modificar el registro"
}
</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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
|}

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://localhost:44305/api/v1/CentroCosto")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/CentroCosto");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/CentroCosto');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]