Predefinedfeeapiv1
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]
{
"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"
}