Retrieve-API – Finanzdokument
Test-Endpunkt:
https://transact.ti.com/v2/store/orders/T10999999/financial-documents/5999999999/test
Produktionsendpunkt:
https://transact.ti.com/v2/store/orders/{Order Number}/financial-documents/{Invoice Number}
Die Retrieve-API für Finanzdokumentente liefert Rechnungsinformationen für Nicht-Apruve-Zahlungen und ermöglicht das Herunterladen von PDF-Kopien Ihrer Rechnungen. Die Rechnungen werden verfügbar, nachdem TI die Bestellung bearbeitet und versendet hat. Um eine Rechnung mit der Retrieve-API für Finanzdokumente abzurufen, werden die Bestellnummer und die Finanzdokumentnummer für die Anforderung benötigt. Die Nummer des Finanzdokuments finden Sie im Abschnitt „Rechnungen“ der Antwort auf die Bestellung (get /store/orders/{orderNumber} https://api-portal.ti.com/store-order-api). Um eine PDF-Datei abzurufen,sehen Sie sich die Konfigurationsoptionen unten an. Diese API ist sowohl als Push- als auch als Pull-Implementierung verfügbar. Die Push-API sendet in Echtzeit einen Webhook an Ihr System, um Sie zu benachrichtigen, dass Ihre Finanzdokumente bereit sind. Weitere Informationen finden Sie unter „Einrichtung von Push-Benachrichtigungen“.
Für Rechnungen, die Apruve als Zahlungsmethode verwenden, navigieren Sie zu Ihrem Apruve-Portal, um Ihre Rechnung direkt zu erhalten.
Ablauf des Abrufs von Finanzdokumenten
- Nachdem die Finanzdokumente erstellt wurden: Authentifizieren Sie sich mit Ihrem zugewiesenen API-Schlüssel und -Kennwort.
- Nachdem Sie das Zugriffstoken erhalten haben, senden Sie eine Anfrage mit der Bestellnummer und der Dokumentennummer. In derselben Sitzung können mehrere Anforderungen mit dem Zugriffstoken gestellt werden, solange es noch nicht abgelaufen ist.
- Die API antwortet mit dem Statuscode „200 OK“ und einem JSON-String mit den Dokumentinformationen.
- Wenn eine PDF-Datei angefordert wurde, wird diese als base64-codierte Zeichenfolge in den JSON-String eingefügt.
Eine Testversion der API ist verfügbar. Die Daten in der Antwort geben standardisierte Testbeispieldaten zurück. Zu Testzwecken sollte financialDocumentNumber immer als 5999999999 übergeben werden.
Beispielanforderung: