Savingsaccountapiv1
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
Description for creationDate in SavingsAccountApiV1
currency object
Description for currency in SavingsAccountApiV1
Description for code in CurrencyApiV1
Description for creationDate in CurrencyApiV1
Description for currencySymbolPosition in CurrencyApiV1
Possible values: [AFTER_NUMBER, BEFORE_NUMBER]
Description for digitsAfterDecimal in CurrencyApiV1
Description for isBaseCurrency in CurrencyApiV1
Description for lastModifiedDate in CurrencyApiV1
Description for name in CurrencyApiV1
Description for symbol in CurrencyApiV1
Description for currencyCode in SavingsAccountApiV1
customFieldValues object[]
Description for customFieldValues in SavingsAccountApiV1
Description for amount in CustomFieldValueApiV1
customField object
Description for customField in CustomFieldValueApiV1
amounts object
Description for amounts in CustomFieldApiV1
Description for builtInCustomFieldId in CustomFieldApiV1
Possible values: [MOBILE_PHONE, EMAIL_ADDRESS, GENDER, MIDDLE_NAME, HOME_PHONE, BIRTHDATE, LAST_NAME, FIRST_NAME]
Description for creationDate in CustomFieldApiV1
customFieldProductSettings object[]
Description for customFieldProductSettings in CustomFieldApiV1
Description for customFieldEncodedKey in CustomFieldLinkApiV1
Description for encodedKey in CustomFieldLinkApiV1
Description for isDefault in CustomFieldLinkApiV1
Description for isRequired in CustomFieldLinkApiV1
Description for linkType in CustomFieldLinkApiV1
Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]
Description for productKey in CustomFieldLinkApiV1
customFieldSelectionOptions object[]
Description for customFieldSelectionOptions in CustomFieldApiV1
constraint object
Description for constraint in CustomFieldSelectionApiV1
Description for customFieldKey in CustomFilterConstraintApiV1
Description for dataFieldType in CustomFilterConstraintApiV1
Possible values: [NATIVE, CUSTOM]
Description for dataFieldValue in CustomFilterConstraintApiV1
Description for dataItemType in CustomFilterConstraintApiV1
Possible values: [WRITTEN_OFF_LOANS, LINE_OF_CREDIT, INVESTOR_FUND, TRANSACTION_DETAILS, DOCUMENT_TEMPLATE, PRODUCT, MCC_EXPIRATION, CENTRE, REPAYMENT_COLLECTION, TASK, OUTSTANDING_PORTFOLIO_AMOUNTS, REVENUE, COMPOSED_TRANSACTIONS, UNION_TRANSACTIONS, PRINCIPAL_PAYMENT_SETTINGS, LOANS, DISBURSEMENT_DETAILS, SAVINGS_TRANSACTION, IDENTIFICATION_DOCUMENT, LOAN_PRODUCT, DISBURSED_LOANS, LOAN_GROUP, TRANSACTION_CHANNEL, CUSTOM_PREDEFINED_FEE, JOURNAL_ENTRY, ATTACHMENT, PREDEFINED_FEE, TRANCHE, TRANSACTION, INDEX_RATE_SOURCE, GROUP_ROLE, LOAN_TRANSACTION, CLIENT_ROLE, GROUP, NOTIFICATION_MESSAGE, OUTSTANDING_PORTFOLIO_ACCOUNTS, REPAYMENT, LOAN_ACCOUNT_GUARANTY, BRANCH, CURRENCY, CARD_TRANSACTION_REVERSAL, INTEREST_PRODUCT_SETTINGS, CREATED_ACCOUNTS, USER, SAVINGS_PRODUCT, CLIENT, PRODUCT_ARREARS_SETTINGS, SAVINGS, EXPENSE, INDEX_RATE, NOTIFICATION_TEMPLATE, CUSTOM_FIELD_SELECTION, ACTIVITY]
Description for dataType in CustomFilterConstraintApiV1
Possible values: [ENUM, MONEY, NUMBER, DATE_UTC, JAVA_BLOB, OBJECT, BOOLEAN, DATE, PERCENT, BIG_DECIMAL, STRING, KEY, LONG]
Description for encodedKey in CustomFilterConstraintApiV1
Description for filterElement in CustomFilterConstraintApiV1
Possible values: [STARTS_WITH_CASE_SENSITIVE, THIS_WEEK, EQUALS, STARTS_WITH, IN, TODAY, THIS_YEAR, BETWEEN, AFTER, LESS_THAN, DIFFERENT_THAN, THIS_MONTH, NOT_EMPTY, BEFORE, EQUALS_CASE_SENSITIVE, LAST_DAYS, MORE_THAN, EMPTY, ON]
Description for groupNumber in CustomFilterConstraintApiV1
Description for index in CustomFilterConstraintApiV1
Description for linkingOperator in CustomFilterConstraintApiV1
Possible values: [OR, AND]
Description for secondValue in CustomFilterConstraintApiV1
Description for value in CustomFilterConstraintApiV1
Description for encodedKey in CustomFieldSelectionApiV1
Description for id in CustomFieldSelectionApiV1
Description for score in CustomFieldSelectionApiV1
Description for value in CustomFieldSelectionApiV1
customFieldSet object
Description for customFieldSet in CustomFieldApiV1
Description for builtInType in CustomFieldSetApiV1
Possible values: [DETAILS, GENERAL]
Description for createdDate in CustomFieldSetApiV1
customFields object[]
Description for customFields in CustomFieldSetApiV1
Description for encodedKey in CustomFieldSetApiV1
Description for id in CustomFieldSetApiV1
Description for indexInList in CustomFieldSetApiV1
Description for lastModifiedDate in CustomFieldSetApiV1
Description for name in CustomFieldSetApiV1
Description for notes in CustomFieldSetApiV1
Description for type in CustomFieldSetApiV1
Possible values: [USER_INFO, ASSET_INFO, CLIENT_INFO, LINE_OF_CREDIT, GROUP_INFO, TRANSACTION_CHANNEL_INFO, BRANCH_INFO, SAVINGS_ACCOUNT_INFO, LOAN_ACCOUNT_INFO, GUARANTOR_INFO, CENTRE_INFO]
Description for usage in CustomFieldSetApiV1
Possible values: [SINGLE, GROUPED]
Description for dataType in CustomFieldApiV1
Possible values: [GROUP_LINK, DATE, NUMBER, CHECKBOX, CLIENT_LINK, STRING, USER_LINK, SELECTION]
Description for description in CustomFieldApiV1
editRights object
Description for editRights in CustomFieldApiV1
Description for encodedKey in UsageRightsApiV1
Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
Description for encodedKey in CustomFieldApiV1
Description for id in CustomFieldApiV1
Description for indexInList in CustomFieldApiV1
Description for isDefault in CustomFieldApiV1
Description for isRequired in CustomFieldApiV1
Description for lastModifiedDate in CustomFieldApiV1
Description for name in CustomFieldApiV1
Description for state in CustomFieldApiV1
Possible values: [DEACTIVATED, NORMAL]
Description for type in CustomFieldApiV1
Possible values: [USER_INFO, ASSET_INFO, CLIENT_INFO, LINE_OF_CREDIT, GROUP_INFO, TRANSACTION_CHANNEL_INFO, BRANCH_INFO, SAVINGS_ACCOUNT_INFO, LOAN_ACCOUNT_INFO, GUARANTOR_INFO, CENTRE_INFO]
Description for unique in CustomFieldApiV1
Description for validationPattern in CustomFieldApiV1
Description for valueLength in CustomFieldApiV1
Possible values: [SHORT, LONG]
Description for values in CustomFieldApiV1
viewRights object
Description for viewRights in CustomFieldApiV1
Description for encodedKey in UsageRightsApiV1
Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
Description for customFieldID in CustomFieldValueApiV1
Description for customFieldKey in CustomFieldValueApiV1
Description for customFieldSetGroupIndex in CustomFieldValueApiV1
Description for encodedKey in CustomFieldValueApiV1
Description for indexInList in CustomFieldValueApiV1
Description for linkedEntityKeyValue in CustomFieldValueApiV1
Description for parentKey in CustomFieldValueApiV1
Description for selectionKey in CustomFieldValueApiV1
Description for value in CustomFieldValueApiV1
Description for encodedKey in SavingsAccountApiV1
Description 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
Description for dayOfMonth in DateDTOApiV1
Description for monthOfYear in DateDTOApiV1
Description for year in DateDTOApiV1
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
Description for encodedKey in InterestAccountSettingsApiV1
Description 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
Description for encodedKey in InterestRateTierApiV1
Description 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
Description for lastModifiedDate in SavingsAccountApiV1
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
Description for creationDate in DataMigrationEventApiV1
Description for encodedKey in DataMigrationEventApiV1
Description for numCentresImported in DataMigrationEventApiV1
Description for numClientsImported in DataMigrationEventApiV1
Description for numGLAccountsImported in DataMigrationEventApiV1
Description for numGroupsImported in DataMigrationEventApiV1
Description for numLoanRepaymentsImported in DataMigrationEventApiV1
Description for numLoanTransactionsImported in DataMigrationEventApiV1
Description for numLoansImported in DataMigrationEventApiV1
Description for numSavingsImported in DataMigrationEventApiV1
Description for state in DataMigrationEventApiV1
Possible values: [REVERTED, DRAFT, APPROVED]
Description for type in DataMigrationEventApiV1
Possible values: [IMPORT, EXPORT]
Description for name in SavingsAccountApiV1
Description for notes in SavingsAccountApiV1
Description for overdraftAmount in SavingsAccountApiV1
Description for overdraftExpiryDate in SavingsAccountApiV1
overdraftExpiryDateDTO object
Description for overdraftExpiryDateDTO in SavingsAccountApiV1
Description for dayOfMonth in DateDTOApiV1
Description for monthOfYear in DateDTOApiV1
Description for year in DateDTOApiV1
Description for overdraftInterestAccrued in SavingsAccountApiV1
overdraftInterestSettings object
Description for overdraftInterestSettings in SavingsAccountApiV1
Description for accrueInterestAfterMaturity in InterestAccountSettingsApiV1
Description for encodedKey in InterestAccountSettingsApiV1
Description 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
Description for encodedKey in InterestRateTierApiV1
Description 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
{
"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": "string",
"isDefault": true,
"isRequired": true,
"linkType": "CLIENT_ROLE",
"productKey": "string"
}
],
"customFieldSelectionOptions": [
{
"constraint": {
"customFieldKey": "string",
"dataFieldType": "NATIVE",
"dataFieldValue": "string",
"dataItemType": "WRITTEN_OFF_LOANS",
"dataType": "ENUM",
"encodedKey": "string",
"filterElement": "STARTS_WITH_CASE_SENSITIVE",
"groupNumber": 0,
"index": 0,
"linkingOperator": "OR",
"secondValue": "string",
"value": "string"
},
"encodedKey": "string",
"id": "string",
"score": 0,
"value": "string"
}
],
"customFieldSet": {
"builtInType": "DETAILS",
"createdDate": "string",
"customFields": [
{}
],
"encodedKey": "string",
"id": "string",
"indexInList": 0,
"lastModifiedDate": "string",
"name": "string",
"notes": "string",
"type": "USER_INFO",
"usage": "SINGLE"
},
"dataType": "GROUP_LINK",
"description": "string",
"editRights": {
"encodedKey": "string",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
},
"encodedKey": "string",
"id": "string",
"indexInList": 0,
"isDefault": true,
"isRequired": true,
"lastModifiedDate": "string",
"name": "string",
"state": "DEACTIVATED",
"type": "USER_INFO",
"unique": true,
"validationPattern": "string",
"valueLength": "SHORT",
"values": [
"string"
],
"viewRights": {
"encodedKey": "string",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
}
},
"customFieldID": "string",
"customFieldKey": "string",
"customFieldSetGroupIndex": 0,
"encodedKey": "string",
"indexInList": 0,
"linkedEntityKeyValue": "string",
"parentKey": "string",
"selectionKey": "string",
"value": "string"
}
],
"encodedKey": "string",
"feesDue": 0,
"holdBalance": 0,
"id": "string",
"interestDue": 0,
"interestPaymentDates": [
{
"dayOfMonth": 0,
"monthOfYear": 0,
"year": 0
}
],
"interestPaymentPoint": "EVERY_WEEK",
"interestSettings": {
"accrueInterestAfterMaturity": true,
"encodedKey": "string",
"interestChargeFrequency": "EVERY_WEEK",
"interestChargeFrequencyCount": 0,
"interestRate": 0,
"interestRateReviewCount": 0,
"interestRateReviewUnit": "MONTHS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRateTerms": "TIERED_PERIOD",
"interestRateTiers": [
{
"encodedKey": "string",
"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": "string",
"encodedKey": "string",
"numCentresImported": 0,
"numClientsImported": 0,
"numGLAccountsImported": 0,
"numGroupsImported": 0,
"numLoanRepaymentsImported": 0,
"numLoanTransactionsImported": 0,
"numLoansImported": 0,
"numSavingsImported": 0,
"state": "REVERTED",
"type": "IMPORT"
},
"name": "string",
"notes": "string",
"overdraftAmount": 0,
"overdraftExpiryDate": "string",
"overdraftExpiryDateDTO": {
"dayOfMonth": 0,
"monthOfYear": 0,
"year": 0
},
"overdraftInterestAccrued": 0,
"overdraftInterestSettings": {
"accrueInterestAfterMaturity": true,
"encodedKey": "string",
"interestChargeFrequency": "EVERY_WEEK",
"interestChargeFrequencyCount": 0,
"interestRate": 0,
"interestRateReviewCount": 0,
"interestRateReviewUnit": "MONTHS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRateTerms": "TIERED_PERIOD",
"interestRateTiers": [
{
"encodedKey": "string",
"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"
}