DEdebitura
Cases

Get case detail with potential revenue breakdown

Changed on

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}

Request

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

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 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.

Changes

  • cf12c7f270d9Revision changes
    • 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)