Clientsortingcriteria

The sorting criteria used for Clients

fieldstringrequired

The field to sort by. It can be native (one from the provided list) or otherwise can specify a custom field definition using the format [customFieldSetId].[customFieldId].

Possible values: [encodedKey, id, fullName, firstName, middleName, lastName, creationDate, lastModifiedDate, depositsBalance, loansBalance, pendingLoanAmount, approvedLoanAmount, totalBalance, totalDue, homePhoneNumber, mobilePhoneNumber, mobilePhoneNumber2, emailAddress, birthdate, loanCycle, groupLoanCycle, portalState]

orderstring

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

Possible values: [ASC, DESC]

Clientsortingcriteria

{
  "field": "encodedKey",
  "order": "ASC"
}