Xero · Schema

Reimbursement

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
reimbursementID string Xero unique identifier for a reimbursement
name string Name of the reimbursement
accountID string Xero unique identifier for the account used for the reimbursement
currentRecord boolean Indicates that whether the reimbursement is active
reimbursementCategory string See Reimbursement Categories
calculationType string See Calculation Types
standardAmount string Optional Fixed Rate Amount. Applicable when calculation type is Fixed Amount
standardTypeOfUnits string Optional Type Of Units. Applicable when calculation type is Rate Per Unit
standardRatePerUnit number Optional Rate Per Unit. Applicable when calculation type is Rate Per Unit
View JSON Schema on GitHub

JSON Schema

xero-reimbursement-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Reimbursement",
  "title": "Reimbursement",
  "type": "object",
  "required": [
    "name",
    "accountID"
  ],
  "properties": {
    "reimbursementID": {
      "description": "Xero unique identifier for a reimbursement",
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "description": "Name of the reimbursement",
      "type": "string"
    },
    "accountID": {
      "description": "Xero unique identifier for the account used for the reimbursement",
      "type": "string",
      "format": "uuid"
    },
    "currentRecord": {
      "description": "Indicates that whether the reimbursement is active",
      "type": "boolean"
    },
    "reimbursementCategory": {
      "description": "See Reimbursement Categories",
      "type": "string",
      "enum": [
        "GST",
        "NoGST",
        "GSTInclusive"
      ]
    },
    "calculationType": {
      "description": "See Calculation Types",
      "type": "string",
      "enum": [
        "Unknown",
        "FixedAmount",
        "RatePerUnit"
      ]
    },
    "standardAmount": {
      "description": "Optional Fixed Rate Amount. Applicable when calculation type is Fixed Amount",
      "type": "string"
    },
    "standardTypeOfUnits": {
      "description": "Optional Type Of Units. Applicable when calculation type is Rate Per Unit",
      "type": "string",
      "enum": [
        "Hours",
        "km"
      ]
    },
    "standardRatePerUnit": {
      "description": "Optional Rate Per Unit. Applicable when calculation type is Rate Per Unit",
      "type": "number",
      "format": "double",
      "x-is-money": true
    }
  }
}