| Name / Description | Type / Format | Example | |
|---|---|---|---|
maxClaimPerEmployee
|
number
double
|
0.0
|
|
percentageOfNIAndPensionToClaim
|
number
double
|
0.0
|
|
govtContribRate
|
number
double
|
0.0
|
|
companyName
|
string
|
"string"
|
|
employerReference
|
string
|
"string"
|
|
companyCrn
|
string
|
"string"
|
|
ctUtr
|
string
|
"string"
|
|
saUtr
|
string
|
"string"
|
|
claimPeriodStartDate
|
string
date
|
"2024-11-21"
|
|
claimPeriodEndDate
|
string
date
|
"2024-11-21"
|
|
numberOfEmployeesBeingFurloughed
|
integer
int32
|
0
|
|
totalClaimAmount
|
number
double
|
0.0
|
|
totalGrossPay
|
number
double
|
0.0
|
|
amountClaimedForGrossPayToEmployeesOnFurloughForThePeriod
|
number
double
|
0.0
|
|
amountClaimedForEmployerNICsContributionsForFurloughedEmployees
|
number
double
|
0.0
|
|
amountClaimedForEmployersAutoEnrolmentPensionCostsForFurloughedEmployees
|
number
double
|
0.0
|
|
lines
|
FurloughReportLine[]
|
{FurloughReportLine}
|
|
bankAccountNumber
|
string
|
"string"
|
|
bankSortCode
|
string
|
"string"
|
|
bankAccountHoldersFirstName
|
string
|
"string"
|
|
bankAccountHoldersLastName
|
string
|
"string"
|
|
bankAccountHoldersAddress
|
string
|
"string"
|
|
buildingSocietyRollNumber
|
string
|
"string"
|
|
companyAddress
|
string
|
"string"
|
|
contactName
|
string
|
"string"
|
|
contactNumber
|
string
|
"string"
|
|
employer
|
Item
|
{Item}
|
|
payPeriod
|
string
|
"Custom"
"Monthly"
"FourWeekly"
"Fortnightly"
"Weekly"
"Daily"
|
|
ordinal
|
integer
int32
|
0
|
|
period
|
integer
int32
|
0
|
|
periodTo
|
integer
int32
|
0
|
|
startPeriodName
|
string
|
"string"
|
|
endPeriodName
|
string
|
"string"
|
|
startDate
|
string
date
|
"2024-11-21"
|
|
endDate
|
string
date
|
"2024-11-21"
|
|
report
|
string
|
"GrossToNet"
"GrossToNetCis"
"PayrunPayments"
"Furlough"
"PensionContribs"
"Journal"
"HourlyPay"
"UmbrellaReconciliation"
"UmbrellaStatement"
"StatutoryPay"
"CostAnalysis"
"CostOfEmployment"
"FullSummaryOfPay"
"P11"
"P11d"
"P30"
"P32"
"P45"
"P60"
"EmployeeExport"
"RightToWork"
"AeoStatement"
"HolidayAllowances"
"HolidayPayAccruals"
"AeAssessments"
"CisStatement"
"SubcontractorSummary"
"PayrollAnalysis"
"VarianceReport"
"P11Detailed"
"NiLetterValidation"
"Ytd"
"TaxCodeChanges"
"EmployeeBenefits"
"MemberEnrolment"
"AttachmentOrders"
"NiYtd"
"ApprenticeshipLevy"
"TeachersPensionEoy"
"MaternitySchedule"
"PaySpine"
"SpinePoint"
"PayGrades"
"PaySpineAllowances"
"AverageHolidayPayRate"
"EmployeeRoleExport"
"HolidayPayAccrualsHours"
"GenderPayGap"
"PensionMemberships"
"PayElement"
"LoanBalances"
"EmployeeLeave"
"AdvancedVarianceReport"
|
|
taxYear
|
string
|
"Year2017"
"Year2018"
"Year2019"
"Year2020"
"Year2021"
"Year2022"
"Year2023"
"Year2024"
|
|
title
|
string
|
"string"
|
|
isDraft
|
boolean
|
true
|
{
"maxClaimPerEmployee": 0.0,
"percentageOfNIAndPensionToClaim": 0.0,
"govtContribRate": 0.0,
"companyName": "string",
"employerReference": "string",
"companyCrn": "string",
"ctUtr": "string",
"saUtr": "string",
"claimPeriodStartDate": "2024-11-21",
"claimPeriodEndDate": "2024-11-21",
"numberOfEmployeesBeingFurloughed": 0,
"totalClaimAmount": 0.0,
"totalGrossPay": 0.0,
"amountClaimedForGrossPayToEmployeesOnFurloughForThePeriod": 0.0,
"amountClaimedForEmployerNICsContributionsForFurloughedEmployees": 0.0,
"amountClaimedForEmployersAutoEnrolmentPensionCostsForFurloughedEmployees": 0.0,
"lines": [
{
"employee": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"employeesFullName": "string",
"employeesNINO": "string",
"employeesPayrollReferenceNumber": "string",
"furloughedDays": 0,
"daysInPeriod": 0,
"hoursNormallyWorked": 0.0,
"hoursFurloughed": 0.0,
"percentageOfFurloughedDaysWorked": 0.0,
"grossPay": 0.0,
"grossPayClaim": 0.0,
"niClaim": 0.0,
"pensionClaim": 0.0,
"totalClaim": 0.0,
"furloughStart": "2024-11-21",
"furloughEnd": "2024-11-21",
"department": "string"
}
],
"bankAccountNumber": "string",
"bankSortCode": "string",
"bankAccountHoldersFirstName": "string",
"bankAccountHoldersLastName": "string",
"bankAccountHoldersAddress": "string",
"buildingSocietyRollNumber": "string",
"companyAddress": "string",
"contactName": "string",
"contactNumber": "string",
"employer": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"payPeriod": "Custom",
"ordinal": 0,
"period": 0,
"periodTo": 0,
"startPeriodName": "string",
"endPeriodName": "string",
"startDate": "2024-11-21",
"endDate": "2024-11-21",
"report": "GrossToNet",
"taxYear": "Year2017",
"title": "string",
"isDraft": true
}- none -
- none -