Obtener Documentos de una Transacción

Este método permite obtener los documentos de venta asociados a una transacción específica.

1. Método de Acceso

Parámetro

Descripción

URL

https://demo.api.experticket.com/api/transactiondocuments

Verbo HTTP

GET

Formato de Envío

application/json

⚠️ Importante:

  • La longitud máxima permitida de la URL es 2048 caracteres.
  • El identificador de la venta es obligatorio para recuperar los documentos.

 

2. Datos de Envío

Campo

Descripción

ApiKey

Clave única y privada del colaborador.

id

Identificador de la transacción (SaleId).

api-version

Versión de la API a utilizar (por defecto 3.21).

 

3. Ejemplo de Petición

Solicitud con Parámetros en la URL

GET https://demo.api.experticket.com/api/transactiondocuments?ApiKey=xyz123&id=5603191358506446612

4. Estructura de la Respuesta

La respuesta incluirá un listado de documentos asociados a la transacción.

Campo

Descripción

Documents

Array con los documentos de venta.

SalesDocumentUrl

URL pública para descargar el documento.

Success

true si la consulta fue exitosa, false en caso contrario.

Timestamp

Fecha y hora de la respuesta.

ErrorMessage

Motivo del error (si Success = false).

ErrorCodes

Códigos de error en caso de fallo.

 

5. Ejemplo de Respuesta Exitosa

{

    "Documents": [

        {

            "SalesDocumentUrl": "https://demo.api.experticket.com/TransactionDownload/SalesDocument?SaleId=5603191358506446612"

        }

    ],

    "Success": true,

    "Timestamp": "2023-03-30T10:03:08.4461296"

}

6. Ejemplo de Respuesta con Error

{

    "Success": false,

    "ErrorMessage": "No se encontró la transacción especificada.",

    "Timestamp": "2025-02-05T12:30:00.000Z",

    "ErrorCodes": [101],

    "ErrorEntityBreakDown": [

        {

            "Id": "5603191358506446612",

            "Name": "Transaction Not Found"

        }

    ]

}

7. Consideraciones Finales

  • La ApiKey debe mantenerse en secreto y solo debe usarse en el servidor.
  • El id debe corresponder al identificador de la venta (SaleId).
  • Si Success = false, revisar ErrorMessage para entender la causa del error.
  • La SalesDocumentUrl es pública y puede compartirse con el cliente para descargar la factura o comprobante.

¿Te ha parecido útil este artículo?

LEARNING PATHS