API Terceros/Forma Pago - Historial de revisiones

Nalzate en 14:01 30 oct 2023

2023-10-30T14:01:55Z

@@ Línea 284: / Línea 284: @@
 </Tab>
 </Tabs>
 == ¿Cómo consumir la API? ==
@@ Línea 356: / Línea 381: @@
 </Tabs>
 [[Category:Documentación APIs]]
 <!-- [[Category:Pages with syntax highlighting errors]] -->

Nalzate: /* Métodos */

2023-09-07T21:35:20Z

Métodos

← Revisión anterior		Revisión del 16:35 7 sep 2023
Línea 66:		Línea 66:
	"id_formapago_categoria": 1,		"id_formapago_categoria": 1,
	"categoria": "CR",		"categoria": "CR",
	"descripcion_formapago_categoria": "CREDITO"		"descripcion_formapago_categoria": "CREDITO",
			"escontraentrega": true
	}		}
	]		]
Línea 104:		Línea 105:
	\|-		\|-
	\| descripcion_formapago_categoria\|\| string \|\| Descripción de la categoría forma de pago		\| descripcion_formapago_categoria\|\| string \|\| Descripción de la categoría forma de pago
			\|-
			\| escontraentrega \|\| bool \|\| true o false. Si es contraentrega
	\|}		\|}
	</Tab>		</Tab>
Línea 137:		Línea 139:
	"cuenta": 11050501,		"cuenta": 11050501,
	"aplicafactura": true,		"aplicafactura": true,
	"aplicapuntopago": true		"aplicapuntopago": true,
			"escontraentrega": true
	}		}
	</syntaxhighlight>		</syntaxhighlight>
Línea 145:		Línea 148:
	! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción		! 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		\| 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
	\|-		\|-
	\| ~~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
	\|-		\|-
	\| ~~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
	\|-		\|-
	\| ~~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
	\|-		\|-
	\| ~~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
	\|-		\|-
	\| ~~aplicafactura~~\|\| bool \|\| 1\|\| NO \|\| true o false. si aplica ~~factura~~		\| aplicapuntopago \|\| bool \|\| 1 \|\| NO \|\| true o false. si aplica punto pago
	\|-		\|-
	\| ~~aplicapuntopago~~\|\| bool \|\| 1\|\| NO \|\| true o false. ~~si aplica punto pago~~		\| escontraentrega \|\| bool \|\| 1 \|\| NO \|\| true o false. Si es contraentrega

	\|}		\|}

Línea 217:		Línea 221:
	"aplicafactura": false,		"aplicafactura": false,
	"aplicapuntopago": true,		"aplicapuntopago": true,
	"gdtformapagocatid": 1		"gdtformapagocatid": 1,
			"escontraentrega": 1
	}		}
	</syntaxhighlight>		</syntaxhighlight>
Línea 240:		Línea 245:
	\|-		\|-
	\| gdtformapagocatid\|\| int \|\| 50 \|\| SI \|\| Identificador único del tipo de categoría para la forma de pago , si es crédito , debito ,contado		\| gdtformapagocatid\|\| int \|\| 50 \|\| SI \|\| Identificador único del tipo de categoría para la forma de pago , si es crédito , debito ,contado
			\|-
			\| escontraentrega \|\| bool \|\| 1 \|\| NO \|\| true o false. Si es contraentrega
	\|}		\|}

Nalzate en 21:50 5 sep 2023

2023-09-05T21:50:05Z

← Revisión anterior		Revisión del 16:50 5 sep 2023
Línea 61:		Línea 61:
	"descripcion_fomapago": "PRUEBAS D",		"descripcion_fomapago": "PRUEBAS D",
	"tipo": "PRUEBAS T",		"tipo": "PRUEBAS T",
	~~"informacion_banco": null,~~
	~~"dias": null,~~
	"aplicafactura": false,		"aplicafactura": false,
	"aplicapuntopago": false,		"aplicapuntopago": false,
Línea 94:		Línea 92:
	\|-		\|-
	\| tipo\|\| string \|\| Descripción del tipo de cuenta o acrónimo de la cuenta		\| 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		\| aplicafactura\|\| bool\|\| true o false. Si aplica factura

Lmedina: /* Métodos */

2023-06-20T16:53:18Z

Métodos

← Revisión anterior		Revisión del 11:53 20 jun 2023
Línea 57:		Línea 57:
	{		{
	"id": 1,		"id": 1,
	"~~auxiliar~~": ~~11050501~~,		"cuenta": 15120501,
	"descripcion_cuenta": "~~TESORERIA~~",		"descripcion_cuenta": "MAQUINARIA Y EQUIPO",
	"descripcion_fomapago": "~~postr~~",		"descripcion_fomapago": "PRUEBAS D",
	"tipo": "CO",		"tipo": "PRUEBAS T",
	"informacion_banco": null,		"informacion_banco": null,
	"dias": null,		"dias": null,
	"aplicafactura": false,		"aplicafactura": false,
	"aplicapuntopago": ~~true~~,		"aplicapuntopago": false,
	"tercuenta": false,		"tercuenta": false,
	"id_formapago_categoria": 1,		"id_formapago_categoria": 1,
Línea 141:		Línea 141:
	"descripcion_fomapago": "forma false",		"descripcion_fomapago": "forma false",
	"tercuenta": true,		"tercuenta": true,
	"~~auxiliar~~": 11050501,		"cuenta": 11050501,
	"aplicafactura": true,		"aplicafactura": true,
	"aplicapuntopago": true		"aplicapuntopago": true
Línea 181:		Línea 181:
	"errors": null,		"errors": null,
	"message": "registro creado exitosamente"		"message": "registro creado exitosamente"
			}
			{
			"success": false,
			"code": 400,
			"errors": [
			"La cuenta 110505019 no existe"
			],
			"message": "Se presentaron errores al crear el registro"
	}		}
	</syntaxhighlight>		</syntaxhighlight>

Lmedina: /* Métodos */

2023-06-15T16:53:12Z

Métodos

← Revisión anterior		Revisión del 11:53 15 jun 2023
Línea 56:		Línea 56:
	"result": [		"result": [
	{		{
	"id": 41,		"id": 1,
	"auxiliar": 11050501,		"auxiliar": 11050501,
	"descripcion_cuenta": "TESORERIA",		"descripcion_cuenta": "TESORERIA",
	"descripcion_fomapago": "~~forma false~~",		"descripcion_fomapago": "postr",
	"tipo": "~~p false~~",		"tipo": "CO",
	"informacion_banco": null,		"informacion_banco": null,
	"dias": null,		"dias": null,
	"aplicafactura": ~~true~~,		"aplicafactura": false,
	"aplicapuntopago": ~~false~~,		"aplicapuntopago": true,
	"tercuenta": false,		"tercuenta": false,
	"~~gdtformapagocatid~~": 3,		"id_formapago_categoria": 1,
	"categoria": "AT",		"categoria": "CR",
	"descripcion_formapago_categoria": "~~ANTICIPOS~~"		"descripcion_formapago_categoria": "CREDITO"
	}		}
	]		]
Línea 105:		Línea 105:
	\| tercuenta\|\| bool \|\| true o false. Si el aplica cuenta tercero		\| tercuenta\|\| bool \|\| true o false. Si el aplica cuenta tercero
	\|-		\|-
	\| ~~gdtformapagocatid~~\|\| int \|\| Corresponde al identificador de la categoría forma de pago		\| id_formapago_categoria \|\| int \|\| Corresponde al identificador de la categoría forma de pago
	\|-		\|-
	\| categoria\|\| string \|\| Abreviatura3 Categoria forma pago		\| categoria\|\| string \|\| Abreviatura3 Categoria forma pago
Línea 137:		Línea 137:
	<syntaxhighlight lang="JSON">		<syntaxhighlight lang="JSON">
	{		{
	"~~gdtformapagocatid~~" : 4,		"id_formapago_categoria" : 4,
	"tipo": "p false",		"tipo": "p false",
	"descripcion_fomapago": "forma false",		"descripcion_fomapago": "forma false",
	"tercuenta": ~~false~~,		"tercuenta": true,
	"auxiliar": 11050501,		"auxiliar": 11050501,
	"aplicafactura": true,		"aplicafactura": true,
	"aplicapuntopago": ~~false~~		"aplicapuntopago": true
	}		}
	</syntaxhighlight>		</syntaxhighlight>

Gpazos en 15:05 27 may 2023

2023-05-27T15:05:46Z

← Revisión anterior		Revisión del 10:05 27 may 2023
Línea 1:		Línea 1:
	'''Descripción:'''		'''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~~.		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:'''		'''Autorización:'''
Línea 6:		Línea 6:

	'''Beneficio:'''		'''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:'''		'''Tipos de peticiones:'''
Línea 12:		Línea 11:

	'''¿Cómo funciona?'''		'''¿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.		*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.		*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

Lmedina: /* Métodos */

2023-05-25T19:56:02Z

Métodos

Mostrar los cambios

Lmedina: /* Métodos */

2023-05-25T16:47:30Z

Métodos

← Revisión anterior		Revisión del 11:47 25 may 2023
Línea 21:		Línea 21:
	<!-- *************** GET **************** -->		<!-- *************** GET **************** -->
	<Tab name = "API Consulta (GET) ">		<Tab name = "API Consulta (GET) ">
	'''GET~~/users~~'''		'''GET'''

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

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

	''' Headers '''		''' Headers '''
Línea 59:		Línea 59:
	"result": [		"result": [
	{		{
	"id": 1,		"id": 41,
	"~~abreviatura~~": "CC",		"auxiliar": 11050501,
	"~~descripcion~~": "~~CEDULA CIUDADANIA~~",		"descripcion_cuenta": "TESORERIA",
	"~~codigo~~": 13,		"descripcion_fomapago": "forma false",
	"~~abreviatura2~~": "",		"tipo": "p false",
	"~~abreviatura3~~": ~~null~~,		"informacion_banco": null,
	"~~excluirImpVentas~~": ~~null~~		"dias": null,
			"aplicafactura": true,
			"aplicapuntopago": false,
			"tercuenta": false,
			"gdtformapagocatid": 3,
			"categoria": "AT",
			"descripcion_formapago_categoria": "ANTICIPOS"
	}		}
	]		]
Línea 84:		Línea 90:
	\| Id \|\| int \|\| Corresponde al identificador del tipo de identidad		\| Id \|\| int \|\| Corresponde al identificador del tipo de identidad
	\|-		\|-
	\| ~~abreviatura~~ \|\| string \|\| Abreviatura Tipo de identidad		\| auxiliar\|\| string \|\| Abreviatura Tipo de identidad
	\|-		\|-
	\| ~~descripcion~~ \|\| string \|\| Descripción tipo de identidad		\| descripcion_cuenta\|\| string \|\| Descripción tipo de identidad
	\|-		\|-
	\| ~~codigo~~ \|\| int \|\| Código numero del tipo de identidad		\| descripcion_fomapago\|\| int \|\| Código numero del tipo de identidad
	\|-		\|-
	\| ~~abreviatura2~~ \|\| string \|\| Abreviatura2 Tipo de identidad		\| informacion_banco\|\| string \|\| Abreviatura2 Tipo de identidad
	\|-		\|-
	\| abreviatura3 \|\| string \|\| Abreviatura3 Tipo de identidad		\| abreviatura3 \|\| string \|\| Abreviatura3 Tipo de identidad
	\|-		\|-
	\| excluirImpVentas \|\| bool \|\| True o False. Si el tipo de identidad es excluido del impuesto de ventas		\| excluirImpVentas \|\| bool \|\| True o False. Si el tipo de identidad es excluido del impuesto de ventas
			\|-
			\| dias\|\| int \|\| Corresponde al identificador del tipo de identidad
			\|-
			\| aplicafactura\|\| string \|\| Abreviatura Tipo de identidad
			\|-
			\| aplicapuntopago\|\| string \|\| Descripción tipo de identidad
			\|-
			\| tercuenta\|\| int \|\| Código numero del tipo de identidad
			\|-
			\| gdtformapagocatid\|\| string \|\| Abreviatura2 Tipo de identidad
			\|-
			\| categoria\|\| string \|\| Abreviatura3 Tipo de identidad
			\|-
			\| descripcion_formapago_categoria\|\| bool \|\| True o False. Si el tipo de identidad es excluido del impuesto de ventas

	\|}		\|}
	</Tab>		</Tab>
Línea 145:		Línea 166:
	\|-		\|-
	\| excluirImpVentas\|\| bool \|\| 50 \|\| NO \|\| true o false. Si el tipo de identidad es excluido del impuesto de ventas		\| excluirImpVentas\|\| bool \|\| 50 \|\| NO \|\| true o false. Si el tipo de identidad es excluido del impuesto de ventas

	\|}		\|}

Gpazos: Created page with "'''Descripción:''' Este reporte entrega una visión completa de la gestión del agente al resumir individualmente la actividad del asesor indicando el total de las llamadas gestionadas (inbound/ outbound/ internal), el tiempo que ha usado en cada fase de la atención al cliente (tiempo de Ring, ACW y AHT), fecha y hora de Log In/Log Out, además la cantidad de hits y RPC. '''Autorización:''' Se requiere autenticación para todas las solicitudes. Las credenciales de au..."

2023-05-25T14:07:45Z

Created page with "'''Descripción:''' Este reporte entrega una visión completa de la gestión del agente al resumir individualmente la actividad del asesor indicando el total de las llamadas gestionadas (inbound/ outbound/ internal), el tiempo que ha usado en cada fase de la atención al cliente (tiempo de Ring, ACW y AHT), fecha y hora de Log In/Log Out, además la cantidad de hits y RPC. '''Autorización:''' Se requiere autenticación para todas las solicitudes. Las credenciales de au..."

Página nueva

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

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/TipoIdentidad?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,
"abreviatura": "CC",
"descripcion": "CEDULA CIUDADANIA",
"codigo": 13,
"abreviatura2": "",
"abreviatura3": null,
"excluirImpVentas": null
}
]
}

{
"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
|-
| abreviatura || string || Abreviatura Tipo de identidad
|-
| descripcion || string || Descripción tipo de identidad
|-
| codigo || int || Código numero del tipo de identidad
|-
| abreviatura2 || string || Abreviatura2 Tipo de identidad
|-
| abreviatura3 || string || Abreviatura3 Tipo de identidad
|-
| excluirImpVentas || bool || True o False. Si el tipo de identidad es excluido del impuesto de ventas
|}
</Tab>


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

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

''' 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">
{
"abreviatura": "NIT",
"descripcion": "NIT",
"codigo": 31,
"abreviatura2": " NIT2",
"abreviatura3": "",
"excluirImpVentas": false
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| abreviatura || string || 50 || SI || Abreviatura Tipo de identidad
|-
| descripcion|| string || 50 || SI || Descripcion tipo de identidad
|-
| codigo || int || 50 || SI || Codigo numero del tipo de identidad
|-
| abreviatura2 || string || 50 || NO || Abreviatura2 Tipo de identidad
|-
| abreviatura3 || string || 50 || NO || Abreviatura3 Tipo de identidad
|-
| excluirImpVentas|| bool || 50 || NO || true o false. Si el tipo de identidad es excluido del impuesto de ventas
|}

'''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": "x registro(s) encontrados",
"result": [
{
"id": 1,
"abreviatura": "CC",
"descripcion": "CEDULA CIUDADANIA",
"codigo": 13,
"abreviatura2": "",
"abreviatura3": null,
"excluirImpVentas": null
}
]
}

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


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

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

''' 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
"abreviatura": "NIT",
"descripcion": "NIT",
"codigo": 31,
"abreviatura2": " NIT2",
"abreviatura3": "",
"excluirImpVentas": false
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || Corresponde al identificador del tipo de identidad
|-
| abreviatura || string || 50 || SI || Abreviatura Tipo de identidad
|-
| descripcion|| string || 50 || SI || Descripcion tipo de identidad
|-
| codigo || int || 50 || SI || Codigo numero del tipo de identidad
|-
| abreviatura2 || string || 50 || NO || Abreviatura2 Tipo de identidad
|-
| abreviatura3 || string || 50 || NO || Abreviatura3 Tipo de identidad
|-
| excluirImpVentas|| bool || 50 || NO || true o false. Si el tipo de identidad es excluido del impuesto de ventas
|}

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