PartyOrPartyRole

One of: Individual, Organization, PartyRef, PartyRole, PartyRoleRef

A Party or PartyRole or Ref

Field Required Nullable Type Description Constraints Example

Field	Required	Nullable	Type	Description	Constraints	Example
`@type`	Yes	No	`String`	When sub-classing, this defines the sub-class Extensible name	default `null`;
`@baseType`	No	No	`String`	When sub-classing, this defines the super-class	default `null`;
`@schemaLocation`	No	No	`String`	A URI to a JSON-Schema file that defines additional attributes and relationships	default `null`;
`id`	Yes	No	`String`	Unique identifier	default `null`;	2d7ed5fd-9f62-4211-bc84-357f5f7b80f5
`href`	No	No	`URI`	Hyperlink reference	default `null`;	https://api.example.org/resource/id
`contactMedium`	No	No	`array` of ContactMedium	Contact medium	default `null`;	[]
`externalReference`	No	No	`array` of ExternalIdentifier	List of identifiers of the Party in an external system, for example when party information is imported from a commerce system	default `null`;	[]
`businessId`	No	No	`String`	A business relevant identifier when different from the technical identifier documented with the .id property	default `null`;	1234
`partyCharacteristic`	No	No	`array` of Characteristic	List of additional characteristics that a Party can take on.	default `null`;	[]
`familyName`	No	No	`String`	Contains the non-chosen or inherited name. Also known as last name in the Western context	default `null`;	Muster
`salutation`	No	No	`String`	Standard wording used to address an individual	default `null`;	Ms
`givenName`	No	No	`String`	First name of the individual	default `null`;	Melanie
`title`	No	No	`String`	Useful for titles (aristocratic, social,…) Pr, Dr, Sir, …	default `null`;	Dr.
`name`	Yes	No	`String`	A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles. It’s the name of the PartyRole unique entity.	default `null`;	PartyRoleName
`@referredType`	No	No	`String`	The actual type of the target instance when needed for disambiguation.	default `null`;
`description`	No	No	`String`	A description of the PartyRole.	default `null`;	Lorem ipsum dolor
`role`	No	No	`String`	Role played by the engagedParty in this context. As role is defined by partyRoleSpecification, this role attribute can be used to precise the role defined by partyRoleSpecification, or it can be used to define the role in case there is no partyRoleSpecification.	default `null`;
`engagedParty`	Yes	No	PartyRef		default `null`;
`characteristic`	No	No	`array` of Characteristic	Describes the characteristic of a party role.	default `null`;	[]
`account`	No	No	`array` of AccountRef	Account	default `null`;	[]
`agreement`	No	No	`array` of AgreementRef	Agreement	default `null`;	[]
`relatedParty`	No	No	`array` of RelatedPartyOrPartyRole	Related party	default `null`;	[]
`status`	No	No	`String`	Used to track the lifecycle status of the party role.	default `null`;
`statusReason`	No	No	`String`	A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection.	default `null`;
`validFor`	No	No	TimePeriod		default `null`;

@type

Yes

String

When sub-classing, this defines the sub-class Extensible name

default null;

@baseType

String

When sub-classing, this defines the super-class

default null;

@schemaLocation

String

A URI to a JSON-Schema file that defines additional attributes and relationships

default null;

id

Yes

String

Unique identifier

default null;

2d7ed5fd-9f62-4211-bc84-357f5f7b80f5

href

URI

Hyperlink reference

default null;

https://api.example.org/resource/id

contactMedium

array of ContactMedium

Contact medium

default null;

[]

externalReference

array of ExternalIdentifier

List of identifiers of the Party in an external system, for example when party information is imported from a commerce system

default null;

[]

businessId

String

A business relevant identifier when different from the technical identifier documented with the .id property

default null;

1234

partyCharacteristic

array of Characteristic

List of additional characteristics that a Party can take on.

default null;

[]

familyName

String

Contains the non-chosen or inherited name. Also known as last name in the Western context

default null;

Muster

salutation

String

Standard wording used to address an individual

default null;

givenName

String

First name of the individual

default null;

Melanie

title

String

Useful for titles (aristocratic, social,…) Pr, Dr, Sir, …

default null;

Dr.

name

Yes

String

A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles. It’s the name of the PartyRole unique entity.

default null;

PartyRoleName

@referredType

String

The actual type of the target instance when needed for disambiguation.

default null;

description

String

A description of the PartyRole.

default null;

Lorem ipsum dolor

role

String

Role played by the engagedParty in this context. As role is defined by partyRoleSpecification, this role attribute can be used to precise the role defined by partyRoleSpecification, or it can be used to define the role in case there is no partyRoleSpecification.

default null;

engagedParty

Yes

PartyRef

default null;

characteristic

array of Characteristic

Describes the characteristic of a party role.

default null;

[]

account

array of AccountRef

Account

default null;

[]

agreement

array of AgreementRef

Agreement

default null;

[]

relatedParty

array of RelatedPartyOrPartyRole

Related party

default null;

[]

status

String

Used to track the lifecycle status of the party role.

default null;

statusReason

String

A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection.

default null;

validFor

TimePeriod

default null;