Skip to main content

Loanproductbranchapiv1

branchKeystring

Description for branchKey in LoanProductBranchApiV1

encodedKeystring

Description for encodedKey in LoanProductBranchApiV1

product object

Description for product in LoanProductBranchApiV1

accountInitialStatestring

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]

accountLinkingEnabledboolean

Description for accountLinkingEnabled in LoanProductApiV1

accountingMethodstring

Description for accountingMethod in LoanProductApiV1

Possible values: [NONE, CASH, ACCRUAL]

accrueLateInterestboolean

Description for accrueLateInterest in LoanProductApiV1

activatedboolean

Description for activated in LoanProductApiV1

allowArbitraryFeesboolean

Description for allowArbitraryFees in LoanProductApiV1

allowCustomRepaymentAllocationboolean

Description for allowCustomRepaymentAllocation in LoanProductApiV1

amortizationMethodstring

Description for amortizationMethod in LoanProductApiV1

Possible values: [PAYMENT_PLAN, BALLOON_PAYMENTS, STANDARD_PAYMENTS, OPTIMIZED_PAYMENTS]

applyInterestOnPrepaymentMethodstring

Description for applyInterestOnPrepaymentMethod in LoanProductApiV1

Possible values: [AUTOMATIC, MANUAL]

arrearsSettings object

Description for arrearsSettings in LoanProductApiV1

dateCalculationMethodstring

Description for dateCalculationMethod in ProductArrearsSettingsApiV1

Possible values: [DATE_OF_LAST_LATE_REPAYMENT, DATE_ACCOUNT_FIRST_WENT_TO_ARREARS]

defaultTolerancePeriodnumber

Description for defaultTolerancePeriod in ProductArrearsSettingsApiV1

encodedKeystring

Description for encodedKey in ProductArrearsSettingsApiV1

maxTolerancePeriodnumber

Description for maxTolerancePeriod in ProductArrearsSettingsApiV1

minTolerancePeriodnumber

Description for minTolerancePeriod in ProductArrearsSettingsApiV1

monthlyToleranceDaynumber

Description for monthlyToleranceDay in ProductArrearsSettingsApiV1

nonWorkingDaysMethodstring

Description for nonWorkingDaysMethod in ProductArrearsSettingsApiV1

Possible values: [EXCLUDED, INCLUDED]

toleranceCalculationMethodstring

Description for toleranceCalculationMethod in ProductArrearsSettingsApiV1

Possible values: [MONTHLY_ARREARS_TOLERANCE_DAY, ARREARS_TOLERANCE_PERIOD]

autoCreateLinkedAccountsboolean

Description for autoCreateLinkedAccounts in LoanProductApiV1

autoLinkAccountsboolean

Description for autoLinkAccounts in LoanProductApiV1

availableProductBranchesundefined[]

Description for availableProductBranches in LoanProductApiV1

cappingApplyAccruedChargesBeforeLockingboolean

Description for cappingApplyAccruedChargesBeforeLocking in LoanProductApiV1

cappingConstraintTypestring

Description for cappingConstraintType in LoanProductApiV1

Possible values: [SOFT_CAP, HARD_CAP]

cappingMethodstring

Description for cappingMethod in LoanProductApiV1

Possible values: [OUTSTANDING_PRINCIPAL_PERCENTAGE, ORIGINAL_PRINCIPAL_PERCENTAGE]

cappingPercentagenumber

Description for cappingPercentage in LoanProductApiV1

creationDatestring

Description for creationDate in LoanProductApiV1

daysInYearstring

Description for daysInYear in LoanProductApiV1

Possible values: [E30_42_365, ACTUAL_365_FIXED, ACTUAL_360, E30_360, ACTUAL_364, ACTUAL_ACTUAL_ISDA]

defaultFirstRepaymentDueDateOffsetnumber

Description for defaultFirstRepaymentDueDateOffset in LoanProductApiV1

defaultGracePeriodnumber

Description for defaultGracePeriod in LoanProductApiV1

defaultLoanAmountnumber

Description for defaultLoanAmount in LoanProductApiV1

defaultNumInstallmentsnumber

Description for defaultNumInstallments in LoanProductApiV1

defaultPenaltyRatenumber

Description for defaultPenaltyRate in LoanProductApiV1

defaultPrincipalRepaymentIntervalnumber

Description for defaultPrincipalRepaymentInterval in LoanProductApiV1

defaultRepaymentPeriodCountnumber

Description for defaultRepaymentPeriodCount in LoanProductApiV1

dormancyPeriodDaysnumber

Description for dormancyPeriodDays in LoanProductApiV1

elementsRecalculationMethodstring

Description for elementsRecalculationMethod in LoanProductApiV1

Possible values: [FIXED_PRINCIPAL_EXPECTED, FIXED_TOTAL_EXPECTED]

encodedKeystring

Description for encodedKey in LoanProductApiV1

fixedDaysOfMonthnumber[]

Description for fixedDaysOfMonth in LoanProductApiV1

forAllBranchesboolean

Description for forAllBranches in LoanProductApiV1

forHybridGroupsboolean

Description for forHybridGroups in LoanProductApiV1

forIndividualsboolean

Description for forIndividuals in LoanProductApiV1

forPureGroupsboolean

Description for forPureGroups in LoanProductApiV1

futurePaymentsAcceptancestring

Description for futurePaymentsAcceptance in LoanProductApiV1

Possible values: [ACCEPT_OVERPAYMENTS, NO_FUTURE_PAYMENTS, ACCEPT_FUTURE_PAYMENTS]

gracePeriodTypestring

Description for gracePeriodType in LoanProductApiV1

Possible values: [PAY_INTEREST_ONLY, NONE, INTEREST_FORGIVENESS]

idstring

Description for id in LoanProductApiV1

idGeneratorTypestring

Description for idGeneratorType in LoanProductApiV1

Possible values: [INCREMENTAL_NUMBER, RANDOM_PATTERN]

idPatternstring

Description for idPattern in LoanProductApiV1

interestAccrualCalculationstring

Description for interestAccrualCalculation in LoanProductApiV1

Possible values: [BREAKDOWN_PER_ACCOUNT, AGGREGATED_AMOUNT, NONE]

interestAccruedAccountingMethodstring

Description for interestAccruedAccountingMethod in LoanProductApiV1

Possible values: [DAILY, END_OF_MONTH, NONE]

interestApplicationMethodstring

Description for interestApplicationMethod in LoanProductApiV1

Possible values: [ON_REPAYMENT, ON_DISBURSEMENT]

interestBalanceCalculationMethodstring

Description for interestBalanceCalculationMethod in LoanProductApiV1

Possible values: [PRINCIPAL_ONLY, PRINCIPAL_AND_INTEREST]

interestCalculationMethodstring

Description for interestCalculationMethod in LoanProductApiV1

Possible values: [DECLINING_BALANCE, DECLINING_BALANCE_DISCOUNTED, FLAT]

interestRateSettings object

Description for interestRateSettings in LoanProductApiV1

accrueInterestAfterMaturityboolean

Description for accrueInterestAfterMaturity in InterestProductSettingsApiV1

defaultInterestRatenumber

Description for defaultInterestRate in InterestProductSettingsApiV1

encodedKeystring

Description for encodedKey in InterestProductSettingsApiV1

indexSourceKeystring

Description for indexSourceKey in InterestProductSettingsApiV1

interestChargeFrequencystring

Description for interestChargeFrequency in InterestProductSettingsApiV1

Possible values: [EVERY_WEEK, ANNUALIZED, EVERY_MONTH, EVERY_X_DAYS, EVERY_FOUR_WEEKS, EVERY_DAY]

interestChargeFrequencyCountnumber

Description for interestChargeFrequencyCount in InterestProductSettingsApiV1

interestRateCeilingValuenumber

Description for interestRateCeilingValue in InterestProductSettingsApiV1

interestRateFloorValuenumber

Description for interestRateFloorValue in InterestProductSettingsApiV1

interestRateReviewCountnumber

Description for interestRateReviewCount in InterestProductSettingsApiV1

interestRateReviewUnitstring

Description for interestRateReviewUnit in InterestProductSettingsApiV1

Possible values: [MONTHS, WEEKS, DAYS]

interestRateSourcestring

Description for interestRateSource in InterestProductSettingsApiV1

Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]

interestRateTermsstring

Description for interestRateTerms in InterestProductSettingsApiV1

Possible values: [TIERED_PERIOD, FIXED, TIERED]

interestRateTiers object[]

Description for interestRateTiers in InterestProductSettingsApiV1

  • Array [
  • encodedKeystring

    Description for encodedKey in InterestRateTierApiV1

    endingBalancenumber

    Description for endingBalance in InterestRateTierApiV1

    endingDaynumber

    Description for endingDay in InterestRateTierApiV1

    indexnumber

    Description for index in InterestRateTierApiV1

    interestRatenumber

    Description for interestRate in InterestRateTierApiV1

  • ]
  • maxInterestRatenumber

    Description for maxInterestRate in InterestProductSettingsApiV1

    minInterestRatenumber

    Description for minInterestRate in InterestProductSettingsApiV1

    interestTypestring

    Description for interestType in LoanProductApiV1

    Possible values: [CAPITALIZED_INTEREST, SIMPLE_INTEREST]

    lastModifiedDatestring

    Description for lastModifiedDate in LoanProductApiV1

    latePaymentsRecalculationMethodstring

    Description for latePaymentsRecalculationMethod in LoanProductApiV1

    Possible values: [INCREASE_OVERDUE_INSTALLMENTS, INCREASE_LAST_INSTALLMENT]

    lineOfCreditRequirementstring

    Description for lineOfCreditRequirement in LoanProductApiV1

    Possible values: [OPTIONAL, NOT_REQUIRED, REQUIRED]

    linkableSavingsProductKeystring

    Description for linkableSavingsProductKey in LoanProductApiV1

    loanFees object[]

    Description for loanFees in LoanProductApiV1

  • Array [
  • activeboolean

    Description for active in PredefinedFeeApiV1

    amortizationIntervalSettings object

    Description for amortizationIntervalSettings in PredefinedFeeApiV1

    encodedKeystring

    Description for encodedKey in PeriodIntervalSettingsApiV1

    frequencystring

    Description for frequency in PeriodIntervalSettingsApiV1

    Possible values: [ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING, ACCOUNT_INSTALLMENTS_DUE_DATES, CUSTOM_INTERVAL]

    intervalCountnumber

    Description for intervalCount in PeriodIntervalSettingsApiV1

    intervalTypestring

    Description for intervalType in PeriodIntervalSettingsApiV1

    Possible values: [FULL_TERM, PREDEFINED_INTERVALS]

    periodCountnumber

    Description for periodCount in PeriodIntervalSettingsApiV1

    periodUnitstring

    Description for periodUnit in PeriodIntervalSettingsApiV1

    Possible values: [MONTHS, YEARS, WEEKS, DAYS]

    amortizationProfilestring

    Description for amortizationProfile in PredefinedFeeApiV1

    Possible values: [STRAIGHT_LINE, SUM_OF_YEARS_DIGITS, EFFECTIVE_INTEREST_RATE, NONE]

    amountnumber

    Description for amount in PredefinedFeeApiV1

    amountCalculationMethodstring

    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]

    applyDateMethodstring

    Description for applyDateMethod in PredefinedFeeApiV1

    Possible values: [MONTHLY_FROM_ACTIVATION, FIRST_OF_EVERY_MONTH]

    creationDatestring

    Description for creationDate in PredefinedFeeApiV1

    encodedKeystring

    Description for encodedKey in PredefinedFeeApiV1

    feeAmortizationUponRescheduleOptionstring

    Description for feeAmortizationUponRescheduleOption in PredefinedFeeApiV1

    Possible values: [CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT, END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT]

    feeApplicationstring

    Description for feeApplication in PredefinedFeeApiV1

    Possible values: [OPTIONAL, REQUIRED]

    feeProductRules object[]

    Description for feeProductRules in PredefinedFeeApiV1

  • Array [
  • account object

    Description for account in GLAccountingRuleApiV1

    activatedboolean

    Description for activated in GLAccountApiV1

    allowManualJournalEntriesboolean

    Description for allowManualJournalEntries in GLAccountApiV1

    balancenumber

    Description for balance in GLAccountApiV1

    creationDatestring

    Description for creationDate in GLAccountApiV1

    currency object

    Description for currency in GLAccountApiV1

    codestring

    Description for code in CurrencyApiV1

    creationDatestring

    Description for creationDate in CurrencyApiV1

    currencySymbolPositionstring

    Description for currencySymbolPosition in CurrencyApiV1

    Possible values: [AFTER_NUMBER, BEFORE_NUMBER]

    digitsAfterDecimalnumber

    Description for digitsAfterDecimal in CurrencyApiV1

    isBaseCurrencyboolean

    Description for isBaseCurrency in CurrencyApiV1

    lastModifiedDatestring

    Description for lastModifiedDate in CurrencyApiV1

    namestring

    Description for name in CurrencyApiV1

    symbolstring

    Description for symbol in CurrencyApiV1

    descriptionstring

    Description for description in GLAccountApiV1

    encodedKeystring

    Description for encodedKey in GLAccountApiV1

    glCodestring

    Description for glCode in GLAccountApiV1

    lastModifiedDatestring

    Description for lastModifiedDate in GLAccountApiV1

    migrationEvent object

    Description for migrationEvent in GLAccountApiV1

    creationDatestring

    Description for creationDate in DataMigrationEventApiV1

    encodedKeystring

    Description for encodedKey in DataMigrationEventApiV1

    numCentresImportednumber

    Description for numCentresImported in DataMigrationEventApiV1

    numClientsImportednumber

    Description for numClientsImported in DataMigrationEventApiV1

    numGLAccountsImportednumber

    Description for numGLAccountsImported in DataMigrationEventApiV1

    numGroupsImportednumber

    Description for numGroupsImported in DataMigrationEventApiV1

    numLoanRepaymentsImportednumber

    Description for numLoanRepaymentsImported in DataMigrationEventApiV1

    numLoanTransactionsImportednumber

    Description for numLoanTransactionsImported in DataMigrationEventApiV1

    numLoansImportednumber

    Description for numLoansImported in DataMigrationEventApiV1

    numSavingsImportednumber

    Description for numSavingsImported in DataMigrationEventApiV1

    statestring

    Description for state in DataMigrationEventApiV1

    Possible values: [REVERTED, DRAFT, APPROVED]

    typestring

    Description for type in DataMigrationEventApiV1

    Possible values: [IMPORT, EXPORT]

    namestring

    Description for name in GLAccountApiV1

    stripTrailingZerosboolean

    Description for stripTrailingZeros in GLAccountApiV1

    typestring

    Description for type in GLAccountApiV1

    Possible values: [INCOME, EXPENSE, LIABILITY, ASSET, EQUITY]

    usagestring

    Description for usage in GLAccountApiV1

    Possible values: [HEADER, DETAIL]

    encodedKeystring

    Description for encodedKey in GLAccountingRuleApiV1

    financialResourcestring

    Description for financialResource in GLAccountingRuleApiV1

    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]

    indexnumber

    Description for index in GLAccountingRuleApiV1

    predefinedFeeKeystring

    Description for predefinedFeeKey in GLAccountingRuleApiV1

    productKeystring

    Description for productKey in GLAccountingRuleApiV1

    productTypestring

    Description for productType in GLAccountingRuleApiV1

    Possible values: [LOAN, SAVINGS]

    transactionChannelKeystring

    Description for transactionChannelKey in GLAccountingRuleApiV1

  • ]
  • namestring

    Description for name in PredefinedFeeApiV1

    percentageAmountnumber

    Description for percentageAmount in PredefinedFeeApiV1

    triggerstring

    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]

  • ]
  • loanPenaltyCalculationMethodstring

    Description for loanPenaltyCalculationMethod in LoanProductApiV1

    Possible values: [OVERDUE_BALANCE_AND_INTEREST, OUTSTANDING_PRINCIPAL, OVERDUE_BALANCE, NONE]

    loanPenaltyGracePeriodnumber

    Description for loanPenaltyGracePeriod in LoanProductApiV1

    loanProductRules object[]

    Description for loanProductRules in LoanProductApiV1

  • Array [
  • account object

    Description for account in GLAccountingRuleApiV1

    activatedboolean

    Description for activated in GLAccountApiV1

    allowManualJournalEntriesboolean

    Description for allowManualJournalEntries in GLAccountApiV1

    balancenumber

    Description for balance in GLAccountApiV1

    creationDatestring

    Description for creationDate in GLAccountApiV1

    currency object

    Description for currency in GLAccountApiV1

    codestring

    Description for code in CurrencyApiV1

    creationDatestring

    Description for creationDate in CurrencyApiV1

    currencySymbolPositionstring

    Description for currencySymbolPosition in CurrencyApiV1

    Possible values: [AFTER_NUMBER, BEFORE_NUMBER]

    digitsAfterDecimalnumber

    Description for digitsAfterDecimal in CurrencyApiV1

    isBaseCurrencyboolean

    Description for isBaseCurrency in CurrencyApiV1

    lastModifiedDatestring

    Description for lastModifiedDate in CurrencyApiV1

    namestring

    Description for name in CurrencyApiV1

    symbolstring

    Description for symbol in CurrencyApiV1

    descriptionstring

    Description for description in GLAccountApiV1

    encodedKeystring

    Description for encodedKey in GLAccountApiV1

    glCodestring

    Description for glCode in GLAccountApiV1

    lastModifiedDatestring

    Description for lastModifiedDate in GLAccountApiV1

    migrationEvent object

    Description for migrationEvent in GLAccountApiV1

    creationDatestring

    Description for creationDate in DataMigrationEventApiV1

    encodedKeystring

    Description for encodedKey in DataMigrationEventApiV1

    numCentresImportednumber

    Description for numCentresImported in DataMigrationEventApiV1

    numClientsImportednumber

    Description for numClientsImported in DataMigrationEventApiV1

    numGLAccountsImportednumber

    Description for numGLAccountsImported in DataMigrationEventApiV1

    numGroupsImportednumber

    Description for numGroupsImported in DataMigrationEventApiV1

    numLoanRepaymentsImportednumber

    Description for numLoanRepaymentsImported in DataMigrationEventApiV1

    numLoanTransactionsImportednumber

    Description for numLoanTransactionsImported in DataMigrationEventApiV1

    numLoansImportednumber

    Description for numLoansImported in DataMigrationEventApiV1

    numSavingsImportednumber

    Description for numSavingsImported in DataMigrationEventApiV1

    statestring

    Description for state in DataMigrationEventApiV1

    Possible values: [REVERTED, DRAFT, APPROVED]

    typestring

    Description for type in DataMigrationEventApiV1

    Possible values: [IMPORT, EXPORT]

    namestring

    Description for name in GLAccountApiV1

    stripTrailingZerosboolean

    Description for stripTrailingZeros in GLAccountApiV1

    typestring

    Description for type in GLAccountApiV1

    Possible values: [INCOME, EXPENSE, LIABILITY, ASSET, EQUITY]

    usagestring

    Description for usage in GLAccountApiV1

    Possible values: [HEADER, DETAIL]

    encodedKeystring

    Description for encodedKey in GLAccountingRuleApiV1

    financialResourcestring

    Description for financialResource in GLAccountingRuleApiV1

    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]

    indexnumber

    Description for index in GLAccountingRuleApiV1

    predefinedFeeKeystring

    Description for predefinedFeeKey in GLAccountingRuleApiV1

    productKeystring

    Description for productKey in GLAccountingRuleApiV1

    productTypestring

    Description for productType in GLAccountingRuleApiV1

    Possible values: [LOAN, SAVINGS]

    transactionChannelKeystring

    Description for transactionChannelKey in GLAccountingRuleApiV1

  • ]
  • loanProductTypestring

    Description for loanProductType in LoanProductApiV1

    Possible values: [INTEREST_FREE_LOAN, DYNAMIC_TERM_LOAN, FIXED_TERM_LOAN, REVOLVING_CREDIT, TRANCHED_LOAN]

    lockPeriodDaysnumber

    Description for lockPeriodDays in LoanProductApiV1

    maxFirstRepaymentDueDateOffsetnumber

    Description for maxFirstRepaymentDueDateOffset in LoanProductApiV1

    maxGracePeriodnumber

    Description for maxGracePeriod in LoanProductApiV1

    maxLoanAmountnumber

    Description for maxLoanAmount in LoanProductApiV1

    maxNumInstallmentsnumber

    Description for maxNumInstallments in LoanProductApiV1

    maxNumberOfDisbursementTranchesnumber

    Description for maxNumberOfDisbursementTranches in LoanProductApiV1

    maxPenaltyRatenumber

    Description for maxPenaltyRate in LoanProductApiV1

    minFirstRepaymentDueDateOffsetnumber

    Description for minFirstRepaymentDueDateOffset in LoanProductApiV1

    minGracePeriodnumber

    Description for minGracePeriod in LoanProductApiV1

    minLoanAmountnumber

    Description for minLoanAmount in LoanProductApiV1

    minNumInstallmentsnumber

    Description for minNumInstallments in LoanProductApiV1

    minPenaltyRatenumber

    Description for minPenaltyRate in LoanProductApiV1

    offsetPercentagenumber

    Description for offsetPercentage in LoanProductApiV1

    offsetSettings object

    Description for offsetSettings in LoanProductApiV1

    encodedKeystring

    Description for encodedKey in ProductOffsetSettingsApiV1

    isOffsetEnabledboolean

    Description for isOffsetEnabled in ProductOffsetSettingsApiV1

    loanProduct object

    Description for loanProduct in ProductOffsetSettingsApiV1

    0
    1
    2
    3
    4
    5
    6
    7
    8
    9
    paymentMethodstring

    Description for paymentMethod in LoanProductApiV1

    Possible values: [VERTICAL, HORIZONTAL]

    prepaymentAcceptancestring

    Description for prepaymentAcceptance in LoanProductApiV1

    Possible values: [ACCEPT_PREPAYMENTS, NO_PREPAYMENTS]

    prepaymentRecalculationMethodstring

    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]

    principalPaidInstallmentStatusstring

    Description for principalPaidInstallmentStatus in LoanProductApiV1

    Possible values: [PARTIALLY_PAID, ORIGINAL_TOTAL_EXPECTED_PAID, PAID]

    principalPaymentSettings object

    Description for principalPaymentSettings in LoanProductApiV1

    defaultAmountnumber

    Description for defaultAmount in PrincipalPaymentProductSettingsApiV1

    defaultPercentagenumber

    Description for defaultPercentage in PrincipalPaymentProductSettingsApiV1

    encodedKeystring

    Description for encodedKey in PrincipalPaymentProductSettingsApiV1

    includeFeesInFloorAmountboolean

    Description for includeFeesInFloorAmount in PrincipalPaymentProductSettingsApiV1

    includeInterestInFloorAmountboolean

    Description for includeInterestInFloorAmount in PrincipalPaymentProductSettingsApiV1

    maxAmountnumber

    Description for maxAmount in PrincipalPaymentProductSettingsApiV1

    maxPercentagenumber

    Description for maxPercentage in PrincipalPaymentProductSettingsApiV1

    minAmountnumber

    Description for minAmount in PrincipalPaymentProductSettingsApiV1

    minPercentagenumber

    Description for minPercentage in PrincipalPaymentProductSettingsApiV1

    principalCeilingValuenumber

    Description for principalCeilingValue in PrincipalPaymentProductSettingsApiV1

    principalFloorValuenumber

    Description for principalFloorValue in PrincipalPaymentProductSettingsApiV1

    principalPaymentMethodstring

    Description for principalPaymentMethod in PrincipalPaymentProductSettingsApiV1

    Possible values: [OUTSTANDING_PRINCIPAL_PERCENTAGE, FLAT, TOTAL_BALANCE_PERCENTAGE]

    productDescriptionstring

    Description for productDescription in LoanProductApiV1

    productNamestring

    Description for productName in LoanProductApiV1

    productSecuritySettings object

    Description for productSecuritySettings in LoanProductApiV1

    encodedKeystring

    Description for encodedKey in ProductSecuritySettingsApiV1

    funderInterestCommission object

    Description for funderInterestCommission in ProductSecuritySettingsApiV1

    defaultValuenumber

    Description for defaultValue in DecimalIntervalConstraintsApiV1

    encodedKeystring

    Description for encodedKey in DecimalIntervalConstraintsApiV1

    maxValuenumber

    Description for maxValue in DecimalIntervalConstraintsApiV1

    minValuenumber

    Description for minValue in DecimalIntervalConstraintsApiV1

    funderInterestCommissionAllocationTypestring

    Description for funderInterestCommissionAllocationType in ProductSecuritySettingsApiV1

    Possible values: [PERCENTAGE_OF_LOAN_FUNDING, FIXED_INTEREST_COMMISSIONS]

    isCollateralEnabledboolean

    Description for isCollateralEnabled in ProductSecuritySettingsApiV1

    isGuarantorsEnabledboolean

    Description for isGuarantorsEnabled in ProductSecuritySettingsApiV1

    isInvestorFundsEnabledboolean

    Description for isInvestorFundsEnabled in ProductSecuritySettingsApiV1

    lockFundsAtApprovalboolean

    Description for lockFundsAtApproval in ProductSecuritySettingsApiV1

    organizationInterestCommission object

    Description for organizationInterestCommission in ProductSecuritySettingsApiV1

    defaultValuenumber

    Description for defaultValue in DecimalIntervalConstraintsApiV1

    encodedKeystring

    Description for encodedKey in DecimalIntervalConstraintsApiV1

    maxValuenumber

    Description for maxValue in DecimalIntervalConstraintsApiV1

    minValuenumber

    Description for minValue in DecimalIntervalConstraintsApiV1

    requiredGuarantiesnumber

    Description for requiredGuaranties in ProductSecuritySettingsApiV1

    requiredInvestorFundsnumber

    Description for requiredInvestorFunds in ProductSecuritySettingsApiV1

    redrawSettings object

    Description for redrawSettings in LoanProductApiV1

    allowRedrawboolean

    Description for allowRedraw in ProductRedrawSettingsApiV1

    encodedKeystring

    Description for encodedKey in ProductRedrawSettingsApiV1

    repaymentAllocationOrderstring[]

    Description for repaymentAllocationOrder in LoanProductApiV1

    Possible values: [PENALTY, FEE, PRINCIPAL, INTEREST]

    repaymentCurrencyRoundingstring

    Description for repaymentCurrencyRounding in LoanProductApiV1

    Possible values: [ROUND_UP_TO_NEAREST_WHOLE_UNIT, NO_ROUNDING, ROUND_TO_NEAREST_WHOLE_UNIT]

    repaymentElementsRoundingMethodstring

    Description for repaymentElementsRoundingMethod in LoanProductApiV1

    Possible values: [NO_ROUNDING, PAYMENT_DUE, ROUND_ALL]

    repaymentPeriodUnitstring

    Description for repaymentPeriodUnit in LoanProductApiV1

    Possible values: [MONTHS, YEARS, WEEKS, DAYS]

    repaymentReschedulingMethodstring

    Description for repaymentReschedulingMethod in LoanProductApiV1

    Possible values: [PREVIOUS_WORKING_DAY, NEXT_WORKING_DAY, NONE, EXTEND_SCHEDULE]

    repaymentScheduleEditOptionsstring[]

    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]

    repaymentScheduleMethodstring

    Description for repaymentScheduleMethod in LoanProductApiV1

    Possible values: [FIXED, NONE, DYNAMIC]

    roundingRepaymentScheduleMethodstring

    Description for roundingRepaymentScheduleMethod in LoanProductApiV1

    Possible values: [ROUND_PRINCIPAL_AND_INTEREST_REMAINDER_INTO_LAST_REPAYMENT, NO_ROUNDING, ROUND_REMAINDER_INTO_LAST_REPAYMENT]

    scheduleDueDatesMethodstring

    Description for scheduleDueDatesMethod in LoanProductApiV1

    Possible values: [INTERVAL, FIXED_DAYS_OF_MONTH]

    scheduleInterestDaysCountMethodstring

    Description for scheduleInterestDaysCountMethod in LoanProductApiV1

    Possible values: [USING_REPAYMENT_PERIODICITY, USING_ACTUAL_DAYS_COUNT]

    settlementOptionsstring

    Description for settlementOptions in LoanProductApiV1

    Possible values: [NO_AUTOMATED_TRANSFERS, PARTIAL_DUE_AMOUNTS, FULL_DUE_AMOUNTS]

    shortMonthHandlingMethodstring

    Description for shortMonthHandlingMethod in LoanProductApiV1

    Possible values: [LAST_DAY_IN_MONTH, FIRST_DAY_OF_NEXT_MONTH]

    taxCalculationMethodstring

    Description for taxCalculationMethod in LoanProductApiV1

    Possible values: [EXCLUSIVE, INCLUSIVE]

    taxSourceKeystring

    Description for taxSourceKey in LoanProductApiV1

    taxesOnFeesEnabledboolean

    Description for taxesOnFeesEnabled in LoanProductApiV1

    taxesOnInterestEnabledboolean

    Description for taxesOnInterestEnabled in LoanProductApiV1

    taxesOnPenaltyEnabledboolean

    Description for taxesOnPenaltyEnabled in LoanProductApiV1

    templates object[]

    Description for templates in LoanProductApiV1

  • Array [
  • creationDatestring

    Description for creationDate in DocumentTemplateApiV1

    encodedKeystring

    Description for encodedKey in DocumentTemplateApiV1

    lastModifiedDatestring

    Description for lastModifiedDate in DocumentTemplateApiV1

    namestring

    Description for name in DocumentTemplateApiV1

    typestring

    Description for type in DocumentTemplateApiV1

    Possible values: [ACCOUNT, ACCOUNT_WITH_TRANSACTIONS, TRANSACTION]

  • ]
  • Loanproductbranchapiv1
    {
    "branchKey": "string",
    "encodedKey": "string",
    "product": {
    "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": "string",
    "maxTolerancePeriod": 0,
    "minTolerancePeriod": 0,
    "monthlyToleranceDay": 0,
    "nonWorkingDaysMethod": "EXCLUDED",
    "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY"
    },
    "autoCreateLinkedAccounts": true,
    "autoLinkAccounts": true,
    "availableProductBranches": [
    null
    ],
    "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": "string",
    "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": "string",
    "indexSourceKey": "string",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestChargeFrequencyCount": 0,
    "interestRateCeilingValue": 0,
    "interestRateFloorValue": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED_PERIOD",
    "interestRateTiers": [
    {
    "encodedKey": "string",
    "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": "string",
    "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": "string",
    "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
    "feeApplication": "OPTIONAL",
    "feeProductRules": [
    {
    "account": {
    "activated": true,
    "allowManualJournalEntries": true,
    "balance": 0,
    "creationDate": "string",
    "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": "string",
    "migrationEvent": {
    "creationDate": "string",
    "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": "string",
    "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": "string",
    "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": "string",
    "migrationEvent": {
    "creationDate": "string",
    "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": "string",
    "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": {
    "encodedKey": "string",
    "isOffsetEnabled": true,
    "loanProduct": {}
    },
    "paymentMethod": "VERTICAL",
    "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
    "prepaymentRecalculationMethod": "NO_RECALCULATION",
    "principalPaidInstallmentStatus": "PARTIALLY_PAID",
    "principalPaymentSettings": {
    "defaultAmount": 0,
    "defaultPercentage": 0,
    "encodedKey": "string",
    "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": "string",
    "funderInterestCommission": {
    "defaultValue": 0,
    "encodedKey": "string",
    "maxValue": 0,
    "minValue": 0
    },
    "funderInterestCommissionAllocationType": "PERCENTAGE_OF_LOAN_FUNDING",
    "isCollateralEnabled": true,
    "isGuarantorsEnabled": true,
    "isInvestorFundsEnabled": true,
    "lockFundsAtApproval": true,
    "organizationInterestCommission": {
    "defaultValue": 0,
    "encodedKey": "string",
    "maxValue": 0,
    "minValue": 0
    },
    "requiredGuaranties": 0,
    "requiredInvestorFunds": 0
    },
    "redrawSettings": {
    "allowRedraw": true,
    "encodedKey": "string"
    },
    "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": "string",
    "lastModifiedDate": "string",
    "name": "string",
    "type": "ACCOUNT"
    }
    ]
    }
    }