DEdebitura
Cases

List cases for referral partner clients

Changed on

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 • WaitingOn - Client or Debitura (held cases only; string values)

Held cases expose hold.waitingOn, waitingSince, requestDelivery (Pending/Delivered/Failed) and the latest unanswered client question. Delivery failure reasons and internal reviewer data are never returned. Pending/failed delivery does not start a response deadline; an unknown delivery time stays null. Summary counts follow all requested filters, before pagination.

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

Request

  • Base URL
    https://referral-api.debitura.com
  • URL
    https://referral-api.debitura.com/cases
  • Auth
    API key in header XApiKey

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

WaitingOnstring

Filter held cases by Client or Debitura. Numeric values are not accepted.

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

Changes

  • cf12c7f270d9Revision changes
    • info

      added the new optional query request parameter WaitingOn

    • info

      added the optional property // to the response with the status (media type: text/plain)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: text/json)

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)