Contract Template

Description

Properties

Property Description
bodyHtml

The HTML body of the contract template.

brandTheme read-only

A brand theme.

brandThemeId

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

created read-only

The creation date of this contract template.

id

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

languageCode

The Unicode CLDR language tag for the language used in this contract template.

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

name

The name for this contract template.

type

The type of resource represented.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "properties": {
    "bodyHtml": {
      "description": "The HTML body of the contract template.",
      "type": "string"
    },
    "brandTheme": {
      "allOf": [
        {
          "readOnly": true
        },
        {
          "$ref": "#/components/schemas/BrandTheme"
        }
      ]
    },
    "brandThemeId": {
      "$ref": "#/components/schemas/Id"
    },
    "created": {
      "description": "The creation date of this contract template.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "languageCode": {
      "description": "The Unicode CLDR language tag for the language used in this\ncontract template.",
      "example": "en_US",
      "type": "string"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The name for this contract template.",
      "type": "string"
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Type"
        },
        {
          "enum": [
            "contract-template"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "name",
    "brandThemeId",
    "bodyHtml",
    "languageCode"
  ],
  "title": "Contract Template",
  "type": "object"
}