v1

latestOpenAPI 3.0.42026-08-045381279.6 KB

Cases

Fetch case by reference

Returns case details for the provided Debitura case reference (example: Q8OAXF3W).

get/cases/case-reference/{caseReference}

Path parameters

caseReferencestring required

Response

Case found

idstring uuid

dateCreatedstring date-time

dateUpdatedstring date-time nullable

referencestring nullable

creditorReferencestring nullable

creditorCommentsstring nullable

claimDescriptionstring nullable

grossAmountnumber double

remaindernumber double

interestFeesnumber double

reminderFeesnumber double

collectionFeesnumber double

totalAddedFeesnumber double

currencystring nullable

isTestCaseboolean

lifecyclestring nullable

dueDatestring date-time

datestring date-time

dateFinishedstring date-time nullable

dateCollectionStartedstring date-time nullable

closeCodestring nullable

currentEngagementPhasestring nullable

The current phase of the case's engagement: "Pre-legal", "Legal", or "Enforcement". A different axis from Debitura.Web.ExternalApi.Contracts.V1.Cases.InvoiceDto.Lifecycle/Debitura.Web.ExternalApi.Contracts.V1.Cases.InvoiceDto.CloseCode — an Active case can be in any of the three phases.

Null means "no active engagement" (e.g. lead / quoting / pre-contract-signing / unassigned, or a data-consistency gap) — this is a distinct third state, NOT a synonym for Pre-legal. Most cases legitimately read Pre-legal; phase only leaves Pre-legal on legal/enforcement quote flows.

Not guaranteed to be monotonic: an admin correction can move phase backwards (e.g. Legal back to Pre-legal).

Persists after case closure — reflects the case's last-known engagement phase, not the current Lifecycle. Note: this is a different field from a lead quote's own offered phase (the phase a partner's quote proposes to work the case at, if this case ever went through a quote flow) — this field is the case-level phase of its actual engagement, not a quote's terms.

claimTypestring nullable

The type of claim for this case (e.g. "Unpaid Invoice", "Loan Repayment", "Breach of Contract"). Null if not set.

creditorDivisionIdstring uuid nullable

blendedAgeUpliftPointsnumber double nullable

MULTI-INVOICE AGE BUCKET PRICING Calculated blended age uplift percentage points (0-20) for multi-invoice cases. Shows the additional fee percentage added due to invoice age. Formula: ((A12-A24)×10 + A24×20) / Total Principal Null for single-invoice cases (age uplift is calculated from due date instead).

preLegalSuccessFeenumber double nullable

PRE-LEGAL SUCCESS FEE The total pre-legal success fee percentage for this case. Includes base fee + age-based uplift (blended or single-invoice). Null if pricing has not been calculated yet or if case is not in pre-legal phase. Example: 20.5 represents 20.5% success fee.

solutionUrlstring nullable

When the case is created with allowPendingContracts=true and required contracts are unsigned, this URL points to the signing page. Null when contracts are already signed or not applicable.

exclusivePeriodEndDatestring date-time nullable

The date the exclusive collection period ends (or ended). Null if no collection period has been created for this case (e.g. custom-terms cases). Use GET /cases/{id}/exclusive-period for the full chain including extensions.

disputeStatusstring nullable

Whether the claim is disputed by the debtor. Returns the description of Debitura.Domain.Model.Receiveables.Invoices.Enums.ClaimDisputeStatus: "Yes, the claim is disputed", "No, the claim is not disputed", or "Don't Know". Null when the dispute status has not been set on the case.

Example response

{
  "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"
  }
}