get https://api.gliderpay.com/glider/report/v1/invoice.json/
Returns extended details of invoice and transaction status given an invoice Id
An invoice number identifier must be specified in the API request, this can be obtained
while creating a new Glider Batch or from a separate Report API.
| Parameter | Description | Example |
|---|---|---|
| invoiceId | Invoice number identifier | 114 |
API response values are described in the table below:
| Name | Description | Example |
|---|---|---|
| invoiceId | Invoice identification number | 114 |
| batchId | Batch identifier number | 50 |
| accountName | Account name related to the invoice. | John Doe |
| accountNumber | Account number related to the invoice. | ABCD1234567 |
| contact | Recipient contact details (email address, mobile number or empty for link channel) | +61432555666 |
| invoiceStatus | Current status of the invoice | paid, partially_paid, not_paid, registered, refunded, partially_refunded |
| url | Invoice unique url | https://pay.gliderpay.com/6VBJJV |
| expirationDate | Invoice expiry time | 2021-05-16 09:03:57 |
| visits | Number of visit events | 4 |
| lastVisit | Date time of the last invoice visit event | 2017-11-14 01:35:33 |
| approvedTransactions | Number of approved transactions | 1 |
| declinedTransactions | Number of declined transactions | 1 |
| lastTransaction | Date time of the last recorded transaction | 2017-11-14 01:40:33 |
| totalTransactionsAmount | Total amount of the last transaction | 94 |
| receiptEmail | Captured email address from a receipt request | [email protected] |
| receiptDate | Date time of a receipt request | 2017-11-14 01:45:33 |
| created | Invoice data time creation | 2017-11-14 01:45:33 |
| updated | Invoice date time last update | 2017-11-14 01:45:33 |
| handler | Invoice handler | bot 1223 |
| attachment | Invoice attachment | |
| customLabel1 | Invoice custom label 1 | |
| customValue1 | Invoice custom value 1 | |
| customLabel2 | Invoice custom label 2 | |
| customValue2 | Invoice custom value 2 | |
| customLabel3 | Invoice custom label 3 | |
| customValue3 | Invoice custom value 3 | |
| planAmount | (if instalment) user amount plan selection | |
| planFrequency | (if instalment) user frequency plan selection | |
| planStartDate | (if instalment) user start date plan selection | |
| planRate | (if instalment) plan interest rate | |
| planEnabled | flag to define if the invoice has been resolved as a plan / instalment | 0 |
| channel | invoice notification channel | {mobile, email, link} |
| transactions | Object with each single transaction details | [] |