Productoffsetsettingsapiv1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for isOffsetEnabled in ProductOffsetSettingsApiV1
loanProduct object
Description for loanProduct in ProductOffsetSettingsApiV1
Description for accountInitialState in LoanProductApiV1
Possible values: [WITHDRAWN, PARTIALLY_DISBURSED, LOCKED, ACTIVE, CLOSED, PARTIAL_APPLICATION, LOCKED_CAPPING, CLOSED_REJECTED, RESCHEDULED, ACTIVE_IN_ARREARS, MATURED, CLOSED_RESCHEDULED, CLOSED_WITHDRAWN, PENDING_APPROVAL, APPROVED, REFINANCED, DORMANT, CLOSED_WRITTEN_OFF]
Description for accountLinkingEnabled in LoanProductApiV1
Description for accountingMethod in LoanProductApiV1
Possible values: [NONE, CASH, ACCRUAL]
Description for accrueLateInterest in LoanProductApiV1
Description for activated in LoanProductApiV1
Description for allowArbitraryFees in LoanProductApiV1
Description for allowCustomRepaymentAllocation in LoanProductApiV1
Description for amortizationMethod in LoanProductApiV1
Possible values: [PAYMENT_PLAN, BALLOON_PAYMENTS, STANDARD_PAYMENTS, OPTIMIZED_PAYMENTS]
Description for applyInterestOnPrepaymentMethod in LoanProductApiV1
Possible values: [AUTOMATIC, MANUAL]
arrearsSettings object
Description for arrearsSettings in LoanProductApiV1
Description for dateCalculationMethod in ProductArrearsSettingsApiV1
Possible values: [DATE_OF_LAST_LATE_REPAYMENT, DATE_ACCOUNT_FIRST_WENT_TO_ARREARS]
Description for defaultTolerancePeriod in ProductArrearsSettingsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for maxTolerancePeriod in ProductArrearsSettingsApiV1
Description for minTolerancePeriod in ProductArrearsSettingsApiV1
Description for monthlyToleranceDay in ProductArrearsSettingsApiV1
Description for nonWorkingDaysMethod in ProductArrearsSettingsApiV1
Possible values: [EXCLUDED, INCLUDED]
Description for toleranceCalculationMethod in ProductArrearsSettingsApiV1
Possible values: [MONTHLY_ARREARS_TOLERANCE_DAY, ARREARS_TOLERANCE_PERIOD]
Description for autoCreateLinkedAccounts in LoanProductApiV1
Description for autoLinkAccounts in LoanProductApiV1
availableProductBranches object[]
Description for availableProductBranches in LoanProductApiV1
Description for branchKey in LoanProductBranchApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472product object
Description for product in LoanProductBranchApiV1
Description for cappingApplyAccruedChargesBeforeLocking in LoanProductApiV1
Description for cappingConstraintType in LoanProductApiV1
Possible values: [SOFT_CAP, HARD_CAP]
Description for cappingMethod in LoanProductApiV1
Possible values: [OUTSTANDING_PRINCIPAL_PERCENTAGE, ORIGINAL_PRINCIPAL_PERCENTAGE]
Description for cappingPercentage in LoanProductApiV1
the date and time when this loan product was created
Description for daysInYear in LoanProductApiV1
Possible values: [E30_42_365, ACTUAL_365_FIXED, ACTUAL_360, E30_360, ACTUAL_364, ACTUAL_ACTUAL_ISDA]
Description for defaultFirstRepaymentDueDateOffset in LoanProductApiV1
Description for defaultGracePeriod in LoanProductApiV1
Description for defaultLoanAmount in LoanProductApiV1
Description for defaultNumInstallments in LoanProductApiV1
Description for defaultPenaltyRate in LoanProductApiV1
Description for defaultPrincipalRepaymentInterval in LoanProductApiV1
Description for defaultRepaymentPeriodCount in LoanProductApiV1
Description for dormancyPeriodDays in LoanProductApiV1
Description for elementsRecalculationMethod in LoanProductApiV1
Possible values: [FIXED_PRINCIPAL_EXPECTED, FIXED_TOTAL_EXPECTED]
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for fixedDaysOfMonth in LoanProductApiV1
Description for forAllBranches in LoanProductApiV1
Description for forHybridGroups in LoanProductApiV1
Description for forIndividuals in LoanProductApiV1
Description for forPureGroups in LoanProductApiV1
Description for futurePaymentsAcceptance in LoanProductApiV1
Possible values: [ACCEPT_OVERPAYMENTS, NO_FUTURE_PAYMENTS, ACCEPT_FUTURE_PAYMENTS]
Description for gracePeriodType in LoanProductApiV1
Possible values: [PAY_INTEREST_ONLY, NONE, INTEREST_FORGIVENESS]
Description for id in LoanProductApiV1
Description for idGeneratorType in LoanProductApiV1
Possible values: [INCREMENTAL_NUMBER, RANDOM_PATTERN]
Description for idPattern in LoanProductApiV1
Description for interestAccrualCalculation in LoanProductApiV1
Possible values: [BREAKDOWN_PER_ACCOUNT, AGGREGATED_AMOUNT, NONE]
Description for interestAccruedAccountingMethod in LoanProductApiV1
Possible values: [DAILY, END_OF_MONTH, NONE]
Description for interestApplicationMethod in LoanProductApiV1
Possible values: [ON_REPAYMENT, ON_DISBURSEMENT]
Description for interestBalanceCalculationMethod in LoanProductApiV1
Possible values: [PRINCIPAL_ONLY, PRINCIPAL_AND_INTEREST]
Description for interestCalculationMethod in LoanProductApiV1
Possible values: [DECLINING_BALANCE, DECLINING_BALANCE_DISCOUNTED, FLAT]
interestRateSettings object
Description for interestRateSettings in LoanProductApiV1
Description for accrueInterestAfterMaturity in InterestProductSettingsApiV1
Description for defaultInterestRate in InterestProductSettingsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for indexSourceKey in InterestProductSettingsApiV1
Description for interestChargeFrequency in InterestProductSettingsApiV1
Possible values: [EVERY_WEEK, ANNUALIZED, EVERY_MONTH, EVERY_X_DAYS, EVERY_FOUR_WEEKS, EVERY_DAY]
Description for interestChargeFrequencyCount in InterestProductSettingsApiV1
Description for interestRateCeilingValue in InterestProductSettingsApiV1
Description for interestRateFloorValue in InterestProductSettingsApiV1
Description for interestRateReviewCount in InterestProductSettingsApiV1
Description for interestRateReviewUnit in InterestProductSettingsApiV1
Possible values: [MONTHS, WEEKS, DAYS]
Description for interestRateSource in InterestProductSettingsApiV1
Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]
Description for interestRateTerms in InterestProductSettingsApiV1
Possible values: [TIERED_PERIOD, FIXED, TIERED]
interestRateTiers object[]
Description for interestRateTiers in InterestProductSettingsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for endingBalance in InterestRateTierApiV1
Description for endingDay in InterestRateTierApiV1
Description for index in InterestRateTierApiV1
Description for interestRate in InterestRateTierApiV1
Description for maxInterestRate in InterestProductSettingsApiV1
Description for minInterestRate in InterestProductSettingsApiV1
Description for interestType in LoanProductApiV1
Possible values: [CAPITALIZED_INTEREST, SIMPLE_INTEREST]
the date on which this loan product was last modified
Description for latePaymentsRecalculationMethod in LoanProductApiV1
Possible values: [INCREASE_OVERDUE_INSTALLMENTS, INCREASE_LAST_INSTALLMENT]
Description for lineOfCreditRequirement in LoanProductApiV1
Possible values: [OPTIONAL, NOT_REQUIRED, REQUIRED]
Description for linkableSavingsProductKey in LoanProductApiV1
loanFees object[]
Description for loanFees in LoanProductApiV1
Description for active in PredefinedFeeApiV1
amortizationIntervalSettings object
Description for amortizationIntervalSettings in PredefinedFeeApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for frequency in PeriodIntervalSettingsApiV1
Possible values: [ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING, ACCOUNT_INSTALLMENTS_DUE_DATES, CUSTOM_INTERVAL]
Description for intervalCount in PeriodIntervalSettingsApiV1
Description for intervalType in PeriodIntervalSettingsApiV1
Possible values: [FULL_TERM, PREDEFINED_INTERVALS]
Description for periodCount in PeriodIntervalSettingsApiV1
Description for periodUnit in PeriodIntervalSettingsApiV1
Possible values: [MONTHS, YEARS, WEEKS, DAYS]
Description for amortizationProfile in PredefinedFeeApiV1
Possible values: [STRAIGHT_LINE, SUM_OF_YEARS_DIGITS, EFFECTIVE_INTEREST_RATE, NONE]
Description for amount in PredefinedFeeApiV1
Description for amountCalculationMethod in PredefinedFeeApiV1
Possible values: [LOAN_AMOUNT_PERCENTAGE, LOAN_AMOUNT_PERCENTAGE_NUMBER_OF_INSTALLMENTS, REPAYMENT_PRINCIPAL_AMOUNT_PERCENTAGE, FLAT_NUMBER_OF_INSTALLMENTS, FLAT]
Description for applyDateMethod in PredefinedFeeApiV1
Possible values: [MONTHLY_FROM_ACTIVATION, FIRST_OF_EVERY_MONTH]
the date and time when this fee was created
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for feeAmortizationUponRescheduleOption in PredefinedFeeApiV1
Possible values: [CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT, END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT]
Description for feeApplication in PredefinedFeeApiV1
Possible values: [OPTIONAL, REQUIRED]
feeProductRules object[]
Description for feeProductRules in PredefinedFeeApiV1
account object
Description for account in GLAccountingRuleApiV1
whether this general ledger account is in use
whether manual entries are allowed for this general ledger account
the current balance of this general ledger account
the date on which this general ledger account was created
currency object
Description for currency in GLAccountApiV1
the three letter ISO code for this currency
the date on which this currency was created
indicates where the currency symbol should appear in relation to the numeric value
Possible values: [AFTER_NUMBER, BEFORE_NUMBER]
indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.
whether this currency is the base currency for your banking institution
the date on which this currency was last modified
the name of this currency
the currency symnbol used for this currency
an optional description for this general ledger account
the encoded key of this general ledger account
the numeric code for this general ledger account
the date on which this general ledger account was last modified
migrationEvent object
Description for migrationEvent in GLAccountApiV1
the date on which the data import was made
the encoded key of this data migration event
the number of centres which were imported during the data migration
the number of clients which were imported as part of the data migration
the number of general ledger accounts which were imported as part of the data migration
the number of groups which were imported as part of the data migration
the number of loan repayment transations which were imported as part of the data migration
the number of loan transactions which were imported as part of the data migration
the number of loan accounts which were imported as part of the data migration
the number of savings accounts which were imported as part of the data migration
whether the data import was accepted, is still in a draft state, or was rejected and all data reverted
Possible values: [REVERTED, DRAFT, APPROVED]
the type of migration event
Possible values: [IMPORT, EXPORT]
the name of this general ledger account
controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code 1100, if this field is set to true, only the first two numbers will be recognised
the type of general ledger account
Possible values: [INCOME, EXPENSE, LIABILITY, ASSET, EQUITY]
whether this general ledger account is a DETAIL account, in which case it will have a value, or a HEADER account, in which case its value will be calculated based on the sum of detail accounts under it.
Possible values: [HEADER, DETAIL]
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the type of transaction governed by this rule
Possible values: [FEE_RECEIVABLE, OVERDRAFT_INTEREST_INCOME, OVERDRAFT_INTEREST_RECEIVABLE, FEE_INCOME, INTEREST_PAYABLE, INTEREST_EXPENSE, PENALTY_RECEIVABLE, INTEREST_INCOME, DEFERRED_TAXES, DEFERRED_FEE_INCOME, PORTFOLIO_CONTROL, DEFERRED_INTERESTS_INCOME, OVERDRAFT_WRITE_OFF_EXPENSE, PENALTY_INCOME, OVERDRAFT_PORTFOLIO_CONTROL, SAVINGS_CONTROL, TAXES_RECEIVABLE, INTEREST_RECEIVABLE, INTER_BRANCH_TRANSFER, FUND_SOURCE, WRITE_OFF_EXPENSE, DEPOSIT_REFERENCE, TAXES_PAYABLE]
the index in list when there are multiple rules for the same type of transaction
the encoded key of the predefined key this rule relates to
the encoded key of the product this rule relates to
the type of account this rule relates to
Possible values: [LOAN, SAVINGS]
the encoded key of the transaction channel that this rule relates to
Description for name in PredefinedFeeApiV1
Description for percentageAmount in PredefinedFeeApiV1
Description for trigger in PredefinedFeeApiV1
Possible values: [DISBURSEMENT, ARBITRARY, CAPITALIZED_DISBURSEMENT, MONTHLY_FEE, UPFRONT_DISBURSEMENT, LATE_REPAYMENT, MANUAL, PAYMENT_DUE, PAYMENT_DUE_APPLIED_ON_DUE_DATES]
Description for loanPenaltyCalculationMethod in LoanProductApiV1
Possible values: [OVERDUE_BALANCE_AND_INTEREST, OUTSTANDING_PRINCIPAL, OVERDUE_BALANCE, NONE]
Description for loanPenaltyGracePeriod in LoanProductApiV1
loanProductRules object[]
Description for loanProductRules in LoanProductApiV1
account object
Description for account in GLAccountingRuleApiV1
whether this general ledger account is in use
whether manual entries are allowed for this general ledger account
the current balance of this general ledger account
the date on which this general ledger account was created
currency object
Description for currency in GLAccountApiV1
the three letter ISO code for this currency
the date on which this currency was created
indicates where the currency symbol should appear in relation to the numeric value
Possible values: [AFTER_NUMBER, BEFORE_NUMBER]
indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.
whether this currency is the base currency for your banking institution
the date on which this currency was last modified
the name of this currency
the currency symnbol used for this currency
an optional description for this general ledger account
the encoded key of this general ledger account
the numeric code for this general ledger account
the date on which this general ledger account was last modified
migrationEvent object
Description for migrationEvent in GLAccountApiV1
the date on which the data import was made
the encoded key of this data migration event
the number of centres which were imported during the data migration
the number of clients which were imported as part of the data migration
the number of general ledger accounts which were imported as part of the data migration
the number of groups which were imported as part of the data migration
the number of loan repayment transations which were imported as part of the data migration
the number of loan transactions which were imported as part of the data migration
the number of loan accounts which were imported as part of the data migration
the number of savings accounts which were imported as part of the data migration
whether the data import was accepted, is still in a draft state, or was rejected and all data reverted
Possible values: [REVERTED, DRAFT, APPROVED]
the type of migration event
Possible values: [IMPORT, EXPORT]
the name of this general ledger account
controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code 1100, if this field is set to true, only the first two numbers will be recognised
the type of general ledger account
Possible values: [INCOME, EXPENSE, LIABILITY, ASSET, EQUITY]
whether this general ledger account is a DETAIL account, in which case it will have a value, or a HEADER account, in which case its value will be calculated based on the sum of detail accounts under it.
Possible values: [HEADER, DETAIL]
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the type of transaction governed by this rule
Possible values: [FEE_RECEIVABLE, OVERDRAFT_INTEREST_INCOME, OVERDRAFT_INTEREST_RECEIVABLE, FEE_INCOME, INTEREST_PAYABLE, INTEREST_EXPENSE, PENALTY_RECEIVABLE, INTEREST_INCOME, DEFERRED_TAXES, DEFERRED_FEE_INCOME, PORTFOLIO_CONTROL, DEFERRED_INTERESTS_INCOME, OVERDRAFT_WRITE_OFF_EXPENSE, PENALTY_INCOME, OVERDRAFT_PORTFOLIO_CONTROL, SAVINGS_CONTROL, TAXES_RECEIVABLE, INTEREST_RECEIVABLE, INTER_BRANCH_TRANSFER, FUND_SOURCE, WRITE_OFF_EXPENSE, DEPOSIT_REFERENCE, TAXES_PAYABLE]
the index in list when there are multiple rules for the same type of transaction
the encoded key of the predefined key this rule relates to
the encoded key of the product this rule relates to
the type of account this rule relates to
Possible values: [LOAN, SAVINGS]
the encoded key of the transaction channel that this rule relates to
Description for loanProductType in LoanProductApiV1
Possible values: [INTEREST_FREE_LOAN, DYNAMIC_TERM_LOAN, FIXED_TERM_LOAN, REVOLVING_CREDIT, TRANCHED_LOAN]
Description for lockPeriodDays in LoanProductApiV1
Description for maxFirstRepaymentDueDateOffset in LoanProductApiV1
Description for maxGracePeriod in LoanProductApiV1
Description for maxLoanAmount in LoanProductApiV1
Description for maxNumInstallments in LoanProductApiV1
Description for maxNumberOfDisbursementTranches in LoanProductApiV1
Description for maxPenaltyRate in LoanProductApiV1
Description for minFirstRepaymentDueDateOffset in LoanProductApiV1
Description for minGracePeriod in LoanProductApiV1
Description for minLoanAmount in LoanProductApiV1
Description for minNumInstallments in LoanProductApiV1
Description for minPenaltyRate in LoanProductApiV1
Description for offsetPercentage in LoanProductApiV1
offsetSettings object
Description for offsetSettings in LoanProductApiV1
Description for paymentMethod in LoanProductApiV1
Possible values: [VERTICAL, HORIZONTAL]
Description for prepaymentAcceptance in LoanProductApiV1
Possible values: [ACCEPT_PREPAYMENTS, NO_PREPAYMENTS]
Description for prepaymentRecalculationMethod in LoanProductApiV1
Possible values: [NO_RECALCULATION, RECALCULATE_SCHEDULE_KEEP_SAME_NUMBER_OF_TERMS, REDUCE_AMOUNT_PER_INSTALLMENT, REDUCE_NUMBER_OF_INSTALLMENTS_NEW, REDUCE_NUMBER_OF_INSTALLMENTS, RESCHEDULE_REMAINING_REPAYMENTS, RECALCULATE_SCHEDULE_KEEP_SAME_TOTAL_REPAYMENT_AMOUNT, RECALCULATE_SCHEDULE_KEEP_SAME_PRINCIPAL_AMOUNT]
Description for principalPaidInstallmentStatus in LoanProductApiV1
Possible values: [PARTIALLY_PAID, ORIGINAL_TOTAL_EXPECTED_PAID, PAID]
principalPaymentSettings object
Description for principalPaymentSettings in LoanProductApiV1
Description for defaultAmount in PrincipalPaymentProductSettingsApiV1
Description for defaultPercentage in PrincipalPaymentProductSettingsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for includeFeesInFloorAmount in PrincipalPaymentProductSettingsApiV1
Description for includeInterestInFloorAmount in PrincipalPaymentProductSettingsApiV1
Description for maxAmount in PrincipalPaymentProductSettingsApiV1
Description for maxPercentage in PrincipalPaymentProductSettingsApiV1
Description for minAmount in PrincipalPaymentProductSettingsApiV1
Description for minPercentage in PrincipalPaymentProductSettingsApiV1
Description for principalCeilingValue in PrincipalPaymentProductSettingsApiV1
Description for principalFloorValue in PrincipalPaymentProductSettingsApiV1
Description for principalPaymentMethod in PrincipalPaymentProductSettingsApiV1
Possible values: [OUTSTANDING_PRINCIPAL_PERCENTAGE, FLAT, TOTAL_BALANCE_PERCENTAGE]
Description for productDescription in LoanProductApiV1
Description for productName in LoanProductApiV1
productSecuritySettings object
Description for productSecuritySettings in LoanProductApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472funderInterestCommission object
Description for funderInterestCommission in ProductSecuritySettingsApiV1
Description for defaultValue in DecimalIntervalConstraintsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for maxValue in DecimalIntervalConstraintsApiV1
Description for minValue in DecimalIntervalConstraintsApiV1
Description for funderInterestCommissionAllocationType in ProductSecuritySettingsApiV1
Possible values: [PERCENTAGE_OF_LOAN_FUNDING, FIXED_INTEREST_COMMISSIONS]
Description for isCollateralEnabled in ProductSecuritySettingsApiV1
Description for isGuarantorsEnabled in ProductSecuritySettingsApiV1
Description for isInvestorFundsEnabled in ProductSecuritySettingsApiV1
Description for lockFundsAtApproval in ProductSecuritySettingsApiV1
organizationInterestCommission object
Description for organizationInterestCommission in ProductSecuritySettingsApiV1
Description for defaultValue in DecimalIntervalConstraintsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for maxValue in DecimalIntervalConstraintsApiV1
Description for minValue in DecimalIntervalConstraintsApiV1
Description for requiredGuaranties in ProductSecuritySettingsApiV1
Description for requiredInvestorFunds in ProductSecuritySettingsApiV1
redrawSettings object
Description for redrawSettings in LoanProductApiV1
Description for allowRedraw in ProductRedrawSettingsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for repaymentAllocationOrder in LoanProductApiV1
Possible values: [PENALTY, FEE, PRINCIPAL, INTEREST]
Description for repaymentCurrencyRounding in LoanProductApiV1
Possible values: [ROUND_UP_TO_NEAREST_WHOLE_UNIT, NO_ROUNDING, ROUND_TO_NEAREST_WHOLE_UNIT]
Description for repaymentElementsRoundingMethod in LoanProductApiV1
Possible values: [NO_ROUNDING, PAYMENT_DUE, ROUND_ALL]
Description for repaymentPeriodUnit in LoanProductApiV1
Possible values: [MONTHS, YEARS, WEEKS, DAYS]
Description for repaymentReschedulingMethod in LoanProductApiV1
Possible values: [PREVIOUS_WORKING_DAY, NEXT_WORKING_DAY, NONE, EXTEND_SCHEDULE]
Description for repaymentScheduleEditOptions in LoanProductApiV1
Possible values: [ADJUST_PRINCIPAL_PAYMENT_SCHEDULE, ADJUST_PAYMENT_DATES, ADJUST_FEE_PAYMENT_SCHEDULE, ADJUST_INTEREST_PAYMENT_SCHEDULE, ADJUST_PENALTY_PAYMENT_SCHEDULE, ADJUST_NUMBER_OF_INSTALLMENTS]
Description for repaymentScheduleMethod in LoanProductApiV1
Possible values: [FIXED, NONE, DYNAMIC]
Description for roundingRepaymentScheduleMethod in LoanProductApiV1
Possible values: [ROUND_PRINCIPAL_AND_INTEREST_REMAINDER_INTO_LAST_REPAYMENT, NO_ROUNDING, ROUND_REMAINDER_INTO_LAST_REPAYMENT]
Description for scheduleDueDatesMethod in LoanProductApiV1
Possible values: [INTERVAL, FIXED_DAYS_OF_MONTH]
Description for scheduleInterestDaysCountMethod in LoanProductApiV1
Possible values: [USING_REPAYMENT_PERIODICITY, USING_ACTUAL_DAYS_COUNT]
Description for settlementOptions in LoanProductApiV1
Possible values: [NO_AUTOMATED_TRANSFERS, PARTIAL_DUE_AMOUNTS, FULL_DUE_AMOUNTS]
Description for shortMonthHandlingMethod in LoanProductApiV1
Possible values: [LAST_DAY_IN_MONTH, FIRST_DAY_OF_NEXT_MONTH]
Description for taxCalculationMethod in LoanProductApiV1
Possible values: [EXCLUSIVE, INCLUSIVE]
Description for taxSourceKey in LoanProductApiV1
Description for taxesOnFeesEnabled in LoanProductApiV1
Description for taxesOnInterestEnabled in LoanProductApiV1
Description for taxesOnPenaltyEnabled in LoanProductApiV1
templates object[]
Description for templates in LoanProductApiV1
the date and time when this document was created
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the date on which this document template was last modified
the name of the document template
the type of template, this will have an impact on what data is available to the template as placeholders
Possible values: [ACCOUNT, ACCOUNT_WITH_TRANSACTIONS, TRANSACTION]
{
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"isOffsetEnabled": true,
"loanProduct": {
"accountInitialState": "WITHDRAWN",
"accountLinkingEnabled": true,
"accountingMethod": "NONE",
"accrueLateInterest": true,
"activated": true,
"allowArbitraryFees": true,
"allowCustomRepaymentAllocation": true,
"amortizationMethod": "PAYMENT_PLAN",
"applyInterestOnPrepaymentMethod": "AUTOMATIC",
"arrearsSettings": {
"dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
"defaultTolerancePeriod": 0,
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"maxTolerancePeriod": 0,
"minTolerancePeriod": 0,
"monthlyToleranceDay": 0,
"nonWorkingDaysMethod": "EXCLUDED",
"toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY"
},
"autoCreateLinkedAccounts": true,
"autoLinkAccounts": true,
"availableProductBranches": [
{
"branchKey": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"product": {}
}
],
"cappingApplyAccruedChargesBeforeLocking": true,
"cappingConstraintType": "SOFT_CAP",
"cappingMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE",
"cappingPercentage": 0,
"creationDate": "string",
"daysInYear": "E30_42_365",
"defaultFirstRepaymentDueDateOffset": 0,
"defaultGracePeriod": 0,
"defaultLoanAmount": 0,
"defaultNumInstallments": 0,
"defaultPenaltyRate": 0,
"defaultPrincipalRepaymentInterval": 0,
"defaultRepaymentPeriodCount": 0,
"dormancyPeriodDays": 0,
"elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"fixedDaysOfMonth": [
0
],
"forAllBranches": true,
"forHybridGroups": true,
"forIndividuals": true,
"forPureGroups": true,
"futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
"gracePeriodType": "PAY_INTEREST_ONLY",
"id": "string",
"idGeneratorType": "INCREMENTAL_NUMBER",
"idPattern": "string",
"interestAccrualCalculation": "BREAKDOWN_PER_ACCOUNT",
"interestAccruedAccountingMethod": "DAILY",
"interestApplicationMethod": "ON_REPAYMENT",
"interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
"interestCalculationMethod": "DECLINING_BALANCE",
"interestRateSettings": {
"accrueInterestAfterMaturity": true,
"defaultInterestRate": 0,
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"indexSourceKey": "string",
"interestChargeFrequency": "EVERY_WEEK",
"interestChargeFrequencyCount": 0,
"interestRateCeilingValue": 0,
"interestRateFloorValue": 0,
"interestRateReviewCount": 0,
"interestRateReviewUnit": "MONTHS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRateTerms": "TIERED_PERIOD",
"interestRateTiers": [
{
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"endingBalance": 0,
"endingDay": 0,
"index": 0,
"interestRate": 0
}
],
"maxInterestRate": 0,
"minInterestRate": 0
},
"interestType": "CAPITALIZED_INTEREST",
"lastModifiedDate": "string",
"latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
"lineOfCreditRequirement": "OPTIONAL",
"linkableSavingsProductKey": "string",
"loanFees": [
{
"active": true,
"amortizationIntervalSettings": {
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
"intervalCount": 0,
"intervalType": "FULL_TERM",
"periodCount": 0,
"periodUnit": "MONTHS"
},
"amortizationProfile": "STRAIGHT_LINE",
"amount": 0,
"amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
"applyDateMethod": "MONTHLY_FROM_ACTIVATION",
"creationDate": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
"feeApplication": "OPTIONAL",
"feeProductRules": [
{
"account": {
"activated": true,
"allowManualJournalEntries": true,
"balance": 0,
"creationDate": "2024-07-29T15:51:28.071Z",
"currency": {
"code": "string",
"creationDate": "string",
"currencySymbolPosition": "AFTER_NUMBER",
"digitsAfterDecimal": 0,
"isBaseCurrency": true,
"lastModifiedDate": "string",
"name": "string",
"symbol": "string"
},
"description": "string",
"encodedKey": "string",
"glCode": "string",
"lastModifiedDate": "2024-07-29T15:51:28.071Z",
"migrationEvent": {
"creationDate": "2024-07-29T15:51:28.071Z",
"encodedKey": "string",
"numCentresImported": 0,
"numClientsImported": 0,
"numGLAccountsImported": 0,
"numGroupsImported": 0,
"numLoanRepaymentsImported": 0,
"numLoanTransactionsImported": 0,
"numLoansImported": 0,
"numSavingsImported": 0,
"state": "REVERTED",
"type": "IMPORT"
},
"name": "string",
"stripTrailingZeros": true,
"type": "INCOME",
"usage": "HEADER"
},
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"financialResource": "FEE_RECEIVABLE",
"index": 0,
"predefinedFeeKey": "string",
"productKey": "string",
"productType": "LOAN",
"transactionChannelKey": "string"
}
],
"name": "string",
"percentageAmount": 0,
"trigger": "DISBURSEMENT"
}
],
"loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
"loanPenaltyGracePeriod": 0,
"loanProductRules": [
{
"account": {
"activated": true,
"allowManualJournalEntries": true,
"balance": 0,
"creationDate": "2024-07-29T15:51:28.071Z",
"currency": {
"code": "string",
"creationDate": "string",
"currencySymbolPosition": "AFTER_NUMBER",
"digitsAfterDecimal": 0,
"isBaseCurrency": true,
"lastModifiedDate": "string",
"name": "string",
"symbol": "string"
},
"description": "string",
"encodedKey": "string",
"glCode": "string",
"lastModifiedDate": "2024-07-29T15:51:28.071Z",
"migrationEvent": {
"creationDate": "2024-07-29T15:51:28.071Z",
"encodedKey": "string",
"numCentresImported": 0,
"numClientsImported": 0,
"numGLAccountsImported": 0,
"numGroupsImported": 0,
"numLoanRepaymentsImported": 0,
"numLoanTransactionsImported": 0,
"numLoansImported": 0,
"numSavingsImported": 0,
"state": "REVERTED",
"type": "IMPORT"
},
"name": "string",
"stripTrailingZeros": true,
"type": "INCOME",
"usage": "HEADER"
},
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"financialResource": "FEE_RECEIVABLE",
"index": 0,
"predefinedFeeKey": "string",
"productKey": "string",
"productType": "LOAN",
"transactionChannelKey": "string"
}
],
"loanProductType": "INTEREST_FREE_LOAN",
"lockPeriodDays": 0,
"maxFirstRepaymentDueDateOffset": 0,
"maxGracePeriod": 0,
"maxLoanAmount": 0,
"maxNumInstallments": 0,
"maxNumberOfDisbursementTranches": 0,
"maxPenaltyRate": 0,
"minFirstRepaymentDueDateOffset": 0,
"minGracePeriod": 0,
"minLoanAmount": 0,
"minNumInstallments": 0,
"minPenaltyRate": 0,
"offsetPercentage": 0,
"offsetSettings": {},
"paymentMethod": "VERTICAL",
"prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
"prepaymentRecalculationMethod": "NO_RECALCULATION",
"principalPaidInstallmentStatus": "PARTIALLY_PAID",
"principalPaymentSettings": {
"defaultAmount": 0,
"defaultPercentage": 0,
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"includeFeesInFloorAmount": true,
"includeInterestInFloorAmount": true,
"maxAmount": 0,
"maxPercentage": 0,
"minAmount": 0,
"minPercentage": 0,
"principalCeilingValue": 0,
"principalFloorValue": 0,
"principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
},
"productDescription": "string",
"productName": "string",
"productSecuritySettings": {
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"funderInterestCommission": {
"defaultValue": 0,
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"maxValue": 0,
"minValue": 0
},
"funderInterestCommissionAllocationType": "PERCENTAGE_OF_LOAN_FUNDING",
"isCollateralEnabled": true,
"isGuarantorsEnabled": true,
"isInvestorFundsEnabled": true,
"lockFundsAtApproval": true,
"organizationInterestCommission": {
"defaultValue": 0,
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"maxValue": 0,
"minValue": 0
},
"requiredGuaranties": 0,
"requiredInvestorFunds": 0
},
"redrawSettings": {
"allowRedraw": true,
"encodedKey": "8a19b7057471f4af017472dc0fd80472"
},
"repaymentAllocationOrder": [
"PENALTY"
],
"repaymentCurrencyRounding": "ROUND_UP_TO_NEAREST_WHOLE_UNIT",
"repaymentElementsRoundingMethod": "NO_ROUNDING",
"repaymentPeriodUnit": "MONTHS",
"repaymentReschedulingMethod": "PREVIOUS_WORKING_DAY",
"repaymentScheduleEditOptions": [
"ADJUST_PRINCIPAL_PAYMENT_SCHEDULE"
],
"repaymentScheduleMethod": "FIXED",
"roundingRepaymentScheduleMethod": "ROUND_PRINCIPAL_AND_INTEREST_REMAINDER_INTO_LAST_REPAYMENT",
"scheduleDueDatesMethod": "INTERVAL",
"scheduleInterestDaysCountMethod": "USING_REPAYMENT_PERIODICITY",
"settlementOptions": "NO_AUTOMATED_TRANSFERS",
"shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
"taxCalculationMethod": "EXCLUSIVE",
"taxSourceKey": "string",
"taxesOnFeesEnabled": true,
"taxesOnInterestEnabled": true,
"taxesOnPenaltyEnabled": true,
"templates": [
{
"creationDate": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"lastModifiedDate": "string",
"name": "string",
"type": "ACCOUNT"
}
]
}
}