Skip to main content
PUT
Replace enforceable title

Authorizations

Authorization
string
header
required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company
string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

If-Match
string

Apply the change only while the current ETag matches one of the supplied validators (or *); otherwise the request fails with 412 precondition_failed and nothing is written.

Path Parameters

claim_id
string<uuid>
required

UUID of the parent claim in this request.

Body

application/json

Replace the title metadata. Supply at least one title field. Omitted metadata fields and amount are cleared. Use PATCH to preserve fields you do not send.

title_type
enum<string> | null
required

Legal title category: enforcement_order = Vollstreckungsbescheid; default_judgment = Versäumnisurteil; final_judgment = Endurteil; acknowledgment_judgment = Anerkenntnisurteil; reservation_judgment = Vorbehaltsurteil; court_settlement = Gerichtlicher Vergleich; enforceable_notarial_deed = Vollstreckbare notarielle Urkunde; cost_assessment_order = Kostenfestsetzungsbeschluss; other = Sonstiger Titel. Required before finalization.

Available options:
enforcement_order,
default_judgment,
final_judgment,
acknowledgment_judgment,
reservation_judgment,
court_settlement,
enforceable_notarial_deed,
cost_assessment_order,
other
amount
object | null

Gross amount confirmed by the client and owned by the enforceable title. May be absent or null while drafting; must be positive before finalization.

file_number
string | null

Official file or reference number shown on the title. Required before finalization.

Maximum string length: 255
issued_on
string<date> | null

Date on which the enforceable title was issued. Required before finalization.

issuing_authority
string | null

Court, notary, or other authority that issued the title. Required before finalization.

Maximum string length: 255
legally_binding_since
string<date> | null

Optional date from which the title is legally binding; it cannot precede issued_on.

served_on
string<date> | null

Optional date on which the title was served; it cannot precede issued_on.

Response

amount
object | null
required

Gross amount confirmed by the client and owned by the enforceable title.

created_at
string<date-time>
required
read-only

Time at which the enforceable title was created.

documents
object[]
required
read-only

Documents owned by the title; one primary enforceable-title document is required before finalization.

file_number
string
required
read-only

Official file or reference number shown on the title.

id
string<uuid>
required
read-only

Stable identifier of the enforceable title.

issued_on
string<date> | null
required
read-only

Date on which the enforceable title was issued.

issuing_authority
string
required
read-only

Court, notary, or other authority that issued the title.

legally_binding_since
string<date> | null
required
read-only

Optional date from which the title is legally binding; it cannot precede issued_on.

served_on
string<date> | null
required
read-only

Optional date on which the title was served; it cannot precede issued_on.

title_type
enum<string> | null
required

Legal title category: enforcement_order = Vollstreckungsbescheid; default_judgment = Versäumnisurteil; final_judgment = Endurteil; acknowledgment_judgment = Anerkenntnisurteil; reservation_judgment = Vorbehaltsurteil; court_settlement = Gerichtlicher Vergleich; enforceable_notarial_deed = Vollstreckbare notarielle Urkunde; cost_assessment_order = Kostenfestsetzungsbeschluss; other = Sonstiger Titel.

Available options:
enforcement_order,
default_judgment,
final_judgment,
acknowledgment_judgment,
reservation_judgment,
court_settlement,
enforceable_notarial_deed,
cost_assessment_order,
other
updated_at
string<date-time>
required
read-only

Time at which the enforceable title last changed.