Invoice Item

Description

An invoice item.

Properties

Property Description
description

A description for this invoice item.

displayOrder

The order in which this item should appear in the list of items.

id

The identifier for this invoice item.

invoiceItemTemplateId nullable

The identifier of the invoice item template from which this item was created, if applicable.

isTaxable

Whether this invoice item is taxable.

itemPrice

The price for a single one of this invoice item.

name

The name of this invoice item.

quantity

The quantity purchased of this invoice item.

totalPrice

The invoice item price multiplied by the quantity.

type

The type of object represented.

OpenAPI Schema

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

{
  "description": "An invoice item.",
  "properties": {
    "description": {
      "description": "A description for this invoice item.",
      "type": "string"
    },
    "displayOrder": {
      "description": "The order in which this item should appear in the list of items.",
      "type": "integer"
    },
    "id": {
      "description": "The identifier for this invoice item.",
      "type": "integer"
    },
    "invoiceItemTemplateId": {
      "description": "The identifier of the invoice item template from which this item was\ncreated, if applicable.",
      "nullable": true,
      "type": "integer"
    },
    "isTaxable": {
      "description": "Whether this invoice item is taxable.",
      "type": "boolean"
    },
    "itemPrice": {
      "description": "The price for a single one of this invoice item.",
      "type": "number"
    },
    "name": {
      "description": "The name of this invoice item.",
      "type": "string"
    },
    "quantity": {
      "description": "The quantity purchased of this invoice item.",
      "type": "integer"
    },
    "totalPrice": {
      "description": "The invoice item price multiplied by the quantity.",
      "type": "number"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "invoice-item"
      ],
      "type": "string"
    }
  },
  "required": [
    "type",
    "name",
    "displayOrder",
    "itemPrice",
    "quantity",
    "totalPrice",
    "isTaxable"
  ],
  "title": "Invoice Item",
  "type": "object"
}