API Pedidos

De WikiSerpi
Ir a la navegación Ir a la búsqueda

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

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": "2 registro(s) encontrados",
    "result": [
        {
            "id": 1,
            "categoriaDocumento": "PDV",
            "prefijo": "PDV",
            "descripcion": "PEDIDO VENTA"
        }
    ]
}

{
    "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 Pedidos Venta (GET) ">

EndPoint: https://www.apis.serpi.com.co/api/v1/PedidoVenta/ConsultarPedidoVenta?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 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 

{
    "idTipoDocumento": 15,
    "numeroDesde": null,
    "numeroHasta": null,
    "fechaDesde": "2023-01-01",
    "fechaHasta": "2023-01-31"
}
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 

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

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

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

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 

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

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

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 

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

</Tab>

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

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 

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


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 

{
    "success": true,
    "code": 200,
    "errors": [],
    "message": "Se eliminaron 1 de 1 Pedidos de Venta"
}

</Tab>


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

Parametros
Parametro Requerido Descripcion
idPedido SI identificador del pedido al cual se le creara un detalle

Authorization: 

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


Body 

{
    "idArticulo": 1,
    "cantidad": 2.00000,
    "valorUnitario": 1196000.00000,
    "porcdescuento": 0.00000,
    "descuentovalor": 0.00000,
    "porcImpuesto": 19.00000,
    "subtotal": 2392000.00000,
    "impuesto": 454480.00000
}


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 

{
    "success": true,
    "code": 200,
    "errors": [],
    "message": "Se eliminaron 1 de 1 Pedidos de Venta"
}

</Tab>


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

Parametros
Parametro Requerido Descripcion
idDetallePedido SI identificador del detalle de un pedido de venta

Authorization: 

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


Response 

{
    "success": true,
    "code": 200,
    "errors": [],
    "message": "Se eliminaron 1 de 1 detalle del Pedidos de Venta"
}

</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/PedidoVenta")
  .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/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());

</Tab>

<Tab name = "PHP"> Request 

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

</Tab>

</Tabs>

Obtenido de «https://www.wikiserpi.com/index.php?title=API_Pedidos&oldid=1102»