API BI Cartera - Historial de revisiones

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

2023-12-12T14:25:08Z

¿Cómo consumir la API?

← Revisión anterior		Revisión del 09:25 12 dic 2023
Línea 223:		Línea 223:
	RequestBody body = RequestBody.create(mediaType, "");		RequestBody body = RequestBody.create(mediaType, "");
	Request request = new Request.Builder()		Request request = new Request.Builder()
	.url("https://localhost:~~44305~~/api/v1/~~Pais~~")		.url("https://localhost:4444/api/v1/BICartera")
	.method("GET", body)		.method("GET", body)
	.addHeader("secretkey", "{{secret key}}")		.addHeader("secretkey", "{{secret key}}")
Línea 236:		Línea 236:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	var client = new HttpClient();		var client = new HttpClient();
	var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:~~44305~~/api/v1/~~Pais~~");		var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:4444/api/v1/BICartera");
	request.Headers.Add("secretkey", "{{secret key}}");		request.Headers.Add("secretkey", "{{secret key}}");
	request.Headers.Add("Authorization", "Bearer{{token}}");		request.Headers.Add("Authorization", "Bearer{{token}}");
Línea 253:		Línea 253:
	require_once 'HTTP/Request2.php';		require_once 'HTTP/Request2.php';
	$request = new HTTP_Request2();		$request = new HTTP_Request2();
	$request->setUrl('https://localhost:~~44305~~/api/v1/~~Pais~~');		$request->setUrl('https://localhost:4444/api/v1/BICartera');
	$request->setMethod(HTTP_Request2::METHOD_GET);		$request->setMethod(HTTP_Request2::METHOD_GET);
	$request->setConfig(array(		$request->setConfig(array(

Lmedina: /* Métodos */

2023-12-11T19:50:46Z

Métodos

@@ Línea 20: / Línea 20: @@
 '''EndPoint:'''
-https://www.apis.serpi.com.co/api/v1/Pais
+https://www.apis.serpi.com.co/api/v1/BICartera
 {| class="wikitable"
@@ Línea 55: / Línea 58: @@
      "result": [
+         {
-             "id": 1,
+             "tercero_nombre": "DIANA ISABEL IBARGUEN ZAMBRANO",
-             "nombre": "COLOMBIA",
+            "tercero_correo": "caralblos88@hotmail.com",
-             "codigo": "57",
+            "tercero_tel": "3153183793",
-             "codigo_alfa": "CO"
+            "tercero_movil": "3153183793-3125113943",
+         }
+	]
@@ Línea 75: / Línea 112: @@
 |-
 ! Campo !! Tipo de dato !! Descripción
 |-
 | id || int || Identificador del país

Lmedina: /* Métodos */

2023-12-11T16:17:55Z

Métodos

@@ Línea 84: / Línea 84: @@
 | codigo_alfa || string || Nomenclatura del país
 |}
 </Tab>
 </Tabs>

Lmedina: /* Métodos */

2023-12-11T16:16:31Z

Métodos

← Revisión anterior		Revisión del 11:16 11 dic 2023
Línea 86:		Línea 86:
	</Tab>		</Tab>

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

	~~{\| 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">~~
	{
	~~"nombre": "PAIS DEMO",~~
	~~"codigo": "1",~~
	~~"codigo_alfa": "PD"~~
	}
	~~</syntaxhighlight>~~


	~~{\| class="wikitable"~~
	~~\|+ Campos del request~~
	\|-
	~~! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción~~
	\|-
	~~\| nombre \|\| string \|\| 45 \|\| Si \|\| Nombre del país~~
	\|-
	~~\| codigo \|\| string \|\| 3 \|\| Si \|\| Código del país~~
	\|-
	~~\| codigo_alfa \|\| string \|\| 5 \|\| No \|\| Nomenclatura del país~~
	\|}

	~~==== '''AVISO IMPORTANTE:''' ====~~
	Donde los '''campos no sean obligatorios''' y no se desea asignar algún valor, pruebe digitando '''null''' o '''0''' en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite '''null'''.


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

	~~'''Validaciones'''~~
	~~<syntaxhighlight lang="JSON">~~
	{
	~~"success": false,~~
	~~"code": 400,~~
	~~"errors": null,~~
	~~"message": "El codigo del pais ya existe"~~
	}
	~~</syntaxhighlight>~~
	~~</Tab>~~

	<!-- ************************************************************ PUT ******************************************************************** -->		<!-- ************************************************************ PUT ******************************************************************** -->

Lmedina en 16:12 11 dic 2023

2023-12-11T16:12:21Z

← Revisión anterior		Revisión del 11:12 11 dic 2023
Línea 9:		Línea 9:

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

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

Lmedina en 16:07 11 dic 2023

2023-12-11T16:07:42Z

Mostrar los cambios

Lmedina en 16:06 11 dic 2023

2023-12-11T16:06:08Z

← Revisión anterior		Revisión del 11:06 11 dic 2023
Línea 154:		Línea 154:



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

Lmedina en 16:03 11 dic 2023

2023-12-11T16:03:50Z

Mostrar los cambios

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…»

2023-12-11T15:51:23Z

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…»

Página nueva

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