Depositaccountsearchcriteria

Represents the filtering criteria list and the sorting criteria for searching deposit accounts.

filterCriteria object[]

The list of filtering criteria.

Array [

fieldstringrequired

The fields to search, which can be enumerated values or custom fields using the format [customFieldSetId].[customFieldId].

Possible values: [encodedKey, id, name, accountHolderKey, clientId, groupId, accountHolderName, accountState, accountType, creationDate, activationDate, approvedDate, lastModifiedDate, maturityDate, lastSetToArrearsDate, closedDate, accruedAmounts.interestAccrued, accruedAmounts.overdraftInterestAccrued, accruedAmounts.technicalOverdraftInterestAccrued, maxBalance, balances.availableBalance, balances.blockedBalance, balances.feesDue, balances.lockedBalance, balances.overdraftAmount, balances.overdraftInterestDue, balances.technicalOverdraftAmount, balances.totalBalance, balances.holdBalance, assignedBranchKey, assignedCentreKey, assignedUserKey, currencyCode, interestSettings.interestRate, currentInterestTier.endingBalance, currentInterestTier.index, currentInterestTier.interestRate, currentInterestTier.startingBalance, internalControls.maxWithdrawalAmount, internalControls.recommendedDepositAmount, internalControls.targetAmount, lengthInDays, overdraftRiskLevelKey, overdraftAvailableLimit, overdraftDaysInArrears, overdraftInArrears, overdraftInterestSettings.interestRateSettings.interestRate, overdraftInterestSettings.interestRateSettings.interestSpread, currentOverdraftInterestTier.endingBalance, currentOverdraftInterestTier.index, currentOverdraftInterestTier.interestRate, currentOverdraftInterestTier.startingBalance, overdraftSettings.overdraftExpiryDate, overdraftSettings.overdraftLimit, overdraftSettings.allowOverdraft, productTypeKey, productCategory, taxApplied, withholdingTaxSourceKey, taxRate]

operatorstringrequired

Operator	Affected values	Available for
EQUALS	ONE_VALUE	BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
EQUALS_CASE_SENSITIVE	ONE_VALUE	BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
MORE_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
LESS_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
BETWEEN	TWO_VALUES	BIG_DECIMAL,NUMBER,MONEY,DATE,DATE_TIME
ON	ONE_VALUE	DATE,DATE_TIME
AFTER	ONE_VALUE	DATE,DATE_TIME
BEFORE	ONE_VALUE	DATE,DATE_TIME
BEFORE_INCLUSIVE	ONE_VALUE	DATE,DATE_TIME
STARTS_WITH	ONE_VALUE	STRING
STARTS_WITH_CASE_SENSITIVE	ONE_VALUE	STRING
IN	LIST	ENUM,KEY
TODAY	NO_VALUE	DATE,DATE_TIME
THIS_WEEK	NO_VALUE	DATE,DATE_TIME
THIS_MONTH	NO_VALUE	DATE,DATE_TIME
THIS_YEAR	NO_VALUE	DATE,DATE_TIME
LAST_DAYS	ONE_VALUE	NUMBER
EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_TIME
NOT_EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_TIME

Possible values: [EQUALS, EQUALS_CASE_SENSITIVE, DIFFERENT_THAN, MORE_THAN, LESS_THAN, BETWEEN, ON, AFTER, AFTER_INCLUSIVE, BEFORE, BEFORE_INCLUSIVE, STARTS_WITH, STARTS_WITH_CASE_SENSITIVE, IN, TODAY, THIS_WEEK, THIS_MONTH, THIS_YEAR, LAST_DAYS, EMPTY, NOT_EMPTY]

secondValuestring

The second value to match the searching criteria, when the BETWEEN operator is used.

valuestring

The value to match the searching criteria.

valuesstring[]

List of values when the IN operator is used.

]

sortingCriteria object

The sorting criteria used for searching deposit accounts.

fieldstringrequired

The field used as sorting selection

orderstring

The sorting order: ASC or DESC. The default order is DESC.

Possible values: [ASC, DESC]

Depositaccountsearchcriteria

{
  "filterCriteria": [
    {
      "field": "encodedKey",
      "operator": "EQUALS",
      "secondValue": "string",
      "value": "string",
      "values": [
        "string"
      ]
    }
  ],
  "sortingCriteria": {
    "field": "string",
    "order": "ASC"
  }
}