Filtering and Sorting
Debitura APIs support filtering and sorting on list endpoints.
Sorting
Use the Sort parameter with syntax field:direction.
GET /v1/cases?Sort=date:desc
| Direction | Meaning |
|---|---|
asc | Ascending (oldest first, A-Z) |
desc | Descending (newest first, Z-A) |
Sortable fields vary by endpoint. Common fields include date, amount, debtorName.
Sorting is available on all three external APIs:
- Customer API: Case endpoints (
date,amount,debtorName, and more) - Collection Partner API: Case endpoints (
date,amount,debtorName, and more) - Referral Partner API:
/clients(dateCreated,name) and/reporting/transactions(collectionDate,amount)
Array Parameters
Use bracket notation for array filters:
GET /v1/cases?Statuses[]=Active&Statuses[]=Paused
GET /v1/cases?Ids[]=uuid1&Ids[]=uuid2
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 /v1/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.