API de recuperación de documentos financieros
Punto final de la prueba:
https://transact.ti.com/v2/store/orders/T10999999/financial-documents/5999999999/test
Punto final de producción:
https://transact.ti.com/v2/store/orders/{Order Number}/financial-documents/{Invoice Number}
La API de recuperación de documentos financieros proporciona información de facturas para pagos que no son de Apruve y le permite descargar copias en PDF de sus facturas. Las facturas estarán disponibles después de que TI procese y envíe el pedido. Para recuperar una factura mediante la interfaz de programación de aplicaciones (API) de recuperación financiera, son necesarios el número de pedido y el número de documento financiero para la solicitud. Puede encontrar el número de documento financiero en la sección de "facturas" en la respuesta de recuperación de pedidos (get /store/orders/{orderNumber} https://api-portal.ti.com/store-order-api). Para recuperar un PDF, consulte las especificaciones para ver las opciones de configuración. Esta API está disponible en implementaciones de inserción o recuperación. La API push enviará un webhook a su sistema en tiempo real para notificar que sus documentos financieros están listos y se puede utilizar para activar flujos de automatización. Consulte la configuración de notificaciones push para obtener más información.
Para las facturas que utilizan Apruve como método de pago, navegue hasta su portal de Apruve para obtener su factura directamente.
Flujo de recuperación de documentos financieros
- Después de que se generen los documentos financieros, autentifíquese con su clave de API y palabra secreta.
- Una vez que haya recibido su token de acceso, envíe una solicitud que incluya el número de pedido y el número de documento. Se pueden realizar varias solicitudes en la misma sesión con el token de acceso siempre que el token no haya caducado.
- La API responderá con un código de estado, 200 OK y un JSON que contenga el acuse de recibo del pedido.
- Si se solicitó un PDF, se incluirá en el JSON como una cadena codificada en base64.
Una versión de prueba de la API está disponible. Los datos de la respuesta devolverán datos de ejemplo de pruebas estandarizadas. Para las pruebas, el campo financialDocumentNumber (número de documento financiero) siempre se debe pasar como 5999999999.
Ejemplo de solicitud: