Disbursementdetailsapiv1
customInformation object[]
custom field definitions associated with this disbursement
Description for amount in CustomFieldValueApiV1
customField object
Description for customField in CustomFieldValueApiV1
amounts object
used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score
if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions
Possible values: [MOBILE_PHONE, EMAIL_ADDRESS, GENDER, MIDDLE_NAME, HOME_PHONE, BIRTHDATE, LAST_NAME, FIRST_NAME]
the date on which this custom field definition was created
customFieldProductSettings object[]
Description for customFieldProductSettings in CustomFieldApiV1
the key to the parent custom field definition
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472whether this field is displayed by default when creating a new record
whether this field is required when creating a new record
the type of entity this field represents a link to
Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]
when the link type is product, this field should contain the encoded key of the linekd product
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
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the ID of this selectable item
the score assigned to this selection
display name of this option
customFieldSet object
Description for customFieldSet in CustomFieldApiV1
if this set is part of the set of built-in custom field sets, its type will be shown here
Possible values: [DETAILS, GENERAL]
the date and time when this custom field set was created
customFields object[]
an array of custom field definitions included in this custom field set
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the ID of this custom field set
for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values
the date on which this custom field set was last modified
the name of this custom field set
any notes regarding this custom field set
the entity type that this custom field definition is attached to
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]
whether this custom field set can only be used once, or added multiple times to the same entity
Possible values: [SINGLE, GROUPED]
the type of custom field definition
Possible values: [GROUP_LINK, DATE, NUMBER, CHECKBOX, CLIENT_LINK, STRING, USER_LINK, SELECTION]
a brief description of this custom field definition
editRights object
Description for editRights in CustomFieldApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the ID for this custom field definition
Description for indexInList in CustomFieldApiV1
whether this field will be included by default on new records
whether this field is required when creating a new record
the date on which this custom field definition was last modified
the name of this custom field definition
whether this field is available for use or has been deactivated
Possible values: [DEACTIVATED, NORMAL]
the type of data this custom field definition will contain
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]
whether the data in this custom field definition needs to be a unique value
a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example @@-##-$$$
whether this field needs to support a large number of characters
Possible values: [SHORT, LONG]
a list of possible values when the field is a selection field
viewRights object
Description for viewRights in CustomFieldApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
Description for customFieldID in CustomFieldValueApiV1
Description for customFieldKey in CustomFieldValueApiV1
Description for customFieldSetGroupIndex in CustomFieldValueApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for indexInList in CustomFieldValueApiV1
Description for linkedEntityKeyValue in CustomFieldValueApiV1
Description for parentKey in CustomFieldValueApiV1
Description for selectionKey in CustomFieldValueApiV1
Description for value in CustomFieldValueApiV1
the date on which the loan was disbursed
the automatically generated ID for this disbursement
the date on which this disbursement is expected to take place
fees object[]
a list of fees associated with the disbursement
the amount of this fee
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472fee object
Description for fee in CustomPredefinedFeeApiV1
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]
the date of the first repayment for the loan
transactionDetails object
Description for transactionDetails in DisbursementDetailsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for internalTransfer in TransactionDetailsApiV1
Description for targetSavingsAccountKey in TransactionDetailsApiV1
transactionChannel object
Description for transactionChannel in TransactionDetailsApiV1
whether this transaction channel is enabled
the encoded key of the user who created this transaction channel
the date on which this transaction channel was created
customFields object[]
Description for customFields in TransactionChannelInTransactionDetailsApiV1
amounts object
used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score
if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions
Possible values: [MOBILE_PHONE, EMAIL_ADDRESS, GENDER, MIDDLE_NAME, HOME_PHONE, BIRTHDATE, LAST_NAME, FIRST_NAME]
the date on which this custom field definition was created
customFieldProductSettings object[]
Description for customFieldProductSettings in CustomFieldApiV1
the key to the parent custom field definition
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472whether this field is displayed by default when creating a new record
whether this field is required when creating a new record
the type of entity this field represents a link to
Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]
when the link type is product, this field should contain the encoded key of the linekd product
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
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the ID of this selectable item
the score assigned to this selection
display name of this option
customFieldSet object
Description for customFieldSet in CustomFieldApiV1
if this set is part of the set of built-in custom field sets, its type will be shown here
Possible values: [DETAILS, GENERAL]
the date and time when this custom field set was created
an array of custom field definitions included in this custom field set
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the ID of this custom field set
for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values
the date on which this custom field set was last modified
the name of this custom field set
any notes regarding this custom field set
the entity type that this custom field definition is attached to
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]
whether this custom field set can only be used once, or added multiple times to the same entity
Possible values: [SINGLE, GROUPED]
the type of custom field definition
Possible values: [GROUP_LINK, DATE, NUMBER, CHECKBOX, CLIENT_LINK, STRING, USER_LINK, SELECTION]
a brief description of this custom field definition
editRights object
Description for editRights in CustomFieldApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the ID for this custom field definition
Description for indexInList in CustomFieldApiV1
whether this field will be included by default on new records
whether this field is required when creating a new record
the date on which this custom field definition was last modified
the name of this custom field definition
whether this field is available for use or has been deactivated
Possible values: [DEACTIVATED, NORMAL]
the type of data this custom field definition will contain
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]
whether the data in this custom field definition needs to be a unique value
a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example @@-##-$$$
whether this field needs to support a large number of characters
Possible values: [SHORT, LONG]
a list of possible values when the field is a selection field
viewRights object
Description for viewRights in CustomFieldApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
the encoded key for this transaction channel
the user specified ID for this transaction channel
Description for index in TransactionChannelInTransactionDetailsApiV1
loanConstraints object
Description for loanConstraints in TransactionChannelInTransactionDetailsApiV1
customConfigurationInfo object
Description for customConfigurationInfo in CustomFilterApiV1
the date on which this configuration was created
the type of entity this configuration is for
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]
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472if more than one configuration exists for a given type, this is its index in the list
the date on which this configuration was last modified
the name for this configuration
whether this configuration is private or can be used by other users of the system
the encoded key of the Mambu user who created this configuration
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
whether there are any rules regarding usage of this transaction channel with loan accounts
Possible values: [UNCONSTRAINED_USAGE, LIMITED_USAGE]
the name of this transaction channel
savingsConstraints object
Description for savingsConstraints in TransactionChannelInTransactionDetailsApiV1
customConfigurationInfo object
Description for customConfigurationInfo in CustomFilterApiV1
the date on which this configuration was created
the type of entity this configuration is for
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]
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472if more than one configuration exists for a given type, this is its index in the list
the date on which this configuration was last modified
the name for this configuration
whether this configuration is private or can be used by other users of the system
the encoded key of the Mambu user who created this configuration
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
whether there are any rules regarding usage of this transaction channel with savings accounts
Possible values: [UNCONSTRAINED_USAGE, LIMITED_USAGE]
transactionChannelAccountingRule object
Description for transactionChannelAccountingRule in TransactionChannelInTransactionDetailsApiV1
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
usageRights object
Description for usageRights in TransactionChannelInTransactionDetailsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
Description for transactionChannelKey in TransactionDetailsApiV1
{
"customInformation": [
{
"amount": 0,
"customField": {
"amounts": {},
"builtInCustomFieldId": "MOBILE_PHONE",
"creationDate": "string",
"customFieldProductSettings": [
{
"customFieldEncodedKey": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"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": "8a19b7057471f4af017472dc0fd80472",
"id": "string",
"score": 0,
"value": "string"
}
],
"customFieldSet": {
"builtInType": "DETAILS",
"createdDate": "string",
"customFields": [
{}
],
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"id": "string",
"indexInList": 0,
"lastModifiedDate": "string",
"name": "string",
"notes": "string",
"type": "USER_INFO",
"usage": "SINGLE"
},
"dataType": "GROUP_LINK",
"description": "string",
"editRights": {
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
},
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"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": "8a19b7057471f4af017472dc0fd80472",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
}
},
"customFieldID": "string",
"customFieldKey": "string",
"customFieldSetGroupIndex": 0,
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"indexInList": 0,
"linkedEntityKeyValue": "string",
"parentKey": "string",
"selectionKey": "string",
"value": "string"
}
],
"disbursementDate": "string",
"encodedKey": "string",
"expectedDisbursementDate": "string",
"fees": [
{
"amount": 0,
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"fee": {
"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"
}
}
],
"firstRepaymentDate": "string",
"transactionDetails": {
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"internalTransfer": true,
"targetSavingsAccountKey": "string",
"transactionChannel": {
"activated": true,
"createdByUserKey": "string",
"creationDate": "string",
"customFields": [
{
"amounts": {},
"builtInCustomFieldId": "MOBILE_PHONE",
"creationDate": "string",
"customFieldProductSettings": [
{
"customFieldEncodedKey": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"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": "8a19b7057471f4af017472dc0fd80472",
"id": "string",
"score": 0,
"value": "string"
}
],
"customFieldSet": {
"builtInType": "DETAILS",
"createdDate": "string",
"customFields": [
null
],
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"id": "string",
"indexInList": 0,
"lastModifiedDate": "string",
"name": "string",
"notes": "string",
"type": "USER_INFO",
"usage": "SINGLE"
},
"dataType": "GROUP_LINK",
"description": "string",
"editRights": {
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
},
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"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": "8a19b7057471f4af017472dc0fd80472",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
}
}
],
"encodedKey": "string",
"id": "string",
"index": 0,
"loanConstraints": {
"customConfigurationInfo": {
"creationDate": "string",
"dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"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"
}
]
},
"loanConstraintsUsage": "UNCONSTRAINED_USAGE",
"name": "string",
"savingsConstraints": {
"customConfigurationInfo": {
"creationDate": "string",
"dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"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": "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"
},
"usageRights": {
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
}
},
"transactionChannelKey": "string"
}
}