Full Payment Summary XML Without Submission

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "lodgeFinalPayRun": "boolean",
    "payRunId": "int32",
    "taxYear": "int32"
}

Properties

Name Type Description
lodgeFinalPayRun boolean Boolean
payRunId int32 Int32
taxYear int32 Int32

Response

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

Status code Description Resource
200 OK

OK

 FpsResponseXmlModel