Obtener Facturas Simplificadas

Este método permite obtener las facturas simplificadas de las transacciones compradas a través de la taquilla de Colaborador

1. Método de Acceso

Parámetro

Descripción

URL (Versión 3.60)

{baseurl}/api/simplifiedinvoice?api-version=3.60

Verbo HTTP

POST

Formato de Envío

application/json

 

2. Datos de Envío

Para obtener las facturas simplificadas, se deben enviar los siguientes parámetros:

Campo

Descripción

SaleId

ID de la venta, obtenido tras la creación de la transacción.

PartnerSaleId

ID interno asignado por Colaborador

FromDate

Fecha de inicio del filtro (ISO 8601: yyyy-MM-dd). No puede ser menor al día actual.

ToDate

Fecha de fin del filtro (ISO 8601: yyyy-MM-dd). Por defecto, un año desde el día actual.

 

3. Ejemplo de Petición

curl -X POST "{baseurl}/api/simplifiedinvoice?api-version=3.60" \

     -H "Content-Type: application/json" \

     -d '{

          "SaleId": "12345",

          "PartnerSaleId": "ABC987",

          "FromDate": "2025-02-05",

          "ToDate": "2025-12-31"

        }'

También puedes hacer la solicitud desde Postman o cualquier cliente HTTP con el siguiente cuerpo JSON:

 

{

    "SaleId": "12345",

    "PartnerSaleId": "ABC987",

    "FromDate": "2025-02-05",

    "ToDate": "2025-12-31"

}

4. Estructura de la Respuesta

La API devolverá una lista de facturas simplificadas con los detalles de cada una.

Campo

Descripción

SimplifiedInvoices

Lista de facturas simplificadas.

PartnerId

ID del colaborador en Colaborador

SaleId

Identificador de la venta.

PartnerSaleId

ID interno de la venta asignado por Colaborador

Number

Número de la factura simplificada.

CreatedDate

Fecha de creación de la factura simplificada.

Originals

Lista de facturas simplificadas originales.

Success

true si la llamada fue exitosa.

Timestamp

Fecha y hora de la solicitud procesada.

ErrorMessage

Mensaje de error si la solicitud falla.

ErrorCodes

Códigos de error en caso de problemas.

 

5. Ejemplo de Respuesta Exitosa

{

    "SimplifiedInvoices": [

        {

            "PartnerId": "{partnerId}",

            "SaleId": "12345",

            "PartnerSaleId": "ABC987",

            "Number": "INV-20250205-001",

            "CreatedDate": "2025-02-05T10:00:00Z",

            "Originals": [

                {

                    "Number": "INV-20250205-001-ORIGINAL",

                    "CreatedDate": "2025-02-05T10:00:00Z"

                }

            ]

        }

    ],

    "Success": true,

    "Timestamp": "2025-02-05T15:30:00.000Z"

}

6. Ejemplo de Respuesta con Error

Si la SaleId no existe o no se encuentran facturas simplificadas, la API devolverá un error:

{

    "Success": false,

    "ErrorMessage": "No se encontraron facturas simplificadas para la venta especificada.",

    "Timestamp": "2025-02-05T15:32:00.000Z"

}

7. Consideraciones Finales

  • El SaleId y el PartnerSaleId deben ser correctos para obtener facturas.
  • Las fechas FromDateToDate no pueden ser menores al día actual.
  • Si no hay facturas dentro del rango de fechas, la respuesta indicará un error.
  • Las facturas pueden tener versiones originales, reflejadas en el campo Originals.

¿Te ha parecido útil este artículo?