| Name / Description | Type / Format | Example | |
|---|---|---|---|
title
A descriptive name for the Period
|
string
|
"string"
|
|
taxYear
|
string
|
"Year2017"
"Year2018"
"Year2019"
"Year2020"
"Year2021"
"Year2022"
"Year2023"
"Year2024"
|
|
periodEnding
|
string
date
|
"2024-12-22"
|
|
periodComplete
Indicates whether or not all PayRuns for this period have been completed
|
boolean
|
true
|
|
recoverableAmountsEpsCreated
If there are recoverable amount present (ie, SMP) and the Period is complete then this field Indicates
whether or not an EPS has been created up to the final tax month of this period to declare the recoverable amounts |
boolean
|
true
|
|
apprenticeshipLevyEpsCreated
If there is an Apprenticeship LEvy amount present and the Period is complete then this field Indicates
whether or not an EPS has been created up to the final tax month of this period to declare the amount |
boolean
|
true
|
|
payRuns
|
PayRun[]
|
{PayRun}
|
|
tax
Amount due to HMRC for PAYE in period
|
number
double
|
0.0
|
|
cisDeductions
Amount due to HMRC for CIS Deductions made in period
|
number
double
|
0.0
|
|
postgradLoanDeductions
Amount due to HMRC for Postgrad Loan Deductions made in period
|
number
double
|
0.0
|
|
studentLoanDeductions
Amount due to HMRC for Student Loan Deductions made in period
|
number
double
|
0.0
|
|
employeeNic
Amount due to HMRC for Employee NIC Contributions withheld in period
|
number
double
|
0.0
|
|
employerNic
Amount due to HMRC for Employer NIC Contributions due on payments in period
|
number
double
|
0.0
|
|
realTimeClass1ANic
Amount due to HMRC for Employer NIC Contributions due on payments in period
|
number
double
|
0.0
|
|
smp
SMP recovered from payments in period
|
number
double
|
0.0
|
|
smpNic
SMP NIC Compensation for period
|
number
double
|
0.0
|
|
spp
SPP recovered from payments in period
|
number
double
|
0.0
|
|
sppNic
SPP Nic Compensation for period
|
number
double
|
0.0
|
|
sap
SAP recovered from payments in period
|
number
double
|
0.0
|
|
sapNic
SAP Nic Compensation for period
|
number
double
|
0.0
|
|
shpp
ShPP recovered from payments in period
|
number
double
|
0.0
|
|
shppNic
ShPP Nic Compensation for period
|
number
double
|
0.0
|
|
spbp
SPBP recovered from payments in period
|
number
double
|
0.0
|
|
spbpNic
SPBP Nic Compensation for period
|
number
double
|
0.0
|
|
eligibleForEmploymentAllowance
Indicates whether the Employer settings say the Employer is eligible for Employment Allowance
|
boolean
|
true
|
|
employmentAllowanceClaim
Amount to claim with respect to the Employment Allowance
|
number
double
|
0.0
|
|
employmentAllowanceClaimAuto
If set to true, we'll automatically claim the maximum allowed.
If set to false then you can enter your own value. If EligibleForEmploymentAllowance is false then the EmploymentAllowanceClaim will always be overwritten with a zero value regardless of this property |
boolean
|
true
|
|
liableForApprenticeshipLevy
Indicates whether the Employer settings say the Employer is liable for the Apprenticeship Levy
|
boolean
|
true
|
|
apprenticeshipLevy
Amount due with respect to the Apprenticeship Levy
|
number
double
|
0.0
|
|
apprenticeshipLevyAuto
If set to true, we'll automatically calculate your liability
If set to false then you can enter your own value. If LiableForApprenticeshipLevy is false then the ApprenticeshipLevy will always be overwritten with a zero value regardless of this property |
boolean
|
true
|
|
liabilityArisingInPeriod
Total Liability (before any deductions) arising in this Period
|
number
double
|
0.0
|
|
dueInPreviousPeriods
Amount due to HMRC in previous periods for this Tax Year
|
number
double
|
0.0
|
|
paidInPreviousPeriods
Amount paid to HMRC in previous periods for this Tax Year
|
number
double
|
0.0
|
|
employmentAllowanceClaimInPreviousPeriods
The amount of Employment Allowance claimed in previous periods for this Tax Year
|
number
double
|
0.0
|
|
receivedFromHMRCToRefundTax
Any amount received from HMRC to refund Tax in Period
|
number
double
|
0.0
|
|
receivedFromHMRCToPayStatutoryPay
Any amount received from HMRC to pay Statutory Pay Period
|
number
double
|
0.0
|
|
cisDeductionsSuffered
CIS Deductions Suffered in Period
|
number
double
|
0.0
|
|
adjustment
Any manual adjustment for Period
|
number
double
|
0.0
|
|
netLiabilityForPeriod
Net Liability (including any deductions/additions) arising in this Period
|
number
double
|
0.0
|
|
totalPaid
The total value of all payments in this period
|
number
double
|
0.0
|
|
payments
|
HmrcPayment[]
|
{HmrcPayment}
|
|
fpsList
|
Item[]
|
{Item}
|
|
allowLinkedEps
If true this will allow you to submit a combined Employer Payment Summary
|
boolean
|
true
|
|
id
The unique id of the object
|
string
uuid
|
"string"
|
{
"title": "string",
"taxYear": "Year2017",
"periodEnding": "2024-12-22",
"periodComplete": true,
"recoverableAmountsEpsCreated": true,
"apprenticeshipLevyEpsCreated": true,
"payRuns": [
{
"taxYear": "Year2017",
"taxMonth": 0,
"payPeriod": "Custom",
"ordinal": 0,
"period": 0,
"startDate": "2024-12-22",
"endDate": "2024-12-22",
"paymentDate": "2024-12-22",
"employeeCount": 0,
"subContractorCount": 0,
"nonRtiEmployeeCount": 0,
"totals": {
"basicPay": 0.0,
"gross": 0.0,
"grossForNi": 0.0,
"grossForNiNonRti": 0.0,
"grossNotSubjectToEmployersNi": 0.0,
"grossNotSubjectToEmployersNiNonRti": 0.0,
"grossForTax": 0.0,
"employerNi": 0.0,
"employerNiNonRti": 0.0,
"employeeNi": 0.0,
"employeeNiNonRti": 0.0,
"employerNiOffPayroll": 0.0,
"realTimeClass1ANi": 0.0,
"realTimeClass1ANiNonRti": 0.0,
"tax": 0.0,
"taxNonRti": 0.0,
"netPay": 0.0,
"adjustments": 0.0,
"notionalPay": 0.0,
"additions": 0.0,
"deductions": 0.0,
"takeHomePay": 0.0,
"nonTaxOrNICPmt": 0.0,
"itemsSubjectToClass1NIC": 0.0,
"dednsFromNetPay": 0.0,
"tcp_Tcls": 0.0,
"tcp_Pp": 0.0,
"tcp_Op": 0.0,
"flexiDd_Death": 0.0,
"flexiDd_Death_NonTax": 0.0,
"flexiDd_Pension": 0.0,
"flexiDd_Pension_NonTax": 0.0,
"flexiDd_SeriousIllHealth": 0.0,
"flexiDd_SeriousIllHealth_NonTax": 0.0,
"smp": 0.0,
"smpNonRti": 0.0,
"spp": 0.0,
"sppNonRti": 0.0,
"sap": 0.0,
"sapNonRti": 0.0,
"shpp": 0.0,
"shppNonRti": 0.0,
"spbp": 0.0,
"spbpNonRti": 0.0,
"ssp": 0.0,
"sspNonRti": 0.0,
"studentLoanRecovered": 0.0,
"studentLoanRecoveredNonRti": 0.0,
"postgradLoanRecovered": 0.0,
"postgradLoanRecoveredNonRti": 0.0,
"pensionableEarnings": 0.0,
"pensionablePay": 0.0,
"nonTierablePay": 0.0,
"employeePensionContribution": 0.0,
"employeePensionContributionAvc": 0.0,
"employerPensionContribution": 0.0,
"empeePenContribnsNotPaid": 0.0,
"empeePenContribnsPaid": 0.0,
"attachmentOrderDeductions": 0.0,
"cisDeduction": 0.0,
"cisVat": 0.0,
"cisUmbrellaFee": 0.0,
"cisUmbrellaFeePostTax": 0.0,
"pbik": 0.0,
"mapsMiles": 0,
"foreignTaxAmount": 0.0,
"foreignTaxAmountReclaimed": 0.0,
"umbrellaFee": 0.0,
"appLevyDeduction": 0.0,
"paymentAfterLeaving": 0.0,
"taxOnPaymentAfterLeaving": 0.0,
"nilPaid": 0,
"leavers": 0,
"starters": 0,
"p45Gross": 0.0,
"p45Tax": 0.0,
"totalCost": 0.0,
"recoverableAmounts": {
"taxMonth": 0,
"smpRecovered": 0.0,
"sppRecovered": 0.0,
"sapRecovered": 0.0,
"shPPRecovered": 0.0,
"spbpRecovered": 0.0,
"nicCompensationOnSMP": 0.0,
"nicCompensationOnSPP": 0.0,
"nicCompensationOnSAP": 0.0,
"nicCompensationOnShPP": 0.0,
"nicCompensationOnSPBP": 0.0,
"cisDeductionsSuffered": 0.0,
"total": 0.0
}
},
"payslipScheduledDateTime": "2024-12-22",
"state": "Opening",
"isClosed": true,
"isRolledBack": true,
"dateClosed": "2024-12-22T02:57:13",
"autoPilotCloseDate": "2024-12-22",
"entries": [
{
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
}
]
}
],
"tax": 0.0,
"cisDeductions": 0.0,
"postgradLoanDeductions": 0.0,
"studentLoanDeductions": 0.0,
"employeeNic": 0.0,
"employerNic": 0.0,
"realTimeClass1ANic": 0.0,
"smp": 0.0,
"smpNic": 0.0,
"spp": 0.0,
"sppNic": 0.0,
"sap": 0.0,
"sapNic": 0.0,
"shpp": 0.0,
"shppNic": 0.0,
"spbp": 0.0,
"spbpNic": 0.0,
"eligibleForEmploymentAllowance": true,
"employmentAllowanceClaim": 0.0,
"employmentAllowanceClaimAuto": true,
"liableForApprenticeshipLevy": true,
"apprenticeshipLevy": 0.0,
"apprenticeshipLevyAuto": true,
"liabilityArisingInPeriod": 0.0,
"dueInPreviousPeriods": 0.0,
"paidInPreviousPeriods": 0.0,
"employmentAllowanceClaimInPreviousPeriods": 0.0,
"receivedFromHMRCToRefundTax": 0.0,
"receivedFromHMRCToPayStatutoryPay": 0.0,
"cisDeductionsSuffered": 0.0,
"adjustment": 0.0,
"netLiabilityForPeriod": 0.0,
"totalPaid": 0.0,
"payments": [
{
"amount": 0.0,
"date": "2024-12-22",
"id": "string"
}
],
"fpsList": [
{
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
}
],
"allowLinkedEps": true,
"id": "string"
}