Invoice Template

Description

An invoice template.

Properties

Property Description
acceptedPaymentTypes

An array of payment types this invoice template accepts.

brandTheme

A brand theme.

brandThemeId

The identifier for the brand theme this invoice template uses.

created read-only

The creation date of this invoice.

currencyCode read-only

Identifies the currency represented in price.

currencySymbol read-only

The currency symbol for the currency used for this invoice template.

emailAutomationGroupId nullable

The identifier for the email automation group this invoice template uses.

grandTotal

The invoice template grand total.

id

The identifier for this invoice template

invoiceRetainerLabel nullable

This label represents how the studio wishes to refer to the initial payment represented by retainerPercent or retainerFixedAmount for this invoice. This property is required if retainerPercent or retainerFixedAmount contain non-null values.

The following labels are available. You are responsible for displaying appropriate human-readable strings for these labels, translated for your audience.

ShootProof Identifier Description
non-refundable-payment The initial payment should be referred to as a "non-refundable payment" when displaying the invoice to the studio's customer.
deposit The initial payment should be referred to as a "deposit" when displaying the invoice to the studio's customer.
retainer The initial payment should be referred to as a "retainer" when displaying the invoice to the studio's customer.
items

An array of line items for this invoice template.

languageCode

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

notesToClient

Notes to display on the invoice for the client.

paymentConfirmationText

A message sent to the client upon receipt of payment.

retainerFixedAmount nullable

Suggested fixed amount of retainer. If a retainer is defined, one of retainerPercent or retainerFixedAmount will be non-null.

retainerPercent nullable

Suggested amount of retainer in a percentage from 1-100. If a retainer is defined, one of retainerPercent or retainerFixedAmount will be non-null.

salesTaxPercent

A decimal number from 0-100, specifying the sales tax percentage. Required if salesTaxTitle has a non-zero length value.

salesTaxTitle

A label to apply to the sales tax percent on the invoice when viewed by the client. Required if salesTaxPercent has a non-zero length value.

salesTaxTotal

The total amount of sales tax on the invoice template.

subtotal

The invoice template subtotal.

taxableSubtotal

The taxable subtotal of the invoice template, based on its taxable items.

type

The type of object represented.

OpenAPI Schema

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

{
  "description": "An invoice template.",
  "properties": {
    "acceptedPaymentTypes": {
      "description": "An array of payment types this invoice template accepts.",
      "items": {
        "description": "A string identifying a specific payment type.",
        "enum": [
          "cash-check",
          "credit-card"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "brandTheme": {
      "$ref": "#/components/schemas/BrandTheme"
    },
    "brandThemeId": {
      "description": "The identifier for the brand theme this invoice template uses.",
      "type": "integer"
    },
    "created": {
      "description": "The creation date of this invoice.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "currencyCode": {
      "description": "Identifies the currency represented in `price`.",
      "readOnly": true,
      "type": "string"
    },
    "currencySymbol": {
      "description": "The currency symbol for the currency used for this invoice template.",
      "readOnly": true,
      "type": "string"
    },
    "emailAutomationGroupId": {
      "description": "The identifier for the email automation group this invoice template\nuses.",
      "nullable": true,
      "type": "integer"
    },
    "grandTotal": {
      "description": "The invoice template grand total.",
      "type": "number"
    },
    "id": {
      "description": "The identifier for this invoice template",
      "type": "integer"
    },
    "invoiceRetainerLabel": {
      "description": "This label represents how the studio wishes to refer to the initial\npayment represented by `retainerPercent` or `retainerFixedAmount` for this\ninvoice. This property is required if `retainerPercent` or\n`retainerFixedAmount` contain non-null values.\n\nThe following labels are available. You are responsible for displaying\nappropriate human-readable strings for these labels, translated for your\naudience.\n\n| ShootProof Identifier | Description |\n| --------------------- | ----------- |\n| `non-refundable-payment` | The initial payment should be referred to as a \"non-refundable payment\" when displaying the invoice to the studio's customer. |\n| `deposit` | The initial payment should be referred to as a \"deposit\" when displaying the invoice to the studio's customer. |\n| `retainer` | The initial payment should be referred to as a \"retainer\" when displaying the invoice to the studio's customer. |",
      "enum": [
        "non-refundable-payment",
        "deposit",
        "retainer"
      ],
      "nullable": true,
      "type": "string"
    },
    "items": {
      "description": "An array of line items for this invoice template.",
      "items": {
        "$ref": "#/components/schemas/InvoiceItem"
      },
      "type": "array"
    },
    "languageCode": {
      "description": "The Unicode CLDR language tag for the language used in this invoice\ntemplate.",
      "type": "string"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The name of this invoice template.",
      "type": "string"
    },
    "notesToClient": {
      "description": "Notes to display on the invoice for the client.",
      "type": "string"
    },
    "paymentConfirmationText": {
      "description": "A message sent to the client upon receipt of payment.",
      "type": "string"
    },
    "retainerFixedAmount": {
      "description": "Suggested fixed amount of retainer. If a retainer is defined, one of\n`retainerPercent` or `retainerFixedAmount` will be non-null.",
      "nullable": true,
      "type": "number"
    },
    "retainerPercent": {
      "description": "Suggested amount of retainer in a percentage from 1-100. If a\nretainer is defined, one of `retainerPercent` or\n`retainerFixedAmount` will be non-null.",
      "maximum": 100,
      "minimum": 1,
      "nullable": true,
      "type": "number"
    },
    "salesTaxPercent": {
      "description": "A decimal number from 0-100, specifying the sales tax percentage. Required\nif `salesTaxTitle` has a non-zero length value.",
      "maximum": 100,
      "minimum": 0,
      "type": "number"
    },
    "salesTaxTitle": {
      "description": "A label to apply to the sales tax percent on the invoice when viewed\nby the client. Required if `salesTaxPercent` has a non-zero length value.",
      "type": "string"
    },
    "salesTaxTotal": {
      "description": "The total amount of sales tax on the invoice template.",
      "type": "number"
    },
    "subtotal": {
      "description": "The invoice template subtotal.",
      "type": "number"
    },
    "taxableSubtotal": {
      "description": "The taxable subtotal of the invoice template, based on its taxable\nitems.",
      "type": "number"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "invoice-template"
      ],
      "type": "string"
    }
  },
  "required": [
    "type",
    "name",
    "brandThemeId",
    "acceptedPaymentTypes",
    "languageCode",
    "items"
  ],
  "title": "Invoice Template",
  "type": "object"
}