Financial document retrieve API
Test endpoint:
https://transact.ti.com/v2/store/orders/T10999999/financial-documents/5999999999/test
Production endpoint:
https://transact.ti.com/v2/store/orders/{Order Number}/financial-documents/{Invoice Number}
The financial document retrieve API provides invoice information for non-Apruve payments and allows you to download PDF copies of your invoices.
What invoices can you access?
- This API retrieves invoices for orders processed and shipped by TI (excluding Apruve payments).
- Invoices become available after TI processes and ships your order.
How to retrieve an invoice:
- Gather information: You’ll need both the order number and the financial document number.
- Find the order number in your order confirmation email or by using the response (get /store/orders/{orderNumber} https://api-portal.ti.com/store-order-api).
- Locate the financial document number in the “invoices” section of the order retrieve response.
- Authenticate: Obtain an access token using your assigned API key and secret.
- Send a request: Make a request to the API including the order number, financial document number and your access token.
- Receive your invoice:
- The API will respond with a success code (200 OK) and a JSON containing the invoice information.
- If you requested a PDF copy, it will be included as a base64 encoded string.
Testing the API:
A testing version of the API is available. The data in the response will return standardized testing example data. For testing, the financialDocumentNumber should always be passed as 5999999999.
Additional notes:
- Invoices for Apruve payments can be accessed directly through your Apruve portal.
- The API is available in push or retrieve implementations. See push notification setup for more information.