Invoice Collection

Description

A collection of invoices

Properties

Property Description
items

A collection of resources returned in the current result set.

Property Description
amountDue nullable

The total amount remaining to be paid on this invoice against the grand total.

contactId

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

contactName

The full name of the contact associated with this invoice.

contracts

An array of linked contracts.

created

The creation date of this invoice.

currencyCode

Identifies the currency represented in price.

currencySymbol

The currency symbol for the currency used for this invoice.

customInvoiceId

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

finalDueDate nullable

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

grandTotal nullable

The grand total of all items on the invoice, including any applicable sales tax.

id

The identifier for this invoice.

installments

An array of invoice installments, defining the installment schedule for this invoice.

invoiceStatus

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

isHidden

Whether or not the invoice is hidden

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

publicId

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

retainerFixedAmount nullable

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

retainerPercent nullable

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

type

The type of object represented.

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

meta required read-only

Metadata describing the current result set.

Property Description
currentPage

The current page of results returned.

invoiceTotals required

Total counts for various types of invoices in various states.

rows

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

totalItems

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

totalPages

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

type

The 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.

{
  "description": "A collection of invoices",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "description": "An invoice as viewed from a collection.",
        "properties": {
          "amountDue": {
            "description": "The total amount remaining to be paid on this invoice against the\ngrand total.",
            "nullable": true,
            "type": "number"
          },
          "contactId": {
            "$ref": "#/components/schemas/Id"
          },
          "contactName": {
            "description": "The full name of the contact associated with this invoice.",
            "type": "string"
          },
          "contracts": {
            "description": "An array of linked contracts.",
            "items": {
              "$ref": "#/components/schemas/ContractMinimal"
            },
            "type": "array"
          },
          "created": {
            "description": "The creation date of this invoice.",
            "format": "date-time",
            "type": "string"
          },
          "currencyCode": {
            "description": "Identifies the currency represented in `price`.",
            "type": "string"
          },
          "currencySymbol": {
            "description": "The currency symbol for the currency used for this invoice.",
            "type": "string"
          },
          "customInvoiceId": {
            "description": "A client-facing identifier for this invoice, starting at 1000 for\neach studio.",
            "type": "integer"
          },
          "finalDueDate": {
            "description": "The date on which this invoice must be paid in full.",
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "grandTotal": {
            "description": "The grand total of all items on the invoice, including any\napplicable sales tax.",
            "nullable": true,
            "type": "number"
          },
          "id": {
            "description": "The identifier for this invoice.",
            "type": "integer"
          },
          "installments": {
            "description": "An array of invoice installments, defining the installment schedule\nfor this invoice.",
            "items": {
              "$ref": "#/components/schemas/InvoiceInstallment"
            },
            "type": "array"
          },
          "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"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "publicId": {
            "description": "The public identifier for this invoice (may be used in the portal\nwebsite).",
            "pattern": "^[a-fA-F0-9]{32}$",
            "type": "string"
          },
          "retainerFixedAmount": {
            "description": "Suggested fixed amount of retainer. If a retainer is defined, one of\n`retainerPercent` or `retainerFixedAmount` will be non-null.",
            "nullable": true,
            "type": "number"
          },
          "retainerPercent": {
            "description": "Suggested amount of retainer in a percentage from 1-100. If a\nretainer is defined, one of `retainerPercent` or\n`retainerFixedAmount` will be non-null.",
            "maximum": 100,
            "minimum": 1,
            "nullable": true,
            "type": "number"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "invoice"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "links",
          "id",
          "publicId",
          "customInvoiceId",
          "invoiceStatusId",
          "invoiceStatus",
          "contactId",
          "contactName",
          "finalDueDate",
          "currencyCode",
          "grandTotal",
          "amountDue",
          "created",
          "isHidden"
        ],
        "title": "Invoice",
        "type": "object"
      },
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "invoiceTotals": {
          "description": "Total counts for various types of invoices in various states.",
          "properties": {
            "all": {
              "description": "The total number of invoices for the brand.",
              "type": "integer"
            },
            "awaiting_payment": {
              "description": "The total number of invoices for the brand considered\nto be awaiting payment",
              "type": "integer"
            },
            "canceled_hidden": {
              "description": "The total number of invoices for the brand considered\nto be canceled OR hidden",
              "type": "integer"
            },
            "overdue": {
              "description": "The total number of invoices for the brand considered\nto be overdue",
              "type": "integer"
            },
            "paid": {
              "description": "The total number of invoices for the brand considered\nto be paid",
              "type": "integer"
            }
          },
          "required": [
            "all",
            "awaiting_payment",
            "overdue",
            "paid",
            "canceled_hidden"
          ],
          "type": "object"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "required": [
        "invoiceTotals"
      ],
      "type": "object"
    },
    "type": {
      "description": "The model type for the list response object.",
      "enum": [
        "invoice-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Invoice Collection",
  "type": "object"
}