Contract Template

Description

contract-template
Contract Template

Properties

Property Description
bodyHtml
string

The HTML body of the contract template.
brandTheme read-only
brand-theme
Brand Theme

A brand theme.

Property Description
colorScheme
string
enum
  • dark
  • light

The color scheme for this brand theme.

ShootProof Identifier Description
dark A "dark" color scheme should be used when displaying this brand theme.
light A "light" color scheme should be used when displaying this brand theme.
created read-only
string
date-time
Signature

The date on which the entity was created.
emailBrandLogo nullable
brand-logo
Brand Logo

The brand logo for use in email messages (and any other place using a white/neutral background such as contracts and invoices).
eventBrandLogo nullable
brand-logo
Brand Logo

The brand logo for use in event presentation.
fontSet
string
enum
  • brandon
  • freeland
  • baskerville
  • blooming-elegant
  • bambusa-pro-regular
  • scandiebox-one

The font set for this brand theme.

ShootProof Identifier Primary Font Name Secondary Font Name Body Font Name
brandon Brandon Brandon Baskerville
freeland ProximaNova Freeland ProximaNova
baskerville Baskerville Baskerville OpenSans-Regular
blooming-elegant BloomingElegant-Regular BloomingElegant-Regular Brandon
bambusa-pro-regular BambusaPro-Regular BambusaPro-Regular OpenSans-Regular
scandiebox-one SBOne SBOne OpenSans-Regular
id
integer

The identifier of this brand theme.
links required read-only
object
Links

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
string

The name of this brand theme.
primaryColor
string

The primary hex color code for this brand theme.
secondaryColor
string

The secondary hex color code for this brand theme.
type
string
enum
  • brand-theme

The type of object represented.
brandThemeId
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
created read-only
string
date-time

The creation date of this contract template.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

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

The Unicode CLDR language tag for the language used in this contract template.
links required read-only
object
Links

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
string

The name for this contract template.
type
string
enum
  • 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"
}
Contract Template