Nalzate en 14:08 30 oct 2023

2023-10-30T14:08:56Z

@@ Línea 446: / Línea 446: @@
 </Tab>
 </Tabs>
 == ¿Cómo consumir la API? ==

Nalzate: Página creada con «'''Descripción:''' Esta API permite la sincronización del agrupador definido como Factura de Compra entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estándar entre las dos Plataformas. '''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. '''…»

2023-09-18T14:30:45Z

Página creada con «'''Descripción:''' Esta API permite la sincronización del agrupador definido como Factura de Compra entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estándar entre las dos Plataformas. '''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. '''…»

Página nueva

'''Descripción:'''
Esta API permite la sincronización del agrupador definido como Factura de Compra entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estándar entre las dos Plataformas.

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

'''Tipos de peticiones:'''
GET

'''¿Cómo funciona?'''
*El consumo de esta API se realiza por método GET.
*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 Tipos de Documento(GET)">

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/FacturaCompra/GetTipoDocumento

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight >
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

{| class="wikitable"
|+ 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'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "2 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "FC",
"prefijo": "FC",
"descripcion": "FACTURA COMPRA"
}
]
}

{
"success": true,
"code": 204,
"message": "No se encontraron registros",
}

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador del tipo de documento
|-
| categoriaDocumento || string || Categoria del tipo de documento
|-
| prefijo || string || Prefijo del tipo de documento
|-
| descripcion || string || Descripcion del tipo de documento
|}
</Tab>


<Tab name = "API Consultar Factura Compra(GET) ">

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/FacturaCompra/ConsultarFacturaVenta?limite=10&pagina=1

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight >
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Requerido !! Descripción
|-
| Límite || NO || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || 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
|}

'''Body'''
<syntaxhighlight lang="JSON">
{
"idTipoDocumento": 16,
"numeroDesde": null,
"numeroHasta": null,
"fechaDesde": "2023-01-01",
"fechaHasta": "2023-01-31"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos Body
|-
! Campo !! Tipo !! Requerido !! Descripcion
|-
| tiposDocumentos || Array[Int] || SI || Id del tipo de documento (Api consulta tipos documento)
|-
| numeroDesde || Int || NO || Numero inicial para filtrar por rango de numeros de documentos
|-
| numeroHasta || Int || NO || Numero final para filtrar por rango de numeros de documentos
|-
| fechaDesde || String || SI || Fecha inicial para filtrar por rango de fecha del documento
|-
| fechaHasta || bool || SI || Fecha final para filtrar por rango de fecha del documento
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 2763,
"prefijo": "FC",
"numeroDoc": 1,
"prefijoProveedor": "fv",
"numeroProveedor": 152,
"fechaDocumento": "2023-07-10",
"fechaVencimiento": "2023-09-08",
"nitTerceroEnc": "1234567890",
"nombreTerceroEnc": "PROVEEDOR1",
"idBodega": 3,
"idProyecto": null,
"idCategoria": null,
"numOrdenCompra": null,
"detalles": [
{
"idArticulo": 455,
"descripcion": "ARTICULO1",
"cantidad": 1000.00000,
"valorUnitario": 3700.00000,
"porcImpuesto": 19.00000,
"subtotal": 4403000.00000,
"impuesto": 703000.00000
},
{
"idArticulo": 158,
"descripcion": "ARTICULO2",
"cantidad": 1000.00000,
"valorUnitario": 9400.00000,
"porcImpuesto": 19.00000,
"subtotal": 11186000.00000,
"impuesto": 1786000.00000
}
]
}
]
}

{
"success": true,
"code": 204,
"message": "No se encontraron registros",
}

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| id || int || Corresponde al id del registro de la factura de compra
|-
| prefijo || string || Prefijo del tipo de documento
|-
| numeroDoc || Int || Numero de la Factura de compra
|-
| nitTerceroEnc || string || Numero de identificación del tercero de la Factura de compra
|-
| nombreTerceroEnc || string || Nombre del tercero de la Factura de compra
|-
| fechaDocumento || string || Fecha de la Factura de compra
|-
| fechaVencimiento || string || Fecha Vencimiento de la Factura de compra
|-
| prefijoProveedor || String || Prefijo de la factura del proveedor
|-
| numeroProveedor || Int || Numero de la factura del proveedor
|-
| idBodega || Int || Id de la bodega
|-
| idProyecto || Int || Id del proyecto
|-
| idActividad || Int || Id de la actividad
|-
| numOrdenCompra || int || Numero de la Orden de Compra
|-
| detalles || Array[ObjetoDetalle]* || Array de objetos de los detalles de la factura de compra
|}

'''ObjetoDetalle'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| idArticulo || Int || Id del Articulo
|-
| descripcion || string || Descripcion del Articulo
|-
| cantidad || decimal || Cantidad vendida
|-
| valorUnitario || decimal || Precio o Valor unitario de venta
|-
| porcImpuesto || decimal || Porcentaje del impuesto
|-
| subtotal || decimal || Subtotal
|-
| impuesto || decimal || Valor Impuesto
|}

</Tab>


<Tab name = "API Crear (POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/FacturaCompra

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight>
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"prefijo": "FC",
"numeroDoc": 2580,
"prefijoProveedor": "FV1",
"numeroProveedor": 77534,
"fechaDocumento": "2023-09-14",
"fechaVencimiento": "2023-09-14",
"nitTerceroEnc": "890919549",
"idBodega": 3,
"idProyecto": null,
"idCategoria": null,
"numOrdenCompra": null,
"detalles": [
{
"idArticulo": 455,
"cantidad": 1000.00000,
"valorUnitario": 3700.00000,
"porcImpuesto": 19.00000,
"subtotal": 4403000.00000,
"impuesto": 703000.00000
},
{
"idArticulo": 158,
"cantidad": 1000.00000,
"valorUnitario": 9400.00000,
"porcImpuesto": 19.00000,
"subtotal": 11186000.00000,
"impuesto": 1786000.00000
}
]
}
]

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultado
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| prefijo || string || SI || Prefijo del tipo de documento
|-
| numeroDoc || Int || SI || Numero de la Factura de Compra
|-
| nitTerceroEnc || string || SI || Numero de identificación del tercero de la Factura de Compra
|-
| fechaDocumento || string || SI || Fecha de la Factura de Compra
|-
| fechaVencimiento || string || SI || Fecha Vencimiento de la Factura de Compra
|-
| numeroProveedor || string || SI || Prefijo de la factura del proveedor
|-
| numeroProveedor || Int || SI || Numero de la factura del proveedor
|-
| idBodega || Int || SI || Id de la bodega
|-
| idProyecto || Int || NO || Id del proyecto
|-
| idActividad || Int || NO || Id de la actividad
|-
| numOrdenCompra || int || NO || Numero de la Orden de Compra
|-
| detalles || Array[ObjetoDetalle]* || SI || Array de objetos de los detalles de la factura de compra
|}

'''ObjetoDetalle'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| idArticulo || Int || SI || Id del Articulo
|-
| cantidad || decimal || SI || Cantidad vendida
|-
| valorUnitario || decimal || SI || Precio o Valor unitario de venta
|-
| porcImpuesto || decimal || NO || Porcentaje del impuesto
|-
| subtotal || decimal || SI || Subtotal
|-
| impuesto || decimal || NO || Valor Impuesto
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 1 de 1 Facturas de Compra"
}

</syntaxhighlight>
</Tab>


<Tab name = "API Eliminar(DELETE) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/FacturaCompra

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight>
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Body'''
<syntaxhighlight lang="JSON">
{
"idTipoDocumento": 6,
"numeroDesde": 1,
"numeroHasta": 1,
"fechaDesde": "2023-03-01",
"fechaHasta": "2023-03-31"
}

</syntaxhighlight>

{| class="wikitable"
|+ Campos Body
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| idTipoDocumento || Int || SI || Id del tipo de documento
|-
| numeroDesde || Decimal || SI || Numero inicial para filtrar por rango de números de documentos
|-
| numeroHasta || Decimal || SI || Numero final para filtrar por rango de números de documentos
|-
| fechaDesde || String || SI || Fecha inicial para filtrar por rango de fecha del documento
|-
| fechaHasta || Bool || SI || Fecha final para filtrar por rango de fecha del documento
|-
|
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Se eliminaron 1 de 1 Facturas de Compra"
}

</syntaxhighlight>
</Tab>
</Tabs>

== ¿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/FacturaCompra")
.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/FacturaCompra");
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/FacturaCompra');
$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]]

API Inventarios/Factura Compra - Historial de revisiones

Nalzate en 14:08 30 oct 2023