WikiSerpi - Contribuciones del usuario [es]

API Terceros/Campos Personalizados Articulos

2024-05-21T16:17:43Z

Nalzate: Página creada con «'''Descripción:''' Este conjunto de APIs esta dispuesto con el fin de consultar los datos correspondientes a los campos personalizados de los articulos en SERPI. '''Autorización:''' Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP. '''Beneficio:''' Este API permite tener sincronizad…»

'''Descripción:'''
Este conjunto de APIs esta dispuesto con el fin de consultar los datos correspondientes a los campos personalizados de los articulos en SERPI.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''
Este API permite tener sincronizada la información concerniente a terceros de su plataforma y SERPI .

'''Tipos de peticiones:'''
GET

'''¿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/CamposArticulo

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/CamposArticulo?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": [
{
"campo": {
"id_campoarticulo": 1,
"descripcion_campoarticulo": "TIPO_ALMACENAMIENTO"
},
"detalle": [
{
"1": "REFRIGERADO"
},
{
"2": "NO APLICA"
}
]
}
]
}

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

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| *Campo || Objeto || Contiene id_campoarticulo y descripcion_campoarticulo
|-
| id_campoarticulo || int || Identificador del campo personalizado
|-
| descripcion_campoarticulo || string || Descripción del campo personalizado
|-
| *Detalle || Objeto || Contiene los detalles de los campos personalizados (Valor y descripción). En caso de no tener detalles, no se mostrarán.
|}

</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/CamposArticulo")
.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/CamposArticulo");
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/CamposArticulo');
$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/Campos Personalizados Terceros

2024-05-21T16:12:30Z

Nalzate: /* Métodos */

'''Descripción:'''
Este conjunto de APIs esta dispuesto con el fin de consultar los datos correspondientes a los campos personalizados de terceros en SERPI.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''
Este API permite tener sincronizada la información concerniente a terceros de su plataforma y SERPI .

'''Tipos de peticiones:'''
GET

'''¿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/CamposCliente

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/CamposCliente?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": [
{
"campo": {
"id_campocliente": 1,
"descripcion_campocliente": "GRUPO_ETNICO"
},
"detalle": [
{
"1": "AFRODESCENDIENTE"
},
{
"2": "MESTIZO"
}
]
}
]
}

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

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| *Campo || Objeto || Contiene id_campocliente y descripcion_campocliente
|-
| id_campocliente || int || Identificador del campo personalizado
|-
| descripcion_campocliente || string || Descripción del campo personalizado
|-
| *Detalle || Objeto || Contiene los detalles de los campos personalizados (Valor y descripción). En caso de no tener detalles, no se mostrarán.
|}

</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/CamposCliente")
.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/CamposCliente");
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/CamposCliente');
$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/Campos Personalizados Terceros

2024-05-21T16:10:19Z

Nalzate: /* ¿Cómo consumir la API? */

'''Descripción:'''
Este conjunto de APIs esta dispuesto con el fin de consultar los datos correspondientes a los campos personalizados de terceros en SERPI.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''
Este API permite tener sincronizada la información concerniente a terceros de su plataforma y SERPI .

'''Tipos de peticiones:'''
GET

'''¿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/CamposCliente

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/CamposCliente?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": [
{
"campo": {
"id_campoarticulo": 1,
"descripcion_campoarticulo": "GRUPO_ETNICO"
},
"detalle": [
{
"1": "AFRODESCENDIENTE"
},
{
"2": "MESTIZO"
}
]
}
]
}

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

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| *Campo || Objeto || Contiene id_campocliente y descripcion_campocliente
|-
| id_campocliente || int || Identificador del campo personalizado
|-
| descripcion_campocliente || string || Descripción del campo personalizado
|-
| *Detalle || Objeto || Contiene los detalles de los campos personalizados (Valor y descripción). En caso de no tener detalles, no se mostrarán.
|}

</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/CamposCliente")
.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/CamposCliente");
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/CamposCliente');
$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/Campos Personalizados Terceros

2024-05-21T16:09:27Z

Nalzate: /* Métodos */

'''Descripción:'''
Este conjunto de APIs esta dispuesto con el fin de consultar los datos correspondientes a los campos personalizados de terceros en SERPI.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''
Este API permite tener sincronizada la información concerniente a terceros de su plataforma y SERPI .

'''Tipos de peticiones:'''
GET

'''¿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/CamposCliente

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/CamposCliente?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": [
{
"campo": {
"id_campoarticulo": 1,
"descripcion_campoarticulo": "GRUPO_ETNICO"
},
"detalle": [
{
"1": "AFRODESCENDIENTE"
},
{
"2": "MESTIZO"
}
]
}
]
}

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

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| *Campo || Objeto || Contiene id_campocliente y descripcion_campocliente
|-
| id_campocliente || int || Identificador del campo personalizado
|-
| descripcion_campocliente || string || Descripción del campo personalizado
|-
| *Detalle || Objeto || Contiene los detalles de los campos personalizados (Valor y descripción). En caso de no tener detalles, no se mostrarán.
|}

</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/Tercero")
.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/Tercero");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</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/Tercero');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Terceros/Campos Personalizados Terceros

2024-05-21T16:06:12Z

Nalzate: /* Métodos */

'''Descripción:'''
Este conjunto de APIs esta dispuesto con el fin de consultar los datos correspondientes a los campos personalizados de terceros en SERPI.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''
Este API permite tener sincronizada la información concerniente a terceros de su plataforma y SERPI .

'''Tipos de peticiones:'''
GET

'''¿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/CamposCliente

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/CamposCliente?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": [
{
"campo": {
"id_campoarticulo": 1,
"descripcion_campoarticulo": "GRUPO_ETNICO"
},
"detalle": [
{
"1": "AFRODESCENDIENTE"
},
{
"2": "MESTIZO"
}
]
}
]
}

{
"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
|-
| *Campo || Objeto || Contiene id_campoarticulo y descripcion_campoarticulo
|-
| id_campoarticulo || int || Identificador del campo del artículo
|-
| descripcion_campoarticulo || string || Descripción del campo del artículo
|-
| *Detalle || Objeto || Contiene los detalles de los campos personalizados (Valor y descripción). En caso de no tener detalles, no se mostrarán.
|}

</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/Tercero")
.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/Tercero");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</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/Tercero');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Terceros/Campos Personalizados Terceros

2024-05-21T15:46:21Z

Nalzate:

'''Descripción:'''
Este conjunto de APIs esta dispuesto con el fin de consultar los datos correspondientes a los campos personalizados de terceros en SERPI.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''
Este API permite tener sincronizada la información concerniente a terceros de su plataforma y SERPI .

'''Tipos de peticiones:'''
GET

'''¿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/CamposCliente

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/CamposCliente?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": [
{
"campo": {
"id_campoarticulo": 1,
"descripcion_campoarticulo": "GRUPO_ETNICO"
},
"detalle": [
{
"1": "AFRODESCENDIENTE"
},
{
"2": "MESTIZO"
}
]
}
]
}

{
"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
|-
| tipo cuenta || string || Tipo de cuenta bancaria (A=Cuenta de ahorro, B=Cuenta Corriente)
|-
| cuenta bancaria || string || Numero de cuenta bancaria
|-
| limite credito || decimal || Limite del credito
|-
| camposPersonalizados || Objeto || Objeto con la informacion de campos personalizados
|}
</Tab>

</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/Tercero")
.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/Tercero");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</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/Tercero');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Terceros/Campos Personalizados Terceros

2024-05-21T15:34:53Z

Nalzate:

'''Descripción:'''
Este conjunto de APIs esta dispuesto con el fin de consultar los datos correspondientes a los campos personalizados de terceros en SERPI.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''
Este API permite tener sincronizada la información concerniente a terceros de su plataforma y SERPI .

'''Tipos de peticiones:'''
GET

'''¿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/CamposCliente

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/CamposCliente?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": 1,
"tipo_cuenta": null,
"cuenta_bancaria": null,
"limite_credito": 0.00000,
"camposPersonalizados": {
"ACTIVIDADECONOMICAMUNICIPAL": "BC44",
"Comentarios": "Cliente proveedor de software",
"Comuna": 11,
"FechaAniversario": "2016-06-01",
"ClienteNacional": true,
"Ranking": "2",
"TieneAsesor": "N",
"Vetado": "3",
"TipodeEmpresa": [
"b",
"c"
],
"continente": ""
}

]
}

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

{
"success": false,
"code": 400,
"message": "El formato de las fechas es invalido. Ejemplo 2023-01-20 00:00:00",
}

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| Id || int || Corresponde al identificador del tercero
|-
| tipo cuenta || string || Tipo de cuenta bancaria (A=Cuenta de ahorro, B=Cuenta Corriente)
|-
| cuenta bancaria || string || Numero de cuenta bancaria
|-
| limite credito || decimal || Limite del credito
|-
| camposPersonalizados || Objeto || Objeto con la informacion de campos personalizados
|}
</Tab>

</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/Tercero")
.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/Tercero");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</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/Tercero');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Terceros/Campos Personalizados Terceros

2024-05-21T15:24:32Z

Nalzate: Página creada con «'''Descripción:''' Este conjunto de APIs esta dispuesto con el fin de consultar, agregar y modificar los datos correspondientes a terceros en SERPI, como terceros se consideran diferentes actores del procesos como clientes, empleados, vendedores, proveedores y otros. '''Autorización:''' Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authoriza…»

API Modulo Articulos Productos

2024-05-21T15:19:28Z

Nalzate:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Articulos/Productos'''

* '''[[API Articulos]]'''
* [[API Articulos/Proveedores|API Proveedores]]
* [[API Articulos/Lineas|API Líneas]]
* [[API Articulos/Grupos Contables|API Grupos Contables]]
* [[API Articulos/Presentacion-Tipo|API Tipo Presentación]]
* [[API Articulos/Marcas|API Marcas]]
* [[API Articulos/Unidades de Medida|API Unidades de Medida]]
* [[API Articulos/Grupos|API Grupos(Categorías)]]
* [[API Terceros/Lista_Precios|API Lista Precios]]
* [[API Terceros/Lista_Precios_Detalle|API Lista Precios Detalle]]
* [[API Terceros/Campos_Personalizados_Articulos|API Campos Personalizados Articulos]]

API Modulo Terceros

2024-05-21T15:18:13Z

Nalzate:

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

* '''[[API Terceros]]'''
* [[API Terceros/Tipo_Identidad|API Tipo Identidad]]

* [[API Terceros/Paises|API Países]]
* [[API Terceros/Ciudades|API Ciudades]]
* [[API Terceros/Zonas|API Zonas]]
* [[API Terceros/Categoria_Terceros|API Categoria Terceros]]
* [[API Terceros/Forma_Pago|API Forma Pago]]
* [[API Terceros/Lista_Precios|API Lista Precios]]
* [[API Terceros/Lista_Precios_Detalle|API Lista Precios Detalle]]
* [[API Terceros/Grupo_Ventas_Compras|API Grupo Ventas/Compras]]
* [[API Terceros|API Vendedores]]
* [[API Terceros|API Cobradores]]
* [[API Terceros/Regimen_Tributario|API Regimen Tributario]]
* [[API Terceros/Bancos|API Bancos]]
* [[API Terceros/Tipo_Cuenta|API Tipo Cuenta]]
* [[API Terceros/Notas_Tercero|API Notas Tercero]]
* [[API Terceros/Campos_Personalizados_Terceros|API Campos Personalizados Terceros]]

API Terceros

2023-11-23T17:58:06Z

Nalzate: /* Métodos */

'''Descripción:'''
Este conjunto de APIs esta dispuesto con el fin de consultar, agregar y modificar los datos correspondientes a terceros en SERPI, como terceros se consideran diferentes actores del procesos como clientes, empleados, vendedores, proveedores y otros.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''
Este API permite tener sincronizada la información concerniente a terceros de su plataforma y SERPI .

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

'''¿Cómo funciona?'''
*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

== Métodos ==
<Tabs>

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

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

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Tercero?limite=50&pagina=1&identificacion=123456789&fechaCreadoDesde=2020-01-01%2000:00:00&fechaCreadoHasta=2020-12-31%2023:59:59

''' Headers '''
{| 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,
"camposPersonalizados": {
"ACTIVIDADECONOMICAMUNICIPAL": "BC44",
"Comentarios": "Cliente proveedor de software",
"Comuna": 11,
"FechaAniversario": "2016-06-01",
"ClienteNacional": true,
"Ranking": "2",
"TieneAsesor": "N",
"Vetado": "3",
"TipodeEmpresa": [
"b",
"c"
],
"continente": ""
}

]
}

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

{
"success": false,
"code": 400,
"message": "El formato de las fechas es invalido. Ejemplo 2023-01-20 00:00:00",
}

</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
|-
| camposPersonalizados || Objeto || Objeto con la informacion de campos personalizados
|}
</Tab>


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

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

''' Headers '''
{| 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
|-
| camposPersonalizados || 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/Tercero

''' 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,
"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 left"
! Campo !! Tipo !! Longitud !! Requerido !! Descripción
|-
| tipoidentidad || String || 50 || SI || Código del tipo de identidad
|-
| identificacion || String || 50 || SI || Número de identificación
|-
| dv || Int || 50 || SI || Digito de verificación
|-
| tipopersona || 50 || Int || SI || Código del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || String || 50 || SI (Si tipo persona=NATURAL) || Primer Nombre
|-
| segundonombre || String || 50 || NO || Segundo Nombre
|-
| primerapellido || String || 50 || SI (Si tipo persona=NATURAL) || Primer Apellido
|-
| segundoapellido || String || 50 || NO || Segundo Apellido
|-
| nombrecompleto || String || 50 || SI || Nombre Completo
|-
| razonsocial || String || 50 || SI (Si tipo persona=JURIDICO) || Razón Social
|-
| escliente || Bool || 50 || NO || Seleccionar si el tercero es cliente
|-
| esproveedor || Bool || 50 || NO || Seleccionar si el tercero es proveedor
|-
| esempleado || Bool || 50 || NO || Seleccionar si el tercero es empleado
|-
| esvendedor || Bool || 50 || NO || Seleccionar si el tercero es vendedor
|-
| esotro || Bool || 50 || NO || Seleccionar si el tercero es otro
|-
| escobrador || Bool || 50 || NO || Seleccionar si el tercero es cobrador
|-
| cumple_dia || Int || 50 || NO || Día del cumpleaños
|-
| cumplea_mes || Int || 50 || NO || Mes del cumpleaños
|-
| cumplea_ano || Int || 50 || NO || Año del cumpleaños
|-
| genero || String || 50 || NO || Género del tercero (M=Masculino, F=Femenino)
|-
| direccion || String || 50 || SI || Dirección
|-
| direccion2 || String || 50 || NO || Dirección complementaria
|-
| telefono || String || 50 || NO || Número de teléfono
|-
| ext || Int || 50 || NO || Número de extensión
|-
| movil || String || 50 || SI || Número de móvil celular
|-
| pais || String || 50 || Informativo || Nombre País
|-
| departamento || String || 50 || Informativo || Nombre del departamento
|-
| ciudad || String || 50 || Informativo || Nombre de la ciudad
|-
| codciudad || String || 50 || SI || Código único de la ciudad
|-
| zona || Int || 50 || NO || ID de la zona
|-
| email || String || 50 || SI || Cuenta de email
|-
| activo || Bool || 50 || SI || Estado del tercero (true=Activo, false=Inactivo)
|-
| cupocredito || Decimal || 50 || NO || Cupo de crédito
|-
| periodopago || Int || 50 || NO || Período de pago en días para el vencimiento de facturas de venta
|-
| codigociiu || String || 50 || NO || Código CIIU, Actividades económicas
|-
| descuentoventa || Decimal || 50 || NO || Porcentaje para el descuento en ventas
|-
| categoriatercero || Int || 50 || SI || ID de la categoría de terceros
|-
| formapago || Int || 50 || NO || ID de la forma de pago
|-
| listaprecios || Int || 50 || NO || ID de la lista de precios
|-
| grupoventas || Int || 50 || SI || ID del grupo de retenciones para ventas
|-
| grupocompras || Int || 50 || SI || ID del grupo de retenciones para compras
|-
| vendedor || Int || 50 || NO || Número de identificación del vendedor
|-
| cobrador || Int || 50 || NO || Número de identificación del cobrador
|-
| fechacreacion || String || 50 || NO || Fecha de creación del tercero. Ejemplo "2020-05-20 00:00:00"
|-
| regimen || Int || 50 || SI || ID del régimen tributario
|-
| banco || Int || 50 || NO || ID del banco
|-
| tipo_cuenta || String || 50 || NO || Tipo cuenta bancaria. (A=Cuenta de Ahorro, B=Cuenta Corriente)
|-
| cuenta_bancaria || String || 50 || NO || Número de cuenta bancaria
|-
| limite_credito || Decimal || 50 || NO || Límite del crédito
|-
| camposPersonalizados || Objeto || 50 || NO || Objeto con la información de campos personalizados
|}

'''Authorization:'''
<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ó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/Tercero")
.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/Tercero");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</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/Tercero');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Ordenes de Producción

2023-10-30T14:19:14Z

Nalzate:

'''Descripción:'''
Esta API permite la sincronización del agrupador definido como Ordenes de Produccion 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 Tipo de Documento(GET)">

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "2 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "OP",
"prefijo": "OP",
"descripcion": "ORDEN DE PRODUCCION"
}
]
}

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

</syntaxhighlight>

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


<Tab name = "API Consultar Ordenes de Producción(GET) ">

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/OP/ConsultarOP?limite=10&pagina=1&idTipoDocumento=1&numeroDesde=1&numeroHasta=100&fechaDesde=2023-07-01&fechaHasta=2023-08-31&idArticulo=10&estado=1

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Requerido !! Descripción
|-
| Límite || NO || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || NO || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|-
| idTipoDocumento || SI || Id del tipo de documento (Api consulta tipos documento)
|-
| numeroDesde || NO || Numero inicial para filtrar por rango de numeros de documentos
|-
| numeroHasta || NO || Numero final para filtrar por rango de numeros de documentos
|-
| fechaDesde || SI || Fecha inicial para filtrar por rango de fecha del documento
|-
| fechaHasta || SI || Fecha final para filtrr por rango de fecha del documento
|-
| idArticulo || NO || Id del Articulo a filtrar
|-
| Estado || NO || 1=En Proceso, 2=Terminado
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1818,
"prefijo": "OP",
"numeroDoc": 1,
"idArticulo": 10,
"articulo": "ARTICULO1",
"fecha": "2023-06-23",
"autor": "USUARIO1",
"cantidad": 10000.00000,
"cantPendiente": 7000.00000,
"cantEnsambles": 2,
"estado": "En Proceso",
"ensambles": [
{
"prefijo": "ENS",
"numeroDoc": 1,
"fecha": "2023-07-12",
"autor": "USUARIO2",
"cantidad": 1500.00000,
"estado": "Terminado"
},
{
"prefijo": "ENS",
"numeroDoc": 2,
"fecha": "2023-06-30",
"autor": "USUARIO2",
"cantidad": 1500.00000,
"estado": "Terminado"
}
]
}
]
}

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

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| id || Int || Corresponde al id del registro
|-
| prefijo || String || Prefijo del tipo de documento
|-
| numeroDoc || Int || Numero de la orden de produccion
|-
| idArticulo || Int || Id del Articulo
|-
| articulo || String || Descripcion del Articulo
|-
| fecha || String || Fecha de la orden de produccion
|-
| autor || String || Usuario quien crea la orden de produccion
|-
| cantidad || Decimal || cantidad a producir
|-
| cantidadPendiente || Decimal || Cantidad Pendiente
|-
| cantEnsambles || Int || Cantidad de ensambles asociados a la orden de produccion
|-
| Estado || String || Estado de la orden de produccion
|-
| ensambles || Array[ObjetoDetalle]* || Array de objetos de los ensambles la orden de produccion
|}

'''ObjetoDetalle'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| prefijo || String || Prefijo del tipo de documento del ensamble
|-
| numeroDoc || Int || Numero del ensamble
|-
| fecha || String || Fecha del ensamble
|-
| autor || String || Usuario quien crea el ensamble
|-
| cantidad || Decimal || Cantidad del ensamble
|-
| Estado || String || Estado del ensamble
|}

</Tab>


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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"prefijo": "OP",
"numeroDoc": 1,
"idArticulo": 10,
"fecha": "2023-08-29",
"cantidad": 100
},
{
"prefijo": "OP",
"numeroDoc": 2,
"idArticulo": 11,
"fecha": "2023-08-29",
"cantidad": 220
}
]

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| prefijo || String || SI || Prefijo del tipo de documento
|-
| numeroDoc || Int || SI || Numero de la orden de produccion
|-
| idArticulo || Int || SI || Id del Articulo
|-
| cantidad || Decimal || SI || Cantidad a producir
|}

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

</syntaxhighlight>
</Tab>


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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Requerido !! Descripción
|-
| idOP || NO || id de la orden de produccion a eliminar
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Se elimino correctamente la Orden de Produccion"
}

</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/OP")
.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/OP");
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/OP');
$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 Formulas

2023-10-30T14:18:48Z

Nalzate:

'''Descripción:'''
Esta API permite la sincronización del agrupador definido como Formulas 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 Tipo de Materiales(GET)">

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "2 registro(s) encontrados",
"result": [
{
"id": 1,
"tipoMaterial": "COMPONENTE"
},
{
"id": 2,
"tipoMaterial": "PRODUCTO SECUNDARIO"
}
]
}

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

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador del tipo de material
|-
| tipoMaterial || string || Tipo de Material
|}
</Tab>


<Tab name = "API Consultar Formulas(GET) ">

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

{| 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
|-
| idArticulo || int || NO || Id del articulo a buscar
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 60,
"idArticulo": 120,
"codigo": "COD1",
"descripcion": "ARTICULO1",
"naturaleza": "E",
"idunidadmedida": 4,
"unidadmedida": "KILOGRAMOS",
"materiales": [
{
"idDetalle": 60,
"idArticulo": 649,
"codigo": "COD60",
"descripcion": "ARTICULO60",
"idTipoMaterial": 1,
"tipoMaterial": "COMPONENTE",
"cantidad": 0.0025,
"idunidadmedida": 3,
"unidadmedida": "UNIDAD"
},
{
"idDetalle": 60,
"idArticulo": 282,
"codigo": "COD2",
"descripcion": "CODIGO2",
"idTipoMaterial": 1,
"tipoMaterial": "COMPONENTE",
"cantidad": 0.003,
"idunidadmedida": 4,
"unidadmedida": "KILOGRAMOS"
}
]
}
]
}

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

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| id || int || Corresponde al id del registro de la formula
|-
| idArticulo || int || Id del Articulo
|-
| codigo || string || Codigo del Articulo
|-
| descripcion || string || Descripcion del Articulo
|-
| naturaleza || string || E=Ensamble, S=Desemsamble
|-
| idunidadmedida || int || Id de la unidad de medida
|-
| unidadmedida || string || Descripcion de la unidad de medida
|-
| materiales || Array[ObjetoMateriales] || Array de objetos de los materiales de la formula
|}

'''ObjetoMateriales'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| idDetalle || Int || Corresponde al id del material
|-
| idArticulo || int || Id del Articulo
|-
| codigo || string || Codigo del Articulo
|-
| descripcion || string || Descripcion del Articulo
|-
| IdTipoMaterial || int || Id del tipo de material
|-
| TipoMaterial || string || Descripcion del tipo de material
|-
| cantidad || decimal || Cantidad vendida
|-
| Idunidadmedida || int || Id de la unidad de medida
|-
| unidadmedida || string || Descripcion de la unidad de medida
|}

</Tab>


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

{| 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">
[
{
"idArticulo": 120,
"naturaleza": "E",
"idunidadmedida": 4,
"materiales": [
{
"idArticulo": 649,
"idTipoMaterial": 1,
"cantidad": 0.0025,
"idunidadmedida": 3
},
{
"idArticulo": 282,
"idTipoMaterial": 2,
"cantidad": 0.003,
"idunidadmedida": 4
}
]
}
]

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| idArticulo || Int || SI || Id del Articulo
|-
| naturaleza || String || SI || E=Ensamble, S=Desemsamble
|-
| idunidadmedida || Int || NO || Id de la unidad de medida
|-
| materiales || Array[ObjetoMateriales] || SI || Array de objetos de los materiales de la formula
|}

'''ObjetoMateriales'''

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| idArticulo || Int || SI || Id del Articulo
|-
| idTipoMaterial || Int || SI || Id del tipo de material
|-
| cantidad || decimal || SI || Cantidad vendida
|-
| idunidadmedida || Int || NO || Id de la unidad de medida
|}

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

</syntaxhighlight>
</Tab>


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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Requerido !! Descripción
|-
| idFormula || NO || id de la Formula a eliminar
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": " Se elimino la formula correctamente"
}
</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/Formula")
.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/Formula");
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/Formula');
$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 Ensambles

2023-10-30T14:17:40Z

Nalzate:

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

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''

'''Tipos de peticiones:'''
GET

'''¿Cómo funciona?'''
*El consumo de esta API se realiza por método GET.
*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

== Métodos ==
<Tabs>

<Tab name = "API Consulta Tipos de Documento(GET)">

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "ENS",
"prefijo": "ENS",
"descripcion": "ENSAMBLE"
}
]
}

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

</syntaxhighlight>

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


<Tab name = "API Consultar Ensambles(GET) ">

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/Ensamble/ConsultarOP?limite=10&pagina=1&idTipoDocumento=1&numeroDesde=1&numeroHasta=100&fechaDesde=2023-07-01&fechaHasta=2023-08-31&idArticulo=10&estado=1

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Requerido !! Descripción
|-
| Límite || NO || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || NO || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|-
| idTipoDocumento || SI || Id del tipo de documento (Api consulta tipos documento)
|-
| numeroDesde || NO || Numero inicial para filtrar por rango de numeros de documentos
|-
| numeroHasta || NO || Numero final para filtrar por rango de numeros de documentos
|-
| fechaDesde || SI || Fecha inicial para filtrar por rango de fecha del documento
|-
| fechaHasta || SI || Fecha final para filtrr por rango de fecha del documento
|-
| idArticulo || NO || Id del Articulo a filtrar
|-
| Estado || NO || 0=Pendiente, 2=Terminado
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"prefijo": "ENS",
"numeroDoc": 1,
"fecha": "2023-08-29",
"nitResponsable": "1234567890",
"responsable": "RESPONSABLE1",
"idArticulo": 744,
"descripcion": "ENSAMBLE1",
"cantidad": 5.00000,
"idCentroOperacion": 1,
"idBodega": 3,
"idProyecto": null,
"idCategoria": null,
"estado": "Pendiente",
"materiales": [
{
"tipo": "C",
"idArticulo": 155,
"descripcion": "ARTICULO1",
"cantidad": 2.39295,
"porcCostoDesensamble": null
},
{
"tipo": "C",
"idArticulo": 158,
"descripcion": "ARTICULO2",
"cantidad": 0.22725,
"porcCostoDesensamble": null
}
]
}
]
}

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

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| id || Int || Corresponde al id del registro de Ensamble
|-
| prefijo || String || Prefijo del tipo de documento
|-
| numeroDoc || Int || Numero del Ensamble
|-
| nitResponsable || String || Numero de indentificacion del responsable del Ensamble
|-
| responsable || String || Nombre del responsable del Ensamble
|-
| idArticulo || Int || Id del articulo de Ensamble
|-
| descripcion || String || Descripcion del Articulo
|-
| cantidad || Decimal || cantidad a producir
|-
| fecha || String || Fecha del Ensamble
|-
| idCentroOperacion || Int || Id del centro de operacion
|-
| idBodega || Int || Id de la bodega
|-
| idProyecto || Int || Id del proyecto
|-
| idActividad || Int || Id de la Actividad
|-
| estado || Int || 0=Pendiente, 1=Terminado
|-
| materiales || Array[ObjetoDetalle]* || Array de objetos de los materiales del Ensamble
|}

'''ObjetoDetalle'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| tipo || String || C=Componente, PT=Producto Terminado, PS=Producto Secundario
|-
| idArticulo || Int || Id del Articulo
|-
| descripcion || String || Descripcion del Articulo
|-
| cantidad || Decimal || Cantidad de los materiales
|-
| porcCostDesensamble || Decimal || Porcentaje destribucion de costos en desensambles
|}

</Tab>


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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"prefijo": "ENS",
"numeroDoc": 12580,
"fecha": "2023-08-31",
"nitResponsable": "1151940703",
"idArticulo": 744,
"cantidad": 5.00000,
"idCentroOperacion": 1,
"idBodega": 3,
"idBodegaMateriales": 3,
"idProyecto": null,
"idCategoria": null,
"materiales": [
{
"tipo": "C",
"idArticulo": 155,
"descripcion": "Material1",
"cantidad": 2.39295,
"porcCostoDesensamble": null
},
{
"tipo": "C",
"idArticulo": 158,
"descripcion": "Material2",
"cantidad": 0.22725,
"porcCostoDesensamble": null
}
]
}
]

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| prefijo || String || SI || Prefijo del tipo de documento
|-
| numeroDoc || Int || SI || Numero del Ensamble
|-
| nitResponsable || String || SI || Numero de identificacion del responsable del Ensamble
|-
| idArticulo || Int || SI || Id del Articulo del Ensamble
|-
| cantidad || Decimal || SI || Cantidad a producir
|-
| fecha || String || SI || Fecha del Ensamble
|-
| idCentroOperacion || Int || SI || Id del Centro de Operacion
|-
| idBodega || Int || SI || Id de la Bodega
|-
| idProyecto || Int || NO || Id del Proyecto
|-
| idActividad || Int || NO || Id de la Actividad
|-
| materiales || Array[ObjetoDetalle]* || || Array de objetos de los materiales del Ensamble
|}

'''ObjetoDetalle'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| tipo || String || SI || C=Componente, PT=Producto Terminado, PS=Producto Secundario
|-
| idArticulo || Int || SI || Id del Articulo
|-
| cantidad || Decimal || SI || Cantidad de los materiales
|-
| porcCostDesensamble || Decimal || NO || Porcentaje destribucion de costos en desensambles
|}

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

</syntaxhighlight>
</Tab>


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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Requerido !! Descripción
|-
| idOP || NO || id de la orden de produccion a eliminar
|)

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Se elimino correctamente la Orden de Produccion"
}

</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/Ensambles")
.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/Ensambles");
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/Ensambles');
$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 Ventas/Sucursales

2023-10-30T14:14:13Z

Nalzate:

'''Descripción:'''
Esta API permite la sincronizacion de sucursales 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 (GET) ">
'''GET/users'''

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

''' 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
"success": true,
"code": 200,
"errors": null,
"message": "x registro(s) encontrados",
"result": [
{
"id": 2317,
"id_tercero": 1804,
"nit_tercero": "900985549",
"codigo": 0,
"referencia_sucursal": "",
"descripcion": "PRUEBA",
"direccion": "cra 22 # 4-44",
"direccion2": "",
"telefono": "",
"telefono2": "",
"ext": null,
"ext2": null,
"movil": "",
"id_ciudad": 5001,
"codigo_ciudad": "05001",
"id_departamento": 5,
"codigo_departamento": "05",
"id_pais": 1,
"codigo_pais": "57",
"id_vendedor": 3418,
"id_cobrador": null,
"es_direccionCobro": false,
"es_direccionDespacho": false
},
]
}

{
"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 sucursal
|-
| id_tercero || int || Corresponde al identificador del tercero
|-
| nit_tercero || int || Nit del tercero
|-
| codigo || string || Codigo de la sucursal
|-
| referencia_sucursal || string || Referencia de la sucursal
|-
| descripcion || string || Descripcion de la sucursal
|-
| direccion || string || Direccion de la sucursal
|-
| direccion2 || string || Segunda direccion de la sucursal
|-
| telefono || int || Telefono correspondiente a la sucursal
|-
| telefono2 || int || Segundo telefono correspondiente a la sucursal
|-
| ext || int || Extension de la sucursal
|-
| ext2 || int || Extension de la sucursal
|-
| movil || int || Celular de la sucursal
|-
| id_ciudad || int || Identificador correspondiente a la ciudad de la sucursal
|-
| codigo_ciudad || string || Codigo de la ciudad de la sucursal
|-
| id_departamento || int || Identificador correspondiente al departamento de la sucursal
|-
| codigo_departamento || string || Codigo del departamento de la sucursal
|-
| id_pais || int || Identificador correspondiente al pais de la sucursal
|-
| codigo_pais || string || Codigo del pais de la sucursal
|-
| id_vendedor || int || Identificador correspondiente al vendedor de la sucursal
|-
| id_cobrador || int || Identificador correspondiente al cobrador de la sucursal
|-
| es_direccionCobro || bool || Valida si es direccion de cobro
|-
| es_direccionDespacho || bool || Valida si es direccion de despacho
|}
</Tab>


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

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

''' 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_tercero": 1804,
"nit_tercero": "900985549",
"codigo": 0,
"referencia_sucursal": null,
"descripcion": "PRUEBA",
"direccion": "cra 22 #4-44",
"direccion2": null,
"telefono": null,
"telefono2": null,
"ext": null,
"ext2": null,
"movil": null,
"id_ciudad": 5001,
"codigo_ciudad": "05001",
"id_departamento": 5,
"codigo_departamento": "05",
"id_pais": 1,
"codigo_pais": "57",
"id_vendedor": 3418,
"id_cobrador": null,
"es_direccionCobro": false,
"es_direccionDespacho": false
}

</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id_tercero || int || 50 || SI || Corresponde al identificador del tercero
|-
| nit_tercero || int || 50 || SI || Nit del tercero
|-
| codigo || string || 50 || SI || Codigo de la sucursal
|-
| referencia_sucursal || string || 50 || SI || Referencia de la sucursal
|-
| descripcion || string || 50 || SI || Descripcion de la sucursal
|-
| direccion || string || 50 || SI || Direccion de la sucursal
|-
| direccion2 || string || 50 || NO || Segunda direccion de la sucursal
|-
| telefono || int || 50 || SI || Telefono correspondiente a la sucursal
|-
| telefono2 || int || 50 || NO || Segundo telefono correspondiente a la sucursal
|-
| ext || int || 50 || NO || Extension de la sucursal
|-
| ext2 || int || 50 || NO || Extension de la sucursal
|-
| movil || int || 50 || NO || Celular de la sucursal
|-
| id_ciudad || int || 50 || SI || Identificador correspondiente a la ciudad de la sucursal
|-
| codigo_ciudad || string || 50 || SI || Codigo de la ciudad de la sucursal
|-
| id_departamento || int || 50 || SI || Identificador correspondiente al departamento de la sucursal
|-
| codigo_departamento || string || 50 || SI || Codigo del departamento de la sucursal
|-
| id_pais || int || 50 || SI || Identificador correspondiente al pais de la sucursal
|-
| codigo_pais || string || 50 || SI || Codigo del pais de la sucursal
|-
| id_vendedor || int || 50 || SI || Identificador correspondiente al vendedor de la sucursal
|-
| id_cobrador || int || 50 || NO || Identificador correspondiente al cobrador de la sucursal
|-
| es_direccionCobro || bool || X || SI || Valida si es direccion de cobro
|-
| es_direccionDespacho || bool || X || SI || Valida si es direccion de despacho
|}

'''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/Sucursales
''' 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": 2317,
"id_tercero": 1804,
"codigo": 0,
"referencia_sucursal": "",
"descripcion": "PRUEBA CAMBIO",
"direccion": "cra 22 #4-44",
"direccion2": "",
"telefono": "",
"telefono2": "",
"ext": null,
"ext2": null,
"movil": "",
"id_ciudad": 5001,
"id_departamento": 5,
"id_pais": 1,
"id_vendedor": 3418,
"id_cobrador": null,
"es_direccionCobro": false,
"es_direccionDespacho": false
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || Corresponde al identificador de la sucursal
|-
| id_tercero || int || 50 || SI || Corresponde al identificador del tercero
|-
| nit_tercero || int || 50 || SI || Nit del tercero
|-
| codigo || string || 50 || SI || Codigo de la sucursal
|-
| referencia_sucursal || string || 50 || SI || Referencia de la sucursal
|-
| descripcion || string || 50 || SI || Descripcion de la sucursal
|-
| direccion || string || 50 || SI || Direccion de la sucursal
|-
| direccion2 || string || 50 || NO || Segunda direccion de la sucursal
|-
| telefono || int || 50 || SI || Telefono correspondiente a la sucursal
|-
| telefono2 || int || 50 || NO || Segundo telefono correspondiente a la sucursal
|-
| ext || int || 50 || NO || Extension de la sucursal
|-
| ext2 || int || 50 || NO || Extension de la sucursal
|-
| movil || int || 50 || NO || Celular de la sucursal
|-
| id_ciudad || int || 50 || SI || Identificador correspondiente a la ciudad de la sucursal
|-
| codigo_ciudad || string || 50 || SI || Codigo de la ciudad de la sucursal
|-
| id_departamento || int || 50 || SI || Identificador correspondiente al departamento de la sucursal
|-
| codigo_departamento || string || 50 || SI || Codigo del departamento de la sucursal
|-
| id_pais || int || 50 || SI || Identificador correspondiente al pais de la sucursal
|-
| codigo_pais || string || 50 || SI || Codigo del pais de la sucursal
|-
| id_vendedor || int || 50 || SI || Identificador correspondiente al vendedor de la sucursal
|-
| id_cobrador || int || 50 || NO || Identificador correspondiente al cobrador de la sucursal
|-
| es_direccionCobro || bool || X || SI || Valida si es direccion de cobro
|-
| es_direccionDespacho || bool || X || SI || Valida si es direccion de despacho
|}

'''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ó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" 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/Sucursales")
.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/Sucursales"

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/Sucursales');
$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>

[[Category:Documentación APIs]]

API Pedido Rastreo

2023-10-30T14:13:21Z

Nalzate:

API Ventas/Factura Venta

2023-10-30T14:12:48Z

Nalzate:

'''Descripción:'''
Esta API permite la sincronización del agrupador definido como Factura Venta 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 Tipo de Documento(GET) ">

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "2 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "FV",
"prefijo": "FV",
"descripcion": "FACTURA VENTA"
}
]
}

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

</syntaxhighlight>

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


<Tab name = "API Consultar Facturas Venta (GET) ">

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! 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
|}

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

{| class="wikitable"
|+ Campos
|-
! Campo !! Tipo de dato !! Requerido !! Descripción
|-
| idTipoDocumento || int || SI || Id del tipo de documento (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
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"prefijo": "FV",
"numeroDoc": 1,
"fechaDocumento": "2023-05-02",
"fechaVencimiento": "2023-05-16",
"nitTerceroEnc": "123456789",
"nombreTerceroEnc": "LUIS LOPEZ",
"idSucursal": null,
"idCentroOperacion": 1,
"idBodega": 1,
"idProyecto": null,
"idCategoria": null,
"idListaPrecio": 2,
"nitVendedor": "999888777",
"nombreVendedor": "VENDEDOR1",
"numOrdenCompra": null,
"cufe": "23e2a330beffa134a059c75198e5eaaaa5d571f",
"detalles": [
{
"idArticulo": 108,
"descripcion": "ARTICULO1",
"cantidad": 2.00000,
"valorUnitario": 61200.00000,
"porcImpuesto": 19.00000,
"subtotal": 104040.00000,
"impuesto": 19767.60000,
"nitRecaudoTercero": null,
"nombreRecaudoTercero": null
},
{
"idArticulo": 1620,
"descripcion": "ARTICULO2",
"cantidad": 3.00000,
"valorUnitario": 25700.00000,
"porcImpuesto": 19.00000,
"subtotal": 65535.00000,
"impuesto": 12451.65000,
"nitRecaudoTercero": null,
"nombreRecaudoTercero": null
}
],
"formasPago": [
{
"idFormaPago": 2,
"valorPago": 77986.00000,
"fechaPago": "2023-07-31 12:50:22",
"codigoAutorizacion": null,
"codigoTransaccion": null
}
]
}
]
}

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

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| id || int || Corresponde al id del registro de la factura de venta
|-
| prefijo || string || Prefijo del tipo de documento
|-
| numeroDoc || Int || Numero de la Factura de Venta
|-
| nitTerceroEnc || string || Numero de identificación del tercero de la Factura de Venta
|-
| nombreTerceroEnc || string || Nombre del tercero de la Factura de Venta
|-
| fechaDocumento || string || Fecha de la Factura de Venta
|-
| fechaVencimiento || string || Fecha Vencimiento de la Factura de Venta
|-
| idSucursal || Int || Id de la sucursal del tercero de la Factura de Venta
|-
| idCentroOperacion || Int || Id del Centro de Operacion
|-
| idBodega || Int || Id de la bodega
|-
| idProyecto || Int || Id del proyecto
|-
| idActividad || Int || Id de la actividad
|-
| idListaPrecio || Int || Id de la Lista de Precios
|-
| nitVendedor || string || Numero de identificación del vendedor de la Factura de Venta
|-
| nombreVendedor || string || Nombre del vendedor de la Factura de Venta
|-
| numOrdenCompra || int || Numero de la Orden de Compra
|-
| Cufe || string || Codigo Cufe Facturacion Electronica
|-
| detalles || Array[ObjetoDetalle]* || Array de objetos de los detalles de la factura de venta
|}

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

'''ObjetoFormasPago'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| idFormaPago || Int || Id de la forma de pago
|-
| valorPago || Decimal || Valor del pago
|-
| fechaPago || string || Fecha del pago
|-
| codigoAutorizacion || string || Codigo de la autorizacion
|-
| codigoTrasaccion || string || Codigo de la transaccion
|}

</Tab>


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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"prefijo": "FV",
"numeroDoc": 9465,
"fechaDocumento": "2023-07-07",
"fechaVencimiento": "2023-07-07",
"nitTerceroEnc": "1234567890",
"nombreTerceroEnc": "CLIENTE PRUEBA",
"idSucursal": null,
"idCentroOperacion": 1,
"idBodega": 3,
"idProyecto": 321,
"idCategoria": null,
"idListaPrecio": 12,
"nitVendedor": "0987654321",
"nombreVendedor": "VENDEDOR PRUEBA",
"numOrdenCompra": "2450",
"retefuente": 140000.00000,
"reteica": 0.00000,
"reteiva": 0.00000,
"cufe": "vwd348uhgsnducbni2nv",
"detalles": [
{
"idArticulo": 13056,
"descripcion": "ARTICULO PRUEBA",
"cantidad": 2.00000,
"valorUnitario": 2800000.00000,
"porcdescuento": 0.00000,
"descuentovalor": 0.00000,
"porcImpuesto": 19.00000,
"subtotal": 5600000.00000,
"impuesto": 1064000.00000,
"nitRecaudoTercero": null,
"nombreRecaudoTercero": null
}
],
"formasPago": [
{
"idFormaPago": 2,
"valorPago": 77986.00000,
"fechaPago": null,
"codigoAutorizacion": null,
"codigoTransaccion": null
}
]
}
]

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| prefijo || string || SI || Prefijo del tipo de documento
|-
| numeroDoc || Int || SI || Numero de la Factura de Venta
|-
| nitTerceroEnc || string || SI || Numero de identificación del tercero de la Factura de Venta
|-
| fechaDocumento || string || SI || Fecha de la Factura de Venta
|-
| fechaVencimiento || string || SI || Fecha Vencimiento de la Factura de Venta
|-
| idSucursal || Int || NO || Id de la sucursal del tercero de la Factura de Venta
|-
| idCentroOperacion || Int || NO || Id del Centro de Operacion
|-
| idBodega || Int || SI || Id de la bodega
|-
| idProyecto || Int || NO || Id del proyecto
|-
| idActividad || Int || NO || Id de la actividad
|-
| idListaPrecio || Int || SI || Id de la Lista de Precios
|-
| nitVendedor || string || SI || Numero de identificación del vendedor de la Factura de Venta
|-
| numOrdenCompra || int || NO || Numero de la Orden de Compra
|-
| retefuente || Decimal || NO || Valor de la Retención en la fuente
|-
| reteica || Decimal || NO || Valor de la Retención de Ica
|-
| reteiva || Decimal || NO || Valor de la Retención de Iva
|-
| Cufe || string || NO || Codigo Cufe Facturacion Electronica
|-
| detalles || Array[ObjetoDetalle]* || || Array de objetos de los detalles de la factura de venta
|}

'''ObjetoDetalle'''

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

'''ObjetoFormasPago'''

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| idFormaPago || Int || SI || Id de la forma de pago
|-
| valorPago || decimal || SI || Valor de pago
|-
| fechaPago || string || NO || Fecha de pago
|-
| codigoAutorizacion || string || NO || Codigo de la autorizacion
|-
| codigoTrasaccion || string || NO || Codigo de la transaccion
|}

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

</syntaxhighlight>
</Tab>


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

{| 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">
{
"idTipoDocumento": 6,
"numeroDesde": 1,
"numeroHasta": 10000,
"fechaDesde": "2023-03-01",
"fechaHasta": "2023-03-31"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! 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
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Se eliminaron 1 de 1 Facturas de Venta"
}
</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/FacturaVenta")
.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/FacturaVenta");
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/FacturaVenta');
$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 Pedidos

2023-10-30T14:11:53Z

Nalzate:

'''Descripción:'''
Esta API permite la sincronización del agrupador definido como Pedido Venta 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 Tipo de Documento(GET) ">

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "2 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "PDV",
"prefijo": "PDV",
"descripcion": "PEDIDO VENTA"
}
]
}

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

</syntaxhighlight>

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


<Tab name = "API Consultar Pedidos Venta (GET) ">

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! 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
|}

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

{| class="wikitable"
|+ Campos
|-
! Campo !! Tipo de dato !! Requerido !! Descripción
|-
| idTipoDocumento || int || SI || Id del tipo de documento (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
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 2,
"prefijo": "PDV",
"numeroDoc": 2,
"fechaDocumento": "2018-04-18",
"nitTerceroEnc": "987654321",
"nombreTerceroEnc": "CLIENTE PRUEBA",
"nitVendedor": "1234567890",
"nombreVendedor": "VENDEDOR PRUEBA",
"idSucursal": null,
"idBodega": 3,
"idListaPrecio": 12,
"numOrdenCompra": null,
"comentario": null,
"retefuente": 0.00000,
"reteica": 0.00000,
"reteiva": 0.00000,
"total": 17326400.00000,
"detalles": [
{
"idArticulo": 1,
"descripcion": "ARTICULO1",
"cantidad": 10.00000,
"valorUnitario": 1456000.00000,
"porcdescuento": 0.00000,
"descuentovalor": 0.00000,
"porcImpuesto": 19.00000,
"subtotal": 14560000.00000,
"impuesto": 2766400.00000,
"factura": "FV-1",
"fechaFactura": "2023-07-11"
}
],
"formasPago": [
{
"idFormaPago": 2,
"valorPago": 17326400.00000,
"fechaPago": "2023-07-30 12:50:22",,
"codigoAutorizacion": null,
"codigoTransaccion": null
}
]
}
]
}

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

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| id || int || Corresponde al id del registro de la factura de venta
|-
| prefijo || string || Prefijo del tipo de documento
|-
| numeroDoc || int || Numero de la Factura de Venta
|-
| nitTerceroEnc || string || Numero de identificación del tercero de la Factura de Venta
|-
| nombreTerceroEnc || string || Nombre del tercero de la Factura de Venta
|-
| fechaDocumento || string || Fecha de la Factura de Venta
|-
| idSucursal || int || Id de la sucursal del tercero de la Factura de Venta
|-
| idBodega || int || Id de la bodega
|-
| idListaPrecio || int || Id de la Lista de Precios
|-
| nitVendedor || string || Numero de identificación del vendedor de la Factura de Venta
|-
| nombreVendedor || string || Nombre del vendedor de la Factura de Venta
|-
| numOrdenCompra || int || Numero de la Orden de Compra
|-
| comentario || string || Comentarios del pedido
|-
| retefuente || decimal || Valor de la Retención en la fuente
|-
| reteica || decimal || Valor de la Retención de Ica
|-
| reteiva || decimal || Valor de la Retención de Iva
|-
| detalles || Array[ObjetoDetalle]* || Array de objetos de los detalles del pedido de venta
|}

'''ObjetoDetalle'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| idDetalle || Int || Corresponde al id del detalle del pedido
|-
| idArticulo || Int || Id del Articulo
|-
| descripcion || string || Descripcion del Articulo
|-
| cantidad || decimal || Cantidad vendida
|-
| valorUnitario || decimal || Precio o Valor unitario de venta
|-
| porcdescuento || decimal || Porcentaje descuento
|-
| descuentovalor || decimal || Valor descuento
|-
| porcImpuesto || decimal || Porcentaje del impuesto
|-
| subtotal || decimal || Subtotal
|-
| impuesto || decimal || Valor Impuesto
|-
| factura || string || Número de Factura Venta asociada
|-
| fechaFactura || string || Fecha de la factura
|}

'''ObjetoFormasPago'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| idFormaPago || Int || Id de la forma de pago
|-
| valorPago || Decimal || Valor de pago
|-
| fechaPago || string || Fecha del pago
|-
| codigoAutorizacion || string || Codigo de la Autorizacion
|-
| codigoTrasaccion || string || Codigo de la transaccion
|}

</Tab>


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

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

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

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"prefijo": "PDV",
"numeroDoc": 1,
"fechaDocumento": "2023-07-14",
"nitTerceroEnc": "123456789",
"nitVendedor": "987654321",
"idSucursal": null,
"idBodega": 3,
"idListaPrecio": 12,
"numOrdenCompra": null,
"comentario": "prueba",
"detalles": [
{
"idArticulo": 1,
"cantidad": 1.00000,
"valorUnitario": 100000.00000,
"porcdescuento": 0.00000,
"descuentovalor": 0.00000,
"porcImpuesto": 19.00000,
"subtotal": 100000.00000,
"impuesto": 19000.00000,
}
],
"formasPago": [
{
"idFormaPago": 2,
"valorPago": 119000.00000,
"fechaPago": null,
"codigoAutorizacion": null,
"codigoTransaccion": null
}
]
}
]

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| prefijo || string || SI || Prefijo del tipo de documento
|-
| numeroDoc || Int || SI || Numero del Pedido de Venta
|-
| nitTerceroEnc || string || SI || Numero de identificación del tercero del Pedido de Venta
|-
| fechaDocumento || string || SI || Fecha del Pedido de Venta
|-
| idSucursal || Int || NO || Id de la sucursal del tercero del Pedido de Venta
|-
| idBodega || Int || SI || Id de la bodega
|-
| idListaPrecio || Int || SI || Id de la Lista de Precios
|-
| nitVendedor || string || SI || Numero de identificación del vendedor del Pedido de Venta
|-
| numOrdenCompra || int || NO || Numero de la Orden de Compra
|-
| Comentario || string || NO || Comentarios del pedido
|-
| detalles || Array[ObjetoDetalle]* || || Array de objetos de los detalles de la factura de venta
|}

'''ObjetoDetalle'''

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

'''ObjetoFormasPago'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| idFormaPago || Int || SI || Id de la forma de pago
|-
| valorPago || Decimal || SI || Valor de pago
|-
| fechaPago || string || NO || Fecha del pago
|-
| codigoAutorizacion || string || NO || Codigo de la Autorizacion
|-
| codigoTrasaccion || string || NO || Codigo de la transaccion
|}

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

</syntaxhighlight>
</Tab>


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

{| 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">
{
"idTipoDocumento": 6,
"numeroDesde": 1,
"numeroHasta": 100,
"fechaDesde": "2023-03-01",
"fechaHasta": "2023-03-31"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! 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
|}

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


<Tab name = "API Creacion Detalle(POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/PedidoVenta/CrearDetalle?idPedido=12

{| class="wikitable"
|+ Parametros
|-
! Parametro !! Requerido !! Descripcion
|-
| idPedido || SI || identificador del pedido al cual se le creara un detalle
|}

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

'''Body'''
<syntaxhighlight lang="JSON">
{
"idArticulo": 1,
"cantidad": 2.00000,
"valorUnitario": 1196000.00000,
"porcdescuento": 0.00000,
"descuentovalor": 0.00000,
"porcImpuesto": 19.00000,
"subtotal": 2392000.00000,
"impuesto": 454480.00000
}
</syntaxhighlight>

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

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


<Tab name = "API Eliminar Detalle(DELETE) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/PedidoVenta/EliminarDetalle?idDetallePedido=99

{| class="wikitable"
|+ Parametros
|-
! Parametro !! Requerido !! Descripcion
|-
| idDetallePedido || SI || identificador del detalle de un pedido de venta
|}

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

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

</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/PedidoVenta")
.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/PedidoVenta");
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/PedidoVenta');
$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/Impuestos

2023-10-30T14:11:19Z

Nalzate:

'''Descripción:'''
Esta API permite la sincronización del agrupador definido como Impuesto 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/Impuesto

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/Impuesto?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,
"descripcion": "IVA COMPRA 5%",
"valor": 5.00000,
"aplica": 1,
"_base": 0.00000,
"cuenta_impuesto": 2659,
"cuenta_impuesto_devolucion": 2659,
"cuenta_impuesto_bonificado": null
}
]
}

{
"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 del Impuesto
|-
| descripcion || string || Descripción de la Impuesto
|-
| valor || decimal || Descripción de la Impuesto
|-
| aplica || int || Descripción de la Impuesto
|-
| _base || decimal || Descripción de la Impuesto
|-
| cuenta_impuesto || int || Corresponde al identificador de la cuenta del impuesto
|-
| cuenta_impuesto_devolucion || int || Corresponde al identificador de la cuenta del impuesto descuento
|-
| cuenta_impuesto_bonificado || int || Corresponde al identificador de la cuenta del impuesto bonificado
|}
</Tab>


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

{| 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">
{
"descripcion": "pruebaDescuento",
"valor": 5.00000,
"aplica": 1,
"_base": 0.00000,
"cuenta_impuesto": 2659,
"cuenta_impuesto_devolucion": 2659,
"cuenta_impuesto_bonificado": 2659
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Requerido !! Descripción
|-
| descripcion || string || SI || Descripción de la Impuesto
|-
| valor || decimal || SI || Descripción de la Impuesto
|-
| aplica || int || SI || Descripción de la Impuesto
|-
| _base || decimal || SI || Descripción de la Impuesto
|-
| cuenta_impuesto || int || SI || Corresponde al identificador de la cuenta del impuesto
|-
| cuenta_impuesto_devolucion || int || NO || Corresponde al identificador de la cuenta del impuesto descuento
|-
| cuenta_impuesto_bonificado || int || NO || Corresponde al identificador de la cuenta del impuesto bonificado
|}

==== '''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/Impuesto

{| 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": 123,
"descripcion": "pruebanueva",
"valor": 5.00000,
"aplica": 1,
"_base": 0.00000,
"cuenta_impuesto": 2659,
"cuenta_impuesto_devolucion": 2659,
"cuenta_impuesto_bonificado": 2659
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Requerido !! Descripción
|-
| id || int || Si || Corresponde al identificador de la Impuesto
|-
| descripcion || string || SI || Descripción de la Impuesto
|-
| valor || decimal || SI || Descripción de la Impuesto
|-
| aplica || int || SI || Descripción de la Impuesto
|-
| _base || decimal || SI || Descripción de la Impuesto
|-
| cuenta_impuesto || int || SI || Corresponde al identificador de la cuenta del impuesto
|-
| cuenta_impuesto_devolucion || int || NO || Corresponde al identificador de la cuenta del impuesto descuento
|-
| cuenta_impuesto_bonificado || int || NO || Corresponde al identificador de la cuenta del impuesto bonificado
|}

==== '''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ó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/Impuesto")
.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/Impuesto");
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/Impuesto');
$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/Sucursales

2023-10-30T14:10:55Z

Nalzate:

'''Descripción:'''
Esta API permite la sincronizacion de sucursales 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 (GET) ">
'''GET/users'''

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

''' 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
"success": true,
"code": 200,
"errors": null,
"message": "x registro(s) encontrados",
"result": [
{
"id": 2317,
"id_tercero": 1804,
"nit_tercero": "900985549",
"codigo": 0,
"referencia_sucursal": "",
"descripcion": "PRUEBA",
"direccion": "cra 22 # 4-44",
"direccion2": "",
"telefono": "",
"telefono2": "",
"ext": null,
"ext2": null,
"movil": "",
"id_ciudad": 5001,
"codigo_ciudad": "05001",
"id_departamento": 5,
"codigo_departamento": "05",
"id_pais": 1,
"codigo_pais": "57",
"id_vendedor": 3418,
"id_cobrador": null,
"es_direccionCobro": false,
"es_direccionDespacho": false
},
]
}

{
"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 sucursal
|-
| id_tercero || int || Corresponde al identificador del tercero
|-
| nit_tercero || int || Nit del tercero
|-
| codigo || string || Codigo de la sucursal
|-
| referencia_sucursal || string || Referencia de la sucursal
|-
| descripcion || string || Descripcion de la sucursal
|-
| direccion || string || Direccion de la sucursal
|-
| direccion2 || string || Segunda direccion de la sucursal
|-
| telefono || int || Telefono correspondiente a la sucursal
|-
| telefono2 || int || Segundo telefono correspondiente a la sucursal
|-
| ext || int || Extension de la sucursal
|-
| ext2 || int || Extension de la sucursal
|-
| movil || int || Celular de la sucursal
|-
| id_ciudad || int || Identificador correspondiente a la ciudad de la sucursal
|-
| codigo_ciudad || string || Codigo de la ciudad de la sucursal
|-
| id_departamento || int || Identificador correspondiente al departamento de la sucursal
|-
| codigo_departamento || string || Codigo del departamento de la sucursal
|-
| id_pais || int || Identificador correspondiente al pais de la sucursal
|-
| codigo_pais || string || Codigo del pais de la sucursal
|-
| id_vendedor || int || Identificador correspondiente al vendedor de la sucursal
|-
| id_cobrador || int || Identificador correspondiente al cobrador de la sucursal
|-
| es_direccionCobro || bool || Valida si es direccion de cobro
|-
| es_direccionDespacho || bool || Valida si es direccion de despacho
|}
</Tab>


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

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

''' 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_tercero": 1804,
"nit_tercero": "900985549",
"codigo": 0,
"referencia_sucursal": null,
"descripcion": "PRUEBA",
"direccion": "cra 22 #4-44",
"direccion2": null,
"telefono": null,
"telefono2": null,
"ext": null,
"ext2": null,
"movil": null,
"id_ciudad": 5001,
"codigo_ciudad": "05001",
"id_departamento": 5,
"codigo_departamento": "05",
"id_pais": 1,
"codigo_pais": "57",
"id_vendedor": 3418,
"id_cobrador": null,
"es_direccionCobro": false,
"es_direccionDespacho": false
}

</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id_tercero || int || 50 || SI || Corresponde al identificador del tercero
|-
| nit_tercero || int || 50 || SI || Nit del tercero
|-
| codigo || string || 50 || SI || Codigo de la sucursal
|-
| referencia_sucursal || string || 50 || SI || Referencia de la sucursal
|-
| descripcion || string || 50 || SI || Descripcion de la sucursal
|-
| direccion || string || 50 || SI || Direccion de la sucursal
|-
| direccion2 || string || 50 || NO || Segunda direccion de la sucursal
|-
| telefono || int || 50 || SI || Telefono correspondiente a la sucursal
|-
| telefono2 || int || 50 || NO || Segundo telefono correspondiente a la sucursal
|-
| ext || int || 50 || NO || Extension de la sucursal
|-
| ext2 || int || 50 || NO || Extension de la sucursal
|-
| movil || int || 50 || NO || Celular de la sucursal
|-
| id_ciudad || int || 50 || SI || Identificador correspondiente a la ciudad de la sucursal
|-
| codigo_ciudad || string || 50 || SI || Codigo de la ciudad de la sucursal
|-
| id_departamento || int || 50 || SI || Identificador correspondiente al departamento de la sucursal
|-
| codigo_departamento || string || 50 || SI || Codigo del departamento de la sucursal
|-
| id_pais || int || 50 || SI || Identificador correspondiente al pais de la sucursal
|-
| codigo_pais || string || 50 || SI || Codigo del pais de la sucursal
|-
| id_vendedor || int || 50 || SI || Identificador correspondiente al vendedor de la sucursal
|-
| id_cobrador || int || 50 || NO || Identificador correspondiente al cobrador de la sucursal
|-
| es_direccionCobro || bool || X || SI || Valida si es direccion de cobro
|-
| es_direccionDespacho || bool || X || SI || Valida si es direccion de despacho
|}

'''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/Sucursales
''' 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": 2317,
"id_tercero": 1804,
"codigo": 0,
"referencia_sucursal": "",
"descripcion": "PRUEBA CAMBIO",
"direccion": "cra 22 #4-44",
"direccion2": "",
"telefono": "",
"telefono2": "",
"ext": null,
"ext2": null,
"movil": "",
"id_ciudad": 5001,
"id_departamento": 5,
"id_pais": 1,
"id_vendedor": 3418,
"id_cobrador": null,
"es_direccionCobro": false,
"es_direccionDespacho": false
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || Corresponde al identificador de la sucursal
|-
| id_tercero || int || 50 || SI || Corresponde al identificador del tercero
|-
| nit_tercero || int || 50 || SI || Nit del tercero
|-
| codigo || string || 50 || SI || Codigo de la sucursal
|-
| referencia_sucursal || string || 50 || SI || Referencia de la sucursal
|-
| descripcion || string || 50 || SI || Descripcion de la sucursal
|-
| direccion || string || 50 || SI || Direccion de la sucursal
|-
| direccion2 || string || 50 || NO || Segunda direccion de la sucursal
|-
| telefono || int || 50 || SI || Telefono correspondiente a la sucursal
|-
| telefono2 || int || 50 || NO || Segundo telefono correspondiente a la sucursal
|-
| ext || int || 50 || NO || Extension de la sucursal
|-
| ext2 || int || 50 || NO || Extension de la sucursal
|-
| movil || int || 50 || NO || Celular de la sucursal
|-
| id_ciudad || int || 50 || SI || Identificador correspondiente a la ciudad de la sucursal
|-
| codigo_ciudad || string || 50 || SI || Codigo de la ciudad de la sucursal
|-
| id_departamento || int || 50 || SI || Identificador correspondiente al departamento de la sucursal
|-
| codigo_departamento || string || 50 || SI || Codigo del departamento de la sucursal
|-
| id_pais || int || 50 || SI || Identificador correspondiente al pais de la sucursal
|-
| codigo_pais || string || 50 || SI || Codigo del pais de la sucursal
|-
| id_vendedor || int || 50 || SI || Identificador correspondiente al vendedor de la sucursal
|-
| id_cobrador || int || 50 || NO || Identificador correspondiente al cobrador de la sucursal
|-
| es_direccionCobro || bool || X || SI || Valida si es direccion de cobro
|-
| es_direccionDespacho || bool || X || SI || Valida si es direccion de despacho
|}

'''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ó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/Sucursales")
.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/Sucursales");
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/Sucursales');
$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-10-30T14:10:21Z

Nalzate:

'''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ó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" 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>

[[Category:Documentación APIs]]

API Inventarios/Factura Compra

2023-10-30T14:08:56Z

Nalzate:

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

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''

'''Tipos de peticiones:'''
GET

'''¿Cómo funciona?'''
*El consumo de esta API se realiza por método GET.
*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

== Métodos ==
<Tabs>

<Tab name = "API Consulta Tipos de Documento(GET)">

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "2 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "FC",
"prefijo": "FC",
"descripcion": "FACTURA COMPRA"
}
]
}

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

</syntaxhighlight>

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


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

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Requerido !! Descripción
|-
| Límite || NO || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || NO || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

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

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

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

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

</syntaxhighlight>

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

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

</Tab>


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

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

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

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

</syntaxhighlight>

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

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

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

</syntaxhighlight>
</Tab>


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

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

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

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

</syntaxhighlight>

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

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

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

== Có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/FacturaCompra")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/FacturaCompra");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/FacturaCompra');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Inventarios/Traslado Inventario

2023-10-30T14:08:28Z

Nalzate:

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

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''

'''Tipos de peticiones:'''
GET

'''¿Cómo funciona?'''
*El consumo de esta API se realiza por método GET.
*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

== Métodos ==
<Tabs>

<Tab name = "API Consulta Tipos de Documento(GET)">

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "TRI",
"prefijo": "TRI",
"descripcion": " TRASLADO DE INVENTARIO"
}
]
}

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

</syntaxhighlight>

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


<Tab name = "API Consultar Traslado de Inventario(GET) ">

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Requerido !! Descripción
|-
| Límite || NO || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || NO || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

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

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

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "TRI",
"prefijo": "TRI",
"numeroDoc": 1,
"nitTerceroEnc": "123456789",
"nombreTerceroEnc": "EMPRESA PRUEBA S.A.S.",
"fechaDocumento": "2023-06-01",
"idBodegaOrigen": 25,
"bodegaOrigen": "REGALOS",
"idBodegaDestino": 3,
"bodegaDestino": "PRINCIPAL",
"observacion": null,
"detalles": [
{
"idArticulo": 1,
"descripcion": "ARTICULO PRUEBA",
"cantidad": 3.00000,
"costo": 46060.06,
"comentarios": null
}
]
}
]
}

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

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| id || Int || Corresponde al id del registro
|-
| categoriaDocumento || String || Categoria del tipo de documento
|-
| prefijo || String || Prefijo del tipo de documento
|-
| numeroDoc || Int || Numero del traslado de inventario
|-
| nitTerceroEnc || String || Numero de identificador del tercero del traslado de inventario
|-
| nombreTerceroEnc || String || Nombre del tercero
|-
| fechaDocumento || String || Fecha del traslado
|-
| idBodegaOrigen || int || Id de la bodega origen
|-
| bodegaOrigen || String || Nombre de la bodega origen
|-
| idBodegaDestino || Int || Id de la bodega destino
|-
| bodegaDestino || String || Nombre de la bodega destino
|-
| observaciones || String || Observaciones
|-
| detalles || Array[ObjetoDetalle*] || Array de objetos de los detalles del traslado de inventario
|}

'''ObjetoDetalle'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| idArticulo || Int || Id del Articulo
|-
| descripcion || String || Descripcion del Articulo
|-
| cantidad || Decimal || Cantidad a trasladar
|-
| costo || Decimal || Costo articulo
|-
| comentarios || String || Comentarios del movimiento
|}

</Tab>


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

{| 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">
[
{
"categoriaDocumento": "TRI",
"prefijo": "TRASL",
"numeroDoc": 1,
"nitTerceroEnc": "1234567890",
"fechaDocumento": "2023-09-12",
"idBodegaOrigen": 3,
"idBodegaDestino": 20,
"observacion": "",
"detalles": [
{
"idArticulo": 95,
"cantidad": 1.00000,
"costo": 6500
},
{
"idArticulo": 21,
"cantidad": 1.00000,
"costo": 5500
}
]
}
]

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| categoriaDocumento || String || SI || Categoria del tipo de documento
|-
| prefijo || String || SI || Prefijo del tipo de documento
|-
| numeroDoc || Int || SI || Numero de traslado
|-
| nitTerceroEnc || Int || SI || Nit del tercero del traslado
|-
| fechaDocumento || String || SI || Fecha del traslado
|-
| idBodegaOrigen || Int || SI || Id de la bodega origen
|-
| idBodegaDestino || Int || SI || Id de la bodega destino
|-
| observaciones || String || SI || Observaciones del traslado
|-
| detalles || Array[ObjetoDetalle]* || SI || Array de objetos de los detalles del Traslado
|}

'''ObjetoDetalle'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| idArticulo || Int || SI || Id del Articulo a ajustar
|-
| cantidad || Decimal || SI || Cantidad a trasladar
|-
| costo || Decimal || SI || Costo del articulo
|}

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

</syntaxhighlight>
</Tab>


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

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

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

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

</syntaxhighlight>

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

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

</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/TrasladoInventario")
.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/TrasladoInventario");
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/TrasladoInventario');
$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 Ventas/Bodegas

2023-10-30T14:08:00Z

Nalzate:

'''Descripción:'''
Esta API permite la sincronizacion de Bodegas 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 (GET) ">
'''GET/users'''

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

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Bodega?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": 1,
"abreviatura": "1",
"descripcion": "BODEGA PRINCIPAL",
"tipo_Bodega": "PRINCIPAL",
"id_Centro_Operacion": 1,
"id_Centro_Costo": 1,
"id_Subcentro_Costo": 4
}
]
}

{
"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 Bodega
|-
| abreviatura || string || Abreviatura de la Bodega
|-
| descripcion || string || Descripcion de la Bodega
|-
| tipo_Bodega || string || Tipo de la Bodega
|-
| id_Centro_Operacion || int || identificador del centro de operacion
|-
| id_Centro_Costo || int || identificador del centro de costo
|-
| id_Subcentro_Costo || int || identificador del subcentro de costo
|}
</Tab>


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

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

''' 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">
{
"abreviatura": "326",
"descripcion": "BODEGA EJEMPLO",
"tipo_Bodega": "PRINCIPAL",
"id_Centro_Operacion": 1,
"id_Centro_Costo": 1,
"id_Subcentro_Costo": 4
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| abreviatura || string || 50 || SI || Abreviatura de la Bodega
|-
| descripcion || string || 50 || SI || Descripcion de la Bodega
|-
| tipo_Bodega || string || 50 || SI || identificador del tipo de bodega
|-
| id_Centro_Operacion || int || 50 || SI || Identificador del centro de operacion
|-
| id_Centro_Costo || int || 50 || SI || identificador del centro de costo
|-
| id_Subcentro_Costo || int || 50 || SI || identificador del subcentro de costo
|}

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

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

''' 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": 7,
"abreviatura": "999",
"descripcion": "BODEGA CAMBIO",
"tipo_Bodega": "PRINCIPAL",
"id_Centro_Operacion": 1,
"id_Centro_Costo": 1,
"id_Subcentro_Costo": 4
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || Corresponde al identificador de la Bodega
|-
| abreviatura || string || 50 || SI || Abreviatura de la Bodega
|-
| descripcion || string || 50 || SI || Descripcion de la Bodega
|-
| tipo_Bodega || string || 50 || SI || identificador del tipo de bodega
|-
| id_Centro_Operacion || int || 50 || SI || Identificador del centro de operacion
|-
| id_Centro_Costo || int || 50 || SI || identificador del centro de costo
|-
| id_Subcentro_Costo || int || 50 || SI || identificador del subcentro de costo
|}

'''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 id 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ó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/Bodega")
.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/Bodega");
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/Bodega');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Inventarios/Ajuste Inventario

2023-10-30T14:07:23Z

Nalzate:

'''Descripción:'''
Esta API permite la sincronizacion de ajuste de inventarios 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 Consultar Tipo de Documento(GET)">
'''GET/users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/AjusteInventario/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": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "AI",
"prefijo": "AI",
"descripcion": " AJUSTE DE INVENTARIO"
}
]
}

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

</syntaxhighlight>

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

<Tab name = "API Consultar Tipos de Ajuste(GET)">
'''GET/users'''

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

''' 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": "1 registro(s) encontrados",
"result": [
{
"idTipoAjuste": 2,
"abreviatura": "AJ",
"descripcion": "AJUSTE INVENTARIO",
"cuenta": "61350601 - VENTA DE PARTES"
}
]
}

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

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo !! Descripción
|-
| idTipoAjuste || int || Corresponde al identificador del tipo de ajuste
|-
| abreviatura || string || Abreviatura del tipo de ajuste
|-
| descripcion || string || Descripcion del tipo de ajuste
|-
| cuenta || string || Cuenta contable asociada al tipo de ajuste
|}

</Tab>

<Tab name = "API Consultar Ajuste Inventarios(GET)">
'''GET/users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/AjusteInventario/Consultar?limite=10&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>

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

'''Campos'''
{| 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 || Número inicial para filtrar por rango de números de documentos
|-
| numeroHasta || int || NO || Número 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": 482,
"categoriaDocumento": "AI",
"prefijo": "AI",
"numeroDoc": 474,
"nitTerceroEnc": "123456789",
"nombreTerceroEnc": "SERPI",
"fechaDocumento": "2023-01-17",
"comentario": "SOBRANTES Y FALTANTANTES A DIC 31 DE 2022",
"detalles": [
{
"idArticulo": 1,
"descripcion": "ARTICULO1",
"idBodega": 1,
"bodega": "BODEGA PRINCIPAL",
"tipoMovimiento": "E",
"saldo": 1.00000,
"costo": 15673.86601,
"observacion": "SOBRANTE EN CONTEO FISICO"
},
{
"idArticulo": 2,
"descripcion": "ARTICULO2",
"idBodega": 1,
"bodega": "BODEGA PRINCIPAL",
"tipoMovimiento": "S",
"saldo": 1.00000,
"costo": 4868.30944,
"observacion": "FALTANTE DE MCIA."
}
]
}
]
}

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

</syntaxhighlight>

'''Campos Resultado'''
{| class="wikitable"
! Campo !! Tipo !! 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
|-
| comentario || string || Comentarios
|-
| detalles || Array[ObjetoDetalle]* || Array de objetos de los detalles del ajuste de inventario
|}

'''Objeto Detalle'''
{| class="wikitable"
! Campo !! Tipo !! Descripción
|-
| idArticulo || Int || Id del artículo
|-
| Descripcion || string || Descripción del artículo
|-
| idBodega || Int || Id de la bodega
|-
| Bodega || string || Nombre de la bodega
|-
| tipoMovimiento || string || E=Entrada, S=Salida
|-
| saldo || decimal || Cantidad ajuste
|-
| Costo || decimal || Costo ajuste
|-
| Observación || string || Observaciones del movimiento
|}

</Tab>


<Tab name = "API Crear(POST)">
'''POST/users'''

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

''' 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": "AI",
"prefijo": "AI",
"fechaCorte": "2023-03-01",
"idTipoAjuste": 2,
"comentario": "Ajuste",
"detalles": [
{
"idArticulo": 1,
"idBodega": 1,
"observaciones": "Ajuste Articulo",
"saldo": 100.00
},
{
"idArticulo": 2,
"idBodega": 1,
"observaciones": "Ajuste Articulo",
"saldo": 50.00
},
{
"idArticulo": 3,
"idBodega": 1,
"observaciones": "Ajuste Articulo",
"saldo": 60.00
}
]
}
]

</syntaxhighlight>

'''Campos'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| categoriaDocumento || string || SI || Categoría del tipo de documento
|-
| prefijo || string || SI || Prefijo del tipo de documento
|-
| fechaCorte || string || SI || Fecha corte para creación del ajuste y para la consulta del saldo de unidades
|-
| idTipoAjuste || int || NO || Id del tipo de ajuste
|-
| comentario || string || SI || Comentarios
|-
| detalles || Array[ObjetoDetalle]* || SI || Array de objetos de los detalles del Ajuste
|}

'''ObjetoDetalle*'''
{| class="wikitable"
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| idArticulo || Int || SI || Id del artículo a ajustar
|-
| IdBodega || string || SI || Id de la bodega
|-
| observaciones || string || NO || Observaciones del ajuste
|-
| saldo || decimal || SI || Saldo real en bodega del artículo a ajustar
|}

'''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 3 de 3 ajustes de inventario"
}
</syntaxhighlight>
</Tab>

<Tab name = "API Eliminar(DELETE)">
'''DELETE/users'''

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

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

</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/AjusteInventario")
.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/AjusteInventario");
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/AjusteInventario');
$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-10-30T14:06:10Z

Nalzate:

'''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"
},
]

}

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

{
"success": false,
"code": 400,
"errors": [
"El codigo 44 ya existe"
],
"message": "Se presentaron errores al crear el registro"
}

</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"
}
{
"success": false,
"code": 400,
"errors": [
"La codigo 44 ya esta asociado al id 2"
],
"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" 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>

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

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

</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Articulos/Lineas

2023-10-30T14:05:17Z

Nalzate:

'''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",
"facturable": true,
"factura_negativo": true,
"trasladar_negativo": false,
"porcentaje_comision": "0.000"
}
]
}

{
"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
|-
| facturable || bool || Activo=1, Inactivo=0
|-
| factura_negativo || bool || Facturar linea en negativo
|-
| porcentaje_comision || decimal || Porcentaje de la comision de la linea
|-
| trasladar_negativo || bool || trasladar en negativo (SI=1, NO=0)
|}
</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": "1",
"descripcion": "PRODUCTOS NO FABRICADOS",
"facturable": true,
"factura_negativo": true,
"porcentaje_comision": "0.000",
"trasladar_negativo": false,
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Requerido !! Descripción
|-
| codigo || string || Si || Código
|-
| descripcion || string || Si || Descripción de la linea
|-
| facturable || bool || SI || Activo=1, Inactivo=0
|-
| factura_negativo || bool || SI || Facturar linea en negativo
|-
| porcentaje_comision || decimal || NO || Porcentaje de la comision de la linea
|-
| trasladar_negativo || bool || SI || trasladar en negativo (SI=, NO=0)
|}

==== '''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": "21",
"codigo": "1",
"descripcion": "PRODUCTOS NO FABRICADOS",
"facturable": true,
"factura_negativo": true,
"porcentaje_comision": "0.000",
"trasladar_negativo": false,
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Requerido !! Descripción
|-
| id || int || Si || Corresponde al identificador de la linea
|-
| codigo || string || Si || Código
|-
| descripcion || string || Si || Descripción de la linea
|-
| facturable || bool || SI || Activo=1, Inactivo=0
|-
| factura_negativo || bool || SI || Facturar linea en negativo
|-
| porcentaje_comision || decimal || NO || Porcentaje de la comision de la linea
|-
| trasladar_negativo || bool || SI || trasladar en negativo (SI=1, NO=0)
|}

==== '''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ó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/Linea")
.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/Linea");
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/Linea');
$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/Tipo Cuenta

2023-10-30T14:04:08Z

Nalzate:

'''Descripción:'''
Esta API permite gestionar los tipos de cuenta registrados en SERPI hacia la plataforma que lo requiera permitiendo tener un manejo estandar 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, 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/TipoCuenta

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/TipoCuenta?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": 1,
"codigo": "A",
"descripcion": "Cuenta de Ahorros",
"abreviatura": "37"
}
]
}

{
"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 cuenta
|-
| codigo || string || Codigo Tipo de cuenta
|-
| descripcion || string || Descripción tipo de cuenta
|-
| abreviatura || string || abreviatura del tipo de cuenta
|}
</Tab>


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

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

''' 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": "BE",
"descripcion": "Cuenta Corriente",
"abreviatura": "344"
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo || string || 50 || SI || Codigo Tipo de cuenta
|-
| descripcion|| string || 50 || SI || Descripcion tipo de cuenta
|-
| abreviatura || string || 50 || SI || Abreviatura del tipo de cuenta
|}

'''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": "x registro(s) encontrados",
"result": [
{
"codigo": "BE",
"descripcion": "Cuenta Corriente",
"abreviatura": "344"
}
]
}

{
"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/TipoCuenta

''' 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": "BE",
"descripcion": "Cuenta Corriente",
"abreviatura": "344"
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo || string || 50 || SI || Codigo Tipo de Cuenta
|-
| descripcion|| string || 50 || SI || Descripcion tipo de Cuenta
|-
| abreviatura || string || 50 || SI || Abreviatura del tipo de Cuenta
|}

'''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ó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/TipoCuenta")
.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/TipoCuenta");
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/TipoCuenta');
$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/Bancos

2023-10-30T14:03:25Z

Nalzate:

'''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ó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/Banco")
.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/Banco");
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/Banco');
$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/Forma Pago

2023-10-30T14:01:55Z

Nalzate:

'''Descripción:'''
Esta API permite la sincronizacion de Formas de pago para los procesos de ventas 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, 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/FormaPago

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/FormaPago?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": 1,
"cuenta": 15120501,
"descripcion_cuenta": "MAQUINARIA Y EQUIPO",
"descripcion_fomapago": "PRUEBAS D",
"tipo": "PRUEBAS T",
"aplicafactura": false,
"aplicapuntopago": false,
"tercuenta": false,
"id_formapago_categoria": 1,
"categoria": "CR",
"descripcion_formapago_categoria": "CREDITO",
"escontraentrega": true
}
]
}

{
"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 identidad
|-
| auxiliar|| int|| Corresponde al código de la cuenta
|-
| descripcion_cuenta|| string || Descripción tipo de cuenta.
|-
| descripcion_fomapago|| string || Descripción de la forma de pago
|-
| tipo|| string || Descripción del tipo de cuenta o acrónimo de la cuenta
|-
| aplicafactura|| bool|| true o false. Si aplica factura
|-
| aplicapuntopago|| bool || true o false. Si el aplica punto de pago
|-
| tercuenta|| bool || true o false. Si el aplica cuenta tercero
|-
| id_formapago_categoria || int || Corresponde al identificador de la categoría forma de pago
|-
| categoria|| string || Abreviatura3 Categoria forma pago
|-
| descripcion_formapago_categoria|| string || Descripción de la categoría forma de pago
|-
| escontraentrega || bool || true o false. Si es contraentrega
|}
</Tab>


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

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

''' 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_formapago_categoria" : 4,
"tipo": "p false",
"descripcion_fomapago": "forma false",
"tercuenta": true,
"cuenta": 11050501,
"aplicafactura": true,
"aplicapuntopago": true,
"escontraentrega": true
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| gdtformapagocatid || int || 11 || SI || Identificador único del tipo de categoría para la forma de pago , si es crédito , debito ,contado
|-
| tipo || string || 100 || SI || tipo de forma de pago como CO. DE, CR
|-
| descripcion_fomapago || string || 50 || SI || Descripción del tipo de forma de pago
|-
| tercuenta || bool || 1 || SI || true o false. toma la Cuenta por Cobrar, Tomarla del Tercero y al numero auxiliar
|-
| auxiliar || string || 15 || NO || Código auxilita de la cuenta, hace referencia a tercuenta según su estado true o false
|-
| aplicafactura || bool || 1 || NO || true o false. si aplica factura
|-
| aplicapuntopago || bool || 1 || NO || true o false. si aplica punto pago
|-
| escontraentrega || bool || 1 || NO || true o false. Si es contraentrega
|}

'''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": false,
"code": 400,
"errors": [
"La cuenta 110505019 no existe"
],
"message": "Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


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

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

''' 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": 39,
"descripcion_fomapago": "PRUEBAS",
"tipo": "PR",
"tercuenta": false,
"auxiliar": 11050501,
"aplicafactura": false,
"aplicapuntopago": true,
"gdtformapagocatid": 1,
"escontraentrega": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || Corresponde al identificador de la forma de pago
|-
| descripcion_fomapago|| string || 50 || SI || Descripción del tipo de forma de pago
|-
| tipo|| string || 50 || SI || Descripcion tipo de forma pago
|-
| tercuenta || bool || 1 || NO || true o false. toma la Cuenta por Cobrar, Tomarla del Tercero y al numero auxiliar
|-
| auxiliar|| string || 50 || NO || Código auxilita de la cuenta, hace referencia a tercuenta según su estado true o false
|-
| aplicafactura|| string || 50 || NO || true o false. si aplica factura
|-
| aplicapuntopago|| bool || 50 || NO || true o false. si aplica punto pago
|-
| gdtformapagocatid|| int || 50 || SI || Identificador único del tipo de categoría para la forma de pago , si es crédito , debito ,contado
|-
| escontraentrega || bool || 1 || NO || true o false. Si es contraentrega
|}

'''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 descripcion_fomapago 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ó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" 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>

[[Category:Documentación APIs]]

API Terceros/Categoria Terceros

2023-10-30T14:00:51Z

Nalzate:

'''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) ">
'''GET/users'''

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

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/CategoriaTercero?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": 1,
"descripcion": "TERCEROS",
"cxc_cliente": 13050501,
"descripcion_cxc_cliente": "CLIENTES INSTITUCIONALES",
"cxc_proveedor": 22050501,
"descripcion_cxc_proveedor": "PROVEEDORES NACIONALES"

}
]
}

{
"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 la categoría tercero
|-
| Descripcion || string || Describe la categoría.
|-
| cxc_cliente|| int || Corresponde al código de la cuenta
|-
| cxc_proveedor|| string || Corresponde al código de la cuenta

|}
</Tab>


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

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

''' 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">
{
"descripcion": "TERCERO EXTERIOR 100",
"cxc_cliente": 11050501,
"cxc_proveedor": 22100101

}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| descripcion || string || 100 || SI || Describe la categoría del tercero
|-
| cxc_cliente || int || 20 || SI || Cuenta Por Cobrar Cliente
|-
| cxc_proveedor|| int || 20 || SI || Cuenta Por Pagar Proveedor
|}

'''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": false,
"code": 400,
"errors": [
"El campo descripcion es obligatorio",
"El campo cxc_cliente 1105050 no existe",
"El campo cxc_proveedor 2210010 no existe"
],
"message": "Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


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

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

''' 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
"descripcion": "categoria terceros ",
"cxc_cliente": 11050501,
"cxc_proveedor": 11050501

}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || SI || Hace referencia al id que vamos a hacer la edición
|-
| descripcion|| string || 50 || SI || Describe la categoría del tercero
|-
| cxc_cliente|| int || 20 || SI || Cuenta Por Cobrar Cliente
|-
| cxc_proveedor|| int|| 20 || SI || Cuenta Por Pagar Proveedor
|}

'''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": "registro modificado exitosamente"
}

{
"success": false,
"code": 400,
"errors": [
"El campo descripcion es obligatorio",
"El campo cxc_cliente 110505019 no existe",
"El campo cxc_proveedor 110505019 no existe"
],
"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ó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/CategoriaTercero")
.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/CategoriaTercero");
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/CategoriaTercero');
$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>

''' Observaciones '''
{| class="wikitable left"
! Campos !! Descripción
|-
| cxc_cliente || Cuenta Por Cobrar Cliente ,se bebe enviar el numero de la cuenta como, 11050501
|-
| cxc_proveedor || Cuenta Por Pagar Proveedor ,se bebe enviar el numero de la cuenta como ,11050200
|-
| id || NO se debe enviar el numero identificador de la cuenta.
|}

[[Category:Documentación APIs]]

API Terceros/Zonas

2023-10-30T13:59:35Z

Nalzate:

'''Descripción:'''
Esta API permite sincronizar los códigos de zonas definidas en SERPI con el fin de agrupar clientes.

'''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:'''
Permite el manejo estándar de códigos de zonas entre SERPI y la plataforma integrada.

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

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Zona?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": 2,
"abreviatura": "2",
"descripcion": "BOGOTA",
"id_vendedor": "3173988",
"descripcion_vendedor": "DESCRIPCIÓN DEL VENDEDOR",
"id_cobrador": "3173988",
"descripcion_cobrador": "DESCRIPCIÓN DEL COBRADOR"
}
]
}

{
"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 zona
|-
| abreviatura || string || Abreviatura de Zona
|-
| descripcion || string || Descripción Zona
|-
| vendedorid || int || Corresponde al identificador del vendedor
|-
| descripcion_vendedor || string || Descripción del vendedor
|-
| cobradorid || int || Corresponde al identificador del cobrador
|-
| descripcion_cobrador || string || Descripción del cobrador
|}
</Tab>


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

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

''' 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": 2,
"abreviatura": "2",
"descripcion": "BOGOTA",
"id_vendedor": "3173988",
"id_cobrador": "3173988"
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| abreviatura || string || 50 || SI || Abreviatura Zona
|-
| descripcion|| string || 50 || SI || Descripcion tipo de Zona
|-
| vendedorid || int || 50 || SI || identificador del vendedor
|-
| cobradorid || int || 50 || SI || identificador del cobrador
|}

'''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": "x registro(s) encontrados",
"result": [
{
"id": 2,
"abreviatura": "2",
"descripcion": "BOGOTA",
"id_vendedor": "3173988",
"id_cobrador": "3173988"
}
]
}

{
"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/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": 2,
"abreviatura": "2",
"descripcion": "BOGOTA",
"id_vendedor": "3173988",
"id_cobrador": "3173988"
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| abreviatura || string || 50 || SI || Abreviatura de Zona
|-
| descripcion|| string || 50 || SI || Descripcion de Zona
|-
| vendedorid || int || 50 || SI || Identificador del vendedor
|-
| cobradorid || int || 50 || SI || Identificador del cobrador
|}

'''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ó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/Zona")
.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/Zona");
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/Zona');
$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/Ciudades

2023-10-30T13:59:07Z

Nalzate:

'''Descripción:'''
Esta API permite la sincronizacion de ciudades 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 (GET) ">
'''GET/users'''

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

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Ciudad?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": 5001,
"ciudad": "MEDELLÍN",
"codigo": "05001",
"codigo_postal": null,
"id_departamento": 5
}
]
}

{
"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 Ciudad
|-
| ciudad || string || Nombre de ciudad
|-
| codigo || string || Codigo de ciudad
|-
| codigo_postal || int || Código postal de ciudad
|-
| id_departamento || int || identificador del departamento correspondiente
|}
</Tab>


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

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

''' 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">
{
"ciudad": "MEDELLÍN",
"codigo": "05001",
"codigo_postal": null,
"id_departamento": 5
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| ciudad || string || 50 || SI || Nombre de ciudad
|-
| codigo || string || 50 || SI || codigo de ciudad
|-
| codigo_postal || int || 50 || NO || Codigo postal de ciudad
|-
| id_departamento|| int || 50 || SI || identificador del departamento 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": 200,
"message": "x registro(s) encontrados",
"result": [
{
"id": 5001,
"ciudad": "MEDELLÍN",
"codigo": "05001",
"codigo_postal": null,
"id_departamento": 5
}
]
}

{
"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/Ciudad

''' 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": 5001,
"ciudad": "MEDELLÍN",
"codigo": "05001",
"codigo_postal": null,
"id_departamento": 5
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || identificador de ciudad
|-
| ciudad || string || 50 || SI || Nombre de ciudad
|-
| codigo || string || 50 || SI || codigo de ciudad
|-
| codigo_postal || int || 50 || SI || Codigo postal de ciudad
|-
| id_departamento || int || 50 || NO || identificador del departamento 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": 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ó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/Ciudad")
.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/Ciudad");
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/Ciudad');
$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

2023-10-30T13:58:09Z

Nalzate:

'''Descripción:'''
Este conjunto de APIs esta dispuesto con el fin de consultar, agregar y modificar los datos correspondientes a terceros en SERPI, como terceros se consideran diferentes actores del procesos como clientes, empleados, vendedores, proveedores y otros.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''
Este API permite tener sincronizada la información concerniente a terceros de su plataforma y SERPI .

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

'''¿Cómo funciona?'''
*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

== Métodos ==
<Tabs>

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

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

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/Tercero?limite=50&pagina=1&identificacion=123456789&fechaCreadoDesde=2020-01-01%2000:00:00&fechaCreadoHasta=2020-12-31%2023:59:59

''' Headers '''
{| 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,
"camposPersonalizados": {
"ACTIVIDADECONOMICAMUNICIPAL": "BC44",
"Comentarios": "Cliente proveedor de software",
"Comuna": 11,
"FechaAniversario": "2016-06-01",
"ClienteNacional": true,
"Ranking": "2",
"TieneAsesor": "N",
"Vetado": "3",
"TipodeEmpresa": [
"b",
"c"
],
"continente": ""
}

]
}

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

{
"success": false,
"code": 400,
"message": "El formato de las fechas es invalido. Ejemplo 2023-01-20 00:00:00",
}

</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
|-
| camposPersonalizados || Objeto || Objeto con la informacion de campos personalizados
|}
</Tab>


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

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

''' Headers '''
{| 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,
"camposPersonalizados": {
"ACTIVIDADECONOMICAMUNICIPAL": "BC44",
"Comentarios": "Cliente proveedor de software",
"Comuna": 11,
"FechaAniversario": "2016-06-01",
"ClienteNacional": true,
"Ranking": "2",
"TieneAsesor": "N",
"Vetado": "3",
"TipodeEmpresa": [
"b",
"c"
],
"continente": ""
}

}

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

''' 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,
"tipoidentidad": "CC",
"identificacion": "123456789",
"dv": 0,
"tipopersona": 2,
"primernombre": "PEDRO",
"segundonombre": "LUIS",
"primerapellido": "PEREZ",
"segundoapellido": "LOPEZ",
"nombrecompleto": "PEDRO LUIS PEREZ LOPEZ",
"razonsocial": null,
"escliente": true,
"esproveedor": true,
"esempleado": false,
"esvendedor": false,
"esotro": false,
"escobrador": false,
"cumple_dia": 0,
"cumplea_mes": 0,
"cumplea_ano": 0,
"genero": "N",
"direccion": "CRA 1 25 05",
"direccion2": null,
"telefono": null,
"ext": 0,
"movil": null,
"pais": "COLOMBIA",
"departamento": "VALLE",
"ciudad": "SANTIAGO DE CALI",
"codciudad": "76001",
"zona": 0,
"email": "prueba@mail.com",
"activo": true,
"cupocredito": 0.00,
"periodopago": 0,
"codigociiu": null,
"descuentoventa": 0,
"categoriatercero": 1,
"formapago": 0,
"listaprecios": 2,
"grupoventas": 1,
"grupocompras": 2,
"vendedor": 0,
"cobrador": 0,
"fechacreacion": "2020-01-04 10:16:30",
"regimen": 2,
"banco": 0,
"tipo_cuenta": null,
"cuenta_bancaria": null,
"limite_credito": 0.00000,
"camposPersonalizados": {
"ACTIVIDADECONOMICAMUNICIPAL": "BC44",
"Comentarios": "Cliente proveedor de software",
"Comuna": 11,
"FechaAniversario": "2016-06-01",
"ClienteNacional": true,
"Ranking": "2",
"TieneAsesor": "N",
"Vetado": "3",
"TipodeEmpresa": [
"b",
"c"
],
"continente": ""
}
}
]

</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo !! Longitud !! Requerido !! Descripción
|-
| tipoidentidad || String || 50 || SI || Código del tipo de identidad
|-
| identificacion || String || 50 || SI || Número de identificación
|-
| dv || Int || 50 || SI || Digito de verificación
|-
| tipopersona || 50 || Int || SI || Código del tipo de persona (1=JURIDICO, 2=NATURAL)
|-
| primernombre || String || 50 || SI (Si tipo persona=NATURAL) || Primer Nombre
|-
| segundonombre || String || 50 || NO || Segundo Nombre
|-
| primerapellido || String || 50 || SI (Si tipo persona=NATURAL) || Primer Apellido
|-
| segundoapellido || String || 50 || NO || Segundo Apellido
|-
| nombrecompleto || String || 50 || SI || Nombre Completo
|-
| razonsocial || String || 50 || SI (Si tipo persona=JURIDICO) || Razón Social
|-
| escliente || Bool || 50 || NO || Seleccionar si el tercero es cliente
|-
| esproveedor || Bool || 50 || NO || Seleccionar si el tercero es proveedor
|-
| esempleado || Bool || 50 || NO || Seleccionar si el tercero es empleado
|-
| esvendedor || Bool || 50 || NO || Seleccionar si el tercero es vendedor
|-
| esotro || Bool || 50 || NO || Seleccionar si el tercero es otro
|-
| escobrador || Bool || 50 || NO || Seleccionar si el tercero es cobrador
|-
| cumple_dia || Int || 50 || NO || Día del cumpleaños
|-
| cumplea_mes || Int || 50 || NO || Mes del cumpleaños
|-
| cumplea_ano || Int || 50 || NO || Año del cumpleaños
|-
| genero || String || 50 || NO || Género del tercero (M=Masculino, F=Femenino)
|-
| direccion || String || 50 || SI || Dirección
|-
| direccion2 || String || 50 || NO || Dirección complementaria
|-
| telefono || String || 50 || NO || Número de teléfono
|-
| ext || Int || 50 || NO || Número de extensión
|-
| movil || String || 50 || SI || Número de móvil celular
|-
| pais || String || 50 || Informativo || Nombre País
|-
| departamento || String || 50 || Informativo || Nombre del departamento
|-
| ciudad || String || 50 || Informativo || Nombre de la ciudad
|-
| codciudad || String || 50 || SI || Código único de la ciudad
|-
| zona || Int || 50 || NO || ID de la zona
|-
| email || String || 50 || SI || Cuenta de email
|-
| activo || Bool || 50 || SI || Estado del tercero (true=Activo, false=Inactivo)
|-
| cupocredito || Decimal || 50 || NO || Cupo de crédito
|-
| periodopago || Int || 50 || NO || Período de pago en días para el vencimiento de facturas de venta
|-
| codigociiu || String || 50 || NO || Código CIIU, Actividades económicas
|-
| descuentoventa || Decimal || 50 || NO || Porcentaje para el descuento en ventas
|-
| categoriatercero || Int || 50 || SI || ID de la categoría de terceros
|-
| formapago || Int || 50 || NO || ID de la forma de pago
|-
| listaprecios || Int || 50 || NO || ID de la lista de precios
|-
| grupoventas || Int || 50 || SI || ID del grupo de retenciones para ventas
|-
| grupocompras || Int || 50 || SI || ID del grupo de retenciones para compras
|-
| vendedor || Int || 50 || NO || Número de identificación del vendedor
|-
| cobrador || Int || 50 || NO || Número de identificación del cobrador
|-
| fechacreacion || String || 50 || NO || Fecha de creación del tercero. Ejemplo "2020-05-20 00:00:00"
|-
| regimen || Int || 50 || SI || ID del régimen tributario
|-
| banco || Int || 50 || NO || ID del banco
|-
| tipo_cuenta || String || 50 || NO || Tipo cuenta bancaria. (A=Cuenta de Ahorro, B=Cuenta Corriente)
|-
| cuenta_bancaria || String || 50 || NO || Número de cuenta bancaria
|-
| limite_credito || Decimal || 50 || NO || Límite del crédito
|-
| camposPersonalizados || Objeto || 50 || NO || Objeto con la información de campos personalizados
|}

'''Authorization:'''
<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ó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/Tercero")
.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/Tercero");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</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/Tercero');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Pedido Rastreo

2023-09-25T22:10:59Z

Nalzate: /* Métodos */

API Pedido Rastreo

2023-09-25T22:09:03Z

Nalzate: /* Métodos */

API Pedido Rastreo

2023-09-25T21:54:58Z

Nalzate:

API Pedido Rastreo

2023-09-25T21:51:03Z

Nalzate:

API Pedido Rastreo

2023-09-25T21:40:22Z

Nalzate:

API Pedido Rastreo

2023-09-25T21:24:47Z

Nalzate:

'''Descripción:'''
Esta API permite la sincronizacion de sucursales 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 (GET) ">
'''GET/users'''

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

''' 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
"success": true,
"code": 200,
"errors": null,
"message": "x registro(s) encontrados",
"result": [
{
"id": 2317,
"id_tercero": 1804,
"nit_tercero": "900985549",
"codigo": 0,
"referencia_sucursal": "",
"descripcion": "PRUEBA",
"direccion": "cra 22 # 4-44",
"direccion2": "",
"telefono": "",
"telefono2": "",
"ext": null,
"ext2": null,
"movil": "",
"id_ciudad": 5001,
"codigo_ciudad": "05001",
"id_departamento": 5,
"codigo_departamento": "05",
"id_pais": 1,
"codigo_pais": "57",
"id_vendedor": 3418,
"id_cobrador": null,
"es_direccionCobro": false,
"es_direccionDespacho": false
},
]
}

{
"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 sucursal
|-
| id_tercero || int || Corresponde al identificador del tercero
|-
| nit_tercero || int || Nit del tercero
|-
| codigo || string || Codigo de la sucursal
|-
| referencia_sucursal || string || Referencia de la sucursal
|-
| descripcion || string || Descripcion de la sucursal
|-
| direccion || string || Direccion de la sucursal
|-
| direccion2 || string || Segunda direccion de la sucursal
|-
| telefono || int || Telefono correspondiente a la sucursal
|-
| telefono2 || int || Segundo telefono correspondiente a la sucursal
|-
| ext || int || Extension de la sucursal
|-
| ext2 || int || Extension de la sucursal
|-
| movil || int || Celular de la sucursal
|-
| id_ciudad || int || Identificador correspondiente a la ciudad de la sucursal
|-
| codigo_ciudad || string || Codigo de la ciudad de la sucursal
|-
| id_departamento || int || Identificador correspondiente al departamento de la sucursal
|-
| codigo_departamento || string || Codigo del departamento de la sucursal
|-
| id_pais || int || Identificador correspondiente al pais de la sucursal
|-
| codigo_pais || string || Codigo del pais de la sucursal
|-
| id_vendedor || int || Identificador correspondiente al vendedor de la sucursal
|-
| id_cobrador || int || Identificador correspondiente al cobrador de la sucursal
|-
| es_direccionCobro || bool || Valida si es direccion de cobro
|-
| es_direccionDespacho || bool || Valida si es direccion de despacho
|}
</Tab>


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

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

''' 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_tercero": 1804,
"nit_tercero": "900985549",
"codigo": 0,
"referencia_sucursal": null,
"descripcion": "PRUEBA",
"direccion": "cra 22 #4-44",
"direccion2": null,
"telefono": null,
"telefono2": null,
"ext": null,
"ext2": null,
"movil": null,
"id_ciudad": 5001,
"codigo_ciudad": "05001",
"id_departamento": 5,
"codigo_departamento": "05",
"id_pais": 1,
"codigo_pais": "57",
"id_vendedor": 3418,
"id_cobrador": null,
"es_direccionCobro": false,
"es_direccionDespacho": false
}

</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id_tercero || int || 50 || SI || Corresponde al identificador del tercero
|-
| nit_tercero || int || 50 || SI || Nit del tercero
|-
| codigo || string || 50 || SI || Codigo de la sucursal
|-
| referencia_sucursal || string || 50 || SI || Referencia de la sucursal
|-
| descripcion || string || 50 || SI || Descripcion de la sucursal
|-
| direccion || string || 50 || SI || Direccion de la sucursal
|-
| direccion2 || string || 50 || NO || Segunda direccion de la sucursal
|-
| telefono || int || 50 || SI || Telefono correspondiente a la sucursal
|-
| telefono2 || int || 50 || NO || Segundo telefono correspondiente a la sucursal
|-
| ext || int || 50 || NO || Extension de la sucursal
|-
| ext2 || int || 50 || NO || Extension de la sucursal
|-
| movil || int || 50 || NO || Celular de la sucursal
|-
| id_ciudad || int || 50 || SI || Identificador correspondiente a la ciudad de la sucursal
|-
| codigo_ciudad || string || 50 || SI || Codigo de la ciudad de la sucursal
|-
| id_departamento || int || 50 || SI || Identificador correspondiente al departamento de la sucursal
|-
| codigo_departamento || string || 50 || SI || Codigo del departamento de la sucursal
|-
| id_pais || int || 50 || SI || Identificador correspondiente al pais de la sucursal
|-
| codigo_pais || string || 50 || SI || Codigo del pais de la sucursal
|-
| id_vendedor || int || 50 || SI || Identificador correspondiente al vendedor de la sucursal
|-
| id_cobrador || int || 50 || NO || Identificador correspondiente al cobrador de la sucursal
|-
| es_direccionCobro || bool || X || SI || Valida si es direccion de cobro
|-
| es_direccionDespacho || bool || X || SI || Valida si es direccion de despacho
|}

'''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/Sucursales
''' 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": 2317,
"id_tercero": 1804,
"codigo": 0,
"referencia_sucursal": "",
"descripcion": "PRUEBA CAMBIO",
"direccion": "cra 22 #4-44",
"direccion2": "",
"telefono": "",
"telefono2": "",
"ext": null,
"ext2": null,
"movil": "",
"id_ciudad": 5001,
"id_departamento": 5,
"id_pais": 1,
"id_vendedor": 3418,
"id_cobrador": null,
"es_direccionCobro": false,
"es_direccionDespacho": false
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || Corresponde al identificador de la sucursal
|-
| id_tercero || int || 50 || SI || Corresponde al identificador del tercero
|-
| nit_tercero || int || 50 || SI || Nit del tercero
|-
| codigo || string || 50 || SI || Codigo de la sucursal
|-
| referencia_sucursal || string || 50 || SI || Referencia de la sucursal
|-
| descripcion || string || 50 || SI || Descripcion de la sucursal
|-
| direccion || string || 50 || SI || Direccion de la sucursal
|-
| direccion2 || string || 50 || NO || Segunda direccion de la sucursal
|-
| telefono || int || 50 || SI || Telefono correspondiente a la sucursal
|-
| telefono2 || int || 50 || NO || Segundo telefono correspondiente a la sucursal
|-
| ext || int || 50 || NO || Extension de la sucursal
|-
| ext2 || int || 50 || NO || Extension de la sucursal
|-
| movil || int || 50 || NO || Celular de la sucursal
|-
| id_ciudad || int || 50 || SI || Identificador correspondiente a la ciudad de la sucursal
|-
| codigo_ciudad || string || 50 || SI || Codigo de la ciudad de la sucursal
|-
| id_departamento || int || 50 || SI || Identificador correspondiente al departamento de la sucursal
|-
| codigo_departamento || string || 50 || SI || Codigo del departamento de la sucursal
|-
| id_pais || int || 50 || SI || Identificador correspondiente al pais de la sucursal
|-
| codigo_pais || string || 50 || SI || Codigo del pais de la sucursal
|-
| id_vendedor || int || 50 || SI || Identificador correspondiente al vendedor de la sucursal
|-
| id_cobrador || int || 50 || NO || Identificador correspondiente al cobrador de la sucursal
|-
| es_direccionCobro || bool || X || SI || Valida si es direccion de cobro
|-
| es_direccionDespacho || bool || X || SI || Valida si es direccion de despacho
|}

'''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/Sucursales")
.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/Sucursales"

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/Sucursales');
$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 Pedido Rastreo

2023-09-25T21:24:15Z

Nalzate:

API Pedido Rastreo

2023-09-25T21:22:00Z

Nalzate: Página creada con «'''Descripción:''' Esta API permite la sincronizacion de sucursales 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 petici…»

API Modulo Ventas

2023-09-25T21:19:28Z

Nalzate:

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 Pedido Rastreo|API Pedido Rastreo ]]
* [[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 Inventarios/Factura Compra

2023-09-18T14:30:45Z

Nalzate: Página creada con «'''Descripción:''' Esta API permite la sincronización del agrupador definido como Factura de Compra entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estándar entre las dos Plataformas. '''Autorización:''' Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP. '''…»

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

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''

'''Tipos de peticiones:'''
GET

'''¿Cómo funciona?'''
*El consumo de esta API se realiza por método GET.
*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

== Métodos ==
<Tabs>

<Tab name = "API Consulta Tipos de Documento(GET)">

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "2 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "FC",
"prefijo": "FC",
"descripcion": "FACTURA COMPRA"
}
]
}

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

</syntaxhighlight>

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


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

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Requerido !! Descripción
|-
| Límite || NO || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || NO || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

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

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

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

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

</syntaxhighlight>

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

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

</Tab>


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

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

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

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

</syntaxhighlight>

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

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

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

</syntaxhighlight>
</Tab>


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

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

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

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

</syntaxhighlight>

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

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

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

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

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://localhost:44305/api/v1/FacturaCompra")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/FacturaCompra");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/FacturaCompra');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Modulo Inventarios

2023-09-18T14:11:50Z

Nalzate:

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 Articulos]]
* [[API Ventas/Bodegas|API Bodegas]]
* [[API Terceros/Grupo_Ventas_Compras|API Grupos Ventas/Compras]]
* [[API Inventarios/Traslado_Inventario |API Traslado Inventario]]
* [[API Inventarios/Factura_Compra |API Factura Compra]]

API Articulos

2023-09-18T14:09:59Z

Nalzate:

'''Descripción:'''
Esta API permite la sincronizacion de Articulos 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 Consultar(GET)">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/Articulo?limite=50&pagina=1&codigo=12345

''' 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
|-
| Codigo || int || No || Codigo del articulo a filtrar
|}

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"codigo": "123",
"referencia": "456",
"barras": "123456789",
"descripcion": "ARTICULO1",
"idgrupocontable": 2,
"descripcionalterna": null,
"idlinea": 1,
"idcategoria": 2,
"idpresentacion": 5,
"idmarca": 1,
"idunidadmedida": 3,
"peso": 0.00000,
"costo": 1000.00,
"costou": null,
"activo": true,
"posicionarancel": "1332",
"porcentajeArancel": 0.00000,
"diasMaximo": 0,
"diasminimo": 0,
"diasoptimo": 0,
"dias_reposicion": 0,
"tipoPlaneacion": 0,
"multiploCompra": 1.00,
"pedidoMinimo": 1.00000,
"stockMinimoUnidades": null,
"stockOptimoUnidades": null,
"aplicaPromocion": false,
"aplicaKit": false,
"exportable": false,
"volumen": 1.00000,
"ubicacion": 1.00000,
"ubicacionAlfanumerica": "1",
"palabrasClave": "prueba,articulo,casa",
"camposPersonalizados": {
"PAGINAS": 50,
"Comentarios": "Cliente proveedor ",
"AUTOR": "Juan",
},
"aplicaAiu": true,
"porcentajeAiu": 11.00,
"idgrupocontableAiu": 3
}
]
}

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

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo !! Descripción
|-
| id || int || Corresponde al id del artículo
|-
| codigo || string || Código del artículo
|-
| referencia || string || Referencia del artículo
|-
| barras || string || Código de barras del artículo
|-
| descripcion || string || Descripción del artículo
|-
| idgrupocontable || Int || Id del Grupo contable
|-
| descripcionalterna || string || Descripción alterna del artículo
|-
| idlinea || Int || Id de la Línea
|-
| idcategoria || Int || Id de la Categoría
|-
| idpresentacion || Int || Id de la Presentación
|-
| idmarca || Int || Id de la Marca
|-
| idunidadmedida || Int || Id de la Unidad de medida
|-
| peso || decimal || Peso del artículo
|-
| costo || decimal || Costo del artículo
|-
| costou || decimal || Último Costo del artículo
|-
| activo || bool || Estado del artículo (true=Activo, false=Inactivo)
|-
| posicionarancel || string || Posición arancel
|-
| porcentajeArancel || decimal || Porcentaje arancel
|-
| DiasMaximo || short || Días Máximo
|-
| Diasminimo || short || Días mínimo
|-
| Diasoptimo || short || Días óptimo
|-
| dias_reposicion || short || Días reposición
|-
| tipoPlaneacion || Int || Tipo planeación (0=General, 1=Personalizada)
|-
| multiploCompra || decimal || Múltiplo compra
|-
| PedidoMinimo || decimal || Pedido mínimo
|-
| stockMinimoUnidades || decimal || Stock mínimo en unidades
|-
| stockOptimoUnidades || decimal || Stock óptimo en unidades
|-
| aplicaPromocion || bool || Si aplica promoción. (true=Activo, false=Inactivo)
|-
| aplicaKit || bool || Si aplica kit. (true=Activo, false=Inactivo)
|-
| exportable || bool || Si el articulo es exportable para un software externo. (true=Activo, false=Inactivo)
|-
| volumen || Decimal || Volumen del articulo
|-
| ubicacion || Decimal || Ubicacion del articulo
|-
| ubicacionAlfanumerica || String || Ubicacion alfanumerica del articulo
|-
| palabrasClave || string || Texto para ingresar palabras clave
|-
| camposPersonalizados || Objeto || Objeto con la informacion de campos personalizados
|-
| aplicaAiu || Bool || Si aplica porcentaje Aiu (true=Activo, false=Inactivo)
|-
| porcentajeAiu || Decimal || Porcentaje del Aiu
|-
| idgrupocontableAiu || Int || Id del grupo contable para Aiu
|}
</Tab>


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

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

'''Body:'''
<syntaxhighlight lang="JSON">
[
{
"codigo": "123",
"referencia": "456",
"barras": "123456789",
"descripcion": "ARTICULO1",
"idgrupocontable": 2,
"descripcionalterna": null,
"idlinea": 1,
"idcategoria": 2,
"idpresentacion": 5,
"idmarca": 1,
"idunidadmedida": 3,
"peso": 0.00000,
"costo": 1000.00,
"costou": null,
"activo": true,
"posicionarancel": "1332",
"porcentajeArancel": 0.00000,
"diasMaximo": 0,
"diasminimo": 0,
"diasoptimo": 0,
"dias_reposicion": 0,
"tipoPlaneacion": 0,
"multiploCompra": 1.00,
"pedidoMinimo": 1.00000,
"stockMinimoUnidades": null,
"stockOptimoUnidades": null,
"aplicaPromocion": false,
"aplicaKit": false,
"exportable": false,
"volumen": 1.00000,
"ubicacion": 1.00000,
"ubicacionAlfanumerica": "1",
"palabrasClave": "prueba,articulo,casa",
"camposPersonalizados": {
"PAGINAS": 50,
"Comentarios": "Cliente proveedor ",
"AUTOR": "Juan",
},
"aplicaAiu": true,
"porcentajeAiu": 11.00,
"idgrupocontableAiu": 3
}
]

</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| codigo || string || SI || Código del artículo
|-
| referencia || string || NO || Referencia del artículo
|-
| barras || string || NO || Código de barras del artículo
|-
| descripcion || string || SI || Descripción del artículo
|-
| idgrupocontable || Int || SI || Id del Grupo contable
|-
| descripcionalterna || string || NO || Descripción alterna del artículo
|-
| idlinea || Int || SI || Id de la Línea
|-
| idcategoria || Int || SI || Id de la Categoría
|-
| idpresentacion || Int || SI || Id de la Presentación
|-
| idmarca || Int || SI || Id de la Marca
|-
| idunidadmedida || Int || SI || Id de la Unidad de medida
|-
| peso || decimal || NO || Peso del artículo
|-
| costo || decimal || NO || Costo del artículo
|-
| costou || decimal || NO || Último Costo del artículo
|-
| activo || bool || SI || Estado del artículo (true=Activo, false=Inactivo)
|-
| posicionarancel || string || NO || Posición arancel
|-
| porcentajeArancel || decimal || NO || Porcentaje arancel
|-
| DiasMaximo || short || NO || Días Máximo
|-
| Diasminimo || short || NO || Días mínimo
|-
| Diasoptimo || short || NO || Días óptimo
|-
| dias_reposicion || short || NO || Días reposición
|-
| tipoPlaneacion || Int || NO || Tipo planeación (0=General, 1=Personalizada)
|-
| multiploCompra || decimal || NO || Múltiplo compra
|-
| PedidoMinimo || decimal || NO || Pedido mínimo
|-
| stockMinimoUnidades || decimal || NO || Stock mínimo en unidades
|-
| stockOptimoUnidades || decimal || NO || Stock óptimo en unidades
|-
| aplicaPromocion || bool || NO || Si aplica promoción. (true=Activo, false=Inactivo)
|-
| aplicaKit || bool || NO || Si aplica kit. (true=Activo, false=Inactivo)
|-
| exportable || bool || NO || Si el articulo es exportable para un software externo. (true=Activo, false=Inactivo)
|-
| volumen || Decimal || NO || Volumen del articulo
|-
| ubicacion || Decimal || NO || Ubicacion del articulo
|-
| ubicacionAlfanumerica || String || NO || Ubicacion alfanumerica del articulo
|-
| palabrasClave || string || NO || Texto para ingresar palabras clave
|-
| camposPersonalizados || Objeto || NO || Objeto con la informacion de campos personalizados
|-
| aplicaAiu || Bool || NO || Si aplica porcentaje Aiu (true=Activo, false=Inactivo)
|-
| porcentajeAiu || Decimal || NO || Porcentaje del Aiu
|-
| idgrupocontableAiu || Int || NO || Id del grupo contable para Aiu
|}

'''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 articulos"
}
</syntaxhighlight>
</Tab>


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

''' 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">
[
{
"id": 1,
"codigo": "123",
"referencia": "456",
"barras": "123456789",
"descripcion": "ARTICULO1",
"idgrupocontable": 2,
"descripcionalterna": null,
"idlinea": 1,
"idcategoria": 2,
"idpresentacion": 5,
"idmarca": 1,
"idunidadmedida": 3,
"peso": 0.00000,
"costo": 1000.00,
"costou": null,
"activo": true,
"posicionarancel": "1332",
"porcentajeArancel": 0.00000,
"diasMaximo": 0,
"diasminimo": 0,
"diasoptimo": 0,
"dias_reposicion": 0,
"tipoPlaneacion": 0,
"multiploCompra": 1.00,
"pedidoMinimo": 1.00000,
"stockMinimoUnidades": null,
"stockOptimoUnidades": null,
"aplicaPromocion": false,
"aplicaKit": false,
"exportable": false,
"volumen": 1.00000,
"ubicacion": 1.00000,
"ubicacionAlfanumerica": "1",
"palabrasClave": "prueba,articulo,casa",
"camposcliente": {}},

"aplicaAiu": true,
"porcentajeAiu": 11.00,
"idgrupocontableAiu": 3
}
]

</syntaxhighlight>

'''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 modificaron 10 de 10 articulos"
}
</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/Articulo")
.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/Articulo");
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/Articulo');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Inventarios/Traslado Inventario

2023-09-13T16:53:21Z

Nalzate: Página creada con «'''Descripción:''' Esta API permite la sincronización del agrupador definido como Traslado de Inventario 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.…»

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

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''

'''Tipos de peticiones:'''
GET

'''¿Cómo funciona?'''
*El consumo de esta API se realiza por método GET.
*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

== Métodos ==
<Tabs>

<Tab name = "API Consulta Tipos de Documento(GET)">

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "TRI",
"prefijo": "TRI",
"descripcion": " TRASLADO DE INVENTARIO"
}
]
}

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

</syntaxhighlight>

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


<Tab name = "API Consultar Traslado de Inventario(GET) ">

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

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

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

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Requerido !! Descripción
|-
| Límite || NO || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || NO || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

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

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

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "TRI",
"prefijo": "TRI",
"numeroDoc": 1,
"nitTerceroEnc": "123456789",
"nombreTerceroEnc": "EMPRESA PRUEBA S.A.S.",
"fechaDocumento": "2023-06-01",
"idBodegaOrigen": 25,
"bodegaOrigen": "REGALOS",
"idBodegaDestino": 3,
"bodegaDestino": "PRINCIPAL",
"observacion": null,
"detalles": [
{
"idArticulo": 1,
"descripcion": "ARTICULO PRUEBA",
"cantidad": 3.00000,
"costo": 46060.06,
"comentarios": null
}
]
}
]
}

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

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| id || Int || Corresponde al id del registro
|-
| categoriaDocumento || String || Categoria del tipo de documento
|-
| prefijo || String || Prefijo del tipo de documento
|-
| numeroDoc || Int || Numero del traslado de inventario
|-
| nitTerceroEnc || String || Numero de identificador del tercero del traslado de inventario
|-
| nombreTerceroEnc || String || Nombre del tercero
|-
| fechaDocumento || String || Fecha del traslado
|-
| idBodegaOrigen || int || Id de la bodega origen
|-
| bodegaOrigen || String || Nombre de la bodega origen
|-
| idBodegaDestino || Int || Id de la bodega destino
|-
| bodegaDestino || String || Nombre de la bodega destino
|-
| observaciones || String || Observaciones
|-
| detalles || Array[ObjetoDetalle*] || Array de objetos de los detalles del traslado de inventario
|}

'''ObjetoDetalle'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Descripción
|-
| idArticulo || Int || Id del Articulo
|-
| descripcion || String || Descripcion del Articulo
|-
| cantidad || Decimal || Cantidad a trasladar
|-
| costo || Decimal || Costo articulo
|-
| comentarios || String || Comentarios del movimiento
|}

</Tab>


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

{| 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">
[
{
"categoriaDocumento": "TRI",
"prefijo": "TRASL",
"numeroDoc": 1,
"nitTerceroEnc": "1234567890",
"fechaDocumento": "2023-09-12",
"idBodegaOrigen": 3,
"idBodegaDestino": 20,
"observacion": "",
"detalles": [
{
"idArticulo": 95,
"cantidad": 1.00000,
"costo": 6500
},
{
"idArticulo": 21,
"cantidad": 1.00000,
"costo": 5500
}
]
}
]

</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| categoriaDocumento || String || SI || Categoria del tipo de documento
|-
| prefijo || String || SI || Prefijo del tipo de documento
|-
| numeroDoc || Int || SI || Numero de traslado
|-
| nitTerceroEnc || Int || SI || Nit del tercero del traslado
|-
| fechaDocumento || String || SI || Fecha del traslado
|-
| idBodegaOrigen || Int || SI || Id de la bodega origen
|-
| idBodegaDestino || Int || SI || Id de la bodega destino
|-
| observaciones || String || SI || Observaciones del traslado
|-
| detalles || Array[ObjetoDetalle]* || SI || Array de objetos de los detalles del Traslado
|}

'''ObjetoDetalle'''
{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo !! Requerido !! Descripción
|-
| idArticulo || Int || SI || Id del Articulo a ajustar
|-
| cantidad || Decimal || SI || Cantidad a trasladar
|-
| costo || Decimal || SI || Costo del articulo
|}

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

</syntaxhighlight>
</Tab>


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

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

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

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

</syntaxhighlight>

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

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

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

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

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://localhost:44305/api/v1/TrasladoInventario")
.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/TrasladoInventario");
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/TrasladoInventario');
$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-09-13T15:59:12Z

Nalzate:

API Terceros/Forma Pago

2023-09-07T21:35:20Z

Nalzate: /* Métodos */

'''Descripción:'''
Esta API permite la sincronizacion de Formas de pago para los procesos de ventas 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, 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/FormaPago

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/FormaPago?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": 1,
"cuenta": 15120501,
"descripcion_cuenta": "MAQUINARIA Y EQUIPO",
"descripcion_fomapago": "PRUEBAS D",
"tipo": "PRUEBAS T",
"aplicafactura": false,
"aplicapuntopago": false,
"tercuenta": false,
"id_formapago_categoria": 1,
"categoria": "CR",
"descripcion_formapago_categoria": "CREDITO",
"escontraentrega": true
}
]
}

{
"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 identidad
|-
| auxiliar|| int|| Corresponde al código de la cuenta
|-
| descripcion_cuenta|| string || Descripción tipo de cuenta.
|-
| descripcion_fomapago|| string || Descripción de la forma de pago
|-
| tipo|| string || Descripción del tipo de cuenta o acrónimo de la cuenta
|-
| aplicafactura|| bool|| true o false. Si aplica factura
|-
| aplicapuntopago|| bool || true o false. Si el aplica punto de pago
|-
| tercuenta|| bool || true o false. Si el aplica cuenta tercero
|-
| id_formapago_categoria || int || Corresponde al identificador de la categoría forma de pago
|-
| categoria|| string || Abreviatura3 Categoria forma pago
|-
| descripcion_formapago_categoria|| string || Descripción de la categoría forma de pago
|-
| escontraentrega || bool || true o false. Si es contraentrega
|}
</Tab>


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

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

''' 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_formapago_categoria" : 4,
"tipo": "p false",
"descripcion_fomapago": "forma false",
"tercuenta": true,
"cuenta": 11050501,
"aplicafactura": true,
"aplicapuntopago": true,
"escontraentrega": true
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| gdtformapagocatid || int || 11 || SI || Identificador único del tipo de categoría para la forma de pago , si es crédito , debito ,contado
|-
| tipo || string || 100 || SI || tipo de forma de pago como CO. DE, CR
|-
| descripcion_fomapago || string || 50 || SI || Descripción del tipo de forma de pago
|-
| tercuenta || bool || 1 || SI || true o false. toma la Cuenta por Cobrar, Tomarla del Tercero y al numero auxiliar
|-
| auxiliar || string || 15 || NO || Código auxilita de la cuenta, hace referencia a tercuenta según su estado true o false
|-
| aplicafactura || bool || 1 || NO || true o false. si aplica factura
|-
| aplicapuntopago || bool || 1 || NO || true o false. si aplica punto pago
|-
| escontraentrega || bool || 1 || NO || true o false. Si es contraentrega
|}

'''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": false,
"code": 400,
"errors": [
"La cuenta 110505019 no existe"
],
"message": "Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


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

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

''' 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": 39,
"descripcion_fomapago": "PRUEBAS",
"tipo": "PR",
"tercuenta": false,
"auxiliar": 11050501,
"aplicafactura": false,
"aplicapuntopago": true,
"gdtformapagocatid": 1,
"escontraentrega": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || Corresponde al identificador de la forma de pago
|-
| descripcion_fomapago|| string || 50 || SI || Descripción del tipo de forma de pago
|-
| tipo|| string || 50 || SI || Descripcion tipo de forma pago
|-
| tercuenta || bool || 1 || NO || true o false. toma la Cuenta por Cobrar, Tomarla del Tercero y al numero auxiliar
|-
| auxiliar|| string || 50 || NO || Código auxilita de la cuenta, hace referencia a tercuenta según su estado true o false
|-
| aplicafactura|| string || 50 || NO || true o false. si aplica factura
|-
| aplicapuntopago|| bool || 50 || NO || true o false. si aplica punto pago
|-
| gdtformapagocatid|| int || 50 || SI || Identificador único del tipo de categoría para la forma de pago , si es crédito , debito ,contado
|-
| escontraentrega || bool || 1 || NO || true o false. Si es contraentrega
|}

'''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 descripcion_fomapago 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/Forma Pago

2023-09-05T21:50:05Z

Nalzate:

'''Descripción:'''
Esta API permite la sincronizacion de Formas de pago para los procesos de ventas 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, 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/FormaPago

'''EndPoint con parámetros:'''
https://www.apis.serpi.com.co/api/v1/FormaPago?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": 1,
"cuenta": 15120501,
"descripcion_cuenta": "MAQUINARIA Y EQUIPO",
"descripcion_fomapago": "PRUEBAS D",
"tipo": "PRUEBAS T",
"aplicafactura": false,
"aplicapuntopago": false,
"tercuenta": false,
"id_formapago_categoria": 1,
"categoria": "CR",
"descripcion_formapago_categoria": "CREDITO"
}
]
}

{
"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 identidad
|-
| auxiliar|| int|| Corresponde al código de la cuenta
|-
| descripcion_cuenta|| string || Descripción tipo de cuenta.
|-
| descripcion_fomapago|| string || Descripción de la forma de pago
|-
| tipo|| string || Descripción del tipo de cuenta o acrónimo de la cuenta
|-
| aplicafactura|| bool|| true o false. Si aplica factura
|-
| aplicapuntopago|| bool || true o false. Si el aplica punto de pago
|-
| tercuenta|| bool || true o false. Si el aplica cuenta tercero
|-
| id_formapago_categoria || int || Corresponde al identificador de la categoría forma de pago
|-
| categoria|| string || Abreviatura3 Categoria forma pago
|-
| descripcion_formapago_categoria|| string || Descripción de la categoría forma de pago

|}
</Tab>


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

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

''' 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_formapago_categoria" : 4,
"tipo": "p false",
"descripcion_fomapago": "forma false",
"tercuenta": true,
"cuenta": 11050501,
"aplicafactura": true,
"aplicapuntopago": true
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| gdtformapagocatid|| int|| 11 || SI || Identificador único del tipo de categoría para la forma de pago , si es crédito , debito ,contado
|-
| tipo|| string || 100 || SI || tipo de forma de pago como CO. DE, CR
|-
| descripcion_fomapago|| string || 50 || SI || Descripción del tipo de forma de pago
|-
| tercuenta|| bool || 1 || SI || true o false. toma la Cuenta por Cobrar, Tomarla del Tercero y al numero auxiliar
|-
| auxiliar|| string || 15 || NO || Código auxilita de la cuenta, hace referencia a tercuenta según su estado true o false
|-
| aplicafactura|| bool || 1|| NO || true o false. si aplica factura
|-
| aplicapuntopago|| bool || 1|| NO || true o false. si aplica punto pago

|}

'''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": false,
"code": 400,
"errors": [
"La cuenta 110505019 no existe"
],
"message": "Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


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

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

''' 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": 39,
"descripcion_fomapago": "PRUEBAS",
"tipo": "PR",
"tercuenta": false,
"auxiliar": 11050501,
"aplicafactura": false,
"aplicapuntopago": true,
"gdtformapagocatid": 1
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable left"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 50 || SI || Corresponde al identificador de la forma de pago
|-
| descripcion_fomapago|| string || 50 || SI || Descripción del tipo de forma de pago
|-
| tipo|| string || 50 || SI || Descripcion tipo de forma pago
|-
| tercuenta || bool || 1 || NO || true o false. toma la Cuenta por Cobrar, Tomarla del Tercero y al numero auxiliar
|-
| auxiliar|| string || 50 || NO || Código auxilita de la cuenta, hace referencia a tercuenta según su estado true o false
|-
| aplicafactura|| string || 50 || NO || true o false. si aplica factura
|-
| aplicapuntopago|| bool || 50 || NO || true o false. si aplica punto pago
|-
| gdtformapagocatid|| int || 50 || SI || Identificador único del tipo de categoría para la forma de pago , si es crédito , debito ,contado
|}

'''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 descripcion_fomapago 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]]