Xero · Schema

CreditNoteResponse

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
creditNoteId string Xero Identifier of credit note
contact object
total number Total of Invoice tax inclusive (i.e. SubTotal + TotalTax); Not included in summary mode
lineItems array Not included in summary mode
View JSON Schema on GitHub

JSON Schema

xero-creditnoteresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreditNoteResponse",
  "title": "CreditNoteResponse",
  "type": "object",
  "properties": {
    "creditNoteId": {
      "type": "string",
      "description": "Xero Identifier of credit note",
      "format": "uuid"
    },
    "contact": {
      "$ref": "#/components/schemas/ContactResponse"
    },
    "total": {
      "type": "number",
      "description": "Total of Invoice tax inclusive (i.e. SubTotal + TotalTax); Not included in summary mode",
      "format": "double",
      "x-is-money": true
    },
    "lineItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LineItemResponse"
      },
      "description": "Not included in summary mode"
    }
  },
  "additionalProperties": false
}