get https://api.gliderpay.com/glider/report/v1/invoice.json/startDate//endDate/
Given a date range (start and end date time) returns the the list
of all the invoices that have been processed within the date range
Start and end date must be in the following format YYYY-MM-DD
and they will be compared with the invoice process time. All dates are in UTC timezone.
Parameter | Description | Example |
---|---|---|
startDate | Initial date where the query will start | 2017-10-10 |
endDate | Final date where the query will end | 2017-11-11 |
The API response returns an array of invoice objects of which their values are described below:
Name | Description | Example |
---|---|---|
invoiceId | Invoice identification number | 190 |
batchId | Batch identifier number | 50 |
accountNumber | Account number related to the invoice | ABCD1234567 |
invoiceAmount | Amount requested (in dollars) from the invoice | 123.88 |
invoiceStatus | Transaction status of the invoice (not_paid, partially_paid, paid, refunded, partially_refunded, registered) | partially_paid |
overallStatus | Overall status of the invoice (sent clicked, expired, paid, partially_paid, refunded, partially_refunded, plan) | clicked |
url | Total amount of sms sent | 2 |
smsStatus | [DEPRECATED] Total amount of sms delivered | null |
smsUpdateDate | [DEPRECATED] Total amount of sms failed | null |
visits | Total amount of sms pending | 0 |
lastVisit | Total amount of approved transaction | 1 |
transactions | Total amount of declined payments | 0 |
approvedTransactions | Total amount (in dollars) of approved transactions | 200.00 |
declinedTransactions | Total amount of requested receipts from the end-user | 1 |
lastTransaction | Total amount of requested receipts from the end-user | 1 |
totalTransactionsAmount | Total amount of requested receipts from the end-user | 1 |
Total amount of requested receipts from the end-user | 1 | |
receiptDate | Total amount of requested receipts from the end-user | 1 |
handler | Agent ID to be stored for reporting as part of the campaign | Agent1 |
mobileNumber | Recipient contact details (email address, mobile number or empty for link channel) | +61432555666 |
planAmount | User amount plan selection | 800.00 |
planFrequency | User frequency plan selection | weekly |
planStartDate | User start date plan selection | 2023-10-10 |
planRate | Plan interest rate | 1.5 |
instalmentEnabled | Flag to determine if the invoice has instalment option enabled | true |
planMaxTerm | Plan maximum term | 1 |
planMaxTermPeriod | Plan maximum term period (year, month, day) | year |
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 | |
created | Invoice creation time | 2023-10-10 10:00:00 |
updated | Invoice last update time | 2023-10-14 12:02:30 |