Invoice In List

Description

invoice
Invoice

An invoice as viewed from a collection.

Properties

Property Description
amountDue nullable
number

The total amount remaining to be paid on this invoice against the grand total.
contactId
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.
contactName
string

The full name of the contact associated with this invoice.
contracts
contract[]
Contract Minimal

An array of linked contracts.
created
string
date-time

The creation date of this invoice.
currencyCode
string

Identifies the currency represented in price.
currencySymbol
string

The currency symbol for the currency used for this invoice.
customInvoiceId
integer

A client-facing identifier for this invoice, starting at 1000 for each studio.
finalDueDate nullable
string
date-time

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

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

The identifier for this invoice.
installments
invoice-installment[]
Invoice Installment

An array of invoice installments, defining the installment schedule for this invoice.
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
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.
publicId
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.
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.

{
  "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"
}
Invoice