Get Loan Statement Summary

Return a loan statement summary.

Request

path Parameters

loanStatementId

required

string

Responses

200

400

401

403

404

405

406

409

422

429

500

503

get/loans/statements/{loanStatementId}

Request samples

Curl
JavaScript

Response samples

application/json

{"loanStatementId": "lstmt_aJoljbRcBEDHe8mr",
"referenceStatementId": "string",
"loanId": "loan_aJoljLRcBEDHe8ml",
"referenceLoanId": "string",
"loanAccountName": "string",
"loanProductType": "TradingAccount",
"loanMetadata": { },
"loanTimeZone": "Australia/Sydney",
"customerId": "cust_aJolhbRcBEDHe8l8",
"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"
},
"billerSupportEmailAddress": "lucy.diamond@star.com",
"billerPhoneNumber": "+61401234567",
"borrowerMerchantId": "mcht_aJolhbRcBEDHe8l7",
"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,
"paidAmount": 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,
"paymentEvents": [{"timestamp": "2019-08-24T14:15:22Z",
"amount": 0,
"user": "string"
}
],
"status": "draft",
"totalEntryCount": 0,
"createdAt": "2019-08-24T14:15:22Z"
}