Search for savings transactions
POST/savings/transactions/search
Allows to retrieve transactions using dynamic custom filters.
Parameters
| Parameter | Value |
| filterConstraints | A JSON array of constraints. |
| filterSelection | The field on which the constraint will be applied. Available transaction filter selections can be found below. |
| filterElement | The constraint operator. Available filter elements can be found below. |
| value | The constraint value. Required for filter elements with one or two values. |
| secondValue | The constraint second value. Required for filter elements with two values. |
| dataItemType | The entity where the field on which to apply the constraint is located. If the field is located in the same entity with the entity being searched, this field is optional. |
Available transaction filter values
| Filter Selection Parameter | Data Type |
| PARENT_ACCOUNT_KEY | KEY |
| PRODUCT_TYPE_KEY | KEY |
| USER_KEY | KEY |
| BRANCH_KEY | KEY |
| CENTRE_KEY | KEY |
| PARENT_ACCOUNT_HOLDER_KEY | KEY |
| CURRENCY_CODE | KEY |
| PRODUCT_ID | STRING |
| WAS_REVERSED | BOOLEAN |
| TYPE_IS_REVERSAL | BOOLEAN |
| INTERNAL_TRANSFER | BOOLEAN |
| TRANSACTION_CHANNEL_KEY | KEY |
| ENCODED_KEY | KEY |
| TRANSACTION_ID | LONG |
| TILL_ID | STRING |
| ENTRY_DATE | DATE |
| TRANSACTION_DATE | DATE_UTC |
| EVENT | ENUM |
| AMOUNT | MONEY |
| ADVANCE_POSITION | MONEY |
| ARREARS_POSITION | MONEY |
| EXPECTED_PRINCIPAL_REDRAW | MONEY |
| ORIGINAL_AMOUNT | MONEY |
| ORIGINAL_AMOUNT_CURRENCY_CODE | STRING |
| BALANCE (Deprecated. Use TOTAL_BALANCE) | MONEY |
| TOTAL_BALANCE | MONEY |
| PRINCIPAL_BALANCE | MONEY |
| REDRAW_BALANCE | MONEY |
| PRINCIPAL_PAID | MONEY |
| INTEREST_PAID | MONEY |
| DEFERRED_INTEREST | MONEY |
| FEES_PAID | MONEY |
| FEE_KEY | KEY |
| FEE_TYPE | ENUM |
| PENALTY_PAID | MONEY |
| BRANCH | STRING |
| CENTRE | STRING |
| PARENT_ACCOUNT | STRING |
| PARENT_ACCOUNT_ID | STRING |
| PARENT_ACCOUNT_HOLDER | STRING |
| PARENT_ACCOUNT_HOLDER_ID | STRING |
| TAX_RATE | BIG_DECIMAL |
| TAX_AMOUNT | MONEY |
| INTEREST_RATE | BIG_DECIMAL |
| PRINCIPAL_PAYMENT_FLAT_AMOUNT | MONEY |
| PRINCIPAL_PAYMENT_PERCENTAGE | BIG_DECIMAL |
| OVERDRAFT_INTEREST_RATE | BIG_DECIMAL |
| OVERDRAFT_LIMIT | MONEY |
Available filter elements
| Filter Element | Number Of 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_UTC |
| ON | ONE_VALUE | DATE,DATE_UTC |
| AFTER | ONE_VALUE | DATE,DATE_UTC |
| BEFORE | ONE_VALUE | DATE,DATE_UTC |
| STARTS_WITH | ONE_VALUE | STRING |
| IN | LIST | ENUM,KEY |
| TODAY | NO_VALUE | DATE,DATE_UTC |
| THIS_WEEK | NO_VALUE | DATE,DATE_UTC |
| THIS_MONTH | NO_VALUE | DATE,DATE_UTC |
| THIS_YEAR | NO_VALUE | DATE,DATE_UTC |
| LAST_DAYS | ONE_VALUE | DATE,DATE_UTC |
| EMPTY | NO_VALUE | BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC |
| NOT_EMPTY | NO_VALUE | BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC |
note
Optimising searches: Use EQUALS_CASE_SENSITIVE when searching by transaction id or account parent id as the performance is better than EQUALS. It can be used in all situations where we know precisely the case of the supplied value.
Request
Responses
- 200
OK