API Terceros/Campos Personalizados Terceros - Historial de revisiones

Nalzate: /* Métodos */

2024-05-21T16:12:30Z

Métodos

← Revisión anterior		Revisión del 11:12 21 may 2024
Línea 58:		Línea 58:
	{		{
	"campo": {		"campo": {
	"~~id_campoarticulo~~": 1,		"id_campocliente": 1,
	"~~descripcion_campoarticulo~~": "GRUPO_ETNICO"		"descripcion_campocliente": "GRUPO_ETNICO"
	},		},
	"detalle": [		"detalle": [

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

2024-05-21T16:10:19Z

¿Cómo consumir la API?

← Revisión anterior		Revisión del 11:10 21 may 2024
Línea 137:		Línea 137:
	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/~~Tercero~~")		.url("https://localhost:44305/api/v1/CamposCliente")
	.method("GET", body)		.method("GET", body)
	.addHeader("secretkey", "{{secret key}}")		.addHeader("secretkey", "{{secret key}}")
Línea 150:		Línea 150:
	<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/~~Tercero~~");		var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/CamposCliente");
	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 167:		Línea 167:
	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/~~Tercero~~');		$request->setUrl('https://localhost:44305/api/v1/CamposCliente');
	$request->setMethod(HTTP_Request2::METHOD_GET);		$request->setMethod(HTTP_Request2::METHOD_GET);
	$request->setConfig(array(		$request->setConfig(array(

Nalzate: /* Métodos */

2024-05-21T16:09:27Z

Métodos

← Revisión anterior		Revisión del 11:09 21 may 2024
Línea 77:		Línea 77:
	"code": 204,		"code": 204,
	"message": "No se encontraron registros",		"message": "No se encontraron registros",
	}

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

Línea 94:		Línea 88:
	! Campo !! Tipo de dato !! Descripción		! Campo !! Tipo de dato !! Descripción
	\|-		\|-
	\| *Campo \|\| Objeto \|\| Contiene ~~id_campoarticulo~~ y ~~descripcion_campoarticulo~~		\| *Campo \|\| Objeto \|\| Contiene id_campocliente y descripcion_campocliente
	\|-		\|-
	\| ~~id_campoarticulo~~ \|\| int \|\| Identificador del campo ~~del artículo~~		\| id_campocliente \|\| int \|\| Identificador del campo personalizado
	\|-		\|-
	\| ~~descripcion_campoarticulo~~ \|\| string \|\| Descripción del campo ~~del artículo~~		\| descripcion_campocliente \|\| string \|\| Descripción del campo personalizado
	\|-		\|-
	\| *Detalle \|\| Objeto \|\| Contiene los detalles de los campos personalizados (Valor y descripción). En caso de no tener detalles, no se mostrarán.		\| *Detalle \|\| Objeto \|\| Contiene los detalles de los campos personalizados (Valor y descripción). En caso de no tener detalles, no se mostrarán.

Nalzate: /* Métodos */

2024-05-21T16:06:12Z

Métodos

← Revisión anterior		Revisión del 11:06 21 may 2024
Línea 94:		Línea 94:
	! Campo !! Tipo de dato !! Descripción		! Campo !! Tipo de dato !! Descripción
	\|-		\|-
	\| Id \|\| ~~int~~ \|\| ~~Corresponde al identificador del tercero~~		\| *Campo \|\| Objeto \|\| Contiene id_campoarticulo y descripcion_campoarticulo
	\|-		\|-
	\| ~~tipo cuenta~~ \|\| ~~string~~ \|\| ~~Tipo de cuenta bancaria (A=Cuenta de ahorro, B=Cuenta Corriente)~~		\| id_campoarticulo \|\| int \|\| Identificador del campo del artículo
	\|-		\|-
	\| ~~cuenta bancaria~~ \|\| string \|\| ~~Numero de cuenta bancaria~~		\| descripcion_campoarticulo \|\| string \|\| Descripción del campo del artículo
	\|-		\|-
	\| ~~limite credito \|\| decimal \|\| Limite del credito~~		\| *Detalle \|\| Objeto \|\| Contiene los detalles de los campos personalizados (Valor y descripción). En caso de no tener detalles, no se mostrarán.
	\|-
	~~\| camposPersonalizados~~ \|\| Objeto \|\| ~~Objeto con la informacion~~ de campos personalizados
	\|}		\|}

	</Tab>		</Tab>

Nalzate en 15:46 21 may 2024

2024-05-21T15:46:21Z

← Revisión anterior		Revisión del 10:46 21 may 2024
Línea 57:		Línea 57:
	"result": [		"result": [
	{		{
	"id": 1,		"campo": {
	"~~tipo_cuenta~~": ~~null~~,		"id_campoarticulo": 1,
	"~~cuenta_bancaria~~": ~~null,~~		"descripcion_campoarticulo": "GRUPO_ETNICO"
	"~~limite_credito~~"~~: 0.00000~~,		},
	"~~camposPersonalizados~~": {		"detalle": [
	"~~ACTIVIDADECONOMICAMUNICIPAL~~": "~~BC44~~",		{
	~~"Comentarios": "Cliente proveedor de software"~~,		"1": "AFRODESCENDIENTE"
	~~"Comuna": 11,~~		},
	~~"FechaAniversario": "2016-06-01",~~		{
	~~"ClienteNacional": true,~~		"2": "MESTIZO"
	~~"Ranking":~~ "2",		}
	~~"TieneAsesor~~": "N",		]
	~~"Vetado": "3",~~		}
	~~"TipodeEmpresa": [~~
	~~"b",~~
	~~"c"~~
	],
	~~"continente": ""~~
	}

	]		]
	}		}

	{		{

Nalzate en 15:34 21 may 2024

2024-05-21T15:34:53Z

Mostrar los cambios

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

2024-05-21T15:24:32Z

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>

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