Skip to main content

Jsonsavingsaccountapiv1

customInformation object[]

Description for customInformation in JSONSavingsAccountApiV1

  • Array [
  • amountnumber

    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

    property name*number
    builtInCustomFieldIdstring

    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]

    creationDatestring

    the date on which this custom field definition was created

    customFieldProductSettings object[]

    Description for customFieldProductSettings in CustomFieldApiV1

  • Array [
  • customFieldEncodedKeystring

    the key to the parent custom field definition

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    isDefaultboolean

    whether this field is displayed by default when creating a new record

    isRequiredboolean

    whether this field is required when creating a new record

    linkTypestring

    the type of entity this field represents a link to

    Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]

    productKeystring

    when the link type is product, this field should contain the encoded key of the linekd product

  • ]
  • customFieldSelectionOptions object[]

    Description for customFieldSelectionOptions in CustomFieldApiV1

  • Array [
  • constraint object

    Description for constraint in CustomFieldSelectionApiV1

    customFieldKeystring

    Description for customFieldKey in CustomFilterConstraintApiV1

    dataFieldTypestring

    Description for dataFieldType in CustomFilterConstraintApiV1

    Possible values: [NATIVE, CUSTOM]

    dataFieldValuestring

    Description for dataFieldValue in CustomFilterConstraintApiV1

    dataItemTypestring

    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]

    dataTypestring

    Description for dataType in CustomFilterConstraintApiV1

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

    encodedKeystring

    Description for encodedKey in CustomFilterConstraintApiV1

    filterElementstring

    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]

    groupNumbernumber

    Description for groupNumber in CustomFilterConstraintApiV1

    indexnumber

    Description for index in CustomFilterConstraintApiV1

    linkingOperatorstring

    Description for linkingOperator in CustomFilterConstraintApiV1

    Possible values: [OR, AND]

    secondValuestring

    Description for secondValue in CustomFilterConstraintApiV1

    valuestring

    Description for value in CustomFilterConstraintApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    idstring

    the ID of this selectable item

    scorenumber

    the score assigned to this selection

    valuestring

    display name of this option

  • ]
  • customFieldSet object

    Description for customFieldSet in CustomFieldApiV1

    builtInTypestring

    if this set is part of the set of built-in custom field sets, its type will be shown here

    Possible values: [DETAILS, GENERAL]

    createdDatestring

    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

  • Array [
  • 0
    1
    2
    3
    4
    5
    6
    7
    8
    9
  • ]
  • encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    idstring

    the ID of this custom field set

    indexInListnumber

    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

    lastModifiedDatestring

    the date on which this custom field set was last modified

    namestring

    the name of this custom field set

    notesstring

    any notes regarding this custom field set

    typestring

    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]

    usagestring

    whether this custom field set can only be used once, or added multiple times to the same entity

    Possible values: [SINGLE, GROUPED]

    dataTypestring

    the type of custom field definition

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

    descriptionstring

    a brief description of this custom field definition

    editRights object

    Description for editRights in CustomFieldApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    isAccessibleByAllUsersboolean

    Description for isAccessibleByAllUsers in UsageRightsApiV1

    rolesstring[]

    Description for roles in UsageRightsApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    idstring

    the ID for this custom field definition

    indexInListnumber

    Description for indexInList in CustomFieldApiV1

    isDefaultboolean

    whether this field will be included by default on new records

    isRequiredboolean

    whether this field is required when creating a new record

    lastModifiedDatestring

    the date on which this custom field definition was last modified

    namestring

    the name of this custom field definition

    statestring

    whether this field is available for use or has been deactivated

    Possible values: [DEACTIVATED, NORMAL]

    typestring

    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]

    uniqueboolean

    whether the data in this custom field definition needs to be a unique value

    validationPatternstring

    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 @@-##-$$$

    valueLengthstring

    whether this field needs to support a large number of characters

    Possible values: [SHORT, LONG]

    valuesstring[]

    a list of possible values when the field is a selection field

    viewRights object

    Description for viewRights in CustomFieldApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    isAccessibleByAllUsersboolean

    Description for isAccessibleByAllUsers in UsageRightsApiV1

    rolesstring[]

    Description for roles in UsageRightsApiV1

    customFieldIDstring

    Description for customFieldID in CustomFieldValueApiV1

    customFieldKeystring

    Description for customFieldKey in CustomFieldValueApiV1

    customFieldSetGroupIndexnumber

    Description for customFieldSetGroupIndex in CustomFieldValueApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    indexInListnumber

    Description for indexInList in CustomFieldValueApiV1

    linkedEntityKeyValuestring

    Description for linkedEntityKeyValue in CustomFieldValueApiV1

    parentKeystring

    Description for parentKey in CustomFieldValueApiV1

    selectionKeystring

    Description for selectionKey in CustomFieldValueApiV1

    valuestring

    Description for value in CustomFieldValueApiV1

  • ]
  • savingsAccount object

    Description for savingsAccount in JSONSavingsAccountApiV1

    accountHolderKeystring

    Description for accountHolderKey in SavingsAccountApiV1

    accountHolderTypestring

    Description for accountHolderType in SavingsAccountApiV1

    Possible values: [GROUP, CLIENT]

    accountStatestring

    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]

    accountTypestring

    Description for accountType in SavingsAccountApiV1

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

    accruedInterestnumber

    Description for accruedInterest in SavingsAccountApiV1

    activationDatestring

    Description for activationDate in SavingsAccountApiV1

    allowOverdraftboolean

    Description for allowOverdraft in SavingsAccountApiV1

    approvedDatestring

    Description for approvedDate in SavingsAccountApiV1

    assignedBranchKeystring

    Description for assignedBranchKey in SavingsAccountApiV1

    assignedCentreKeystring

    Description for assignedCentreKey in SavingsAccountApiV1

    assignedUserKeystring

    Description for assignedUserKey in SavingsAccountApiV1

    availableBalancenumber

    Description for availableBalance in SavingsAccountApiV1

    balancenumber

    Description for balance in SavingsAccountApiV1

    closedDatestring

    Description for closedDate in SavingsAccountApiV1

    creationDatestring

    the date and time when this savings account was created

    currency object

    Description for currency in SavingsAccountApiV1

    codestring

    the three letter ISO code for this currency

    creationDatestring

    the date on which this currency was created

    currencySymbolPositionstring

    indicates where the currency symbol should appear in relation to the numeric value

    Possible values: [AFTER_NUMBER, BEFORE_NUMBER]

    digitsAfterDecimalnumber

    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.

    isBaseCurrencyboolean

    whether this currency is the base currency for your banking institution

    lastModifiedDatestring

    the date on which this currency was last modified

    namestring

    the name of this currency

    symbolstring

    the currency symnbol used for this currency

    currencyCodestring

    Description for currencyCode in SavingsAccountApiV1

    customFieldValues object[]

    Description for customFieldValues in SavingsAccountApiV1

  • Array [
  • amountnumber

    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

    property name*number
    builtInCustomFieldIdstring

    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]

    creationDatestring

    the date on which this custom field definition was created

    customFieldProductSettings object[]

    Description for customFieldProductSettings in CustomFieldApiV1

  • Array [
  • customFieldEncodedKeystring

    the key to the parent custom field definition

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    isDefaultboolean

    whether this field is displayed by default when creating a new record

    isRequiredboolean

    whether this field is required when creating a new record

    linkTypestring

    the type of entity this field represents a link to

    Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]

    productKeystring

    when the link type is product, this field should contain the encoded key of the linekd product

  • ]
  • customFieldSelectionOptions object[]

    Description for customFieldSelectionOptions in CustomFieldApiV1

  • Array [
  • constraint object

    Description for constraint in CustomFieldSelectionApiV1

    customFieldKeystring

    Description for customFieldKey in CustomFilterConstraintApiV1

    dataFieldTypestring

    Description for dataFieldType in CustomFilterConstraintApiV1

    Possible values: [NATIVE, CUSTOM]

    dataFieldValuestring

    Description for dataFieldValue in CustomFilterConstraintApiV1

    dataItemTypestring

    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]

    dataTypestring

    Description for dataType in CustomFilterConstraintApiV1

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

    encodedKeystring

    Description for encodedKey in CustomFilterConstraintApiV1

    filterElementstring

    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]

    groupNumbernumber

    Description for groupNumber in CustomFilterConstraintApiV1

    indexnumber

    Description for index in CustomFilterConstraintApiV1

    linkingOperatorstring

    Description for linkingOperator in CustomFilterConstraintApiV1

    Possible values: [OR, AND]

    secondValuestring

    Description for secondValue in CustomFilterConstraintApiV1

    valuestring

    Description for value in CustomFilterConstraintApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    idstring

    the ID of this selectable item

    scorenumber

    the score assigned to this selection

    valuestring

    display name of this option

  • ]
  • customFieldSet object

    Description for customFieldSet in CustomFieldApiV1

    builtInTypestring

    if this set is part of the set of built-in custom field sets, its type will be shown here

    Possible values: [DETAILS, GENERAL]

    createdDatestring

    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

  • Array [
  • 0
    1
    2
    3
    4
    5
    6
    7
    8
    9
  • ]
  • encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    idstring

    the ID of this custom field set

    indexInListnumber

    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

    lastModifiedDatestring

    the date on which this custom field set was last modified

    namestring

    the name of this custom field set

    notesstring

    any notes regarding this custom field set

    typestring

    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]

    usagestring

    whether this custom field set can only be used once, or added multiple times to the same entity

    Possible values: [SINGLE, GROUPED]

    dataTypestring

    the type of custom field definition

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

    descriptionstring

    a brief description of this custom field definition

    editRights object

    Description for editRights in CustomFieldApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    isAccessibleByAllUsersboolean

    Description for isAccessibleByAllUsers in UsageRightsApiV1

    rolesstring[]

    Description for roles in UsageRightsApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    idstring

    the ID for this custom field definition

    indexInListnumber

    Description for indexInList in CustomFieldApiV1

    isDefaultboolean

    whether this field will be included by default on new records

    isRequiredboolean

    whether this field is required when creating a new record

    lastModifiedDatestring

    the date on which this custom field definition was last modified

    namestring

    the name of this custom field definition

    statestring

    whether this field is available for use or has been deactivated

    Possible values: [DEACTIVATED, NORMAL]

    typestring

    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]

    uniqueboolean

    whether the data in this custom field definition needs to be a unique value

    validationPatternstring

    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 @@-##-$$$

    valueLengthstring

    whether this field needs to support a large number of characters

    Possible values: [SHORT, LONG]

    valuesstring[]

    a list of possible values when the field is a selection field

    viewRights object

    Description for viewRights in CustomFieldApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    isAccessibleByAllUsersboolean

    Description for isAccessibleByAllUsers in UsageRightsApiV1

    rolesstring[]

    Description for roles in UsageRightsApiV1

    customFieldIDstring

    Description for customFieldID in CustomFieldValueApiV1

    customFieldKeystring

    Description for customFieldKey in CustomFieldValueApiV1

    customFieldSetGroupIndexnumber

    Description for customFieldSetGroupIndex in CustomFieldValueApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    indexInListnumber

    Description for indexInList in CustomFieldValueApiV1

    linkedEntityKeyValuestring

    Description for linkedEntityKeyValue in CustomFieldValueApiV1

    parentKeystring

    Description for parentKey in CustomFieldValueApiV1

    selectionKeystring

    Description for selectionKey in CustomFieldValueApiV1

    valuestring

    Description for value in CustomFieldValueApiV1

  • ]
  • encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    feesDuenumber

    Description for feesDue in SavingsAccountApiV1

    holdBalancenumber

    Description for holdBalance in SavingsAccountApiV1

    idstring

    Description for id in SavingsAccountApiV1

    interestDuenumber

    Description for interestDue in SavingsAccountApiV1

    interestPaymentDates object[]

    Description for interestPaymentDates in SavingsAccountApiV1

  • Array [
  • dayOfMonthnumber

    the day of the month

    monthOfYearnumber

    the month

    yearnumber

    the year

  • ]
  • interestPaymentPointstring

    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

    accrueInterestAfterMaturityboolean

    Description for accrueInterestAfterMaturity in InterestAccountSettingsApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    interestChargeFrequencystring

    Description for interestChargeFrequency in InterestAccountSettingsApiV1

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

    interestChargeFrequencyCountnumber

    Description for interestChargeFrequencyCount in InterestAccountSettingsApiV1

    interestRatenumber

    Description for interestRate in InterestAccountSettingsApiV1

    interestRateReviewCountnumber

    Description for interestRateReviewCount in InterestAccountSettingsApiV1

    interestRateReviewUnitstring

    Description for interestRateReviewUnit in InterestAccountSettingsApiV1

    Possible values: [MONTHS, WEEKS, DAYS]

    interestRateSourcestring

    Description for interestRateSource in InterestAccountSettingsApiV1

    Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]

    interestRateTermsstring

    Description for interestRateTerms in InterestAccountSettingsApiV1

    Possible values: [TIERED_PERIOD, FIXED, TIERED]

    interestRateTiers object[]

    Description for interestRateTiers in InterestAccountSettingsApiV1

  • Array [
  • encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    endingBalancenumber

    Description for endingBalance in InterestRateTierApiV1

    endingDaynumber

    Description for endingDay in InterestRateTierApiV1

    indexnumber

    Description for index in InterestRateTierApiV1

    interestRatenumber

    Description for interestRate in InterestRateTierApiV1

  • ]
  • interestSpreadnumber

    Description for interestSpread in InterestAccountSettingsApiV1

    lastAccountAppraisalDatestring

    Description for lastAccountAppraisalDate in SavingsAccountApiV1

    lastInterestCalculationDatestring

    Description for lastInterestCalculationDate in SavingsAccountApiV1

    lastInterestStoredDatestring

    Description for lastInterestStoredDate in SavingsAccountApiV1

    lastModifiedDatestring

    the date on which this savings account was last modified

    lastOverdraftInterestReviewDatestring

    Description for lastOverdraftInterestReviewDate in SavingsAccountApiV1

    lastSetToArrearsDatestring

    Description for lastSetToArrearsDate in SavingsAccountApiV1

    lineOfCreditKeystring

    Description for lineOfCreditKey in SavingsAccountApiV1

    lockedBalancenumber

    Description for lockedBalance in SavingsAccountApiV1

    lockedDatestring

    Description for lockedDate in SavingsAccountApiV1

    maturityDatestring

    Description for maturityDate in SavingsAccountApiV1

    maxWidthdrawlAmountnumber

    Description for maxWidthdrawlAmount in SavingsAccountApiV1

    migrationEvent object

    Description for migrationEvent in SavingsAccountApiV1

    creationDatestring<date-time>

    the date on which the data import was made

    encodedKeystring

    the encoded key of this data migration event

    numCentresImportednumber

    the number of centres which were imported during the data migration

    numClientsImportednumber

    the number of clients which were imported as part of the data migration

    numGLAccountsImportednumber

    the number of general ledger accounts which were imported as part of the data migration

    numGroupsImportednumber

    the number of groups which were imported as part of the data migration

    numLoanRepaymentsImportednumber

    the number of loan repayment transations which were imported as part of the data migration

    numLoanTransactionsImportednumber

    the number of loan transactions which were imported as part of the data migration

    numLoansImportednumber

    the number of loan accounts which were imported as part of the data migration

    numSavingsImportednumber

    the number of savings accounts which were imported as part of the data migration

    statestring

    whether the data import was accepted, is still in a draft state, or was rejected and all data reverted

    Possible values: [REVERTED, DRAFT, APPROVED]

    typestring

    the type of migration event

    Possible values: [IMPORT, EXPORT]

    namestring

    Description for name in SavingsAccountApiV1

    notesstring

    Description for notes in SavingsAccountApiV1

    overdraftAmountnumber

    Description for overdraftAmount in SavingsAccountApiV1

    overdraftExpiryDatestring

    Description for overdraftExpiryDate in SavingsAccountApiV1

    overdraftExpiryDateDTO object

    Description for overdraftExpiryDateDTO in SavingsAccountApiV1

    dayOfMonthnumber

    the day of the month

    monthOfYearnumber

    the month

    yearnumber

    the year

    overdraftInterestAccruednumber

    Description for overdraftInterestAccrued in SavingsAccountApiV1

    overdraftInterestSettings object

    Description for overdraftInterestSettings in SavingsAccountApiV1

    accrueInterestAfterMaturityboolean

    Description for accrueInterestAfterMaturity in InterestAccountSettingsApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    interestChargeFrequencystring

    Description for interestChargeFrequency in InterestAccountSettingsApiV1

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

    interestChargeFrequencyCountnumber

    Description for interestChargeFrequencyCount in InterestAccountSettingsApiV1

    interestRatenumber

    Description for interestRate in InterestAccountSettingsApiV1

    interestRateReviewCountnumber

    Description for interestRateReviewCount in InterestAccountSettingsApiV1

    interestRateReviewUnitstring

    Description for interestRateReviewUnit in InterestAccountSettingsApiV1

    Possible values: [MONTHS, WEEKS, DAYS]

    interestRateSourcestring

    Description for interestRateSource in InterestAccountSettingsApiV1

    Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]

    interestRateTermsstring

    Description for interestRateTerms in InterestAccountSettingsApiV1

    Possible values: [TIERED_PERIOD, FIXED, TIERED]

    interestRateTiers object[]

    Description for interestRateTiers in InterestAccountSettingsApiV1

  • Array [
  • encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    endingBalancenumber

    Description for endingBalance in InterestRateTierApiV1

    endingDaynumber

    Description for endingDay in InterestRateTierApiV1

    indexnumber

    Description for index in InterestRateTierApiV1

    interestRatenumber

    Description for interestRate in InterestRateTierApiV1

  • ]
  • interestSpreadnumber

    Description for interestSpread in InterestAccountSettingsApiV1

    overdraftLimitnumber

    Description for overdraftLimit in SavingsAccountApiV1

    productTypeKeystring

    Description for productTypeKey in SavingsAccountApiV1

    recommendedDepositAmountnumber

    Description for recommendedDepositAmount in SavingsAccountApiV1

    targetAmountnumber

    Description for targetAmount in SavingsAccountApiV1

    technicalInterestDuenumber

    Description for technicalInterestDue in SavingsAccountApiV1

    technicalOverdraftAmountnumber

    Description for technicalOverdraftAmount in SavingsAccountApiV1

    technicalOverdraftInterestAccruednumber

    Description for technicalOverdraftInterestAccrued in SavingsAccountApiV1

    withholdingTaxSourceKeystring

    Description for withholdingTaxSourceKey in SavingsAccountApiV1

    Jsonsavingsaccountapiv1
    {
    "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"
    }
    ],
    "savingsAccount": {
    "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"
    }
    }