Invoice Minimal

Description

A minimal representation of an invoice.

Properties

Property Description
customInvoiceId read-only

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

finalDueDate nullable read-only

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

id

The identifier for this invoice.

invoiceStatus

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

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

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

type

The type of object represented.

OpenAPI Schema

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

{
  "description": "A minimal representation of an invoice.",
  "properties": {
    "customInvoiceId": {
      "description": "A client-facing identifier for this invoice, starting at 1000 for\neach studio.",
      "readOnly": true,
      "type": "integer"
    },
    "finalDueDate": {
      "description": "The date on which this invoice must be paid in full.",
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "The identifier for this invoice.",
      "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"
    },
    "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}$",
      "readOnly": true,
      "type": "string"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "invoice"
      ],
      "type": "string"
    }
  },
  "title": "Invoice",
  "type": "object"
}