Skip to content

Agreement

Agreement

Data type: 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.

Name Type Description Example
@type (1) string When sub-classing, this defines the sub-class Extensible name
agreementType (1) string Type of the agreement (e.g. witaContract, ServiceContractCustomer, ServiceContractOrderer, SingleContract, PreAgreement, witaContract,...) ServiceContractOrderer
@baseType string When sub-classing, this defines the super-class
@schemaLocation string A URI to a JSON-Schema file that defines additional attributes and relationships
id string Unique identifier 2d7ed5fd-9f62-4211-bc84-357f5f7b80f5
href URI Hyperlink reference https://api.example.org/resource/id
name string A human-readable name for the agreement contract no. 42
engagedParty PartyOrPartyRole [n..m] Engaged party []
relatedParty RelatedPartyOrPartyRole [n..m] Related party []
businessId string A business relevant identifier when different from the technical identifier documented with the .id property 1234