API Ventas/Factura Venta

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

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": "FV",
            "prefijo": "FV",
            "descripcion": "FACTURA 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 Facturas Venta (GET) ">

EndPoint: https://www.apis.serpi.com.co/api/v1/FacturaVenta/ConsultarFacturaVenta?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": 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
                }
            ]
        }
    ]
}

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

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

</Tab>

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

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": "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
            }
        ]
    }
]

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

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

Response

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

</Tab>

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

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

{
	"id": 123,
    "descripcion": "pruebanueva",
    "valor": 5.00000,
    "aplica": 1,
    "_base": 0.00000,
    "cuenta_impuesto": 2659,
    "cuenta_impuesto_devolucion": 2659,
    "cuenta_impuesto_bonificado": 2659
}

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

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

Validaciones

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

</Tab> </Tabs>

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

</Tab>

<Tab name = "PHP"> Request

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

</Tab>

</Tabs>