Adds an estate item to a case

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params
string
enum
Allowed:
double | double | null
required
-100000000 to 100000000
^-?(?:0|[1-9]\d*)(?:\.\d+)?$
double | double | null
required
-100000000 to 100000000
^-?(?:0|[1-9]\d*)(?:\.\d+)?$
double | double | null
required
0 to 100000000
^-?(?:0|[1-9]\d*)(?:\.\d+)?$
double | double | null
required
0 to 100000000
^-?(?:0|[1-9]\d*)(?:\.\d+)?$
address
object
required
string | null
required
^[0-9]{2}-?[0-9]{2}-?[0-9]{2}$
string | null
required
^.*[0-9]$
string | null
required
string | null
required
string | null
required
realisation
object
required

A realisation of an estate item's proceeds (the money received when the asset was sold or closed).

Where the proceeds went is identified by Guid? EstateItemRealisationResourceRepresentation.CaseItemId. On read it is always populated
when the proceeds went to an estate item: it is the id of that destination estate item — a bank
account, cash ISA, cash savings account, and so on — and the special Client Cash Account is
represented by the fixed sentinel id 7F05AD59-A20F-4FAD-9716-2011E72774E2. When the proceeds
went to a free-text destination instead, string? EstateItemRealisationResourceRepresentation.OtherDestination holds that text and
Guid? EstateItemRealisationResourceRepresentation.CaseItemId is null.

Historically the destination was carried by the RealisationDestination? EstateItemRealisationResourceRepresentation.Destination enum and a Client Cash
Account realisation stored no CaseItemId. That enum is retained for backwards compatibility
but is being retired in favour of Guid? EstateItemRealisationResourceRepresentation.CaseItemId, so consumers should prefer
Guid? EstateItemRealisationResourceRepresentation.CaseItemId and derive the destination's type from the estate item it points at.

double | double
required
0 to 1
^-?(?:0|[1-9]\d*)(?:\.\d+)?$
boolean | null
required
string | null
required
jointOwnerIds
array of uuids | null
required
jointOwnerIds*
enum
required
Allowed:
string | null
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
Credentials
OAuth2
Required Scopes
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain
text/json