LoanSummary
A summary of a loan account.
Field | Data Type | Description |
loanId | string | Required A unique id assigned to the loan on your lending app. For example, a UUID. Limited to 50 characters. Read-only after creation |
principalAmount | number | Required The principal amount for the loan. It must be greater than 0. Read-only after creation |
payableAmount | number | Required The total repayment amount for the loan. It must be greater than 0. Read-only after creation |
paidAmount | number | Required The amount that has actually been paid for a loan out of the payable amount. Read-only after creation |
startDate | string ( Timestamp format ) | Required The date the loan started as per the contract terms. Denoted in ISO format. Example: Read-only after creation |
endDate | string ( Timestamp format ) | Required The date the loan is expected to be fully settled as per the contract terms. Denoted in ISO format. Example: Read-only after creation |
nextPaymentDate | string ( Timestamp format ) | null | Required The date the next loan payment is due e.g the next installment date.
For loans with only a single installment, then this value should be the same as It should be in ISO format. Example: Read-write |
completionDate | string ( Timestamp format ) | null | Required The date the loan was actually fully settled in ISO format. For ongoing loans, set this field to null. Example: Read-write |
assessmentId | string ( Timestamp format ) | null | Required
The weza.io Read-write |
currencyCode | string | The ISO 4217 currency code associated with this loan. The supported currencies are as below.
If left undefined, the currency will be set using the Read-only after creation |
Last updated