Agreement

Extends

Entity

An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.

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

No

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

name

No

No

String

A human-readable name for the agreement

default null;

contract no. 42

engagedParty

No

No

array of PartyOrPartyRole

Engaged party

default null;

[]

relatedParty

No

No

array of RelatedPartyOrPartyRole

Related party

default null;

[]

businessId

No

No

String

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

default null;

1234

agreementType

Yes

No

String

Type of the agreement (e.g. witaContract, ServiceContractCustomer, ServiceContractOrderer, SingleContract, PreAgreement, witaContract,…​)

default null;

ServiceContractOrderer