Contract

Description

contract
Contract

Properties

Property Description
activity read-only
object[]
Contract Activity

A list of activities that have occurred with this contract.
bodyContainsMagicBlank read-only
boolean

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

The HTML body of the contract.
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.
cancelationMessage nullable
string

Optional cancelation message to include in studio-to-client email sent when contract status moves to canceled state. As of this writing, value only used on PATCH requests.
contactIds write-only
[]
unique
Id

An array of unique contact ids to link to contract
contacts required read-only
contact-collection
Contact Collection Minimal

A collection of contacts associated with this contract

Property Description
items
contact[]
Contact Minimal

A collection of resources returned in the current result set.
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.
meta read-only
object

Metadata describing the current result set.
type
string
enum
  • contact-collection
Type

The type of resource represented.
contractStatus
string
enum
  • draft
  • awaiting-client-signature
  • awaiting-studio-countersign
  • completed
  • canceled
  • expired
Contract Status

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.
contractTemplate required read-only
contract-template
Contract Template
Property Description
bodyHtml
string

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

A brand theme.
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.
contractTemplateId nullable
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.
expirationDate
string
date-time

The date on which this contract expires.
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.
invoices read-only
invoice[]
Invoice Minimal

An array of linked invoices.
isEditable
boolean

Whether the contract is able to be edited.
isHidden
boolean

Whether the contract has been marked 'hidden'.
languageCode
string

The Unicode CLDR language tag for the language used in this contract.
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.

Property Description
alternate
either
object
Single Link
or
object[]
Link

The target URL is an alternate representation of the current resource. Usually, this will include a type property to indicate the media type of the alternate representation.
brand
either
object
Single Link
or
object[]
Link

The target URL is a brand or collection of brands related to the current resource.
brand-context deprecated
either
object
Single Link
or
object[]
Link

The target URL indicates the brand authorized for the current context, based on the access token.

This relationship is deprecated and should not be relied on. Access tokens obtained through the OAuth flow are not tied to a specific brand.
brand-homepage
either
object
Single Link
or
object[]
Link

The target URL is the brand homepage API endpoint related to the current resource.
brand-theme
either
object
Single Link
or
object[]
Link

The target URL is a brand theme or collection of brand themes related to the current resource.
canonical
either
object
Single Link
or
object[]
Link

The target URL is the primary location of the current resource (i.e. the current resource may be subordinate to another resource, and the target URL indicates its permanent location).
children
either
object
Single Link
or
object[]
Link

The target URL is a collection of resources that is subordinate to the current resource. That is, the current resource is a parent of the children, and the children belong to this resource.
client
either
object
Single Link
or
object[]
Link

The target URL is the location of the current resource in the Client Galleries website. The media type of the target URL is assumed to be text/html unless otherwise indicated.
client-admin
either
object
Single Link
or
object[]
Link

The target URL is the location of the studio client admin for the current resource in the Client Galleries website. The media type of the target URL is assumed to be text/html unless otherwise indicated.
collection
either
object
Single Link
or
object[]
Link

The target URL is the location of a collection of similar resources of which the current resource is a member.
contact
either
object
Single Link
or
object[]
Link

The target URL is a contact or collection of contacts related to the current resource.
contact-referee
either
object
Single Link
or
object[]
Link

The target URL is a list of available contacts that may be selected as referred by the current resource.
contact-referred-by
either
object
Single Link
or
object[]
Link

The target URL is a list of available contacts that may be selected as having referred the current resource.
contact-tag
either
object
Single Link
or
object[]
Link

The target URL is a list of contact tags available to apply to the current resource.
contract
either
object
Single Link
or
object[]
Link

The target URL is a contract or collection of contracts related to the current resource.
contract-signature
either
object
Single Link
or
object[]
Link

The target URL is a contract signature or collection of contract signatures related to the current resource.
contract-template
either
object
Single Link
or
object[]
Link

The target URL is a contract template or collection of contract templates related to the current resource.
derivedfrom
either
object
Single Link
or
object[]
Link

The target URL is the location of a resource from which the current resource is derived (or a subset of).
email
either
object
Single Link
or
object[]
Link

The target URL may be an email message or collection of email messages related to the current resource. It may also be used to create an email message related to the current resource.
email-automation-group
either
object
Single Link
or
object[]
Link

The target URL is an email automation group or collection of email automation groups related to the current resource.
email-template
either
object
Single Link
or
object[]
Link

The target URL is an email template or collection of email templates related to the current resource.
email-template-type
either
object
Single Link
or
object[]
Link

The target URL is an email template type or collection of email template types related to the current resource.
event
either
object
Single Link
or
object[]
Link

The target URL is an event or collection of events related to the current resource.
event-album
either
object
Single Link
or
object[]
Link

The target URL is an event album or collection of event albums related to the current resource.
event-album-passwords
either
object
Single Link
or
object[]
Link

The target URL is a listing of all passwords for all event albums related to the current resource. If the type indicates a different format (i.e. text/csv), then the URL is a link to a downloadable version of the target resource.
event-album-photo
either
object
Single Link
or
object[]
Link

The target URL is an event album photo or collection of event album photos related to the current resource.
event-archive-cost
either
object
Single Link
or
object[]
Link

The target URL is an event archive cost related to the current resource.
event-category
either
object
Single Link
or
object[]
Link

The target URL is an event category or collection of event categories related to the current resource.
event-contact
either
object
Single Link
or
object[]
Link

The target URL is an event contact or collection of event contacts related to the current resource.
event-contact-photo-favorite
either
object
Single Link
or
object[]
Link

The target URL is a photo or collection of photos related to the current resource and favorited by the context event contact.
event-contact-photo-hidden
either
object
Single Link
or
object[]
Link

The target URL is a photo or collection of photos related to the current resource and hidden by the context event contact.
event-contact-photo-share
either
object
Single Link
or
object[]
Link

The target URL is a photo or collection of photos related to the current resource and shared by the context event contact.
event-contact-photo-tag
either
object
Single Link
or
object[]
Link

The target URL is a photo or collection of photos related to the current resource and tagged by the context event contact.

When templated is true, this is a templated URL. The template parameter filterPhotoTag may be used with the tag name or a comma-separated list of tag names to filter tagged photo results.
event-defaults
either
object
Single Link
or
object[]
Link

The target URL is a set of event defaults settings or collection of more than one set of event defaults settings related to the current resource.
event-photo
either
object
Single Link
or
object[]
Link

The target URL is an event photo or collection of event photos related to the current resource.
event-photo-original
either
object
Single Link
or
object[]
Link

The target URL is the original uploaded photo related to the current resource.
event-photo-upload-policy
either
object
Single Link
or
object[]
Link

The target URL may be used to generate an event photo upload policy related to the current resource. This is the first step in the process to upload new event photos to an event resource.
event-visitor
either
object
Single Link
or
object[]
Link

The target URL is an event visitor or collection of event visitors related to the current resource.
invoice
either
object
Single Link
or
object[]
Link

The target URL is an invoice or collection of invoices related to the current resource.
invoice-credit-card
either
object
Single Link
or
object[]
Link

The target URL may be used to manipulate the invoice credit card related to the current resource. The current resource may be an invoice or may have an invoice related to it, for which the target URL may be used.
invoice-item-template
either
object
Single Link
or
object[]
Link

The target URL is an invoice item template or collection of invoice item templates related to the current resource.
invoice-payment
either
object
Single Link
or
object[]
Link

The target URL may be used to make an invoice payment related to the current resource. The current resource may be an invoice or may have an invoice related to it, for which the target URL may be used.
invoice-refund
either
object
Single Link
or
object[]
Link

The target URL may be used to make an invoice refund related to the current resource. The current resource may be an invoice or may have an invoice related to it, for which the target URL may be used.
invoice-template
either
object
Single Link
or
object[]
Link

The target URL is an invoice template or collection of invoice templates related to the current resource.
lab
either
object
Single Link
or
object[]
Link

The target URL is a lab related to the current resource.
lab-catalog
either
object
Single Link
or
object[]
Link

The target URL is a lab catalog or collection of lab catalogs related to the current resource.
lab-catalog-self-fulfilled
either
object
Single Link
or
object[]
Link

The target URL is a self-fulfilled lab catalog or collection of self-fulfilled lab catalogs related to the current resource.
lab-catalog-shipping-option
either
object
Single Link
or
object[]
Link

The target URL is a lab catalog shipping option or collection of lab catalog shipping options related to the current resource.
market-department
either
object
Single Link
or
object[]
Link

The target URL is a market department or collection of market departments related to the current resource.
market-product
either
object
Single Link
or
object[]
Link

The target URL is a market product or collection of market products related to the current resource.
market-vendor
either
object
Single Link
or
object[]
Link

The target URL is a market vendor or collection of market vendors related to the current resource.
me
either
object
Single Link
or
object[]
Link

The target URL is the profile for the authenticated access token.

Usually this is the Studio Panel user who has granted authorization and an access token.
mobile-app
either
object
Single Link
or
object[]
Link

The target URL is a mobile app or collection of mobile apps related to the current resource.
order
either
object
Single Link
or
object[]
Link

The target URL is an order or collection of orders related to the current resource.
order-payment
either
object
Single Link
or
object[]
Link

The target URL is an order payment or collection of order payments related to the current resource.
parent
either
object
Single Link
or
object[]
Link

The target URL identifies a parent resource for the current resource. It is often used on subordinate resources or collections to identify the resource to which they belong.
playlist
either
object
Single Link
or
object[]
Link

The target URL is a music playlist or collection of music playlists related to the current resource.
portal
either
object
Single Link
or
object[]
Link

The target URL is the location of the current resource in the Studio-Client Portal website. The media type of the target URL is assumed to be text/html unless otherwise indicated.
price-sheet
either
object
Single Link
or
object[]
Link

The target URL is a price sheet or collection of price sheets related to the current resource.
price-sheet-discount
either
object
Single Link
or
object[]
Link

The target URL is a price sheet discount or collection of price sheet discounts related to the current resource.
price-sheet-event
either
object
Single Link
or
object[]
Link

The target URL is an event associated to a price sheet or a collection of events associated to a price sheet related to the current resource.
price-sheet-item
either
object
Single Link
or
object[]
Link

The target URL is a collection of price sheet items related to the current resource.
price-sheet-item-image
either
object
Single Link
or
object[]
Link

The target URL is a collection of images associated to a price sheet item related to the current resource.
price-sheet-shipping-option
either
object
Single Link
or
object[]
Link

The target URL is a price sheet shipping option or collection of price sheet shipping options related to the current resource.
search
either
object
Single Link
or
object[]
Link

The target URL is a location that may be used to search or filter results for the current resource.
self
either
object
Single Link
or
object[]
Link

The target URL is the current resource's own location. It may not be the canonical location of the resource; if this is the case, the canonical relationship might be present to indicate the resource's canonical URL.
shorturl
either
object
Single Link
or
object[]
Link

The target URL may be used to create a shortened URL for use with social sharing.
signature
either
object
Single Link
or
object[]
Link

The target URL is a signature or collection of signatures related to the current resource.
token-replacement
either
object
Single Link
or
object[]
Link

The target URL may be used to replace tokens in the current resource. Tokens available to pass for replacement are indicated by the URI template parameters.
user-mfa
either
object
Single Link
or
object[]
Link

The target URL is a user's MFA configuration or collection of a user's MFA configurations related to the current resource. Tokens available to pass for replacement are indicated by the URI template parameters.
user-mfa-code
either
object
Single Link
or
object[]
Link

The target URL is a user's MFA code or collection of a user's MFA codes related to the current resource.
user-mfa-verification
either
object
Single Link
or
object[]
Link

The target URL is a user's MFA verification or collection of a user's MFA verifications related to the current resource.
volume-sort
either
object
Single Link
or
object[]
Link

The target URL is the status of the volume photography related sorting of the current resource.
watermark
either
object
Single Link
or
object[]
Link

The target URL is a watermark or collection of watermarks related to the current resource.
name
string

The name for this contract.
publicId read-only
string
  • ^[a-fA-F0-9]{32}$

The public identifier for this contract (may be used in the portal website).
shootDate nullable
string
date-time

This contract covers a photo shoot or event that took place on this date.
signatureClient nullable read-only
contract-signature
Contract Signature

The contract signature for the client.

Property Description
created read-only
string
date-time
Signature

The date on which the entity was created.
ipAddress
string
ipv4

The IP address of the user agent recording the signature.
publicId
string
  • ^[a-fA-F0-9]{32}$

The public identifier for this contract signature. This is used on all public screens and printable views of the contract as a transaction identifier.
signature
signature
Signature

A signature.
signatureType
string
enum
  • studio
  • client

The type of signature.

Status Description
studio The signature was created by the studio.
client The signature was created by the client.
type
string
enum
  • contract-signature
Type

The type of resource represented.
userAgent
string

The full user agent identifier string of the user agent recording the signature.
signatureStudio nullable read-only
contract-signature
Contract Signature

The contract signature for the studio.

Property Description
created read-only
string
date-time
Signature

The date on which the entity was created.
ipAddress
string
ipv4

The IP address of the user agent recording the signature.
publicId
string
  • ^[a-fA-F0-9]{32}$

The public identifier for this contract signature. This is used on all public screens and printable views of the contract as a transaction identifier.
signature
signature
Signature

A signature.
signatureType
string
enum
  • studio
  • client

The type of signature.

Status Description
studio The signature was created by the studio.
client The signature was created by the client.
type
string
enum
  • contract-signature
Type

The type of resource represented.
userAgent
string

The full user agent identifier string of the user agent recording the signature.
type
string
enum
  • contract
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": {
    "activity": {
      "description": "A list of activities that have occurred with this contract.",
      "items": {
        "$ref": "#/components/schemas/ContractActivity"
      },
      "readOnly": true,
      "title": "Contract Activity",
      "type": "array"
    },
    "bodyContainsMagicBlank": {
      "description": "Indicates if the HTML body of the contract contains one or more\n'magic blank' placeholder strings.",
      "readOnly": true,
      "type": "boolean"
    },
    "bodyHtml": {
      "description": "The HTML body of the contract.",
      "type": "string"
    },
    "brandTheme": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BrandTheme"
        },
        {
          "readOnly": true
        }
      ]
    },
    "brandThemeId": {
      "$ref": "#/components/schemas/Id"
    },
    "cancelationMessage": {
      "description": "Optional cancelation message to include in studio-to-client email\nsent when contract status moves to canceled state. As of this\nwriting, value only used on `PATCH` requests.",
      "nullable": true,
      "type": "string"
    },
    "contactIds": {
      "description": "An array of unique contact ids to link to contract",
      "items": {
        "$ref": "#/components/schemas/Id"
      },
      "type": "array",
      "uniqueItems": true,
      "writeOnly": true
    },
    "contacts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ContactCollectionMinimal"
        },
        {
          "description": "A collection of contacts associated with this contract",
          "readOnly": true
        }
      ]
    },
    "contractStatus": {
      "description": "The current status of the contract.\n\n| Status | Description |\n| ------ | ----------- |\n| `draft` | The contract is a draft and has not been sent to the client. |\n| `awaiting-client-signature` | The contract has been sent to the client and is awaiting their signature. |\n| `awaiting-studio-countersign` | The client has signed the contract, and it is ready for the studio to countersign. |\n| `completed` | The client and studio have both signed the contract. |\n| `canceled` | The studio has canceled the contract. |\n| `expired` | The expiration date specified on the contract has passed while the contract was in the `draft` or `awaiting-client-signature` states. |",
      "enum": [
        "draft",
        "awaiting-client-signature",
        "awaiting-studio-countersign",
        "completed",
        "canceled",
        "expired"
      ],
      "title": "Contract Status",
      "type": "string"
    },
    "contractTemplate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ContractTemplate"
        },
        {
          "readOnly": true
        }
      ]
    },
    "contractTemplateId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Id"
        },
        {
          "nullable": true
        }
      ]
    },
    "created": {
      "description": "The creation date of this contract.",
      "format": "date-time",
      "readOnly": true,
      "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"
      },
      "readOnly": true,
      "title": "Invoice",
      "type": "array"
    },
    "isEditable": {
      "description": "Whether the contract is able to be edited.",
      "type": "boolean"
    },
    "isHidden": {
      "description": "Whether the contract has been marked 'hidden'.",
      "type": "boolean"
    },
    "languageCode": {
      "description": "The Unicode CLDR language tag for the language used in this\ncontract.",
      "example": "en_US",
      "type": "string"
    },
    "links": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Links"
        },
        {
          "readOnly": true
        }
      ]
    },
    "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}$",
      "readOnly": true,
      "type": "string"
    },
    "shootDate": {
      "description": "This contract covers a photo shoot or event that took place on this\ndate.",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "signatureClient": {
      "allOf": [
        {
          "description": "The contract signature for the client.",
          "nullable": true,
          "readOnly": true
        },
        {
          "$ref": "#/components/schemas/ContractSignature"
        }
      ]
    },
    "signatureStudio": {
      "allOf": [
        {
          "description": "The contract signature for the studio.",
          "nullable": true,
          "readOnly": true
        },
        {
          "$ref": "#/components/schemas/ContractSignature"
        }
      ]
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Type"
        },
        {
          "enum": [
            "contract"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "name",
    "brandThemeId",
    "contactIds",
    "bodyHtml",
    "expirationDate",
    "languageCode"
  ],
  "title": "Contract",
  "type": "object"
}
Contract