API Inventarios/Ajuste Inventario

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

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Parámetros

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

Response

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "1 registro(s) encontrados",
    "result": [
        {
            "id": 1,
            "categoriaDocumento": "AI",
            "prefijo": "AI",
            "descripcion": " AJUSTE DE INVENTARIO"
        }    
]
}

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

Campo de resultados

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

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Parámetros

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

Response

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "1 registro(s) encontrados",
    "result": [
        {
            "idTipoAjuste": 2,
            "abreviatura": "AJ",
            "descripcion": "AJUSTE INVENTARIO",
            "cuenta": "61350601 - VENTA DE PARTES"
        }
    ]
}

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

Campo de resultados

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

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Body:

{
    "tiposDocumentos": [16],
    "numeroDesde": null,
    "numeroHasta": null,
    "fechaDesde": "2023-01-01",
    "fechaHasta": "2023-01-31"
}

Campos

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:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response

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

Campos Resultado

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

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

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Body:

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

Campos

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*

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:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response

{
    "success": true,
    "code": 201,
    "errors": [],
    "message": "Se crearon 3 de 3 ajustes de inventario"
}

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

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

Headers

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Body:

{
    "idTipoDocumento": 6,
    "numeroDesde": 1,
    "numeroHasta": 10000,
    "fechaDesde": "2023-03-01",
    "fechaHasta": "2023-03-31"
}

Campos

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:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response

{
    "success": true,
    "code": 200,
    "errors": [],
    "message": "Se eliminaron 10 de 10 ajustes de inventario"
}

</Tab> </Tabs>

Códigos de estado HTTP

Código	Descripción
200	La solicitud ha sido exitosa
201	La solicitud ha tenido éxito y ha llevado a la creación de un recurso
204	La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta
400	El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente
401	La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso
403	El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso
404	El recurso solicitado no se ha encontrado en el servidor
500	Internal Server Error
503	El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal

¿Cómo consumir la API?

<Tabs>

<Tab name = "Java"> Request

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

</Tab>

<Tab name = "C#"> Request

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost: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());

</Tab>

<Tab name = "PHP"> Request

<?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();
}

</Tab>

</Tabs>