Invoice Installment

Description

An invoice installment.

Properties

Property Description
amount

The amount due for this installment.

dueDate

The date on which this installment is due.

id

The identifier for this invoice installment.

invoiceInstallmentStatus read-only

The status slug for this invoice installment.

isFixed

Whether this amount is fixed.

If the installment amount is flagged as fixed, then it may not change automatically due to recalculations based on changes to the invoice grand total or other installment amounts. It may only change if the user directly edits this amount.

isRetainer

Whether this installment represents a retainer for a job.

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 installment.",
  "properties": {
    "amount": {
      "description": "The amount due for this installment.",
      "type": "number"
    },
    "dueDate": {
      "description": "The date on which this installment is due.",
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "description": "The identifier for this invoice installment.",
      "type": "integer"
    },
    "invoiceInstallmentStatus": {
      "description": "The status slug for this invoice installment.",
      "enum": [
        "unpaid",
        "partially-paid",
        "paid-in-full"
      ],
      "readOnly": true,
      "type": "string"
    },
    "isFixed": {
      "description": "Whether this amount is fixed.\n\nIf the installment amount is flagged as `fixed`, then it may not\nchange automatically due to recalculations based on changes to the\ninvoice grand total or other installment amounts. It may only change\nif the user directly edits this amount.",
      "type": "boolean"
    },
    "isRetainer": {
      "description": "Whether this installment represents a retainer for a job.",
      "type": "boolean"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "invoice-installment"
      ],
      "type": "string"
    }
  },
  "required": [
    "type",
    "isRetainer",
    "isFixed",
    "amount",
    "dueDate"
  ],
  "title": "Invoice Installment",
  "type": "object"
}