API Inventarios/Traslado Inventario

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

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": "TRI",
            "prefijo": "TRI",
            "descripcion": " TRASLADO DE INVENTARIO"
        }    
]
}

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

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

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

{
    "idTiposDocumento": 16,
    "numeroDesde": null,
    "numeroHasta": null,
    "fechaDesde": "2023-01-01",
    "fechaHasta": "2023-01-31"
}

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

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

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

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

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

Request

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

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

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

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

</Tab>

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

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": 1,
    "fechaDesde": "2023-03-01",
    "fechaHasta": "2023-03-31"
}

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

{
    "success": true,
    "code": 200,
    "errors": [],
    "message": "Se eliminaron 1 de 1 Traslados 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/TrasladoInventario")
  .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/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());

</Tab>

<Tab name = "PHP"> Request

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

</Tab>

</Tabs>