WikiSerpi - Contribuciones del usuario [es]

API Terceros/Lista Precios Detalle

2024-01-29T13:59:26Z

Gpazos: /* Métodos */

'''Descripción:'''
Este reporte entrega una visión completa de la gestión del agente al resumir individualmente la actividad del asesor indicando el total de las llamadas gestionadas (inbound/ outbound/ internal), el tiempo que ha usado en cada fase de la atención al cliente (tiempo de Ring, ACW y AHT), fecha y hora de Log In/Log Out, además la cantidad de hits y RPC.

'''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 reporte permite hacer una medición de la productividad individual de los agentes teniendo en cuenta el tiempo dedicado a la gestión de llamadas y sus logros (hits y RPC)

'''Tipos de peticiones:'''
GET, POST, PUT

'''¿Cómo funciona?'''
*El consumo de esta API se realiza por método GET.
*Para consumir esta API debe reemplazar en la url {ip_ipdialbox} por la nomenclatura del servidor de la operación y el {token} generado desde wolkvox Manager para obtener la información de manera segura.
*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) ">

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

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/ListaPrecioDetalle?limite=50&pagina=1&idArticulo=1&idListaPrecio=1</nowiki>

{| 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
|-
| limite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| pagina || 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
|-
| idArticulo || int || No || Este parámetro indica el id del artículo que desea consultar
|-
| idListaPrecio || int || No || Este parámetro trae la consulta de los artículos relacionados al id de la lista precio que desee consultar
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id_listaprecio": 1,
"descripcion_id_listaprecio": "DESCRIPCION DE LA LISTA DE PRECIO",
"id_articulo": 1,
"descripcion_articulo": "ARTICULO DEMO",
"precio": 0,
"descuento": 0,
"observaciones": "OBSERVACIONES GENERALES"
}
]
}

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

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id_listaprecio || int || Identificador de la lista precio relacionada al detalle
|-
| descripcion_id_listaprecio || string || Descripción de la lista precio relacionada al detalle
|-
| id_articulo || int || Identificador del articulo relacionado al detalle
|-
| descripcion_articulo || string || Descripción del artículo
|-
| precio || double || Precio del artículo
|-
| descuento || double || Descuento del artículo
|-
| observaciones || string || Observaciones de la lista de precio detalle
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/ListaPrecioDetalle

{| 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">
[
{
"id_listaprecio": 1,
"id_articulo": 1000,
"precio": 50000,
"descuento": 10,
"observaciones": "OBSERVACIÓN GENERAL"
},
.
.
.
{
"id_listaprecio": n,
"id_articulo": n,
"precio": 0,
"descuento": 0,
"observaciones": null
}
]
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id_listaprecio || int || 11 || Si || Identificador de la lista precio relacionada al detalle. Debe existir la lista de precio para relacionar el id.
|-
| id_articulo || int || 11 || Si || Identificador del articulo relacionado al detalle. Debe existir el artículo para relacionar el id.
|-
| precio || double || (18,5) || Si || Precio del artículo
|-
| descuento || double || (18,5) || No || Porcentaje del descuento que aplica para el artículo relacionado. El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica
|-
| observaciones || string || 500 || No || Observaciones de la lista de precio detalle
|}

=== '''AVISO IMPORTANTE:''' ===
Donde los '''campos no sean obligatorios''' y no se desea asignar algún valor, pruebe digitando '''null''' o '''0''' en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite '''null'''.

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

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [
"El campo precio es obligatorio",
"El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica",
"No existe un articulo relacionado al id 0",
"No existe una lista de precio relacionada al id 0"
],
"message": "Se crearon 0 de 1 lista precio detalle"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/ListaPrecioDetalle

{| 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">
[
{
"id_listaprecio": 1000,
"id_articulo": 10000,
"precio": 0,
"descuento": 0,
"observaciones": "OBSERVACIONES GENERALES"
},
.
.
.
{
"id_listaprecio": n,
"id_articulo": n,
"precio": 0,
"descuento": 0,
"observaciones": null
}
]

</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id_listaprecio || int || 11 || Si || Identificador de la lista precio relacionada al detalle. Debe existir la lista de precio para relacionar el id.
|-
| id_articulo || int || 11 || Si || Identificador del articulo relacionado al detalle. Debe existir el artículo para relacionar el id.
|-
| precio || double || (18,5) || Si || Precio del artículo
|-
| descuento || double || (18,5) || No || Porcentaje del descuento que aplica para el artículo relacionado. El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica
|-
| observaciones || string || 500 || No || Observaciones de la lista de precio detalle
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Se modificaron 1 de 1 lista precios detalle"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [
"Lista Precio Detalle 1: El id no existe",
"El campo precio es obligatorio",
"El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica",
"No existe un articulo relacionado al id 10000",
"No existe una lista de precio relacionada al id 1000"
],
"message": "Se modificaron 0 de 1 lista precios detalle"
}
</syntaxhighlight>
</Tab>
</tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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'''
<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/ListaPrecioDetalle")
.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/ListaPrecioDetalle");
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/ListaPrecioDetalle');
$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 Terceros/Lista Precios Detalle

2024-01-29T13:55:18Z

Gpazos: /* Métodos */

'''Descripción:'''
Este reporte entrega una visión completa de la gestión del agente al resumir individualmente la actividad del asesor indicando el total de las llamadas gestionadas (inbound/ outbound/ internal), el tiempo que ha usado en cada fase de la atención al cliente (tiempo de Ring, ACW y AHT), fecha y hora de Log In/Log Out, además la cantidad de hits y RPC.

'''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 reporte permite hacer una medición de la productividad individual de los agentes teniendo en cuenta el tiempo dedicado a la gestión de llamadas y sus logros (hits y RPC)

'''Tipos de peticiones:'''
GET, POST, PUT

'''¿Cómo funciona?'''
*El consumo de esta API se realiza por método GET.
*Para consumir esta API debe reemplazar en la url {ip_ipdialbox} por la nomenclatura del servidor de la operación y el {token} generado desde wolkvox Manager para obtener la información de manera segura.
*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) ">

'''EndPoint:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/ListaPrecioDetalle</nowiki>

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/ListaPrecioDetalle?limite=50&pagina=1&idArticulo=1&idListaPrecio=1</nowiki>

{| 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
|-
| limite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| pagina || 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
|-
| idArticulo || int || No || Este parámetro indica el id del artículo que desea consultar
|-
| idListaPrecio || int || No || Este parámetro trae la consulta de los artículos relacionados al id de la lista precio que desee consultar
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id_listaprecio": 1,
"descripcion_id_listaprecio": "DESCRIPCION DE LA LISTA DE PRECIO",
"id_articulo": 1,
"descripcion_articulo": "ARTICULO DEMO",
"precio": 0,
"descuento": 0,
"observaciones": "OBSERVACIONES GENERALES"
}
]
}

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

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id_listaprecio || int || Identificador de la lista precio relacionada al detalle
|-
| descripcion_id_listaprecio || string || Descripción de la lista precio relacionada al detalle
|-
| id_articulo || int || Identificador del articulo relacionado al detalle
|-
| descripcion_articulo || string || Descripción del artículo
|-
| precio || double || Precio del artículo
|-
| descuento || double || Descuento del artículo
|-
| observaciones || string || Observaciones de la lista de precio detalle
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/ListaPrecioDetalle

{| 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">
[
{
"id_listaprecio": 1,
"id_articulo": 1000,
"precio": 50000,
"descuento": 10,
"observaciones": "OBSERVACIÓN GENERAL"
},
.
.
.
{
"id_listaprecio": n,
"id_articulo": n,
"precio": 0,
"descuento": 0,
"observaciones": null
}
]
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id_listaprecio || int || 11 || Si || Identificador de la lista precio relacionada al detalle. Debe existir la lista de precio para relacionar el id.
|-
| id_articulo || int || 11 || Si || Identificador del articulo relacionado al detalle. Debe existir el artículo para relacionar el id.
|-
| precio || double || (18,5) || Si || Precio del artículo
|-
| descuento || double || (18,5) || No || Porcentaje del descuento que aplica para el artículo relacionado. El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica
|-
| observaciones || string || 500 || No || Observaciones de la lista de precio detalle
|}

=== '''AVISO IMPORTANTE:''' ===
Donde los '''campos no sean obligatorios''' y no se desea asignar algún valor, pruebe digitando '''null''' o '''0''' en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite '''null'''.

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

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [
"El campo precio es obligatorio",
"El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica",
"No existe un articulo relacionado al id 0",
"No existe una lista de precio relacionada al id 0"
],
"message": "Se crearon 0 de 1 lista precio detalle"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/ListaPrecioDetalle

{| 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">
[
{
"id_listaprecio": 1000,
"id_articulo": 10000,
"precio": 0,
"descuento": 0,
"observaciones": "OBSERVACIONES GENERALES"
},
.
.
.
{
"id_listaprecio": n,
"id_articulo": n,
"precio": 0,
"descuento": 0,
"observaciones": null
}
]

</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id_listaprecio || int || 11 || Si || Identificador de la lista precio relacionada al detalle. Debe existir la lista de precio para relacionar el id.
|-
| id_articulo || int || 11 || Si || Identificador del articulo relacionado al detalle. Debe existir el artículo para relacionar el id.
|-
| precio || double || (18,5) || Si || Precio del artículo
|-
| descuento || double || (18,5) || No || Porcentaje del descuento que aplica para el artículo relacionado. El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica
|-
| observaciones || string || 500 || No || Observaciones de la lista de precio detalle
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Se modificaron 1 de 1 lista precios detalle"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [
"Lista Precio Detalle 1: El id no existe",
"El campo precio es obligatorio",
"El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica",
"No existe un articulo relacionado al id 10000",
"No existe una lista de precio relacionada al id 1000"
],
"message": "Se modificaron 0 de 1 lista precios detalle"
}
</syntaxhighlight>
</Tab>
</tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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'''
<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/ListaPrecioDetalle")
.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/ListaPrecioDetalle");
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/ListaPrecioDetalle');
$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 Modulo Ventas

2023-08-25T14:23:33Z

Gpazos:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Ventas''' (Facturas)

*'''[[API Pedidos]]'''
* [[API Ventas/Factura_Venta|API Factura Venta]]
* [[API Tipos Documentos Modulo|API Tipos de Documentos (Módulo de Ventas)]]
* [[API Ventas/Sucursales|API Sucursales]]
* [[API Ventas/Bodegas|API Bodegas]]
* [[API Terceros/Lista_Precios|API Lista Precios]]
* [[API Terceros/Lista_Precios_Detalle|API Lista Precios Detalle]]
* [[API Articulos|API Articulos]]
* [[API Ventas/Centro_Operaciones|API Centro Operaciones]]
* [[API Documentos_Contables/Proyectos|API Proyectos]]
* [[API_Documentos_Contables/Actividades|API Categoria]]
* [[API Terceros/Forma_Pago|API Forma Pago]]

API Modulo Ventas

2023-08-25T14:21:38Z

Gpazos:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Ventas''' (Facturas)

*'''[[API Pedidos]]'''
*'''[[API Facturas]]'''
* [[API Ventas/Factura_Venta|API Factura Venta]]
* [[API Tipos Documentos Modulo|API Tipos de Documentos (Módulo de Ventas)]]
* [[API Ventas/Sucursales|API Sucursales]]
* [[API Ventas/Bodegas|API Bodegas]]
* [[API Terceros/Lista_Precios|API Lista Precios]]
* [[API Terceros/Lista_Precios_Detalle|API Lista Precios Detalle]]
* [[API Articulos|API Articulos]]
* [[API Ventas/Centro_Operaciones|API Centro Operaciones]]
* [[API Documentos_Contables/Proyectos|API Proyectos]]
* [[API_Documentos_Contables/Actividades|API Categoria]]
* [[API Terceros/Forma_Pago|API Forma Pago]]

API Ventas/Documentos

2023-07-10T13:57:34Z

Gpazos:

'''Descripción:'''
Esta API permite obtener los tipos de documentos disponibles en SERPI con el fin de que sean utilizados por una plataforma externa conservando la integridad de las transacciones 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?'''
*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.

{| class="wikitable"
|+ Identificadores de los documentos electrónicos
! Id !! Descripción
|-
| 0 || NO APLICA
|-
| 1 || FACTURA
|-
| 2 || NOTA DEBITO
|-
| 3 || NOTA CREDITO
|-
| 4 || DOCUMENTO SOPORTE
|-
| 5 || NOTE DE AJUSTE DOCUMENTO SOPORTE
|-
| 6 || FACTURA POS
|-
| 7 || NOTA CREDITO POR DESCUENTO
|}

{| class="wikitable"
|+ Abreviaturas para las categorías del documento
! Abreviatura !! Descripción
|-
| AFS || SALDO INICIAL ACTIVOS FIJOS
|-
| AFB || ACTIVO FIJO BAJA
|-
| AFV || ACTIVO FIJO VENTA
|-
| AFR || ACTIVO FIJO RECONOCIMIENTO
|-
| AI || AJUSTE DE INVENTARIO
|-
| AIV || AJUSTE DE INVENTARIO VALORIZADO
|-
| AMD || AMORTIZACION DIFERIDOS
|-
| CE || COMPROBANTE DE EGRESO
|-
| CCO || CAUSACION DE COMPRA
|-
| COT || COTIZACION
|-
| ENS || ENSAMBLE DE MATERIALES
|-
| DNS || DESENSAMBLE DE MATERIALES
|-
| DAF || DEPRECIACION ACTIVOS FIJOS
|-
| DSP || DESPERDICIOS
|-
| DC || DEVOLUCION DE COMPRA
|-
| DV || DEVOLUCION DE VENTA
|-
| DEQ || DOCUMENTO EQUIVALENTE
|-
| FC || FACTURAS COMPRAS
|-
| FCP || FACTURA COMPRA PROFORMA
|-
| FCG || FACTURA COMPRA AGRUPADA
|-
| FV || FACTURAS DE VENTA
|-
| FRV || PLANTILLA DE FACTURACION RECURRENTE
|-
| NCF || NOTA DE CONTABILIDAD FIJA
|-
| NC || NOTA DE CONTABILIDAD
|-
| NCX || NOTA CIERRE CONTABLE
|-
| NCY || NOTA CIERRE CUENTAS BALANCE
|-
| ODC || ORDEN DE COMPRA
|-
| PDV || PEDIDO DE VENTA
|-
| RC || RECIBOS DE CAJA
|-
| RMV || REMISION VENTA
|-
| RMP || REMISION PLANTILLA
|-
| RMC || REMISION COMPRA
|-
| TR || TRANSFERENCIA
|-
| TRI || TRASLADO DE INVENTARIO
|-
| TSC || TRASLADO CON SOBRECOSTO
|-
| NVN || NOVEDAD DE NOMINA
|-
| NVNP || NOVEDAD DE NOMINA PROYECTADA
|-
| NVS || NOVEDAD DE AUMENTO DE SALARIO
|-
| LQN || LIQUIDACIÓN DE NOMINA
|-
| LQNP || LIQUIDACIÓN DE NOMINA PROYECTADA
|-
| LCN || LIQUIDACIÓN CESANTIAS DE NOMINA
|-
| LPN || LIQUIDACIÓN PRIMA DE NOMINA
|-
| LPV || LIQUIDACIÓN PROVISIONES DE NOMINA
|-
| LVN || LIQUIDACIÓN VACACIONES DE NOMINA
|-
| LSS || LIQUIDACIÓN SEGURIDAD SOCIAL
|-
| LQC || LIQUIDACIÓN DE CONTRATOS
|-
| PRE || PRESTAMO DE NOMINA
|-
| PRT || PROGRAMACIÓN DE TURNOS
|-
| SUC || SUCESOS
|-
| NVF || NOVEDAD FACTURA
|-
| NE || NOMINA ELECTRONICA
|-
| OP || ORDENES DE PRODUCCION
|-
| NEA || NOMINA ELECTRONICA AJUSTE
|-
| DDQ || DEVOLUCION DOCUMENTO EQUIVALENTE
|-
| DCC || DEVOLUCION CAUSACION DE COMPRA
|-
| POC || PLANEACION ORDENES DE COMPRA
|-
| POP || PLANEACION ORDENES DE PRODUCCION
|-
| RQ || REQUISICION DE ARTICULOS
|}

== Métodos ==
<Tabs>

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

'''EndPoint:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/TipoDocumento</nowiki>

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/TipoDocumento?limite=50&pagina=1</nowiki>

{| 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": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"id_centro_operacion": 1,
"descripcion_centro_operacion": "DESCRIPCIÓN DEL CENTRO DE OPERACIÓN",
"categoria_doc": "NC",
"prefijo_tipo_doc": "RCA",
"descripcion": "RECIBO DE CAJA",
"numero": 2,
"num_digitos_decimal": 2,
"mensaje_factura1": "MENSAJE DE LA FACTURA 1",
"mensaje_factura2": "MENSAJE DE LA FACTURA 2",
"numero_resolucion_dian": "1234567",
"formato_doc": "PDF",
"prefijo_factura": "PF",
"activo": true,
"sub_costo_venta": 1,
"descripcion_sub_costo_venta": "ADMINISTRACION",
"sub_ingreso_venta": 4,
"descripcion_sub_ingreso_venta": "VENTAS",
"sub_devolucion_venta": 1,
"descripcion_sub_devolucion_venta": "ADMINISTRACION",
"mensaje_factura3": "MENSAJE DE LA FACTURA 3",
"aplica_COLGAAP": true,
"aplica_NIIF": true,
"predeterminado": false,
"aplica_restringe_orden_cronologico": false,
"aplica_fecha_primer_documento": false,
"mensaje_factura4": "MENSAJE DE LA FACTURA 4",
"resolucion_desde": 1234567,
"resolucion_hasta": 1234567,
"res_fecha_desde": "2023-06-01",
"aplica_doc_recurrente": true,
"aplica_intereses_venta": true,
"id_documento_electronico": 6,
"aplica_gestiona_tarea": true,
"aplica_adjuntar_formato_facturaSerpi": true,
"res_fecha_hasta": "2023-06-01",
"seleccione_tipo_doc_soporte_automatico": 1,
"descripcion_tipo_doc_soporte_automatico": "DESCRIPCIÓN DEL TIPO DOCUMENTO",
"seleccione_tipo_devolucion_causacion_compra": 1,
"descripcion_tipo_devolucion_causacion_compra": "DESCRIPCIÓN DEL TIPO DOCUMENTO",
"id_bodega_pos": 2,
"descripcion_bodega_pos": "DESCRIPCIÓN DE LA BODEGA",
"id_tercero_pos": 1234,
"nit_tercero_pos": "1234567",
"descripcion_tercero_pos": "DESCRIPCIÓN DEL TERCERO",
"aplica_asignar_recepcion_electronico": true,
"fecha_recepcion_electronica": "2023-06-01"
}
]
}

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

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Identificador del tipo de documento
|-
| id_centro_operacion || int || Identificador del centro de operación
|-
| descripcion_centro_operacion || string || Descripción del centro de operación
|-
| categoria_doc || string || Categoría del documento (Se especifican en la descripción inicial de esta API)
|-
| prefijo_tipo_doc || string || Prefijo del tipo de documento
|-
| descripcion || string || Descripción del tipo de documento
|-
| numero || int || Número del documento
|-
| num_digitos_decimal || int || Número de dígitos decimales
|-
| mensaje_factura1 || string || Mensaje de factura 1
|-
| mensaje_factura2 || string || Mensaje de factura 2
|-
| numero_resolucion_dian || string || Número de resolución DIAN
|-
| formato_doc || string || Formato del documento
|-
| prefijo_factura || string || Prefijo de la factura
|-
| activo || bool || Indicador de activo
|-
| sub_costo_venta || int || Subcentro de costo para costo de venta
|-
| descripcion_sub_costo_venta || string || Descripción del subcentro de costo para costo de venta
|-
| sub_ingreso_venta || int || Subcentro de costo para ingreso de venta
|-
| descripcion_sub_ingreso_venta || string || Descripción del subcentro de costo para ingreso de venta
|-
| sub_devolucion_venta || int || Subcentro de costo para devolución de venta
|-
| descripcion_sub_devolucion_venta || string || Descripción del subcentro de costo para devolución de venta
|-
| mensaje_factura3 || string || Mensaje de factura 3
|-
| aplica_COLGAAP || bool || Aplica COLGAAP
|-
| aplica_NIIF || bool || Aplica NIIF
|-
| predeterminado || bool || Predeterminado (COLGAAP es false, NIIF es true)
|-
| aplica_restringe_orden_cronologico || bool || Aplica restringe orden cronológico
|-
| aplica_fecha_primer_documento || bool || Aplica fecha primer documento
|-
| mensaje_factura4 || string || Mensaje de factura 4
|-
| resolucion_desde || int || Resolución desde
|-
| resolucion_hasta || int || Resolución hasta
|-
| res_fecha_desde || string || Resolución fecha desde
|-
| aplica_doc_recurrente || bool || Aplica documento recurrente
|-
| aplica_intereses_venta || bool || Aplica intereses de venta
|-
| id_documento_electronico || int || Identificador del documento electrónico (Se especifican en la descripción inicial de esta API)
|-
| aplica_gestiona_tarea || bool || Aplica gestión de tarea
|-
| aplica_adjuntar_formato_facturaSerpi || bool || Aplica adjuntar formato factura SERPI
|-
| res_fecha_hasta || string || Resolución fecha hasta
|-
| seleccione_tipo_doc_soporte_automatico || int || Identificador de la misma tabla de tipos de documento relacionado para soporte automático
|-
| descripcion_tipo_doc_soporte_automatico || string || Descripción del tipo de documento soporte automático relacionado
|-
| seleccione_tipo_devolucion_causacion_compra || int || Identificador de la misma tabla de tipos de documento relacionado a la devolución de causación de compra
|-
| descripcion_tipo_devolucion_causacion_compra || string || Descripción del tipo de documento para devolución de causación de compra relacionado
|-
| id_bodega_pos || int || Identificador de la bodega POS
|-
| descripcion_bodega_pos || string || Descripción de la bodega POS
|-
| id_tercero_pos || int || Identificador del tercero POS
|-
| nit_tercero_pos || string || NIT del tercero POS
|-
| descripcion_tercero_pos || string || Descripción del tercero POS
|-
| aplica_asignar_recepcion_electronico || bool || Aplica asignar recepción electrónica
|-
| fecha_recepcion_electronica || string || Fecha de recepción electrónica
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/TipoDocumento

{| 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">
{
"id_centro_operacion": 1,
"categoria_doc": "NC",
"prefijo_tipo_doc": "RCA",
"descripcion": "RECIBO DE CAJA",
"numero": 2,
"num_digitos_decimal": 2,
"mensaje_factura1": "MENSAJE DE LA FACTURA 1",
"mensaje_factura2": "MENSAJE DE LA FACTURA 2",
"numero_resolucion_dian": "1234567",
"formato_doc": "PDF",
"prefijo_factura": "PF",
"activo": true,
"sub_costo_venta": 1,
"sub_ingreso_venta": 4,
"sub_devolucion_venta": 1,
"mensaje_factura3": "MENSAJE DE LA FACTURA 3",
"aplica_COLGAAP": true,
"aplica_NIIF": true,
"predeterminado": false,
"aplica_restringe_orden_cronologico": false,
"aplica_fecha_primer_documento": false,
"mensaje_factura4": "MENSAJE DE LA FACTURA 4",
"resolucion_desde": 1234567,
"resolucion_hasta": 1234567,
"res_fecha_desde": "2023-06-01",
"aplica_doc_recurrente": true,
"aplica_intereses_venta": true,
"id_documento_electronico": 6,
"aplica_gestiona_tarea": true,
"aplica_adjuntar_formato_facturaSerpi": true,
"res_fecha_hasta": "2023-06-01",
"seleccione_tipo_doc_soporte_automatico": 80,
"seleccione_tipo_devolucion_causacion_compra": 80,
"id_bodega_pos": 2,
"nit_tercero_pos": "1234567",
"aplica_asignar_recepcion_electronico": true,
"fecha_recepcion_electronica": "2023-06-01"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id_centro_operacion || int || 11 || Si || Identificador del centro de operación
|-
| categoria_doc || string || 5 || Si || Categoría del documento (Se especifican en la descripción inicial de esta API)
|-
| prefijo_tipo_doc || string || 5 || Si || Prefijo del tipo de documento
|-
| descripcion || string || 100 || Si || Descripción del documento
|-
| numero || int || 11 || No || Número del documento
|-
| num_digitos_decimal || int || 11 || No || Número de dígitos decimales
|-
| mensaje_factura1 || string || 65535 || No || Mensaje de la factura 1
|-
| mensaje_factura2 || string || 65535 || No || Mensaje de la factura 2
|-
| numero_resolucion_dian || string || 65535 || No || Número de resolución DIAN
|-
| formato_doc || string || 100 || No || Formato del documento
|-
| prefijo_factura || string || 5 || No || Prefijo de la factura
|-
| activo || bool || 1 || No || Indicador de activo
|-
| sub_costo_venta || int || 11 || No || Identificador de subcentro de costo para costo de venta
|-
| sub_ingreso_venta || int || 11 || No || Identificador de subcentro de costo para ingreso de venta
|-
| sub_devolucion_venta || int || 11 || No || Identificador de subcentro de costo para devolución de venta
|-
| mensaje_factura3 || string || 65535 || No || Mensaje de la factura 3
|-
| aplica_COLGAAP || bool || 1 || No || Indicador de aplicación de COLGAAP
|-
| aplica_NIIF || bool || 1 || No || Indicador de aplicación de NIIF
|-
| predeterminado || bool || 1 || No || Indicador predeterminado (COLGAAP es false, NIIF es true)
|-
| aplica_restringe_orden_cronologico || bool || 1 || No || Indicador de aplicación de restricción de orden cronológico
|-
| aplica_fecha_primer_documento || bool || 1 || No || Indicador de aplicación de fecha de primer documento
|-
| mensaje_factura4 || string || 65535 || No || Mensaje de la factura 4
|-
| resolucion_desde || int || 11 || No || Resolución desde
|-
| resolucion_hasta || int || 11 || No || Resolución hasta
|-
| res_fecha_desde || string || 10 || No || Fecha de la resolución desde. Formato YYYY-MM-DD
|-
| aplica_doc_recurrente || bool || 1 || No || Indicador de aplicación de documento recurrente
|-
| aplica_intereses_venta || bool || 1 || No || Indicador de aplicación de intereses de venta
|-
| id_documento_electronico || int || 11 || No || Identificador del documento electrónico (Se especifican en la descripción inicial de esta API)
|-
| aplica_gestiona_tarea || bool || 1 || No || Indicador de aplicación de gestión de tarea
|-
| aplica_adjuntar_formato_facturaSerpi || bool || 1 || No || Indicador de aplicación de adjuntar formato de factura SERPI
|-
| res_fecha_hasta || string || 10 || No || Fecha de la resolución hasta. Formato YYYY-MM-DD
|-
| seleccione_tipo_doc_soporte_automatico || int || 11 || No || Identificador de la misma tabla de tipos de documento relacionado para soporte automático
|-
| seleccione_tipo_devolucion_causacion_compra || int || 11 || No || Identificador de la misma tabla de tipos de documento relacionado a la devolución de causación de compra
|-
| id_bodega_pos || int || 11 || No || Identificador de la bodega POS
|-
| nit_tercero_pos || string || 15 || No || NIT del tercero POS
|-
| aplica_asignar_recepcion_electronico || bool || 1 || No || Indicador de aplicación de asignar recepción electrónica
|-
| fecha_recepcion_electronica || string || 10 || No || Fecha de recepción electrónica. Formato YYYY-MM-DD
|}

==== '''AVISO IMPORTANTE:''' ====
Donde los '''campos no sean obligatorios''' y no se desea asignar algún valor, pruebe digitando '''null''' o '''0''' en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite '''null'''.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [],
"message": "Validaciones exitosas. Registro creado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El centro de operacion 1 no existe",
"El prefijo_tipo_doc RCA ya existe",
"El campo descripcion es obligatorio",
"El campo numero debe ser mínimo 1",
"El id 1 del campo sub_costo_venta no existe",
"El id 4 del campo sub_ingreso_venta no existe",
"El id 1 del campo sub_devolucion_venta no existe",
"El campo res_fecha_hasta es inválido. Formato esperado: yyyy-MM-dd",
"El campo fecha_recepcion_electronica es inválido. Formato esperado: yyyy-MM-dd",
"El id 80 del campo seleccione_tipo_doc_soporte_automatico no existe",
"El id 80 del campo seleccione_tipo_devolucion_causacion_compra no existe",
"El id_bodega_pos 2 no existe",
"El nit_tercero_pos 1234567 no existe",
"El campo categoria_doc con la categoría NC no coincide con alguna de las nomenclaturas especificadas",
"El campo id_documento_electronico debe ser un valor del 0 al 7: 1 (FACTURA), 2 (NOTA DEBITO), 3 (NOTA CREDITO), 4 (DOCUMENTO SOPORTE), 5 (NOTE DE AJUSTE DOCUMENTO SOPORTE), 6 (FACTURA POS), 7 (NOTA CREDITO POR DESCUENTO) o 0 (NO APLICA)"
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/TipoDocumento

{| 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">
{
"id": 1,
"id_centro_operacion": 1,
"categoria_doc": "NC",
"prefijo_tipo_doc": "RCA",
"descripcion": "RECIBO DE CAJA",
"numero": 2,
"num_digitos_decimal": 2,
"mensaje_factura1": "MENSAJE DE LA FACTURA 1",
"mensaje_factura2": "MENSAJE DE LA FACTURA 2",
"numero_resolucion_dian": "1234567",
"formato_doc": "PDF",
"prefijo_factura": "PF",
"activo": true,
"sub_costo_venta": 1,
"sub_ingreso_venta": 4,
"sub_devolucion_venta": 1,
"mensaje_factura3": "MENSAJE DE LA FACTURA 3",
"aplica_COLGAAP": true,
"aplica_NIIF": true,
"predeterminado": false,
"aplica_restringe_orden_cronologico": false,
"aplica_fecha_primer_documento": false,
"mensaje_factura4": "MENSAJE DE LA FACTURA 4",
"resolucion_desde": 1234567,
"resolucion_hasta": 1234567,
"res_fecha_desde": "2023-06-01",
"aplica_doc_recurrente": true,
"aplica_intereses_venta": true,
"id_documento_electronico": 6,
"aplica_gestiona_tarea": true,
"aplica_adjuntar_formato_facturaSerpi": true,
"res_fecha_hasta": "2023-06-01",
"seleccione_tipo_doc_soporte_automatico": 80,
"seleccione_tipo_devolucion_causacion_compra": 80,
"id_bodega_pos": 2,
"nit_tercero_pos": "1234567",
"aplica_asignar_recepcion_electronico": true,
"fecha_recepcion_electronica": "2023-06-01"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || Si || Identificador del tipo de documento
|-
| id_centro_operacion || int || 11 || Si || Identificador del centro de operación
|-
| categoria_doc || string || 5 || Si || Categoría del documento (Se especifican en la descripción inicial de esta API)
|-
| prefijo_tipo_doc || string || 5 || Si || Prefijo del tipo de documento
|-
| descripcion || string || 100 || Si || Descripción del documento
|-
| numero || int || 11 || No || Número del documento
|-
| num_digitos_decimal || int || 11 || No || Número de dígitos decimales
|-
| mensaje_factura1 || string || 65535 || No || Mensaje de la factura 1
|-
| mensaje_factura2 || string || 65535 || No || Mensaje de la factura 2
|-
| numero_resolucion_dian || string || 65535 || No || Número de resolución DIAN
|-
| formato_doc || string || 100 || No || Formato del documento
|-
| prefijo_factura || string || 5 || No || Prefijo de la factura
|-
| activo || bool || 1 || No || Indicador de activo
|-
| sub_costo_venta || int || 11 || No || Identificador de subcentro de costo para costo de venta
|-
| sub_ingreso_venta || int || 11 || No || Identificador de subcentro de costo para ingreso de venta
|-
| sub_devolucion_venta || int || 11 || No || Identificador de subcentro de costo para devolución de venta
|-
| mensaje_factura3 || string || 65535 || No || Mensaje de la factura 3
|-
| aplica_COLGAAP || bool || 1 || No || Indicador de aplicación de COLGAAP
|-
| aplica_NIIF || bool || 1 || No || Indicador de aplicación de NIIF
|-
| predeterminado || bool || 1 || No || Indicador predeterminado (COLGAAP es false, NIIF es true)
|-
| aplica_restringe_orden_cronologico || bool || 1 || No || Indicador de aplicación de restricción de orden cronológico
|-
| aplica_fecha_primer_documento || bool || 1 || No || Indicador de aplicación de fecha de primer documento
|-
| mensaje_factura4 || string || 65535 || No || Mensaje de la factura 4
|-
| resolucion_desde || int || 11 || No || Resolución desde
|-
| resolucion_hasta || int || 11 || No || Resolución hasta
|-
| res_fecha_desde || string || 10 || No || Fecha de la resolución desde. Formato YYYY-MM-DD
|-
| aplica_doc_recurrente || bool || 1 || No || Indicador de aplicación de documento recurrente
|-
| aplica_intereses_venta || bool || 1 || No || Indicador de aplicación de intereses de venta
|-
| id_documento_electronico || int || 11 || No || Identificador del documento electrónico (Se especifican en la descripción inicial de esta API)
|-
| aplica_gestiona_tarea || bool || 1 || No || Indicador de aplicación de gestión de tarea
|-
| aplica_adjuntar_formato_facturaSerpi || bool || 1 || No || Indicador de aplicación de adjuntar formato de factura SERPI
|-
| res_fecha_hasta || string || 10 || No || Fecha de la resolución hasta. Formato YYYY-MM-DD
|-
| seleccione_tipo_doc_soporte_automatico || int || 11 || No || Identificador de la misma tabla de tipos de documento relacionado para soporte automático
|-
| seleccione_tipo_devolucion_causacion_compra || int || 11 || No || Identificador de la misma tabla de tipos de documento relacionado a la devolución de causación de compra
|-
| id_bodega_pos || int || 11 || No || Identificador de la bodega POS
|-
| nit_tercero_pos || string || 15 || No || NIT del tercero POS
|-
| aplica_asignar_recepcion_electronico || bool || 1 || No || Indicador de aplicación de asignar recepción electrónica
|-
| fecha_recepcion_electronica || string || 10 || No || Fecha de recepción electrónica. Formato YYYY-MM-DD
|}

==== '''AVISO IMPORTANTE:''' ====
Donde los '''campos no sean obligatorios''' y no se desea asignar algún valor, pruebe digitando '''null''' o '''0''' en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite '''null'''.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Validaciones exitosas. Registro modificado exitosamente"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id 1"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"El centro de operacion 1 no existe",
"El prefijo_tipo_doc RCA ya existe",
"El campo descripcion es obligatorio",
"El campo numero debe ser mínimo 1",
"El id 1 del campo sub_costo_venta no existe",
"El id 4 del campo sub_ingreso_venta no existe",
"El id 1 del campo sub_devolucion_venta no existe",
"El campo res_fecha_hasta es inválido. Formato esperado: yyyy-MM-dd",
"El campo fecha_recepcion_electronica es inválido. Formato esperado: yyyy-MM-dd",
"El id 80 del campo seleccione_tipo_doc_soporte_automatico no existe",
"El id 80 del campo seleccione_tipo_devolucion_causacion_compra no existe",
"El id_bodega_pos 2 no existe",
"El nit_tercero_pos 1234567 no existe",
"El campo categoria_doc con la categoría NC no coincide con alguna de las nomenclaturas especificadas",
"El campo id_documento_electronico debe ser un valor del 0 al 7: 1 (FACTURA), 2 (NOTA DEBITO), 3 (NOTA CREDITO), 4 (DOCUMENTO SOPORTE), 5 (NOTE DE AJUSTE DOCUMENTO SOPORTE), 6 (FACTURA POS), 7 (NOTA CREDITO POR DESCUENTO) o 0 (NO APLICA)"
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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'''
<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/TipoDocumento")
.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/TipoDocumento");
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/TipoDocumento');
$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 Modulo Ventas

2023-07-10T13:47:50Z

Gpazos:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Ventas'''

*'''[[API Pedidos]]'''
*'''[[API Facturas]]'''
* [[API Facturas/Documentos|API Tipo Documentos Contables]]
* [[API Facturas/Sucursales|API Sucursales]]
* [[API Facturas/Centro_Operaciones|API Centro Operaciones]]
* [[API Facturas/Proyectos|API Proyectos]]
* [[API_Documentos-Contables/Actividades|API Categoria]]
* [[API Facturas/Bodegas|API Bodegas]]
* [[API Facturas/Lista_Precios|API Lista Precios]]
* [[API Facturas/Articulos|API Articulos]]

API Modulo Ensambles Desensambles

2023-07-10T03:38:44Z

Gpazos: Página creada con «Esta es la documentación sobre las APIs relacionadas al módulo de '''Ensambles''' * '''API Ensambles''' * API Documentos Ensambles * API Centro Operaciones * API Proyectos * API Categoria Terceros * API Bodegas * API Articulos/Presentacion-Tipo * API Articulos|API Ar…»

Esta es la documentación sobre las APIs relacionadas al módulo de '''Ensambles'''
* '''[[API Ensambles|API Ensambles]]'''
* [[API Documentos Ensambles|API Documentos Ensambles]]
* [[API Documentos-Contables/Centro_Operaciones |API Centro Operaciones]]
* [[API Documentos-Contables/Proyectos |API Proyectos]]
* [[API Terceros/Categoria_Terceros|API Categoria Terceros]]
* [[API Facturas/Bodegas|API Bodegas]]
* [[API Articulos/Presentacion-Tipo]]
* [[API Articulos|API Articulos]]

API Modulo Compras

2023-07-10T03:34:27Z

Gpazos: Página creada con «Esta es la documentación sobre las APIs relacionadas al módulo de '''Compras''' * '''API Compras''' * API Documentos Compras * API Proyectos * API Categoria Terceros * API Bodegas * API Articulos»

Esta es la documentación sobre las APIs relacionadas al módulo de '''Compras'''
* '''[[API Compras|API Compras]]'''
* [[API Documentos Ventas|API Documentos Compras]]
* [[API Documentos-Contables/Proyectos |API Proyectos]]
* [[API Terceros/Categoria_Terceros|API Categoria Terceros]]
* [[API Facturas/Bodegas|API Bodegas]]
* [[API Articulos|API Articulos]]

API Devoluciones de Venta

2023-07-10T03:31:14Z

Gpazos:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Inventarios'''
* '''[[API Devolucion Ventas|API Devolucion Venta]]'''
* [[API Documentos Ventas|API Documentos Ventas]]
* [[API Documentos-Contables/Sucursales |API Sucursales]]
* [[API Documentos-Contables/Centro_Operaciones |API Centro Operaciones]]
* [[API Documentos-Contables/Proyectos |API Proyectos]]
* [[API Terceros/Categoria_Terceros|API Categoria Terceros]]
* [[API Facturas/Bodegas|API Bodegas]]
* [[API Facturas/Lista_Precios|API Lista Precios]]
* [[API Articulos|API Articulos]]

API Devoluciones de Compra

2023-07-10T03:30:58Z

Gpazos:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Devolucion de Compras'''
* '''[[API Devolucion Compras|API Devolucion Compra]]'''
* [[API Documentos Ventas|API Documentos Compras]]
* [[API Documentos-Contables/Sucursales |API Sucursales]]
* [[API Documentos-Contables/Centro_Operaciones |API Centro Operaciones]]
* [[API Documentos-Contables/Proyectos |API Proyectos]]
* [[API Terceros/Categoria_Terceros|API Categoria Terceros]]
* [[API Facturas/Bodegas|API Bodegas]]
* [[API Facturas/Lista_Precios|API Lista Precios]]
* [[API Articulos|API Articulos]]

API Devoluciones de Compra

2023-07-10T03:30:01Z

Gpazos:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Devolucion de Compras'''
* '''[[API Devolucion Compras|API Devilucion Compras]]'''
* [[API Documentos Ventas|API Documentos Compras]]
* [[API Documentos-Contables/Sucursales |API Sucursales]]
* [[API Documentos-Contables/Centro_Operaciones |API Centro Operaciones]]
* [[API Documentos-Contables/Proyectos |API Proyectos]]
* [[API Terceros/Categoria_Terceros|API Categoria Terceros]]
* [[API Facturas/Bodegas|API Bodegas]]
* [[API Facturas/Lista_Precios|API Lista Precios]]
* [[API Articulos|API Articulos]]

API Devoluciones de Compra

2023-07-10T03:29:39Z

Gpazos: Página creada con «Esta es la documentación sobre las APIs relacionadas al módulo de '''Devolucion de Compras''' * '''API Devilucion Compra''' * API Documentos Compras * API Sucursales * API Centro Operaciones * API Proyectos * API Categoria Terceros * API Facturas/Bo…»

Esta es la documentación sobre las APIs relacionadas al módulo de '''Devolucion de Compras'''
* '''[[API Devolucion Compras|API Devilucion Compra]]'''
* [[API Documentos Ventas|API Documentos Compras]]
* [[API Documentos-Contables/Sucursales |API Sucursales]]
* [[API Documentos-Contables/Centro_Operaciones |API Centro Operaciones]]
* [[API Documentos-Contables/Proyectos |API Proyectos]]
* [[API Terceros/Categoria_Terceros|API Categoria Terceros]]
* [[API Facturas/Bodegas|API Bodegas]]
* [[API Facturas/Lista_Precios|API Lista Precios]]
* [[API Articulos|API Articulos]]

API Devoluciones de Venta

2023-07-10T03:27:21Z

Gpazos:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Inventarios'''
* '''[[API Devolucion Ventas|API Devilucion Venta]]'''
* [[API Documentos Ventas|API Documentos Ventas]]
* [[API Documentos-Contables/Sucursales |API Sucursales]]
* [[API Documentos-Contables/Centro_Operaciones |API Centro Operaciones]]
* [[API Documentos-Contables/Proyectos |API Proyectos]]
* [[API Terceros/Categoria_Terceros|API Categoria Terceros]]
* [[API Facturas/Bodegas|API Bodegas]]
* [[API Facturas/Lista_Precios|API Lista Precios]]
* [[API Articulos|API Articulos]]

API Devoluciones de Venta

2023-07-10T03:15:20Z

Gpazos: Página creada con «Esta es la documentación sobre las APIs relacionadas al módulo de '''Inventarios''' * '''API Saldo Inventario''' * API Ajuste Inventario * API Documentos Inventario * API Grupos»

Esta es la documentación sobre las APIs relacionadas al módulo de '''Inventarios'''
* '''[[API Inventarios/Saldo_Inventarios |API Saldo Inventario]]'''
* [[API Inventarios/Ajuste_Inventario |API Ajuste Inventario]]
* [[API Documentos Inventario|API Documentos Inventario]]
* [[API Terceros/Grupo_Ventas_Compras|API Grupos]]

API Modulo Inventarios

2023-07-10T03:12:57Z

Gpazos:

API Modulo Inventarios

2023-07-10T03:09:28Z

Gpazos:

API Documentos Inventario

2023-07-10T03:08:01Z

Gpazos: Página creada con «'''Descripción:''' Esta API permite la sincronizacion de documentos contables entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas. '''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…»

'''Descripción:'''
Esta API permite la sincronizacion de documentos contables entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas.

'''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, 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 Tipos de Documento">
'''GET/users'''

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

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

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

'''Parámetros'''
{| class="wikitable"
! 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" line="1">
{
"success": true,
"code": 200,
"errors": null,
"message": "2 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "NC",
"prefijo": "RCA",
"descripcion": "RECIBO DE CAJA"
},
{
"id": 2,
"categoriaDocumento": "NC",
"prefijo": "NCC",
"descripcion": "NOTA CONTABLE"
}
]
}

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

</syntaxhighlight>

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


<Tab name = "API Consultar Documentos Contables">
'''POST /users'''

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

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

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

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| tiposDocumentos || Array [Int] || SI || Array de enteros. Son los Ids de los tipos de documentos (Api Consulta tipos documento)
|-
| numeroDesde || int || NO || Numero inicial para filtrar por rango de números de documentos
|-
| numeroHasta || int || NO || 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
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 111,
"categoriaDocumento": "CCO",
"prefijo": "COM",
"numeroDoc": 1,
"nitTerceroEnc": "1234567890",
"nombreTerceroEnc": "ALEJANDRA LOPEZ LOPEZ",
"fechaDocumento": "2023-03-01",
"detalles": [
{
"cuenta": 52954501,
"nitTerceroDet": "1234567890",
"nombreTerceroDet": "ALEJANDRA LOPEZ LOPEZ",
"naturaleza": "D",
"crucePrefijo": null,
"cruceNumero": null,
"fechaVencimiento": null,
"valor": 67900.00000,
"baseImpuesto": 0.00000,
"cuota": 0,
"detalle": "SERV DE TRANSP INFORMAL",
"idSubcentroCosto": 4,
"idCentroOperacion": 1,
"idProyecto": null,
"idActividad": null,
"idSucursal": null
},
{
"cuenta": 23359501,
"nitTerceroDet": "1234567890",
"nombreTerceroDet": "ALEJANDRA LOPEZ LOPEZ",
"naturaleza": "C",
"crucePrefijo": "COM",
"cruceNumero": 3272,
"fechaVencimiento": null,
"valor": 67900.00000,
"baseImpuesto": 0.00000,
"cuota": 0,
"detalle": "SERV DE TRANSP INFORMAL",
"idSubcentroCosto": null,
"idCentroOperacion": 1,
"idProyecto": null,
"idActividad": null,
"idSucursal": null
}
]
}
]
}

{
"success": true,
"code": 204,
"message": "No se encontraron registros",
}
</syntaxhighlight>

''' Campos del resultado'''
{| class="wikitable"
! Campo !! Tipo de Dato !! Descripción
|-
| id || int || Corresponde al id del registro contable
|-
| categoriaDocumento || string || Categoría del tipo de documento
|-
| prefijo || string || Prefijo del tipo de documento
|-
| numeroDoc || Int || Numero del documento contable
|-
| nitTerceroEnc || string || Numero de identificación del tercero del documento contable
|-
| nombreTerceroEnc || string || Nombre del tercero del documento contable
|-
| fechaDocumento || string || Fecha del documento contable
|-
| detalles || Array[ObjetoDetalle]* || Array de objetos de los detalles del documento contable
|}

''' ObjetoDetalle:'''
{| class="wikitable"
! Campo !! Tipo de Dato !! Descripción
|-
| cuenta || Int || Auxiliar o numero de cuenta contable del movimiento
|-
| nitTerceroDet || string || Numero de identificación del tercero del detalle
|-
| nombreTerceroDet || string || Nombre del tercero del detalle
|-
| naturaleza || string || Naturaleza del movimiento (C=Credito, D=Debito)
|-
| crucePrefijo || string || Prefijo del documento cruce
|-
| cruceNumero || Int || Numero del documento cruce
|-
| fechaVencimiento || string || Fecha de vencimiento del movimiento
|-
| valor || decimal || Valor del movimiento
|-
| baseImpuesto || decimal || Valor base de impuesto
|-
| cuota || Int || Numero de cuota, para documentos que manejan contabilización de cuotas
|-
| detalle || string || Comentarios del movimiento
|-
| idSubcentroCosto || Int || Id del subcentro de costo del movimiento
|-
| idCentroOperacion || Int || Id del centro de operacion del movimiento
|-
| idProyecto || Int || Id del proyecto del movimiento
|-
| idActividad || Int || Id de la actividad del movimiento
|-
| idSucursal || Int || Id de la sucursal del tercero del movimiento
|}
</Tab>


<Tab name = "API Crear">

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/DocumentoContable
''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Body:'''
<syntaxhighlight lang="JSON">
[
{
"categoriaDocumento": "CCO",
"prefijo": "COM",
"numeroDoc": 2,
"nitTerceroEnc": "123456789",
"fechaDocumento": "2023-03-01",
"detalles": [
{
"cuenta": 52954501,
"nitTerceroDet": "123456789",
"naturaleza": "D",
"crucePrefijo": null,
"cruceNumero": null,
"fechaVencimiento": null,
"valor": 67900.00000,
"baseImpuesto": 0.00000,
"cuota": 0,
"detalle": "SERV DE TRANSP INFORMAL",
"idSubcentroCosto": 4,
"idCentroOperacion": 1,
"idProyecto": null,
"idActividad": null,
"idSucursal": null
},
{
"cuenta": 23359501,
"nitTerceroDet": "123456789",
"naturaleza": "C",
"crucePrefijo": "COM",
"cruceNumero": 1,
"fechaVencimiento": null,
"valor": 67900.00000,
"baseImpuesto": 0.00000,
"cuota": 0,
"detalle": "SERV DE TRANSP INFORMAL",
"idSubcentroCosto": null,
"idCentroOperacion": 1,
"idProyecto": null,
"idActividad": null,
"idSucursal": null
}
]
}
]

</syntaxhighlight>

''' Campos resultado'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| categoriaDocumento || string || SI || Categoría del tipo de documento
|-
| prefijo || string || SI || Prefijo del tipo de documento
|-
| numeroDoc || Int || SI || Numero del documento contable
|-
| nitTerceroEnc || string || SI || Numero de identificación del tercero del documento contable
|-
| fechaDocumento || string || SI || Fecha del documento contable
|-
| detalles || Array[ObjetoDetalle]* || SI || Array de objetos de los detalles del documento contable
|}

''' ObjetoDetalle:'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| cuenta || Int || SI || Auxiliar o numero de cuenta contable del movimiento
|-
| nitTerceroDet || string || SI || Numero de identificación del tercero del detalle
|-
| naturaleza || string || SI || Naturaleza del movimiento (C=Credito, D=Debito)
|-
| crucePrefijo || string || NO || Prefijo del documento cruce
|-
| cruceNumero || Int || NO || Numero del documento cruce
|-
| fechaVencimiento || string || NO || Fecha de vencimiento del movimiento
|-
| valor || decimal || SI || Valor del movimiento
|-
| baseImpuesto || decimal || NO || Valor base de impuesto
|-
| cuota || Int || NO || Numero de cuota, para documentos que manejan contabilización de cuotas
|-
| detalle || string || NO || Comentarios del movimiento
|-
| idSubcentroCosto || Int || NO || Id del subcentro de costo del movimiento
|-
| idCentroOperacion|| Int || NO || Id del centro de operacion del movimiento
|-
| idProyecto || Int || NO || Id del proyecto del movimiento
|-
| idActividad || Int || NO || Id de la actividad del movimiento
|-
| idSucursal || Int || NO || Id de la sucursal del tercero del movimiento
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 documentos contables"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Eliminar">
'''PUT/users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/DocumentoContable
''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

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

''' Campos Solicitados '''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| idTipoDocumento || int || SI || Id del tipo de documento
|-
| numeroDesde || int || SI || Numero inicial para filtrar por rango de números de documentos
|-
| numeroHasta || int || 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
|}

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

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

</syntaxhighlight>
</Tab>

</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https:///www.apis.serpi.com.co/api/v1/DocumentoContable")
.method("GET", body)
.addHeader("secretkey", "{Secret Key}")
.addHeader("Authorization", "{Bearer Token}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Python">
'''Request'''
<syntaxhighlight lang="java" line="1">
import requests

url = "https://www.apis.serpi.com.co/api/v1/DocumentoContable"

payload = {}
headers = {
'secretkey': '{Secret Key}',
'Authorization': '{Bearer Token}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Php">
'''Request'''
<syntaxhighlight lang="java" line="1">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://www.apis.serpi.com.co/api/v1/DocumentoContable');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{Secret Key}',
'Authorization' => '{Bearer Token}'
));
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>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

</Tabs>

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]

API Modulo Inventarios

2023-07-10T03:07:47Z

Gpazos:

API Saldos Inventario

2023-07-07T20:52:30Z

Gpazos: Página creada con «'''Descripción:''' Esta API permite la sincronización de los tipos de presentación de productos entre SERPI y la plataforma que lo requiera. '''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. '''Tipos de peticiones:''' GET, POST, PUT == Métodos == <Tabs> <!-…»

'''Descripción:'''
Esta API permite la sincronización de los tipos de presentación de productos entre SERPI y la plataforma que lo requiera.

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

'''Tipos de peticiones:'''
GET, POST, PUT

== Métodos ==
<Tabs>

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

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

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/TipoPresentacion?limite=50&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 !! 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": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"codigo": "1",
"descripcion": "TIPO PRESENTACION DEMO"
}
]
}

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

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador del tipo de presentacion
|-
| codigo|| string || Corresponde al código del tipo de presentacion
|-
| description|| string || Descripción del tipo de presentacion
</Tab>


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

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

{| 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">
{
"codigo": "1",
"descripcion": "TIPO PRESENTACION DEMO"
}

</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo|| string || 20 || Si || Código del tipo de presentación
|-
| descripcion|| string || 100 || Si || Descripción del tipo de presentación
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [],
"message": "Validaciones exitosas. Registro creado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El codigo 1 ya existe"
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/TipoPresentacion

{| 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">
{
"id": 1,
"codigo": "1",
"descripcion": "TIPO PRESENTACION DEMO"
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || Si || Corresponde al identificador del tipo de presentación
|-
| codigo|| string || 20 || Si || Código del tipo de presentación
|-
| descripcion|| string || 100 || Si || Descripción del tipo de presentación
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "registro modificado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"El campo descripcion es obligatorio",
"La codigo 1 ya esta asociado al id X"
],
"message": "Se presentaron errores al modificar el registro"
}
</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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'''
<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/TipoPresentacion")
.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/TipoPresentacion");
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/TipoPresentacion');
$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 Modulo Inventarios

2023-07-07T20:51:39Z

Gpazos:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Inventarios'''
* '''[[API Inventarios/Saldo_Inventarios |API Saldo Inventario]]'''
* [[API Inventarios/Ajuste_Inventario |API Ajuste Inventario]]
* [[API Saldos Inventario|API Tipo Documentos Contables]]
* [[API Saldos Inventario|API Grupos]]
* [[API Saldos Inventario|API Ubicaciones]]

API Modulo Inventarios

2023-07-07T20:45:28Z

Gpazos:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Inventarios'''
* '''[[API Inventarios/Saldo_Inventarios |API Saldo Inventario]]'''
* [[API Inventarios/Ajuste_Inventario |API Ajuste Inventario]]
* [[API Documentos|API Tipo Documentos Contables]]
* [[API Grupos|API Tipo Documentos Contables]]
* [[API Articulos/Grupos Contables]]

API Modulo Inventarios

2023-07-07T20:43:57Z

Gpazos:

API Modulo Inventarios

2023-07-07T20:43:33Z

Gpazos:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Inventarios'''
* '''[[API Inventarios/Saldo_Inventarios |API Saldo Inventario]]'''
* [[API Inventarios/Ajuste_Inventario |API Ajuste Inventario]]
* [[API Documentos|API Tipo Documentos Contables|API Ajuste Inventario]]

API Modulo Inventarios

2023-07-07T20:42:34Z

Gpazos:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Inventarios'''

* '''[[API Inventarios/Saldo_Inventarios |API Saldo Inventario]]'''
* [[API Inventarios/Ajuste_Inventario |API Ajuste Inventario]]
* [[API Documentos/API Tipo Documentos Contables|API Ajuste Inventario]]

Nomina

2023-07-06T21:46:06Z

Gpazos: /* Liquidación */

SERPI ERP, cuenta con una de las nóminas más completas del mercado , con un diseño intuitivo, con la posibilidad de administrar de manera ágil la información

==Parámetros==
En esta opción se lleva cabo la parametrización de la nómina, definiendo cada uno de sus componentes y valores de referencia, los siguientes son sus módulos:

<ul class="accordion">
<li>
<div class="tab">organización</div>
<div class="content">

*'''Cargos'''
[[File:Serpi cargos.jpg|frameless]]'''.'''
'''Ruta:''' Nómina/ Parámetros/ Organizacion/ Cargos/ Crear
Esta opción permite Crear lo diferentes cargos desempeñados en la empresa , el modelo de creación es el estándar de SERPI,
Se puede hacer la creación de nuevos cargos, eliminación o edición de los mismos.

[[File:CARGOS CREAR.jpg|frameless|445x445px]]

En la opción crear aparece el cuadro el cual debe ser llenado con descripción del cargo y los rangos del salario, dar guardar y quedará hecho.

[[File:RANGOS SALARIOS.jpg|frameless|388x388px]]
Contenido de la pestaña 1.
</div>
</li>
<li>
<div class="tab">Liquidación</div>
<div class="content">
Contenido de la pestaña 2
</div>
</li>

<li>
<div class="tab">Planilla Pila</div>
<div class="content">
Contenido de la pestaña 2
</div>
</li>

<li><div class="tab">IBC</div>
<div class="content">
Contenido de la pestaña 2
</div>

</ul>

Parámetros para realizar liquidaciones de diferentes campos en nómina a acomodo de la ley y/o políticas de la empresa[[Archivo:LIQUIDACION.jpg|sinmarco|1028x1028px]]<ul class="accordion">
<li>'''Periodo de Nómina'''
</li></ul>[[Archivo:PERIODOS DE NOMINA.jpg|sinmarco|671x671px]]

Es el campo encargado de identificar los periodos de pago, ya sean mensual, quincenal, semanal o en su defecto diario.

se pueden crear diferentes periodos y/o eliminar

[[Archivo:Periodo crear.jpg|sinmarco|687x687px]]

* '''Formas de Pago'''
Existen diversas formas de pago que pueden utilizarse en transacciones de nomina, por ejemplo:

# Efectivo
# Cheque
# Transferencia Bancaria

[[Archivo:FORMAS DE PAGO.jpg|sinmarco|454x454px]]

En este punto creamos las formas que la empresa va a manejar las formas de pago.

[[Archivo:EFECTIVO.jpg|sinmarco|891x891px]]

Se pueden crear varias formas de pago con su respectiva abreviatura, al igual se pueden eliminar.

[[Archivo:CREACION DE EFECTIVO.jpg|sinmarco|431x431px]]

* '''Días de Corte de Pago'''
Los días de corte de pago de nómina son las fechas establecidas por un empleador para determinar el período de tiempo que se tomará en cuenta al calcular los salarios de los empleados.

El día de corte de pago de nómina puede variar según la política de cada empresa, pero generalmente se establece al final de un período de tiempo regular, como una semana, quincena o mes.

[[Archivo:DIAS CORTE DE PAGO.jpg|sinmarco|452x452px]]

Se crean los dias de pago o cortes que la empresa maneje para liquidar la nómina ya sea por proyectos o grupos.

Por ejemplo, si una empresa tiene un período de pago quincenal, el día de corte podría ser el último día de la quincena, y se tomarían en cuenta los días trabajados desde el último día de corte hasta esa fecha.

[[Archivo:DIAS DE PAGO 1.jpg|sinmarco|461x461px]]

* '''Retención en la Fuente'''

[[Archivo:RETENCION EN LA FUENTE.jpg|sinmarco|453x453px]]

La retención en la fuente a empleados es un mecanismo utilizado por los gobiernos para recaudar impuestos de forma anticipada sobre los ingresos que los empleados reciben a través de sus salarios.

Es fundamental que los empleadores cumplan adecuadamente con las obligaciones de retención en la fuente a empleados para evitar sanciones y problemas legales.

En esta parte del sistema se parametrizan los rangos de porcentaje a realizar al empleado según sus devengos

[[Archivo:RT FUENTE 1.jpg|sinmarco|774x774px]]

[[Archivo:RANGOS RT.jpg|sinmarco|418x418px]]

* '''Parámetros Anuales'''

[[Archivo:PARAMETROS ANUALES.jpg|sinmarco|447x447px]]

En esta parte del sistema se configura la nómina, se refiere a los elementos o factores que se tienen en cuenta al calcular y determinar los valores relacionados con los salarios y las deducciones de los empleados a lo largo de un año fiscal. Estos parámetros son utilizados por los empleadores para realizar cálculos precisos y consistentes en la gestión de la nómina.

Es importante tener en cuenta que los parámetros anuales en nómina pueden variar según las regulaciones laborales y fiscales de cada país. Por lo tanto, los empleadores deben mantenerse actualizados con los cambios legales y ajustar los parámetros de nómina en consecuencia para asegurar el cumplimiento adecuado y justo de las obligaciones salariales y fiscales.

[[Archivo:PARAMETROS ANUALES 1.jpg|sinmarco|529x529px]]

[[Archivo:PARAMETROS ANUALES 3.jpg|sinmarco|543x543px]]

* '''Variables'''
Las variables de nómina son elementos o factores que se consideran al calcular los salarios y deducciones de los empleados. Estas variables pueden afectar directamente el monto que un empleado recibe como salario o la cantidad que se deduce de su salario para fines como impuestos, seguridad social u otros conceptos.

[[Archivo:VARIABLES.jpg|sinmarco|450x450px]]

Encontramos las variables y las abreviaturas que se manejan internamente por empresa

[[Archivo:VARIABLES 1.jpg|sinmarco|560x560px]]

* '''Conceptos'''
se refieren a los elementos específicos que componen el desglose detallado de los ingresos, deducciones y otros aspectos relacionados con el salario de un empleado en un período determinado. Estos conceptos describen y categorizan los diferentes componentes que conforman la nómina de un trabajador.

Es importante destacar que los conceptos de nómina pueden variar según las políticas y regulaciones laborales y fiscales de cada país y empresa. Los empleadores deben asegurarse de seguir las normativas correspondientes y proporcionar una nómina clara y detallada que refleje todos los conceptos relevantes para el cálculo del salario neto de sus empleados.

[[Archivo:CONCEPTOS.jpg|sinmarco|450x450px]]

Algunos de los conceptos comunes que se pueden hallar en las nomina

# Liquidacion de Nomina
# Liquidación de Prima
# Incapacidad
# Vacaciones

[[Archivo:CONCEPTOS 1.jpg|sinmarco|520x520px]]

Cada empresa es libre de crear sus propios conceptos y tratamientos de nómina

* '''Tipo de Terminación de Contrato'''
La terminación de contrato se refiere al cese de la relación laboral entre un empleador y un empleado. Puede ocurrir por diversas razones y existen diferentes tipos de terminación de contrato.

[[Archivo:TERMINACION DE CONTRATO.jpg|sinmarco|447x447px]]

# Terminación por mutuo acuerdo: Ocurre cuando ambas partes, el empleador y el empleado, acuerdan poner fin al contrato laboral de manera consensuada. Puede deberse a razones como reestructuraciones internas, cambios en las circunstancias laborales o acuerdos amistosos.
# Terminación por despido: Sucede cuando el empleador decide poner fin al contrato laboral debido a razones como bajo rendimiento, mala conducta, incumplimiento de políticas o normas de la empresa, reducción de la plantilla, cierre de operaciones o motivos económicos.
# Terminación por renuncia voluntaria: Ocurre cuando el empleado decide poner fin al contrato laboral de manera voluntaria, generalmente para aceptar otra oportunidad laboral, por motivos personales o por insatisfacción con las condiciones de trabajo.
# Terminación por término del contrato a plazo fijo: En algunos casos, los contratos laborales se establecen por un período de tiempo específico. Cuando ese período llega a su fin, el contrato se termina automáticamente sin necesidad de una acción específica.
# Terminación por jubilación: Ocurre cuando el empleado llega a la edad de jubilación establecida por la legislación o los acuerdos laborales y decide dejar de trabajar. En este caso, la terminación del contrato se produce debido a la jubilación del empleado.

[[Archivo:TERMINACION DE CONTRATO 1.jpg|sinmarco|539x539px]]

Es importante tener en cuenta que las razones y los procedimientos de terminación de contrato pueden variar según las leyes laborales y los acuerdos laborales vigentes en cada país. Es fundamental que tanto el empleador como el empleado cumplan con las regulaciones y los procedimientos adecuados para evitar conflictos legales y asegurar una terminación justa y adecuada.

* '''Préstamos y Libranzas'''
[[Archivo:PRESTAMOS.jpg|sinmarco|447x447px]]

'''Préstamos:''' .En el contexto laboral, los empleados pueden acceder a préstamos a través de su empleador o mediante acuerdos con instituciones financieras externas. Estos préstamos pueden utilizarse para diversos fines, como consolidación de deudas, compra de bienes o servicios, gastos médicos o emergencias. (crear las cuentas a las que se debe amarrar el documento)

[[Archivo:PRESTAMOS 1.jpg|sinmarco|458x458px]]

'''Libranzas:''' Una libranza es un mecanismo mediante el cual un empleado autoriza al empleador a deducir de su salario ciertas sumas de dinero para el pago de obligaciones financieras. Generalmente, estas obligaciones son préstamos, créditos o deudas adquiridas por el empleado. (deben ir amarradas a un tercero distinto, entidad financiera, cooperativa etc. también configurar las cuentas las cuales va a afectar el documento como tal)

[[Archivo:LIBRANZA.jpg|sinmarco|427x427px]]

'''Nota:''' El documentos '''PRENO''' debe estar creado en configuracion/configuracion empresa/documentos/préstamo

* '''Embargos'''
Es una orden legal que permite a un acreedor cobrar una deuda directamente del salario de un deudor. En pocas palabras, cuando se produce un embargo de nómina, el empleador retiene una parte del salario del empleado para pagar una deuda pendiente

[[Archivo:EMBARGOS.jpg|sinmarco|450x450px]]

En esta pantalla se genera el tipo de embargo que se va a manejar, ya sea por alimentos, moras, etc.

[[Archivo:EMBARGOS 1.jpg|sinmarco|603x603px]]

Un embargo de nómina es una medida legal que permite a un acreedor cobrar una deuda al retener parte del salario del deudor a través de una orden judicial, también se debe tener en cuenta la cantidad que puede ser embargada y garantizan que el deudor tenga suficiente dinero para cubrir sus necesidades básicas.

[[Archivo:EMBARGO 2.jpg|sinmarco|515x515px]]

* '''Certificado Ret'''
proporciona detalles sobre las deducciones y retenciones realizadas en el salario del empleado durante un período específico, generalmente un año fiscal.

[[Archivo:CERTIDICADO DE RET.jpg|sinmarco|445x445px]]

En esta pantalla encontramos el informe de Medios Magnéticos de nómina y también el formato 220 que nos da los ingresos y deducciones del empleados

[[Archivo:CERTIFICADO INGR.jpg|sinmarco|731x731px]]

Aquí encontramos la parametrización del formato 220 en donde se amarran los conceptos de los ingresos

[[Archivo:CERTIFICADO INGR 2.jpg|sinmarco|538x538px]]

En el botón de generar encontramos el formato por empleado, el cual se descarga firma y entrega al empleado solicitante

[[Archivo:GENERAR CERTIFICADO.jpg|sinmarco|541x541px]]

'''''FORMATO 220'''''

[[Archivo:CERTIFICADO INGR 3.jpg|sinmarco|523x523px]]

* '''Formato Carta Laboral'''
[[Archivo:CARTA LABORAL.jpg|sinmarco|450x450px]]

* '''Variables de Nómina Electrónica'''

<div class="content">
Contenido de la pestaña 2
</div>[[Archivo:VARIABLES DE NOMINA.jpg|sinmarco|448x448px]]<ul class="accordion"><li><div class="tab">Planilla Pila</div>
<div class="content">
Contenido de la pestaña 2
</div>
</li>

<li>
<div class="tab">IBC</div>
<div class="content">
Contenido de la pestaña 2
</div>

</ul>

===Organización===
[[File:Serpi Nomina organizacion.jpg|frameless|703x703px]]

*'''Áreas'''
[[File:AREAS.jpg|frameless|453x453px]]

Sirve para clasificar la ubicación del empleado dentro de la empresa.

*'''Tipos de contrato'''
[[File:TIPOS DE CON.jpg|frameless|446x446px]]

Este es un campo en el que se especifica que tipos de contrato se manejarán dentro de la empresa y que se adaptarán al tipo de pago de cada trabajador.

se da crear y se habilita el campo de descripción, si es fijo e indefinido; también se debe tener claro a qué código de la nómina electrónica pertenece ante la DIAN, ya que, es un campo que aparece en la trasmisión de la misma. también se tiene la opción de editar y eliminar.

*'''Entidades'''
[[File:ENTIDADES.jpg|frameless|453x453px]]

'''RUTA: Nómina / Parámetros / Organización / Entidades'''

'''CREAR LA ENTIDAD EN NÓMINA''': estas son las utilizadas para la liquidación de la seguridad social y la provisión de cada empleado dependiendo a que ente este afiliado.

Es uno de los puntos más importantes en la nómina, pues es el encargado de realizar los debidos descuentos y pagos a cada trabajador.

Se puede crear, editar y eliminar cualquier entidad que se necesite

'''Nota:''' las entidades deben de estar creadas en los módulos de <u>'''TERCEROS, GRUPO DE EMPLEADOS, SUBCENTRO DE COSTOS'''</u>

[[Archivo:CREAR ENTIDAD.jpg|sinmarco|611x611px]]

*'''Grupos de empleados'''
[[Archivo:GRUPO DE EMPLEADOS.jpg|sinmarco|444x444px]]

En este módulo se configura el grupo al que va a pertenecer el empleado y cuáles van a ser los tratamientos que se van a llevar a cabo al momento de liquidar la nómina.

En el grupo de empleados debemos tener en cuenta cual es el subcentro de costos que se va a manejar para el proceso contable en el sistema, las entidades que tiene cada empleado y la configuración de Rangos de FSP

[[Archivo:EDICION GEMPLEADOS.jpg|sinmarco|920x920px]]

Se debe configurar el nombre que llevara a cabo el grupo de empleados, la cuenta del salario por pagar y demás configuraciones que se tendrán en cuenta.

[[Archivo:DESCRIPCION GRUPO EMPLEADOS.jpg|sinmarco|609x609px]]

También los porcentajes de descuento de '''ARL, EPS, PENSION''' o si el empleado es aprendiz en etapa lectiva o productiva (se generan descuentos distintos) y siempre garantizar el SMLV a los trabajadores para tener en cuenta en una incapacidad y o en algún descuento

[[Archivo:Porcentajes.jpg|borde|sinmarco|616x616px]]

En vinculaciones, se recomienda tener configuradas las necesarias por cada uno de los grupos. Ejemplo: '''ENTIDAD PRESTADORA DE SALUD''' para los aprendices en etapa lectiva o para los de administración que cuentan con las 4 entidades obligatorias ('''ARL,EPS,PENSION, CAJA DE COMPENSACIÓN''').

[[Archivo:VINCULACIONES.jpg|sinmarco|616x616px]]

En cuanto a la configuración del '''FSP''' se deben de configurar los rangos en cada uno de los grupos creados con las debidas tarifas

[[Archivo:RANGOS FSP.jpg|sinmarco|616x616px]]

*'''Actividades'''
[[Archivo:ACTIVIDADES.jpg|sinmarco|450x450px]]

Esta configuración está basada en las tasas de cotización de la ARL vinculada a la empresa, dependiendo del margen que se maneje por cada grupo de empleado y riesgo que se enfrente segun su area.

[[Archivo:TASAS DE COTIZACIÓN.jpg|sinmarco|609x609px]]
*'''Bancos'''
[[Archivo:BANCOS.jpg|sinmarco|442x442px]]

Cada empresa maneja sus entes financieros, al igual que cada empleado; se debe crear cada uno y configurar los parámetros necesarios para generar el pago y los descuentos manejados en el módulo de la Nómina

[[Archivo:BANCOS 2.jpg|sinmarco|740x740px]]

'''Bancos Empresa''', para crearlos son aquellos que son internos con los que se realizan pagos de nómina y se deben configurar con el código legal del ente, el número de la cuenta y la cuenta contable con la cual se hará el manejo

[[Archivo:BANCOS EMPRESA.jpg|sinmarco|577x577px]]

'''Banco Empleado''' se debe crear ya que es en el cual se va a realizar el pago de la nómina y otros ingresos que este tenga,

Estos son los bancos que se manejan para parametrizar el pago de los empleados, dependiendo cual maneja cada uno de ellos. Esta creación debe tener el campo del código que es legal del banco y el nombre.

[[Archivo:BANCOS EMPLEADOS.jpg|sinmarco|660x660px]]

*'''Codigos Actividad ARL'''

[[Archivo:CODIGOS DE ACTIVIDAD.jpg|sinmarco|444x444px]]

En la configuración de la base de Datos al instalar Serpi, deben ir incluidas las actividades legales, si por algún motivo el campo se encuentra vacío se deberán comunicar con el área de soporte para acomodar el modulo con la información que se necesita

[[Archivo:ARL CODIGOS.jpg|sinmarco|842x842px]]
===Planilla Pila===

===Liquidación===
ffffgfgfg

===IBC===

==Procesos==
*Opcion 1
https://felcowiki.thefactoryhka.com.co/index.php/Primeros_Pasos_-_Portal_HKAN%C3%B3mina#Registro_en_Portal_Factura_Electr.C3.B3nica_.28Ambiente_Demo.29

*Opcion 2

==Integraciones==

==Informes==

Nomina

2023-07-06T21:42:47Z

Gpazos: /* IBC */

SERPI ERP, cuenta con una de las nóminas más completas del mercado , con un diseño intuitivo, con la posibilidad de administrar de manera ágil la información

==Parámetros==
En esta opción se lleva cabo la parametrización de la nómina, definiendo cada uno de sus componentes y valores de referencia, los siguientes son sus módulos:

<ul class="accordion">
<li>
<div class="tab">organización</div>
<div class="content">

*'''Cargos'''
[[File:Serpi cargos.jpg|frameless]]'''.'''
'''Ruta:''' Nómina/ Parámetros/ Organizacion/ Cargos/ Crear
Esta opción permite Crear lo diferentes cargos desempeñados en la empresa , el modelo de creación es el estándar de SERPI,
Se puede hacer la creación de nuevos cargos, eliminación o edición de los mismos.

[[File:CARGOS CREAR.jpg|frameless|445x445px]]

En la opción crear aparece el cuadro el cual debe ser llenado con descripción del cargo y los rangos del salario, dar guardar y quedará hecho.

[[File:RANGOS SALARIOS.jpg|frameless|388x388px]]
Contenido de la pestaña 1.
</div>
</li>
<li>
<div class="tab">Liquidación</div>
<div class="content">
Contenido de la pestaña 2
</div>
</li>

<li>
<div class="tab">Planilla Pila</div>
<div class="content">
Contenido de la pestaña 2
</div>
</li>

<li><div class="tab">IBC</div>
<div class="content">
Contenido de la pestaña 2
</div>

</ul>

Parámetros para realizar liquidaciones de diferentes campos en nómina a acomodo de la ley y/o políticas de la empresa[[Archivo:LIQUIDACION.jpg|sinmarco|1028x1028px]]<ul class="accordion">
<li>'''Periodo de Nómina'''
</li></ul>[[Archivo:PERIODOS DE NOMINA.jpg|sinmarco|671x671px]]

Es el campo encargado de identificar los periodos de pago, ya sean mensual, quincenal, semanal o en su defecto diario.

se pueden crear diferentes periodos y/o eliminar

[[Archivo:Periodo crear.jpg|sinmarco|687x687px]]

* '''Formas de Pago'''
Existen diversas formas de pago que pueden utilizarse en transacciones de nomina, por ejemplo:

# Efectivo
# Cheque
# Transferencia Bancaria

[[Archivo:FORMAS DE PAGO.jpg|sinmarco|454x454px]]

En este punto creamos las formas que la empresa va a manejar las formas de pago.

[[Archivo:EFECTIVO.jpg|sinmarco|891x891px]]

Se pueden crear varias formas de pago con su respectiva abreviatura, al igual se pueden eliminar.

[[Archivo:CREACION DE EFECTIVO.jpg|sinmarco|431x431px]]

* '''Días de Corte de Pago'''
Los días de corte de pago de nómina son las fechas establecidas por un empleador para determinar el período de tiempo que se tomará en cuenta al calcular los salarios de los empleados.

El día de corte de pago de nómina puede variar según la política de cada empresa, pero generalmente se establece al final de un período de tiempo regular, como una semana, quincena o mes.

[[Archivo:DIAS CORTE DE PAGO.jpg|sinmarco|452x452px]]

Se crean los dias de pago o cortes que la empresa maneje para liquidar la nómina ya sea por proyectos o grupos.

Por ejemplo, si una empresa tiene un período de pago quincenal, el día de corte podría ser el último día de la quincena, y se tomarían en cuenta los días trabajados desde el último día de corte hasta esa fecha.

[[Archivo:DIAS DE PAGO 1.jpg|sinmarco|461x461px]]

* '''Retención en la Fuente'''

[[Archivo:RETENCION EN LA FUENTE.jpg|sinmarco|453x453px]]

La retención en la fuente a empleados es un mecanismo utilizado por los gobiernos para recaudar impuestos de forma anticipada sobre los ingresos que los empleados reciben a través de sus salarios.

Es fundamental que los empleadores cumplan adecuadamente con las obligaciones de retención en la fuente a empleados para evitar sanciones y problemas legales.

En esta parte del sistema se parametrizan los rangos de porcentaje a realizar al empleado según sus devengos

[[Archivo:RT FUENTE 1.jpg|sinmarco|774x774px]]

[[Archivo:RANGOS RT.jpg|sinmarco|418x418px]]

* '''Parámetros Anuales'''

[[Archivo:PARAMETROS ANUALES.jpg|sinmarco|447x447px]]

En esta parte del sistema se configura la nómina, se refiere a los elementos o factores que se tienen en cuenta al calcular y determinar los valores relacionados con los salarios y las deducciones de los empleados a lo largo de un año fiscal. Estos parámetros son utilizados por los empleadores para realizar cálculos precisos y consistentes en la gestión de la nómina.

Es importante tener en cuenta que los parámetros anuales en nómina pueden variar según las regulaciones laborales y fiscales de cada país. Por lo tanto, los empleadores deben mantenerse actualizados con los cambios legales y ajustar los parámetros de nómina en consecuencia para asegurar el cumplimiento adecuado y justo de las obligaciones salariales y fiscales.

[[Archivo:PARAMETROS ANUALES 1.jpg|sinmarco|529x529px]]

[[Archivo:PARAMETROS ANUALES 3.jpg|sinmarco|543x543px]]

* '''Variables'''
Las variables de nómina son elementos o factores que se consideran al calcular los salarios y deducciones de los empleados. Estas variables pueden afectar directamente el monto que un empleado recibe como salario o la cantidad que se deduce de su salario para fines como impuestos, seguridad social u otros conceptos.

[[Archivo:VARIABLES.jpg|sinmarco|450x450px]]

Encontramos las variables y las abreviaturas que se manejan internamente por empresa

[[Archivo:VARIABLES 1.jpg|sinmarco|560x560px]]

* '''Conceptos'''
se refieren a los elementos específicos que componen el desglose detallado de los ingresos, deducciones y otros aspectos relacionados con el salario de un empleado en un período determinado. Estos conceptos describen y categorizan los diferentes componentes que conforman la nómina de un trabajador.

Es importante destacar que los conceptos de nómina pueden variar según las políticas y regulaciones laborales y fiscales de cada país y empresa. Los empleadores deben asegurarse de seguir las normativas correspondientes y proporcionar una nómina clara y detallada que refleje todos los conceptos relevantes para el cálculo del salario neto de sus empleados.

[[Archivo:CONCEPTOS.jpg|sinmarco|450x450px]]

Algunos de los conceptos comunes que se pueden hallar en las nomina

# Liquidacion de Nomina
# Liquidación de Prima
# Incapacidad
# Vacaciones

[[Archivo:CONCEPTOS 1.jpg|sinmarco|520x520px]]

Cada empresa es libre de crear sus propios conceptos y tratamientos de nómina

* '''Tipo de Terminación de Contrato'''
La terminación de contrato se refiere al cese de la relación laboral entre un empleador y un empleado. Puede ocurrir por diversas razones y existen diferentes tipos de terminación de contrato.

[[Archivo:TERMINACION DE CONTRATO.jpg|sinmarco|447x447px]]

# Terminación por mutuo acuerdo: Ocurre cuando ambas partes, el empleador y el empleado, acuerdan poner fin al contrato laboral de manera consensuada. Puede deberse a razones como reestructuraciones internas, cambios en las circunstancias laborales o acuerdos amistosos.
# Terminación por despido: Sucede cuando el empleador decide poner fin al contrato laboral debido a razones como bajo rendimiento, mala conducta, incumplimiento de políticas o normas de la empresa, reducción de la plantilla, cierre de operaciones o motivos económicos.
# Terminación por renuncia voluntaria: Ocurre cuando el empleado decide poner fin al contrato laboral de manera voluntaria, generalmente para aceptar otra oportunidad laboral, por motivos personales o por insatisfacción con las condiciones de trabajo.
# Terminación por término del contrato a plazo fijo: En algunos casos, los contratos laborales se establecen por un período de tiempo específico. Cuando ese período llega a su fin, el contrato se termina automáticamente sin necesidad de una acción específica.
# Terminación por jubilación: Ocurre cuando el empleado llega a la edad de jubilación establecida por la legislación o los acuerdos laborales y decide dejar de trabajar. En este caso, la terminación del contrato se produce debido a la jubilación del empleado.

[[Archivo:TERMINACION DE CONTRATO 1.jpg|sinmarco|539x539px]]

Es importante tener en cuenta que las razones y los procedimientos de terminación de contrato pueden variar según las leyes laborales y los acuerdos laborales vigentes en cada país. Es fundamental que tanto el empleador como el empleado cumplan con las regulaciones y los procedimientos adecuados para evitar conflictos legales y asegurar una terminación justa y adecuada.

* '''Préstamos y Libranzas'''
[[Archivo:PRESTAMOS.jpg|sinmarco|447x447px]]

'''Préstamos:''' .En el contexto laboral, los empleados pueden acceder a préstamos a través de su empleador o mediante acuerdos con instituciones financieras externas. Estos préstamos pueden utilizarse para diversos fines, como consolidación de deudas, compra de bienes o servicios, gastos médicos o emergencias. (crear las cuentas a las que se debe amarrar el documento)

[[Archivo:PRESTAMOS 1.jpg|sinmarco|458x458px]]

'''Libranzas:''' Una libranza es un mecanismo mediante el cual un empleado autoriza al empleador a deducir de su salario ciertas sumas de dinero para el pago de obligaciones financieras. Generalmente, estas obligaciones son préstamos, créditos o deudas adquiridas por el empleado. (deben ir amarradas a un tercero distinto, entidad financiera, cooperativa etc. también configurar las cuentas las cuales va a afectar el documento como tal)

[[Archivo:LIBRANZA.jpg|sinmarco|427x427px]]

'''Nota:''' El documentos '''PRENO''' debe estar creado en configuracion/configuracion empresa/documentos/préstamo

* '''Embargos'''
Es una orden legal que permite a un acreedor cobrar una deuda directamente del salario de un deudor. En pocas palabras, cuando se produce un embargo de nómina, el empleador retiene una parte del salario del empleado para pagar una deuda pendiente

[[Archivo:EMBARGOS.jpg|sinmarco|450x450px]]

En esta pantalla se genera el tipo de embargo que se va a manejar, ya sea por alimentos, moras, etc.

[[Archivo:EMBARGOS 1.jpg|sinmarco|603x603px]]

Un embargo de nómina es una medida legal que permite a un acreedor cobrar una deuda al retener parte del salario del deudor a través de una orden judicial, también se debe tener en cuenta la cantidad que puede ser embargada y garantizan que el deudor tenga suficiente dinero para cubrir sus necesidades básicas.

[[Archivo:EMBARGO 2.jpg|sinmarco|515x515px]]

* '''Certificado Ret'''
proporciona detalles sobre las deducciones y retenciones realizadas en el salario del empleado durante un período específico, generalmente un año fiscal.

[[Archivo:CERTIDICADO DE RET.jpg|sinmarco|445x445px]]

En esta pantalla encontramos el informe de Medios Magnéticos de nómina y también el formato 220 que nos da los ingresos y deducciones del empleados

[[Archivo:CERTIFICADO INGR.jpg|sinmarco|731x731px]]

Aquí encontramos la parametrización del formato 220 en donde se amarran los conceptos de los ingresos

[[Archivo:CERTIFICADO INGR 2.jpg|sinmarco|538x538px]]

En el botón de generar encontramos el formato por empleado, el cual se descarga firma y entrega al empleado solicitante

[[Archivo:GENERAR CERTIFICADO.jpg|sinmarco|541x541px]]

'''''FORMATO 220'''''

[[Archivo:CERTIFICADO INGR 3.jpg|sinmarco|523x523px]]

* '''Formato Carta Laboral'''
[[Archivo:CARTA LABORAL.jpg|sinmarco|450x450px]]

* '''Variables de Nómina Electrónica'''

<div class="content">
Contenido de la pestaña 2
</div>[[Archivo:VARIABLES DE NOMINA.jpg|sinmarco|448x448px]]<ul class="accordion"><li><div class="tab">Planilla Pila</div>
<div class="content">
Contenido de la pestaña 2
</div>
</li>

<li>
<div class="tab">IBC</div>
<div class="content">
Contenido de la pestaña 2
</div>

</ul>

===Organización===
[[File:Serpi Nomina organizacion.jpg|frameless|703x703px]]

*'''Áreas'''
[[File:AREAS.jpg|frameless|453x453px]]

Sirve para clasificar la ubicación del empleado dentro de la empresa.

*'''Tipos de contrato'''
[[File:TIPOS DE CON.jpg|frameless|446x446px]]

Este es un campo en el que se especifica que tipos de contrato se manejarán dentro de la empresa y que se adaptarán al tipo de pago de cada trabajador.

se da crear y se habilita el campo de descripción, si es fijo e indefinido; también se debe tener claro a qué código de la nómina electrónica pertenece ante la DIAN, ya que, es un campo que aparece en la trasmisión de la misma. también se tiene la opción de editar y eliminar.

*'''Entidades'''
[[File:ENTIDADES.jpg|frameless|453x453px]]

'''RUTA: Nómina / Parámetros / Organización / Entidades'''

'''CREAR LA ENTIDAD EN NÓMINA''': estas son las utilizadas para la liquidación de la seguridad social y la provisión de cada empleado dependiendo a que ente este afiliado.

Es uno de los puntos más importantes en la nómina, pues es el encargado de realizar los debidos descuentos y pagos a cada trabajador.

Se puede crear, editar y eliminar cualquier entidad que se necesite

'''Nota:''' las entidades deben de estar creadas en los módulos de <u>'''TERCEROS, GRUPO DE EMPLEADOS, SUBCENTRO DE COSTOS'''</u>

[[Archivo:CREAR ENTIDAD.jpg|sinmarco|611x611px]]

*'''Grupos de empleados'''
[[Archivo:GRUPO DE EMPLEADOS.jpg|sinmarco|444x444px]]

En este módulo se configura el grupo al que va a pertenecer el empleado y cuáles van a ser los tratamientos que se van a llevar a cabo al momento de liquidar la nómina.

En el grupo de empleados debemos tener en cuenta cual es el subcentro de costos que se va a manejar para el proceso contable en el sistema, las entidades que tiene cada empleado y la configuración de Rangos de FSP

[[Archivo:EDICION GEMPLEADOS.jpg|sinmarco|920x920px]]

Se debe configurar el nombre que llevara a cabo el grupo de empleados, la cuenta del salario por pagar y demás configuraciones que se tendrán en cuenta.

[[Archivo:DESCRIPCION GRUPO EMPLEADOS.jpg|sinmarco|609x609px]]

También los porcentajes de descuento de '''ARL, EPS, PENSION''' o si el empleado es aprendiz en etapa lectiva o productiva (se generan descuentos distintos) y siempre garantizar el SMLV a los trabajadores para tener en cuenta en una incapacidad y o en algún descuento

[[Archivo:Porcentajes.jpg|borde|sinmarco|616x616px]]

En vinculaciones, se recomienda tener configuradas las necesarias por cada uno de los grupos. Ejemplo: '''ENTIDAD PRESTADORA DE SALUD''' para los aprendices en etapa lectiva o para los de administración que cuentan con las 4 entidades obligatorias ('''ARL,EPS,PENSION, CAJA DE COMPENSACIÓN''').

[[Archivo:VINCULACIONES.jpg|sinmarco|616x616px]]

En cuanto a la configuración del '''FSP''' se deben de configurar los rangos en cada uno de los grupos creados con las debidas tarifas

[[Archivo:RANGOS FSP.jpg|sinmarco|616x616px]]

*'''Actividades'''
[[Archivo:ACTIVIDADES.jpg|sinmarco|450x450px]]

Esta configuración está basada en las tasas de cotización de la ARL vinculada a la empresa, dependiendo del margen que se maneje por cada grupo de empleado y riesgo que se enfrente segun su area.

[[Archivo:TASAS DE COTIZACIÓN.jpg|sinmarco|609x609px]]
*'''Bancos'''
[[Archivo:BANCOS.jpg|sinmarco|442x442px]]

Cada empresa maneja sus entes financieros, al igual que cada empleado; se debe crear cada uno y configurar los parámetros necesarios para generar el pago y los descuentos manejados en el módulo de la Nómina

[[Archivo:BANCOS 2.jpg|sinmarco|740x740px]]

'''Bancos Empresa''', para crearlos son aquellos que son internos con los que se realizan pagos de nómina y se deben configurar con el código legal del ente, el número de la cuenta y la cuenta contable con la cual se hará el manejo

[[Archivo:BANCOS EMPRESA.jpg|sinmarco|577x577px]]

'''Banco Empleado''' se debe crear ya que es en el cual se va a realizar el pago de la nómina y otros ingresos que este tenga,

Estos son los bancos que se manejan para parametrizar el pago de los empleados, dependiendo cual maneja cada uno de ellos. Esta creación debe tener el campo del código que es legal del banco y el nombre.

[[Archivo:BANCOS EMPLEADOS.jpg|sinmarco|660x660px]]

*'''Codigos Actividad ARL'''

[[Archivo:CODIGOS DE ACTIVIDAD.jpg|sinmarco|444x444px]]

En la configuración de la base de Datos al instalar Serpi, deben ir incluidas las actividades legales, si por algún motivo el campo se encuentra vacío se deberán comunicar con el área de soporte para acomodar el modulo con la información que se necesita

[[Archivo:ARL CODIGOS.jpg|sinmarco|842x842px]]
===Planilla Pila===

===Liquidación===
===IBC===

==Procesos==
*Opcion 1
https://felcowiki.thefactoryhka.com.co/index.php/Primeros_Pasos_-_Portal_HKAN%C3%B3mina#Registro_en_Portal_Factura_Electr.C3.B3nica_.28Ambiente_Demo.29

*Opcion 2

==Integraciones==

==Informes==

Nomina

2023-07-06T21:39:52Z

Gpazos: /* Liquidación */

SERPI ERP, cuenta con una de las nóminas más completas del mercado , con un diseño intuitivo, con la posibilidad de administrar de manera ágil la información

==Parámetros==
En esta opción se lleva cabo la parametrización de la nómina, definiendo cada uno de sus componentes y valores de referencia, los siguientes son sus módulos:

<ul class="accordion">
<li>
<div class="tab">organización</div>
<div class="content">

*'''Cargos'''
[[File:Serpi cargos.jpg|frameless]]'''.'''
'''Ruta:''' Nómina/ Parámetros/ Organizacion/ Cargos/ Crear
Esta opción permite Crear lo diferentes cargos desempeñados en la empresa , el modelo de creación es el estándar de SERPI,
Se puede hacer la creación de nuevos cargos, eliminación o edición de los mismos.

[[File:CARGOS CREAR.jpg|frameless|445x445px]]

En la opción crear aparece el cuadro el cual debe ser llenado con descripción del cargo y los rangos del salario, dar guardar y quedará hecho.

[[File:RANGOS SALARIOS.jpg|frameless|388x388px]]
Contenido de la pestaña 1.
</div>
</li>
<li>
<div class="tab">Liquidación</div>
<div class="content">
Contenido de la pestaña 2
</div>
</li>

<li>
<div class="tab">Planilla Pila</div>
<div class="content">
Contenido de la pestaña 2
</div>
</li>

<li><div class="tab">IBC</div>
<div class="content">
Contenido de la pestaña 2
</div>

</ul>

Parámetros para realizar liquidaciones de diferentes campos en nómina a acomodo de la ley y/o políticas de la empresa[[Archivo:LIQUIDACION.jpg|sinmarco|1028x1028px]]<ul class="accordion">
<li>'''Periodo de Nómina'''
</li></ul>[[Archivo:PERIODOS DE NOMINA.jpg|sinmarco|671x671px]]

Es el campo encargado de identificar los periodos de pago, ya sean mensual, quincenal, semanal o en su defecto diario.

se pueden crear diferentes periodos y/o eliminar

[[Archivo:Periodo crear.jpg|sinmarco|687x687px]]

* '''Formas de Pago'''
Existen diversas formas de pago que pueden utilizarse en transacciones de nomina, por ejemplo:

# Efectivo
# Cheque
# Transferencia Bancaria

[[Archivo:FORMAS DE PAGO.jpg|sinmarco|454x454px]]

En este punto creamos las formas que la empresa va a manejar las formas de pago.

[[Archivo:EFECTIVO.jpg|sinmarco|891x891px]]

Se pueden crear varias formas de pago con su respectiva abreviatura, al igual se pueden eliminar.

[[Archivo:CREACION DE EFECTIVO.jpg|sinmarco|431x431px]]

* '''Días de Corte de Pago'''
Los días de corte de pago de nómina son las fechas establecidas por un empleador para determinar el período de tiempo que se tomará en cuenta al calcular los salarios de los empleados.

El día de corte de pago de nómina puede variar según la política de cada empresa, pero generalmente se establece al final de un período de tiempo regular, como una semana, quincena o mes.

[[Archivo:DIAS CORTE DE PAGO.jpg|sinmarco|452x452px]]

Se crean los dias de pago o cortes que la empresa maneje para liquidar la nómina ya sea por proyectos o grupos.

Por ejemplo, si una empresa tiene un período de pago quincenal, el día de corte podría ser el último día de la quincena, y se tomarían en cuenta los días trabajados desde el último día de corte hasta esa fecha.

[[Archivo:DIAS DE PAGO 1.jpg|sinmarco|461x461px]]

* '''Retención en la Fuente'''

[[Archivo:RETENCION EN LA FUENTE.jpg|sinmarco|453x453px]]

La retención en la fuente a empleados es un mecanismo utilizado por los gobiernos para recaudar impuestos de forma anticipada sobre los ingresos que los empleados reciben a través de sus salarios.

Es fundamental que los empleadores cumplan adecuadamente con las obligaciones de retención en la fuente a empleados para evitar sanciones y problemas legales.

En esta parte del sistema se parametrizan los rangos de porcentaje a realizar al empleado según sus devengos

[[Archivo:RT FUENTE 1.jpg|sinmarco|774x774px]]

[[Archivo:RANGOS RT.jpg|sinmarco|418x418px]]

* '''Parámetros Anuales'''

[[Archivo:PARAMETROS ANUALES.jpg|sinmarco|447x447px]]

En esta parte del sistema se configura la nómina, se refiere a los elementos o factores que se tienen en cuenta al calcular y determinar los valores relacionados con los salarios y las deducciones de los empleados a lo largo de un año fiscal. Estos parámetros son utilizados por los empleadores para realizar cálculos precisos y consistentes en la gestión de la nómina.

Es importante tener en cuenta que los parámetros anuales en nómina pueden variar según las regulaciones laborales y fiscales de cada país. Por lo tanto, los empleadores deben mantenerse actualizados con los cambios legales y ajustar los parámetros de nómina en consecuencia para asegurar el cumplimiento adecuado y justo de las obligaciones salariales y fiscales.

[[Archivo:PARAMETROS ANUALES 1.jpg|sinmarco|529x529px]]

[[Archivo:PARAMETROS ANUALES 3.jpg|sinmarco|543x543px]]

* '''Variables'''
Las variables de nómina son elementos o factores que se consideran al calcular los salarios y deducciones de los empleados. Estas variables pueden afectar directamente el monto que un empleado recibe como salario o la cantidad que se deduce de su salario para fines como impuestos, seguridad social u otros conceptos.

[[Archivo:VARIABLES.jpg|sinmarco|450x450px]]

Encontramos las variables y las abreviaturas que se manejan internamente por empresa

[[Archivo:VARIABLES 1.jpg|sinmarco|560x560px]]

* '''Conceptos'''
se refieren a los elementos específicos que componen el desglose detallado de los ingresos, deducciones y otros aspectos relacionados con el salario de un empleado en un período determinado. Estos conceptos describen y categorizan los diferentes componentes que conforman la nómina de un trabajador.

Es importante destacar que los conceptos de nómina pueden variar según las políticas y regulaciones laborales y fiscales de cada país y empresa. Los empleadores deben asegurarse de seguir las normativas correspondientes y proporcionar una nómina clara y detallada que refleje todos los conceptos relevantes para el cálculo del salario neto de sus empleados.

[[Archivo:CONCEPTOS.jpg|sinmarco|450x450px]]

Algunos de los conceptos comunes que se pueden hallar en las nomina

# Liquidacion de Nomina
# Liquidación de Prima
# Incapacidad
# Vacaciones

[[Archivo:CONCEPTOS 1.jpg|sinmarco|520x520px]]

Cada empresa es libre de crear sus propios conceptos y tratamientos de nómina

* '''Tipo de Terminación de Contrato'''
La terminación de contrato se refiere al cese de la relación laboral entre un empleador y un empleado. Puede ocurrir por diversas razones y existen diferentes tipos de terminación de contrato.

[[Archivo:TERMINACION DE CONTRATO.jpg|sinmarco|447x447px]]

# Terminación por mutuo acuerdo: Ocurre cuando ambas partes, el empleador y el empleado, acuerdan poner fin al contrato laboral de manera consensuada. Puede deberse a razones como reestructuraciones internas, cambios en las circunstancias laborales o acuerdos amistosos.
# Terminación por despido: Sucede cuando el empleador decide poner fin al contrato laboral debido a razones como bajo rendimiento, mala conducta, incumplimiento de políticas o normas de la empresa, reducción de la plantilla, cierre de operaciones o motivos económicos.
# Terminación por renuncia voluntaria: Ocurre cuando el empleado decide poner fin al contrato laboral de manera voluntaria, generalmente para aceptar otra oportunidad laboral, por motivos personales o por insatisfacción con las condiciones de trabajo.
# Terminación por término del contrato a plazo fijo: En algunos casos, los contratos laborales se establecen por un período de tiempo específico. Cuando ese período llega a su fin, el contrato se termina automáticamente sin necesidad de una acción específica.
# Terminación por jubilación: Ocurre cuando el empleado llega a la edad de jubilación establecida por la legislación o los acuerdos laborales y decide dejar de trabajar. En este caso, la terminación del contrato se produce debido a la jubilación del empleado.

[[Archivo:TERMINACION DE CONTRATO 1.jpg|sinmarco|539x539px]]

Es importante tener en cuenta que las razones y los procedimientos de terminación de contrato pueden variar según las leyes laborales y los acuerdos laborales vigentes en cada país. Es fundamental que tanto el empleador como el empleado cumplan con las regulaciones y los procedimientos adecuados para evitar conflictos legales y asegurar una terminación justa y adecuada.

* '''Préstamos y Libranzas'''
[[Archivo:PRESTAMOS.jpg|sinmarco|447x447px]]

'''Préstamos:''' .En el contexto laboral, los empleados pueden acceder a préstamos a través de su empleador o mediante acuerdos con instituciones financieras externas. Estos préstamos pueden utilizarse para diversos fines, como consolidación de deudas, compra de bienes o servicios, gastos médicos o emergencias. (crear las cuentas a las que se debe amarrar el documento)

[[Archivo:PRESTAMOS 1.jpg|sinmarco|458x458px]]

'''Libranzas:''' Una libranza es un mecanismo mediante el cual un empleado autoriza al empleador a deducir de su salario ciertas sumas de dinero para el pago de obligaciones financieras. Generalmente, estas obligaciones son préstamos, créditos o deudas adquiridas por el empleado. (deben ir amarradas a un tercero distinto, entidad financiera, cooperativa etc. también configurar las cuentas las cuales va a afectar el documento como tal)

[[Archivo:LIBRANZA.jpg|sinmarco|427x427px]]

'''Nota:''' El documentos '''PRENO''' debe estar creado en configuracion/configuracion empresa/documentos/préstamo

* '''Embargos'''
Es una orden legal que permite a un acreedor cobrar una deuda directamente del salario de un deudor. En pocas palabras, cuando se produce un embargo de nómina, el empleador retiene una parte del salario del empleado para pagar una deuda pendiente

[[Archivo:EMBARGOS.jpg|sinmarco|450x450px]]

En esta pantalla se genera el tipo de embargo que se va a manejar, ya sea por alimentos, moras, etc.

[[Archivo:EMBARGOS 1.jpg|sinmarco|603x603px]]

Un embargo de nómina es una medida legal que permite a un acreedor cobrar una deuda al retener parte del salario del deudor a través de una orden judicial, también se debe tener en cuenta la cantidad que puede ser embargada y garantizan que el deudor tenga suficiente dinero para cubrir sus necesidades básicas.

[[Archivo:EMBARGO 2.jpg|sinmarco|515x515px]]

* '''Certificado Ret'''
proporciona detalles sobre las deducciones y retenciones realizadas en el salario del empleado durante un período específico, generalmente un año fiscal.

[[Archivo:CERTIDICADO DE RET.jpg|sinmarco|445x445px]]

En esta pantalla encontramos el informe de Medios Magnéticos de nómina y también el formato 220 que nos da los ingresos y deducciones del empleados

[[Archivo:CERTIFICADO INGR.jpg|sinmarco|731x731px]]

Aquí encontramos la parametrización del formato 220 en donde se amarran los conceptos de los ingresos

[[Archivo:CERTIFICADO INGR 2.jpg|sinmarco|538x538px]]

En el botón de generar encontramos el formato por empleado, el cual se descarga firma y entrega al empleado solicitante

[[Archivo:GENERAR CERTIFICADO.jpg|sinmarco|541x541px]]

'''''FORMATO 220'''''

[[Archivo:CERTIFICADO INGR 3.jpg|sinmarco|523x523px]]

* '''Formato Carta Laboral'''
[[Archivo:CARTA LABORAL.jpg|sinmarco|450x450px]]

* '''Variables de Nómina Electrónica'''

<div class="content">
Contenido de la pestaña 2
</div>[[Archivo:VARIABLES DE NOMINA.jpg|sinmarco|448x448px]]<ul class="accordion"><li><div class="tab">Planilla Pila</div>
<div class="content">
Contenido de la pestaña 2
</div>
</li>

<li>
<div class="tab">IBC</div>
<div class="content">
Contenido de la pestaña 2
</div>

</ul>

===Organización===
[[File:Serpi Nomina organizacion.jpg|frameless|703x703px]]

*'''Áreas'''
[[File:AREAS.jpg|frameless|453x453px]]

Sirve para clasificar la ubicación del empleado dentro de la empresa.

*'''Tipos de contrato'''
[[File:TIPOS DE CON.jpg|frameless|446x446px]]

Este es un campo en el que se especifica que tipos de contrato se manejarán dentro de la empresa y que se adaptarán al tipo de pago de cada trabajador.

se da crear y se habilita el campo de descripción, si es fijo e indefinido; también se debe tener claro a qué código de la nómina electrónica pertenece ante la DIAN, ya que, es un campo que aparece en la trasmisión de la misma. también se tiene la opción de editar y eliminar.

*'''Entidades'''
[[File:ENTIDADES.jpg|frameless|453x453px]]

'''RUTA: Nómina / Parámetros / Organización / Entidades'''

'''CREAR LA ENTIDAD EN NÓMINA''': estas son las utilizadas para la liquidación de la seguridad social y la provisión de cada empleado dependiendo a que ente este afiliado.

Es uno de los puntos más importantes en la nómina, pues es el encargado de realizar los debidos descuentos y pagos a cada trabajador.

Se puede crear, editar y eliminar cualquier entidad que se necesite

'''Nota:''' las entidades deben de estar creadas en los módulos de <u>'''TERCEROS, GRUPO DE EMPLEADOS, SUBCENTRO DE COSTOS'''</u>

[[Archivo:CREAR ENTIDAD.jpg|sinmarco|611x611px]]

*'''Grupos de empleados'''
[[Archivo:GRUPO DE EMPLEADOS.jpg|sinmarco|444x444px]]

En este módulo se configura el grupo al que va a pertenecer el empleado y cuáles van a ser los tratamientos que se van a llevar a cabo al momento de liquidar la nómina.

En el grupo de empleados debemos tener en cuenta cual es el subcentro de costos que se va a manejar para el proceso contable en el sistema, las entidades que tiene cada empleado y la configuración de Rangos de FSP

[[Archivo:EDICION GEMPLEADOS.jpg|sinmarco|920x920px]]

Se debe configurar el nombre que llevara a cabo el grupo de empleados, la cuenta del salario por pagar y demás configuraciones que se tendrán en cuenta.

[[Archivo:DESCRIPCION GRUPO EMPLEADOS.jpg|sinmarco|609x609px]]

También los porcentajes de descuento de '''ARL, EPS, PENSION''' o si el empleado es aprendiz en etapa lectiva o productiva (se generan descuentos distintos) y siempre garantizar el SMLV a los trabajadores para tener en cuenta en una incapacidad y o en algún descuento

[[Archivo:Porcentajes.jpg|borde|sinmarco|616x616px]]

En vinculaciones, se recomienda tener configuradas las necesarias por cada uno de los grupos. Ejemplo: '''ENTIDAD PRESTADORA DE SALUD''' para los aprendices en etapa lectiva o para los de administración que cuentan con las 4 entidades obligatorias ('''ARL,EPS,PENSION, CAJA DE COMPENSACIÓN''').

[[Archivo:VINCULACIONES.jpg|sinmarco|616x616px]]

En cuanto a la configuración del '''FSP''' se deben de configurar los rangos en cada uno de los grupos creados con las debidas tarifas

[[Archivo:RANGOS FSP.jpg|sinmarco|616x616px]]

*'''Actividades'''
[[Archivo:ACTIVIDADES.jpg|sinmarco|450x450px]]

Esta configuración está basada en las tasas de cotización de la ARL vinculada a la empresa, dependiendo del margen que se maneje por cada grupo de empleado y riesgo que se enfrente segun su area.

[[Archivo:TASAS DE COTIZACIÓN.jpg|sinmarco|609x609px]]
*'''Bancos'''
[[Archivo:BANCOS.jpg|sinmarco|442x442px]]

Cada empresa maneja sus entes financieros, al igual que cada empleado; se debe crear cada uno y configurar los parámetros necesarios para generar el pago y los descuentos manejados en el módulo de la Nómina

[[Archivo:BANCOS 2.jpg|sinmarco|740x740px]]

'''Bancos Empresa''', para crearlos son aquellos que son internos con los que se realizan pagos de nómina y se deben configurar con el código legal del ente, el número de la cuenta y la cuenta contable con la cual se hará el manejo

[[Archivo:BANCOS EMPRESA.jpg|sinmarco|577x577px]]

'''Banco Empleado''' se debe crear ya que es en el cual se va a realizar el pago de la nómina y otros ingresos que este tenga,

Estos son los bancos que se manejan para parametrizar el pago de los empleados, dependiendo cual maneja cada uno de ellos. Esta creación debe tener el campo del código que es legal del banco y el nombre.

[[Archivo:BANCOS EMPLEADOS.jpg|sinmarco|660x660px]]

*'''Codigos Actividad ARL'''

[[Archivo:CODIGOS DE ACTIVIDAD.jpg|sinmarco|444x444px]]

En la configuración de la base de Datos al instalar Serpi, deben ir incluidas las actividades legales, si por algún motivo el campo se encuentra vacío se deberán comunicar con el área de soporte para acomodar el modulo con la información que se necesita

[[Archivo:ARL CODIGOS.jpg|sinmarco|842x842px]]
===Planilla Pila===
===IBC===

==Procesos==
*Opcion 1
https://felcowiki.thefactoryhka.com.co/index.php/Primeros_Pasos_-_Portal_HKAN%C3%B3mina#Registro_en_Portal_Factura_Electr.C3.B3nica_.28Ambiente_Demo.29

*Opcion 2

==Integraciones==

==Informes==

MediaWiki:Sidebar

2023-06-06T19:07:39Z

Gpazos:

MediaWiki:Sidebar

2023-06-06T19:07:14Z

Gpazos:

MediaWiki:Sidebar

2023-06-06T19:06:24Z

Gpazos:

API Documentos Contables/Actividades

2023-06-05T17:32:34Z

Gpazos:

'''Descripción:'''
Esta API permite la sincronización de las '''actividades de proyectos''' vinculadas a proyectos entre SERPI y la plataforma que lo requiera, este mismo conjunto de datos en el proceso de facturación es referenciado como '''Categorias de ´proyectos.'''

'''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, 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/Actividades

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Actividades?limite=50&pagina=1

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

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

'''Parámetros'''
{| class="wikitable"
! 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" line="1">
{
"success": true
"code": 200,
"message": "x registro(s) encontrados",
"result": [
{
"id": 6,
"codigo": "GP",
"actividad": "GASTO PORTUARIO",
"codigoProyecto": 1
}
]
}

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

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador de la Actividad
|-
| codigo || string || Codigo de Actividad
|-
| Actividad || string || Descripcion Actividad
|-
| codigoProyecto || int || identificador del proyecto correspondiente
|}
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"codigo": "PRE",
"actividad": "PRUEBA",
"codigoProyecto": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo || string || 50 || SI || codigo de Actividad
|-
| actividad || string || 50 || SI || Descripcion Actividad
|-
| codigoProyecto|| int || 50 || SI || identificador del proyecto correspondiente
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": null,
"message": "registro creado exitosamente"
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 314,
"codigo": "PRI",
"actividad": "PRUEBA",
"codigoProyecto": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || identificador de Actividad
|-
| codigo || string || 50 || SI || codigo de Actividad
|-
| actividad || string || 50 || SI || Descripcion de Actividad
|-
| codigoProyecto || int || 50 || SI || identificador del Proyecto
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"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"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https:///www.apis.serpi.com.co/api/v1/Actividades")
.method("GET", body)
.addHeader("secretkey", "{Secret Key}")
.addHeader("Authorization", "{Bearer Token}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Python">
'''Request'''
<syntaxhighlight lang="java" line="1">
import requests

url = "https://www.apis.serpi.com.co/api/v1/Actividades"

payload = {}
headers = {
'secretkey': '{Secret Key}',
'Authorization': '{Bearer Token}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Php">
'''Request'''
<syntaxhighlight lang="java" line="1">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://www.apis.serpi.com.co/api/v1/Actividades');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{Secret Key}',
'Authorization' => '{Bearer Token}'
));
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>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

</Tabs>

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]

API Documentos Contables/Actividades

2023-06-05T17:31:25Z

Gpazos:

'''Descripción:'''
Esta API permite la sincronización de las '''actividades''' vinculadas a proyectos entre SERPI y la plataforma que lo requiera, este mismo conjunto de datos en el proceso de facturación es referenciado como '''Categorias de ´proyectos.'''

'''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, 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/Actividades

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Actividades?limite=50&pagina=1

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

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

'''Parámetros'''
{| class="wikitable"
! 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" line="1">
{
"success": true
"code": 200,
"message": "x registro(s) encontrados",
"result": [
{
"id": 6,
"codigo": "GP",
"actividad": "GASTO PORTUARIO",
"codigoProyecto": 1
}
]
}

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

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador de la Actividad
|-
| codigo || string || Codigo de Actividad
|-
| Actividad || string || Descripcion Actividad
|-
| codigoProyecto || int || identificador del proyecto correspondiente
|}
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"codigo": "PRE",
"actividad": "PRUEBA",
"codigoProyecto": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo || string || 50 || SI || codigo de Actividad
|-
| actividad || string || 50 || SI || Descripcion Actividad
|-
| codigoProyecto|| int || 50 || SI || identificador del proyecto correspondiente
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": null,
"message": "registro creado exitosamente"
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 314,
"codigo": "PRI",
"actividad": "PRUEBA",
"codigoProyecto": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || identificador de Actividad
|-
| codigo || string || 50 || SI || codigo de Actividad
|-
| actividad || string || 50 || SI || Descripcion de Actividad
|-
| codigoProyecto || int || 50 || SI || identificador del Proyecto
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"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"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https:///www.apis.serpi.com.co/api/v1/Actividades")
.method("GET", body)
.addHeader("secretkey", "{Secret Key}")
.addHeader("Authorization", "{Bearer Token}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Python">
'''Request'''
<syntaxhighlight lang="java" line="1">
import requests

url = "https://www.apis.serpi.com.co/api/v1/Actividades"

payload = {}
headers = {
'secretkey': '{Secret Key}',
'Authorization': '{Bearer Token}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Php">
'''Request'''
<syntaxhighlight lang="java" line="1">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://www.apis.serpi.com.co/api/v1/Actividades');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{Secret Key}',
'Authorization' => '{Bearer Token}'
));
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>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

</Tabs>

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]

MediaWiki:Sidebar

2023-06-05T14:38:29Z

Gpazos:

API Documentos Contables/Actividades

2023-06-05T13:59:32Z

Gpazos:

'''Descripción:'''
Esta API permite la sincronización de las '''actividades''' vinculadas a proyectos entre SERPI y la plataforma que lo requiera, este mismo conjunto de datos en el proceso de facturacion es referenciado como '''Categorias de facturas'''

'''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, 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/Actividades

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Actividades?limite=50&pagina=1

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

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

'''Parámetros'''
{| class="wikitable"
! 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" line="1">
{
"success": true
"code": 200,
"message": "x registro(s) encontrados",
"result": [
{
"id": 6,
"codigo": "GP",
"actividad": "GASTO PORTUARIO",
"codigoProyecto": 1
}
]
}

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

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador de la Actividad
|-
| codigo || string || Codigo de Actividad
|-
| Actividad || string || Descripcion Actividad
|-
| codigoProyecto || int || identificador del proyecto correspondiente
|}
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"codigo": "PRE",
"actividad": "PRUEBA",
"codigoProyecto": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo || string || 50 || SI || codigo de Actividad
|-
| actividad || string || 50 || SI || Descripcion Actividad
|-
| codigoProyecto|| int || 50 || SI || identificador del proyecto correspondiente
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": null,
"message": "registro creado exitosamente"
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 314,
"codigo": "PRI",
"actividad": "PRUEBA",
"codigoProyecto": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || identificador de Actividad
|-
| codigo || string || 50 || SI || codigo de Actividad
|-
| actividad || string || 50 || SI || Descripcion de Actividad
|-
| codigoProyecto || int || 50 || SI || identificador del Proyecto
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"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"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https:///www.apis.serpi.com.co/api/v1/Actividades")
.method("GET", body)
.addHeader("secretkey", "{Secret Key}")
.addHeader("Authorization", "{Bearer Token}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Python">
'''Request'''
<syntaxhighlight lang="java" line="1">
import requests

url = "https://www.apis.serpi.com.co/api/v1/Actividades"

payload = {}
headers = {
'secretkey': '{Secret Key}',
'Authorization': '{Bearer Token}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Php">
'''Request'''
<syntaxhighlight lang="java" line="1">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://www.apis.serpi.com.co/api/v1/Actividades');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{Secret Key}',
'Authorization' => '{Bearer Token}'
));
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>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

</Tabs>

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]

API Modulo Ventas

2023-06-05T13:56:38Z

Gpazos:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Facturas'''

* [[API Facturas]]
* [[API Facturas/Documentos|API Documentos]]
* [[API Facturas/Sucursales|API Sucursales]]
* [[API Facturas/Centro_Operaciones|API Centro Operaciones]]
* [[API Facturas/Proyectos|API Proyectos]]
* [[API_Documentos-Contables/Actividades|API Categoria]]
* [[API Facturas/Bodegas|API Bodegas]]
* [[API Facturas/Lista_Precios|API Lista Precios]]
* [[API Facturas/Articulos|API Articulos]]

API Documentos Contables/Actividades

2023-06-05T02:12:26Z

Gpazos:

'''Descripción:'''
Esta API permite la sincronizacion de las '''actividades''' vinculadas a proyectos entre SERPI y la plataforma que lo requiera.

'''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, 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/Actividades

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Actividades?limite=50&pagina=1

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

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

'''Parámetros'''
{| class="wikitable"
! 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" line="1">
{
"success": true
"code": 200,
"message": "x registro(s) encontrados",
"result": [
{
"id": 6,
"codigo": "GP",
"actividad": "GASTO PORTUARIO",
"codigoProyecto": 1
}
]
}

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

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador de la Actividad
|-
| codigo || string || Codigo de Actividad
|-
| Actividad || string || Descripcion Actividad
|-
| codigoProyecto || int || identificador del proyecto correspondiente
|}
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"codigo": "PRE",
"actividad": "PRUEBA",
"codigoProyecto": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo || string || 50 || SI || codigo de Actividad
|-
| actividad || string || 50 || SI || Descripcion Actividad
|-
| codigoProyecto|| int || 50 || SI || identificador del proyecto correspondiente
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": null,
"message": "registro creado exitosamente"
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 314,
"codigo": "PRI",
"actividad": "PRUEBA",
"codigoProyecto": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || identificador de Actividad
|-
| codigo || string || 50 || SI || codigo de Actividad
|-
| actividad || string || 50 || SI || Descripcion de Actividad
|-
| codigoProyecto || int || 50 || SI || identificador del Proyecto
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"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"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https:///www.apis.serpi.com.co/api/v1/Actividades")
.method("GET", body)
.addHeader("secretkey", "{Secret Key}")
.addHeader("Authorization", "{Bearer Token}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Python">
'''Request'''
<syntaxhighlight lang="java" line="1">
import requests

url = "https://www.apis.serpi.com.co/api/v1/Actividades"

payload = {}
headers = {
'secretkey': '{Secret Key}',
'Authorization': '{Bearer Token}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Php">
'''Request'''
<syntaxhighlight lang="java" line="1">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://www.apis.serpi.com.co/api/v1/Actividades');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{Secret Key}',
'Authorization' => '{Bearer Token}'
));
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>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

</Tabs>

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]

API Documentos Contables/Subcentro Costos

2023-06-05T02:10:53Z

Gpazos: Página creada con «'''Descripción:''' Esta API permite la sincronización de los '''Subcentros de costos''' entre SERPI y la plataforma que lo requiera. '''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, POST, PUT '''¿Cómo funcio…»

'''Descripción:'''
Esta API permite la sincronización de los '''Subcentros de costos''' entre SERPI y la plataforma que lo requiera.

'''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, 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) ">

'''EndPoint:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/SubCentroCosto</nowiki>

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/SubCentroCosto?limite=50&pagina=1</nowiki>

{| 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": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"codigo": "01",
"abreviatura": "ADS",
"descripcion": "ADMINISTRACION"
}
]
}

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

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Identificador del centro de costo
|-
| codigo|| string || Abreviatura del centro de costo
|-
| abreviatura || string || Abreviatura del centro de costo
|-
| descripcion || string || Descripción del centro de costo
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/CentroCosto

{| 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">
{
"codigo": "02",
"abreviatura": "VE",
"descripcion": "VENTAS"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo|| string || 5 || Si || Codigo unico de centro de costo
|-
| abreviatura || string || 5 || Si || Abreviatura unica del centro de costo
|-
| descripcion || string || 200 || Si || Descripción del centro de costo
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [],
"message": "Validaciones exitosas. Registro creado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"La abreviatura CO1 ya existe",
"El campo descripcion es obligatorio",
"El codigo 957 ya existe",
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/CentroCosto

{| 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">
{
"id": 1,
"codigo": "01",
"abreviatura": "ADS",
"descripcion": "ADMINISTRACION"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || Si || Identificador del centro de costo
|-
| codigo|| string || 5 || Si || Codigo unico de centro de costo
|-
| abreviatura || string || 5 || Si || Abreviatura unica del centro de costo
|-
| descripcion || string || 200 || Si || Descripción del centro de costo
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Validaciones exitosas. Registro modificado exitosamente"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id 1"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"La abreviatura CO1 ya esta asociado al id x",
"El campo descripcion es obligatorio",
],
"message": "Problemas de validaciones. Se presentaron errores al modificar el registro"
}
</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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'''
<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/CentroCosto")
.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/CentroCosto");
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/CentroCosto');
$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 Documentos Contables

2023-06-05T02:09:14Z

Gpazos:

'''Descripción:'''
Esta API permite la sincronización de los '''documentos contables''' requeridos entre SERPI y la plataforma que lo requiera.

'''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, 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/Actividades

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Actividades?limite=50&pagina=1

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

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

'''Parámetros'''
{| class="wikitable"
! 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" line="1">
{
"success": true
"code": 200,
"message": "x registro(s) encontrados",
"result": [
{
"id": 6,
"codigo": "GP",
"actividad": "GASTO PORTUARIO",
"codigoProyecto": 1
}
]
}

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

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador de la Actividad
|-
| codigo || string || Codigo de Actividad
|-
| Actividad || string || Descripcion Actividad
|-
| codigoProyecto || int || identificador del proyecto correspondiente
|}
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"codigo": "PRE",
"actividad": "PRUEBA",
"codigoProyecto": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo || string || 50 || SI || codigo de Actividad
|-
| actividad || string || 50 || SI || Descripcion Actividad
|-
| codigoProyecto|| int || 50 || SI || identificador del proyecto correspondiente
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": null,
"message": "registro creado exitosamente"
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 314,
"codigo": "PRI",
"actividad": "PRUEBA",
"codigoProyecto": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || identificador de Actividad
|-
| codigo || string || 50 || SI || codigo de Actividad
|-
| actividad || string || 50 || SI || Descripcion de Actividad
|-
| codigoProyecto || int || 50 || SI || identificador del Proyecto
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"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"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https:///www.apis.serpi.com.co/api/v1/Actividades")
.method("GET", body)
.addHeader("secretkey", "{Secret Key}")
.addHeader("Authorization", "{Bearer Token}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Python">
'''Request'''
<syntaxhighlight lang="java" line="1">
import requests

url = "https://www.apis.serpi.com.co/api/v1/Actividades"

payload = {}
headers = {
'secretkey': '{Secret Key}',
'Authorization': '{Bearer Token}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Php">
'''Request'''
<syntaxhighlight lang="java" line="1">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://www.apis.serpi.com.co/api/v1/Actividades');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{Secret Key}',
'Authorization' => '{Bearer Token}'
));
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>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

</Tabs>

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]

API Documentos Contables

2023-06-05T02:07:58Z

Gpazos: Página creada con «'''Descripción:''' Esta API pemrite la sincronizacion de las actividades vinculadas a proyectos entre SERPI y la plataforma que lo requiera. '''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, POST, PUT '''¿Cómo…»

'''Descripción:'''
Esta API pemrite la sincronizacion de las actividades vinculadas a proyectos entre SERPI y la plataforma que lo requiera.

'''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, 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/Actividades

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Actividades?limite=50&pagina=1

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

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

'''Parámetros'''
{| class="wikitable"
! 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" line="1">
{
"success": true
"code": 200,
"message": "x registro(s) encontrados",
"result": [
{
"id": 6,
"codigo": "GP",
"actividad": "GASTO PORTUARIO",
"codigoProyecto": 1
}
]
}

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

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador de la Actividad
|-
| codigo || string || Codigo de Actividad
|-
| Actividad || string || Descripcion Actividad
|-
| codigoProyecto || int || identificador del proyecto correspondiente
|}
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"codigo": "PRE",
"actividad": "PRUEBA",
"codigoProyecto": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo || string || 50 || SI || codigo de Actividad
|-
| actividad || string || 50 || SI || Descripcion Actividad
|-
| codigoProyecto|| int || 50 || SI || identificador del proyecto correspondiente
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": null,
"message": "registro creado exitosamente"
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 314,
"codigo": "PRI",
"actividad": "PRUEBA",
"codigoProyecto": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || identificador de Actividad
|-
| codigo || string || 50 || SI || codigo de Actividad
|-
| actividad || string || 50 || SI || Descripcion de Actividad
|-
| codigoProyecto || int || 50 || SI || identificador del Proyecto
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"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"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https:///www.apis.serpi.com.co/api/v1/Actividades")
.method("GET", body)
.addHeader("secretkey", "{Secret Key}")
.addHeader("Authorization", "{Bearer Token}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Python">
'''Request'''
<syntaxhighlight lang="java" line="1">
import requests

url = "https://www.apis.serpi.com.co/api/v1/Actividades"

payload = {}
headers = {
'secretkey': '{Secret Key}',
'Authorization': '{Bearer Token}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Php">
'''Request'''
<syntaxhighlight lang="java" line="1">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://www.apis.serpi.com.co/api/v1/Actividades');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{Secret Key}',
'Authorization' => '{Bearer Token}'
));
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>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

</Tabs>

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]

API Documentos Contables/Centro Operaciones

2023-06-05T02:06:17Z

Gpazos:

'''Descripción:'''
Esta API permite la sincronización de los '''Centros de Operaciones''' entre SERPI y la plataforma que lo requiera.

'''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, 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) ">

'''EndPoint:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/CentroOperacion</nowiki>

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/CentroOperacion?limite=50&pagina=1</nowiki>

{| 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": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"abreviatura": "1",
"descripcion": "CENTRO DE OPERACIONES DEMO",
"direccion": "CALLE 1 # 2-3",
"codigo_pais": 1,
"pais": "COLOMBIA",
"codigo_departamento": 76,
"departamento": "VALLE DEL CAUCA",
"codigo_ciudad": 76001,
"ciudad": "SANTIAGO DE CALI",
"telefono": 1234567,
"movil": "1234567890"
}
]
}

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

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Identificador del centro de operación
|-
| abreviatura || string || Abreviatura del centro de operación
|-
| descripcion || string || Descripción del centro de operación
|-
| direccion || string || Dirección del centro de operación
|-
| codigo_pais|| int || Código del país
|-
| pais || string || Nombre del país
|-
| codigo_departamento || int || Código del departamento
|-
| departamento || string || Nombre del departamento
|-
| codigo_ciudad || int || Código de ciudad
|-
| ciudad || string || Nombre de la ciudad
|-
| telefono || int || Teléfono del centro de operación
|-
| movil || string || Número de celular del centro de operación
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/CentroOperacion

{| 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">
{
"abreviatura": "CO1",
"descripcion": "CENTRO DE OPERACION DEMO",
"direccion": "CALLE 1 # 2-3",
"codigo_pais": 1,
"codigo_departamento": 76,
"codigo_ciudad": 76001,
"telefono": 1234567,
"movil": "1234567890"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| abreviatura || string || 11 || Si || Abreviatura del centro de operación
|-
| descripcion || string || 11 || Si || Descripción del centro de operación
|-
| direccion || string || 11 || Si || Dirección del centro de operación
|-
| codigo_pais|| int || 11 || Si || Código del país
|-
| codigo_departamento || int || 11 || Si || Código del departamento
|-
| codigo_ciudad || int || 11 || Si || Código de ciudad
|-
| telefono || int || 11 || No || Teléfono del centro de operación
|-
| movil || string || 11 || Si || Número de celular del centro de operación
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [],
"message": "Validaciones exitosas. Registro creado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"La abreviatura CO1 ya existe",
"El campo descripcion es obligatorio",
"El campo direccion es obligatorio",
"El campo movil es obligatorio",
"El codigo 1 del campo codigo_pais no existe",
"El codigo 76 del campo codigo_departamento no existe",
"El codigo 76001 del campo codigo_ciudad no existe"
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/CentroOperacion

{| 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">
{
"id": 1,
"abreviatura": "CO1",
"descripcion": "CENTRO DE OPERACION DEMO",
"direccion": "CALLE 1 # 2-3",
"codigo_pais": 1,
"codigo_departamento": 76,
"codigo_ciudad": 76001,
"telefono": 1234567,
"movil": "1234567890"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || Si || Identificador del centro de operación
|-
| abreviatura || string || 11 || Si || Abreviatura del centro de operación
|-
| descripcion || string || 11 || Si || Descripción del centro de operación
|-
| direccion || string || 11 || Si || Dirección del centro de operación
|-
| codigo_pais|| int || 11 || Si || Código del país
|-
| codigo_departamento || int || 11 || Si || Código del departamento
|-
| codigo_ciudad || int || 11 || Si || Código de ciudad
|-
| telefono || int || 11 || No || Teléfono del centro de operación
|-
| movil || string || 11 || Si || Número de celular del centro de operación
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Validaciones exitosas. Registro modificado exitosamente"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id 1"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"La abreviatura CO1 ya esta asociado al id x",
"El campo descripcion es obligatorio",
"El campo direccion es obligatorio",
"El campo movil es obligatorio",
"El codigo 1 del campo codigo_pais no existe",
"El codigo 76 del campo codigo_departamento no existe",
"El codigo 76001 del campo codigo_ciudad no existe"
],
"message": "Problemas de validaciones. Se presentaron errores al modificar el registro"
}
</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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'''
<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/CentroOperacion")
.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/CentroOperacion");
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/CentroOperacion');
$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 Documentos Contables/Actividades

2023-06-05T02:04:20Z

Gpazos:

API Documentos Contables/Centro Costos

2023-06-05T01:53:43Z

Gpazos:

'''Descripción:'''
Esta API permite la sincronización de los '''centros de costos''' entre SERPI y la plataforma que lo requiera.

'''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, 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) ">

'''EndPoint:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/CentroCosto</nowiki>

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/CentroCosto?limite=50&pagina=1</nowiki>

{| 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": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"codigo": "01",
"abreviatura": "ADS",
"descripcion": "ADMINISTRACION"
}
]
}

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

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Identificador del centro de costo
|-
| codigo|| string || Abreviatura del centro de costo
|-
| abreviatura || string || Abreviatura del centro de costo
|-
| descripcion || string || Descripción del centro de costo
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/CentroCosto

{| 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">
{
"codigo": "02",
"abreviatura": "VE",
"descripcion": "VENTAS"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo|| string || 5 || Si || Codigo unico de centro de costo
|-
| abreviatura || string || 5 || Si || Abreviatura unica del centro de costo
|-
| descripcion || string || 200 || Si || Descripción del centro de costo
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [],
"message": "Validaciones exitosas. Registro creado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"La abreviatura CO1 ya existe",
"El campo descripcion es obligatorio",
"El codigo 957 ya existe",
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/CentroCosto

{| 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">
{
"id": 1,
"codigo": "01",
"abreviatura": "ADS",
"descripcion": "ADMINISTRACION"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || Si || Identificador del centro de costo
|-
| codigo|| string || 5 || Si || Codigo unico de centro de costo
|-
| abreviatura || string || 5 || Si || Abreviatura unica del centro de costo
|-
| descripcion || string || 200 || Si || Descripción del centro de costo
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Validaciones exitosas. Registro modificado exitosamente"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id 1"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"La abreviatura CO1 ya esta asociado al id x",
"El campo descripcion es obligatorio",
],
"message": "Problemas de validaciones. Se presentaron errores al modificar el registro"
}
</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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'''
<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/CentroCosto")
.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/CentroCosto");
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/CentroCosto');
$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 Articulos/Grupos

2023-06-05T01:52:02Z

Gpazos:

'''Descripción:'''
Esta API permite la sincronización del agrupador de items definido como '''grupo''' entre SERPI y la plataforma que lo requiera.

'''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, 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) ">

'''EndPoint:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/CategoriaArticulo</nowiki>

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/CategoriaArticulo?limite=50&pagina=1</nowiki>

{| 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": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"codigo": "1",
"descripcion": "CATEGORIA DEMO",
"id_categoria_articulo": 0
}
]
}

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

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Identificador de la categoría
|-
| codigo || string || Código de la categoría
|-
| descripcion || string || Descripción de la categoría
|-
| id_categoria_articulo || int || Identificador de la categoría artículo
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/CategoriaArticulo

{| 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">
{
"codigo": "1",
"descripcion": "CATEGORIA DEMO",
"id_categoria_articulo": 0
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo || string || 20 || Si || Código único de la categoría
|-
| descripcion || string || 150 || Si || Descripción de la categoría
|-
| id_categoria_articulo || int || 11 || No || Identificador de la categoría artículo
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [],
"message": "Validaciones exitosas. Registro creado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El codigo 1 ya existe",
"El campo descripcion es obligatorio"
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/CategoriaArticulo

{| 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">
{
"id": 1,
"codigo": "10",
"descripcion": "CATEGORIA DEMO MODIFICADA",
"id_categoria_articulo": 0
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || Si || Identificador de la categoría
|-
| codigo || string || 20 || Si || Código único de la categoría
|-
| descripcion || string || 150 || Si || Descripción de la categoría
|-
| id_categoria_articulo || int || 11 || No || Identificador de la categoría artículo
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Validaciones exitosas. Registro modificado exitosamente"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id 1"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"El codigo 1 ya esta asociado a otro id",
"El campo descripcion es obligatorio"
],
"message": "Problemas de validaciones. Se presentaron errores al modificar el registro"
}
</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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'''
<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/CategoriaArticulo")
.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/CategoriaArticulo");
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/CategoriaArticulo');
$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 Articulos/Unidades de Medida

2023-06-05T01:50:31Z

Gpazos:

'''Descripción:'''
Esta API pemite sincronizar las Unidades de medida de items entre SERPI y la plataforma que lo requiera.

'''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, 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) ">

'''EndPoint:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/UnidadMedida</nowiki>

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/UnidadMedida?limite=50&pagina=1</nowiki>

{| 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": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"codigo": "1",
"descripcion": "UNIDAD DEMO",
"abreviatura": "Und"
}
]
}

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

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Identificador de la unidad de medida
|-
| codigo || string || Código único de la unidad de medida
|-
| descripcion || string || Descripción de la unidad de medida
|-
| abreviatura || string || Abreviatura única de la unidad de medida
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/UnidadMedida

{| 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">
{
"codigo": "1",
"descripcion": "UNIDAD DEMO",
"abreviatura": "Und"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo || string || 5 || Si || Código único de la unidad de medida. No puede repetirse
|-
| descripcion || string || 50 || Si || Descripción de la unidad de medida
|-
| abreviatura || string || 10 || Si || Abreviatura única de la unidad de medida
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [],
"message": "Validaciones exitosas. Registro creado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El codigo 1 ya existe",
"El campo descripcion es obligatorio",
"El campo abreviatura es obligatorio",
"La abreviatura Und ya esta asociado a otro id"
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/UnidadMedida

{| 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">
{
"id": 1,
"codigo": "1",
"descripcion": "UNIDAD DEMO",
"abreviatura": "Und"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || Si || Identificador de la unidad de medida
|-
| codigo || string || 5 || Si || Código único de la unidad de medida. No puede repetirse
|-
| descripcion || string || 50 || Si || Descripción de la unidad de medida
|-
| abreviatura || string || 10 || Si || Abreviatura única de la unidad de medida
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Validaciones exitosas. Registro modificado exitosamente"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id 1"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"El codigo 4 ya esta asociado a otro id",
"El campo descripcion es obligatorio",
"La abreviatura Und ya esta asociado a otro id"
],
"message": "Problemas de validaciones. Se presentaron errores al modificar el registro"
}
</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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'''
<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/UnidadMedida")
.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/UnidadMedida");
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/UnidadMedida');
$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 Articulos/Marcas

2023-06-05T01:49:29Z

Gpazos:

'''Descripción:'''
Esta API permite la sincronizacion de Marcas ligadas a los items entre SERPI y la plataforma que lo requiera.

'''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, POST, PUT

'''¿Cómo funciona?'''
*El consumo de esta API se realiza por método GET.
*Para consumir esta API debe reemplazar en la url {ip_ipdialbox} por la nomenclatura del servidor de la operación y el {token} generado desde wolkvox Manager para obtener la información de manera segura.
*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'''

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

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Marca?limite=50&pagina=1

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

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

'''Parámetros'''
{| class="wikitable"
! 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
|}

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": null,
"message": "x registro(s) encontrados",
"result": [
{
"id": 1,
"codigo": "2",
"descripcion": "GASTOS ENVIO 2"
},
]

}

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

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| Id || int || Corresponde al identificador de la marca
|-
| Código|| string || Corresponde al código de la marca
|-
| description|| string || Descripción de la marca
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"codigo" : "A08",
"descripcion": "PRUEBAS"

}

</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| código|| String || SI || Describe el código de la categoría
|-
| descripción|| String || SI || Descripción de la marca
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{{
"success": true,
"code": 201,
"errors": null,
"message": "registro creado exitosamente"

}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''PUT'''

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 1,
"codigo": "2",
"descripcion": "GASTOS ENVIO "

}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || Corresponde al identificador de la marca
|-
| codigo|| string || 50 || SI || Describe el código de la marca
|-
| descripcion|| string || 50 || SI || Descripción de la marca
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true
"code": 200,
"message": "registro modificado exitosamente"
}

{
"success": false,
"code": 400,
"errors": [
"El campo codigo 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"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>
<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
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/marca")
.method("GET", body)
.addHeader("secretkey", "ABc-zaw3+7uio-*")
.addHeader("Authorization", "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4MDUwMjYzODYiLrl5NCdQfosUBqVeGfWGCXrVcsov2VFBNBiayWxK9Hq0Ws9gqz7egNQ")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="java" line="1">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/marca");
request.Headers.Add("secretkey", "ABc-xxsse3444.123");
request.Headers.Add("Authorization", "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4MDUwMjYzODYiLCJ1bmlxdWVfeGfWGCXrVcsov2VFBNBiayWxK9Hq0Ws9gqz7egNQ");
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>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="java" line="1">

<?php
$client = new http\Client;
$request = new http\Client\Request;
$request->setRequestUrl('https://localhost:44305/api/v1/marca');
$request->setRequestMethod('GET');
$body = new http\Message\Body;
$request->setBody($body);
$request->setOptions(array());
$request->setHeaders(array(
'secretkey' => 'ABc-xyzas234*-.123',
'Authorization' => 'Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4MDUwMjYzODYiLHq0Ws9gqz7egNQ'
));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();

</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

</Tabs>

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]

API Articulos/Presentacion-Tipo

2023-06-05T01:48:13Z

Gpazos:

'''Descripción:'''
Esta API permite la sincronización de los tipos de presentación de productos entre SERPI y la plataforma que lo requiera.

'''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, POST, PUT

'''¿Cómo funciona?'''
*El consumo de esta API se realiza por método GET.
*Para consumir esta API debe reemplazar en la url {ip_ipdialbox} por la nomenclatura del servidor de la operación y el {token} generado desde wolkvox Manager para obtener la información de manera segura.
*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'''

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

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/tipopresentacion?limite=50&pagina=1

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

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

'''Parámetros'''
{| class="wikitable"
! 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
|}

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": null,
"message": "x registro(s) encontrados",
"result": [
{
"id": 1,
"codigo": "20",
"descripcion": "ENVIO "
},
]

}

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

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| Id || int || Corresponde al identificador deL tipo de presentacion
|-
| Código|| string || Corresponde al código deL tipo de presentacion
|-
| description|| string || Descripción deL tipo de presentacion
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"codigo" : "U08",
"descripcion": "UNICA"

}

</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| código|| String || SI || Describe el tipo de presentacion
|-
| descripción|| String || SI || Descripción deL tipo de presentacion
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{{
"success": true,
"code": 201,
"errors": null,
"message": "registro creado exitosamente"

}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''PUT'''

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 1,
"codigo": "2",
"descripcion": "ENVIO "

}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || Corresponde al identificador del tipo DE presentación
|-
| codigo|| string || 50 || SI || Describe el código del tipo de presentación
|-
| descripcion|| string || 50 || SI || Descripción el tipo de presentación
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true
"code": 200,
"message": "registro modificado exitosamente"
}

{
"success": false,
"code": 400,
"errors": [
"El campo codigo 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"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>
<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
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/tipopresentacion")
.method("GET", body)
.addHeader("secretkey", "ABc-zaw3+7uio-*")
.addHeader("Authorization", "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4MDUwMjYzODYiLrl5NCdQfosUBqVeGfWGCXrVcsov2VFBNBiayWxK9Hq0Ws9gqz7egNQ")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="java" line="1">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/tipopresentacion");
request.Headers.Add("secretkey", "ABc-xxsse3444.123");
request.Headers.Add("Authorization", "Bearer eyJhbGciOiJIUzUxMiIsInR5XVCJ9.eyJuYW1laWQiOiI4MDUwMjYzODYiLCJ1bmlxdWVfeGfWGCXrVcsov2VFBNBiayWxK9Hq0Ws9gqz7egNQ");
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>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="java" line="1">

<?php
$client = new http\Client;
$request = new http\Client\Request;
$request->setRequestUrl('https://localhost:44305/api/v1/tipopresentacion');
$request->setRequestMethod('GET');
$body = new http\Message\Body;
$request->setBody($body);
$request->setOptions(array());
$request->setHeaders(array(
'secretkey' => 'ABc-xyzas234*-.123',
'Authorization' => 'Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4MDUwMjYzODYiLHq0Ws9gqz7egNQ'
));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();

</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

</Tabs>

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]

API Articulos/Grupos Contables

2023-06-05T01:46:48Z

Gpazos:

'''Descripción:'''
Esta API permite sincronizar agrupador denominado Grupos contables entre SERPI y la plataforma que lo requiera,

'''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, 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) ">

'''EndPoint:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/GrupoCont</nowiki>

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/GrupoCont?limite=50&pagina=1</nowiki>

{| 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": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"codigo": "1",
"descripcion": "GRUPO CONTABLE DEMO",
"tipoproducto": 1,
"aplica_recaudo_tercero": true,
"aplica_impuesto_venta": true,
"impuesto_venta": 5.00000,
"descripcion_impuesto_venta": "IVA COMPRA 5%",
"aplica_impuesto_compra": true,
"impuesto_compra": 19.00000,
"descripcion_impuesto_compra": "IVA COMPRA 19%",
"aplica_impoconsumo": true,
"valor_impoconsumo": 0,
"aux_cuenta_impoconsumo": 1234567,
"aux_cuenta_gastoxcompra": 1234567,
"aux_cuenta_ingresoventa": 1234567,
"aux_cuenta_devolucionventa": 1234567,
"aux_cuenta_costo": 1234567,
"aux_cuenta_cartera": 1234567,
"aux_cuenta_ajuste": 1234567,
"aux_cuenta_desperdicio": 1234567,
"centro_costo": "01",
"aplica_retencion": true
}
]
}

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

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Identificador del grupo contable
|-
| codigo || string || Código único del grupo contable
|-
| descripcion || string || Descripción del grupo contable
|-
| tipoproducto || int || Tipo producto del grupo contable, debe ser 0 (Producto) o 1 (Servicio)
|-
| aplica_recaudo_tercero || bool || Si aplica recaudo para tercero para cuando el tipo producto es un 1 (Servicio)
|-
| aplica_impuesto_venta || bool || Si aplica impuesto venta
|-
| impuesto_venta || double || Porcentaje del impuesto venta
|-
| descripcion_impuesto_venta || string || Descripción del impuesto venta, debe ser "IVA COMPRA 5%", "IVA COMPRA 19%", "EXENTO", "IVA GENERADO EN VENTAS" o null
|-
| aplica_impuesto_compra || bool || Si aplica impuesto compra
|-
| impuesto_compra || double || Porcentaje del impuesto compra
|-
| descripcion_impuesto_compra || string || Descripción del impuesto compra, debe ser "IVA COMPRA 5%", "IVA COMPRA 19%", "EXENTO", "IVA GENERADO EN VENTAS" o null
|-
| aplica_impoconsumo || bool || Si aplica impuesto consumo
|-
| valor_impoconsumo || double || Valor del impoconsumo
|-
| aux_cuenta_impoconsumo || int || Cuenta Impoconsumo
|-
| aux_cuenta_gastoxcompra || int || Cuenta Gasto x Compra
|-
| aux_cuenta_ingresoventa || int || Cuenta Ingreso Venta
|-
| aux_cuenta_devolucionventa || int || Cuenta Devolucion Venta
|-
| aux_cuenta_costo || int || Cuenta Costo
|-
| aux_cuenta_cartera || int || Cuenta Cartera (Propiedad Horizontal)
|-
| aux_cuenta_ajuste || int || Cuenta Ajuste (Ajuste de Inventario)
|-
| aux_cuenta_desperdicio || int || Cuenta Desperdicio (Desperdicio Producción)
|-
| centro_costo || string || Centro de costo, debe ser 01 (ADMINISTRACION) o 02 (VENTAS)
|-
| aplica_retencion || bool || Si aplica retención
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/GrupoCont

{| 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">
{
"codigo": "1",
"descripcion": " GRUPO CONTABLE DEMO",
"tipoproducto": 1,
"aplica_recaudo_tercero": true,
"aplica_impuesto_venta": true,
"impuesto_venta": 3,
"aplica_impuesto_compra": true,
"impuesto_compra": 5,
"aplica_impoconsumo": false,
"valor_impoconsumo": 0,
"aux_cuenta_impoconsumo": 1234567,
"aux_cuenta_gastoxcompra": 1234567,
"aux_cuenta_ingresoventa": 1234567,
"aux_cuenta_devolucionventa": 1234567,
"aux_cuenta_costo": 1234567,
"aux_cuenta_cartera": 1234567,
"aux_cuenta_ajuste": 1234567,
"aux_cuenta_desperdicio": 1234567,
"centro_costo": "01",
"aplica_retencion": true
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo || string || 20 || Si || Código único del grupo contable
|-
| descripcion || string || 100 || Si || Descripción del grupo contable
|-
| tipoproducto || int || 11 || 11 || Tipo producto del grupo contable, debe ser 0 (Producto) o 1 (Servicio)
|-
| aplica_recaudo_tercero || bool || 1 || No || Si aplica recaudo para tercero para cuando el tipo producto es un 1 (Servicio)
|-
| aplica_impuesto_venta || bool || 1 || No || Si aplica impuesto venta
|-
| impuesto_venta || double || 1 || No || Porcentaje del impuesto venta, debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)
|-
| aplica_impuesto_compra || bool || 1 || No || Si aplica impuesto compra
|-
| impuesto_compra || double || 1 || No || Porcentaje del impuesto compra, debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)
|-
| aplica_impoconsumo || bool || 1 || No || Si aplica impuesto consumo
|-
| valor_impoconsumo || double || (18,5) || No || Valor del impoconsumo
|-
| aux_cuenta_impoconsumo || int || 11 || No || Cuenta Impoconsumo
|-
| aux_cuenta_gastoxcompra || int || 11 || Si || Cuenta Gasto x Compra
|-
| aux_cuenta_ingresoventa || int || 11 || Si || Cuenta Ingreso Venta
|-
| aux_cuenta_devolucionventa || int || 11 || Si || Cuenta Devolucion Venta
|-
| aux_cuenta_costo || int || 11 || Si || Cuenta Costo
|-
| aux_cuenta_cartera || int || 11 || No || Cuenta Cartera (Propiedad Horizontal)
|-
| aux_cuenta_ajuste || int || 11 || No || Cuenta Ajuste (Ajuste de Inventario)
|-
| aux_cuenta_desperdicio || int || 11 || No || Cuenta Desperdicio (Desperdicio Producción)
|-
| centro_costo || string || 5 || Si || Centro de costo, debe ser 01 (ADMINISTRACION) o 02 (VENTAS)
|-
| aplica_retencion || bool || 1 || No || Si aplica retención
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [],
"message": "Validaciones exitosas. Registro creado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo descripcion es obligatorio",
"El campo tipoproducto debe ser 0 (Producto) o 1 (Servicio)",
"El campo impuesto_venta debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)",
"El campo impuesto_compra debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)",
"El campo centro_costo debe ser 01 (ADMINISTRACION) o 02 (VENTAS)",
"El auxiliar 123456 del campo aux_cuenta_impoconsumo no existe",
"El campo aux_cuenta_gastoxcompra es obligatorio",
"El campo aux_cuenta_ingresoventa es obligatorio",
"El campo aux_cuenta_devolucionventa es obligatorio",
"El campo aux_cuenta_costo es obligatorio",
"El auxiliar 123456 del campo aux_cuenta_cartera no existe",
"El auxiliar 123456 del campo aux_cuenta_ajuste no existe",
"El auxiliar 123456 del campo aux_cuenta_desperdicio no existe"
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/GrupoCont

{| 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">
{
"id": 1,
"codigo": "1",
"descripcion": " GRUPO CONTABLE DEMO",
"tipoproducto": 1,
"aplica_recaudo_tercero": true,
"aplica_impuesto_venta": true,
"impuesto_venta": 3,
"aplica_impuesto_compra": true,
"impuesto_compra": 5,
"aplica_impoconsumo": false,
"valor_impoconsumo": 0,
"aux_cuenta_impoconsumo": 1234567,
"aux_cuenta_gastoxcompra": 1234567,
"aux_cuenta_ingresoventa": 1234567,
"aux_cuenta_devolucionventa": 1234567,
"aux_cuenta_costo": 1234567,
"aux_cuenta_cartera": 1234567,
"aux_cuenta_ajuste": 1234567,
"aux_cuenta_desperdicio": 1234567,
"centro_costo": "01",
"aplica_retencion": true
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || Si || Identificador del grupo contable
|-
| codigo || string || 20 || Si || Código único del grupo contable
|-
| descripcion || string || 100 || Si || Descripción del grupo contable
|-
| tipoproducto || int || 11 || 11 || Tipo producto del grupo contable, debe ser 0 (Producto) o 1 (Servicio)
|-
| aplica_recaudo_tercero || bool || 1 || No || Si aplica recaudo para tercero para cuando el tipo producto es un 1 (Servicio)
|-
| aplica_impuesto_venta || bool || 1 || No || Si aplica impuesto venta
|-
| impuesto_venta || double || 1 || No || Porcentaje del impuesto venta, debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)
|-
| aplica_impuesto_compra || bool || 1 || No || Si aplica impuesto compra
|-
| impuesto_compra || double || 1 || No || Porcentaje del impuesto compra, debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)
|-
| aplica_impoconsumo || bool || 1 || No || Si aplica impuesto consumo
|-
| valor_impoconsumo || double || (18,5) || No || Valor del impoconsumo
|-
| aux_cuenta_impoconsumo || int || 11 || No || Cuenta Impoconsumo
|-
| aux_cuenta_gastoxcompra || int || 11 || Si || Cuenta Gasto x Compra
|-
| aux_cuenta_ingresoventa || int || 11 || Si || Cuenta Ingreso Venta
|-
| aux_cuenta_devolucionventa || int || 11 || Si || Cuenta Devolucion Venta
|-
| aux_cuenta_costo || int || 11 || Si || Cuenta Costo
|-
| aux_cuenta_cartera || int || 11 || No || Cuenta Cartera (Propiedad Horizontal)
|-
| aux_cuenta_ajuste || int || 11 || No || Cuenta Ajuste (Ajuste de Inventario)
|-
| aux_cuenta_desperdicio || int || 11 || No || Cuenta Desperdicio (Desperdicio Producción)
|-
| centro_costo || string || 5 || Si || Centro de costo, debe ser 01 (ADMINISTRACION) o 02 (VENTAS)
|-
| aplica_retencion || bool || 1 || No || Si aplica retención
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Validaciones exitosas. Registro modificado exitosamente"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id 1"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"El campo descripcion es obligatorio",
"El campo tipoproducto debe ser 0 (Producto) o 1 (Servicio)",
"El campo impuesto_venta debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)",
"El campo impuesto_compra debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)",
"El campo centro_costo debe ser 01 (ADMINISTRACION) o 02 (VENTAS)",
"El auxiliar 123456 del campo aux_cuenta_impoconsumo no existe",
"El campo aux_cuenta_gastoxcompra es obligatorio",
"El campo aux_cuenta_ingresoventa es obligatorio",
"El campo aux_cuenta_devolucionventa es obligatorio",
"El campo aux_cuenta_costo es obligatorio",
"El auxiliar 123456 del campo aux_cuenta_cartera no existe",
"El auxiliar 123456 del campo aux_cuenta_ajuste no existe",
"El auxiliar 123456 del campo aux_cuenta_desperdicio no existe"
],
"message": "Problemas de validaciones. Se presentaron errores al modificar el registro"
}
</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! 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'''
<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/GrupoCont")
.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/GrupoCont");
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/GrupoCont');
$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 Articulos/Lineas

2023-06-05T01:45:18Z

Gpazos:

'''Descripción:'''
Esta API permite la sincronización del agrupador definido como Linea 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 (GET) ">

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

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/Linea?limite=50&pagina=1</nowiki>

{| 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": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"codigo": "1",
"descripcion": "PRODUCTOS NO FABRICADOS"
}
]
}

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

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador de la linea
|-
| codigo || string|| Código
|-
| descripcion || string || Descripción de la linea
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/Linea

{| 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">
{
"codigo": "13",
"descripcion": "PRODUCTOS DE PRUEBA"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo || string || 30 || Si || Código
|-
| descripcion || string || 100 || Si || Descripción de la linea
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": null,
"message": "registro creado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo descripcion es obligatorio",
"El campo codigo es obligatorio"
],
"message": "Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/Linea

{| 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">
{
"id": 3,
"codigo": "66",
"descripcion": "PRODUCTOS CAMBIADO"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || Si || Corresponde al identificador de la linea
|-
| codigo || string || 30 || Si || Código
|-
| descripcion || string || 100 || Si || Descripción de la linea
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "registro modificado exitosamente"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id 1"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"El campo descripcion es obligatorio",
"El campo codigo es obligatorio"
],
"message": "Se presentaron errores al modificar el registro"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https:///www.apis.serpi.com.co/api/v1/Linea")
.method("GET", body)
.addHeader("secretkey", "{Secret Key}")
.addHeader("Authorization", "{Bearer Token}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Python">
'''Request'''
<syntaxhighlight lang="java" line="1">
import requests

url = "https://www.apis.serpi.com.co/api/v1/Linea"

payload = {}
headers = {
'secretkey': '{Secret Key}',
'Authorization': '{Bearer Token}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Php">
'''Request'''
<syntaxhighlight lang="java" line="1">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://www.apis.serpi.com.co/api/v1/Linea');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{Secret Key}',
'Authorization' => '{Bearer Token}'
));
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>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

</Tabs>

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]

API Articulos

2023-06-05T01:43:51Z

Gpazos:

'''Descripción:'''
Esta API permite la sincronización de los items registrados en SERPI con la plataforma que se requiera, los ítems son utilizados en los procesos de inventarios facturacion y POS.

'''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, 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/TipoIdentidad

'''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 '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

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

'''Parámetros'''
{| class="wikitable"
! 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'''
<syntaxhighlight lang="JSON" line="1">
{
"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,
"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": ""
}

]
}

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

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! 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
|-
| camposcliente || 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/TipoIdentidad

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"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": ""
}

}

</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! 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
|-
| camposcliente || Objeto || NO || Objeto con la información de campos personalizados
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 terceros"
}
</syntaxhighlight>
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 1
"abreviatura": "NIT",
"descripcion": "NIT",
"codigo": 31,
"abreviatura2": " NIT2",
"abreviatura3": "",
"excluirImpVentas": false
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || Corresponde al identificador del tipo de identidad
|-
| abreviatura || string || 50 || SI || Abreviatura Tipo de identidad
|-
| descripcion|| string || 50 || SI || Descripcion tipo de identidad
|-
| codigo || int || 50 || SI || Codigo numero del tipo de identidad
|-
| abreviatura2 || string || 50 || NO || Abreviatura2 Tipo de identidad
|-
| abreviatura3 || string || 50 || NO || Abreviatura3 Tipo de identidad
|-
| excluirImpVentas|| bool || 50 || NO || true o false. Si el tipo de identidad es excluido del impuesto de ventas
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"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"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://wv9901.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}")
.method("GET", null)
.addHeader("wolkvox-token", "{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Python">
'''Request'''
<syntaxhighlight lang="java" line="1">
import requests

url = "https://wv9901.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}"

payload={}
headers = {
'wolkvox-token': '{{token}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

</Tabs>

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]

API Terceros/Bancos

2023-06-05T01:36:07Z

Gpazos:

'''Descripción:'''
Esta API permite sincronizar los bancos definidos en SERPI con con la plataforma que lo requiera.

'''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 reporte permite hacer una medición de la productividad individual de los agentes teniendo en cuenta el tiempo dedicado a la gestión de llamadas y sus logros (hits y RPC)

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

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

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Banco?limite=50&pagina=1

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

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

'''Parámetros'''
{| class="wikitable"
! 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" line="1">
{
"success": true
"code": 200,
"message": "x registro(s) encontrados",
"result": [
{
"id": 6,
"codigo": "007",
"descripcion": "BANCOLOMBIA",
"codigo2": ""
}
]
}

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

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| Id || int || Corresponde al identificador de banco
|-
| codigo|| string || Abreviatura numerica banco
|-
| descripcion || string || Descripción tipo de banco
|-
| codigo || int || Código alterno numero del banco

|}
</Tab>


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

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"codigo": "990",
"descripcion": "Banco Agrario de Colombia",
"codigo2": "80"
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| Codigo|| string || 5 || SI || Abreviatura numerica banco
|-
| descripcion || string || 100 || SI || Descripción tipo de banco
|-
| Codigo2 || string || 15 || SI || Código alterno numero del banco

|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": null,
"message": "registro creado exitosamente"

}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''PUT'''

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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 1
"codigo": "99",
"descripcion": "DAVIVIENDA",
"codigo2": 31,
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| Codigo|| string || 5 || SI || Abreviatura numerica banco
|-
| descripcion || string || 100 || SI || Descripción tipo de banco
|-
| Codigo2 || string || 15 || SI || Código alterno numero del banco
|}

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

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true
"code": 200,
"message": "registro modificado exitosamente"
}

{
"success": false,
"code": 400,
"errors": [
"El campo Codigoes obligatorio"
],
"message": "Se presentaron errores al modificar el registro"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id xx"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java" line="1">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://wv9901.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}")
.method("GET", null)
.addHeader("wolkvox-token", "{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "Python">
'''Request'''
<syntaxhighlight lang="java" line="1">
import requests

url = "https://wv9901.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}"

payload={}
headers = {
'wolkvox-token': '{{token}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"code": 200,
"error": null,
"msg": "Information found for the current month",
"data": [
{
"operation": "",
"description": "",
"items": "",
"date": ""
}
]
}
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="java" line="1">

$request->setRequestUrl('https://localhost:44305/api/v1/Banco');
$request->setRequestMethod('GET');
$body = new http\Message\Body;
$request->setBody($body);
$request->setOptions(array());
$request->setHeaders(array(
'secretkey' => 'XXX123.ABc0101.123',
'Authorization' => '5NCdQfosUBqVeGfWGCXrVcsov2VFBNBiayWxK9Hq0Ws9gqz7egNQ'
));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();

</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="java" line="1">
{
"success": true,
"code": 200,
"errors": null,
"message": "2 registro(s) encontrados",
"result": [
{
"id": 6,
"codigo": "007",
"descripcion": "BANCOLOMBIA",
"codigo2": ""
},
{
"id": 7,
"codigo": "51",
"descripcion": "DAVIVIENDA",
"codigo2": ""
},

]
}

</syntaxhighlight>
</Tab>

</Tabs>

''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}

[[Category:Documentación APIs]]