Diferencia entre revisiones de «API BI Flujo de Caja»

De WikiSerpi
Ir a la navegación Ir a la búsqueda
← Edición anteriorEdición siguiente →
VisualWikitexto
Línea 17: Línea 17:
<Tabs>
<Tabs>
<!-- ************************************************************** GET ********************************************************************** -->
<!-- ************************************************************** GET ********************************************************************** -->
 
== Flujo Caja==
<Tab name = "API Consulta (GET)  ">
<Tab name = "API Consulta (GET)  ">


'''EndPoint:'''
'''EndPoint:'''
== Flujo Caja==


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

Revisión del 11:17 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

<Tabs>

Flujo Caja

<Tab name = "API Consulta (GET) ">

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

Métodos

<Tabs> <Tab name = "API Consulta (GET) ">

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

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