Employer Payment Summary submission

Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/report/eps

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

The request body takes a complete UkEmployerPaymentSummarySubmissionModel resource, containing the following writable properties:

{
    "isAutomaticSubmission": "boolean",
    "isFinalEpsForTaxYear": "boolean",
    "noPaymentDates": {
        "fromDate": "date-time",
        "toDate": "date-time"
    },
    "payeSchemeCeased": "boolean",
    "payeSchemeCeasedDate": "date-time",
    "periodEnd": "date-time",
    "periodOfInactivity": "boolean",
    "periodOfInactivityToDate": "date-time"
}

Properties

Name Type Description
isAutomaticSubmission boolean Boolean
isFinalEpsForTaxYear boolean Boolean
noPaymentDates object EpsPaymentDatesViewModel
noPaymentDates.fromDate date-time DateTime
noPaymentDates.toDate date-time DateTime
payeSchemeCeased boolean Boolean
payeSchemeCeasedDate date-time Nullable
periodEnd date-time DateTime
periodOfInactivity boolean Boolean
periodOfInactivityToDate date-time Nullable

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 EmployerPaymentSummaryReportGridModel