Skip to main content

Predefinedfeeapiv1

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]

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