Sign in

d0dcc5024bd1

latestOpenAPI 3.0.42026-08-104969330.3 KB
Cases

List collection cases.

Returns a paginated list of cases where you are the collection partner (actively collecting the debt).

What is a Collection Partner? A collection partner is an agency or law firm that performs the actual debt recovery work. When you appear as the collection partner on a case, you are responsible for:

  • Contacting the debtor and attempting recovery
  • Managing the case lifecycle and status updates
  • Recording payments and fees
  • Uploading documents and evidence
  • Communicating with the creditor through the case chat

Note: This endpoint shows cases where you are collecting. For cases you submitted on behalf of your own clients (where you are the managing partner), use the /managed-cases endpoint instead.

Pagination:

  • page (default: 1) - Page number, starting from 1
  • pageSize (default: 10, max: 100) - Number of results per page

Filters:

  • statuses - Filter by case lifecycle status (comma-separated list) Valid values: PendingVerification, NeedsAdditionalDetails, Leads, LeadsQuoteGiven, Active, Paused, Closed Note: Partner-specific statuses only. Internal platform statuses like 'PendingContractSigning' or 'PendingVerificationInternal' are not available here — cases in those stages are hidden from every collection-partner-facing endpoint until Debitura's internal verification clears, regardless of assignment.
  • divisionIds - Filter by creditor division IDs (comma-separated GUIDs)
  • debtorIds - Filter by specific debtor IDs (comma-separated GUIDs)
  • ids - Filter by specific case IDs (comma-separated GUIDs)
  • includeTestCases - When true, includes test/demo cases owned by the caller. Defaults to false.

Sorting:

  • sort - Sort field and direction (format: 'field:direction') Examples: 'date:desc', 'amount:asc', 'debtorName:asc'

Response:

  • Returns InvoiceListApiDTO with page metadata and cases array
  • Page metadata includes: totalResults, currentPage, skipped, pageSize
get/cases

Query parameters

Pageinteger
PageSizeinteger
DebtorIdsstring[]
Idsstring[]
Statusesstring[]

Filter by case lifecycle status. Valid values: PendingContractSigning, PendingVerificationInternal, PendingVerification, NeedsAdditionalDetails, Leads, LeadsQuoteGiven, Active, Paused, Closed, Merged (case-insensitive; both name and description forms accepted).

DivisionIdsstring[]

Optional list of division IDs to filter by

Sortstring

Optional sorting string "Field[:asc|desc][,Field2[:asc|desc]]…". Valid sort fields: DateCreated, DateUpdated, DateFinished, DateCollectionStarted, DueDate, Date, GrossAmount, Remainder, InterestFees, CollectionFees, ReminderFees, Lifecycle, CloseCode. Examples: 'DateCreated:desc', 'DueDate:asc'. Unknown fields are silently ignored.

includeTestCasesboolean

When true, includes test/demo cases where the caller is the owner (either as collection partner or as managing partner). Defaults to false.

Implementation note: the spec sets CollectionPartnerIds = [callerPartnerId] as an AND filter. Self-managed test cases are still returned because routing isolation guarantees CollectionPartnerId == ManagedByPartnerId for cases submitted by the managing partner to themselves. TestCaseOwnerManagedByPartnerId provides the OR-leg for non-self-routed test cases.

Response

List returned

Example response

{
  "cases": [
    {
      "debtor": {
        "type": "Company",
        "name": "Pacific Trading LLC",
        "contactPerson": "John Smith",
        "companyRegistrationNumber": "47-1234567",
        "address": "123 Market Street, Suite 400",
        "zipCode": "94105",
        "city": "San Francisco",
        "state": "California",
        "stateAlpha2": "CA",
        "countryAlpha2": "US",
        "country": "United States",
        "email": "accounts@pacifictrading.com",
        "phone": "+1 415 555 0123"
      }
    }
  ]
}