API BI Cartera

De WikiSerpi
Ir a la navegación Ir a la búsqueda

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

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

Authorization: 

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

Parámetros

Parámetro Tipo de dato Requerido Descripción
Límite int No Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
Página int No Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
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 

{
"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",
}



Campo de resultados

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

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 

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();

</Tab>

<Tab name = "C#"> Request 

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());

</Tab>

<Tab name = "PHP"> Request 

<?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();
}

</Tab>

</Tabs>

Obtenido de «https://www.wikiserpi.com/index.php?title=API_BI_Cartera&oldid=1117»