Skip to main content
POST
Trigger send HMRC RTI FPS for payroll run

Authorizations

X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

X-Org-Id
string
header
required

Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).

Path Parameters

payrollConfigId
string
required

The payroll configuration ID

Pattern: ^[a-zA-Z0-9_-]+$
taxYear
string
required

The tax year

Pattern: ^[0-9]{4}$
period
string
required

The payroll period

Pattern: ^[0-9]+$

Query Parameters

preview
boolean
default:false

Whether to generate a preview without submitting to HMRC

Body

application/json

Final submission details (required for last period of tax year)

Example:

"Final submission details for the period"

Response

HMRC RTI FPS preview generated successfully

message
object
content
object
validationIssues
object[]
messageToken
string
data
string

The FPS submission XML preview

Example:

"<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."