Savingsaccountapiv1

accountHolderKeystring

accountHolderTypestring

Possible values: [GROUP, CLIENT]

accountStatestring

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]

accountTypestring

Possible values: [CURRENT_ACCOUNT, REGULAR_SAVINGS, FIXED_DEPOSIT, INVESTOR_ACCOUNT, SAVINGS_PLAN]

accruedInterestnumber

activationDatestring

allowOverdraftboolean

approvedDatestring

assignedBranchKeystring

assignedCentreKeystring

assignedUserKeystring

availableBalancenumber

balancenumber

closedDatestring

creationDatestring

currency object

codestring

creationDatestring

currencySymbolPositionstring

Possible values: [AFTER_NUMBER, BEFORE_NUMBER]

digitsAfterDecimalnumber

isBaseCurrencyboolean

lastModifiedDatestring

namestring

symbolstring

currencyCodestring

customFieldValues object[]

Array [

amountnumber

customField object

amounts object

property name*number

builtInCustomFieldIdstring

Possible values: [MOBILE_PHONE, EMAIL_ADDRESS, GENDER, MIDDLE_NAME, HOME_PHONE, BIRTHDATE, LAST_NAME, FIRST_NAME]

creationDatestring

customFieldProductSettings object[]

Array [

customFieldEncodedKeystring

encodedKeystring

isDefaultboolean

isRequiredboolean

linkTypestring

Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]

productKeystring

]

customFieldSelectionOptions object[]

Array [

constraint object

customFieldKeystring

dataFieldTypestring

Possible values: [NATIVE, CUSTOM]

dataFieldValuestring

dataItemTypestring

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]

dataTypestring

Possible values: [ENUM, MONEY, NUMBER, DATE_UTC, JAVA_BLOB, OBJECT, BOOLEAN, DATE, PERCENT, BIG_DECIMAL, STRING, KEY, LONG]

encodedKeystring

filterElementstring

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]

groupNumbernumber

indexnumber

linkingOperatorstring

Possible values: [OR, AND]

secondValuestring

valuestring

encodedKeystring

idstring

scorenumber

valuestring

]

customFieldSet object

builtInTypestring

Possible values: [DETAILS, GENERAL]

createdDatestring

customFieldsundefined[]

encodedKeystring

idstring

indexInListnumber

lastModifiedDatestring

namestring

notesstring

typestring

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]

usagestring

Possible values: [SINGLE, GROUPED]

dataTypestring

Possible values: [GROUP_LINK, DATE, NUMBER, CHECKBOX, CLIENT_LINK, STRING, USER_LINK, SELECTION]

descriptionstring

editRights object

encodedKeystring

isAccessibleByAllUsersboolean

rolesstring[]

encodedKeystring

idstring

indexInListnumber

isDefaultboolean

isRequiredboolean

lastModifiedDatestring

namestring

statestring

Possible values: [DEACTIVATED, NORMAL]

typestring

uniqueboolean

validationPatternstring

valueLengthstring

Possible values: [SHORT, LONG]

valuesstring[]

viewRights object

encodedKeystring

isAccessibleByAllUsersboolean

rolesstring[]

customFieldIDstring

customFieldKeystring

customFieldSetGroupIndexnumber

encodedKeystring

indexInListnumber

linkedEntityKeyValuestring

parentKeystring

selectionKeystring

valuestring

]

encodedKeystring

feesDuenumber

holdBalancenumber

idstring

interestDuenumber

interestPaymentDates object[]

Array [

dayOfMonthnumber

monthOfYearnumber

yearnumber

]

interestPaymentPointstring

Possible values: [EVERY_WEEK, ON_FIXED_DATES, EVERY_MONTH, ON_ACCOUNT_MATURITY, EVERY_3_MONTHS, FIRST_DAY_OF_MONTH, EVERY_OTHER_WEEK]

interestSettings object

accrueInterestAfterMaturityboolean

encodedKeystring

interestChargeFrequencystring

Possible values: [EVERY_WEEK, ANNUALIZED, EVERY_MONTH, EVERY_X_DAYS, EVERY_FOUR_WEEKS, EVERY_DAY]

interestChargeFrequencyCountnumber

interestRatenumber

interestRateReviewCountnumber

interestRateReviewUnitstring

Possible values: [MONTHS, WEEKS, DAYS]

interestRateSourcestring

Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]

interestRateTermsstring

Possible values: [TIERED_PERIOD, FIXED, TIERED]

interestRateTiers object[]

Array [

encodedKeystring

endingBalancenumber

endingDaynumber

indexnumber

interestRatenumber

]

interestSpreadnumber

lastAccountAppraisalDatestring

lastInterestCalculationDatestring

lastInterestStoredDatestring

lastModifiedDatestring

lastOverdraftInterestReviewDatestring

lastSetToArrearsDatestring

lineOfCreditKeystring

lockedBalancenumber

lockedDatestring

maturityDatestring

maxWidthdrawlAmountnumber

migrationEvent object

creationDatestring

encodedKeystring

numCentresImportednumber

numClientsImportednumber

numGLAccountsImportednumber

numGroupsImportednumber

numLoanRepaymentsImportednumber

numLoanTransactionsImportednumber

numLoansImportednumber

numSavingsImportednumber

statestring

Possible values: [REVERTED, DRAFT, APPROVED]

typestring

Possible values: [IMPORT, EXPORT]

namestring

notesstring

overdraftAmountnumber

overdraftExpiryDatestring

overdraftExpiryDateDTO object

dayOfMonthnumber

monthOfYearnumber

yearnumber

overdraftInterestAccruednumber

overdraftInterestSettings object

accrueInterestAfterMaturityboolean

encodedKeystring

interestChargeFrequencystring

Possible values: [EVERY_WEEK, ANNUALIZED, EVERY_MONTH, EVERY_X_DAYS, EVERY_FOUR_WEEKS, EVERY_DAY]

interestChargeFrequencyCountnumber

interestRatenumber

interestRateReviewCountnumber

interestRateReviewUnitstring

Possible values: [MONTHS, WEEKS, DAYS]

interestRateSourcestring

Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]

interestRateTermsstring

Possible values: [TIERED_PERIOD, FIXED, TIERED]

interestRateTiers object[]

Array [

encodedKeystring

endingBalancenumber

endingDaynumber

indexnumber

interestRatenumber

]

interestSpreadnumber

overdraftLimitnumber

productTypeKeystring

recommendedDepositAmountnumber

targetAmountnumber

technicalInterestDuenumber

technicalOverdraftAmountnumber

technicalOverdraftInterestAccruednumber

withholdingTaxSourceKeystring

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": [
            null
          ],
          "encodedKey": "string",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "string",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "string",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "string",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "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"
}