Employment Hero Payroll API Reference: YearToDateModel

Methods

get - Get Year to date

Resource

{
    "deductions": {
        "amount": "double",
        "components": [
            {
                "amount": "double",
                "annotation": "string",
                "name": "string",
                "type": "string"
            }
        ],
        "name": "string"
    },
    "grossPay": {
        "amount": "double",
        "components": [
            {
                "amount": "double",
                "nIable": "boolean",
                "name": "string",
                "taxable": "boolean",
                "type": "string"
            }
        ],
        "name": "string",
        "prevAmount": "double"
    },
    "nationalInsurance": {
        "amount": "double",
        "components": [
            {
                "aboveUel": "double",
                "amount": "double",
                "category": "string",
                "datePaid": "date-time",
                "employerNi": "double",
                "fustToUel": "double",
                "fustToUst": "double",
                "lel": "double",
                "lelToPt": "double",
                "lelToSt": "double",
                "name": "string",
                "ptToFust": "double",
                "stToFust": "double",
                "totalNiablePay": "double",
                "type": "string"
            }
        ],
        "name": "string"
    },
    "netPay": {
        "amount": "double",
        "components": [
            {
                "amount": "double",
                "name": "string",
                "type": "string",
                "url": "string"
            }
        ],
        "name": "string"
    },
    "pension": {
        "amount": "double",
        "components": [
            {
                "amount": "double",
                "name": "string",
                "type": "string"
            }
        ],
        "name": "string"
    },
    "statutoryPay": {
        "amount": "double",
        "components": [
            {
                "amount": "double",
                "name": "string",
                "type": "string"
            }
        ],
        "name": "string"
    },
    "tax": {
        "amount": "double",
        "components": [
            {
                "amount": "double",
                "name": "string",
                "type": "string"
            }
        ],
        "name": "string",
        "prevAmount": "double"
    }
}

Properties

Name	Type	Description
deductions	object	YearToDateAnnotatedSection
deductions.amount	double	Decimal
deductions.components[]	array
deductions.components[].amount	double	Decimal
deductions.components[].annotation	string	String
deductions.components[].name	string	String
deductions.components[].type	string	YearToDateComponentType Possible values are: `None` `Deduction` `Pay` `TaxablePaySubTotal` `Tax` `PensionablePay` `PensionEmployee` `PensionEmployer` `PensionSalarySacrifice` `NationalInsurance` `NetPay`
deductions.name	string	String
grossPay	object	YearToDateGrossPaySection
grossPay.amount	double	Decimal
grossPay.components[]	array
grossPay.components[].amount	double	Decimal
grossPay.components[].nIable	boolean	Nullable
grossPay.components[].name	string	String
grossPay.components[].taxable	boolean	Nullable
grossPay.components[].type	string	YearToDateComponentType Possible values are: `None` `Deduction` `Pay` `TaxablePaySubTotal` `Tax` `PensionablePay` `PensionEmployee` `PensionEmployer` `PensionSalarySacrifice` `NationalInsurance` `NetPay`
grossPay.name	string	String
grossPay.prevAmount	double	Nullable
nationalInsurance	object	YearToDateNationalInsuranceSection
nationalInsurance.amount	double	Decimal
nationalInsurance.components[]	array
nationalInsurance.components[].aboveUel	double	Decimal
nationalInsurance.components[].amount	double	Decimal
nationalInsurance.components[].category	string	NationalInsuranceType Possible values are: `A` `B` `C` `H` `J` `M` `X` `Z` `F` `I` `L` `S` `V` `D` `E` `K` `N`
nationalInsurance.components[].datePaid	date-time	DateTime
nationalInsurance.components[].employerNi	double	Decimal
nationalInsurance.components[].fustToUel	double	Decimal
nationalInsurance.components[].fustToUst	double	Decimal
nationalInsurance.components[].lel	double	Decimal
nationalInsurance.components[].lelToPt	double	Decimal
nationalInsurance.components[].lelToSt	double	Decimal
nationalInsurance.components[].name	string	String
nationalInsurance.components[].ptToFust	double	Decimal
nationalInsurance.components[].stToFust	double	Decimal
nationalInsurance.components[].totalNiablePay	double	Decimal
nationalInsurance.components[].type	string	YearToDateComponentType Possible values are: `None` `Deduction` `Pay` `TaxablePaySubTotal` `Tax` `PensionablePay` `PensionEmployee` `PensionEmployer` `PensionSalarySacrifice` `NationalInsurance` `NetPay`
nationalInsurance.name	string	String
netPay	object	YearToDateLinkSection
netPay.amount	double	Decimal
netPay.components[]	array
netPay.components[].amount	double	Decimal
netPay.components[].name	string	String
netPay.components[].type	string	YearToDateComponentType Possible values are: `None` `Deduction` `Pay` `TaxablePaySubTotal` `Tax` `PensionablePay` `PensionEmployee` `PensionEmployer` `PensionSalarySacrifice` `NationalInsurance` `NetPay`
netPay.components[].url	string	String
netPay.name	string	String
pension	object	YearToDatePensionSection
pension.amount	double	Decimal
pension.components[]	array
pension.components[].amount	double	Decimal
pension.components[].name	string	String
pension.components[].type	string	YearToDateComponentType Possible values are: `None` `Deduction` `Pay` `TaxablePaySubTotal` `Tax` `PensionablePay` `PensionEmployee` `PensionEmployer` `PensionSalarySacrifice` `NationalInsurance` `NetPay`
pension.name	string	String
statutoryPay	object	YearToDateDefaultSection
statutoryPay.amount	double	Decimal
statutoryPay.components[]	array
statutoryPay.components[].amount	double	Decimal
statutoryPay.components[].name	string	String
statutoryPay.components[].type	string	YearToDateComponentType Possible values are: `None` `Deduction` `Pay` `TaxablePaySubTotal` `Tax` `PensionablePay` `PensionEmployee` `PensionEmployer` `PensionSalarySacrifice` `NationalInsurance` `NetPay`
statutoryPay.name	string	String
tax	object	YearToDateTaxSection
tax.amount	double	Decimal
tax.components[]	array
tax.components[].amount	double	Decimal
tax.components[].name	string	String
tax.components[].type	string	YearToDateComponentType Possible values are: `None` `Deduction` `Pay` `TaxablePaySubTotal` `Tax` `PensionablePay` `PensionEmployee` `PensionEmployer` `PensionSalarySacrifice` `NationalInsurance` `NetPay`
tax.name	string	String
tax.prevAmount	double	Nullable

YearToDateModel resource

Methods

Resource

Properties