Contract Collection

Description

A collection (or list) of resources.

Properties

Property Description
items

A collection of resources returned in the current result set.

Property Description
bodyContainsMagicBlank read-only

Indicates if the HTML body of the contract contains one or more magic blank placeholder strings.

contactId

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

contactName

The full name of the contact associated with this contract.

contractStatus

The current status of the contract.

Status Description
draft The contract is a draft and has not been sent to the client.
awaiting-client-signature The contract has been sent to the client and is awaiting their signature.
awaiting-studio-countersign The client has signed the contract, and it is ready for the studio to countersign.
completed The client and studio have both signed the contract.
canceled The studio has canceled the contract.
expired The expiration date specified on the contract has passed while the contract was in the draft or awaiting-client-signature states.
created

The creation date of this contract.

expirationDate

The date on which this contract expires.

id

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

invoices

An array of linked invoices.

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.

publicId

The public identifier for this contract (may be used in the portal website).

type

The type of resource represented.

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.

meta read-only

Metadata describing the current result set.

Property Description
currentPage

The current page of results returned.

rows

The number of rows returned per page for the current result set.

totalItems

The total number of items in the result set. This may be affected by active search/filter parameters.

totalPages

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).

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.

{
  "description": "A collection (or list) of resources.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "properties": {
          "bodyContainsMagicBlank": {
            "description": "Indicates if the HTML body of the contract contains one or more\n*magic blank* placeholder strings.",
            "readOnly": true,
            "type": "boolean"
          },
          "contactId": {
            "$ref": "#/components/schemas/Id"
          },
          "contactName": {
            "description": "The full name of the contact associated with this contract.",
            "type": "string"
          },
          "contractStatus": {
            "$ref": "#/components/schemas/Contract/properties/contractStatus"
          },
          "created": {
            "description": "The creation date of this contract.",
            "format": "date-time",
            "type": "string"
          },
          "expirationDate": {
            "description": "The date on which this contract expires.",
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "$ref": "#/components/schemas/Id"
          },
          "invoices": {
            "description": "An array of linked invoices.",
            "items": {
              "$ref": "#/components/schemas/InvoiceMinimal"
            },
            "title": "Invoice",
            "type": "array"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "name": {
            "description": "The name for this contract.",
            "type": "string"
          },
          "publicId": {
            "description": "The public identifier for this contract (may be used in the portal\nwebsite).",
            "pattern": "^[a-fA-F0-9]{32}$",
            "type": "string"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Type"
              },
              {
                "enum": [
                  "contract"
                ]
              }
            ]
          }
        },
        "title": "Contract",
        "type": "object"
      },
      "title": "Contract",
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The type of resource represented.",
      "enum": [
        "contract-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection of Contracts",
  "type": "object"
}