Loantransactionsearchcriteria
Represents the filtering and sorting criteria when searching loan transactions.
filterCriteria object[]
The list of filtering criteria.
Contains the actual searching fields that can be native (one from the provided list) or otherwise can specify a custom field definition 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, creationDate, valueDate, parentAccountKey, parentAccountHolderKey, productTypeKey, productID, type, amount, originalAmount, originalCurrencyCode, affectedAmounts.principalAmount, affectedAmounts.interestAmount, affectedAmounts.fundersInterestAmount, affectedAmounts.organizationCommissionAmount, affectedAmounts.deferredInterestAmount, affectedAmounts.feesAmount, affectedAmounts.penaltyAmount, taxes.taxRate, accountBalances.totalBalance, accountBalances.advancePosition, accountBalances.arrearsPosition, accountBalances.expectedPrincipalRedraw, accountBalances.redrawBalance, accountBalances.principalBalance, userKey, branchKey, branchID, centreKey, centreID, tillKey, tillID, adjustmentTransactionKey, originalTransactionKey, terms.interestSettings.interestRate, transactionDetails.transactionChannelKey, transactionDetails.transactionChannelId, wasAdjusted, typeIsAdjustment, fees.predefinedFeeKey, fees.trigger, fees.name, parentAccountID, adjustmentTransactionID, originalTransactionID]
| 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]
The second value to match the searching criteria, when the BETWEEN operator is used.
The value to match the searching criteria.
List of values when the IN operator is used.
sortingCriteria object
The sorting criteria used for when searching loan transactions.
Contains the field that can be used as sorting selection. Can be native (one from the provided list) or otherwise can specify a custom field using the format [customFieldSetId].[customFieldId].
Possible values: [id, externalId, creationDate, valueDate, parentAccountId, productId, amount, originalAmount, originalCurrencyCode, branchId, centreId, tillId, terms.interestSettings.interestRate, transactionDetails.transactionChannelId, fees.name, accountBalances.totalBalance, accountBalances.principalBalance, accountBalances.redrawBalance, accountBalances.expectedPrincipalRedraw, accountBalances.advancePosition, accountBalances.arrearsPosition, affectedAmounts.principalAmount, affectedAmounts.interestAmount, affectedAmounts.interestFromArrearsAmount, affectedAmounts.deferredInterestAmount, affectedAmounts.feesAmount, affectedAmounts.penaltyAmount, affectedAmounts.organizationCommissionAmount, affectedAmounts.fundersInterestAmount, taxes.taxRate]
The sorting order: ASC or DESC. The default order is DESC.
Possible values: [ASC, DESC]
{
"filterCriteria": [
{
"field": "encodedKey",
"operator": "EQUALS",
"secondValue": "string",
"value": "string",
"values": [
"string"
]
}
],
"sortingCriteria": {
"field": "id",
"order": "ASC"
}
}