The identity and technical contract details declared by the specification.
Debitura.Web.ExternalApi.Contracts.V1.Users.UserRelationDto
object
6 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.ExclusivePeriodDto
object
Full exclusive collection period chain for a case. Returned by GET /cases/{id}/exclusive-period.
5 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.TimelineActorDto
object
Represents the actor (person or system) that performed a timeline action.
2 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.PriceChangeConfirmationResponse
object
Returned with HTTP 409 when a principal edit would move the case success fee by more than the allowed threshold (0.1 percentage points), or would affect a deli…
7 properties
Debitura.Domain.Model.CommunicationCenter.Chats.ChatRole
integer
Debitura.Web.ExternalApi.Contracts.V1.Files.CaseFileDto
object
10 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.CloseCaseRequest
object
Request to close a case
2 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.ClosedByDto
object
2 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.SigningHandoffDto
object
Partner-facing handoff metadata for a creditor's pending signing chain. Returned on POST /cases responses (422 with pending-signing errors, or 200 with AllowPe…
1 property
Debitura.Web.ExternalApi.Contracts.V1.Cases.CollectionPartnerDto
object
V1 Collection Partner DTO for external partner APIs
5 properties
Debitura.Web.ExternalApi.Contracts.V1.Payments.CreatePaymentResponse
object
Response after creating a payment
13 properties
3 required
Debitura.Web.ExternalApi.Contracts.V1.Payments.PaymentRelatedInvoiceDto
object
3 properties
2 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.AssignedUserDto
object
Represents the creditor team member assigned to a case.
2 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.UpdateCaseFeesRequest
object
Request to update the fee amounts (and optionally the principal) on an active case.
6 properties
Debitura.Web.ExternalApi.Contracts.V1.Notes.CreateNoteRequest
object
Request to create a new note on a case
2 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Notes.NoteDto
object
Note details response
8 properties
3 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.CreditorDivisionDto
object
Creditor division information for external partner APIs. Represents a specific division or department within a creditor organization.
2 properties
Debitura.Web.ExternalApi.Contracts.V1.Errors.ApiErrorResponseDto
object
Generic structured error response for API endpoints. Dual-write design: existing fields (Debitura.Web.ExternalApi.Contracts.V1.Errors.ApiErrorResponseDto.Error…
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.BankAccountDto
object
Bank account information for partner API. Full details provided as partners need this to: 1. Provide payment instructions to debtors (when debtor pays client d…
16 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.InvoiceAllocationOutstandingDto
object
Additive external-API read model. Per-bucket outstanding on the debt ledger, produced by the payment allocation engine (bucket total minus Σ active stored allo…
4 properties
Debitura.Web.ExternalApi.Contracts.V1.Payments.CreatePaymentRequest
object
Request to create a payment on a case. Currency: Payment must be in the same currency as the invoice. Currency is automatically determined from the case and ca…
8 properties
3 required
Debitura.Domain.Services.CaseValidation.CaseValidationStatusDto
object
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Chats.ChatDto
object
8 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.StartCaseRequest
object
Request to activate a case from PendingVerification to Active status.
9 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.CaseTimelineResponse
object
Response envelope for GET /cases/{id}/timeline. Wraps the chronological event list with case-level context that cannot be expressed as a single timeline entry.
2 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.CloseCaseResponse
object
Response after closing a case
9 properties
3 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.BusinessErrorApiDTO
object
Represents a business error in the API response.
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Payments.UpdatePaymentRequest
object
Request to edit an existing payment on a case. Mirrors the payout-split semantics of Debitura.Web.ExternalApi.Contracts.V1.Payments.CreatePaymentRequest. Curre…
7 properties
3 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.DebtorDto
object
V1 Debtor DTO for external partner APIs. The debtor is the party that owes the debt.
13 properties
2 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.InvoiceDto
object
V1 Invoice DTO for external partner APIs
37 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.TimelineItemDto
object
5 properties
3 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.StartCaseResponse
object
Response returned when a case is successfully activated.
5 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.CreditorDto
object
Creditor (client) information for external partner APIs. Represents the party that the debtor owes money to.
11 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.UpdateCaseFeesResponse
object
Response returned when case fees (and optionally the principal) are successfully updated.
8 properties
Debitura.Web.ExternalApi.Contracts.V1.Notes.NoteCreatedByDto
object
2 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Payments.PaymentDto
object
9 properties
4 required
Debitura.Domain.Services.CaseValidation.CaseValidationItemDto
object
2 properties
Debitura.Domain.Model.Base.PageData
object
5 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.InvoiceListDto
object
2 properties
1 required
Debitura.Domain.Model.CollectionPartnerLogics.CollectionPartners.SurveyCadenceMode
integer
Debitura.Domain.Services.CaseValidation.CaseValidationLeanDto
object
1 property
Debitura.Web.ExternalApi.Contracts.V1.Chats.SendChatRequest
object
Request to send a chat message on a case.
3 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.ExclusivePeriodExtensionDto
object
A single extension event in the exclusive period chain.
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.PreviewCaseRequestApiViewModel
object
Request model for previewing case eligibility, partner assignment, and required actions before actually creating a collection case. This endpoint allows you to…
8 properties
3 required
Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadQuoteDto
object
V1 Lead Quote DTO for external customer APIs (summary view)
17 properties
4 required
Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadQuoteListDto
object
V1 Lead Quote list response for external customer APIs
1 property
1 required
Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadQuotePricingDto
object
Nested pricing details for a lead quote
6 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.RequiredActionDto
object
An action required before the case can be submitted (e.g., signing a contract).
4 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.CreateCollectionCaseRequestApiViewModel
object
20 properties
1 required
Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadDetailDto
object
V1 Lead detail DTO for external customer APIs (detailed view)
17 properties
3 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.JurisdictionDto
object
Geographic jurisdiction information for the case.
4 properties
Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadListDto
object
V1 Lead list response for external customer APIs
1 property
1 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.Requests.PreviewDebtorDto
object
Simplified debtor information for case preview. Only includes the minimum fields required for partner routing and eligibility checking.
3 properties
2 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.PreviewResultDto
object
Detailed preview result for a case submission.
9 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.PricingPreviewDto
object
Estimated pricing for the case, including age-based surcharges.
6 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.PartnerAssignmentDto
object
Information about the collection partner assigned to this case.
3 properties
Debitura.Web.ExternalApi.Contracts.V1.Tasks.TaskActionDto
object
A machine-readable hint pointing at the existing API call that resolves a task, e.g. { "method": "POST", "path": "/cases/{caseId}/chats" } for a chat-driven ta…
2 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.BusinessErrorResponseApiDTO
object
Response returned when business rule violations prevent case creation.
2 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.PreviewCaseResponseApiViewModel
object
Response from previewing a case, showing eligibility, partner assignment, required actions, and pricing estimates.
1 property
Debitura.Web.ExternalApi.Contracts.V1.Tasks.TaskDto
object
A creditor-facing action item ("task") — something the platform needs the client to do before a case can proceed (e.g. reply to a chat, sign a contract, assign…
14 properties
Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadQuoteDetailDto
object
V1 Lead Quote detail DTO for external customer APIs (detailed view)
14 properties
5 required
Debitura.Web.ExternalApi.Contracts.V1.Leads.LeadDto
object
V1 Lead DTO for external customer APIs (summary view)
15 properties
3 required
Debitura.Web.ExternalApi.Contracts.V1.Cases.CaseContractStatusApiDTO
object
Contract signing status for a case, showing SDCA and PoA status with signing URLs.
5 properties
Debitura.Web.ExternalApi.Contracts.V1.Cases.ContractItemDto
object
Status of an individual contract (SDCA, PoA, or Pricing Appendix).
3 properties
Debitura.Domain.Services.CaseValidation.CaseValidationStatusDto_2
object
Sanitized, creditor-safe projection of a case's current validation status. Safe to expose on any external surface — never contains Rationale, InternalValidatio…
3 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.ContactUser
object
A user contact associated with a creditor.
2 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.ClientContacts
object
Contact information for a client, including the original onboarding user, the company office email, and all other users linked to the creditor.
3 properties
Debitura.Domain.Services.CaseValidation.CaseValidationItemDto_2
object
A single creditor-facing action item within Debitura.Domain.Services.CaseValidation.CaseValidationStatusDto.
2 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.CasePotentialRevenue
object
Breakdown of potential revenue if the full case amount is collected. All amounts are in USD; percentages are displayed as whole numbers (e.g. 9.5 = 9.5%).
7 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.GetCasesResponse
object
Response model for listing cases linked to a referral partner
3 properties
Debitura.Domain.Model.Base.PageData_2
object
Paging metadata describing a paged result set.
5 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.CaseItem
object
A debt collection case as seen by a referral partner. Follows the same field conventions as InvoiceDto (ExternalApi.Contracts) but scoped to what referral part…
18 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.CasesSummary
object
3 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.LifecycleBreakdown
object
4 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.CaseClientInfo
object
Client (creditor) info with referral-partner-specific ExternalTenantId.
4 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.CaseDebtorInfo
object
Debtor info for the case.
2 properties
Debitura.Web.ReferralPartnerApi.Models.Cases.GetCaseDetailResponse
object
Response model for retrieving a single case with potential revenue breakdown. Extends CaseItem fields with revenue data for referral partners.
19 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Debitura publishes across the network.