v1

latestOpenAPI 3.0.42026-08-042281222.0 KB
Cases

List cases for referral partner clients

Retrieves a paginated list of debt collection cases for all clients linked to the authenticated referral partner.

Case Lifecycle Stages Cases progress through a defined lifecycle: • Pending contract signing - Client hasn't signed debt collection agreement yet • Pending Verification Internal - Case awaiting internal Debitura review • Pending Verification - Case awaiting partner verification • More Info Required - More information required from creditor • Collecting Quotes - Awaiting quote from collection partner • Pending Quote Selection - Quote provided by partner • Active - Case is being actively collected • Paused - Collection temporarily paused • Closed - Case is closed (check CloseCode for reason)

Filtering Options • FromDate/ToDate - Filter by case creation date range (ISO 8601) • ExternalTenantId - Filter to specific client using your identifier • Statuses - Filter by lifecycle status(es) • Query - Search across reference numbers and debtor name

Sorting • Sort - Sort field and direction (format: 'field:direction') • Supported fields: DateCreated, GrossAmount, DueDate • Examples: 'DateCreated:desc', 'GrossAmount:asc', 'DueDate:desc' • Default: DateCreated:desc (newest first)

get/cases

Query parameters

FromDatestring date-time

Filter cases from this date (inclusive, based on case creation date). ISO 8601 format.

ToDatestring date-time

Filter cases to this date (inclusive, based on case creation date). ISO 8601 format.

ExternalTenantIdstring

Filter by specific client's external tenant ID

Statusesstring[]

Filter by case lifecycle status(es). Multiple values can be provided. Accepts enum names (e.g. "Active", "Closed") or descriptions (e.g. "More Info Required").

Querystring

Search query across case reference, creditor reference, and debtor name

Pageinteger

Page number (1-indexed)

PageSizeinteger

Number of results per page (default: 10, max: 100)

CountryIdsinteger[]

Filter by debtor country ID(s). Multiple values can be provided. Only cases where the debtor's country matches one of the specified IDs are returned.

CollectionPartnerIdsstring[]

Filter by collection partner ID(s). Multiple values can be provided. Only cases assigned to one of the specified collection partners are returned.

Sortstring

Sort field and direction. Format: "field[:asc|desc]" Supported fields: DateCreated, GrossAmount, DueDate Examples: "DateCreated:desc", "GrossAmount:asc" Default: DateCreated:desc

Response

Cases retrieved successfully

All 22 operations