Skip to main content

Filtering and Sorting

Debitura APIs support filtering and sorting on list endpoints.

Sorting​

Use the Sort parameter with syntax field:direction.

GET /cases?Sort=date:desc
DirectionMeaning
ascAscending (oldest first, A-Z)
descDescending (newest first, Z-A)

Sortable fields vary by endpoint. Common fields include Date, GrossAmount, Debtor.

Sorting is available on all three external APIs:

  • Customer API: Case endpoints (Date, GrossAmount, Debtor, and more)
  • Collection Partner API: Case endpoints (Date, GrossAmount, Debtor, and more)
  • Referral Partner API: /clients (dateCreated, name) and /reporting/transactions (collectionDate, amount)

Array Parameters​

Repeat the plain parameter key for each array value:

GET /cases?Statuses=Active&Statuses=Paused
GET /cases?Ids=uuid1&Ids=uuid2

The indexed form (Statuses[0]=Active&Statuses[1]=Paused) also works.

See each API's reference documentation for available filter parameters.

Combining with Pagination​

Filters work with pagination parameters. The totalResults reflects the filtered count.

GET /cases?Statuses=Active&Sort=date:desc&Page=1&PageSize=50

Need Additional Filters or Sort Options?​

Debitura can add new filters and sort options quickly. Contact contact@debitura.com with your use case.