- 02 Sep 2024
- 35 Minutes To Read
- Print
- DarkLight
- PDF
Loan Early Repayment Charge Fees
- Updated On 02 Sep 2024
- 35 Minutes To Read
- Print
- DarkLight
- PDF
Description
This extension point in Mortgages allows customers to build functions to calculate the Early Repayment Charge fee to be charged on loan account in case of overpayments before due date. Example: applying a fee when overpayment is made and it exceeds the allowance amount per year limit set on loan account.
Technical contract specification
Extension point ID: LOAN_EARLY_REPAYMENT_CHARGE_FEE_AMOUNT
Input properties
EarlyRepaymentChargeAmountFunctionRequestDto
Name | Type | Availability | Description |
---|---|---|---|
amount | string(number) | Sometimes present | Overpayment paid on which early repayment charge will be calculated |
date | string(date-time) | Sometimes present | Current date on which early repayment charge will be calculated |
ercFreeAllowanceAmount | string(number) | Sometimes present | Erc free allowance Amount |
indexRateSources | [EarlyRepaymentChargeIndexRateSourceDto] | Sometimes present | Index rate source details for loan account |
installments | [EarlyRepaymentChargeInstallmentDto] | Sometimes present | Loan schedule details |
loanAccount | EarlyRepaymentChargeLoanAccountDto | Sometimes present | Loan account info |
loanTransactions | [EarlyRepaymentChargeLoanTransactionDto] | Sometimes present | Loan transaction details |
overpaymentDetails | [OverpaymentDetailsDto] | Sometimes present | list of overpayments made and erc transaction linked to the overpayment |
Output properties
EarlyRepaymentChargeAmountFunctionResponseDto
Name | Type | Availability | Description |
---|---|---|---|
ercFeeAmount | string(number) | Always present | ERC fee amount calculated which will be applied on loan account |
ercFreeAllowanceAmount | string(number) | Always present | ERC fee allowance amount remaining calculated which will be set on loan account. Can return zero if not used by function |
Schemas
AccountArrearsSettingsDTO
The account arrears settings, holds the required information for the arrears settings of an account.
Name | Type | Availability | Description |
---|---|---|---|
dateCalculationMethod | ArrearsDateCalculationMethodDTO | Sometimes present | The arrears date calculation method. |
encodedKey | string | Sometimes present | The encoded key of the arrears base settings, auto generated, unique. |
monthlyToleranceDay | string(number) | Sometimes present | Defines monthly arrears tolerance day value. |
nonWorkingDaysMethod | ArrearsNonWorkingDaysMethodDTO | Sometimes present | Shows whether the non working days are taken in consideration or not when applying penaltees/late fees or when setting an account into arrears |
toleranceCalculationMethod | ArrearsToleranceCalculationMethodDTO | Sometimes present | Defines the tolerance calculation method |
toleranceFloorAmount | string(number) | Sometimes present | The tolerance floor amount. |
tolerancePercentageOfOutstandingPrincipal | string(number) | Sometimes present | Defines the arrears tolerance amount. |
tolerancePeriod | string(number) | Sometimes present | Defines the arrears tolerance period value. |
AccountHolderTypeDTO
Indicated the account holder type.
Enumerated values: CLIENT
| GROUP
AccountInterestRateSettingsDTO
Name | Type | Availability | Description |
---|---|---|---|
encodedKey | string | Sometimes present | The encoded key of the interest rate settings, auto generated, unique |
indexSourceKey | string | Sometimes present | Index rate source key. |
interestRate | string(number) | Sometimes present | Interest rate value. |
interestRateCeilingValue | string(number) | Sometimes present | Maximum value allowed for index based interest rate. Valid only for index interest rate. |
interestRateFloorValue | string(number) | Sometimes present | Minimum value allowed for index based interest rate. Valid only for index interest rate. |
interestRateReviewCount | string(number) | Sometimes present | Interest rate review frequency unit count. Valid only for index interest rate. |
interestRateReviewUnit | InterestRateReviewUnitDTO | Sometimes present | Interest rate review frequency measurement unit. Valid only for index interest rate. |
interestRateSource | InterestRateSourceDTO | Always present | Interest calculation method: fixed or indexed(interest spread + active organization index interest rate) |
interestSpread | string(number) | Sometimes present | Interest spread value. |
validFrom | string(date-time) | Always present | Date since an interest rate is valid |
AmountDTO
Represents a simple installment amount structure.
Name | Type | Availability | Description |
---|---|---|---|
due | string(number) | Sometimes present | The due amount. |
expected | string(number) | Sometimes present | The expected amount, which is sum of paid and due amounts. |
paid | string(number) | Sometimes present | The paid amount. |
AmountWithReducedDTO
Represents a simple installment amount structure.
Name | Type | Availability | Description |
---|---|---|---|
due | string(number) | Sometimes present | The due amount. |
expected | string(number) | Sometimes present | The expected amount, which is sum of paid and due amounts. |
paid | string(number) | Sometimes present | The paid amount. |
reduced | string(number) | Sometimes present | The reduced amount. |
ApplyInterestOnPrepaymentMethodDTO
The apply interest method type for pre-payments.
Enumerated values: AUTOMATIC
| MANUAL
ArrearsDateCalculationMethodDTO
The arrears date calculation method.
Enumerated values: ACCOUNT_FIRST_WENT_TO_ARREARS
| LAST_LATE_REPAYMENT
| ACCOUNT_FIRST_BREACHED_MATERIALITY_THRESHOLD
ArrearsNonWorkingDaysMethodDTO
Shows whether the non working days are taken in consideration or not when applying penaltees/late fees or when setting an account into arrears
Enumerated values: INCLUDED
| EXCLUDED
ArrearsToleranceCalculationMethodDTO
Defines the tolerance calculation method
Enumerated values: ARREARS_TOLERANCE_PERIOD
| MONTHLY_ARREARS_TOLERANCE_DAY
AssetDTO
Name | Type | Availability | Description |
---|---|---|---|
amount | string(number) | Always present | The amount used by the client for the guaranty |
assetName | string | Always present | The name of a value the client guarantees with (populated when the guaranty type is ASSET) |
customFieldKeys | object | Sometimes present | |
customFields | object | Sometimes present | Map of custom field values on account |
depositAccountKey | string | Sometimes present | The key of the deposit account used by the guarantor (populated when the guaranty type is GUARANTOR). It can be null. |
encodedKey | string | Sometimes present | The encoded key of the security, auto generated, unique. |
guarantorKey | string | Sometimes present | The key of the client/group used as the guarantor. |
guarantorType | AccountHolderTypeDTO | Sometimes present | The type of the guarantor (client/group) |
originalAmount | string(number) | Sometimes present | The original amount used by the client for a collateral asset |
originalCurrency | CurrencyDTO | Sometimes present | The currency of the original amount used by the client for the collateral asset |
BalancesDTO
The loan account balance details.
Name | Type | Availability | Description |
---|---|---|---|
feesBalance | string(number) | Sometimes present | The fees balance. Represents the total fees expected to be paid on this account at a given moment. |
feesDue | string(number) | Sometimes present | The fees due. Representing the total fees due for the account. |
feesPaid | string(number) | Sometimes present | The fees paid. Represents the total fees paid for the account. |
holdBalance | string(number) | Sometimes present | The sum of all the authorization hold amounts on this account. |
interestBalance | string(number) | Sometimes present | Represents the total interest owed by the client (total interest applied for account minus interest paid). |
interestDue | string(number) | Sometimes present | The interest due. Indicates how much interest it's due for the account at this moment. |
interestFromArrearsBalance | string(number) | Sometimes present | The interest from arrears balance. Indicates interest from arrears owned by the client, from now on. (total interest from arrears accrued for account - interest from arrears paid). |
interestFromArrearsDue | string(number) | Sometimes present | The interest from arrears due. Indicates how much interest from arrears it's due for the account at this moment. |
interestFromArrearsPaid | string(number) | Sometimes present | The interest from arrears paid, indicates total interest from arrears paid into the account. |
interestPaid | string(number) | Sometimes present | The interest paid, indicates total interest paid into the account. |
penaltyBalance | string(number) | Sometimes present | The penalty balance. Represents the total penalty expected to be paid on this account at a given moment. |
penaltyDue | string(number) | Sometimes present | The penalty due. Represents the total penalty amount due for the account. |
penaltyPaid | string(number) | Sometimes present | The Penalty paid. Represents the total penalty amount paid for the account. |
principalBalance | string(number) | Sometimes present | The total principal owned by the client, from now on (principal disbursed - principal paid). |
principalDue | string(number) | Sometimes present | The principal due, indicates how much principal it's due at this moment. |
principalPaid | string(number) | Sometimes present | The principal paid, holds the value of the total paid into the account. |
redrawBalance | string(number) | Sometimes present | The total redraw amount owned by the client, from now on. |
BillingCycleDaysDTO
Defines the billing cycles settings for a loan account
Name | Type | Availability | Description |
---|---|---|---|
days | [string(number)] | Sometimes present | The billing cycle start days in case it is enabled |
CardAcceptorDTO
The details of the card acceptor (merchant) in a transaction hold.
Name | Type | Availability | Description |
---|---|---|---|
city | string | Sometimes present | The city in which the card acceptor has the business. |
country | string | Sometimes present | The country in which the card acceptor has the business. |
mcc | string(number) | Sometimes present | The Merchant Category Code of the card acceptor. |
name | string | Sometimes present | The name of the card acceptor. |
state | string | Sometimes present | The state in which the card acceptor has the business. |
street | string | Sometimes present | The street in which the card acceptor has the business. |
zip | string | Sometimes present | The ZIP code of the location in which the card acceptor has the business. |
CardTransactionDTO
A card transaction entry which will have a corresponding a financial transaction performed.
Name | Type | Availability | Description |
---|---|---|---|
advice | boolean | Always present | Whether the given request should be accepted without balance validations. |
amount | string(number) | Always present | The amount of money to be withdrawn in the financial transaction. |
cardAcceptor | None | Sometimes present | The card acceptor details. |
cardToken | string | Sometimes present | The reference token of the card. |
currencyCode | string | Sometimes present | The ISO currency code in which the card reversal transaction is posted. The amounts are stored in the base currency, but the transaction can be created with a foreign currency. |
encodedKey | string | Sometimes present | The encoded key of the entity, generated, globally unique |
externalAuthorizationReferenceId | string | Sometimes present | The external authorization hold reference ID, which relates this card transaction to a previous authorization hold. |
externalReferenceId | string | Always present | The external reference ID to be used to reference the card transaction in subsequent requests. |
userTransactionTime | string | Sometimes present | The formatted time at which the user made this card transaction. |
CurrenciesDTO
Fiat(ISO-4217) currency code or NON_FIAT for non fiat currencies.
Enumerated values: AED
| AFN
| ALL
| AMD
| ANG
| AOA
| ARS
| AUD
| AWG
| AZN
| BAM
| BBD
| BDT
| BGN
| BHD
| BIF
| BMD
| BND
| BOB
| BOV
| BRL
| BSD
| BTN
| BWP
| BYR
| BYN
| BZD
| CAD
| CDF
| CHE
| CHF
| CHW
| CLF
| CLP
| CNY
| COP
| COU
| CRC
| CUC
| CUP
| CVE
| CZK
| DJF
| DKK
| DOP
| DZD
| EGP
| ERN
| ETB
| EUR
| FJD
| FKP
| GBP
| GEL
| GHS
| GIP
| GMD
| GNF
| GTQ
| GYD
| HKD
| HNL
| HRK
| HTG
| HUF
| IDR
| ILS
| INR
| IQD
| IRR
| ISK
| JMD
| JOD
| JPY
| KES
| KGS
| KHR
| KMF
| KPW
| KRW
| KWD
| KYD
| KZT
| LAK
| LBP
| LKR
| LRD
| LSL
| LTL
| LVL
| LYD
| MAD
| MDL
| MGA
| MKD
| MMK
| MNT
| MOP
| MRO
| MRU
| MUR
| MVR
| MWK
| MXN
| MXV
| MYR
| MZN
| NAD
| NGN
| NIO
| NOK
| NPR
| NZD
| OMR
| PAB
| PEN
| PGK
| PHP
| PKR
| PLN
| PYG
| QAR
| RON
| RSD
| RUB
| RWF
| SAR
| SBD
| SCR
| SDG
| SEK
| SGD
| SHP
| SLL
| SOS
| SRD
| STD
| STN
| SVC
| SYP
| SZL
| THB
| TJS
| TMT
| TND
| TOP
| TRY
| TTD
| TWD
| TZS
| UAH
| UGX
| USD
| USN
| UYI
| UYU
| UYW
| UZS
| VED
| VEF
| VES
| VND
| VUV
| WST
| XAG
| XAU
| XAF
| XBA
| XBB
| XBC
| XBD
| XCD
| XDR
| XOF
| XPD
| XPF
| XPT
| XSU
| XTS
| XUA
| XXX
| YER
| ZAR
| ZIG
| ZMK
| ZWL
| ZMW
| SSP
| NON_FIAT
CurrencyDTO
Represents a currency eg. USD, EUR.
Name | Type | Availability | Description |
---|---|---|---|
code | CurrenciesDTO | Sometimes present | Fiat(ISO-4217) currency code or NON_FIAT for non fiat currencies. |
currencyCode | string | Sometimes present | Currency code for NON_FIAT currency. |
CustomPaymentAmountDTO
Name | Type | Availability | Description |
---|---|---|---|
amount | string(number) | Always present | The amount of the payment paid in the transaction for the given type. |
customPaymentAmountType | CustomPaymentAmountTypeDTO | Always present | The type of the custom payment |
predefinedFeeKey | string | Sometimes present | The encodedKey of the predefined fee to be paid. |
taxOnAmount | string(number) | Sometimes present | The amount of the taxes paid in the transaction for the given type. |
CustomPaymentAmountTypeDTO
The type of the custom payment
Enumerated values: PRINCIPAL
| INTEREST
| MANUAL_FEE
| UPFRONT_DISBURSEMENT_FEE
| LATE_REPAYMENT_FEE
| PAYMENT_DUE_FEE
| PENALTY
CustomPredefinedFeeDTO
The custom predefined fees, they may be used as the expected predefined fees that will be applied on the disbursement.
Name | Type | Availability | Description |
---|---|---|---|
amount | string(number) | Sometimes present | The amount of the custom fee. |
encodedKey | string | Sometimes present | The encoded key of the custom predefined fee, auto generated, unique. |
percentage | string(number) | Sometimes present | The percentage of the custom fee. |
predefinedFeeEncodedKey | string | Sometimes present | The encoded key of the predefined fee |
CustomPredefinedFeeDTO
The custom predefined fees, they may be used as the expected predefined fees that will be applied on the disbursement.
Name | Type | Availability | Description |
---|---|---|---|
amount | string(number) | Sometimes present | The amount of the custom fee. |
encodedKey | string | Sometimes present | The encoded key of the custom predefined fee, auto generated, unique. |
percentage | string(number) | Sometimes present | The percentage of the custom fee. |
predefinedFeeEncodedKey | string | Sometimes present | The encoded key of the predefined fee |
DaysInMonthDTO
Enumeration for days of month and method of handling shorter months.
Name | Type | Availability | Description |
---|---|---|---|
daysInMonth | [string(number)] | Sometimes present | Specifies the day(s) of the month when the interest application dates should be. Only available if the Interest Application Method is InterestApplicationMethodDTO#FIXED_DAYS_OF_MONTH. Currently only 1 value can be specified. |
shortMonthHandlingMethod | ShortMonthHandlingMethodDTO | Sometimes present | Determines how to handle the short months, if they select a fixed day of month > 28. Will be null if no such date is selected. Only available if the Interest Application Method is InterestApplicationMethodDTO#FIXED_DAYS_OF_MONTH. |
DisbursementDetailsDTO
The the disbursement details it holds the information related to the disbursement details as disbursement date, first repayment date, disbursement fees.
Name | Type | Availability | Description |
---|---|---|---|
disbursementDate | string(date-time) | Sometimes present | The activation date, the date when the disbursement actually took place. |
encodedKey | string | Sometimes present | The encoded key of the disbursement details, auto generated, unique |
expectedDisbursementDate | string(date-time) | Sometimes present | The date of the expected disbursement.Stored as Organization Time. |
fees | [CustomPredefinedFeeDTO] | Sometimes present | List of fees that should be applied at the disbursement time. |
firstRepaymentDate | string(date-time) | Sometimes present | The date of the expected first repayment. Stored as Organization Time. |
transactionDetails | None | Sometimes present | The input details for the disbursement transaction |
EarlyRepaymentChargeIndexRateSourceDto
Name | Type | Availability | Description |
---|---|---|---|
creationDate | string(date-time) | Sometimes present | The creation date of the index rate source |
lastModifiedDate | string(date-time) | Sometimes present | The last date this rate source was modified |
name | string | Sometimes present | The name of the index rate source. |
notes | string | Sometimes present | The notes about the the index rate source. |
type | IndexTypeDTO | Sometimes present | The type of index rate source. |
EarlyRepaymentChargeInstallmentDto
Name | Type | Availability | Description |
---|---|---|---|
dueDate | string(date-time) | Sometimes present | The installment due date. |
fee | InstallmentFeeDTO | Sometimes present | The fee amount that may be applied to the loan account. |
feeDetails | [InstallmentFeesDto] | Sometimes present | The breakdown of the fee amounts that have been applied to the loan account. |
interest | InstallmentAllocationElementTaxableAmountDTO | Sometimes present | The interest amount that is charged for the use of the loan. |
lastPaidDate | string(date-time) | Sometimes present | The installment last paid date. |
number | string | Sometimes present | The order number of an installment among all the installments generated for a loan. Loan installments are put in ascending order by due date. The order number only applies to the content of a particular JSON response therefore it is not unique. |
penalty | InstallmentAllocationElementTaxableAmountDTO | Sometimes present | The penalty amount that can be charged for the loan account. |
principal | InstallmentAllocationElementAmountDTO | Sometimes present | The original loan amount that is disbursed, excluding interest, fees, and penalties. |
repaidDate | string(date-time) | Sometimes present | The installment repaid date. |
state | InstallmentStateDTO | Sometimes present | The installment state. |
EarlyRepaymentChargeLoanAccountDto
Loan account info
Name | Type | Availability | Description |
---|---|---|---|
accountArrearsSettings | AccountArrearsSettingsDTO | Sometimes present | The arrears settings for the loan account. |
accountHolderType | AccountHolderTypeDTO | Always present | The type of the account holder. |
accountState | LoanAccountStateDTO | Sometimes present | The state of the loan account. |
accountSubState | LoanAccountSubStateDTO | Sometimes present | A second state for the loan account. Beside the account state, a second substate is sometimes necessary to provide more information about the exact lifecycle state of a loan account.For example, even if the account state of a loan account is ACTIVE , it can also have a substate of LOCKED . |
accruedInterest | string(number) | Sometimes present | The amount of interest that has been accrued in the loan account. |
accruedPenalty | string(number) | Sometimes present | The accrued penalty, represents the amount of penalty that has been accrued in the loan account. |
allowOffset | boolean | Sometimes present | DEPRECATED - Will always be false. |
approvedDate | string(date-time) | Sometimes present | The date the loan account was approved. |
arrearsTolerancePeriod | string(number) | Sometimes present | The arrears tolerance (period or day of month) depending on the product settings. |
assets | [AssetDTO] | Sometimes present | The list of assets associated with the current loan account. |
balances | BalancesDTO | Sometimes present | The balances details for this loan account. |
closedDate | string(date-time) | Sometimes present | The date the loan was closed. |
creationDate | string(date-time) | Sometimes present | The date the loan account was created. |
currency | CurrencyDTO | Sometimes present | The currency in which the amounts are expressed for this account. |
customFieldValues | object | Sometimes present | Map of custom field values on account |
daysInArrears | string(number) | Sometimes present | The number of days the loan account is in arrears. |
daysLate | string(number) | Sometimes present | The number of days a repayment for the loan account is late. |
disbursementDetails | DisbursementDetailsDTO | Sometimes present | The details regarding the disbursement. |
fundingSources | [InvestorFundDTO] | Sometimes present | The list of funds associated with the loan account. |
futurePaymentsAcceptance | FuturePaymentsMethodDTO | Sometimes present | Shows whether the repayment transactions with entry date set in the future are allowed or not for this loan account. |
guarantors | [GuarantorDTO] | Sometimes present | The list of guarantees associated with the loan account. |
interestAccruedInBillingCycle | string(number) | Sometimes present | The interest that is accrued in the current billing cycle. |
interestCommission | string(number) | Sometimes present | The value of the interest booked by the organization from the accounts funded by investors. Null if the funds are not enabled. |
interestFromArrearsAccrued | string(number) | Sometimes present | The amount of interest from arrears that has been accrued in the loan account. |
interestSettings | InterestSettingsDTO | Sometimes present | The interest settings details for the loan account. |
lastAccountAppraisalDate | string(date-time) | Sometimes present | The date the loan account has last been evaluated for interest, principal, fees, and penalties calculations expressed in the organization time format and time zone. |
lastInterestAppliedDate | string(date-time) | Sometimes present | The date of the last time the loan account had interest applied (stored to interest balance), expressed in the organization time format and time zone. |
lastInterestReviewDate | string(date-time) | Sometimes present | The date the interest was reviewed last time, stored in the organization time format and time zone. |
lastLockedDate | string(date-time) | Sometimes present | The date when the loan account was set for the last time in the LOCKED state expressed in the organization time format and time zone. If null, the account is not locked anymore. |
lastModifiedDate | string(date-time) | Sometimes present | The last date the loan was updated. |
lastSetToArrearsDate | string(date-time) | Sometimes present | The date when the loan account was set to last standing or null; if never set, it is expressed in your organization time format and time zone. |
lastTaxRateReviewDate | string(date-time) | Sometimes present | The date the tax rate on the loan account was last checked, expressed in the organization time format and time zone. |
latePaymentsRecalculationMethod | LatePaymentRecalculationMethodDTO | Sometimes present | The overdue payments recalculation method inherited from the loan product on which this loan account is based. |
loanAmount | string(number) | Always present | The loan amount. |
loanName | string | Sometimes present | The name of the loan account. |
lockedAccountTotalDueType | LockedAccountTotalDueTypeDTO | Sometimes present | The locked account total due type. |
lockedOperations | [LoanAccountOperationTypeDTO] | Sometimes present | A list with operations which are locked when the account is in the AccountState.LOCKED substate. |
modifyInterestForFirstInstallment | boolean | Sometimes present | Adjust the interest for the first repayment when the first repayment period is different than the repayment frequency |
paymentHolidaysAccruedInterest | string(number) | Sometimes present | The amount of interest that has been accrued during payment holidays in the loan account. |
paymentMethod | PaymentMethodDTO | Sometimes present | The interest payment method that determines whether the payments are made horizontally (on the repayments) or vertically (on the loan account). |
penaltySettings | PenaltySettingsDTO | Sometimes present | The penalty settings details of the loan account. |
plannedInstallmentFees | [PlannedInstallmentFeeDTO] | Sometimes present | The list with manual fees planned on the installments of the loan account. |
prepaymentSettings | PrepaymentSettingsDTO | Sometimes present | The prepayment settings details of the loan account. |
principalPaymentSettings | PrincipalPaymentAccountSettingsDTO | Sometimes present | The settings for revolving credit principal payments. |
redrawSettings | LoanAccountRedrawSettingsDTO | Sometimes present | The redraw settings for the loan account. |
scheduleSettings | ScheduleSettingsDTO | Always present | The schedule settings details for the loan account. |
taxRate | string(number) | Sometimes present | The tax rate. |
terminationDate | string(date-time) | Sometimes present | The date this loan account was terminated. |
tranches | [LoanTrancheDetailsDto] | Sometimes present | The list of disbursement tranches available for the loan account. |
EarlyRepaymentChargeLoanTransactionDto
Name | Type | Availability | Description |
---|---|---|---|
accountBalances | TransactionBalancesDTO | Sometimes present | The account balances changed within the transaction. |
adjustmentTransactionKey | string | Sometimes present | The encoded key of the transaction that was adjusted as part of this one. Available only for adjustment transactions. |
affectedAmounts | LoanAffectedAmountsDTO | Sometimes present | The amounts affected after completing the transaction. |
amount | string(number) | Sometimes present | The amount that was added or removed on the loan account. |
bookingDate | string(date-time) | Sometimes present | The date when the corresponding journal entry is booked. |
cardTransaction | CardTransactionDTO | Sometimes present | The card transaction details that correspond to the loan transaction (if applicable). |
creationDate | string(date-time) | Sometimes present | The date when this loan transaction was created. |
currency | CurrencyDTO | Sometimes present | The currency in which the amounts are expressed for the transaction. |
customPaymentAmounts | [CustomPaymentAmountDTO] | Sometimes present | The list of custom amounts which the user has paid as part of this transaction. |
encodedKey | string | Sometimes present | The encoded key of transaction. |
fees | [FeeDTO] | Sometimes present | The amounts that have been applied or paid as part of this transaction and involved predefined fees. |
notes | string | Sometimes present | The notes or description for the loan transaction. |
originalAmount | string(number) | Sometimes present | The amount that was posted in a foreign currency. This amount was converted using the exchange rate available at entry date and set into the amount field. |
originalCurrencyCode | string | Sometimes present | The currency in which this transaction was posted. The amounts are stored in the base currency, but the user may enter it in a foreign currency. |
prepaymentRecalculationMethod | PrepaymentRecalculationMethodDTO | Sometimes present | The prepayment recalculation method of the loan transaction. |
taxes | TaxesDTO | Sometimes present | The taxes applied on the transaction. |
terms | LoanTermsDTO | Sometimes present | Represents specific information related to loan transaction terms. |
type | LoanTransactionTypeDTO | Sometimes present | The type of loan transaction. |
valueDate | string(date-time) | Sometimes present | The date of the entry in the organization time format and timezone. |
ElementsRecalculationMethodDTO
The elements recalculation method types
Enumerated values: PRINCIPAL_EXPECTED_FIXED
| TOTAL_EXPECTED_FIXED
FeeAmountDTO
Represents a fee amount.
Name | Type | Availability | Description |
---|---|---|---|
due | string(number) | Sometimes present | The due amount. |
expected | string(number) | Sometimes present | The expected amount, which is sum of paid and due amounts. |
expectedUnapplied | string(number) | Sometimes present | The expected amount, which is the sum of unapplied fee and planned fee due amounts. |
paid | string(number) | Sometimes present | The paid amount. |
FeeDTO
Name | Type | Availability | Description |
---|---|---|---|
amount | string(number) | Sometimes present | The amount of the fee that was applied/paid in the transaction for the given predefined fee. |
name | string | Sometimes present | The name of the predefined fee |
predefinedFeeKey | string | Always present | The encoded key of the predefined fee, auto generated, unique |
taxAmount | string(number) | Sometimes present | The amount of the taxes on fee that was applied/paid in the transaction. |
trigger | TriggerDTO | Sometimes present | Shows the event that will trigger a fee |
FuturePaymentsMethodDTO
Shows whether the repayment transactions with entry date set in the future are allowed or not for this loan account.
Enumerated values: NO_FUTURE_PAYMENTS
| ACCEPT_FUTURE_PAYMENTS
| ACCEPT_OVERPAYMENTS
GracePeriodTypeDTO
The grace period type for a loan account.
Enumerated values: NONE
| PAY_INTEREST_ONLY
| INTEREST_FORGIVENESS
GuarantorDTO
Name | Type | Availability | Description |
---|---|---|---|
amount | string(number) | Always present | The amount used by the client for the guaranty |
assetName | string | Sometimes present | The name of a value the client guarantees with (populated when the guaranty type is ASSET) |
customFieldKeys | object | Sometimes present | |
customFields | object | Sometimes present | Map of custom field values on account |
depositAccountKey | string | Sometimes present | The key of the deposit account used by the guarantor (populated when the guaranty type is GUARANTOR). It can be null. |
encodedKey | string | Sometimes present | The encoded key of the security, auto generated, unique. |
guarantorKey | string | Always present | The key of the client/group used as the guarantor. |
guarantorType | AccountHolderTypeDTO | Always present | The type of the guarantor (client/group) |
IndexTypeDTO
The type of index rate source.
Enumerated values: INTEREST_RATE
| TAX_RATE
| WITHHOLDING_TAX_RATE
| PRINCIPAL_TAX_RATE
InstallmentAllocationElementAmountDTO
Represents an installment allocation element amount structure.
Name | Type | Availability | Description |
---|---|---|---|
amount | AmountDTO | Sometimes present | The installment allocation element amount. |
InstallmentAllocationElementTaxableAmountDTO
Represents an installment allocation element taxable amount structure.
Name | Type | Availability | Description |
---|---|---|---|
amount | AmountDTO | Sometimes present | The installment allocation element amount. |
tax | AmountDTO | Sometimes present | The taxes amount on the income from the installment allocation element amount. |
InstallmentFeeDTO
Represents an installment fee structure.
Name | Type | Availability | Description |
---|---|---|---|
amount | None | Sometimes present | The installment fee amount. |
tax | AmountDTO | Sometimes present | The taxes amount on the income from the installment fee amount. |
InstallmentFeesDto
Name | Type | Availability | Description |
---|---|---|---|
amount | AmountWithReducedDTO | Sometimes present | The installment allocation element amount. |
name | string | Sometimes present | The name of the fee |
tax | AmountWithReducedDTO | Sometimes present | The taxes amount on the income from the fee details amount. |
InstallmentStateDTO
The installment state.
Enumerated values: PENDING
| LATE
| PAID
| PARTIALLY_PAID
| GRACE
InterestApplicationMethodDTO
The interest application method for a loan account. It shows the method used by the loans defining how the interest gets applied.
Enumerated values: AFTER_DISBURSEMENT
| REPAYMENT_DUE_DATE
| FIXED_DAYS_OF_MONTH
InterestBalanceCalculationMethodDTO
The interest balance calculation method for a loan account. Shows the possible methods for obtaining the balance based on which the interest will be calculated for loan repayment.
Enumerated values: ONLY_PRINCIPAL
| PRINCIPAL_AND_INTEREST
InterestCalculationMethodDTO
The interest calculation method for a loan account. Shows the different interest calculation methods.
Enumerated values: FLAT
| DECLINING_BALANCE
| DECLINING_BALANCE_DISCOUNTED
| EQUAL_INSTALLMENTS
InterestChargeFrequencyMethodDTO
The interest change frequency method for a loan account. Shows the possible methods for obtaining the balance based on which the interest will be calculated for loan repayment.
Enumerated values: ANNUALIZED
| EVERY_MONTH
| EVERY_FOUR_WEEKS
| EVERY_WEEK
| EVERY_DAY
| EVERY_X_DAYS
InterestRateChangePMTAdjustmentThresholdDTO
Represents interest rate change threshold settings for loan accounts and loan products.
Name | Type | Availability | Description |
---|---|---|---|
method | None | Sometimes present | The method used to calculate the interest rate change threshold. Supported value is CALENDAR_DAYS |
numberOfDays | string(number) | Sometimes present | The number of days that trigger an interest rate change. |
InterestRateChangeThresholdMethodDTO
Represents the method used to calculate the interest rate change threshold. Supported value is CALENDAR_DAYS
Enumerated values: WORKING_DAYS
| CALENDAR_DAYS
InterestRateReviewUnitDTO
The interest rate review unit values. Shows how often is index interest rate reviewed.
Enumerated values: DAYS
| WEEKS
| MONTHS
InterestRateSourceDTO
The interest rate review unit values. Shows how often is index interest rate reviewed.
Enumerated values: FIXED_INTEREST_RATE
| INDEX_INTEREST_RATE
InterestSettingsDTO
The interest settings, holds all the properties regarding interests for the loan account.
Name | Type | Availability | Description |
---|---|---|---|
accountInterestRateSettings | [AccountInterestRateSettingsDTO] | Sometimes present | Adjustable interest rates settings for loan account |
accrueInterestAfterMaturity | boolean | Sometimes present | The accrue interest after maturity. If the product support this option, specify if the interest should be accrued after the account maturity date. |
accrueLateInterest | boolean | Sometimes present | Indicates whether late interest is accrued for this loan account |
interestApplicationDays | None | Sometimes present | The day(s) of month on which the interest will be applied and how to handle the short months. |
interestApplicationMethod | None | Sometimes present | The interest application method. Represents the interest application method that determines whether the interest gets applied on the account's disbursement or on each repayment. |
interestBalanceCalculationMethod | None | Sometimes present | The interest balance calculation method. Represents the option which determines the way the balance for the account's interest is computed. |
interestCalculationMethod | None | Sometimes present | The interest calculation method. Holds the type of interest calculation method. |
interestChargeFrequency | None | Sometimes present | The interest change frequency. Holds the possible values for how often is interest charged on loan or deposit accounts |
interestRate | string(number) | Sometimes present | The interest rate. Represents the interest rate for the loan account. The interest on loans is accrued on a daily basis, which allows charging the clients only for the days they actually used the loan amount. |
interestRateChangePMTAdjustmentThreshold | None | Sometimes present | Interest rate change PMT adjustment threshold settings |
interestRateReviewCount | string(number) | Sometimes present | Interest rate update frequency unit count. |
interestRateReviewUnit | InterestRateReviewUnitDTO | Sometimes present | The interest rate review unit. Defines the interest rate update frequency measurement unit. |
interestRateSource | InterestRateSourceDTO | Sometimes present | The interest rate source. Represents the interest calculation method: fixed or (interest spread + active organization index interest rate) |
interestSpread | string(number) | Sometimes present | Interest to be added to active organization index interest rate in order to find out actual interest rate |
interestType | InterestTypeDTO | Sometimes present | The possible values for how we compute and apply the interest |
InterestTypeDTO
The possible values for how we compute and apply the interest
Enumerated values: SIMPLE_INTEREST
| CAPITALIZED_INTEREST
| COMPOUNDING_INTEREST
InvestorFundDTO
Name | Type | Availability | Description |
---|---|---|---|
amount | string(number) | Always present | The amount used by the client for the guaranty |
assetName | string | Sometimes present | The name of a value the client guarantees with (populated when the guaranty type is ASSET) |
depositAccountKey | string | Sometimes present | The key of the deposit account used by the guarantor (populated when the guaranty type is GUARANTOR). It can be null. |
encodedKey | string | Sometimes present | The encoded key of the entity, generated, globally unique |
guarantorKey | string | Always present | The key of the client/group used as the guarantor. |
guarantorType | AccountHolderTypeDTO | Always present | The type of the guarantor (client/group) |
id | string | Sometimes present | Investor fund unique identifier. All versions of an investor fund will have same id. |
interestCommission | string(number) | Sometimes present | The constraint minimum value |
sharePercentage | string(number) | Sometimes present | Percentage of loan shares this investor owns |
LatePaymentRecalculationMethodDTO
The late payment recalculation method. Is used by loan accounts to have the schedule recalculated when late payments are posted on accounts..
Enumerated values: OVERDUE_INSTALLMENTS_INCREASE
| LAST_INSTALLMENT_INCREASE
LoanAccountOperationTypeDTO
Enumerated values: APPLY_INTEREST
| APPLY_FEES
| APPLY_PENALTIES
LoanAccountRedrawSettingsDTO
Represents the redraw settings for a loan account.
Name | Type | Availability | Description |
---|---|---|---|
restrictNextDueWithdrawal | boolean | Always present | TRUE if withdrawing amounts that reduce the next due instalment repayment is restricted, FALSE otherwise. |
LoanAccountStateDTO
All the generic account states applicable to loans.
Enumerated values: PARTIAL_APPLICATION
| PENDING_APPROVAL
| APPROVED
| ACTIVE
| ACTIVE_IN_ARREARS
| CLOSED
LoanAccountSubStateDTO
All the generic account sub states applicable to loans.
Enumerated values: PARTIALLY_DISBURSED
| LOCKED
| LOCKED_CAPPING
| REFINANCED
| RESCHEDULED
| WITHDRAWN
| REPAID
| REJECTED
| WRITTEN_OFF
| TERMINATED
LoanAffectedAmountsDTO
The amounts affected after completing the loan transaction
Name | Type | Availability | Description |
---|---|---|---|
deferredInterestAmount | string(number) | Sometimes present | How much interest pre-paid was added/removed in account, within this transaction (including taxes). |
feesAmount | string(number) | Sometimes present | How much fees was added/removed in account, within this transaction. |
fundersInterestAmount | string(number) | Sometimes present | How much interest is given to the investors, within this transaction (only for p2p products) |
interestAmount | string(number) | Sometimes present | How much interest was added/removed in account, within this transaction (including taxes). If there is any deferred interest amount set in this transaction, that amount should be included in this field. |
interestFromArrearsAmount | string(number) | Sometimes present | How much interest from arrears was added/removed in account, within this transaction (including taxes). |
organizationCommissionAmount | string(number) | Sometimes present | How much interest is given to the organization, within this transaction (only for p2p products) |
paymentHolidaysInterestAmount | string(number) | Sometimes present | How much Payment Holidays interest was added/removed in account, within this transaction (including taxes). |
penaltyAmount | string(number) | Sometimes present | How much penalties was added/removed in account, within this transaction. |
principalAmount | string(number) | Sometimes present | How much principal was added/removed in account, within this transaction. |
LoanPenaltyCalculationMethodDTO
The loan penalty calculation method types
Enumerated values: NONE
| OVERDUE_BALANCE
| OVERDUE_BALANCE_AND_INTEREST
| MAMBU_FUNCTION_OVERDUE_PRINCIPAL
| OUTSTANDING_PRINCIPAL
LoanTermsDTO
The loan transaction terms
Name | Type | Availability | Description |
---|---|---|---|
interestSettings | None | Sometimes present | Groups all fields having interest purpose concerning a transaction |
periodicPayment | string(number) | Sometimes present | The periodic payment value logged when changing it for a Balloon Payments account |
principalPaymentAmount | string(number) | Sometimes present | The principal payment flat amount logged when changing it for a Revolving Credit account |
principalPaymentPercentage | string(number) | Sometimes present | The principal payment percentage value logged when changing it for a Revolving Credit account |
LoanTrancheDetailsDto
Name | Type | Availability | Description |
---|---|---|---|
amount | string(number) | Sometimes present | The amount this tranche has available for disburse |
disbursementDetails | TrancheDisbursementDetailsDTO | Sometimes present | The disbursement details of this tranche |
fees | [CustomPredefinedFeeDTO] | Sometimes present | Fees that are associated with this tranche |
moneyAmount | Money | Sometimes present | |
trancheNumber | string(number) | Sometimes present | Index indicating the tranche number |
LoanTransactionDetailsDTO
Represents the loan transaction details.
Name | Type | Availability | Description |
---|---|---|---|
customFieldKeys | object | Sometimes present | |
customFields | object | Sometimes present | Map of custom field values on account |
encodedKey | string | Sometimes present | The encoded key of the entity, generated, globally unique |
internalTransfer | boolean | Sometimes present | Whether the transaction was transferred between loans or deposit accounts |
targetDepositAccountKey | string | Sometimes present | In case of a transaction to a deposit account this represent the deposit account key to which the transaction was made. |
transactionChannelId | string | Sometimes present | The ID of the transaction channel associated with the transaction details. |
transactionChannelKey | string | Sometimes present | The encoded key of the transaction channel associated with the transaction details. |
LoanTransactionTypeDTO
The type of loan transaction.
Enumerated values: IMPORT
| DISBURSEMENT
| DISBURSEMENT_ADJUSTMENT
| WRITE_OFF
| WRITE_OFF_ADJUSTMENT
| REPAYMENT
| PAYMENT_MADE
| WITHDRAWAL_REDRAW
| WITHDRAWAL_REDRAW_ADJUSTMENT
| FEE_APPLIED
| FEE_CHARGED
| FEES_DUE_REDUCED
| FEE_ADJUSTMENT
| PENALTY_APPLIED
| PENALTY_ADJUSTMENT
| PENALTIES_DUE_REDUCED
| REPAYMENT_ADJUSTMENT
| PAYMENT_MADE_ADJUSTMENT
| INTEREST_RATE_CHANGED
| TAX_RATE_CHANGED
| PENALTY_RATE_CHANGED
| INTEREST_APPLIED
| INTEREST_APPLIED_ADJUSTMENT
| INTEREST_DUE_REDUCED
| PENALTY_REDUCTION_ADJUSTMENT
| FEE_REDUCTION_ADJUSTMENT
| INTEREST_REDUCTION_ADJUSTMENT
| DEFERRED_INTEREST_APPLIED
| DEFERRED_INTEREST_APPLIED_ADJUSTMENT
| DEFERRED_INTEREST_PAID
| DEFERRED_INTEREST_PAID_ADJUSTMENT
| INTEREST_LOCKED
| FEE_LOCKED
| PENALTY_LOCKED
| INTEREST_UNLOCKED
| FEE_UNLOCKED
| PENALTY_UNLOCKED
| REDRAW_TRANSFER
| REDRAW_REPAYMENT
| REDRAW_TRANSFER_ADJUSTMENT
| REDRAW_REPAYMENT_ADJUSTMENT
| TRANSFER
| TRANSFER_ADJUSTMENT
| BRANCH_CHANGED
| TERMS_CHANGED
| CARD_TRANSACTION_REVERSAL
| CARD_TRANSACTION_REVERSAL_ADJUSTMENT
| DUE_DATE_CHANGED
| DUE_DATE_CHANGED_ADJUSTMENT
| ACCOUNT_TERMINATED
| ACCOUNT_TERMINATED_ADJUSTMENT
LockedAccountTotalDueTypeDTO
Type of total due amount for a locked account.
Enumerated values: BALANCE_AMOUNT
| DUE_AMOUNT_ON_LATE_INSTALLMENTS
Money
Name | Type | Availability | Description |
---|---|---|---|
absoluteValue | None | Sometimes present | |
amount | string(number) | Sometimes present | |
negative | boolean | Sometimes present | |
negativeOrZero | boolean | Sometimes present | |
numberOfDecimalDigits | string(number) | Sometimes present | |
positive | boolean | Sometimes present | |
positiveOrZero | boolean | Sometimes present | |
zero | boolean | Sometimes present |
OverpaymentDetailsDto
Name | Type | Availability | Description |
---|---|---|---|
ercAllowanceAmount | string(number) | Sometimes present | The erc free allowance amount |
overPaymentAmount | string(number) | Sometimes present | The overpayment amount paid |
transactionKey | string | Sometimes present |
PaymentMethodDTO
The payment allocation method used by the loans defining how the payments get performed.
Enumerated values: HORIZONTAL
| VERTICAL
PenaltySettingsDTO
The penalty settings, holds all the fields regarding penalties
Name | Type | Availability | Description |
---|---|---|---|
loanPenaltyCalculationMethod | None | Sometimes present | The last penalty calculation method, represents on what amount are the penalties calculated. |
penaltyRate | string(number) | Sometimes present | The penalty rate, represents the rate (in percent) which is charged as a penalty. |
PeriodicPaymentDTO
Name | Type | Availability | Description |
---|---|---|---|
amount | string(number) | Always present | The PMT value used in periodic payment |
encodedKey | string | Sometimes present | The encoded key of the periodic payment, auto generated, unique. |
toInstallment | string(number) | Always present | The installment's position up to which the PMT will be used |
PlannedInstallmentFeeDTO
Name | Type | Availability | Description |
---|---|---|---|
amount | string(number) | Sometimes present | The amount of the planned fee. |
applyOnDate | string(date-time) | Sometimes present | The date when a planned fee should be applied, overriding installment's due date. It should match the interval of the installment. If it belong to first installment, it should be between disbursement date and installment due date. |
encodedKey | string | Sometimes present | The encoded key of the planned installment fee, auto generated, unique. |
installmentKey | string | Sometimes present | The encoded key of the installment on which the predefined fee is planned. |
installmentNumber | string(number) | Sometimes present | The number of the installment on which the predefined fee is planned. It is used only in the case when fees are created at the same time with the loan account creation or during preview schedule, before account creation, otherwise this should be empty and installmentKey will be used to identify an installment. |
predefinedFeeKey | string | Always present | The encoded key of the predefined fee which is planned. |
PrepaymentRecalculationMethodDTO
The prepayment recalculation method types.
Enumerated values: NO_RECALCULATION
| RESCHEDULE_REMAINING_REPAYMENTS
| RECALCULATE_SCHEDULE_KEEP_SAME_NUMBER_OF_TERMS
| RECALCULATE_SCHEDULE_KEEP_SAME_PRINCIPAL_AMOUNT
| RECALCULATE_SCHEDULE_KEEP_SAME_TOTAL_REPAYMENT_AMOUNT
| REDUCE_AMOUNT_PER_INSTALLMENT
| REDUCE_NUMBER_OF_INSTALLMENTS
| REDUCE_NUMBER_OF_INSTALLMENTS_NEW
PrepaymentSettingsDTO
The prepayment settings, holds all prepayment properties.
Name | Type | Availability | Description |
---|---|---|---|
applyInterestOnPrepaymentMethod | None | Sometimes present | Apply interest on prepayment method copied from loan product on which this account is based. |
elementsRecalculationMethod | None | Sometimes present | The elements recalculation method, indicates how the declining balance with equal installments repayments are recalculated. |
prepaymentRecalculationMethod | PrepaymentRecalculationMethodDTO | Sometimes present | Prepayment recalculation method copied from the loan product on which this account is based. |
principalPaidInstallmentStatus | None | Sometimes present | Installment status for the case when principal is paid off (copied from loan product). |
PrincipalPaidInstallmentStatusDTO
The status of installment after the principal was paid off as part of an over-payment.
Enumerated values: PARTIALLY_PAID
| PAID
| ORIGINAL_TOTAL_EXPECTED_PAID
PrincipalPaymentAccountSettingsDTO
The principal payment account settings, holds the required information for the principal payment process of an account.
Name | Type | Availability | Description |
---|---|---|---|
amount | string(number) | Sometimes present | Fixed amount for being used for the repayments principal due. |
encodedKey | string | Sometimes present | The encoded key of the principal payment base settings, auto generated, unique. |
includeFeesInFloorAmount | boolean | Sometimes present | Boolean flag, if true, the fees will be included along with the principal in the repayment floor amount, for a revolving credit account |
includeInterestInFloorAmount | boolean | Sometimes present | Boolean flag, if true, the interest will be included along with the principal in the repayment floor amount, for a revolving credit account |
percentage | string(number) | Sometimes present | Percentage of principal amount used for the repayments principal due. |
principalCeilingValue | string(number) | Sometimes present | The maximum principal due amount a repayment made with this settings can have |
principalFloorValue | string(number) | Sometimes present | The minimum principal due amount a repayment made with this settings can have |
principalPaymentMethod | PrincipalPaymentMethodDTO | Sometimes present | The method of principal payment for revolving credit. |
totalDueAmountFloor | string(number) | Sometimes present | The minimum total due amount a repayment made with this settings can have |
totalDuePayment | PrincipalPaymentMethodDTO | Sometimes present | The method of total due payment for revolving credit |
PrincipalPaymentMethodDTO
The principal payment method (for revolving credits)
Enumerated values: FLAT
| OUTSTANDING_PRINCIPAL_PERCENTAGE
| PRINCIPAL_PERCENTAGE_LAST_DISB
| TOTAL_BALANCE_PERCENTAGE
| TOTAL_BALANCE_FLAT
| TOTAL_PRINCIPAL_PERCENTAGE
RepaymentPeriodUnitDTO
The frequency of the loan repayment.
Enumerated values: DAYS
| WEEKS
| MONTHS
| YEARS
RepaymentScheduleMethodDTO
The method used by the loans to compute the repayment schedule.
Enumerated values: NONE
| FIXED
| DYNAMIC
RevolvingAccountSettingsDTO
The number of previewed instalments for an account
Name | Type | Availability | Description |
---|---|---|---|
numberOfPreviewedInstalments | string(number) | Sometimes present | The number of previewed instalments |
ScheduleDueDatesMethodDTO
The schedule due dates method. Used by the loan accounts to determine the due dates of the repayments.
Enumerated values: INTERVAL
| FIXED_DAYS_OF_MONTH
ScheduleSettingsDTO
The schedule settings, holds all schedule properties.
Name | Type | Availability | Description |
---|---|---|---|
billingCycle | None | Sometimes present | The billing cycle start days. |
defaultFirstRepaymentDueDateOffset | string(number) | Sometimes present | The default first repayment due date offset, indicates how many days the first repayment due date should be extended(all other due dates from the schedule are relative to first repayment due date - they will also be affected by the offset) |
fixedDaysOfMonth | [string(number)] | Sometimes present | Specifies the days of the month when the repayment due dates should be. Only available if the Repayment Methodology is FIXED_DAYS_OF_MONTH. |
gracePeriod | string(number) | Always present | The grace period. Represents the grace period for loan repayment - in number of installments. |
gracePeriodType | None | Sometimes present | The grace period type. Representing the type of grace period which is possible for a loan account. |
hasCustomSchedule | boolean | Sometimes present | Flag used when the repayments schedule for the current account was determined by the user, by editing the due dates or the principal due |
paymentPlan | [PeriodicPaymentDTO] | Sometimes present | A list of periodic payments for the current loan account. |
periodicPayment | string(number) | Sometimes present | The periodic payment amount for the accounts which have balloon payments or Reduce Number of Installments and Optimized Payments |
previewSchedule | None | Sometimes present | The number of previewed instalments. |
principalRepaymentInterval | string(number) | Sometimes present | The principal repayment interval. Indicates the interval of repayments that the principal has to be paid. |
repaymentInstallments | string(number) | Sometimes present | The repayment installments. Represents how many installments are required to pay back the loan. |
repaymentPeriodCount | string(number) | Sometimes present | The repayment period count. Represents how often the loan is to be repaid: stored based on the type repayment option. |
repaymentPeriodUnit | None | Sometimes present | The repayment period unit. Represents the frequency of loan repayment. |
repaymentScheduleMethod | None | Sometimes present | The repayment schedule method. Represents the method that determines whether the schedule will be fixed all over the loan account's life cycle or will be dynamically recomputed when required. |
scheduleDueDatesMethod | None | Sometimes present | The schedule due dates method. Represents the methodology used by this account to compute the due dates of the repayments. |
shortMonthHandlingMethod | ShortMonthHandlingMethodDTO | Sometimes present | The short handling method. Determines how to handle the short months, if they select a fixed day of month > 28. Will be null if no such date is selected and also for the Interval methodology. Only available if the Repayment Methodology is FIXED_DAYS_OF_MONTH. |
ShortMonthHandlingMethodDTO
The short month handling method type for a loan account.
Enumerated values: LAST_DAY_IN_MONTH
| FIRST_DAY_OF_NEXT_MONTH
TaxesDTO
The taxes applied within a transaction.
Name | Type | Availability | Description |
---|---|---|---|
deferredTaxOnInterestAmount | string(number) | Sometimes present | How much taxes on the interest that was pre-paid were added/removed in account, within this transaction. If there is any deferred tax on interest amount set in this transaction, that amount should be included in this field. |
taxOnFeesAmount | string(number) | Sometimes present | How much taxes on the fees that were paid in this transaction were added/removed in account, within this transaction. |
taxOnInterestAmount | string(number) | Sometimes present | How much taxes on the interest that was paid in this transaction were added/removed in account, within this transaction. |
taxOnInterestFromArrearsAmount | string(number) | Sometimes present | The amount of taxes on the interest from arrears that were applied/paid in account, within this transaction. |
taxOnPaymentHolidaysInterest | string(number) | Sometimes present | The amount of taxes on the Payment Holidays interest that were added/removed in account, within this transaction. |
taxOnPenaltyAmount | string(number) | Sometimes present | How much taxes on the penalties that were paid in this transaction were added/removed in account, within this transaction. |
taxRate | string(number) | Sometimes present | The tax rate that was set or changed in this transaction. |
TrancheDisbursementDetailsDTO
The disbursement details regarding a loan tranche.
Name | Type | Availability | Description |
---|---|---|---|
disbursementTransactionKey | string | Sometimes present | The key of the disbursement transaction logged when this tranche was disbursed. This field will be null until the tranche disbursement |
expectedDisbursementDate | string(date-time) | Sometimes present | The date when this tranche is supposed to be disbursed (as Organization Time) |
TransactionBalancesDTO
The balances changed within a transaction.
Name | Type | Availability | Description |
---|---|---|---|
advancePosition | string(number) | Sometimes present | Captures the advance (prepaid) amount. |
arrearsPosition | string(number) | Sometimes present | Captures the arrears position amount for the account in arrears. |
expectedPrincipalRedraw | string(number) | Sometimes present | The difference between principal balance and redraw balance after each transaction performed on the loan account. |
principalBalance | string(number) | Sometimes present | The account redraw balance captured after the transaction update. |
redrawBalance | string(number) | Sometimes present | The account redraw balance captured after the transaction update. |
totalBalance | string(number) | Sometimes present | The running balance still owed for the loan. |
TransactionInterestSettingsDTO
The interest settings, holds all the properties regarding interests for the loan account.
Name | Type | Availability | Description |
---|---|---|---|
indexInterestRate | string(number) | Sometimes present | The value of the index interest rate |
interestRate | string(number) | Sometimes present | The interest rate. Represents the interest rate for the loan account. The interest on loans is accrued on a daily basis, which allows charging the clients only for the days they actually used the loan amount. |
TriggerDTO
Shows the event that will trigger a fee
Enumerated values: MANUAL
| MANUAL_PLANNED
| DISBURSEMENT
| CAPITALIZED_DISBURSEMENT
| UPFRONT_DISBURSEMENT
| LATE_REPAYMENT
| PAYMENT_DUE
| PAYMENT_DUE_APPLIED_ON_DUE_DATES
| ARBITRARY
| IOF
| EARLY_REPAYMENT_CHARGE