Invoice Activity

Description

Activity performed on an invoice.

Properties

Property Description
amount nullable

The amount of money related to the activity, if applicable.

created

The date on which this activity took place.

currencyCode nullable

Identifies the currency for the amount, if applicable.

currencySymbol nullable

The currency symbol for the currency used for this invoice activity, if applicable.

invoiceActivityAction

The slug string name for the activity.

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": "Activity performed on an invoice.",
  "properties": {
    "amount": {
      "description": "The amount of money related to the activity, if applicable.",
      "nullable": true,
      "type": "number"
    },
    "created": {
      "description": "The date on which this activity took place.",
      "format": "date-time",
      "type": "string"
    },
    "currencyCode": {
      "description": "Identifies the currency for the amount, if applicable.",
      "nullable": true,
      "type": "string"
    },
    "currencySymbol": {
      "description": "The currency symbol for the currency used for this invoice activity,\nif applicable.",
      "nullable": true,
      "type": "string"
    },
    "invoiceActivityAction": {
      "description": "The slug string name for the activity.",
      "enum": [
        "studio-created",
        "studio-edited",
        "studio-canceled",
        "payment-received",
        "sent-client",
        "autopay-enabled",
        "autopay-disabled",
        "client-viewed",
        "studio-viewed",
        "payment-refund"
      ],
      "type": "string"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "invoice-activity"
      ],
      "type": "string"
    }
  },
  "title": "Invoice Activity",
  "type": "object"
}