Skip to main content

Filter Constraints

Example query with an array of filters on a standard field and a custom field definition and its value, and a sorting order

{
"filterConstraints":[
{
"filterSelection":"CREATION_DATE",
"filterElement":"BETWEEN",
"value":"2015-01-01",
"secondValue":"2015-06-20"
},
{
"filterSelection":"MY_CUSTOM_FIELD",
"filterElement":"EQUALS",
"dataItemType":"CLIENT",
"dataFieldType":"CUSTOM",
"value":"BIG spenders"
}
],
"sortDetails":{
"sortingColumn":"lastModifiedDate",
"sortingOrder":"DESCENDING"
}
}

filterContraints array

ParameterValue
filterSelectionThe field on which the constraint will be applied. For custom fields, the custom field definition encoded key must be provided.
filterElementThe constraint operator. Available filter elements can be found below.
valueThe constraint value. Required for filter elements with one or two values.
secondValueThe constraint second value. Required for filter elements with two values.
dataItemTypeThe 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. Possible values:
  • CLIENT - can be used for client/loans/savings/transactions endpoints
  • GROUP - can be used for group/loans/savings/transactions endpoints
  • LOANS - can be used for loans/transactions endpoints
  • TRANCHE - can be used for loans endpoint
  • DISBURSEMENT_DETAILS - can be used for loans/transactions endpoints
  • SAVINGS - can be used savings/transactions endpoints
  • TRANSACTION - cab be used for transactions/gljournalentries endpoint
  • JOURNAL_ENTRY - can be used for gljournalentries endpoint
  • NOTIFICATION_MESSAGE - can be used only for notification messages
dataFieldTypeNATIVE(default)/CUSTOM for custom field definition searches

sortDetails object

ParameterValue
sortingColumnThe name of the column on which the order is going to take place
sortingOrderThe order in which your results should be presented, either ASCENDING or DESCENDING