Query Loan Statement Summaries

Return a paginated list of matching loan statement summaries.

Request

query Parameters

limit	integer <int32> Maximum results per page. Default to 20, must be between 1 and 500.
page	integer <int32> Page number of results to show (starting at page 1).
sort	string Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.
loanId	Array of strings Filter by loan system identifiers.
loanStatementId	Array of strings Filter by loan statement system identifier
referenceStatementId	Array of strings Filter by reference statement identifier
merchantId	string Filter by merchant identifier
customerId	Array of strings Filter by customer identifier
currency required	string Filter by currency Example: currency=AUD
createdFromInclusive	string <date-time> Return loan activity that was created at or after this timestamp in ISO-8601 format Example: createdFromInclusive=2025-06-26T22:42:43.506398197Z
createdToExclusive	string <date-time> Return loan activity that were created before this timestamp in ISO-8601 format
dueOnFromInclusive	string <date> Return loan activity that is due on or after this date in ISO-8601 format. Example: dueOnFromInclusive=2025-06-26
dueOnToInclusive	string <date> Return loan activity that is due on or before this date in ISO-8601 format.

Responses

200

Matching items sorted as specified

400

401

403

404

405

406

409

422

429

500

503

get/loans/statements

Request samples

Curl
JavaScript

Response samples

application/json

[{"loanStatementId": "lstmt_aF3M4-z6Qgc6IbI3",
"referenceStatementId": "string",
"loanId": "loan_aF3M4-z6Qgc6IbIx",
"referenceLoanId": "string",
"loanAccountName": "string",
"loanProductType": "TradingAccount",
"loanMetadata": { },
"loanTimeZone": "Australia/Sydney",
"customerId": "cust_aF3M3Oz6Qgc6IbIJ",
"referenceCustomerId": "string",
"customerName": "string",
"customerTaxId": "string",
"customerMetadata": { },
"customerAddress": {"unitNumber": "string",
"streetNumber": "string",
"streetName": "string",
"streetType": "string",
"suburb": "string",
"city": "string",
"postalCode": 2000,
"state": "string",
"country": "AU"
},
"billerName": "string",
"billerTaxId": "string",
"billerAddress": {"unitNumber": "string",
"streetNumber": "string",
"streetName": "string",
"streetType": "string",
"suburb": "string",
"city": "string",
"postalCode": 2000,
"state": "string",
"country": "AU"
},
"borrowerMerchantId": "mcht_aF3M3Oz6Qgc6IbII",
"statementStartDate": "2019-08-24",
"statementStartAt": "2019-08-24T14:15:22Z",
"statementEndDate": "2019-08-24",
"statementEndAt": "2019-08-24T14:15:22Z",
"billingDate": "2019-08-24",
"dueDate": "2019-08-24",
"settlementCurrency": "AUD",
"netAmount": 0,
"insuranceAmount": 0,
"taxAmount": 0,
"billedAmount": 0,
"lateFeeAmount": 0,
"lateFeeLineItem": {"entryType": "Charge",
"description": "string",
"netAmount": 0,
"taxAmount": 0,
"totalAmount": 0,
"taxRate": 0,
"taxType": "string",
"originalAmount": {"sourceAmount": 0,
"sourceTaxAmount": 0,
"sourceNetAmount": 0,
"sourceCurrency": "string",
"targetAmount": 0,
"targetTaxAmount": 0,
"targetNetAmount": 0,
"targetCurrency": "string",
"exchangeRate": 0,
"rateUpdatedAt": "2019-08-24T14:15:22Z"
}
},
"outstandingAmount": 0,
"status": "draft",
"totalEntryCount": 0
}
]