Xero · Schema

Payslip

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
EmployeeID string The Xero identifier for an employee
PayslipID string Xero identifier for the payslip
FirstName string First name of employee
LastName string Last name of employee
Wages number The Wages for the Payslip
Deductions number The Deductions for the Payslip
Tax number The Tax for the Payslip
Super number The Super for the Payslip
Reimbursements number The Reimbursements for the Payslip
NetPay number The NetPay for the Payslip
EarningsLines array
LeaveEarningsLines array
TimesheetEarningsLines array
DeductionLines array
LeaveAccrualLines array
ReimbursementLines array
SuperannuationLines array
TaxLines array
UpdatedDateUTC string Last modified timestamp
View JSON Schema on GitHub

JSON Schema

xero-payslip-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Payslip",
  "title": "Payslip",
  "type": "object",
  "properties": {
    "EmployeeID": {
      "description": "The Xero identifier for an employee",
      "type": "string",
      "format": "uuid",
      "example": "4729f087-8eec-49c1-8294-4d11a5a0a37c"
    },
    "PayslipID": {
      "description": "Xero identifier for the payslip",
      "type": "string",
      "format": "uuid",
      "example": "f3c0874d-7cdd-459a-a95c-d90d51decc42"
    },
    "FirstName": {
      "description": "First name of employee",
      "type": "string",
      "example": "Karen"
    },
    "LastName": {
      "description": "Last name of employee",
      "type": "string",
      "example": "Jones"
    },
    "Wages": {
      "description": "The Wages for the Payslip",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 1060.5
    },
    "Deductions": {
      "description": "The Deductions for the Payslip",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 0.0
    },
    "Tax": {
      "description": "The Tax for the Payslip",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 198.0
    },
    "Super": {
      "description": "The Super for the Payslip",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 75.6
    },
    "Reimbursements": {
      "description": "The Reimbursements for the Payslip",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 0.0
    },
    "NetPay": {
      "description": "The NetPay for the Payslip",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 862.5
    },
    "EarningsLines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EarningsLine"
      }
    },
    "LeaveEarningsLines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LeaveEarningsLine"
      }
    },
    "TimesheetEarningsLines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EarningsLine"
      }
    },
    "DeductionLines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DeductionLine"
      }
    },
    "LeaveAccrualLines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LeaveAccrualLine"
      }
    },
    "ReimbursementLines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ReimbursementLine"
      }
    },
    "SuperannuationLines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SuperannuationLine"
      }
    },
    "TaxLines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TaxLine"
      }
    },
    "UpdatedDateUTC": {
      "description": "Last modified timestamp",
      "type": "string",
      "readOnly": true,
      "x-is-msdate-time": true,
      "example": "/Date(1583967733054+0000)/"
    }
  }
}