API reference

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.

ParameterDescriptionExample
startDateInitial date where the query will start2017-10-10
endDateFinal date where the query will end2017-11-11

The API response returns an array of invoice objects of which their values are described below:

NameDescriptionExample
invoiceIdInvoice identification number190
batchIdBatch identifier number50
accountNumberAccount number related to the invoiceABCD1234567
invoiceAmountAmount requested (in dollars) from the invoice123.88
invoiceStatusTransaction status of the invoice (not_paid, partially_paid, paid, refunded, partially_refunded, registered)partially_paid
overallStatusOverall status of the invoice (sent clicked, expired, paid, partially_paid, refunded, partially_refunded, plan)clicked
urlTotal amount of sms sent2
smsStatus[DEPRECATED] Total amount of sms deliverednull
smsUpdateDate[DEPRECATED] Total amount of sms failednull
visitsTotal amount of sms pending0
lastVisitTotal amount of approved transaction1
transactionsTotal amount of declined payments0
approvedTransactionsTotal amount (in dollars) of approved transactions200.00
declinedTransactionsTotal amount of requested receipts from the end-user1
lastTransactionTotal amount of requested receipts from the end-user1
totalTransactionsAmountTotal amount of requested receipts from the end-user1
emailTotal amount of requested receipts from the end-user1
receiptDateTotal amount of requested receipts from the end-user1
handlerAgent ID to be stored for reporting as part of the campaignAgent1
mobileNumberRecipient contact details (email address, mobile number or empty for link channel)+61432555666
planAmountUser amount plan selection800.00
planFrequencyUser frequency plan selectionweekly
planStartDateUser start date plan selection2023-10-10
planRatePlan interest rate1.5
instalmentEnabledFlag to determine if the invoice has instalment option enabledtrue
planMaxTermPlan maximum term1
planMaxTermPeriodPlan maximum term period (year, month, day)year
customLabel1Invoice custom label 1
customValue1Invoice custom value 1
customLabel2Invoice custom label 2
customValue2Invoice custom value 2
customLabel3Invoice custom label 3
customValue3Invoice custom value 3
createdInvoice creation time2023-10-10 10:00:00
updatedInvoice last update time2023-10-14 12:02:30
Language
Click Try It! to start a request and see the response here!