Diferencia entre revisiones de «API BI Flujo de Caja»

Revisión del 11:28 12 dic 2023

Descripción: PENDIENTE

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

Tipos de peticiones: GET

¿Cómo funciona? PENDIENTE

Métodos Flujo Caja

<Tabs>

EndPoint:

https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/FlujoCaja

EndPoint Con Parametros: https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/FlujoCaja?año=2020&esalterna=0

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

Response

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "1 registro(s) encontrados",
    "result": [
        {
           "descrip_sub": "OPERATIVO",
            "gdtempresaid1": 1,
            "descripcion": "NOMINA, APORTES Y LIQUIDACIONES",
            "gdtempresaid": 1,
            "cate_flujo": "USO",
            "gdtflujocajasubid": 1,
            "gdtempresaid2": 1,
            "numero": 4875,
            "fecha": "2021-01-06T00:00:00",
            "ano": 2021,
            "mes": 1,
            "periodo": "202101",
            "semana": 1,
            "debito": 0.00000,
            "credito": 36440973.00000,
            "movimiento": -36440973.00000,
            "gdtcuentaid": 2114,
            "gdtterceroid": 7345,
            "gdtcentrocostoid": null,
            "naturaleza": "C",
            "valor": 36440973.00000,
            "gdtflujocajaid": 4,
            "detalle_mov": "NÓMINA DAVIENDA",
            "gdttipodocid": 6,
            "categoria_doc": "CE",
            "prefjo": "CE",
            "nom_documento": "COMPROBANTE DE EGRESO",
            "nom_auxiliar": "DAVIVIENDA CTA CTE ",
            "clase": 1,
            "grupo": 11,
            "cuenta": 1110,
            "subcuenta": 111005,
            "auxiliar": 11100501,
            "nit": "901067734",
            "dv": 4,
            "nom_tercero": "DEMO2 - GIORGIO "
        }
	]
}

{
	"success": true
	"code": 201,
	"message": "No se encontraron registros",
	"result": []
}

Campos de resultados
Campo	Tipo de dato	Descripción
id	int	Identificador del país
nombre	string	Nombre del país
codigo	string	Código del país
codigo_alfa	string	Nomenclatura del país
id	int	Identificador del país
nombre	string	Nombre del país
codigo	string	Código del país
codigo_alfa	string	Nomenclatura del país
id	int	Identificador del país
nombre	string	Nombre del país
codigo	string	Código del país
codigo_alfa	string	Nomenclatura del país
id	int	Identificador del país
nombre	string	Nombre del país
codigo	string	Código del país
codigo_alfa	string	Nomenclatura del país
id	int	Identificador del país
nombre	string	Nombre del país
codigo	string	Código del país
codigo_alfa	string	Nomenclatura del país
id	int	Identificador del país
nombre	string	Nombre del país
codigo	string	Código del país
codigo_alfa	string	Nomenclatura del país
id	int	Identificador del país
nombre	string	Nombre del país
codigo	string	Código del país
codigo_alfa	string	Nomenclatura del país
id	int	Identificador del país
nombre	string	Nombre del país
codigo	string	Código del país
codigo_alfa	string	Nomenclatura del país
id	int	Identificador del país
nombre	string	Nombre del país
codigo	string	Código del país
codigo_alfa	string	Nomenclatura del país

</Tab>

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

EndPoint Con Parametros: https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/Contabilidad?grupo=11&año_desde=2019&año_hasta=2021

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

        }
]

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

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:4444/api/v1/BIFlujoCajaPeriodo/FlujoCaja")
  .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:4444/api/v1/BIFlujoCajaPeriodo/FlujoCaja");
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:4444/api/v1/BIFlujoCajaPeriodo/FlujoCaja');
$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>

@@ Línea 189: / Línea 189: @@
-<!-- ***************** POST ****************** -->
+<!-- ***************** GET Contabilidad****************** -->
-<Tab name = "API Creación (POST) ">
+<Tab name = "API Contabilidad (GET) ">
-'''POST /users'''
 '''EndPoint:'''
-https://www.apis.serpi.com.co/api/v1/Tercero
+https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/Contabilidad
+'''EndPoint Con Parametros:'''
+https://www.apis.serpi.com.co/api/v1/BIFlujoCajaPeriodo/Contabilidad?grupo=11&año_desde=2019&año_hasta=2021
 ''' Headers '''

Diferencia entre revisiones de «API BI Flujo de Caja»

Revisión del 11:28 12 dic 2023

Métodos Flujo Caja

Códigos de estado HTTP

¿Cómo consumir la API?

Menú de navegación

Buscar