changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "additionalProperties": false,
+ "properties": {
+ "credit_note_id": {
+ "description": "UUID of the created credit note (after confirm:true).",
+ "type": "string"
+ },
+ "note": {
+ "description": "Outcome summary (after confirm:true).",
+ "type": "string"
+ },
+ "preview": {
+ "description": "True when the call was a preview (confirm omitted or false): nothing was changed.",
+ "type": "boolean"
+ },
+ "warning": {
+ "description": "Irreversibility warning (preview only).",
+ "type": "string"
+ },
+ "would_cancel_with_credit_note": {
+ "additionalProperties": false,
+ "description": "Invoice that would be cancelled by a credit note (preview only).",
+ "properties": {
+ "already_has_credit_note": {
+ "description": "True when a credit note already exists for this invoice.",
+ "type": "boolean"
+ },
+ "gross_total": {
+ "description": "Total incl. VAT, in the document currency.",
+ "type": "number"
+ },
+ "id": {
+ "description": "Document UUID.",
+ "type": "string"
+ },
+ "invoice_number": {
+ "description": "Human-readable document number.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Document status: Draft, Sent, Paid, Overdue, Cancelled, Rectified, Accepted, Rejected or Expired.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "invoice_number",
+ "status",
+ "gross_total",
+ "already_has_credit_note"
+ ],
+ "type": "object"
+ }
+ },
+ "type": "object"
+}