latestOpenAPI 3.0.42026-08-132282233.5 KB

8d237e9c6592

Cases

Get case detail with potential revenue breakdown

Retrieves a single case with all standard fields plus a potential revenue breakdown showing what the referral partner would earn if the full amount is collected.

get/cases/{id}

Path parameters

idstring uuid required

Response

Case retrieved successfully

idstring uuid

referencestring nullable

creditorReferencestring nullable

grossAmountnumber double

remaindernumber double

currencystring nullable

lifecyclestring nullable

closeCodestring nullable

currentEngagementPhasestring nullable

The current phase of the case's engagement: "Pre-legal", "Legal", or "Enforcement". Null means no active engagement — see Debitura.Web.ReferralPartnerApi.Models.Cases.CaseItem.CurrentEngagementPhase for full semantics (not monotonic, persists after case closure).

dateCreatedstring date-time

dueDatestring date-time

dateCollectionStartedstring date-time nullable

dateFinishedstring date-time nullable

collectionPartnerstring nullable

Display name of the collection partner handling this case (e.g. "Oriel Collections"). Null if no collection partner has been assigned yet.

expectedReferralRatePercentagenumber double nullable

The expected referral fee rate as a percentage (e.g. 70.0 = 70%). Uses the per-assignment override when set, otherwise the referral link's snapshotted rate (frozen at link creation time). Null when no collection partner has been assigned yet.