Loanaccountfulldetailsapiv1
accountArrearsSettings object
Description for accountArrearsSettings in LoanAccountFullDetailsApiV1
the method used to calculate arrears for an account
Possible values: [DATE_OF_LAST_LATE_REPAYMENT, DATE_ACCOUNT_FIRST_WENT_TO_ARREARS]
the automatically generated encoded ID for this item
Description for monthlyToleranceDay in AccountArrearsSettingsApiV1
whether non-working days, such as holidays are included when calculating the number of days in arrears
Possible values: [EXCLUDED, INCLUDED]
Description for toleranceCalculationMethod in AccountArrearsSettingsApiV1
Possible values: [MONTHLY_ARREARS_TOLERANCE_DAY, ARREARS_TOLERANCE_PERIOD]
Used with the tolerancePercentageOfOutstandingPrincipal to set a minimum threshold that must be reached before an account will be set to 'in arrears'
This setting will cause an account to automatically go into arrears if the amount due exceeds a given percentage of the loan amount remaining. Only available for fixed and dynamic term loans.
the number of days a loan repayment can be late before the account will be automatically set to 'in arrears'.
Description for accountHolderKey in LoanAccountFullDetailsApiV1
Description for accountHolderType in LoanAccountFullDetailsApiV1
Possible values: [GROUP, CLIENT]
Description for accountState in LoanAccountFullDetailsApiV1
Possible values: [WITHDRAWN, PARTIALLY_DISBURSED, LOCKED, ACTIVE, CLOSED, PARTIAL_APPLICATION, LOCKED_CAPPING, CLOSED_REJECTED, RESCHEDULED, ACTIVE_IN_ARREARS, MATURED, CLOSED_RESCHEDULED, CLOSED_WITHDRAWN, PENDING_APPROVAL, APPROVED, REFINANCED, DORMANT, CLOSED_WRITTEN_OFF]
Description for accountSubState in LoanAccountFullDetailsApiV1
Possible values: [WITHDRAWN, PARTIALLY_DISBURSED, LOCKED, ACTIVE, CLOSED, PARTIAL_APPLICATION, LOCKED_CAPPING, CLOSED_REJECTED, RESCHEDULED, ACTIVE_IN_ARREARS, MATURED, CLOSED_RESCHEDULED, CLOSED_WITHDRAWN, PENDING_APPROVAL, APPROVED, REFINANCED, DORMANT, CLOSED_WRITTEN_OFF]
Description for accrueInterestAfterMaturity in LoanAccountFullDetailsApiV1
Description for accrueLateInterest in LoanAccountFullDetailsApiV1
Description for accruedInterest in LoanAccountFullDetailsApiV1
Description for accruedPenalty in LoanAccountFullDetailsApiV1
Description for activationTransactionKey in LoanAccountFullDetailsApiV1
Description for allowOffset in LoanAccountFullDetailsApiV1
Description for applyInterestOnPrepaymentMethod in LoanAccountFullDetailsApiV1
Possible values: [AUTOMATIC, MANUAL]
Description for approvedDate in LoanAccountFullDetailsApiV1
Description for arrearsTolerancePeriod in LoanAccountFullDetailsApiV1
Description for assignedBranchKey in LoanAccountFullDetailsApiV1
Description for assignedCentreKey in LoanAccountFullDetailsApiV1
Description for assignedUserKey in LoanAccountFullDetailsApiV1
Description for closedDate in LoanAccountFullDetailsApiV1
the date and time when this loan account was created
customFieldValues object[]
Description for customFieldValues in LoanAccountFullDetailsApiV1
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
Description for daysInArrears in LoanAccountFullDetailsApiV1
Description for defaultFirstRepaymentDueDateOffset in LoanAccountFullDetailsApiV1
disbursementDetails object
Description for disbursementDetails in LoanAccountFullDetailsApiV1
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
Description for elementsRecalculationMethod in LoanAccountFullDetailsApiV1
Possible values: [FIXED_PRINCIPAL_EXPECTED, FIXED_TOTAL_EXPECTED]
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for feesBalance in LoanAccountFullDetailsApiV1
Description for feesDue in LoanAccountFullDetailsApiV1
Description for feesPaid in LoanAccountFullDetailsApiV1
Description for fixedDaysOfMonth in LoanAccountFullDetailsApiV1
funds object[]
Description for funds in LoanAccountFullDetailsApiV1
the amount being funded
the name of an asset being used as collatoral
customFieldValues object[]
Description for customFieldValues in InvestorFundApiV1
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 automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the encoded key of the client who is acting as guarantor
the type of guarantor, either a private individual or a group
Possible values: [GROUP, CLIENT]
the ID for this funding action
how much this funder shares in the interest generated by the loan
when the type of funding is investor, the percentage which will go back to them when repayments are made
the savings account ID of the account being used to back a loan
the type of funder, either another client of the bank who is acting as guarantor, an asset being used as collatoral or an investor who shares in the interest generated by the loan
Possible values: [GUARANTOR, INVESTOR, ASSET]
Description for futurePaymentsAcceptance in LoanAccountFullDetailsApiV1
Possible values: [ACCEPT_OVERPAYMENTS, NO_FUTURE_PAYMENTS, ACCEPT_FUTURE_PAYMENTS]
Description for gracePeriod in LoanAccountFullDetailsApiV1
Description for gracePeriodType in LoanAccountFullDetailsApiV1
Possible values: [PAY_INTEREST_ONLY, NONE, INTEREST_FORGIVENESS]
guarantees object[]
Description for guarantees in LoanAccountFullDetailsApiV1
the amount being guaranteed
the name of the asset being used as a guranty
customFieldValues object[]
a list of custom information for this guranty
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 automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the encoded key of the client acting as guarantor
the type of entity acting as gurantor, either client or group
Possible values: [GROUP, CLIENT]
the encoded key of the savings account guranteeing the loan
the type of guarantor, either asset backed, an investor or private gurantor
Possible values: [GUARANTOR, INVESTOR, ASSET]
Description for hasCustomSchedule in LoanAccountFullDetailsApiV1
Description for holdBalance in LoanAccountFullDetailsApiV1
Description for id in LoanAccountFullDetailsApiV1
Description for interestApplicationMethod in LoanAccountFullDetailsApiV1
Possible values: [ON_REPAYMENT, ON_DISBURSEMENT]
Description for interestBalance in LoanAccountFullDetailsApiV1
Description for interestBalanceCalculationMethod in LoanAccountFullDetailsApiV1
Possible values: [PRINCIPAL_ONLY, PRINCIPAL_AND_INTEREST]
Description for interestCalculationMethod in LoanAccountFullDetailsApiV1
Possible values: [DECLINING_BALANCE, DECLINING_BALANCE_DISCOUNTED, FLAT]
Description for interestChargeFrequency in LoanAccountFullDetailsApiV1
Possible values: [EVERY_WEEK, ANNUALIZED, EVERY_MONTH, EVERY_X_DAYS, EVERY_FOUR_WEEKS, EVERY_DAY]
Description for interestCommission in LoanAccountFullDetailsApiV1
Description for interestDue in LoanAccountFullDetailsApiV1
Description for interestFromArrearsAccrued in LoanAccountFullDetailsApiV1
Description for interestFromArrearsBalance in LoanAccountFullDetailsApiV1
Description for interestFromArrearsDue in LoanAccountFullDetailsApiV1
Description for interestFromArrearsPaid in LoanAccountFullDetailsApiV1
Description for interestPaid in LoanAccountFullDetailsApiV1
Description for interestRate in LoanAccountFullDetailsApiV1
Description for interestRateReviewCount in LoanAccountFullDetailsApiV1
Description for interestRateReviewUnit in LoanAccountFullDetailsApiV1
Possible values: [MONTHS, WEEKS, DAYS]
Description for interestRateSource in LoanAccountFullDetailsApiV1
Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]
Description for interestRoundingVersion in LoanAccountFullDetailsApiV1
Possible values: [VERSION_2, VERSION_1, VERSION_3]
Description for interestSpread in LoanAccountFullDetailsApiV1
Description for interestType in LoanAccountFullDetailsApiV1
Possible values: [CAPITALIZED_INTEREST, SIMPLE_INTEREST]
Description for lastAccountAppraisalDate in LoanAccountFullDetailsApiV1
Description for lastInterestAppliedDate in LoanAccountFullDetailsApiV1
Description for lastInterestReviewDate in LoanAccountFullDetailsApiV1
Description for lastLockedDate in LoanAccountFullDetailsApiV1
the date on which this loan account was last modified
Description for lastSetToArrearsDate in LoanAccountFullDetailsApiV1
Description for lastTaxRateReviewDate in LoanAccountFullDetailsApiV1
Description for latePaymentsRecalculationMethod in LoanAccountFullDetailsApiV1
Possible values: [INCREASE_OVERDUE_INSTALLMENTS, INCREASE_LAST_INSTALLMENT]
Description for lineOfCreditKey in LoanAccountFullDetailsApiV1
Description for loanAmount in LoanAccountFullDetailsApiV1
loanGroup object
Description for loanGroup in LoanAccountFullDetailsApiV1
accounts object[]
Description for accounts in LoanGroupApiV1
accountArrearsSettings object
Description for accountArrearsSettings in LoanAccountApiV1
the method used to calculate arrears for an account
Possible values: [DATE_OF_LAST_LATE_REPAYMENT, DATE_ACCOUNT_FIRST_WENT_TO_ARREARS]
the automatically generated encoded ID for this item
Description for monthlyToleranceDay in AccountArrearsSettingsApiV1
whether non-working days, such as holidays are included when calculating the number of days in arrears
Possible values: [EXCLUDED, INCLUDED]
Description for toleranceCalculationMethod in AccountArrearsSettingsApiV1
Possible values: [MONTHLY_ARREARS_TOLERANCE_DAY, ARREARS_TOLERANCE_PERIOD]
Used with the tolerancePercentageOfOutstandingPrincipal to set a minimum threshold that must be reached before an account will be set to 'in arrears'
This setting will cause an account to automatically go into arrears if the amount due exceeds a given percentage of the loan amount remaining. Only available for fixed and dynamic term loans.
the number of days a loan repayment can be late before the account will be automatically set to 'in arrears'.
Description for accountHolderKey in LoanAccountApiV1
Description for accountHolderType in LoanAccountApiV1
Possible values: [GROUP, CLIENT]
Description for accountState in LoanAccountApiV1
Possible values: [WITHDRAWN, PARTIALLY_DISBURSED, LOCKED, ACTIVE, CLOSED, PARTIAL_APPLICATION, LOCKED_CAPPING, CLOSED_REJECTED, RESCHEDULED, ACTIVE_IN_ARREARS, MATURED, CLOSED_RESCHEDULED, CLOSED_WITHDRAWN, PENDING_APPROVAL, APPROVED, REFINANCED, DORMANT, CLOSED_WRITTEN_OFF]
Description for accountSubState in LoanAccountApiV1
Possible values: [WITHDRAWN, PARTIALLY_DISBURSED, LOCKED, ACTIVE, CLOSED, PARTIAL_APPLICATION, LOCKED_CAPPING, CLOSED_REJECTED, RESCHEDULED, ACTIVE_IN_ARREARS, MATURED, CLOSED_RESCHEDULED, CLOSED_WITHDRAWN, PENDING_APPROVAL, APPROVED, REFINANCED, DORMANT, CLOSED_WRITTEN_OFF]
Description for accrueInterestAfterMaturity in LoanAccountApiV1
Description for accrueLateInterest in LoanAccountApiV1
Description for accruedInterest in LoanAccountApiV1
Description for accruedPenalty in LoanAccountApiV1
Description for activationTransactionKey in LoanAccountApiV1
Description for allowOffset in LoanAccountApiV1
Description for applyInterestOnPrepaymentMethod in LoanAccountApiV1
Possible values: [AUTOMATIC, MANUAL]
Description for approvedDate in LoanAccountApiV1
Description for arrearsTolerancePeriod in LoanAccountApiV1
Description for assignedBranchKey in LoanAccountApiV1
Description for assignedCentreKey in LoanAccountApiV1
Description for assignedUserKey in LoanAccountApiV1
Description for closedDate in LoanAccountApiV1
the date and time when this loan account was created
customFieldValues object[]
Description for customFieldValues in LoanAccountApiV1
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
Description for daysInArrears in LoanAccountApiV1
Description for defaultFirstRepaymentDueDateOffset in LoanAccountApiV1
disbursementDetails object
Description for disbursementDetails in LoanAccountApiV1
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
Description for elementsRecalculationMethod in LoanAccountApiV1
Possible values: [FIXED_PRINCIPAL_EXPECTED, FIXED_TOTAL_EXPECTED]
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for feesBalance in LoanAccountApiV1
Description for feesDue in LoanAccountApiV1
Description for feesPaid in LoanAccountApiV1
Description for fixedDaysOfMonth in LoanAccountApiV1
funds object[]
Description for funds in LoanAccountApiV1
the amount being funded
the name of an asset being used as collatoral
customFieldValues object[]
Description for customFieldValues in InvestorFundApiV1
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 automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the encoded key of the client who is acting as guarantor
the type of guarantor, either a private individual or a group
Possible values: [GROUP, CLIENT]
the ID for this funding action
how much this funder shares in the interest generated by the loan
when the type of funding is investor, the percentage which will go back to them when repayments are made
the savings account ID of the account being used to back a loan
the type of funder, either another client of the bank who is acting as guarantor, an asset being used as collatoral or an investor who shares in the interest generated by the loan
Possible values: [GUARANTOR, INVESTOR, ASSET]
Description for futurePaymentsAcceptance in LoanAccountApiV1
Possible values: [ACCEPT_OVERPAYMENTS, NO_FUTURE_PAYMENTS, ACCEPT_FUTURE_PAYMENTS]
Description for gracePeriod in LoanAccountApiV1
Description for gracePeriodType in LoanAccountApiV1
Possible values: [PAY_INTEREST_ONLY, NONE, INTEREST_FORGIVENESS]
guarantees object[]
Description for guarantees in LoanAccountApiV1
the amount being guaranteed
the name of the asset being used as a guranty
customFieldValues object[]
a list of custom information for this guranty
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 automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the encoded key of the client acting as guarantor
the type of entity acting as gurantor, either client or group
Possible values: [GROUP, CLIENT]
the encoded key of the savings account guranteeing the loan
the type of guarantor, either asset backed, an investor or private gurantor
Possible values: [GUARANTOR, INVESTOR, ASSET]
Description for hasCustomSchedule in LoanAccountApiV1
Description for holdBalance in LoanAccountApiV1
Description for id in LoanAccountApiV1
Description for interestApplicationMethod in LoanAccountApiV1
Possible values: [ON_REPAYMENT, ON_DISBURSEMENT]
Description for interestBalance in LoanAccountApiV1
Description for interestBalanceCalculationMethod in LoanAccountApiV1
Possible values: [PRINCIPAL_ONLY, PRINCIPAL_AND_INTEREST]
Description for interestCalculationMethod in LoanAccountApiV1
Possible values: [DECLINING_BALANCE, DECLINING_BALANCE_DISCOUNTED, FLAT]
Description for interestChargeFrequency in LoanAccountApiV1
Possible values: [EVERY_WEEK, ANNUALIZED, EVERY_MONTH, EVERY_X_DAYS, EVERY_FOUR_WEEKS, EVERY_DAY]
Description for interestCommission in LoanAccountApiV1
Description for interestDue in LoanAccountApiV1
Description for interestFromArrearsAccrued in LoanAccountApiV1
Description for interestFromArrearsBalance in LoanAccountApiV1
Description for interestFromArrearsDue in LoanAccountApiV1
Description for interestFromArrearsPaid in LoanAccountApiV1
Description for interestPaid in LoanAccountApiV1
Description for interestRate in LoanAccountApiV1
Description for interestRateReviewCount in LoanAccountApiV1
Description for interestRateReviewUnit in LoanAccountApiV1
Possible values: [MONTHS, WEEKS, DAYS]
Description for interestRateSource in LoanAccountApiV1
Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]
Description for interestRoundingVersion in LoanAccountApiV1
Possible values: [VERSION_2, VERSION_1, VERSION_3]
Description for interestSpread in LoanAccountApiV1
Description for interestType in LoanAccountApiV1
Possible values: [CAPITALIZED_INTEREST, SIMPLE_INTEREST]
Description for lastAccountAppraisalDate in LoanAccountApiV1
Description for lastInterestAppliedDate in LoanAccountApiV1
Description for lastInterestReviewDate in LoanAccountApiV1
Description for lastLockedDate in LoanAccountApiV1
the date on which this loan account was last modified
Description for lastSetToArrearsDate in LoanAccountApiV1
Description for lastTaxRateReviewDate in LoanAccountApiV1
Description for latePaymentsRecalculationMethod in LoanAccountApiV1
Possible values: [INCREASE_OVERDUE_INSTALLMENTS, INCREASE_LAST_INSTALLMENT]
Description for lineOfCreditKey in LoanAccountApiV1
Description for loanAmount in LoanAccountApiV1
loanGroup object
Description for loanGroup in LoanAccountApiV1
Description for loanName in LoanAccountApiV1
Description for loanPenaltyCalculationMethod in LoanAccountApiV1
Possible values: [OVERDUE_BALANCE_AND_INTEREST, OUTSTANDING_PRINCIPAL, OVERDUE_BALANCE, NONE]
Description for lockedOperations in LoanAccountApiV1
Possible values: [APPLY_FEES, APPLY_PENALTIES, APPLY_INTEREST]
migrationEvent object
Description for migrationEvent in LoanAccountApiV1
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]
Description for notes in LoanAccountApiV1
Description for originalAccountKey in LoanAccountApiV1
Description for paymentMethod in LoanAccountApiV1
Possible values: [VERTICAL, HORIZONTAL]
paymentPlan object[]
Description for paymentPlan in LoanAccountApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for endingInstallmentPosition in PeriodicPaymentApiV1
Description for index in PeriodicPaymentApiV1
Description for loanAccountEncodedKey in PeriodicPaymentApiV1
Description for pmt in PeriodicPaymentApiV1
Description for penaltyBalance in LoanAccountApiV1
Description for penaltyDue in LoanAccountApiV1
Description for penaltyPaid in LoanAccountApiV1
Description for penaltyRate in LoanAccountApiV1
Description for periodicPayment in LoanAccountApiV1
Description for prepaymentAcceptance in LoanAccountApiV1
Possible values: [ACCEPT_PREPAYMENTS, NO_PREPAYMENTS]
Description for prepaymentRecalculationMethod in LoanAccountApiV1
Possible values: [NO_RECALCULATION, RECALCULATE_SCHEDULE_KEEP_SAME_NUMBER_OF_TERMS, REDUCE_AMOUNT_PER_INSTALLMENT, REDUCE_NUMBER_OF_INSTALLMENTS_NEW, REDUCE_NUMBER_OF_INSTALLMENTS, RESCHEDULE_REMAINING_REPAYMENTS, RECALCULATE_SCHEDULE_KEEP_SAME_TOTAL_REPAYMENT_AMOUNT, RECALCULATE_SCHEDULE_KEEP_SAME_PRINCIPAL_AMOUNT]
Description for principalBalance in LoanAccountApiV1
Description for principalDue in LoanAccountApiV1
Description for principalPaid in LoanAccountApiV1
Description for principalPaidInstallmentStatus in LoanAccountApiV1
Possible values: [PARTIALLY_PAID, ORIGINAL_TOTAL_EXPECTED_PAID, PAID]
principalPaymentSettings object
Description for principalPaymentSettings in LoanAccountApiV1
Description for amount in PrincipalPaymentAccountSettingsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for includeFeesInFloorAmount in PrincipalPaymentAccountSettingsApiV1
Description for includeInterestInFloorAmount in PrincipalPaymentAccountSettingsApiV1
Description for percentage in PrincipalPaymentAccountSettingsApiV1
Description for principalCeilingValue in PrincipalPaymentAccountSettingsApiV1
Description for principalFloorValue in PrincipalPaymentAccountSettingsApiV1
Description for principalPaymentMethod in PrincipalPaymentAccountSettingsApiV1
Possible values: [OUTSTANDING_PRINCIPAL_PERCENTAGE, FLAT, TOTAL_BALANCE_PERCENTAGE]
Description for principalRepaymentInterval in LoanAccountApiV1
Description for productTypeKey in LoanAccountApiV1
Description for redrawBalance in LoanAccountApiV1
redrawSettings object
Description for redrawSettings in LoanAccountApiV1
account object
Description for account in LoanAccountRedrawSettingsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for restrictNextDueWithdrawal in LoanAccountRedrawSettingsApiV1
Description for repaymentInstallments in LoanAccountApiV1
Description for repaymentPeriodCount in LoanAccountApiV1
Description for repaymentPeriodUnit in LoanAccountApiV1
Possible values: [MONTHS, YEARS, WEEKS, DAYS]
Description for repaymentScheduleMethod in LoanAccountApiV1
Possible values: [FIXED, NONE, DYNAMIC]
Description for rescheduledAccountKey in LoanAccountApiV1
Description for scheduleDueDatesMethod in LoanAccountApiV1
Possible values: [INTERVAL, FIXED_DAYS_OF_MONTH]
Description for shortMonthHandlingMethod in LoanAccountApiV1
Possible values: [LAST_DAY_IN_MONTH, FIRST_DAY_OF_NEXT_MONTH]
Description for taxRate in LoanAccountApiV1
tranches object[]
Description for tranches in LoanAccountApiV1
Description for amount in LoanTrancheApiV1
Description for disbursementTransactionKey in LoanTrancheApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for expectedDisbursementDate in LoanTrancheApiV1
Description for index in LoanTrancheApiV1
the date and time when this group was created
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472group object
Description for group in LoanGroupApiV1
the encoded key of the branch to which this group is assigned
the encoded key of the centre to which this group is assigned
the encoded key of the Mambu user to which this group is assigned
clientRole object
Description for clientRole in GroupApiV1
the automatically generated encoded ID for this client or group type
the date and time when this group was created
the email address for this group. This address will be used for automated and manually sent email notifications
the automatically generated encoded ID for this group
8a19b7057471f4af017472dc0fd80472the name of the group
the primary landline contact number for this group
the ID for this group
the pattern used to generate IDs
the date on which this group was last modified
this number will increment each time this group takes out and fully pays back a loan
migrationEvent object
Description for migrationEvent in GroupApiV1
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 primiary mobile contact number for this group
the language which shoudl ideally be used when communicating with this group
Possible values: [PORTUGESE, RUSSIAN, ROMANIAN, ENGLISH, SPANISH, GEORGIAN, BURMESE, PHRASE, CHINESE, FRENCH, INDONESIAN]
the date on which this group was last modified
Description for name in LoanGroupApiV1
Description for notes in LoanGroupApiV1
Description for loanName in LoanAccountFullDetailsApiV1
Description for loanPenaltyCalculationMethod in LoanAccountFullDetailsApiV1
Possible values: [OVERDUE_BALANCE_AND_INTEREST, OUTSTANDING_PRINCIPAL, OVERDUE_BALANCE, NONE]
Description for lockedOperations in LoanAccountFullDetailsApiV1
Possible values: [APPLY_FEES, APPLY_PENALTIES, APPLY_INTEREST]
migrationEvent object
Description for migrationEvent in LoanAccountFullDetailsApiV1
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]
Description for notes in LoanAccountFullDetailsApiV1
Description for originalAccountKey in LoanAccountFullDetailsApiV1
Description for paymentMethod in LoanAccountFullDetailsApiV1
Possible values: [VERTICAL, HORIZONTAL]
paymentPlan object[]
Description for paymentPlan in LoanAccountFullDetailsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for endingInstallmentPosition in PeriodicPaymentApiV1
Description for index in PeriodicPaymentApiV1
Description for loanAccountEncodedKey in PeriodicPaymentApiV1
Description for pmt in PeriodicPaymentApiV1
Description for penaltyBalance in LoanAccountFullDetailsApiV1
Description for penaltyDue in LoanAccountFullDetailsApiV1
Description for penaltyPaid in LoanAccountFullDetailsApiV1
Description for penaltyRate in LoanAccountFullDetailsApiV1
Description for periodicPayment in LoanAccountFullDetailsApiV1
Description for prepaymentAcceptance in LoanAccountFullDetailsApiV1
Possible values: [ACCEPT_PREPAYMENTS, NO_PREPAYMENTS]
Description for prepaymentRecalculationMethod in LoanAccountFullDetailsApiV1
Possible values: [NO_RECALCULATION, RECALCULATE_SCHEDULE_KEEP_SAME_NUMBER_OF_TERMS, REDUCE_AMOUNT_PER_INSTALLMENT, REDUCE_NUMBER_OF_INSTALLMENTS_NEW, REDUCE_NUMBER_OF_INSTALLMENTS, RESCHEDULE_REMAINING_REPAYMENTS, RECALCULATE_SCHEDULE_KEEP_SAME_TOTAL_REPAYMENT_AMOUNT, RECALCULATE_SCHEDULE_KEEP_SAME_PRINCIPAL_AMOUNT]
Description for principalBalance in LoanAccountFullDetailsApiV1
Description for principalDue in LoanAccountFullDetailsApiV1
Description for principalPaid in LoanAccountFullDetailsApiV1
Description for principalPaidInstallmentStatus in LoanAccountFullDetailsApiV1
Possible values: [PARTIALLY_PAID, ORIGINAL_TOTAL_EXPECTED_PAID, PAID]
principalPaymentSettings object
Description for principalPaymentSettings in LoanAccountFullDetailsApiV1
Description for amount in PrincipalPaymentAccountSettingsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for includeFeesInFloorAmount in PrincipalPaymentAccountSettingsApiV1
Description for includeInterestInFloorAmount in PrincipalPaymentAccountSettingsApiV1
Description for percentage in PrincipalPaymentAccountSettingsApiV1
Description for principalCeilingValue in PrincipalPaymentAccountSettingsApiV1
Description for principalFloorValue in PrincipalPaymentAccountSettingsApiV1
Description for principalPaymentMethod in PrincipalPaymentAccountSettingsApiV1
Possible values: [OUTSTANDING_PRINCIPAL_PERCENTAGE, FLAT, TOTAL_BALANCE_PERCENTAGE]
Description for principalRepaymentInterval in LoanAccountFullDetailsApiV1
Description for productTypeKey in LoanAccountFullDetailsApiV1
Description for redrawBalance in LoanAccountFullDetailsApiV1
redrawSettings object
Description for redrawSettings in LoanAccountFullDetailsApiV1
account object
Description for account in LoanAccountRedrawSettingsApiV1
accountArrearsSettings object
Description for accountArrearsSettings in LoanAccountApiV1
the method used to calculate arrears for an account
Possible values: [DATE_OF_LAST_LATE_REPAYMENT, DATE_ACCOUNT_FIRST_WENT_TO_ARREARS]
the automatically generated encoded ID for this item
Description for monthlyToleranceDay in AccountArrearsSettingsApiV1
whether non-working days, such as holidays are included when calculating the number of days in arrears
Possible values: [EXCLUDED, INCLUDED]
Description for toleranceCalculationMethod in AccountArrearsSettingsApiV1
Possible values: [MONTHLY_ARREARS_TOLERANCE_DAY, ARREARS_TOLERANCE_PERIOD]
Used with the tolerancePercentageOfOutstandingPrincipal to set a minimum threshold that must be reached before an account will be set to 'in arrears'
This setting will cause an account to automatically go into arrears if the amount due exceeds a given percentage of the loan amount remaining. Only available for fixed and dynamic term loans.
the number of days a loan repayment can be late before the account will be automatically set to 'in arrears'.
Description for accountHolderKey in LoanAccountApiV1
Description for accountHolderType in LoanAccountApiV1
Possible values: [GROUP, CLIENT]
Description for accountState in LoanAccountApiV1
Possible values: [WITHDRAWN, PARTIALLY_DISBURSED, LOCKED, ACTIVE, CLOSED, PARTIAL_APPLICATION, LOCKED_CAPPING, CLOSED_REJECTED, RESCHEDULED, ACTIVE_IN_ARREARS, MATURED, CLOSED_RESCHEDULED, CLOSED_WITHDRAWN, PENDING_APPROVAL, APPROVED, REFINANCED, DORMANT, CLOSED_WRITTEN_OFF]
Description for accountSubState in LoanAccountApiV1
Possible values: [WITHDRAWN, PARTIALLY_DISBURSED, LOCKED, ACTIVE, CLOSED, PARTIAL_APPLICATION, LOCKED_CAPPING, CLOSED_REJECTED, RESCHEDULED, ACTIVE_IN_ARREARS, MATURED, CLOSED_RESCHEDULED, CLOSED_WITHDRAWN, PENDING_APPROVAL, APPROVED, REFINANCED, DORMANT, CLOSED_WRITTEN_OFF]
Description for accrueInterestAfterMaturity in LoanAccountApiV1
Description for accrueLateInterest in LoanAccountApiV1
Description for accruedInterest in LoanAccountApiV1
Description for accruedPenalty in LoanAccountApiV1
Description for activationTransactionKey in LoanAccountApiV1
Description for allowOffset in LoanAccountApiV1
Description for applyInterestOnPrepaymentMethod in LoanAccountApiV1
Possible values: [AUTOMATIC, MANUAL]
Description for approvedDate in LoanAccountApiV1
Description for arrearsTolerancePeriod in LoanAccountApiV1
Description for assignedBranchKey in LoanAccountApiV1
Description for assignedCentreKey in LoanAccountApiV1
Description for assignedUserKey in LoanAccountApiV1
Description for closedDate in LoanAccountApiV1
the date and time when this loan account was created
customFieldValues object[]
Description for customFieldValues in LoanAccountApiV1
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
Description for daysInArrears in LoanAccountApiV1
Description for defaultFirstRepaymentDueDateOffset in LoanAccountApiV1
disbursementDetails object
Description for disbursementDetails in LoanAccountApiV1
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
Description for elementsRecalculationMethod in LoanAccountApiV1
Possible values: [FIXED_PRINCIPAL_EXPECTED, FIXED_TOTAL_EXPECTED]
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for feesBalance in LoanAccountApiV1
Description for feesDue in LoanAccountApiV1
Description for feesPaid in LoanAccountApiV1
Description for fixedDaysOfMonth in LoanAccountApiV1
funds object[]
Description for funds in LoanAccountApiV1
the amount being funded
the name of an asset being used as collatoral
customFieldValues object[]
Description for customFieldValues in InvestorFundApiV1
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 automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the encoded key of the client who is acting as guarantor
the type of guarantor, either a private individual or a group
Possible values: [GROUP, CLIENT]
the ID for this funding action
how much this funder shares in the interest generated by the loan
when the type of funding is investor, the percentage which will go back to them when repayments are made
the savings account ID of the account being used to back a loan
the type of funder, either another client of the bank who is acting as guarantor, an asset being used as collatoral or an investor who shares in the interest generated by the loan
Possible values: [GUARANTOR, INVESTOR, ASSET]
Description for futurePaymentsAcceptance in LoanAccountApiV1
Possible values: [ACCEPT_OVERPAYMENTS, NO_FUTURE_PAYMENTS, ACCEPT_FUTURE_PAYMENTS]
Description for gracePeriod in LoanAccountApiV1
Description for gracePeriodType in LoanAccountApiV1
Possible values: [PAY_INTEREST_ONLY, NONE, INTEREST_FORGIVENESS]
guarantees object[]
Description for guarantees in LoanAccountApiV1
the amount being guaranteed
the name of the asset being used as a guranty
customFieldValues object[]
a list of custom information for this guranty
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 automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the encoded key of the client acting as guarantor
the type of entity acting as gurantor, either client or group
Possible values: [GROUP, CLIENT]
the encoded key of the savings account guranteeing the loan
the type of guarantor, either asset backed, an investor or private gurantor
Possible values: [GUARANTOR, INVESTOR, ASSET]
Description for hasCustomSchedule in LoanAccountApiV1
Description for holdBalance in LoanAccountApiV1
Description for id in LoanAccountApiV1
Description for interestApplicationMethod in LoanAccountApiV1
Possible values: [ON_REPAYMENT, ON_DISBURSEMENT]
Description for interestBalance in LoanAccountApiV1
Description for interestBalanceCalculationMethod in LoanAccountApiV1
Possible values: [PRINCIPAL_ONLY, PRINCIPAL_AND_INTEREST]
Description for interestCalculationMethod in LoanAccountApiV1
Possible values: [DECLINING_BALANCE, DECLINING_BALANCE_DISCOUNTED, FLAT]
Description for interestChargeFrequency in LoanAccountApiV1
Possible values: [EVERY_WEEK, ANNUALIZED, EVERY_MONTH, EVERY_X_DAYS, EVERY_FOUR_WEEKS, EVERY_DAY]
Description for interestCommission in LoanAccountApiV1
Description for interestDue in LoanAccountApiV1
Description for interestFromArrearsAccrued in LoanAccountApiV1
Description for interestFromArrearsBalance in LoanAccountApiV1
Description for interestFromArrearsDue in LoanAccountApiV1
Description for interestFromArrearsPaid in LoanAccountApiV1
Description for interestPaid in LoanAccountApiV1
Description for interestRate in LoanAccountApiV1
Description for interestRateReviewCount in LoanAccountApiV1
Description for interestRateReviewUnit in LoanAccountApiV1
Possible values: [MONTHS, WEEKS, DAYS]
Description for interestRateSource in LoanAccountApiV1
Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]
Description for interestRoundingVersion in LoanAccountApiV1
Possible values: [VERSION_2, VERSION_1, VERSION_3]
Description for interestSpread in LoanAccountApiV1
Description for interestType in LoanAccountApiV1
Possible values: [CAPITALIZED_INTEREST, SIMPLE_INTEREST]
Description for lastAccountAppraisalDate in LoanAccountApiV1
Description for lastInterestAppliedDate in LoanAccountApiV1
Description for lastInterestReviewDate in LoanAccountApiV1
Description for lastLockedDate in LoanAccountApiV1
the date on which this loan account was last modified
Description for lastSetToArrearsDate in LoanAccountApiV1
Description for lastTaxRateReviewDate in LoanAccountApiV1
Description for latePaymentsRecalculationMethod in LoanAccountApiV1
Possible values: [INCREASE_OVERDUE_INSTALLMENTS, INCREASE_LAST_INSTALLMENT]
Description for lineOfCreditKey in LoanAccountApiV1
Description for loanAmount in LoanAccountApiV1
loanGroup object
Description for loanGroup in LoanAccountApiV1
accounts object[]
Description for accounts in LoanGroupApiV1
the date and time when this group was created
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472group object
Description for group in LoanGroupApiV1
the encoded key of the branch to which this group is assigned
the encoded key of the centre to which this group is assigned
the encoded key of the Mambu user to which this group is assigned
clientRole object
Description for clientRole in GroupApiV1
the automatically generated encoded ID for this client or group type
the date and time when this group was created
the email address for this group. This address will be used for automated and manually sent email notifications
the automatically generated encoded ID for this group
8a19b7057471f4af017472dc0fd80472the name of the group
the primary landline contact number for this group
the ID for this group
the pattern used to generate IDs
the date on which this group was last modified
this number will increment each time this group takes out and fully pays back a loan
migrationEvent object
Description for migrationEvent in GroupApiV1
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 primiary mobile contact number for this group
the language which shoudl ideally be used when communicating with this group
Possible values: [PORTUGESE, RUSSIAN, ROMANIAN, ENGLISH, SPANISH, GEORGIAN, BURMESE, PHRASE, CHINESE, FRENCH, INDONESIAN]
the date on which this group was last modified
Description for name in LoanGroupApiV1
Description for notes in LoanGroupApiV1
Description for loanName in LoanAccountApiV1
Description for loanPenaltyCalculationMethod in LoanAccountApiV1
Possible values: [OVERDUE_BALANCE_AND_INTEREST, OUTSTANDING_PRINCIPAL, OVERDUE_BALANCE, NONE]
Description for lockedOperations in LoanAccountApiV1
Possible values: [APPLY_FEES, APPLY_PENALTIES, APPLY_INTEREST]
migrationEvent object
Description for migrationEvent in LoanAccountApiV1
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]
Description for notes in LoanAccountApiV1
Description for originalAccountKey in LoanAccountApiV1
Description for paymentMethod in LoanAccountApiV1
Possible values: [VERTICAL, HORIZONTAL]
paymentPlan object[]
Description for paymentPlan in LoanAccountApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for endingInstallmentPosition in PeriodicPaymentApiV1
Description for index in PeriodicPaymentApiV1
Description for loanAccountEncodedKey in PeriodicPaymentApiV1
Description for pmt in PeriodicPaymentApiV1
Description for penaltyBalance in LoanAccountApiV1
Description for penaltyDue in LoanAccountApiV1
Description for penaltyPaid in LoanAccountApiV1
Description for penaltyRate in LoanAccountApiV1
Description for periodicPayment in LoanAccountApiV1
Description for prepaymentAcceptance in LoanAccountApiV1
Possible values: [ACCEPT_PREPAYMENTS, NO_PREPAYMENTS]
Description for prepaymentRecalculationMethod in LoanAccountApiV1
Possible values: [NO_RECALCULATION, RECALCULATE_SCHEDULE_KEEP_SAME_NUMBER_OF_TERMS, REDUCE_AMOUNT_PER_INSTALLMENT, REDUCE_NUMBER_OF_INSTALLMENTS_NEW, REDUCE_NUMBER_OF_INSTALLMENTS, RESCHEDULE_REMAINING_REPAYMENTS, RECALCULATE_SCHEDULE_KEEP_SAME_TOTAL_REPAYMENT_AMOUNT, RECALCULATE_SCHEDULE_KEEP_SAME_PRINCIPAL_AMOUNT]
Description for principalBalance in LoanAccountApiV1
Description for principalDue in LoanAccountApiV1
Description for principalPaid in LoanAccountApiV1
Description for principalPaidInstallmentStatus in LoanAccountApiV1
Possible values: [PARTIALLY_PAID, ORIGINAL_TOTAL_EXPECTED_PAID, PAID]
principalPaymentSettings object
Description for principalPaymentSettings in LoanAccountApiV1
Description for amount in PrincipalPaymentAccountSettingsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for includeFeesInFloorAmount in PrincipalPaymentAccountSettingsApiV1
Description for includeInterestInFloorAmount in PrincipalPaymentAccountSettingsApiV1
Description for percentage in PrincipalPaymentAccountSettingsApiV1
Description for principalCeilingValue in PrincipalPaymentAccountSettingsApiV1
Description for principalFloorValue in PrincipalPaymentAccountSettingsApiV1
Description for principalPaymentMethod in PrincipalPaymentAccountSettingsApiV1
Possible values: [OUTSTANDING_PRINCIPAL_PERCENTAGE, FLAT, TOTAL_BALANCE_PERCENTAGE]
Description for principalRepaymentInterval in LoanAccountApiV1
Description for productTypeKey in LoanAccountApiV1
Description for redrawBalance in LoanAccountApiV1
redrawSettings object
Description for redrawSettings in LoanAccountApiV1
Description for repaymentInstallments in LoanAccountApiV1
Description for repaymentPeriodCount in LoanAccountApiV1
Description for repaymentPeriodUnit in LoanAccountApiV1
Possible values: [MONTHS, YEARS, WEEKS, DAYS]
Description for repaymentScheduleMethod in LoanAccountApiV1
Possible values: [FIXED, NONE, DYNAMIC]
Description for rescheduledAccountKey in LoanAccountApiV1
Description for scheduleDueDatesMethod in LoanAccountApiV1
Possible values: [INTERVAL, FIXED_DAYS_OF_MONTH]
Description for shortMonthHandlingMethod in LoanAccountApiV1
Possible values: [LAST_DAY_IN_MONTH, FIRST_DAY_OF_NEXT_MONTH]
Description for taxRate in LoanAccountApiV1
tranches object[]
Description for tranches in LoanAccountApiV1
Description for amount in LoanTrancheApiV1
Description for disbursementTransactionKey in LoanTrancheApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for expectedDisbursementDate in LoanTrancheApiV1
Description for index in LoanTrancheApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for restrictNextDueWithdrawal in LoanAccountRedrawSettingsApiV1
Description for repaymentInstallments in LoanAccountFullDetailsApiV1
Description for repaymentPeriodCount in LoanAccountFullDetailsApiV1
Description for repaymentPeriodUnit in LoanAccountFullDetailsApiV1
Possible values: [MONTHS, YEARS, WEEKS, DAYS]
Description for repaymentScheduleMethod in LoanAccountFullDetailsApiV1
Possible values: [FIXED, NONE, DYNAMIC]
Description for rescheduledAccountKey in LoanAccountFullDetailsApiV1
Description for scheduleDueDatesMethod in LoanAccountFullDetailsApiV1
Possible values: [INTERVAL, FIXED_DAYS_OF_MONTH]
settlementAccounts object[]
Description for settlementAccounts in LoanAccountFullDetailsApiV1
Description for accountHolderKey in SavingsAccountApiV1
Description for accountHolderType in SavingsAccountApiV1
Possible values: [GROUP, CLIENT]
Description for accountState in SavingsAccountApiV1
Possible values: [WITHDRAWN, PARTIALLY_DISBURSED, LOCKED, ACTIVE, CLOSED, PARTIAL_APPLICATION, LOCKED_CAPPING, CLOSED_REJECTED, RESCHEDULED, ACTIVE_IN_ARREARS, MATURED, CLOSED_RESCHEDULED, CLOSED_WITHDRAWN, PENDING_APPROVAL, APPROVED, REFINANCED, DORMANT, CLOSED_WRITTEN_OFF]
Description for accountType in SavingsAccountApiV1
Possible values: [CURRENT_ACCOUNT, REGULAR_SAVINGS, FIXED_DEPOSIT, INVESTOR_ACCOUNT, SAVINGS_PLAN]
Description for accruedInterest in SavingsAccountApiV1
Description for activationDate in SavingsAccountApiV1
Description for allowOverdraft in SavingsAccountApiV1
Description for approvedDate in SavingsAccountApiV1
Description for assignedBranchKey in SavingsAccountApiV1
Description for assignedCentreKey in SavingsAccountApiV1
Description for assignedUserKey in SavingsAccountApiV1
Description for availableBalance in SavingsAccountApiV1
Description for balance in SavingsAccountApiV1
Description for closedDate in SavingsAccountApiV1
the date and time when this savings account was created
currency object
Description for currency in SavingsAccountApiV1
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
Description for currencyCode in SavingsAccountApiV1
customFieldValues object[]
Description for customFieldValues in SavingsAccountApiV1
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 automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for feesDue in SavingsAccountApiV1
Description for holdBalance in SavingsAccountApiV1
Description for id in SavingsAccountApiV1
Description for interestDue in SavingsAccountApiV1
interestPaymentDates object[]
Description for interestPaymentDates in SavingsAccountApiV1
the day of the month
the month
the year
Description for interestPaymentPoint in SavingsAccountApiV1
Possible values: [EVERY_WEEK, ON_FIXED_DATES, EVERY_MONTH, ON_ACCOUNT_MATURITY, EVERY_3_MONTHS, FIRST_DAY_OF_MONTH, EVERY_OTHER_WEEK]
interestSettings object
Description for interestSettings in SavingsAccountApiV1
Description for accrueInterestAfterMaturity in InterestAccountSettingsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for interestChargeFrequency in InterestAccountSettingsApiV1
Possible values: [EVERY_WEEK, ANNUALIZED, EVERY_MONTH, EVERY_X_DAYS, EVERY_FOUR_WEEKS, EVERY_DAY]
Description for interestChargeFrequencyCount in InterestAccountSettingsApiV1
Description for interestRate in InterestAccountSettingsApiV1
Description for interestRateReviewCount in InterestAccountSettingsApiV1
Description for interestRateReviewUnit in InterestAccountSettingsApiV1
Possible values: [MONTHS, WEEKS, DAYS]
Description for interestRateSource in InterestAccountSettingsApiV1
Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]
Description for interestRateTerms in InterestAccountSettingsApiV1
Possible values: [TIERED_PERIOD, FIXED, TIERED]
interestRateTiers object[]
Description for interestRateTiers in InterestAccountSettingsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for endingBalance in InterestRateTierApiV1
Description for endingDay in InterestRateTierApiV1
Description for index in InterestRateTierApiV1
Description for interestRate in InterestRateTierApiV1
Description for interestSpread in InterestAccountSettingsApiV1
Description for lastAccountAppraisalDate in SavingsAccountApiV1
Description for lastInterestCalculationDate in SavingsAccountApiV1
Description for lastInterestStoredDate in SavingsAccountApiV1
the date on which this savings account was last modified
Description for lastOverdraftInterestReviewDate in SavingsAccountApiV1
Description for lastSetToArrearsDate in SavingsAccountApiV1
Description for lineOfCreditKey in SavingsAccountApiV1
Description for lockedBalance in SavingsAccountApiV1
Description for lockedDate in SavingsAccountApiV1
Description for maturityDate in SavingsAccountApiV1
Description for maxWidthdrawlAmount in SavingsAccountApiV1
migrationEvent object
Description for migrationEvent in SavingsAccountApiV1
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]
Description for name in SavingsAccountApiV1
Description for notes in SavingsAccountApiV1
Description for overdraftAmount in SavingsAccountApiV1
Description for overdraftExpiryDate in SavingsAccountApiV1
overdraftExpiryDateDTO object
Description for overdraftExpiryDateDTO in SavingsAccountApiV1
the day of the month
the month
the year
Description for overdraftInterestAccrued in SavingsAccountApiV1
overdraftInterestSettings object
Description for overdraftInterestSettings in SavingsAccountApiV1
Description for accrueInterestAfterMaturity in InterestAccountSettingsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for interestChargeFrequency in InterestAccountSettingsApiV1
Possible values: [EVERY_WEEK, ANNUALIZED, EVERY_MONTH, EVERY_X_DAYS, EVERY_FOUR_WEEKS, EVERY_DAY]
Description for interestChargeFrequencyCount in InterestAccountSettingsApiV1
Description for interestRate in InterestAccountSettingsApiV1
Description for interestRateReviewCount in InterestAccountSettingsApiV1
Description for interestRateReviewUnit in InterestAccountSettingsApiV1
Possible values: [MONTHS, WEEKS, DAYS]
Description for interestRateSource in InterestAccountSettingsApiV1
Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]
Description for interestRateTerms in InterestAccountSettingsApiV1
Possible values: [TIERED_PERIOD, FIXED, TIERED]
interestRateTiers object[]
Description for interestRateTiers in InterestAccountSettingsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for endingBalance in InterestRateTierApiV1
Description for endingDay in InterestRateTierApiV1
Description for index in InterestRateTierApiV1
Description for interestRate in InterestRateTierApiV1
Description for interestSpread in InterestAccountSettingsApiV1
Description for overdraftLimit in SavingsAccountApiV1
Description for productTypeKey in SavingsAccountApiV1
Description for recommendedDepositAmount in SavingsAccountApiV1
Description for targetAmount in SavingsAccountApiV1
Description for technicalInterestDue in SavingsAccountApiV1
Description for technicalOverdraftAmount in SavingsAccountApiV1
Description for technicalOverdraftInterestAccrued in SavingsAccountApiV1
Description for withholdingTaxSourceKey in SavingsAccountApiV1
Description for shortMonthHandlingMethod in LoanAccountFullDetailsApiV1
Possible values: [LAST_DAY_IN_MONTH, FIRST_DAY_OF_NEXT_MONTH]
Description for taxRate in LoanAccountFullDetailsApiV1
tranches object[]
Description for tranches in LoanAccountFullDetailsApiV1
Description for amount in LoanTrancheApiV1
Description for disbursementTransactionKey in LoanTrancheApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for expectedDisbursementDate in LoanTrancheApiV1
Description for index in LoanTrancheApiV1
{
"accountArrearsSettings": {
"dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
"encodedKey": "string",
"monthlyToleranceDay": 0,
"nonWorkingDaysMethod": "EXCLUDED",
"toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
"toleranceFloorAmount": 0,
"tolerancePercentageOfOutstandingPrincipal": 0,
"tolerancePeriod": 0
},
"accountHolderKey": "string",
"accountHolderType": "GROUP",
"accountState": "WITHDRAWN",
"accountSubState": "WITHDRAWN",
"accrueInterestAfterMaturity": true,
"accrueLateInterest": true,
"accruedInterest": 0,
"accruedPenalty": 0,
"activationTransactionKey": "string",
"allowOffset": true,
"applyInterestOnPrepaymentMethod": "AUTOMATIC",
"approvedDate": "string",
"arrearsTolerancePeriod": 0,
"assignedBranchKey": "string",
"assignedCentreKey": "string",
"assignedUserKey": "string",
"closedDate": "string",
"creationDate": "string",
"customFieldValues": [
{
"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"
}
],
"daysInArrears": 0,
"defaultFirstRepaymentDueDateOffset": 0,
"disbursementDetails": {
"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"
}
},
"elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"feesBalance": 0,
"feesDue": 0,
"feesPaid": 0,
"fixedDaysOfMonth": [
0
],
"funds": [
{
"amount": 0,
"assetName": "string",
"customFieldValues": [
{
"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"
}
],
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"guarantorKey": "string",
"guarantorType": "GROUP",
"id": "string",
"interestCommission": 0,
"investmentPercentage": 0,
"savingsAccountKey": "string",
"type": "GUARANTOR"
}
],
"futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
"gracePeriod": 0,
"gracePeriodType": "PAY_INTEREST_ONLY",
"guarantees": [
{
"amount": 0,
"assetName": "string",
"customFieldValues": [
{
"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"
}
],
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"guarantorKey": "string",
"guarantorType": "GROUP",
"savingsAccountKey": "string",
"type": "GUARANTOR"
}
],
"hasCustomSchedule": true,
"holdBalance": 0,
"id": "string",
"interestApplicationMethod": "ON_REPAYMENT",
"interestBalance": 0,
"interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
"interestCalculationMethod": "DECLINING_BALANCE",
"interestChargeFrequency": "EVERY_WEEK",
"interestCommission": 0,
"interestDue": 0,
"interestFromArrearsAccrued": 0,
"interestFromArrearsBalance": 0,
"interestFromArrearsDue": 0,
"interestFromArrearsPaid": 0,
"interestPaid": 0,
"interestRate": 0,
"interestRateReviewCount": 0,
"interestRateReviewUnit": "MONTHS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRoundingVersion": "VERSION_2",
"interestSpread": 0,
"interestType": "CAPITALIZED_INTEREST",
"lastAccountAppraisalDate": "string",
"lastInterestAppliedDate": "string",
"lastInterestReviewDate": "string",
"lastLockedDate": "string",
"lastModifiedDate": "string",
"lastSetToArrearsDate": "string",
"lastTaxRateReviewDate": "string",
"latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
"lineOfCreditKey": "string",
"loanAmount": 0,
"loanGroup": {
"accounts": [
{
"accountArrearsSettings": {
"dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
"encodedKey": "string",
"monthlyToleranceDay": 0,
"nonWorkingDaysMethod": "EXCLUDED",
"toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
"toleranceFloorAmount": 0,
"tolerancePercentageOfOutstandingPrincipal": 0,
"tolerancePeriod": 0
},
"accountHolderKey": "string",
"accountHolderType": "GROUP",
"accountState": "WITHDRAWN",
"accountSubState": "WITHDRAWN",
"accrueInterestAfterMaturity": true,
"accrueLateInterest": true,
"accruedInterest": 0,
"accruedPenalty": 0,
"activationTransactionKey": "string",
"allowOffset": true,
"applyInterestOnPrepaymentMethod": "AUTOMATIC",
"approvedDate": "string",
"arrearsTolerancePeriod": 0,
"assignedBranchKey": "string",
"assignedCentreKey": "string",
"assignedUserKey": "string",
"closedDate": "string",
"creationDate": "string",
"customFieldValues": [
{
"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"
}
],
"daysInArrears": 0,
"defaultFirstRepaymentDueDateOffset": 0,
"disbursementDetails": {
"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"
}
},
"elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"feesBalance": 0,
"feesDue": 0,
"feesPaid": 0,
"fixedDaysOfMonth": [
0
],
"funds": [
{
"amount": 0,
"assetName": "string",
"customFieldValues": [
{
"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"
}
],
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"guarantorKey": "string",
"guarantorType": "GROUP",
"id": "string",
"interestCommission": 0,
"investmentPercentage": 0,
"savingsAccountKey": "string",
"type": "GUARANTOR"
}
],
"futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
"gracePeriod": 0,
"gracePeriodType": "PAY_INTEREST_ONLY",
"guarantees": [
{
"amount": 0,
"assetName": "string",
"customFieldValues": [
{
"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"
}
],
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"guarantorKey": "string",
"guarantorType": "GROUP",
"savingsAccountKey": "string",
"type": "GUARANTOR"
}
],
"hasCustomSchedule": true,
"holdBalance": 0,
"id": "string",
"interestApplicationMethod": "ON_REPAYMENT",
"interestBalance": 0,
"interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
"interestCalculationMethod": "DECLINING_BALANCE",
"interestChargeFrequency": "EVERY_WEEK",
"interestCommission": 0,
"interestDue": 0,
"interestFromArrearsAccrued": 0,
"interestFromArrearsBalance": 0,
"interestFromArrearsDue": 0,
"interestFromArrearsPaid": 0,
"interestPaid": 0,
"interestRate": 0,
"interestRateReviewCount": 0,
"interestRateReviewUnit": "MONTHS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRoundingVersion": "VERSION_2",
"interestSpread": 0,
"interestType": "CAPITALIZED_INTEREST",
"lastAccountAppraisalDate": "string",
"lastInterestAppliedDate": "string",
"lastInterestReviewDate": "string",
"lastLockedDate": "string",
"lastModifiedDate": "string",
"lastSetToArrearsDate": "string",
"lastTaxRateReviewDate": "string",
"latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
"lineOfCreditKey": "string",
"loanAmount": 0,
"loanGroup": {},
"loanName": "string",
"loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
"lockedOperations": [
"APPLY_FEES"
],
"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"
},
"notes": "string",
"originalAccountKey": "string",
"paymentMethod": "VERTICAL",
"paymentPlan": [
{
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"endingInstallmentPosition": 0,
"index": 0,
"loanAccountEncodedKey": "string",
"pmt": 0
}
],
"penaltyBalance": 0,
"penaltyDue": 0,
"penaltyPaid": 0,
"penaltyRate": 0,
"periodicPayment": 0,
"prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
"prepaymentRecalculationMethod": "NO_RECALCULATION",
"principalBalance": 0,
"principalDue": 0,
"principalPaid": 0,
"principalPaidInstallmentStatus": "PARTIALLY_PAID",
"principalPaymentSettings": {
"amount": 0,
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"includeFeesInFloorAmount": true,
"includeInterestInFloorAmount": true,
"percentage": 0,
"principalCeilingValue": 0,
"principalFloorValue": 0,
"principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
},
"principalRepaymentInterval": 0,
"productTypeKey": "string",
"redrawBalance": 0,
"redrawSettings": {
"account": {},
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"restrictNextDueWithdrawal": true
},
"repaymentInstallments": 0,
"repaymentPeriodCount": 0,
"repaymentPeriodUnit": "MONTHS",
"repaymentScheduleMethod": "FIXED",
"rescheduledAccountKey": "string",
"scheduleDueDatesMethod": "INTERVAL",
"shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
"taxRate": 0,
"tranches": [
{
"amount": 0,
"disbursementTransactionKey": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"expectedDisbursementDate": "string",
"index": 0
}
]
}
],
"creationDate": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"group": {
"assignedBranchKey": "string",
"assignedCentreKey": "string",
"assignedUserKey": "string",
"clientRole": {
"encodedKey": "string"
},
"creationDate": "2024-07-29T15:51:28.071Z",
"emailAddress": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"groupName": "string",
"homePhone": "string",
"id": "string",
"idPattern": "string",
"lastModifiedDate": "2024-07-29T15:51:28.071Z",
"loanCycle": 0,
"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"
},
"mobilePhone1": "string",
"preferredLanguage": "PORTUGESE"
},
"lastModifiedDate": "string",
"name": "string",
"notes": "string"
},
"loanName": "string",
"loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
"lockedOperations": [
"APPLY_FEES"
],
"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"
},
"notes": "string",
"originalAccountKey": "string",
"paymentMethod": "VERTICAL",
"paymentPlan": [
{
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"endingInstallmentPosition": 0,
"index": 0,
"loanAccountEncodedKey": "string",
"pmt": 0
}
],
"penaltyBalance": 0,
"penaltyDue": 0,
"penaltyPaid": 0,
"penaltyRate": 0,
"periodicPayment": 0,
"prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
"prepaymentRecalculationMethod": "NO_RECALCULATION",
"principalBalance": 0,
"principalDue": 0,
"principalPaid": 0,
"principalPaidInstallmentStatus": "PARTIALLY_PAID",
"principalPaymentSettings": {
"amount": 0,
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"includeFeesInFloorAmount": true,
"includeInterestInFloorAmount": true,
"percentage": 0,
"principalCeilingValue": 0,
"principalFloorValue": 0,
"principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
},
"principalRepaymentInterval": 0,
"productTypeKey": "string",
"redrawBalance": 0,
"redrawSettings": {
"account": {
"accountArrearsSettings": {
"dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
"encodedKey": "string",
"monthlyToleranceDay": 0,
"nonWorkingDaysMethod": "EXCLUDED",
"toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
"toleranceFloorAmount": 0,
"tolerancePercentageOfOutstandingPrincipal": 0,
"tolerancePeriod": 0
},
"accountHolderKey": "string",
"accountHolderType": "GROUP",
"accountState": "WITHDRAWN",
"accountSubState": "WITHDRAWN",
"accrueInterestAfterMaturity": true,
"accrueLateInterest": true,
"accruedInterest": 0,
"accruedPenalty": 0,
"activationTransactionKey": "string",
"allowOffset": true,
"applyInterestOnPrepaymentMethod": "AUTOMATIC",
"approvedDate": "string",
"arrearsTolerancePeriod": 0,
"assignedBranchKey": "string",
"assignedCentreKey": "string",
"assignedUserKey": "string",
"closedDate": "string",
"creationDate": "string",
"customFieldValues": [
{
"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"
}
],
"daysInArrears": 0,
"defaultFirstRepaymentDueDateOffset": 0,
"disbursementDetails": {
"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"
}
},
"elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"feesBalance": 0,
"feesDue": 0,
"feesPaid": 0,
"fixedDaysOfMonth": [
0
],
"funds": [
{
"amount": 0,
"assetName": "string",
"customFieldValues": [
{
"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"
}
],
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"guarantorKey": "string",
"guarantorType": "GROUP",
"id": "string",
"interestCommission": 0,
"investmentPercentage": 0,
"savingsAccountKey": "string",
"type": "GUARANTOR"
}
],
"futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
"gracePeriod": 0,
"gracePeriodType": "PAY_INTEREST_ONLY",
"guarantees": [
{
"amount": 0,
"assetName": "string",
"customFieldValues": [
{
"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"
}
],
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"guarantorKey": "string",
"guarantorType": "GROUP",
"savingsAccountKey": "string",
"type": "GUARANTOR"
}
],
"hasCustomSchedule": true,
"holdBalance": 0,
"id": "string",
"interestApplicationMethod": "ON_REPAYMENT",
"interestBalance": 0,
"interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
"interestCalculationMethod": "DECLINING_BALANCE",
"interestChargeFrequency": "EVERY_WEEK",
"interestCommission": 0,
"interestDue": 0,
"interestFromArrearsAccrued": 0,
"interestFromArrearsBalance": 0,
"interestFromArrearsDue": 0,
"interestFromArrearsPaid": 0,
"interestPaid": 0,
"interestRate": 0,
"interestRateReviewCount": 0,
"interestRateReviewUnit": "MONTHS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRoundingVersion": "VERSION_2",
"interestSpread": 0,
"interestType": "CAPITALIZED_INTEREST",
"lastAccountAppraisalDate": "string",
"lastInterestAppliedDate": "string",
"lastInterestReviewDate": "string",
"lastLockedDate": "string",
"lastModifiedDate": "string",
"lastSetToArrearsDate": "string",
"lastTaxRateReviewDate": "string",
"latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
"lineOfCreditKey": "string",
"loanAmount": 0,
"loanGroup": {
"accounts": [
{}
],
"creationDate": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"group": {
"assignedBranchKey": "string",
"assignedCentreKey": "string",
"assignedUserKey": "string",
"clientRole": {
"encodedKey": "string"
},
"creationDate": "2024-07-29T15:51:28.071Z",
"emailAddress": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"groupName": "string",
"homePhone": "string",
"id": "string",
"idPattern": "string",
"lastModifiedDate": "2024-07-29T15:51:28.071Z",
"loanCycle": 0,
"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"
},
"mobilePhone1": "string",
"preferredLanguage": "PORTUGESE"
},
"lastModifiedDate": "string",
"name": "string",
"notes": "string"
},
"loanName": "string",
"loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
"lockedOperations": [
"APPLY_FEES"
],
"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"
},
"notes": "string",
"originalAccountKey": "string",
"paymentMethod": "VERTICAL",
"paymentPlan": [
{
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"endingInstallmentPosition": 0,
"index": 0,
"loanAccountEncodedKey": "string",
"pmt": 0
}
],
"penaltyBalance": 0,
"penaltyDue": 0,
"penaltyPaid": 0,
"penaltyRate": 0,
"periodicPayment": 0,
"prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
"prepaymentRecalculationMethod": "NO_RECALCULATION",
"principalBalance": 0,
"principalDue": 0,
"principalPaid": 0,
"principalPaidInstallmentStatus": "PARTIALLY_PAID",
"principalPaymentSettings": {
"amount": 0,
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"includeFeesInFloorAmount": true,
"includeInterestInFloorAmount": true,
"percentage": 0,
"principalCeilingValue": 0,
"principalFloorValue": 0,
"principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
},
"principalRepaymentInterval": 0,
"productTypeKey": "string",
"redrawBalance": 0,
"redrawSettings": {},
"repaymentInstallments": 0,
"repaymentPeriodCount": 0,
"repaymentPeriodUnit": "MONTHS",
"repaymentScheduleMethod": "FIXED",
"rescheduledAccountKey": "string",
"scheduleDueDatesMethod": "INTERVAL",
"shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
"taxRate": 0,
"tranches": [
{
"amount": 0,
"disbursementTransactionKey": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"expectedDisbursementDate": "string",
"index": 0
}
]
},
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"restrictNextDueWithdrawal": true
},
"repaymentInstallments": 0,
"repaymentPeriodCount": 0,
"repaymentPeriodUnit": "MONTHS",
"repaymentScheduleMethod": "FIXED",
"rescheduledAccountKey": "string",
"scheduleDueDatesMethod": "INTERVAL",
"settlementAccounts": [
{
"accountHolderKey": "string",
"accountHolderType": "GROUP",
"accountState": "WITHDRAWN",
"accountType": "CURRENT_ACCOUNT",
"accruedInterest": 0,
"activationDate": "string",
"allowOverdraft": true,
"approvedDate": "string",
"assignedBranchKey": "string",
"assignedCentreKey": "string",
"assignedUserKey": "string",
"availableBalance": 0,
"balance": 0,
"closedDate": "string",
"creationDate": "string",
"currency": {
"code": "string",
"creationDate": "string",
"currencySymbolPosition": "AFTER_NUMBER",
"digitsAfterDecimal": 0,
"isBaseCurrency": true,
"lastModifiedDate": "string",
"name": "string",
"symbol": "string"
},
"currencyCode": "string",
"customFieldValues": [
{
"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"
}
],
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"feesDue": 0,
"holdBalance": 0,
"id": "string",
"interestDue": 0,
"interestPaymentDates": [
{
"dayOfMonth": 0,
"monthOfYear": 0,
"year": 0
}
],
"interestPaymentPoint": "EVERY_WEEK",
"interestSettings": {
"accrueInterestAfterMaturity": true,
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"interestChargeFrequency": "EVERY_WEEK",
"interestChargeFrequencyCount": 0,
"interestRate": 0,
"interestRateReviewCount": 0,
"interestRateReviewUnit": "MONTHS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRateTerms": "TIERED_PERIOD",
"interestRateTiers": [
{
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"endingBalance": 0,
"endingDay": 0,
"index": 0,
"interestRate": 0
}
],
"interestSpread": 0
},
"lastAccountAppraisalDate": "string",
"lastInterestCalculationDate": "string",
"lastInterestStoredDate": "string",
"lastModifiedDate": "string",
"lastOverdraftInterestReviewDate": "string",
"lastSetToArrearsDate": "string",
"lineOfCreditKey": "string",
"lockedBalance": 0,
"lockedDate": "string",
"maturityDate": "string",
"maxWidthdrawlAmount": 0,
"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",
"notes": "string",
"overdraftAmount": 0,
"overdraftExpiryDate": "string",
"overdraftExpiryDateDTO": {
"dayOfMonth": 0,
"monthOfYear": 0,
"year": 0
},
"overdraftInterestAccrued": 0,
"overdraftInterestSettings": {
"accrueInterestAfterMaturity": true,
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"interestChargeFrequency": "EVERY_WEEK",
"interestChargeFrequencyCount": 0,
"interestRate": 0,
"interestRateReviewCount": 0,
"interestRateReviewUnit": "MONTHS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRateTerms": "TIERED_PERIOD",
"interestRateTiers": [
{
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"endingBalance": 0,
"endingDay": 0,
"index": 0,
"interestRate": 0
}
],
"interestSpread": 0
},
"overdraftLimit": 0,
"productTypeKey": "string",
"recommendedDepositAmount": 0,
"targetAmount": 0,
"technicalInterestDue": 0,
"technicalOverdraftAmount": 0,
"technicalOverdraftInterestAccrued": 0,
"withholdingTaxSourceKey": "string"
}
],
"shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
"taxRate": 0,
"tranches": [
{
"amount": 0,
"disbursementTransactionKey": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"expectedDisbursementDate": "string",
"index": 0
}
]
}