Loantransactionapiv1
Description for advancePosition in LoanTransactionApiV1
Description for amount in LoanTransactionApiV1
Description for arrearsPosition in LoanTransactionApiV1
Description for balance in LoanTransactionApiV1
Description for bookingDate in LoanTransactionApiV1
Description for branchKey in LoanTransactionApiV1
Description for centreKey in LoanTransactionApiV1
Description for comment in LoanTransactionApiV1
Description for creationDate in LoanTransactionApiV1
customInformation object[]
Description for customInformation in LoanTransactionApiV1
Description for amount in CustomFieldValueApiV1
customField object
Description for customField in CustomFieldValueApiV1
amounts object
Description for amounts in CustomFieldApiV1
Description for builtInCustomFieldId in CustomFieldApiV1
Possible values: [MOBILE_PHONE, EMAIL_ADDRESS, GENDER, MIDDLE_NAME, HOME_PHONE, BIRTHDATE, LAST_NAME, FIRST_NAME]
Description for creationDate in CustomFieldApiV1
customFieldProductSettings object[]
Description for customFieldProductSettings in CustomFieldApiV1
Description for customFieldEncodedKey in CustomFieldLinkApiV1
Description for encodedKey in CustomFieldLinkApiV1
Description for isDefault in CustomFieldLinkApiV1
Description for isRequired in CustomFieldLinkApiV1
Description for linkType in CustomFieldLinkApiV1
Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]
Description for productKey in CustomFieldLinkApiV1
customFieldSelectionOptions object[]
Description for customFieldSelectionOptions in CustomFieldApiV1
constraint object
Description for constraint in CustomFieldSelectionApiV1
Description for customFieldKey in CustomFilterConstraintApiV1
Description for dataFieldType in CustomFilterConstraintApiV1
Possible values: [NATIVE, CUSTOM]
Description for dataFieldValue in CustomFilterConstraintApiV1
Description for dataItemType in CustomFilterConstraintApiV1
Possible values: [WRITTEN_OFF_LOANS, LINE_OF_CREDIT, INVESTOR_FUND, TRANSACTION_DETAILS, DOCUMENT_TEMPLATE, PRODUCT, MCC_EXPIRATION, CENTRE, REPAYMENT_COLLECTION, TASK, OUTSTANDING_PORTFOLIO_AMOUNTS, REVENUE, COMPOSED_TRANSACTIONS, UNION_TRANSACTIONS, PRINCIPAL_PAYMENT_SETTINGS, LOANS, DISBURSEMENT_DETAILS, SAVINGS_TRANSACTION, IDENTIFICATION_DOCUMENT, LOAN_PRODUCT, DISBURSED_LOANS, LOAN_GROUP, TRANSACTION_CHANNEL, CUSTOM_PREDEFINED_FEE, JOURNAL_ENTRY, ATTACHMENT, PREDEFINED_FEE, TRANCHE, TRANSACTION, INDEX_RATE_SOURCE, GROUP_ROLE, LOAN_TRANSACTION, CLIENT_ROLE, GROUP, NOTIFICATION_MESSAGE, OUTSTANDING_PORTFOLIO_ACCOUNTS, REPAYMENT, LOAN_ACCOUNT_GUARANTY, BRANCH, CURRENCY, CARD_TRANSACTION_REVERSAL, INTEREST_PRODUCT_SETTINGS, CREATED_ACCOUNTS, USER, SAVINGS_PRODUCT, CLIENT, PRODUCT_ARREARS_SETTINGS, SAVINGS, EXPENSE, INDEX_RATE, NOTIFICATION_TEMPLATE, CUSTOM_FIELD_SELECTION, ACTIVITY]
Description for dataType in CustomFilterConstraintApiV1
Possible values: [ENUM, MONEY, NUMBER, DATE_UTC, JAVA_BLOB, OBJECT, BOOLEAN, DATE, PERCENT, BIG_DECIMAL, STRING, KEY, LONG]
Description for encodedKey in CustomFilterConstraintApiV1
Description for filterElement in CustomFilterConstraintApiV1
Possible values: [STARTS_WITH_CASE_SENSITIVE, THIS_WEEK, EQUALS, STARTS_WITH, IN, TODAY, THIS_YEAR, BETWEEN, AFTER, LESS_THAN, DIFFERENT_THAN, THIS_MONTH, NOT_EMPTY, BEFORE, EQUALS_CASE_SENSITIVE, LAST_DAYS, MORE_THAN, EMPTY, ON]
Description for groupNumber in CustomFilterConstraintApiV1
Description for index in CustomFilterConstraintApiV1
Description for linkingOperator in CustomFilterConstraintApiV1
Possible values: [OR, AND]
Description for secondValue in CustomFilterConstraintApiV1
Description for value in CustomFilterConstraintApiV1
Description for encodedKey in CustomFieldSelectionApiV1
Description for id in CustomFieldSelectionApiV1
Description for score in CustomFieldSelectionApiV1
Description for value in CustomFieldSelectionApiV1
customFieldSet object
Description for customFieldSet in CustomFieldApiV1
Description for builtInType in CustomFieldSetApiV1
Possible values: [DETAILS, GENERAL]
Description for createdDate in CustomFieldSetApiV1
customFields object[]
Description for customFields in CustomFieldSetApiV1
Description for encodedKey in CustomFieldSetApiV1
Description for id in CustomFieldSetApiV1
Description for indexInList in CustomFieldSetApiV1
Description for lastModifiedDate in CustomFieldSetApiV1
Description for name in CustomFieldSetApiV1
Description for notes in CustomFieldSetApiV1
Description for type in CustomFieldSetApiV1
Possible values: [USER_INFO, ASSET_INFO, CLIENT_INFO, LINE_OF_CREDIT, GROUP_INFO, TRANSACTION_CHANNEL_INFO, BRANCH_INFO, SAVINGS_ACCOUNT_INFO, LOAN_ACCOUNT_INFO, GUARANTOR_INFO, CENTRE_INFO]
Description for usage in CustomFieldSetApiV1
Possible values: [SINGLE, GROUPED]
Description for dataType in CustomFieldApiV1
Possible values: [GROUP_LINK, DATE, NUMBER, CHECKBOX, CLIENT_LINK, STRING, USER_LINK, SELECTION]
Description for description in CustomFieldApiV1
editRights object
Description for editRights in CustomFieldApiV1
Description for encodedKey in UsageRightsApiV1
Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
Description for encodedKey in CustomFieldApiV1
Description for id in CustomFieldApiV1
Description for indexInList in CustomFieldApiV1
Description for isDefault in CustomFieldApiV1
Description for isRequired in CustomFieldApiV1
Description for lastModifiedDate in CustomFieldApiV1
Description for name in CustomFieldApiV1
Description for state in CustomFieldApiV1
Possible values: [DEACTIVATED, NORMAL]
Description for type in CustomFieldApiV1
Possible values: [USER_INFO, ASSET_INFO, CLIENT_INFO, LINE_OF_CREDIT, GROUP_INFO, TRANSACTION_CHANNEL_INFO, BRANCH_INFO, SAVINGS_ACCOUNT_INFO, LOAN_ACCOUNT_INFO, GUARANTOR_INFO, CENTRE_INFO]
Description for unique in CustomFieldApiV1
Description for validationPattern in CustomFieldApiV1
Description for valueLength in CustomFieldApiV1
Possible values: [SHORT, LONG]
Description for values in CustomFieldApiV1
viewRights object
Description for viewRights in CustomFieldApiV1
Description for encodedKey in UsageRightsApiV1
Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
Description for customFieldID in CustomFieldValueApiV1
Description for customFieldKey in CustomFieldValueApiV1
Description for customFieldSetGroupIndex in CustomFieldValueApiV1
Description for encodedKey in CustomFieldValueApiV1
Description for indexInList in CustomFieldValueApiV1
Description for linkedEntityKeyValue in CustomFieldValueApiV1
Description for parentKey in CustomFieldValueApiV1
Description for selectionKey in CustomFieldValueApiV1
Description for value in CustomFieldValueApiV1
customPaymentAmounts object[]
Description for customPaymentAmounts in LoanTransactionApiV1
Description for amount in CustomPaymentAmountApiV1
Description for customPaymentAmountType in CustomPaymentAmountApiV1
Possible values: [PAYMENT_DUE_FEE, PENALTY, MANUAL_FEE, PRINCIPAL, UPFRONT_DISBURSEMENT_FEE, LATE_REPAYMENT_FEE, INTEREST]
Description for encodedKey in CustomPaymentAmountApiV1
Description for index in CustomPaymentAmountApiV1
Description for loanTransactionKey in CustomPaymentAmountApiV1
Description for taxOnAmount in CustomPaymentAmountApiV1
Description for deferredInterestAmount in LoanTransactionApiV1
Description for deferredTaxOnInterestAmount in LoanTransactionApiV1
details object
Description for details in LoanTransactionApiV1
Description for encodedKey in TransactionDetailsApiV1
Description for internalTransfer in TransactionDetailsApiV1
Description for targetSavingsAccountKey in TransactionDetailsApiV1
transactionChannel object
Description for transactionChannel in TransactionDetailsApiV1
Description for activated in TransactionChannelInTransactionDetailsApiV1
Description for createdByUserKey in TransactionChannelInTransactionDetailsApiV1
Description for creationDate in TransactionChannelInTransactionDetailsApiV1
customFields object[]
Description for customFields in TransactionChannelInTransactionDetailsApiV1
amounts object
Description for amounts in CustomFieldApiV1
Description for builtInCustomFieldId in CustomFieldApiV1
Possible values: [MOBILE_PHONE, EMAIL_ADDRESS, GENDER, MIDDLE_NAME, HOME_PHONE, BIRTHDATE, LAST_NAME, FIRST_NAME]
Description for creationDate in CustomFieldApiV1
customFieldProductSettings object[]
Description for customFieldProductSettings in CustomFieldApiV1
Description for customFieldEncodedKey in CustomFieldLinkApiV1
Description for encodedKey in CustomFieldLinkApiV1
Description for isDefault in CustomFieldLinkApiV1
Description for isRequired in CustomFieldLinkApiV1
Description for linkType in CustomFieldLinkApiV1
Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]
Description for productKey in CustomFieldLinkApiV1
customFieldSelectionOptions object[]
Description for customFieldSelectionOptions in CustomFieldApiV1
constraint object
Description for constraint in CustomFieldSelectionApiV1
Description for customFieldKey in CustomFilterConstraintApiV1
Description for dataFieldType in CustomFilterConstraintApiV1
Possible values: [NATIVE, CUSTOM]
Description for dataFieldValue in CustomFilterConstraintApiV1
Description for dataItemType in CustomFilterConstraintApiV1
Possible values: [WRITTEN_OFF_LOANS, LINE_OF_CREDIT, INVESTOR_FUND, TRANSACTION_DETAILS, DOCUMENT_TEMPLATE, PRODUCT, MCC_EXPIRATION, CENTRE, REPAYMENT_COLLECTION, TASK, OUTSTANDING_PORTFOLIO_AMOUNTS, REVENUE, COMPOSED_TRANSACTIONS, UNION_TRANSACTIONS, PRINCIPAL_PAYMENT_SETTINGS, LOANS, DISBURSEMENT_DETAILS, SAVINGS_TRANSACTION, IDENTIFICATION_DOCUMENT, LOAN_PRODUCT, DISBURSED_LOANS, LOAN_GROUP, TRANSACTION_CHANNEL, CUSTOM_PREDEFINED_FEE, JOURNAL_ENTRY, ATTACHMENT, PREDEFINED_FEE, TRANCHE, TRANSACTION, INDEX_RATE_SOURCE, GROUP_ROLE, LOAN_TRANSACTION, CLIENT_ROLE, GROUP, NOTIFICATION_MESSAGE, OUTSTANDING_PORTFOLIO_ACCOUNTS, REPAYMENT, LOAN_ACCOUNT_GUARANTY, BRANCH, CURRENCY, CARD_TRANSACTION_REVERSAL, INTEREST_PRODUCT_SETTINGS, CREATED_ACCOUNTS, USER, SAVINGS_PRODUCT, CLIENT, PRODUCT_ARREARS_SETTINGS, SAVINGS, EXPENSE, INDEX_RATE, NOTIFICATION_TEMPLATE, CUSTOM_FIELD_SELECTION, ACTIVITY]
Description for dataType in CustomFilterConstraintApiV1
Possible values: [ENUM, MONEY, NUMBER, DATE_UTC, JAVA_BLOB, OBJECT, BOOLEAN, DATE, PERCENT, BIG_DECIMAL, STRING, KEY, LONG]
Description for encodedKey in CustomFilterConstraintApiV1
Description for filterElement in CustomFilterConstraintApiV1
Possible values: [STARTS_WITH_CASE_SENSITIVE, THIS_WEEK, EQUALS, STARTS_WITH, IN, TODAY, THIS_YEAR, BETWEEN, AFTER, LESS_THAN, DIFFERENT_THAN, THIS_MONTH, NOT_EMPTY, BEFORE, EQUALS_CASE_SENSITIVE, LAST_DAYS, MORE_THAN, EMPTY, ON]
Description for groupNumber in CustomFilterConstraintApiV1
Description for index in CustomFilterConstraintApiV1
Description for linkingOperator in CustomFilterConstraintApiV1
Possible values: [OR, AND]
Description for secondValue in CustomFilterConstraintApiV1
Description for value in CustomFilterConstraintApiV1
Description for encodedKey in CustomFieldSelectionApiV1
Description for id in CustomFieldSelectionApiV1
Description for score in CustomFieldSelectionApiV1
Description for value in CustomFieldSelectionApiV1
customFieldSet object
Description for customFieldSet in CustomFieldApiV1
Description for builtInType in CustomFieldSetApiV1
Possible values: [DETAILS, GENERAL]
Description for createdDate in CustomFieldSetApiV1
Description for customFields in CustomFieldSetApiV1
Description for encodedKey in CustomFieldSetApiV1
Description for id in CustomFieldSetApiV1
Description for indexInList in CustomFieldSetApiV1
Description for lastModifiedDate in CustomFieldSetApiV1
Description for name in CustomFieldSetApiV1
Description for notes in CustomFieldSetApiV1
Description for type in CustomFieldSetApiV1
Possible values: [USER_INFO, ASSET_INFO, CLIENT_INFO, LINE_OF_CREDIT, GROUP_INFO, TRANSACTION_CHANNEL_INFO, BRANCH_INFO, SAVINGS_ACCOUNT_INFO, LOAN_ACCOUNT_INFO, GUARANTOR_INFO, CENTRE_INFO]
Description for usage in CustomFieldSetApiV1
Possible values: [SINGLE, GROUPED]
Description for dataType in CustomFieldApiV1
Possible values: [GROUP_LINK, DATE, NUMBER, CHECKBOX, CLIENT_LINK, STRING, USER_LINK, SELECTION]
Description for description in CustomFieldApiV1
editRights object
Description for editRights in CustomFieldApiV1
Description for encodedKey in UsageRightsApiV1
Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
Description for encodedKey in CustomFieldApiV1
Description for id in CustomFieldApiV1
Description for indexInList in CustomFieldApiV1
Description for isDefault in CustomFieldApiV1
Description for isRequired in CustomFieldApiV1
Description for lastModifiedDate in CustomFieldApiV1
Description for name in CustomFieldApiV1
Description for state in CustomFieldApiV1
Possible values: [DEACTIVATED, NORMAL]
Description for type in CustomFieldApiV1
Possible values: [USER_INFO, ASSET_INFO, CLIENT_INFO, LINE_OF_CREDIT, GROUP_INFO, TRANSACTION_CHANNEL_INFO, BRANCH_INFO, SAVINGS_ACCOUNT_INFO, LOAN_ACCOUNT_INFO, GUARANTOR_INFO, CENTRE_INFO]
Description for unique in CustomFieldApiV1
Description for validationPattern in CustomFieldApiV1
Description for valueLength in CustomFieldApiV1
Possible values: [SHORT, LONG]
Description for values in CustomFieldApiV1
viewRights object
Description for viewRights in CustomFieldApiV1
Description for encodedKey in UsageRightsApiV1
Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
Description for encodedKey in TransactionChannelInTransactionDetailsApiV1
Description for id in TransactionChannelInTransactionDetailsApiV1
Description for index in TransactionChannelInTransactionDetailsApiV1
Description for name in TransactionChannelInTransactionDetailsApiV1
savingsConstraints object
Description for savingsConstraints in TransactionChannelInTransactionDetailsApiV1
customConfigurationInfo object
Description for customConfigurationInfo in CustomFilterApiV1
Description for creationDate in CustomConfigurationInfoApiV1
Description for dataViewType in CustomConfigurationInfoApiV1
Possible values: [PORTAL_ACCOUNT_TRANSACTION, LOANS_AGING_ANALYSIS, CLOSED_ACCOUNTS, CLIENT_OVERVIEW, ADMIN_CENTRES, USER_NOTIFICATION_MESSAGES, LINE_OF_CREDIT, USER_OVERVIEW, CENTRE_OVERVIEW, REPAYMENT_REPAYMENTS_COLLECTION, GROUP_OVERVIEW, ACTIVITIES_LOOKUP, TRANSACTION, ADMIN_BRANCHES, GROUP, BRANCH_OVERVIEW, NOTIFICATION_MESSAGE, PORTFOLIO_REPORTS, GROUP_NOTIFICATION_MESSAGES, LOAN_ACCOUNT_SECURITIES_OVERVIEW, LINE_OF_CREDIT_OVERVIEW, CURRENCIES, REPAYMENT, TILL_TRANSACTIONS, ALL_TASKS, CENTRE, BRANCH, INDEX_RATES_LIST, USER_TASKS, DOCUMENT_TEMPLATES, SAVINGS_TRANSACTIONS_LOOKUP, LOAN_ACCOUNT_OVERVIEW, DEPOSITS_COLLECTION, USER, ADMIN_USERS, GROUP_TASKS, CLIENT, LOAN_TRANSACTIONS_LOOKUP, LOANS, LOANS_REPAYMENTS_COLLECTION, CLIENT_TASKS, OVERDRAFTS_AGING_ANALYSIS, LOAN_ACCOUNT_FUNDING_OVERVIEW, SAVINGS, SAVINGS_OVERVIEW, JOURNAL_ENTRY, CLIENT_NOTIFICATION_MESSAGES]
Description for encodedKey in CustomConfigurationInfoApiV1
Description for indexInList in CustomConfigurationInfoApiV1
Description for lastModifiedDate in CustomConfigurationInfoApiV1
Description for name in CustomConfigurationInfoApiV1
Description for shared in CustomConfigurationInfoApiV1
Description for userKey in CustomConfigurationInfoApiV1
Description for encodedKey in CustomFilterApiV1
filterConstraints object[]
Description for filterConstraints in CustomFilterApiV1
Description for customFieldKey in CustomFilterConstraintApiV1
Description for dataFieldType in CustomFilterConstraintApiV1
Possible values: [NATIVE, CUSTOM]
Description for dataFieldValue in CustomFilterConstraintApiV1
Description for dataItemType in CustomFilterConstraintApiV1
Possible values: [WRITTEN_OFF_LOANS, LINE_OF_CREDIT, INVESTOR_FUND, TRANSACTION_DETAILS, DOCUMENT_TEMPLATE, PRODUCT, MCC_EXPIRATION, CENTRE, REPAYMENT_COLLECTION, TASK, OUTSTANDING_PORTFOLIO_AMOUNTS, REVENUE, COMPOSED_TRANSACTIONS, UNION_TRANSACTIONS, PRINCIPAL_PAYMENT_SETTINGS, LOANS, DISBURSEMENT_DETAILS, SAVINGS_TRANSACTION, IDENTIFICATION_DOCUMENT, LOAN_PRODUCT, DISBURSED_LOANS, LOAN_GROUP, TRANSACTION_CHANNEL, CUSTOM_PREDEFINED_FEE, JOURNAL_ENTRY, ATTACHMENT, PREDEFINED_FEE, TRANCHE, TRANSACTION, INDEX_RATE_SOURCE, GROUP_ROLE, LOAN_TRANSACTION, CLIENT_ROLE, GROUP, NOTIFICATION_MESSAGE, OUTSTANDING_PORTFOLIO_ACCOUNTS, REPAYMENT, LOAN_ACCOUNT_GUARANTY, BRANCH, CURRENCY, CARD_TRANSACTION_REVERSAL, INTEREST_PRODUCT_SETTINGS, CREATED_ACCOUNTS, USER, SAVINGS_PRODUCT, CLIENT, PRODUCT_ARREARS_SETTINGS, SAVINGS, EXPENSE, INDEX_RATE, NOTIFICATION_TEMPLATE, CUSTOM_FIELD_SELECTION, ACTIVITY]
Description for dataType in CustomFilterConstraintApiV1
Possible values: [ENUM, MONEY, NUMBER, DATE_UTC, JAVA_BLOB, OBJECT, BOOLEAN, DATE, PERCENT, BIG_DECIMAL, STRING, KEY, LONG]
Description for encodedKey in CustomFilterConstraintApiV1
Description for filterElement in CustomFilterConstraintApiV1
Possible values: [STARTS_WITH_CASE_SENSITIVE, THIS_WEEK, EQUALS, STARTS_WITH, IN, TODAY, THIS_YEAR, BETWEEN, AFTER, LESS_THAN, DIFFERENT_THAN, THIS_MONTH, NOT_EMPTY, BEFORE, EQUALS_CASE_SENSITIVE, LAST_DAYS, MORE_THAN, EMPTY, ON]
Description for groupNumber in CustomFilterConstraintApiV1
Description for index in CustomFilterConstraintApiV1
Description for linkingOperator in CustomFilterConstraintApiV1
Possible values: [OR, AND]
Description for secondValue in CustomFilterConstraintApiV1
Description for value in CustomFilterConstraintApiV1
Description for savingsConstraintsUsage in TransactionChannelInTransactionDetailsApiV1
Possible values: [UNCONSTRAINED_USAGE, LIMITED_USAGE]
transactionChannelAccountingRule object
Description for transactionChannelAccountingRule in TransactionChannelInTransactionDetailsApiV1
account object
Description for account in GLAccountingRuleApiV1
Description for activated in GLAccountApiV1
Description for allowManualJournalEntries in GLAccountApiV1
Description for balance in GLAccountApiV1
Description for creationDate in GLAccountApiV1
currency object
Description for currency in GLAccountApiV1
Description for code in CurrencyApiV1
Description for creationDate in CurrencyApiV1
Description for currencySymbolPosition in CurrencyApiV1
Possible values: [AFTER_NUMBER, BEFORE_NUMBER]
Description for digitsAfterDecimal in CurrencyApiV1
Description for isBaseCurrency in CurrencyApiV1
Description for lastModifiedDate in CurrencyApiV1
Description for name in CurrencyApiV1
Description for symbol in CurrencyApiV1
Description for description in GLAccountApiV1
Description for encodedKey in GLAccountApiV1
Description for glCode in GLAccountApiV1
Description for lastModifiedDate in GLAccountApiV1
migrationEvent object
Description for migrationEvent in GLAccountApiV1
Description for creationDate in DataMigrationEventApiV1
Description for encodedKey in DataMigrationEventApiV1
Description for numCentresImported in DataMigrationEventApiV1
Description for numClientsImported in DataMigrationEventApiV1
Description for numGLAccountsImported in DataMigrationEventApiV1
Description for numGroupsImported in DataMigrationEventApiV1
Description for numLoanRepaymentsImported in DataMigrationEventApiV1
Description for numLoanTransactionsImported in DataMigrationEventApiV1
Description for numLoansImported in DataMigrationEventApiV1
Description for numSavingsImported in DataMigrationEventApiV1
Description for state in DataMigrationEventApiV1
Possible values: [REVERTED, DRAFT, APPROVED]
Description for type in DataMigrationEventApiV1
Possible values: [IMPORT, EXPORT]
Description for name in GLAccountApiV1
Description for stripTrailingZeros in GLAccountApiV1
Description for type in GLAccountApiV1
Possible values: [INCOME, EXPENSE, LIABILITY, ASSET, EQUITY]
Description for usage in GLAccountApiV1
Possible values: [HEADER, DETAIL]
Description for encodedKey in GLAccountingRuleApiV1
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]
Description for index in GLAccountingRuleApiV1
Description for predefinedFeeKey in GLAccountingRuleApiV1
Description for productKey in GLAccountingRuleApiV1
Description for productType in GLAccountingRuleApiV1
Possible values: [LOAN, SAVINGS]
Description for transactionChannelKey in GLAccountingRuleApiV1
usageRights object
Description for usageRights in TransactionChannelInTransactionDetailsApiV1
Description for encodedKey in UsageRightsApiV1
Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
Description for transactionChannelKey in TransactionDetailsApiV1
Description for encodedKey in LoanTransactionApiV1
Description for entryDate in LoanTransactionApiV1
Description for expectedPrincipalRedraw in LoanTransactionApiV1
Description for feesPaid in LoanTransactionApiV1
Description for fundersInterestAmount in LoanTransactionApiV1
indexInterestRate object
Description for indexInterestRate in LoanTransactionApiV1
Description for encodedKey in IndexRateApiV1
Description for notes in IndexRateApiV1
Description for rate in IndexRateApiV1
rateSource object
Description for rateSource in IndexRateApiV1
Description for encodedKey in IndexRateSourceApiV1
Description for name in IndexRateSourceApiV1
Description for notes in IndexRateSourceApiV1
Description for type in IndexRateSourceApiV1
Possible values: [TAX_RATE, INTEREST_RATE, WITHHOLDING_TAX_RATE]
Description for startDate in IndexRateApiV1
Description for userKey in IndexRateApiV1
Description for interestFromArrearsAmount in LoanTransactionApiV1
Description for interestPaid in LoanTransactionApiV1
Description for interestRate in LoanTransactionApiV1
loanPredefinedFeeAmounts object[]
Description for loanPredefinedFeeAmounts in LoanTransactionApiV1
amortizedAmounts object[]
Description for amortizedAmounts in PredefinedFeeAmountApiV1
Description for amount in AmortizationAmountApiV1
Description for branchKey in AmortizationAmountApiV1
Description for centreKey in AmortizationAmountApiV1
Description for creationDate in AmortizationAmountApiV1
Description for encodedKey in AmortizationAmountApiV1
Description for entryDate in AmortizationAmountApiV1
Description for reversalAmountKey in AmortizationAmountApiV1
Description for taxAmount in AmortizationAmountApiV1
Description for type in AmortizationAmountApiV1
Possible values: [AMORTIZATION_ADJUSTMENT, AMORTIZATION_CORRECTION, AMORTIZATION]
Description for amount in PredefinedFeeAmountApiV1
Description for encodedKey in PredefinedFeeAmountApiV1
fee object
Description for fee in PredefinedFeeAmountApiV1
Description for active in PredefinedFeeApiV1
amortizationIntervalSettings object
Description for amortizationIntervalSettings in PredefinedFeeApiV1
Description for encodedKey in PeriodIntervalSettingsApiV1
Description 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]
Description for creationDate in PredefinedFeeApiV1
Description for encodedKey in PredefinedFeeApiV1
Description 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
Description for activated in GLAccountApiV1
Description for allowManualJournalEntries in GLAccountApiV1
Description for balance in GLAccountApiV1
Description for creationDate in GLAccountApiV1
currency object
Description for currency in GLAccountApiV1
Description for code in CurrencyApiV1
Description for creationDate in CurrencyApiV1
Description for currencySymbolPosition in CurrencyApiV1
Possible values: [AFTER_NUMBER, BEFORE_NUMBER]
Description for digitsAfterDecimal in CurrencyApiV1
Description for isBaseCurrency in CurrencyApiV1
Description for lastModifiedDate in CurrencyApiV1
Description for name in CurrencyApiV1
Description for symbol in CurrencyApiV1
Description for description in GLAccountApiV1
Description for encodedKey in GLAccountApiV1
Description for glCode in GLAccountApiV1
Description for lastModifiedDate in GLAccountApiV1
migrationEvent object
Description for migrationEvent in GLAccountApiV1
Description for creationDate in DataMigrationEventApiV1
Description for encodedKey in DataMigrationEventApiV1
Description for numCentresImported in DataMigrationEventApiV1
Description for numClientsImported in DataMigrationEventApiV1
Description for numGLAccountsImported in DataMigrationEventApiV1
Description for numGroupsImported in DataMigrationEventApiV1
Description for numLoanRepaymentsImported in DataMigrationEventApiV1
Description for numLoanTransactionsImported in DataMigrationEventApiV1
Description for numLoansImported in DataMigrationEventApiV1
Description for numSavingsImported in DataMigrationEventApiV1
Description for state in DataMigrationEventApiV1
Possible values: [REVERTED, DRAFT, APPROVED]
Description for type in DataMigrationEventApiV1
Possible values: [IMPORT, EXPORT]
Description for name in GLAccountApiV1
Description for stripTrailingZeros in GLAccountApiV1
Description for type in GLAccountApiV1
Possible values: [INCOME, EXPENSE, LIABILITY, ASSET, EQUITY]
Description for usage in GLAccountApiV1
Possible values: [HEADER, DETAIL]
Description for encodedKey in GLAccountingRuleApiV1
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]
Description for index in GLAccountingRuleApiV1
Description for predefinedFeeKey in GLAccountingRuleApiV1
Description for productKey in GLAccountingRuleApiV1
Description for productType in GLAccountingRuleApiV1
Possible values: [LOAN, SAVINGS]
Description for transactionChannelKey in GLAccountingRuleApiV1
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 taxAmount in PredefinedFeeAmountApiV1
Description for transactionId in PredefinedFeeAmountApiV1
loanTransactionTerms object
Description for loanTransactionTerms in LoanTransactionApiV1
Description for encodedKey in LoanTransactionTermsApiV1
Description for principalPaymentAmount in LoanTransactionTermsApiV1
Description for principalPaymentPercentage in LoanTransactionTermsApiV1
migrationEvent object
Description for migrationEvent in LoanTransactionApiV1
Description for creationDate in DataMigrationEventApiV1
Description for encodedKey in DataMigrationEventApiV1
Description for numCentresImported in DataMigrationEventApiV1
Description for numClientsImported in DataMigrationEventApiV1
Description for numGLAccountsImported in DataMigrationEventApiV1
Description for numGroupsImported in DataMigrationEventApiV1
Description for numLoanRepaymentsImported in DataMigrationEventApiV1
Description for numLoanTransactionsImported in DataMigrationEventApiV1
Description for numLoansImported in DataMigrationEventApiV1
Description for numSavingsImported in DataMigrationEventApiV1
Description for state in DataMigrationEventApiV1
Possible values: [REVERTED, DRAFT, APPROVED]
Description for type in DataMigrationEventApiV1
Possible values: [IMPORT, EXPORT]
Description for organizationCommissionAmount in LoanTransactionApiV1
Description for originalAmount in LoanTransactionApiV1
Description for originalCurrencyCode in LoanTransactionApiV1
Description for parentAccountKey in LoanTransactionApiV1
Description for parentLoanTransactionKey in LoanTransactionApiV1
Description for penaltyPaid in LoanTransactionApiV1
Description for principalBalance in LoanTransactionApiV1
Description for principalPaid in LoanTransactionApiV1
Description for productTypeKey in LoanTransactionApiV1
Description for redrawBalance in LoanTransactionApiV1
Description for reversalTransactionKey in LoanTransactionApiV1
Description for taxOnFeesAmount in LoanTransactionApiV1
Description for taxOnInterestFromArrearsAmount in LoanTransactionApiV1
Description for taxOnInterestPaid in LoanTransactionApiV1
Description for taxOnPenaltyAmount in LoanTransactionApiV1
taxRate object
Description for taxRate in LoanTransactionApiV1
Description for encodedKey in IndexRateApiV1
Description for notes in IndexRateApiV1
Description for rate in IndexRateApiV1
rateSource object
Description for rateSource in IndexRateApiV1
Description for encodedKey in IndexRateSourceApiV1
Description for name in IndexRateSourceApiV1
Description for notes in IndexRateSourceApiV1
Description for type in IndexRateSourceApiV1
Possible values: [TAX_RATE, INTEREST_RATE, WITHHOLDING_TAX_RATE]
Description for startDate in IndexRateApiV1
Description for userKey in IndexRateApiV1
Description for tillKey in LoanTransactionApiV1
Description for transactionId in LoanTransactionApiV1
Description for type in LoanTransactionApiV1
Possible values: [PENALTY_UNLOCKED, INTEREST_UNLOCKED, INTEREST_LOCKED, DISBURSMENT, INTEREST_APPLIED, DISBURSMENT_ADJUSTMENT, FEE, INTEREST_APPLIED_ADJUSTMENT, FEE_ADJUSTMENT, REPAYMENT_ADJUSTMENT, PENALTY_LOCKED, REPAYMENT, WRITE_OFF, FEE_CHARGED, PENALTY_APPLIED, PENALTY_ADJUSTMENT, INTEREST_RATE_CHANGED]
Description for userKey in LoanTransactionApiV1
Description for valueDate in LoanTransactionApiV1
{
"advancePosition": 0,
"amount": 0,
"arrearsPosition": 0,
"balance": 0,
"bookingDate": "string",
"branchKey": "string",
"centreKey": "string",
"comment": "string",
"creationDate": "string",
"customInformation": [
{
"amount": 0,
"customField": {
"amounts": {},
"builtInCustomFieldId": "MOBILE_PHONE",
"creationDate": "string",
"customFieldProductSettings": [
{
"customFieldEncodedKey": "string",
"encodedKey": "string",
"isDefault": true,
"isRequired": true,
"linkType": "CLIENT_ROLE",
"productKey": "string"
}
],
"customFieldSelectionOptions": [
{
"constraint": {
"customFieldKey": "string",
"dataFieldType": "NATIVE",
"dataFieldValue": "string",
"dataItemType": "WRITTEN_OFF_LOANS",
"dataType": "ENUM",
"encodedKey": "string",
"filterElement": "STARTS_WITH_CASE_SENSITIVE",
"groupNumber": 0,
"index": 0,
"linkingOperator": "OR",
"secondValue": "string",
"value": "string"
},
"encodedKey": "string",
"id": "string",
"score": 0,
"value": "string"
}
],
"customFieldSet": {
"builtInType": "DETAILS",
"createdDate": "string",
"customFields": [
{}
],
"encodedKey": "string",
"id": "string",
"indexInList": 0,
"lastModifiedDate": "string",
"name": "string",
"notes": "string",
"type": "USER_INFO",
"usage": "SINGLE"
},
"dataType": "GROUP_LINK",
"description": "string",
"editRights": {
"encodedKey": "string",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
},
"encodedKey": "string",
"id": "string",
"indexInList": 0,
"isDefault": true,
"isRequired": true,
"lastModifiedDate": "string",
"name": "string",
"state": "DEACTIVATED",
"type": "USER_INFO",
"unique": true,
"validationPattern": "string",
"valueLength": "SHORT",
"values": [
"string"
],
"viewRights": {
"encodedKey": "string",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
}
},
"customFieldID": "string",
"customFieldKey": "string",
"customFieldSetGroupIndex": 0,
"encodedKey": "string",
"indexInList": 0,
"linkedEntityKeyValue": "string",
"parentKey": "string",
"selectionKey": "string",
"value": "string"
}
],
"customPaymentAmounts": [
{
"amount": 0,
"customPaymentAmountType": "PAYMENT_DUE_FEE",
"encodedKey": "string",
"index": 0,
"loanTransactionKey": "string",
"taxOnAmount": 0
}
],
"deferredInterestAmount": 0,
"deferredTaxOnInterestAmount": 0,
"details": {
"encodedKey": "string",
"internalTransfer": true,
"targetSavingsAccountKey": "string",
"transactionChannel": {
"activated": true,
"createdByUserKey": "string",
"creationDate": "string",
"customFields": [
{
"amounts": {},
"builtInCustomFieldId": "MOBILE_PHONE",
"creationDate": "string",
"customFieldProductSettings": [
{
"customFieldEncodedKey": "string",
"encodedKey": "string",
"isDefault": true,
"isRequired": true,
"linkType": "CLIENT_ROLE",
"productKey": "string"
}
],
"customFieldSelectionOptions": [
{
"constraint": {
"customFieldKey": "string",
"dataFieldType": "NATIVE",
"dataFieldValue": "string",
"dataItemType": "WRITTEN_OFF_LOANS",
"dataType": "ENUM",
"encodedKey": "string",
"filterElement": "STARTS_WITH_CASE_SENSITIVE",
"groupNumber": 0,
"index": 0,
"linkingOperator": "OR",
"secondValue": "string",
"value": "string"
},
"encodedKey": "string",
"id": "string",
"score": 0,
"value": "string"
}
],
"customFieldSet": {
"builtInType": "DETAILS",
"createdDate": "string",
"customFields": [
null
],
"encodedKey": "string",
"id": "string",
"indexInList": 0,
"lastModifiedDate": "string",
"name": "string",
"notes": "string",
"type": "USER_INFO",
"usage": "SINGLE"
},
"dataType": "GROUP_LINK",
"description": "string",
"editRights": {
"encodedKey": "string",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
},
"encodedKey": "string",
"id": "string",
"indexInList": 0,
"isDefault": true,
"isRequired": true,
"lastModifiedDate": "string",
"name": "string",
"state": "DEACTIVATED",
"type": "USER_INFO",
"unique": true,
"validationPattern": "string",
"valueLength": "SHORT",
"values": [
"string"
],
"viewRights": {
"encodedKey": "string",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
}
}
],
"encodedKey": "string",
"id": "string",
"index": 0,
"name": "string",
"savingsConstraints": {
"customConfigurationInfo": {
"creationDate": "string",
"dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
"encodedKey": "string",
"indexInList": 0,
"lastModifiedDate": "string",
"name": "string",
"shared": true,
"userKey": "string"
},
"encodedKey": "string",
"filterConstraints": [
{
"customFieldKey": "string",
"dataFieldType": "NATIVE",
"dataFieldValue": "string",
"dataItemType": "WRITTEN_OFF_LOANS",
"dataType": "ENUM",
"encodedKey": "string",
"filterElement": "STARTS_WITH_CASE_SENSITIVE",
"groupNumber": 0,
"index": 0,
"linkingOperator": "OR",
"secondValue": "string",
"value": "string"
}
]
},
"savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
"transactionChannelAccountingRule": {
"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"
},
"usageRights": {
"encodedKey": "string",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
}
},
"transactionChannelKey": "string"
},
"encodedKey": "string",
"entryDate": "string",
"expectedPrincipalRedraw": 0,
"feesPaid": 0,
"fundersInterestAmount": 0,
"indexInterestRate": {
"encodedKey": "string",
"notes": "string",
"rate": 0,
"rateSource": {
"encodedKey": "string",
"name": "string",
"notes": "string",
"type": "TAX_RATE"
},
"startDate": "string",
"userKey": "string"
},
"interestFromArrearsAmount": 0,
"interestPaid": 0,
"interestRate": 0,
"loanPredefinedFeeAmounts": [
{
"amortizedAmounts": [
{
"amount": 0,
"branchKey": "string",
"centreKey": "string",
"creationDate": "string",
"encodedKey": "string",
"entryDate": "string",
"reversalAmountKey": "string",
"taxAmount": 0,
"type": "AMORTIZATION_ADJUSTMENT"
}
],
"amount": 0,
"encodedKey": "string",
"fee": {
"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"
},
"taxAmount": 0,
"transactionId": 0
}
],
"loanTransactionTerms": {
"encodedKey": "string",
"principalPaymentAmount": 0,
"principalPaymentPercentage": 0
},
"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"
},
"organizationCommissionAmount": 0,
"originalAmount": 0,
"originalCurrencyCode": "string",
"parentAccountKey": "string",
"parentLoanTransactionKey": "string",
"penaltyPaid": 0,
"principalBalance": 0,
"principalPaid": 0,
"productTypeKey": "string",
"redrawBalance": 0,
"reversalTransactionKey": "string",
"taxOnFeesAmount": 0,
"taxOnInterestFromArrearsAmount": 0,
"taxOnInterestPaid": 0,
"taxOnPenaltyAmount": 0,
"taxRate": {
"encodedKey": "string",
"notes": "string",
"rate": 0,
"rateSource": {
"encodedKey": "string",
"name": "string",
"notes": "string",
"type": "TAX_RATE"
},
"startDate": "string",
"userKey": "string"
},
"tillKey": "string",
"transactionId": 0,
"type": "PENALTY_UNLOCKED",
"userKey": "string",
"valueDate": "string"
}