Deposittransactionsearchcriteria

Wrapper that holds a list of filtering criteria and a sorting criteria for Deposit transaction client directed query

filterCriteria object[]required

The list of filtering criteria

Array [

fieldstringrequired

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

Field with limited capabilities	Data Type	Operators
originalTransactionKey	KEY	EQUALS, IN
transactionDetails.transactionChannelId	STRING	EQUALS
originalTransactionID	STRING	EQUALS

Possible values: [encodedKey, id, externalId, holdExternalReferenceId, productID, currencyCode, branchID, branchKey, centreID, centreKey, tillID, tillKey, amount, affectedAmounts.fundsAmount, affectedAmounts.interestAmount, affectedAmounts.feesAmount, parentAccountKey, parentAccountID, productTypeKey, paymentOrderId, userKey, adjustmentTransactionID, adjustmentTransactionKey, originalTransactionKey, originalTransactionID, transactionDetails.transactionChannelKey, transactionDetails.transactionChannelId, type, creationDate, accountBalances.totalBalance, valueDate, taxes.taxRate, terms.interestSettings.interestRate, fees.trigger, fees.name, fees.predefinedFeeKey, wasAdjusted, typeIsAdjustment, affectedAmounts.overdraftAmount, affectedAmounts.overdraftInterestAmount, affectedAmounts.overdraftFeesAmount, affectedAmounts.technicalOverdraftAmount, affectedAmounts.technicalOverdraftInterestAmount, terms.overdraftInterestSettings.interestRate, terms.overdraftInterestSettings.indexInterestRate]

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 Deposit transactions client directed query

fieldstringrequired

The field to use to sort the selection. The field can be an enumerated value or a custom field using the format [customFieldSetId].[customFieldId].

Possible values: [id, externalId, parentAccountId, productId, valueDate, creationDate, amount, branchId, centreId, tillId, fees.name, transactionDetails.transactionChannelId, taxes.taxRate, terms.interestSettings.interestRate, terms.overdraftInterestSettings.interestRate, terms.overdraftSettings.overdraftLimit, affectedAmounts.interestAmount, affectedAmounts.feesAmount, accountBalances.totalBalance]

orderstring

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

Possible values: [ASC, DESC]

Deposittransactionsearchcriteria

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