The Tenant model represents the brand that provides the account.
This is used by our White Label partners to manage and brand their user accounts.
Unless you are an admin for a White Label account you'll have no interest in this model.
| Name / Description | Type / Format | Example | |
|---|---|---|---|
type
|
string
|
"BasicPay"
"Gross"
"GrossForTax"
"GrossForNi"
"EmployerNi"
"EmployeeNi"
"EmployerNiOffPayroll"
"RealTimeClass1ANi"
"Tax"
"NetPay"
"Adjustments"
"TakeHomePay"
"NonTaxOrNICPmt"
"ItemsSubjectToClass1NIC"
"DednsFromNetPay"
"Tcp_Tcls"
"Tcp_Pp"
"Tcp_Op"
"FlexiDd_Death"
"FlexiDd_Death_NonTax"
"FlexiDd_Pension"
"FlexiDd_Pension_NonTax"
"Smp"
"Spp"
"Sap"
"Shpp"
"Spbp"
"StudentLoanRecovered"
"PostgradLoanRecovered"
"PensionablePay"
"NonTierablePay"
"EmployeePensionContribution"
"EmployerPensionContribution"
"EmpeePenContribnsNotPaid"
"EmpeePenContribnsPaid"
"AttachmentOrderDeductions"
"CisDeduction"
"CisVat"
"CisUmbrellaFee"
"CisUmbrellaFeePostTax"
"Pbik"
"MapsMiles"
"UmbrellaFee"
"AppLevyDeduction"
"PaymentAfterLeaving"
"TaxOnPaymentAfterLeaving"
"Ssp"
"AttachmentOrderAdminFee"
"EmployeePensionNetPay"
"EmployeePensionRas"
"EmployeePensionSalSac"
"EmployeePensionContributionAvc"
"Deductions"
"Additions"
"PensionableEarnings"
"TotalGross"
"FlexiDd_SeriousIllHealth"
"FlexiDd_SeriousIllHealth_NonTax"
"ForeignTaxCredit"
"ForeignTaxReclaimed"
"AverageHolidayPay"
"P45Gross"
"P45Tax"
"Sncp"
"FlexiDd_StandAloneLumpSum"
"FlexiDd_StandAloneLumpSum_NonTax"
"FlexiDd_PensionCommencementExcess"
"FlexiDd_PensionCommencementExcess_NonTax"
"Average_Holiday_Pay_Days"
"Holiday_Days_Day_Rate"
"SpbpNorthernIreland"
"Omp"
|
|
value
The value to use in place of the original value
|
number
double
|
0.0
|
|
originalValue
The original value
|
number
double
|
0.0
|
|
note
The reason given for the override
|
string
|
"string"
|
|
attachmentOrderId
The Id of the AttachmentOrder. Only relevant if the Type is set to AttachmentOrderDeductions
|
string
uuid
|
"string"
|
|
pensionId
The Id of the associated Pension. Only included if the Code is PENSION, PENSIONSS or PENSIONRAS
|
string
uuid
|
"string"
|
|
leaveId
The Id of the associated Leave.
|
string
uuid
|
"string"
|
|
roleId
The Id of the associated Employee Role. Only included if the Type supports it
|
string
uuid
|
"string"
|
{
"type": "BasicPay",
"value": 0.0,
"originalValue": 0.0,
"note": "string",
"attachmentOrderId": "string",
"pensionId": "string",
"leaveId": "string",
"roleId": "string"
}