Skip to main content

Feessettings

Defines fees settings for the product.

allowArbitraryFeesboolean

Only if true users will be able to apply fees, for current object, of type 'Other'; these fees can have any amount.

fees object[]

List of all fees that can be applied for accounts of this loan product.

  • Array [
  • accountingRules object[]

    A list of accounting rules defined for this fee. If null, product default rules are selected.

  • Array [
  • encodedKeystring

    The encoded key of the accounting rule, auto generated, unique.

    financialResourcestringrequired

    General Ledger Financial Resources used to setup the product accounting rules and determine the credit and debit accounts when logging journal entries

    Possible values: [PORTFOLIO_CONTROL, FUND_SOURCE, WRITE_OFF_EXPENSE, INTEREST_INCOME, PAYMENT_HOLIDAY_INTEREST_INCOME, TAXES_PAYABLE, FEE_INCOME, PENALTY_INCOME, NEGATIVE_INTEREST_PAYABLE_RECEIVABLE, NEGATIVE_INTEREST_PAYABLE, INTEREST_RECEIVABLE, PAYMENT_HOLIDAY_INTEREST_RECEIVABLE, FEE_RECEIVABLE, PENALTY_RECEIVABLE, TAXES_RECEIVABLE, DEFERRED_INTERESTS_INCOME, DEFERRED_FEE_INCOME, DEFERRED_TAXES, DEPOSIT_REFERENCE, SAVINGS_CONTROL, INTEREST_EXPENSE, INTEREST_PAYABLE, NEGATIVE_INTEREST_INCOME, NEGATIVE_INTEREST_RECEIVABLE, OVERDRAFT_PORTFOLIO_CONTROL, OVERDRAFT_INTEREST_INCOME, OVERDRAFT_WRITE_OFF_EXPENSE, OVERDRAFT_INTEREST_RECEIVABLE, INTER_BRANCH_TRANSFER, INTEREST_FROM_ARREARS_INCOME, INTEREST_FROM_ARREARS_RECEIVABLE, INTEREST_FROM_ARREARS_WRITE_OFF_EXPENSE, PROFIT_EXPENSE, PROFIT_PAYABLE, MUDARIB_SHARE, DISTRIBUTABLE_PROFIT, INTEREST_FROM_FEES_INCOME, INTEREST_FROM_FEES_RECEIVABLE, INTEREST_FROM_FEES_WRITE_OFF_EXPENSE, CREDIT_BALANCE_PAYABLE]

    glAccountKeystringrequired

    The encoded key of the account that is mapped to the financialResource

    transactionChannelKeystring

    The key of the transaction rule that uses this rule

  • ]
  • amortizationSettings object

    The settings for defining period intervals.

    amortizationProfilestring

    Type of amortization profile used for fee

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

    encodedKeystring

    The encoded key of the period interval settings, auto generated, unique.

    feeAmortizationUponRescheduleRefinanceOptionstring

    Flag for signaling if fee amortization should be continued or finished at account reschedule/refinance

    Possible values: [END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT, CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT]

    frequencystring

    Frequency settings of the fee amortization

    Possible values: [ACCOUNT_INSTALLMENTS_DUE_DATES, ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING, CUSTOM_INTERVAL]

    intervalCountinteger<int32>

    Total number of intervals

    intervalTypestring

    Defines the options for an interval

    Possible values: [PREDEFINED_INTERVALS, FULL_TERM]

    periodCountinteger<int32>

    Period count used in conjunction with periodUnit to determine the next date of the interval

    periodUnitstring

    Amortization unit to determine the interval between amortizations

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

    amountnumber

    The amount of the fee

    amountCalculationFunctionNamestring

    Mambu Function name used for the fee calculation

    amountCalculationMethodstring

    The amount from which the fee is calculated using percentageAmount

    Possible values: [FLAT, LOAN_AMOUNT_PERCENTAGE, REPAYMENT_PRINCIPAL_AMOUNT_PERCENTAGE, LOAN_AMOUNT_PERCENTAGE_NUMBER_OF_INSTALLMENTS, FLAT_NUMBER_OF_INSTALLMENTS, IOF_PERCENTAGE_OF_DISBURSED_AMOUNT, IOF_PERCENTAGE_OF_INSTALLMENT_PRINCIPAL, IOF_PERCENTAGE_OF_LATE_INSTALLMENT_PRINCIPAL, MAMBU_FUNCTION, FEE_RATE_ON_OUTSTANDING_PRINCIPAL]

    applyDateMethodstring

    Shows when a fee should be applied; to be used with monthly deposit fees

    Possible values: [MONTHLY_FROM_ACTIVATION, FIRST_OF_EVERY_MONTH]

    creationDatestring<date-time>

    Shows the creation date of the fee

    Example: 2016-09-06T13:37:50+03:00
    defaultFeeRatenumber

    The rate of the fee applied to parentSource

    encodedKeystring

    The encoded key of the predefined fee, auto generated, unique

    feeApplicationstringrequired

    The type of fee application when disbursement is applied

    Possible values: [REQUIRED, OPTIONAL]

    idstring

    The id of the fee

    includeInPenaltyboolean

    Indicates if the fee can be included in penalty calculation

    interestBearingboolean

    Indication if the fee bears interest

    lastModifiedDatestring<date-time>

    Shows the last modified date of the fee

    Example: 2016-09-06T13:37:50+03:00
    namestring

    The name of the fee

    percentageAmountnumber

    The amount of the fee in percents applied to percentSource

    scheduleAllocationMethodstring

    Method to allocate a fee to installments on the schedule

    Possible values: [ON_INSTALLMENT, NO_ALLOCATION]

    statestringrequired

    Indicates the state of the fee

    Possible values: [ACTIVE, INACTIVE]

    taxSettings object

    Tax settings for a specific Predefined fee that overrides the tax settings of Loan Product

    taxableCalculationMethodstring

    Marks a specific fee as non-taxable (taxes are not calculated for it).Feature is in the Early Stage. To be enabled by request.

    Possible values: [DEFAULT, NON_TAXABLE, CUSTOM_TAX]

    triggerstringrequired

    Shows the event that will trigger a fee

    Possible values: [MANUAL, MANUAL_PLANNED, DISBURSEMENT, CAPITALIZED_DISBURSEMENT, UPFRONT_DISBURSEMENT, LATE_REPAYMENT, PAYMENT_DUE, PAYMENT_DUE_APPLIED_ON_DUE_DATES, ARBITRARY, IOF, EARLY_REPAYMENT_CHARGE, FEE_INCLUDED_IN_PMT]

  • ]
  • Feessettings
    {
    "allowArbitraryFees": true,
    "fees": [
    {
    "accountingRules": [
    {
    "encodedKey": "string",
    "financialResource": "PORTFOLIO_CONTROL",
    "glAccountKey": "string",
    "transactionChannelKey": "string"
    }
    ],
    "amortizationSettings": {
    "amortizationProfile": "NONE",
    "encodedKey": "string",
    "feeAmortizationUponRescheduleRefinanceOption": "END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT",
    "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES",
    "intervalCount": 0,
    "intervalType": "PREDEFINED_INTERVALS",
    "periodCount": 0,
    "periodUnit": "DAYS"
    },
    "amount": 0,
    "amountCalculationFunctionName": "string",
    "amountCalculationMethod": "FLAT",
    "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
    "creationDate": "2016-09-06T13:37:50+03:00",
    "defaultFeeRate": 0,
    "encodedKey": "string",
    "feeApplication": "REQUIRED",
    "id": "string",
    "includeInPenalty": true,
    "interestBearing": true,
    "lastModifiedDate": "2016-09-06T13:37:50+03:00",
    "name": "string",
    "percentageAmount": 0,
    "scheduleAllocationMethod": "ON_INSTALLMENT",
    "state": "ACTIVE",
    "taxSettings": {
    "taxableCalculationMethod": "DEFAULT"
    },
    "trigger": "MANUAL"
    }
    ]
    }