Xero · Schema

Benefit

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
id string The Xero identifier for superannuation
name string Name of the superannuations
category string Superannuations Category type
liabilityAccountId string Xero identifier for Liability Account
expenseAccountId string Xero identifier for Expense Account
calculationTypeNZ string Calculation Type of the superannuation either FixedAmount or PercentageOfTaxableEarnings
standardAmount number Standard amount of the superannuation
percentage number Percentage of Taxable Earnings of the superannuation
companyMax number Company Maximum amount of the superannuation
currentRecord boolean Identifier of a record is active or not.
View JSON Schema on GitHub

JSON Schema

xero-benefit-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Benefit",
  "title": "Benefit",
  "type": "object",
  "required": [
    "name",
    "category",
    "liabilityAccountId",
    "expenseAccountId"
  ],
  "properties": {
    "id": {
      "description": "The Xero identifier for superannuation",
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "description": "Name of the superannuations",
      "type": "string"
    },
    "category": {
      "description": "Superannuations Category type",
      "type": "string",
      "enum": [
        "KiwiSaver",
        "ComplyingFund",
        "Other"
      ]
    },
    "liabilityAccountId": {
      "description": "Xero identifier for Liability Account",
      "type": "string",
      "format": "uuid"
    },
    "expenseAccountId": {
      "description": "Xero identifier for Expense Account",
      "type": "string",
      "format": "uuid"
    },
    "calculationTypeNZ": {
      "description": "Calculation Type of the superannuation either FixedAmount or PercentageOfTaxableEarnings",
      "type": "string",
      "enum": [
        "FixedAmount",
        "PercentageOfTaxableEarnings"
      ]
    },
    "standardAmount": {
      "description": "Standard amount of the superannuation",
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "percentage": {
      "description": "Percentage of Taxable Earnings of the superannuation",
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "companyMax": {
      "description": "Company Maximum amount of the superannuation",
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "currentRecord": {
      "description": "Identifier of a record is active or not.",
      "type": "boolean"
    }
  }
}