Skip to main content

Loantransactionsearchcriteria

Represents the filtering and sorting criteria when searching loan transactions.

filterCriteria object[]

The list of filtering criteria.

  • Array [
  • fieldstringrequired

    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 capabilitiesData TypeOperators
    originalTransactionKeyKEYEQUALS, IN
    transactionDetails.transactionChannelIdSTRINGEQUALS
    originalTransactionIDSTRINGEQUALS

    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]

    operatorstringrequired
    OperatorAffected valuesAvailable for
    EQUALSONE_VALUEBIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
    EQUALS_CASE_SENSITIVEONE_VALUEBIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
    MORE_THANONE_VALUEBIG_DECIMAL,NUMBER,MONEY
    LESS_THANONE_VALUEBIG_DECIMAL,NUMBER,MONEY
    BETWEENTWO_VALUESBIG_DECIMAL,NUMBER,MONEY,DATE,DATE_TIME
    ONONE_VALUEDATE,DATE_TIME
    AFTERONE_VALUEDATE,DATE_TIME
    BEFOREONE_VALUEDATE,DATE_TIME
    BEFORE_INCLUSIVEONE_VALUEDATE,DATE_TIME
    STARTS_WITHONE_VALUESTRING
    STARTS_WITH_CASE_SENSITIVEONE_VALUESTRING
    INLISTENUM,KEY
    TODAYNO_VALUEDATE,DATE_TIME
    THIS_WEEKNO_VALUEDATE,DATE_TIME
    THIS_MONTHNO_VALUEDATE,DATE_TIME
    THIS_YEARNO_VALUEDATE,DATE_TIME
    LAST_DAYSONE_VALUENUMBER
    EMPTYNO_VALUEBIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_TIME
    NOT_EMPTYNO_VALUEBIG_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 when searching loan transactions.

    fieldstringrequired

    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]

    orderstring

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

    Possible values: [ASC, DESC]

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