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.
Auf welche Rechnungen können Sie zugreifen?
- Diese API ruft Rechnungen für Bestellungen ab, die von TI bearbeitet und versendet werden (mit Ausnahme von Apruve-Zahlungen).
- Die Rechnungen werden verfügbar, nachdem TI Ihre Bestellung bearbeitet und versendet hat.
So können Sie eine Rechnung abrufen:
- Informationen sammeln: Sie benötigen sowohl die Bestellnummer als auch die Nummer des Finanzdokuments.
- Entnehmen Sie die Bestellnummer Ihrer Bestellbestätigungs-E-Mail oder der Antwort (get /store/orders/{orderNumber} https://api-portal.ti.com/store-order-api).
- Suchen Sie die Nummer des Finanzdokuments im Abschnitt „Rechnungen“ der Antwort auf den Bestellungsabruf.
- Authentifizieren: Rufen Sie mit Ihrem zugewiesenen API-Schlüssel und -Geheimnis ein Zugriffstoken ab.
- Anfrage senden: Stellen Sie eine Anfrage an die API, in der die Bestellnummer, der Nummer des Finanzdokuments und Ihr Zugriffstoken enthalten sind.
- Ihre Rechnung erhalten:
- Die API antwortet mit einem Statuscode (200 OK) und einer JSON-Datei mit den Rechnungsinformationen.
- Wenn Sie eine PDF-Kopie angefordert haben, wird sie als base64-kodierte Zeichenfolge aufgenommen.
Testen der API:
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.
Zusätzliche Hinweise:
- Auf Rechnungen für Apruve-Zahlungen können Sie direkt über Ihr Apruve-Portal zugreifen.
- Die API ist in Push- oder Retrieve-Implementierungen verfügbar. Weitere Informationen finden Sie unter Einrichtung von Push-Benachrichtigungen.