Diferencia entre revisiones de «API Terceros»

De WikiSerpi
Ir a la navegación Ir a la búsqueda
← Edición anteriorEdición siguiente →
m Dvaldes trasladó la página API Terceros a API Terceros/Vendedores
(Sin diferencias)

Revisión del 09:57 21 jul 2023

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

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

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



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>

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

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

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

Request 

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


        }

Campos del request

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: 

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

Response 

{
    "success": true,
    "code": 201,
    "errors": [],
    "message": "Se crearon 10 de 10 terceros"
}

</Tab>

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

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

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

Request 

[
        {
            "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": ""
            }
        }
    ]

Campos del request

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: 

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

Response 

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

</Tab> </Tabs>

¿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_Terceros&oldid=818»