Invoice Refund

OpenAPI Schema

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

{
  "description": "An invoice refund.",
  "properties": {
    "amount": {
      "description": "The amount of the payment to refund.",
      "type": "number"
    },
    "emailAdditionalMessage": {
      "description": "Optional message to include in email sent to client and payer. May\ninclude HTML tags, but only whitelisted tags will be included.",
      "nullable": true,
      "type": "string"
    },
    "invoicePaymentId": {
      "description": "The identifier for the invoice payment to refund.",
      "type": "integer"
    },
    "note": {
      "description": "A note about the refund.",
      "nullable": true,
      "type": "string"
    },
    "refundDate": {
      "description": "The date on which this refund was made.",
      "format": "date-time",
      "type": "string"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "invoice-refund"
      ],
      "type": "string"
    }
  },
  "required": [
    "type",
    "invoicePaymentId",
    "amount",
    "refundDate"
  ],
  "title": "Invoice Refund",
  "type": "object"
}