<a class="sp-anchor" id="user-content-invoices" href="#invoices" aria-hidden="true"> Invoices

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 required read-only

object

Metadata describing the current result set.

Property	Description
currentPage	`integer` The current page of results returned.
invoiceTotals required	`object` Total counts for various types of invoices in various states.
rows	`integer` The number of rows returned per page for the current result set.
totalItems	`integer` The total number of items in the result set. This may be affected by active search/filter parameters.
totalPages	`integer` The total number of pages in the result set. This is affected by the `rows` parameter (`totalItems / rows == totalPages`).

type

string

enum

invoice-collection

The model type for the list response object.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceCollection"
        }
      }
    },
    "description": "Invoices list response."
  }
}

Creates a new invoice for the current brand.

post

/studio/brand/{brandId}/invoice

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice object to create.

application/vnd.shootproof+json

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice accepts.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice uses.

cancelationMessage

string

Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state.

contactId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

creditCardOnFile required nullable

credit-card

The credit card on file for this invoice, if applicable.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

emailAutomationGroupId nullable

integer

The identifier for the email automation group this invoice uses.

grandTotal

number

The invoice grand total.

integer

The identifier for this invoice.

installments

invoice-installment[]

An array of invoice installments, defining the installment schedule for this invoice. Installments are required for invoices having a grandTotal greater than zero, but disallowed for Invoices having a grandTotal of zero.

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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.

invoiceStatus

string

enum

unpaid
partially-paid
paid-in-full
canceled
archived

The human-readable name of the current status of this invoice.

invoiceTemplateId nullable

integer

The identifier for the invoice template from which this invoice was created.

isHidden

boolean

Whether or not the invoice should be hidden

issueDate

string

date-time

The date on which this invoice was issued.

items

invoice-item[]

An array of line items for this invoice.

languageCode

string

The Unicode CLDR language tag for the language used in this invoice.

notesToClient

string

Notes to display on the invoice for the client.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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 nullable

number

≥ 0
≤ 100

A decimal number from 0-100, specifying the sales tax percentage.

salesTaxTitle nullable

string

A label to apply to the sales tax percent on the invoice when viewed by the client.

salesTaxTotal

number

The total amount of sales tax on the invoice.

subtotal

number

The invoice subtotal.

taxableSubtotal

number

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

type

string

enum

invoice

The type of object represented.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/Invoice"
      }
    }
  },
  "description": "The invoice object to create.",
  "required": true
}

Receiving the response

`201 Created`

The successfully-created invoice.

Headers

Header	Description
Location	`string` uri The URL to the newly-created invoice.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice accepts.

activity read-only

invoice-activity[]

A list of activities that have occurred with this invoice.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice uses.

cancelationMessage

string

Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state.

contact required read-only

contact

The base definition for a contact.

contactId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

contracts read-only

contract[]

An array of linked contracts.

created read-only

string

date-time

The creation date of this invoice.

creditCardOnFile required nullable

credit-card

The credit card on file for this invoice, if applicable.

creditCardTransactions read-only

invoice-credit-card-transaction[]

An array of invoice credit card transactions, showing all attempts to charge a card for this invoice, including approved/declined attempts.

currencyCode read-only

string

Identifies the currency used for this invoice.

currencySymbol read-only

string

The currency symbol for the currency used for this invoice.

customInvoiceId read-only

integer

A client-facing identifier for this invoice, starting at 1000 for each studio.

discountTotal read-only

number

The total amount of all discounts applied to this invoice.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

dueTotal read-only

number

The total amount of this invoice that is due.

emailAutomationGroupId nullable

integer

The identifier for the email automation group this invoice uses.

finalDueDate nullable read-only

string

date-time

The date on which this invoice must be paid in full.

grandTotal

number

The invoice grand total.

integer

The identifier for this invoice.

installments

invoice-installment[]

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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.

invoiceStatus

string

enum

unpaid
partially-paid
paid-in-full
canceled
archived

The human-readable name of the current status of this invoice.

invoiceTemplateId nullable

integer

The identifier for the invoice template from which this invoice was created.

isHidden

boolean

Whether or not the invoice should be hidden

issueDate

string

date-time

The date on which this invoice was issued.

items

invoice-item[]

An array of line items for this invoice.

languageCode

string

The Unicode CLDR language tag for the language used in this invoice.

links required read-only

object

notesToClient

string

Notes to display on the invoice for the client.

paidTotal read-only

number

The total amount of this invoice that has been paid.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

payments read-only

invoice-payment[]

Invoice Discount Template

An array of invoice payments, showing a history of all payments made on this invoice.

publicId read-only

string

^[a-fA-F0-9]{32}$

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

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

retainerTotal read-only

number

The total amount for the invoice retainer.

salesTaxPercent nullable

number

≥ 0
≤ 100

A decimal number from 0-100, specifying the sales tax percentage.

salesTaxTitle nullable

string

A label to apply to the sales tax percent on the invoice when viewed by the client.

salesTaxTotal

number

The total amount of sales tax on the invoice.

subtotal

number

The invoice subtotal.

taxableSubtotal

number

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

type

string

enum

invoice

The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

If the error response is a result of validation errors, it will most likely be a 400 Bad Request response and contain this info.errors property. Each property name in the errors object is a property that failed validation. These properties contain objects with property names in the form of internal validation error message slugs paired with human-readable string values describing the validation failure. Each property may have multiple validation failure messages.

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "201": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Invoice"
        }
      }
    },
    "description": "The successfully-created invoice.",
    "headers": {
      "Location": {
        "description": "The URL to the newly-created invoice.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

List invoice discount templates

get

/studio/brand/{brandId}/invoice/discount-template

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.

Query Parameters

Property	Description
page	`integer` default 1 The page of results to return.
rows	`integer` default 25 The number of rows to return on each page of results.
sortBy	`string` enum name discountType value created default "name" The property by which items returned should be sorted.
sortType	`string` enum asc desc default "asc" The direction in which sorting should occur.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

`200 OK`

A collection of invoice discount templates.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

items

invoice-discount-template[]

A collection of resources returned in the current result set.

Property	Description
created read-only	`string` date-time Signature The date on which the entity was created.
description	`string` A description of the discount for use as display text on the invoice.
discountType	`string` enum percent fixed The type of discount represented by the value.
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.
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` ≤ 20 characters A short name to use for this discount.
type	`string` enum invoice-discount-template Type The type of resource represented.
value	`number` = 0 The amount this discount represents. This value may be a fixed amount (if `discountType` is "fixed") or a number between `0.0` and `100.0`, representing a percentage of the total invoice (if `discountType` is "percent"). The discount value is allowed to be greater than the grand total of the invoice. In this case, the grand total will never be less than `0.00`.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

Property	Description
currentPage	`integer` The current page of results returned.
rows	`integer` The number of rows returned per page for the current result set.
totalItems	`integer` The total number of items in the result set. This may be affected by active search/filter parameters.
totalPages	`integer` The total number of pages in the result set. This is affected by the `rows` parameter (`totalItems / rows == totalPages`).

type

string

enum

invoice-discount-template-collection

The type of resource represented.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Any error with a status code of 400 to 499 is considered a client error. This means it’s usually an error you can handle in your app, and then resend a modified request to the ShootProof API to get a successful response.

An error in the range of 500 to 599, on the other hand, is a different story. These errors usually mean that a problem occured on the server and resending the request with modifications will not fix the issue.

Pay careful attention to the status codes. We try to stick as close as possible to their defined semantics. For a complete list of HTTP status codes, take a look at the official HTTP Status Code Registry.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceDiscountTemplateCollection"
        }
      }
    },
    "description": "A collection of invoice discount templates."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Create an invoice discount template

post

/studio/brand/{brandId}/invoice/discount-template

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice discount template to create.

application/vnd.shootproof+json

Property	Description
description	`string` A description of the discount for use as display text on the invoice.
discountType	`string` enum percent fixed The type of discount represented by the value.
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.
name	`string` ≤ 20 characters A short name to use for this discount.
type	`string` enum invoice-discount-template Type The type of resource represented.
value	`number` = 0 The amount this discount represents. This value may be a fixed amount (if `discountType` is "fixed") or a number between `0.0` and `100.0`, representing a percentage of the total invoice (if `discountType` is "percent"). The discount value is allowed to be greater than the grand total of the invoice. In this case, the grand total will never be less than `0.00`.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceDiscountTemplate"
      }
    }
  },
  "description": "The invoice discount template to create.",
  "required": true
}

Receiving the response

`201 Created`

The new invoice discount template.

Headers

Header	Description
Location	`string` uri The URL to the new invoice discount template.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property	Description
created read-only	`string` date-time Signature The date on which the entity was created.
description	`string` A description of the discount for use as display text on the invoice.
discountType	`string` enum percent fixed The type of discount represented by the value.
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.
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` ≤ 20 characters A short name to use for this discount.
type	`string` enum invoice-discount-template Type The type of resource represented.
value	`number` = 0 The amount this discount represents. This value may be a fixed amount (if `discountType` is "fixed") or a number between `0.0` and `100.0`, representing a percentage of the total invoice (if `discountType` is "percent"). The discount value is allowed to be greater than the grand total of the invoice. In this case, the grand total will never be less than `0.00`.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "201": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceDiscountTemplate"
        }
      }
    },
    "description": "The new invoice discount template.",
    "headers": {
      "Location": {
        "description": "The URL to the new invoice discount template.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Delete an invoice discount template

delete

/studio/brand/{brandId}/invoice/discount-template/{invoiceDiscountTemplateId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceDiscountTemplateId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The invoice discount template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

`204 No Content`

The resource was successfully deleted.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "204": {
    "$ref": "#/components/responses/deleteSuccess"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Get an invoice discount template

get

/studio/brand/{brandId}/invoice/discount-template/{invoiceDiscountTemplateId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceDiscountTemplateId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The invoice discount template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

`200 OK`

An invoice discount template.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property	Description
created read-only	`string` date-time Signature The date on which the entity was created.
description	`string` A description of the discount for use as display text on the invoice.
discountType	`string` enum percent fixed The type of discount represented by the value.
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.
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` ≤ 20 characters A short name to use for this discount.
type	`string` enum invoice-discount-template Type The type of resource represented.
value	`number` = 0 The amount this discount represents. This value may be a fixed amount (if `discountType` is "fixed") or a number between `0.0` and `100.0`, representing a percentage of the total invoice (if `discountType` is "percent"). The discount value is allowed to be greater than the grand total of the invoice. In this case, the grand total will never be less than `0.00`.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceDiscountTemplate"
        }
      }
    },
    "description": "An invoice discount template."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Partially update an invoice discount template

patch

/studio/brand/{brandId}/invoice/discount-template/{invoiceDiscountTemplateId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceDiscountTemplateId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The invoice discount template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice discount template to update. Only provide those properties that need updating.

application/vnd.shootproof+json

Property	Description
description	`string` A description of the discount for use as display text on the invoice.
discountType	`string` enum percent fixed The type of discount represented by the value.
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.
name	`string` ≤ 20 characters A short name to use for this discount.
type	`string` enum invoice-discount-template Type The type of resource represented.
value	`number` = 0 The amount this discount represents. This value may be a fixed amount (if `discountType` is "fixed") or a number between `0.0` and `100.0`, representing a percentage of the total invoice (if `discountType` is "percent"). The discount value is allowed to be greater than the grand total of the invoice. In this case, the grand total will never be less than `0.00`.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceDiscountTemplate"
      }
    }
  },
  "description": "The invoice discount template to update. Only provide those properties\nthat need updating.",
  "required": true
}

Receiving the response

`200 OK`

The updated invoice discount template.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property	Description
created read-only	`string` date-time Signature The date on which the entity was created.
description	`string` A description of the discount for use as display text on the invoice.
discountType	`string` enum percent fixed The type of discount represented by the value.
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.
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` ≤ 20 characters A short name to use for this discount.
type	`string` enum invoice-discount-template Type The type of resource represented.
value	`number` = 0 The amount this discount represents. This value may be a fixed amount (if `discountType` is "fixed") or a number between `0.0` and `100.0`, representing a percentage of the total invoice (if `discountType` is "percent"). The discount value is allowed to be greater than the grand total of the invoice. In this case, the grand total will never be less than `0.00`.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceDiscountTemplate"
        }
      }
    },
    "description": "The updated invoice discount template."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Update an invoice discount template

put

/studio/brand/{brandId}/invoice/discount-template/{invoiceDiscountTemplateId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceDiscountTemplateId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The invoice discount template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice discount template to update.

application/vnd.shootproof+json

Property	Description
description	`string` A description of the discount for use as display text on the invoice.
discountType	`string` enum percent fixed The type of discount represented by the value.
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.
name	`string` ≤ 20 characters A short name to use for this discount.
type	`string` enum invoice-discount-template Type The type of resource represented.
value	`number` = 0 The amount this discount represents. This value may be a fixed amount (if `discountType` is "fixed") or a number between `0.0` and `100.0`, representing a percentage of the total invoice (if `discountType` is "percent"). The discount value is allowed to be greater than the grand total of the invoice. In this case, the grand total will never be less than `0.00`.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceDiscountTemplate"
      }
    }
  },
  "description": "The invoice discount template to update.",
  "required": true
}

Receiving the response

`200 OK`

The updated invoice discount template.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property	Description
created read-only	`string` date-time Signature The date on which the entity was created.
description	`string` A description of the discount for use as display text on the invoice.
discountType	`string` enum percent fixed The type of discount represented by the value.
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.
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` ≤ 20 characters A short name to use for this discount.
type	`string` enum invoice-discount-template Type The type of resource represented.
value	`number` = 0 The amount this discount represents. This value may be a fixed amount (if `discountType` is "fixed") or a number between `0.0` and `100.0`, representing a percentage of the total invoice (if `discountType` is "percent"). The discount value is allowed to be greater than the grand total of the invoice. In this case, the grand total will never be less than `0.00`.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceDiscountTemplate"
        }
      }
    },
    "description": "The updated invoice discount template."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Lists all invoice item templates for the current brand.

get

/studio/brand/{brandId}/invoice/item-template

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.

Query Parameters

Property	Description
page	`integer` default 1 The page of results to return.
rows	`integer` default 25 The number of rows to return on each page of results.
searchNameDescription	`string` Search invoice item templates by the name and description fields.
sortBy	`string` enum id name description itemPrice quantity totalPrice isTaxable created default "name" The property by which items returned should be sorted.
sortType	`string` enum asc desc default "asc" The direction in which sorting should occur.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

200
Schema

`200 OK`

Invoice item templates list response.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

items

invoice-item-template[]

Invoice Item Template

A collection of resources returned in the current result set.

Property	Description
created read-only	`string` date-time Signature The date on which the entity was created.
description	`string` A description for this invoice item template.
id	`integer` The identifier for this invoice item template.
isTaxable	`boolean` Whether this invoice item template is taxable.
itemPrice	`number` The price for a single one of this invoice item 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 of this invoice item template.
quantity	`integer` The default quantity for this invoice item template.
totalPrice	`number` The invoice item template price multiplied by the quantity.
type	`string` enum invoice-item-template The type of object represented.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

Property	Description
currentPage	`integer` The current page of results returned.
rows	`integer` The number of rows returned per page for the current result set.
totalItems	`integer` The total number of items in the result set. This may be affected by active search/filter parameters.
totalPages	`integer` The total number of pages in the result set. This is affected by the `rows` parameter (`totalItems / rows == totalPages`).

type

string

enum

invoice-item-template-collection

The model type for the list response object.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "allOf": [
            {
              "properties": {
                "items": {
                  "items": {
                    "$ref": "#/components/schemas/InvoiceItemTemplate"
                  },
                  "type": "array"
                },
                "type": {
                  "description": "The model type for the list response object.",
                  "enum": [
                    "invoice-item-template-collection"
                  ],
                  "type": "string"
                }
              }
            },
            {
              "$ref": "#/components/schemas/List"
            }
          ],
          "description": "A collection of invoice item templates"
        }
      }
    },
    "description": "Invoice item templates list response."
  }
}

Creates a new invoice item template for the current brand.

post

/studio/brand/{brandId}/invoice/item-template

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice item template object to create.

application/vnd.shootproof+json

Property	Description
description	`string` A description for this invoice item template.
id	`integer` The identifier for this invoice item template.
isTaxable	`boolean` Whether this invoice item template is taxable.
itemPrice	`number` The price for a single one of this invoice item template.
name	`string` The name of this invoice item template.
quantity	`integer` The default quantity for this invoice item template.
totalPrice	`number` The invoice item template price multiplied by the quantity.
type	`string` enum invoice-item-template The type of object represented.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceItemTemplate"
      }
    }
  },
  "description": "The invoice item template object to create.",
  "required": true
}

Receiving the response

`201 Created`

The successfully-created invoice item template.

Headers

Header	Description
Location	`string` uri The URL to the newly-created invoice item template.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property	Description
created read-only	`string` date-time Signature The date on which the entity was created.
description	`string` A description for this invoice item template.
id	`integer` The identifier for this invoice item template.
isTaxable	`boolean` Whether this invoice item template is taxable.
itemPrice	`number` The price for a single one of this invoice item 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 of this invoice item template.
quantity	`integer` The default quantity for this invoice item template.
totalPrice	`number` The invoice item template price multiplied by the quantity.
type	`string` enum invoice-item-template The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "201": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceItemTemplate"
        }
      }
    },
    "description": "The successfully-created invoice item template.",
    "headers": {
      "Location": {
        "description": "The URL to the newly-created invoice item template.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Removes an invoice item template.

delete

/studio/brand/{brandId}/invoice/item-template/{invoiceItemTemplateId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceItemTemplateId required	`integer` The invoice item template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

204
Schema

`204 No Content`

Successful deletion response.

OpenAPI Schema

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

{
  "204": {
    "description": "Successful deletion response."
  }
}

Returns a single invoice item template by ID.

get

/studio/brand/{brandId}/invoice/item-template/{invoiceItemTemplateId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceItemTemplateId required	`integer` The invoice item template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

`200 OK`

An invoice item template.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property	Description
created read-only	`string` date-time Signature The date on which the entity was created.
description	`string` A description for this invoice item template.
id	`integer` The identifier for this invoice item template.
isTaxable	`boolean` Whether this invoice item template is taxable.
itemPrice	`number` The price for a single one of this invoice item 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 of this invoice item template.
quantity	`integer` The default quantity for this invoice item template.
totalPrice	`number` The invoice item template price multiplied by the quantity.
type	`string` enum invoice-item-template The type of object represented.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceItemTemplate"
        }
      }
    },
    "description": "An invoice item template."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Partially updates an invoice item template.

patch

/studio/brand/{brandId}/invoice/item-template/{invoiceItemTemplateId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceItemTemplateId required	`integer` The invoice item template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice item template object to update. Only provide those properties that need updating.

application/vnd.shootproof+json

Property	Description
description	`string` A description for this invoice item template.
id	`integer` The identifier for this invoice item template.
isTaxable	`boolean` Whether this invoice item template is taxable.
itemPrice	`number` The price for a single one of this invoice item template.
name	`string` The name of this invoice item template.
quantity	`integer` The default quantity for this invoice item template.
totalPrice	`number` The invoice item template price multiplied by the quantity.
type	`string` enum invoice-item-template The type of object represented.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceItemTemplate"
      }
    }
  },
  "description": "The invoice item template object to update. Only provide those\nproperties that need updating.",
  "required": true
}

Receiving the response

`200 OK`

The successfully-updated invoice item template.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property	Description
created read-only	`string` date-time Signature The date on which the entity was created.
description	`string` A description for this invoice item template.
id	`integer` The identifier for this invoice item template.
isTaxable	`boolean` Whether this invoice item template is taxable.
itemPrice	`number` The price for a single one of this invoice item 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 of this invoice item template.
quantity	`integer` The default quantity for this invoice item template.
totalPrice	`number` The invoice item template price multiplied by the quantity.
type	`string` enum invoice-item-template The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceItemTemplate"
        }
      }
    },
    "description": "The successfully-updated invoice item template."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Fully updates an invoice item template.

put

/studio/brand/{brandId}/invoice/item-template/{invoiceItemTemplateId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceItemTemplateId required	`integer` The invoice item template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice item template object to update.

application/vnd.shootproof+json

Property	Description
description	`string` A description for this invoice item template.
id	`integer` The identifier for this invoice item template.
isTaxable	`boolean` Whether this invoice item template is taxable.
itemPrice	`number` The price for a single one of this invoice item template.
name	`string` The name of this invoice item template.
quantity	`integer` The default quantity for this invoice item template.
totalPrice	`number` The invoice item template price multiplied by the quantity.
type	`string` enum invoice-item-template The type of object represented.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceItemTemplate"
      }
    }
  },
  "description": "The invoice item template object to update.",
  "required": true
}

Receiving the response

`200 OK`

The successfully-updated invoice item template.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property	Description
created read-only	`string` date-time Signature The date on which the entity was created.
description	`string` A description for this invoice item template.
id	`integer` The identifier for this invoice item template.
isTaxable	`boolean` Whether this invoice item template is taxable.
itemPrice	`number` The price for a single one of this invoice item 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 of this invoice item template.
quantity	`integer` The default quantity for this invoice item template.
totalPrice	`number` The invoice item template price multiplied by the quantity.
type	`string` enum invoice-item-template The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceItemTemplate"
        }
      }
    },
    "description": "The successfully-updated invoice item template."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Lists all invoice templates for the current brand.

Returns a list of all invoice templates for the current brand. Query string parameters may be used to affect the response, including pagination, sorting, and filtering of results.

get

/studio/brand/{brandId}/invoice/template

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.

Query Parameters

Property	Description
page	`integer` default 1 The page of results to return.
rows	`integer` default 25 The number of rows to return on each page of results.
searchInvoiceItem	`string` The name or description of invoice items by which to filter results.
searchName	`string` Invoice template name by which to filter results.
sortBy	`string` enum name invoiceItemCount created default "name" The property by which items returned should be sorted.
sortType	`string` enum asc desc default "asc" The direction in which sorting should occur.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

200
Schema

`200 OK`

Invoice templates list response.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

items

invoice-template[]

A collection of resources returned in the current result set.

Property	Description
created	`string` date-time The creation date of this invoice template.
id	`integer` The identifier for this invoice template.
invoiceItemCount	`integer` The number of invoice items on this invoice 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 of this invoice template.
type	`string` enum invoice-template The type of object represented.

links required read-only

object

meta read-only

object

Metadata describing the current result set.

Property	Description
currentPage	`integer` The current page of results returned.
rows	`integer` The number of rows returned per page for the current result set.
totalItems	`integer` The total number of items in the result set. This may be affected by active search/filter parameters.
totalPages	`integer` The total number of pages in the result set. This is affected by the `rows` parameter (`totalItems / rows == totalPages`).

type

string

enum

invoice-template-collection

The model type for the list response object.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "allOf": [
            {
              "$ref": "#/components/schemas/List"
            },
            {
              "properties": {
                "items": {
                  "items": {
                    "description": "An invoice template as viewed from a collection.",
                    "properties": {
                      "created": {
                        "description": "The creation date of this invoice template.",
                        "format": "date-time",
                        "type": "string"
                      },
                      "id": {
                        "description": "The identifier for this invoice template.",
                        "type": "integer"
                      },
                      "invoiceItemCount": {
                        "description": "The number of invoice items on this invoice\ntemplate.",
                        "type": "integer"
                      },
                      "links": {
                        "$ref": "#/components/schemas/Links"
                      },
                      "name": {
                        "description": "The name of this invoice template.",
                        "type": "string"
                      },
                      "type": {
                        "description": "The type of object represented.",
                        "enum": [
                          "invoice-template"
                        ],
                        "type": "string"
                      }
                    },
                    "required": [
                      "type",
                      "links",
                      "id",
                      "name",
                      "invoiceItemCount",
                      "created"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "type": {
                  "description": "The model type for the list response object.",
                  "enum": [
                    "invoice-template-collection"
                  ],
                  "type": "string"
                }
              },
              "type": "object"
            }
          ],
          "description": "A collection of invoice templates."
        }
      }
    },
    "description": "Invoice templates list response."
  }
}

Creates a new invoice template for the current brand.

post

/studio/brand/{brandId}/invoice/template

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice template object to create.

application/vnd.shootproof+json

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice template accepts.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice template uses.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

emailAutomationGroupId nullable

integer

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

grandTotal

number

The invoice template grand total.

integer

The identifier for this invoice template

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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

invoice-item[]

An array of line items for this invoice template.

languageCode

string

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

name

string

The name of this invoice template.

notesToClient

string

Notes to display on the invoice for the client.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

number

≥ 0
≤ 100

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

salesTaxTitle

string

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

number

The total amount of sales tax on the invoice template.

subtotal

number

The invoice template subtotal.

taxableSubtotal

number

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

type

string

enum

invoice-template

The type of object represented.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceTemplate"
      }
    }
  },
  "description": "The invoice template object to create.",
  "required": true
}

Receiving the response

`201 Created`

The successfully-created invoice template.

Headers

Header	Description
Location	`string` uri The URL to the newly-created invoice template.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice template accepts.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice template uses.

created read-only

string

date-time

The creation date of this invoice.

currencyCode read-only

string

Identifies the currency represented in price.

currencySymbol read-only

string

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

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

emailAutomationGroupId nullable

integer

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

grandTotal

number

The invoice template grand total.

integer

The identifier for this invoice template

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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

invoice-item[]

An array of line items for this invoice template.

languageCode

string

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

links required read-only

object

name

string

The name of this invoice template.

notesToClient

string

Notes to display on the invoice for the client.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

number

≥ 0
≤ 100

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

salesTaxTitle

string

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

number

The total amount of sales tax on the invoice template.

subtotal

number

The invoice template subtotal.

taxableSubtotal

number

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

type

string

enum

invoice-template

The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "201": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceTemplate"
        }
      }
    },
    "description": "The successfully-created invoice template.",
    "headers": {
      "Location": {
        "description": "The URL to the newly-created invoice template.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Removes an invoice template.

delete

/studio/brand/{brandId}/invoice/template/{invoiceTemplateId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceTemplateId required	`integer` The invoice template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

204
Schema

`204 No Content`

Successful deletion response.

OpenAPI Schema

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

{
  "204": {
    "description": "Successful deletion response."
  }
}

Returns a single invoice template by ID.

get

/studio/brand/{brandId}/invoice/template/{invoiceTemplateId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceTemplateId required	`integer` The invoice template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

`200 OK`

An invoice template.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice template accepts.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice template uses.

created read-only

string

date-time

The creation date of this invoice.

currencyCode read-only

string

Identifies the currency represented in price.

currencySymbol read-only

string

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

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

emailAutomationGroupId nullable

integer

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

grandTotal

number

The invoice template grand total.

integer

The identifier for this invoice template

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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

invoice-item[]

An array of line items for this invoice template.

languageCode

string

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

links required read-only

object

name

string

The name of this invoice template.

notesToClient

string

Notes to display on the invoice for the client.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

number

≥ 0
≤ 100

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

salesTaxTitle

string

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

number

The total amount of sales tax on the invoice template.

subtotal

number

The invoice template subtotal.

taxableSubtotal

number

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

type

string

enum

invoice-template

The type of object represented.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceTemplate"
        }
      }
    },
    "description": "An invoice template."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Fully updates an invoice template.

put

/studio/brand/{brandId}/invoice/template/{invoiceTemplateId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceTemplateId required	`integer` The invoice template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice template object to update.

application/vnd.shootproof+json

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice template accepts.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice template uses.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

emailAutomationGroupId nullable

integer

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

grandTotal

number

The invoice template grand total.

integer

The identifier for this invoice template

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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

invoice-item[]

An array of line items for this invoice template.

languageCode

string

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

name

string

The name of this invoice template.

notesToClient

string

Notes to display on the invoice for the client.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

number

≥ 0
≤ 100

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

salesTaxTitle

string

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

number

The total amount of sales tax on the invoice template.

subtotal

number

The invoice template subtotal.

taxableSubtotal

number

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

type

string

enum

invoice-template

The type of object represented.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceTemplate"
      }
    }
  },
  "description": "The invoice template object to update.",
  "required": true
}

Receiving the response

`200 OK`

The successfully-updated invoice template.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice template accepts.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice template uses.

created read-only

string

date-time

The creation date of this invoice.

currencyCode read-only

string

Identifies the currency represented in price.

currencySymbol read-only

string

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

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

emailAutomationGroupId nullable

integer

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

grandTotal

number

The invoice template grand total.

integer

The identifier for this invoice template

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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

invoice-item[]

An array of line items for this invoice template.

languageCode

string

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

links required read-only

object

name

string

The name of this invoice template.

notesToClient

string

Notes to display on the invoice for the client.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

number

≥ 0
≤ 100

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

salesTaxTitle

string

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

number

The total amount of sales tax on the invoice template.

subtotal

number

The invoice template subtotal.

taxableSubtotal

number

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

type

string

enum

invoice-template

The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

`409 Conflict`

In certain cases, we respond with a 409 Conflict HTTP response if the state of the invoice template does not allow the requested change. Inspect the error response message for information about the conflict.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceTemplate"
        }
      }
    },
    "description": "The successfully-updated invoice template."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "409": {
    "description": "In certain cases, we respond with a `409 Conflict` HTTP response if the\nstate of the invoice template does not allow the requested change.\nInspect the error response message for information about the conflict."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Remove all discounts from an invoice template

delete

/studio/brand/{brandId}/invoice/template/{invoiceTemplateId}/discount

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceTemplateId required	`integer` The invoice template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

`204 No Content`

The resource was successfully deleted.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "204": {
    "$ref": "#/components/responses/deleteSuccess"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Apply a discount to an invoice template

post

/studio/brand/{brandId}/invoice/template/{invoiceTemplateId}/discount

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceTemplateId required	`integer` The invoice template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice discount to add to the invoice template.

application/vnd.shootproof+json

Property	Description
description	`string` A description of the discount for use as display text on the invoice.
discountType	`string` enum percent fixed The type of discount represented by the value.
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.
name	`string` ≤ 20 characters A short name to use for this discount.
type	`string` enum invoice-discount Type The type of resource represented.
value	`number` = 0 The amount this discount represents. This value may be a fixed amount (if `discountType` is "fixed") or a number between `0.0` and `100.0`, representing a percentage of the total invoice (if `discountType` is "percent"). The discount value is allowed to be greater than the grand total of the invoice. In this case, the grand total will never be less than `0.00`.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceDiscount"
      }
    }
  },
  "description": "The invoice discount to add to the invoice template.",
  "required": true
}

Receiving the response

`200 OK`

Responds with the invoice template on success.

Headers

Header	Description
Content-Location	`string` uri The URL of the invoice template in the response body.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice template accepts.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice template uses.

created read-only

string

date-time

The creation date of this invoice.

currencyCode read-only

string

Identifies the currency represented in price.

currencySymbol read-only

string

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

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

emailAutomationGroupId nullable

integer

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

grandTotal

number

The invoice template grand total.

integer

The identifier for this invoice template

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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

invoice-item[]

An array of line items for this invoice template.

languageCode

string

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

links required read-only

object

name

string

The name of this invoice template.

notesToClient

string

Notes to display on the invoice for the client.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

number

≥ 0
≤ 100

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

salesTaxTitle

string

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

number

The total amount of sales tax on the invoice template.

subtotal

number

The invoice template subtotal.

taxableSubtotal

number

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

type

string

enum

invoice-template

The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

`409 Conflict`

If the invoice template has the maximum number of allowed discounts applied to it, then we respond with a 409 Conflict response.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceTemplate"
        }
      }
    },
    "description": "Responds with the invoice template on success.",
    "headers": {
      "Content-Location": {
        "description": "The URL of the invoice template in the response body.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "409": {
    "content": {
      "application/problem+json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    },
    "description": "If the invoice template has the maximum number of allowed discounts\napplied to it, then we respond with a `409 Conflict` response."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Remove a discount from an invoice template

delete

/studio/brand/{brandId}/invoice/template/{invoiceTemplateId}/discount/{invoiceDiscountId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceDiscountId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The invoice discount identifier.
invoiceTemplateId required	`integer` The invoice template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

`204 No Content`

The resource was successfully deleted.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "204": {
    "$ref": "#/components/responses/deleteSuccess"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Partially update a discount on an invoice template

patch

/studio/brand/{brandId}/invoice/template/{invoiceTemplateId}/discount/{invoiceDiscountId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceDiscountId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The invoice discount identifier.
invoiceTemplateId required	`integer` The invoice template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice discount to update. Only provide those properties that need updating.

application/vnd.shootproof+json

Property	Description
description	`string` A description of the discount for use as display text on the invoice.
discountType	`string` enum percent fixed The type of discount represented by the value.
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.
name	`string` ≤ 20 characters A short name to use for this discount.
type	`string` enum invoice-discount Type The type of resource represented.
value	`number` = 0 The amount this discount represents. This value may be a fixed amount (if `discountType` is "fixed") or a number between `0.0` and `100.0`, representing a percentage of the total invoice (if `discountType` is "percent"). The discount value is allowed to be greater than the grand total of the invoice. In this case, the grand total will never be less than `0.00`.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceDiscount"
      }
    }
  },
  "description": "The invoice discount to update. Only provide those properties\nthat need updating.",
  "required": true
}

Receiving the response

`200 OK`

Responds with the invoice template on success.

Headers

Header	Description
Content-Location	`string` uri The URL of the invoice template in the response body.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice template accepts.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice template uses.

created read-only

string

date-time

The creation date of this invoice.

currencyCode read-only

string

Identifies the currency represented in price.

currencySymbol read-only

string

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

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

emailAutomationGroupId nullable

integer

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

grandTotal

number

The invoice template grand total.

integer

The identifier for this invoice template

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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

invoice-item[]

An array of line items for this invoice template.

languageCode

string

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

links required read-only

object

name

string

The name of this invoice template.

notesToClient

string

Notes to display on the invoice for the client.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

number

≥ 0
≤ 100

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

salesTaxTitle

string

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

number

The total amount of sales tax on the invoice template.

subtotal

number

The invoice template subtotal.

taxableSubtotal

number

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

type

string

enum

invoice-template

The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceTemplate"
        }
      }
    },
    "description": "Responds with the invoice template on success.",
    "headers": {
      "Content-Location": {
        "description": "The URL of the invoice template in the response body.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Update a discount on an invoice template

put

/studio/brand/{brandId}/invoice/template/{invoiceTemplateId}/discount/{invoiceDiscountId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceDiscountId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The invoice discount identifier.
invoiceTemplateId required	`integer` The invoice template identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The updated invoice template discount.

application/vnd.shootproof+json

Property	Description
description	`string` A description of the discount for use as display text on the invoice.
discountType	`string` enum percent fixed The type of discount represented by the value.
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.
name	`string` ≤ 20 characters A short name to use for this discount.
type	`string` enum invoice-discount Type The type of resource represented.
value	`number` = 0 The amount this discount represents. This value may be a fixed amount (if `discountType` is "fixed") or a number between `0.0` and `100.0`, representing a percentage of the total invoice (if `discountType` is "percent"). The discount value is allowed to be greater than the grand total of the invoice. In this case, the grand total will never be less than `0.00`.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceDiscount"
      }
    }
  },
  "description": "The updated invoice template discount.",
  "required": true
}

Receiving the response

`200 OK`

Responds with the invoice template on success.

Headers

Header	Description
Content-Location	`string` uri The URL of the invoice template in the response body.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice template accepts.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice template uses.

created read-only

string

date-time

The creation date of this invoice.

currencyCode read-only

string

Identifies the currency represented in price.

currencySymbol read-only

string

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

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

emailAutomationGroupId nullable

integer

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

grandTotal

number

The invoice template grand total.

integer

The identifier for this invoice template

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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

invoice-item[]

An array of line items for this invoice template.

languageCode

string

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

links required read-only

object

name

string

The name of this invoice template.

notesToClient

string

Notes to display on the invoice for the client.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

number

≥ 0
≤ 100

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

salesTaxTitle

string

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

number

The total amount of sales tax on the invoice template.

subtotal

number

The invoice template subtotal.

taxableSubtotal

number

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

type

string

enum

invoice-template

The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/InvoiceTemplate"
        }
      }
    },
    "description": "Responds with the invoice template on success.",
    "headers": {
      "Content-Location": {
        "description": "The URL of the invoice template in the response body.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Removes an invoice.

delete

/studio/brand/{brandId}/invoice/{invoiceId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An invoice identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

204
Schema

`204 No Content`

Successful deletion response.

OpenAPI Schema

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

{
  "204": {
    "description": "Successful deletion response."
  }
}

Returns a single invoice by ID.

get

/studio/brand/{brandId}/invoice/{invoiceId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An invoice identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

`200 OK`

An invoice

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice accepts.

activity read-only

invoice-activity[]

A list of activities that have occurred with this invoice.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice uses.

cancelationMessage

string

Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state.

contact required read-only

contact

The base definition for a contact.

contactId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

contracts read-only

contract[]

An array of linked contracts.

created read-only

string

date-time

The creation date of this invoice.

creditCardOnFile required nullable

credit-card

The credit card on file for this invoice, if applicable.

creditCardTransactions read-only

invoice-credit-card-transaction[]

An array of invoice credit card transactions, showing all attempts to charge a card for this invoice, including approved/declined attempts.

currencyCode read-only

string

Identifies the currency used for this invoice.

currencySymbol read-only

string

The currency symbol for the currency used for this invoice.

customInvoiceId read-only

integer

A client-facing identifier for this invoice, starting at 1000 for each studio.

discountTotal read-only

number

The total amount of all discounts applied to this invoice.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

dueTotal read-only

number

The total amount of this invoice that is due.

emailAutomationGroupId nullable

integer

The identifier for the email automation group this invoice uses.

finalDueDate nullable read-only

string

date-time

The date on which this invoice must be paid in full.

grandTotal

number

The invoice grand total.

integer

The identifier for this invoice.

installments

invoice-installment[]

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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.

invoiceStatus

string

enum

unpaid
partially-paid
paid-in-full
canceled
archived

The human-readable name of the current status of this invoice.

invoiceTemplateId nullable

integer

The identifier for the invoice template from which this invoice was created.

isHidden

boolean

Whether or not the invoice should be hidden

issueDate

string

date-time

The date on which this invoice was issued.

items

invoice-item[]

An array of line items for this invoice.

languageCode

string

The Unicode CLDR language tag for the language used in this invoice.

links required read-only

object

notesToClient

string

Notes to display on the invoice for the client.

paidTotal read-only

number

The total amount of this invoice that has been paid.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

payments read-only

invoice-payment[]

An array of invoice payments, showing a history of all payments made on this invoice.

publicId read-only

string

^[a-fA-F0-9]{32}$

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

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

retainerTotal read-only

number

The total amount for the invoice retainer.

salesTaxPercent nullable

number

≥ 0
≤ 100

A decimal number from 0-100, specifying the sales tax percentage.

salesTaxTitle nullable

string

A label to apply to the sales tax percent on the invoice when viewed by the client.

salesTaxTotal

number

The total amount of sales tax on the invoice.

subtotal

number

The invoice subtotal.

taxableSubtotal

number

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

type

string

enum

invoice

The type of object represented.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Invoice"
        }
      }
    },
    "description": "An invoice"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Partially updates an invoice.

patch

/studio/brand/{brandId}/invoice/{invoiceId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An invoice identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice object to update. Only provide those properties that need updating.

application/vnd.shootproof+json

Property	Description
acceptedPaymentTypes	`string[]` enum cash-check credit-card An array of payment types this invoice accepts.
brandThemeId	`integer` The identifier for the brand theme this invoice uses.
contactId	`integer` The identifier for the contact associated with this invoice.
emailAutomationGroupId nullable	`integer` The identifier for the email automation group this invoice uses.
invoiceStatus	`string` enum unpaid partially-paid paid-in-full canceled archived The human-readable name of the current status of this invoice.
isHidden	`boolean` Whether or not the invoice is hidden
issueDate	`string` date-time The date on which this invoice was issued.
languageCode	`string` The Unicode CLDR language tag for the language used in this invoice.
notesToClient	`string` Notes to display on the invoice for the client.
paymentConfirmationText	`string` A message sent to the client upon receipt of payment.
salesTaxPercent	`number` ≥ 0 ≤ 100 A decimal number from 0-100, specifying the sales tax percentage.
salesTaxTitle nullable	`string` A label to apply to the sales tax percent on the invoice when viewed by the client.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "description": "An invoice representation for partial updates.",
        "properties": {
          "acceptedPaymentTypes": {
            "description": "An array of payment types this invoice accepts.",
            "items": {
              "description": "A string identifying a specific payment type.",
              "enum": [
                "cash-check",
                "credit-card"
              ],
              "type": "string"
            },
            "type": "array"
          },
          "brandThemeId": {
            "description": "The identifier for the brand theme this invoice uses.",
            "type": "integer"
          },
          "contactId": {
            "description": "The identifier for the contact associated with this invoice.",
            "type": "integer"
          },
          "emailAutomationGroupId": {
            "description": "The identifier for the email automation group this invoice\nuses.",
            "nullable": true,
            "type": "integer"
          },
          "invoiceStatus": {
            "description": "The human-readable name of the current status of this invoice.",
            "enum": [
              "unpaid",
              "partially-paid",
              "paid-in-full",
              "canceled",
              "archived"
            ],
            "type": "string"
          },
          "isHidden": {
            "description": "Whether or not the invoice is hidden",
            "type": "boolean"
          },
          "issueDate": {
            "description": "The date on which this invoice was issued.",
            "format": "date-time",
            "type": "string"
          },
          "languageCode": {
            "description": "The Unicode CLDR language tag for the language used in this\ninvoice.",
            "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"
          },
          "salesTaxPercent": {
            "description": "A decimal number from 0-100, specifying the sales tax\npercentage.",
            "maximum": 100,
            "minimum": 0,
            "type": "number"
          },
          "salesTaxTitle": {
            "description": "A label to apply to the sales tax percent on the invoice\nwhen viewed by the client.",
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "description": "The invoice object to update. Only provide those properties that need\nupdating.",
  "required": true
}

Receiving the response

`200 OK`

The successfully-updated invoice.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice accepts.

activity read-only

invoice-activity[]

A list of activities that have occurred with this invoice.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice uses.

cancelationMessage

string

Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state.

contact required read-only

contact

The base definition for a contact.

contactId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

contracts read-only

contract[]

An array of linked contracts.

created read-only

string

date-time

The creation date of this invoice.

creditCardOnFile required nullable

credit-card

The credit card on file for this invoice, if applicable.

creditCardTransactions read-only

invoice-credit-card-transaction[]

An array of invoice credit card transactions, showing all attempts to charge a card for this invoice, including approved/declined attempts.

currencyCode read-only

string

Identifies the currency used for this invoice.

currencySymbol read-only

string

The currency symbol for the currency used for this invoice.

customInvoiceId read-only

integer

A client-facing identifier for this invoice, starting at 1000 for each studio.

discountTotal read-only

number

The total amount of all discounts applied to this invoice.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

dueTotal read-only

number

The total amount of this invoice that is due.

emailAutomationGroupId nullable

integer

The identifier for the email automation group this invoice uses.

finalDueDate nullable read-only

string

date-time

The date on which this invoice must be paid in full.

grandTotal

number

The invoice grand total.

integer

The identifier for this invoice.

installments

invoice-installment[]

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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.

invoiceStatus

string

enum

unpaid
partially-paid
paid-in-full
canceled
archived

The human-readable name of the current status of this invoice.

invoiceTemplateId nullable

integer

The identifier for the invoice template from which this invoice was created.

isHidden

boolean

Whether or not the invoice should be hidden

issueDate

string

date-time

The date on which this invoice was issued.

items

invoice-item[]

An array of line items for this invoice.

languageCode

string

The Unicode CLDR language tag for the language used in this invoice.

links required read-only

object

notesToClient

string

Notes to display on the invoice for the client.

paidTotal read-only

number

The total amount of this invoice that has been paid.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

payments read-only

invoice-payment[]

An array of invoice payments, showing a history of all payments made on this invoice.

publicId read-only

string

^[a-fA-F0-9]{32}$

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

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

retainerTotal read-only

number

The total amount for the invoice retainer.

salesTaxPercent nullable

number

≥ 0
≤ 100

A decimal number from 0-100, specifying the sales tax percentage.

salesTaxTitle nullable

string

A label to apply to the sales tax percent on the invoice when viewed by the client.

salesTaxTotal

number

The total amount of sales tax on the invoice.

subtotal

number

The invoice subtotal.

taxableSubtotal

number

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

type

string

enum

invoice

The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Invoice"
        }
      }
    },
    "description": "The successfully-updated invoice."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Fully updates an invoice.

put

/studio/brand/{brandId}/invoice/{invoiceId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An invoice identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice object to update.

application/vnd.shootproof+json

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice accepts.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice uses.

cancelationMessage

string

Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state.

contactId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

creditCardOnFile required nullable

credit-card

The credit card on file for this invoice, if applicable.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

emailAutomationGroupId nullable

integer

The identifier for the email automation group this invoice uses.

grandTotal

number

The invoice grand total.

integer

The identifier for this invoice.

installments

invoice-installment[]

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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.

invoiceStatus

string

enum

unpaid
partially-paid
paid-in-full
canceled
archived

The human-readable name of the current status of this invoice.

invoiceTemplateId nullable

integer

The identifier for the invoice template from which this invoice was created.

isHidden

boolean

Whether or not the invoice should be hidden

issueDate

string

date-time

The date on which this invoice was issued.

items

invoice-item[]

An array of line items for this invoice.

languageCode

string

The Unicode CLDR language tag for the language used in this invoice.

notesToClient

string

Notes to display on the invoice for the client.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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 nullable

number

≥ 0
≤ 100

A decimal number from 0-100, specifying the sales tax percentage.

salesTaxTitle nullable

string

A label to apply to the sales tax percent on the invoice when viewed by the client.

salesTaxTotal

number

The total amount of sales tax on the invoice.

subtotal

number

The invoice subtotal.

taxableSubtotal

number

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

type

string

enum

invoice

The type of object represented.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/Invoice"
      }
    }
  },
  "description": "The invoice object to update.",
  "required": true
}

Receiving the response

`200 OK`

The successfully-updated invoice.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice accepts.

activity read-only

invoice-activity[]

A list of activities that have occurred with this invoice.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice uses.

cancelationMessage

string

Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state.

contact required read-only

contact

The base definition for a contact.

contactId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

contracts read-only

contract[]

An array of linked contracts.

created read-only

string

date-time

The creation date of this invoice.

creditCardOnFile required nullable

credit-card

The credit card on file for this invoice, if applicable.

creditCardTransactions read-only

invoice-credit-card-transaction[]

An array of invoice credit card transactions, showing all attempts to charge a card for this invoice, including approved/declined attempts.

currencyCode read-only

string

Identifies the currency used for this invoice.

currencySymbol read-only

string

The currency symbol for the currency used for this invoice.

customInvoiceId read-only

integer

A client-facing identifier for this invoice, starting at 1000 for each studio.

discountTotal read-only

number

The total amount of all discounts applied to this invoice.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

dueTotal read-only

number

The total amount of this invoice that is due.

emailAutomationGroupId nullable

integer

The identifier for the email automation group this invoice uses.

finalDueDate nullable read-only

string

date-time

The date on which this invoice must be paid in full.

grandTotal

number

The invoice grand total.

integer

The identifier for this invoice.

installments

invoice-installment[]

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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.

invoiceStatus

string

enum

unpaid
partially-paid
paid-in-full
canceled
archived

The human-readable name of the current status of this invoice.

invoiceTemplateId nullable

integer

The identifier for the invoice template from which this invoice was created.

isHidden

boolean

Whether or not the invoice should be hidden

issueDate

string

date-time

The date on which this invoice was issued.

items

invoice-item[]

An array of line items for this invoice.

languageCode

string

The Unicode CLDR language tag for the language used in this invoice.

links required read-only

object

notesToClient

string

Notes to display on the invoice for the client.

paidTotal read-only

number

The total amount of this invoice that has been paid.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

payments read-only

invoice-payment[]

An array of invoice payments, showing a history of all payments made on this invoice.

publicId read-only

string

^[a-fA-F0-9]{32}$

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

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

retainerTotal read-only

number

The total amount for the invoice retainer.

salesTaxPercent nullable

number

≥ 0
≤ 100

A decimal number from 0-100, specifying the sales tax percentage.

salesTaxTitle nullable

string

A label to apply to the sales tax percent on the invoice when viewed by the client.

salesTaxTotal

number

The total amount of sales tax on the invoice.

subtotal

number

The invoice subtotal.

taxableSubtotal

number

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

type

string

enum

invoice

The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

`409 Conflict`

In certain cases, we respond with a 409 Conflict HTTP response if the state of the invoice does not allow the requested change. For example, if the invoice is partially paid and the request attempts to add a discount, we will respond accordingly. Inspect the error response message for information about the conflict.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Invoice"
        }
      }
    },
    "description": "The successfully-updated invoice."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "409": {
    "description": "In certain cases, we respond with a `409 Conflict` HTTP response if the\nstate of the invoice does not allow the requested change. For example,\nif the invoice is partially paid and the request attempts to add a\ndiscount, we will respond accordingly. Inspect the error response\nmessage for information about the conflict."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Deletes a linked contract from a invoice.

Removes the linked contract from the invoice.

delete

/studio/brand/{brandId}/invoice/{invoiceId}/contract/{contractId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
contractId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier A contract identifier.
invoiceId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An invoice identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

`200 OK`

Responds with the invoice on success.

Headers

Header	Description
Content-Location	`string` uri The URL of the invoice in the response body.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice accepts.

activity read-only

invoice-activity[]

A list of activities that have occurred with this invoice.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice uses.

cancelationMessage

string

Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state.

contact required read-only

contact

The base definition for a contact.

contactId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

contracts read-only

contract[]

An array of linked contracts.

created read-only

string

date-time

The creation date of this invoice.

creditCardOnFile required nullable

credit-card

The credit card on file for this invoice, if applicable.

creditCardTransactions read-only

invoice-credit-card-transaction[]

An array of invoice credit card transactions, showing all attempts to charge a card for this invoice, including approved/declined attempts.

currencyCode read-only

string

Identifies the currency used for this invoice.

currencySymbol read-only

string

The currency symbol for the currency used for this invoice.

customInvoiceId read-only

integer

A client-facing identifier for this invoice, starting at 1000 for each studio.

discountTotal read-only

number

The total amount of all discounts applied to this invoice.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

dueTotal read-only

number

The total amount of this invoice that is due.

emailAutomationGroupId nullable

integer

The identifier for the email automation group this invoice uses.

finalDueDate nullable read-only

string

date-time

The date on which this invoice must be paid in full.

grandTotal

number

The invoice grand total.

integer

The identifier for this invoice.

installments

invoice-installment[]

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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.

invoiceStatus

string

enum

unpaid
partially-paid
paid-in-full
canceled
archived

The human-readable name of the current status of this invoice.

invoiceTemplateId nullable

integer

The identifier for the invoice template from which this invoice was created.

isHidden

boolean

Whether or not the invoice should be hidden

issueDate

string

date-time

The date on which this invoice was issued.

items

invoice-item[]

An array of line items for this invoice.

languageCode

string

The Unicode CLDR language tag for the language used in this invoice.

links required read-only

object

notesToClient

string

Notes to display on the invoice for the client.

paidTotal read-only

number

The total amount of this invoice that has been paid.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

payments read-only

invoice-payment[]

An array of invoice payments, showing a history of all payments made on this invoice.

publicId read-only

string

^[a-fA-F0-9]{32}$

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

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

retainerTotal read-only

number

The total amount for the invoice retainer.

salesTaxPercent nullable

number

≥ 0
≤ 100

A decimal number from 0-100, specifying the sales tax percentage.

salesTaxTitle nullable

string

A label to apply to the sales tax percent on the invoice when viewed by the client.

salesTaxTotal

number

The total amount of sales tax on the invoice.

subtotal

number

The invoice subtotal.

taxableSubtotal

number

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

type

string

enum

invoice

The type of object represented.

`404 Not Found`

The requested resource could not be found.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Invoice"
        }
      }
    },
    "description": "Responds with the invoice on success.",
    "headers": {
      "Content-Location": {
        "description": "The URL of the invoice in the response body.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "404": {
    "$ref": "#/components/responses/notFoundError"
  }
}

Adds a linked contract to an invoice.

Links the given contract to the invoice.

put

/studio/brand/{brandId}/invoice/{invoiceId}/contract/{contractId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
contractId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier A contract identifier.
invoiceId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An invoice identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

`200 OK`

Responds with the invoice on success.

Headers

Header	Description
Content-Location	`string` uri The URL of the invoice in the response body.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice accepts.

activity read-only

invoice-activity[]

A list of activities that have occurred with this invoice.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice uses.

cancelationMessage

string

Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state.

contact required read-only

contact

The base definition for a contact.

contactId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

contracts read-only

contract[]

An array of linked contracts.

created read-only

string

date-time

The creation date of this invoice.

creditCardOnFile required nullable

credit-card

The credit card on file for this invoice, if applicable.

creditCardTransactions read-only

invoice-credit-card-transaction[]

An array of invoice credit card transactions, showing all attempts to charge a card for this invoice, including approved/declined attempts.

currencyCode read-only

string

Identifies the currency used for this invoice.

currencySymbol read-only

string

The currency symbol for the currency used for this invoice.

customInvoiceId read-only

integer

A client-facing identifier for this invoice, starting at 1000 for each studio.

discountTotal read-only

number

The total amount of all discounts applied to this invoice.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

dueTotal read-only

number

The total amount of this invoice that is due.

emailAutomationGroupId nullable

integer

The identifier for the email automation group this invoice uses.

finalDueDate nullable read-only

string

date-time

The date on which this invoice must be paid in full.

grandTotal

number

The invoice grand total.

integer

The identifier for this invoice.

installments

invoice-installment[]

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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.

invoiceStatus

string

enum

unpaid
partially-paid
paid-in-full
canceled
archived

The human-readable name of the current status of this invoice.

invoiceTemplateId nullable

integer

The identifier for the invoice template from which this invoice was created.

isHidden

boolean

Whether or not the invoice should be hidden

issueDate

string

date-time

The date on which this invoice was issued.

items

invoice-item[]

An array of line items for this invoice.

languageCode

string

The Unicode CLDR language tag for the language used in this invoice.

links required read-only

object

notesToClient

string

Notes to display on the invoice for the client.

paidTotal read-only

number

The total amount of this invoice that has been paid.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

payments read-only

invoice-payment[]

An array of invoice payments, showing a history of all payments made on this invoice.

publicId read-only

string

^[a-fA-F0-9]{32}$

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

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

retainerTotal read-only

number

The total amount for the invoice retainer.

salesTaxPercent nullable

number

≥ 0
≤ 100

A decimal number from 0-100, specifying the sales tax percentage.

salesTaxTitle nullable

string

A label to apply to the sales tax percent on the invoice when viewed by the client.

salesTaxTotal

number

The total amount of sales tax on the invoice.

subtotal

number

The invoice subtotal.

taxableSubtotal

number

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

type

string

enum

invoice

The type of object represented.

`404 Not Found`

The requested resource could not be found.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

`409 Conflict`

If the invoice is linked to a different contract, then we respond with a 409 Conflict response.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Invoice"
        }
      }
    },
    "description": "Responds with the invoice on success.",
    "headers": {
      "Content-Location": {
        "description": "The URL of the invoice in the response body.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "404": {
    "$ref": "#/components/responses/notFoundError"
  },
  "409": {
    "content": {
      "application/problem+json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    },
    "description": "If the invoice is linked to a different contract, then we respond\nwith a `409 Conflict` response."
  }
}

Remove all discounts from an invoice

When attempting to remove the discounts from an invoice, we will attempt to rebalance the installments on that invoice. We do not attempt to modify an installment if it is marked as "fixed," however; we will only update installments that are percentage-based.

delete

/studio/brand/{brandId}/invoice/{invoiceId}/discount

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An invoice identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

`204 No Content`

The resource was successfully deleted.

`409 Conflict`

If the state of the invoice or any of its installments do not allow the discounts to be removed, then we respond with a 409 Conflict HTTP response. See the full description of this operation for more details.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "204": {
    "$ref": "#/components/responses/deleteSuccess"
  },
  "409": {
    "description": "If the state of the invoice or any of its installments do not allow\nthe discounts to be removed, then we respond with a `409 Conflict`\nHTTP response. See the full description of this operation for more\ndetails."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Apply a discount to an invoice

Discounts may be applied only to unpaid invoices, and only one discount may be applied at a time.

When attempting to apply a discount to an invoice, we will attempt to rebalance the installments on that invoice. We do not attempt to modify an installment if it is marked as "fixed," however; we will only update installments that are percentage-based.

With this in mind, there are several constraints imposed, each of which will response with a 409 Conflict HTTP response, if encountered:

We cannot apply a discount if it would cause the grand total to become less than the total of all fixed installments on the invoice.
We cannot apply a discount if the invoice contains only fixed installments, since we cannot rebalance them.
We cannot apply a discount if doing so would cause one or more of the installments to become less than the minimum allowed value (1.00) when rebalanced.

If we do not encounter any of the above conditions, then we can update the percentage-based installments on the invoice without any problems.

post

/studio/brand/{brandId}/invoice/{invoiceId}/discount

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An invoice identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice discount to add to the invoice.

application/vnd.shootproof+json

Property	Description
description	`string` A description of the discount for use as display text on the invoice.
discountType	`string` enum percent fixed The type of discount represented by the value.
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.
name	`string` ≤ 20 characters A short name to use for this discount.
type	`string` enum invoice-discount Type The type of resource represented.
value	`number` = 0 The amount this discount represents. This value may be a fixed amount (if `discountType` is "fixed") or a number between `0.0` and `100.0`, representing a percentage of the total invoice (if `discountType` is "percent"). The discount value is allowed to be greater than the grand total of the invoice. In this case, the grand total will never be less than `0.00`.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceDiscount"
      }
    }
  },
  "description": "The invoice discount to add to the invoice.",
  "required": true
}

Receiving the response

`200 OK`

Responds with the invoice on success.

Headers

Header	Description
Content-Location	`string` uri The URL of the invoice in the response body.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice accepts.

activity read-only

invoice-activity[]

A list of activities that have occurred with this invoice.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice uses.

cancelationMessage

string

Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state.

contact required read-only

contact

The base definition for a contact.

contactId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

contracts read-only

contract[]

An array of linked contracts.

created read-only

string

date-time

The creation date of this invoice.

creditCardOnFile required nullable

credit-card

The credit card on file for this invoice, if applicable.

creditCardTransactions read-only

invoice-credit-card-transaction[]

An array of invoice credit card transactions, showing all attempts to charge a card for this invoice, including approved/declined attempts.

currencyCode read-only

string

Identifies the currency used for this invoice.

currencySymbol read-only

string

The currency symbol for the currency used for this invoice.

customInvoiceId read-only

integer

A client-facing identifier for this invoice, starting at 1000 for each studio.

discountTotal read-only

number

The total amount of all discounts applied to this invoice.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

dueTotal read-only

number

The total amount of this invoice that is due.

emailAutomationGroupId nullable

integer

The identifier for the email automation group this invoice uses.

finalDueDate nullable read-only

string

date-time

The date on which this invoice must be paid in full.

grandTotal

number

The invoice grand total.

integer

The identifier for this invoice.

installments

invoice-installment[]

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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.

invoiceStatus

string

enum

unpaid
partially-paid
paid-in-full
canceled
archived

The human-readable name of the current status of this invoice.

invoiceTemplateId nullable

integer

The identifier for the invoice template from which this invoice was created.

isHidden

boolean

Whether or not the invoice should be hidden

issueDate

string

date-time

The date on which this invoice was issued.

items

invoice-item[]

An array of line items for this invoice.

languageCode

string

The Unicode CLDR language tag for the language used in this invoice.

links required read-only

object

notesToClient

string

Notes to display on the invoice for the client.

paidTotal read-only

number

The total amount of this invoice that has been paid.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

payments read-only

invoice-payment[]

An array of invoice payments, showing a history of all payments made on this invoice.

publicId read-only

string

^[a-fA-F0-9]{32}$

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

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

retainerTotal read-only

number

The total amount for the invoice retainer.

salesTaxPercent nullable

number

≥ 0
≤ 100

A decimal number from 0-100, specifying the sales tax percentage.

salesTaxTitle nullable

string

A label to apply to the sales tax percent on the invoice when viewed by the client.

salesTaxTotal

number

The total amount of sales tax on the invoice.

subtotal

number

The invoice subtotal.

taxableSubtotal

number

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

type

string

enum

invoice

The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

`409 Conflict`

If the state of the invoice or any of its installments do not allow this discount to be applied, then we respond with a 409 Conflict HTTP response. See the full description of this operation for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Invoice"
        }
      }
    },
    "description": "Responds with the invoice on success.",
    "headers": {
      "Content-Location": {
        "description": "The URL of the invoice in the response body.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "409": {
    "content": {
      "application/problem+json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    },
    "description": "If the state of the invoice or any of its installments do not allow\nthis discount to be applied, then we respond with a `409 Conflict`\nHTTP response. See the full description of this operation for more\ndetails."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Remove a discount from an invoice

When attempting to remove the discount from an invoice, we will attempt to rebalance the installments on that invoice. We do not attempt to modify an installment if it is marked as "fixed," however; we will only update installments that are percentage-based.

delete

/studio/brand/{brandId}/invoice/{invoiceId}/discount/{invoiceDiscountId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceDiscountId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The invoice discount identifier.
invoiceId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An invoice identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Receiving the response

`204 No Content`

The resource was successfully deleted.

`409 Conflict`

If the state of the invoice or any of its installments do not allow this discount to be removed, then we respond with a 409 Conflict HTTP response. See the full description of this operation for more details.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "204": {
    "$ref": "#/components/responses/deleteSuccess"
  },
  "409": {
    "description": "If the state of the invoice or any of its installments do not allow\nthis discount to be removed, then we respond with a `409 Conflict`\nHTTP response. See the full description of this operation for more\ndetails."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Partially update a discount on an invoice

When attempting to update a discount on an invoice, we will attempt to rebalance the installments on that invoice. We do not attempt to modify an installment if it is marked as "fixed," however; we will only update installments that are percentage-based.

With this in mind, there are several constraints imposed, each of which will response with a 409 Conflict HTTP response, if encountered:

We cannot modify a discount if it would cause the grand total to become less than the total of all fixed installments on the invoice.
We cannot modify a discount if the invoice contains only fixed installments, since we cannot rebalance them.
We cannot modify a discount if doing so would cause one or more of the installments to become less than the minimum allowed value (1.00) when rebalanced.

If we do not encounter any of the above conditions, then we can update the percentage-based installments on the invoice without any problems.

patch

/studio/brand/{brandId}/invoice/{invoiceId}/discount/{invoiceDiscountId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceDiscountId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The invoice discount identifier.
invoiceId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An invoice identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice discount to update. Only provide those properties that need updating.

application/vnd.shootproof+json

Property	Description
description	`string` A description of the discount for use as display text on the invoice.
discountType	`string` enum percent fixed The type of discount represented by the value.
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.
name	`string` ≤ 20 characters A short name to use for this discount.
type	`string` enum invoice-discount Type The type of resource represented.
value	`number` = 0 The amount this discount represents. This value may be a fixed amount (if `discountType` is "fixed") or a number between `0.0` and `100.0`, representing a percentage of the total invoice (if `discountType` is "percent"). The discount value is allowed to be greater than the grand total of the invoice. In this case, the grand total will never be less than `0.00`.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceDiscount"
      }
    }
  },
  "description": "The invoice discount to update. Only provide those properties\nthat need updating.",
  "required": true
}

Receiving the response

`200 OK`

Responds with the invoice on success.

Headers

Header	Description
Content-Location	`string` uri The URL of the invoice in the response body.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice accepts.

activity read-only

invoice-activity[]

A list of activities that have occurred with this invoice.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice uses.

cancelationMessage

string

Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state.

contact required read-only

contact

The base definition for a contact.

contactId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

contracts read-only

contract[]

An array of linked contracts.

created read-only

string

date-time

The creation date of this invoice.

creditCardOnFile required nullable

credit-card

The credit card on file for this invoice, if applicable.

creditCardTransactions read-only

invoice-credit-card-transaction[]

An array of invoice credit card transactions, showing all attempts to charge a card for this invoice, including approved/declined attempts.

currencyCode read-only

string

Identifies the currency used for this invoice.

currencySymbol read-only

string

The currency symbol for the currency used for this invoice.

customInvoiceId read-only

integer

A client-facing identifier for this invoice, starting at 1000 for each studio.

discountTotal read-only

number

The total amount of all discounts applied to this invoice.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

dueTotal read-only

number

The total amount of this invoice that is due.

emailAutomationGroupId nullable

integer

The identifier for the email automation group this invoice uses.

finalDueDate nullable read-only

string

date-time

The date on which this invoice must be paid in full.

grandTotal

number

The invoice grand total.

integer

The identifier for this invoice.

installments

invoice-installment[]

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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.

invoiceStatus

string

enum

unpaid
partially-paid
paid-in-full
canceled
archived

The human-readable name of the current status of this invoice.

invoiceTemplateId nullable

integer

The identifier for the invoice template from which this invoice was created.

isHidden

boolean

Whether or not the invoice should be hidden

issueDate

string

date-time

The date on which this invoice was issued.

items

invoice-item[]

An array of line items for this invoice.

languageCode

string

The Unicode CLDR language tag for the language used in this invoice.

links required read-only

object

notesToClient

string

Notes to display on the invoice for the client.

paidTotal read-only

number

The total amount of this invoice that has been paid.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

payments read-only

invoice-payment[]

An array of invoice payments, showing a history of all payments made on this invoice.

publicId read-only

string

^[a-fA-F0-9]{32}$

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

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

retainerTotal read-only

number

The total amount for the invoice retainer.

salesTaxPercent nullable

number

≥ 0
≤ 100

A decimal number from 0-100, specifying the sales tax percentage.

salesTaxTitle nullable

string

A label to apply to the sales tax percent on the invoice when viewed by the client.

salesTaxTotal

number

The total amount of sales tax on the invoice.

subtotal

number

The invoice subtotal.

taxableSubtotal

number

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

type

string

enum

invoice

The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

`409 Conflict`

If the state of the invoice or any of its installments do not allow this discount to be updated, then we respond with a 409 Conflict HTTP response. See the full description of this operation for more details.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Invoice"
        }
      }
    },
    "description": "Responds with the invoice on success.",
    "headers": {
      "Content-Location": {
        "description": "The URL of the invoice in the response body.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "409": {
    "description": "If the state of the invoice or any of its installments do not allow\nthis discount to be updated, then we respond with a `409 Conflict`\nHTTP response. See the full description of this operation for more\ndetails."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Update a discount on an invoice

With this in mind, there are several constraints imposed, each of which will response with a 409 Conflict HTTP response, if encountered:

We cannot modify a discount if it would cause the grand total to become less than the total of all fixed installments on the invoice.
We cannot modify a discount if the invoice contains only fixed installments, since we cannot rebalance them.
We cannot modify a discount if doing so would cause one or more of the installments to become less than the minimum allowed value (1.00) when rebalanced.

If we do not encounter any of the above conditions, then we can update the percentage-based installments on the invoice without any problems.

put

/studio/brand/{brandId}/invoice/{invoiceId}/discount/{invoiceDiscountId}

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceDiscountId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The invoice discount identifier.
invoiceId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An invoice identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The updated invoice discount.

application/vnd.shootproof+json

Property	Description
description	`string` A description of the discount for use as display text on the invoice.
discountType	`string` enum percent fixed The type of discount represented by the value.
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.
name	`string` ≤ 20 characters A short name to use for this discount.
type	`string` enum invoice-discount Type The type of resource represented.
value	`number` = 0 The amount this discount represents. This value may be a fixed amount (if `discountType` is "fixed") or a number between `0.0` and `100.0`, representing a percentage of the total invoice (if `discountType` is "percent"). The discount value is allowed to be greater than the grand total of the invoice. In this case, the grand total will never be less than `0.00`.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceDiscount"
      }
    }
  },
  "description": "The updated invoice discount.",
  "required": true
}

Receiving the response

`200 OK`

Responds with the invoice on success.

Headers

Header	Description
Content-Location	`string` uri The URL of the invoice in the response body.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice accepts.

activity read-only

invoice-activity[]

A list of activities that have occurred with this invoice.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice uses.

cancelationMessage

string

Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state.

contact required read-only

contact

The base definition for a contact.

contactId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

contracts read-only

contract[]

An array of linked contracts.

created read-only

string

date-time

The creation date of this invoice.

creditCardOnFile required nullable

credit-card

The credit card on file for this invoice, if applicable.

creditCardTransactions read-only

invoice-credit-card-transaction[]

An array of invoice credit card transactions, showing all attempts to charge a card for this invoice, including approved/declined attempts.

currencyCode read-only

string

Identifies the currency used for this invoice.

currencySymbol read-only

string

The currency symbol for the currency used for this invoice.

customInvoiceId read-only

integer

A client-facing identifier for this invoice, starting at 1000 for each studio.

discountTotal read-only

number

The total amount of all discounts applied to this invoice.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

dueTotal read-only

number

The total amount of this invoice that is due.

emailAutomationGroupId nullable

integer

The identifier for the email automation group this invoice uses.

finalDueDate nullable read-only

string

date-time

The date on which this invoice must be paid in full.

grandTotal

number

The invoice grand total.

integer

The identifier for this invoice.

installments

invoice-installment[]

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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.

invoiceStatus

string

enum

unpaid
partially-paid
paid-in-full
canceled
archived

The human-readable name of the current status of this invoice.

invoiceTemplateId nullable

integer

The identifier for the invoice template from which this invoice was created.

isHidden

boolean

Whether or not the invoice should be hidden

issueDate

string

date-time

The date on which this invoice was issued.

items

invoice-item[]

An array of line items for this invoice.

languageCode

string

The Unicode CLDR language tag for the language used in this invoice.

links required read-only

object

notesToClient

string

Notes to display on the invoice for the client.

paidTotal read-only

number

The total amount of this invoice that has been paid.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

payments read-only

invoice-payment[]

An array of invoice payments, showing a history of all payments made on this invoice.

publicId read-only

string

^[a-fA-F0-9]{32}$

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

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

retainerTotal read-only

number

The total amount for the invoice retainer.

salesTaxPercent nullable

number

≥ 0
≤ 100

A decimal number from 0-100, specifying the sales tax percentage.

salesTaxTitle nullable

string

A label to apply to the sales tax percent on the invoice when viewed by the client.

salesTaxTotal

number

The total amount of sales tax on the invoice.

subtotal

number

The invoice subtotal.

taxableSubtotal

number

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

type

string

enum

invoice

The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

`409 Conflict`

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

Validation Error Example

{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}

Forbidden Error Example

{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}

Not Found Error Example

{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}

Server Error Example

{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}

Unauthorized Error Example

{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Invoice"
        }
      }
    },
    "description": "Responds with the invoice on success.",
    "headers": {
      "Content-Location": {
        "description": "The URL of the invoice in the response body.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "409": {
    "description": "If the state of the invoice or any of its installments do not allow\nthis discount to be updated, then we respond with a `409 Conflict`\nHTTP response. See the full description of this operation for more\ndetails."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Sends an email message to the contact for an invoice.

post

/studio/brand/{brandId}/invoice/{invoiceId}/email

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An invoice identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice email object used to send an email message.

application/vnd.shootproof+json

Property	Description
body	`string` ≤ 10000 characters The message to include in the body of the email.
buttonText	`string` ≤ 25 characters The text for the call-to-action button in the email body.
emailTemplateId	`integer` The identifier for the email template chosen (if applicable).
headline	`string` ≤ 100 characters The headline to use in the email body.
recipientEmails	`string[]` Email address(es) to send the email to. If provided, must be an array of valid email addresses. Optional, but may be required by child schemas.
subject	`string` ≤ 200 characters The subject line for the email message.
type	`string` enum email 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.

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceEmail"
      }
    }
  },
  "description": "The invoice email object used to send an email message.",
  "required": true
}

Receiving the response

`202 Accepted`

Responds with the invoice on success.

Headers

Header	Description
Content-Location	`string` uri The URL of the invoice in the response body.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice accepts.

activity read-only

invoice-activity[]

A list of activities that have occurred with this invoice.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice uses.

cancelationMessage

string

Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state.

contact required read-only

contact

The base definition for a contact.

contactId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

contracts read-only

contract[]

An array of linked contracts.

created read-only

string

date-time

The creation date of this invoice.

creditCardOnFile required nullable

credit-card

The credit card on file for this invoice, if applicable.

creditCardTransactions read-only

invoice-credit-card-transaction[]

An array of invoice credit card transactions, showing all attempts to charge a card for this invoice, including approved/declined attempts.

currencyCode read-only

string

Identifies the currency used for this invoice.

currencySymbol read-only

string

The currency symbol for the currency used for this invoice.

customInvoiceId read-only

integer

A client-facing identifier for this invoice, starting at 1000 for each studio.

discountTotal read-only

number

The total amount of all discounts applied to this invoice.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

dueTotal read-only

number

The total amount of this invoice that is due.

emailAutomationGroupId nullable

integer

The identifier for the email automation group this invoice uses.

finalDueDate nullable read-only

string

date-time

The date on which this invoice must be paid in full.

grandTotal

number

The invoice grand total.

integer

The identifier for this invoice.

installments

invoice-installment[]

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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.

invoiceStatus

string

enum

unpaid
partially-paid
paid-in-full
canceled
archived

The human-readable name of the current status of this invoice.

invoiceTemplateId nullable

integer

The identifier for the invoice template from which this invoice was created.

isHidden

boolean

Whether or not the invoice should be hidden

issueDate

string

date-time

The date on which this invoice was issued.

items

invoice-item[]

An array of line items for this invoice.

languageCode

string

The Unicode CLDR language tag for the language used in this invoice.

links required read-only

object

notesToClient

string

Notes to display on the invoice for the client.

paidTotal read-only

number

The total amount of this invoice that has been paid.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

payments read-only

invoice-payment[]

An array of invoice payments, showing a history of all payments made on this invoice.

publicId read-only

string

^[a-fA-F0-9]{32}$

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

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

retainerTotal read-only

number

The total amount for the invoice retainer.

salesTaxPercent nullable

number

≥ 0
≤ 100

A decimal number from 0-100, specifying the sales tax percentage.

salesTaxTitle nullable

string

A label to apply to the sales tax percent on the invoice when viewed by the client.

salesTaxTotal

number

The total amount of sales tax on the invoice.

subtotal

number

The invoice subtotal.

taxableSubtotal

number

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

type

string

enum

invoice

The type of object represented.

`400 Bad Request`

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "202": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Invoice"
        }
      }
    },
    "description": "Responds with the invoice on success.",
    "headers": {
      "Content-Location": {
        "description": "The URL of the invoice in the response body.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Creates a payment for an invoice.

post

/studio/brand/{brandId}/invoice/{invoiceId}/payment

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An invoice identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice payment object to create.

application/vnd.shootproof+json

Property	Description
amount	`number` The amount of this payment.
amountLessRefunds nullable	`number` The total amount of this payment, minus any refunds applied to it. This is `null` if the payment is a refund.
billingPostalCode	`string` ^[A-Za-z0-9 -]{0,10}$ The billing address postal code. May be `null` for invoice payments made prior to the introduction of this value.
checkNumber nullable	`integer` If this payment was made by check, the check number for the payment.
creditCard	either `credit-card` Invoice Credit Card or `boolean` When creating a new invoice payment, include the credit card property with this object, if paying by credit card. If you wish to use the invoice credit card that is already on file, set this property to boolean `true`. This property is `null` in responses.
emailAddress	`string` email The email address for the person making the payment.
id	`integer` The identifier for this invoice payment.
nameOnCard	`string` The card-holder name.
note nullable	`string` A note about the payment.
paymentDate	`string` date-time The date on which this payment was made.
paymentFundsType	`string` enum cash check credit-card The type of funds received for this payment.
type	`string` enum invoice-payment The type of object represented.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoicePayment"
      }
    }
  },
  "description": "The invoice payment object to create.",
  "required": true
}

Receiving the response

`202 Accepted`

Responds with the invoice on success.

Headers

Header	Description
Content-Location	`string` uri The URL of the invoice in the response body.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice accepts.

activity read-only

invoice-activity[]

A list of activities that have occurred with this invoice.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice uses.

cancelationMessage

string

Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state.

contact required read-only

contact

The base definition for a contact.

contactId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

contracts read-only

contract[]

An array of linked contracts.

created read-only

string

date-time

The creation date of this invoice.

creditCardOnFile required nullable

credit-card

The credit card on file for this invoice, if applicable.

creditCardTransactions read-only

invoice-credit-card-transaction[]

An array of invoice credit card transactions, showing all attempts to charge a card for this invoice, including approved/declined attempts.

currencyCode read-only

string

Identifies the currency used for this invoice.

currencySymbol read-only

string

The currency symbol for the currency used for this invoice.

customInvoiceId read-only

integer

A client-facing identifier for this invoice, starting at 1000 for each studio.

discountTotal read-only

number

The total amount of all discounts applied to this invoice.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

dueTotal read-only

number

The total amount of this invoice that is due.

emailAutomationGroupId nullable

integer

The identifier for the email automation group this invoice uses.

finalDueDate nullable read-only

string

date-time

The date on which this invoice must be paid in full.

grandTotal

number

The invoice grand total.

integer

The identifier for this invoice.

installments

invoice-installment[]

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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.

invoiceStatus

string

enum

unpaid
partially-paid
paid-in-full
canceled
archived

The human-readable name of the current status of this invoice.

invoiceTemplateId nullable

integer

The identifier for the invoice template from which this invoice was created.

isHidden

boolean

Whether or not the invoice should be hidden

issueDate

string

date-time

The date on which this invoice was issued.

items

invoice-item[]

An array of line items for this invoice.

languageCode

string

The Unicode CLDR language tag for the language used in this invoice.

links required read-only

object

notesToClient

string

Notes to display on the invoice for the client.

paidTotal read-only

number

The total amount of this invoice that has been paid.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

payments read-only

invoice-payment[]

An array of invoice payments, showing a history of all payments made on this invoice.

publicId read-only

string

^[a-fA-F0-9]{32}$

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

retainerFixedAmount nullable

number

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

retainerPercent nullable

number

≥ 1
≤ 100

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

retainerTotal read-only

number

The total amount for the invoice retainer.

salesTaxPercent nullable

number

≥ 0
≤ 100

A decimal number from 0-100, specifying the sales tax percentage.

salesTaxTitle nullable

string

A label to apply to the sales tax percent on the invoice when viewed by the client.

salesTaxTotal

number

The total amount of sales tax on the invoice.

subtotal

number

The invoice subtotal.

taxableSubtotal

number

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

type

string

enum

invoice

The type of object represented.

`400 Bad Request`

Validation error response; includes special handling for credit card transaction errors. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

errors

object

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

transactionErrors

object

If the error response includes credit card transaction errors that cannot be related back to a value on the request, this info.transactionErrors object is included. The response will be a 400 Bad Request response and contain this info.transactionErrors property.

Each property name in the transactionErrors object is a key that identifies a unique transaction error type. The value is a human-readable string in English language only, which could be displayed in a client if necessary. Otherwise, it is recommended that the client switch on the transactionErrors key names to display a translated error message in the end user's preferred language describing the error that occurred.

Possible info.transactionErrors keys:

noResponseReceived: No response received from payment gateway.
declined: Transaction was declined.
gatewayRejected: The payment gateway rejected transaction.
unexpected: An unexpected error occurred; value will be raw error message directly from the payment gateway.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

`402 Payment Required`

If using creditCard with a boolean value true and there is no invoice credit card on file, then we respond with a 402 Payment Required response.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

`409 Conflict`

If the payment gateway has not been configured, then we respond with a 409 Conflict response.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties

Property Description

detail

string

A longer description of of the error encountered.

info

object

Additional information that may be provided to aid in error resolution.

Property Description

reason

string

enum

contract-not-ready-to-countersign
event-photo-count-limit
plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug	Description
`contract-not-ready-to-countersign`	The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action.
`event-photo-count-limit`	The event has reached the maximum number of photos allowed.
`plan-does-not-allow-uploads`	The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.

status

integer

The HTTP status code associated with this error.

title

string

A short description of the error encountered.

type

string

uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "202": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Invoice"
        }
      }
    },
    "description": "Responds with the invoice on success.",
    "headers": {
      "Content-Location": {
        "description": "The URL of the invoice in the response body.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/transactionError"
  },
  "402": {
    "content": {
      "application/problem+json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    },
    "description": "If using `creditCard` with a boolean value `true` and there is no\ninvoice credit card on file, then we respond with a `402 Payment\nRequired` response."
  },
  "409": {
    "content": {
      "application/problem+json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    },
    "description": "If the payment gateway has not been configured, then we respond\nwith a `409 Conflict` response."
  }
}

Creates a refund for an invoice.

post

/studio/brand/{brandId}/invoice/{invoiceId}/refund

Making the request

Example Request

Coming Soon

We’ve got some helpful examples coming your way soon. Stay tuned!

Path Parameters

Property	Description
brandId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier The brand identifier.
invoiceId required	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An invoice identifier.

Header Parameters

Property	Description
Authentication required	`string` The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The invoice refund object to create.

application/vnd.shootproof+json

Property	Description
amount	`number` The amount of the payment to refund.
emailAdditionalMessage nullable	`string` Optional message to include in email sent to client and payer. May include HTML tags, but only whitelisted tags will be included.
invoicePaymentId	`integer` The identifier for the invoice payment to refund.
note nullable	`string` A note about the refund.
refundDate	`string` date-time The date on which this refund was made.
type	`string` enum invoice-refund The type of object represented.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/InvoiceRefund"
      }
    }
  },
  "description": "The invoice refund object to create.",
  "required": true
}

Receiving the response

`202 Accepted`

Responds with the invoice on success.

Headers

Header	Description
Content-Location	`string` uri The URL of the invoice in the response body.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties

Property Description

acceptedPaymentTypes

string[]

enum

cash-check
credit-card

An array of payment types this invoice accepts.

activity read-only

invoice-activity[]

A list of activities that have occurred with this invoice.

brandTheme

brand-theme

A brand theme.

brandThemeId

integer

The identifier for the brand theme this invoice uses.

cancelationMessage

string

Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state.

contact required read-only

contact

The base definition for a contact.

contactId

either

string

uuid

UUID Entity Identifier

integer

Integer Entity Identifier

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

contracts read-only

contract[]

An array of linked contracts.

created read-only

string

date-time

The creation date of this invoice.

creditCardOnFile required nullable

credit-card

The credit card on file for this invoice, if applicable.

creditCardTransactions read-only

invoice-credit-card-transaction[]

An array of invoice credit card transactions, showing all attempts to charge a card for this invoice, including approved/declined attempts.

currencyCode read-only

string

Identifies the currency used for this invoice.

currencySymbol read-only

string

The currency symbol for the currency used for this invoice.

customInvoiceId read-only

integer

A client-facing identifier for this invoice, starting at 1000 for each studio.

discountTotal read-only

number

The total amount of all discounts applied to this invoice.

discounts

invoice-discount[]

An array of discounts applied to this invoice template.

dueTotal read-only

number

The total amount of this invoice that is due.

emailAutomationGroupId nullable

integer

The identifier for the email automation group this invoice uses.

finalDueDate nullable read-only

string

date-time

The date on which this invoice must be paid in full.

grandTotal

number

The invoice grand total.

integer

The identifier for this invoice.

installments

invoice-installment[]

invoiceRetainerLabel nullable

string

enum

non-refundable-payment
deposit
retainer

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.

invoiceStatus

string

enum

unpaid
partially-paid
paid-in-full
canceled
archived

The human-readable name of the current status of this invoice.

invoiceTemplateId nullable

integer

The identifier for the invoice template from which this invoice was created.

isHidden

boolean

Whether or not the invoice should be hidden

issueDate

string

date-time

The date on which this invoice was issued.

items

invoice-item[]

An array of line items for this invoice.

languageCode

string

The Unicode CLDR language tag for the language used in this invoice.

links required read-only

object

notesToClient

string

Notes to display on the invoice for the client.

paidTotal read-only

number

The total amount of this invoice that has been paid.

paymentConfirmationText

string

A message sent to the client upon receipt of payment.

payments read-only

invoice-payment[]