Skip to main content
POST
/
rti
/
eps
/
{taxYear}
/
manual
Submit EPS manually
curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/rti/eps/{taxYear}/manual \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "taxYear": 2025,
  "taxMonth": 1,
  "finalSubmissionDetails": {
    "becauseSchemeCeased": true,
    "dateSchemeCeased": "2024-04-05",
    "forYear": true
  },
  "isPreview": false
}
'
{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {},
    "metadata": {
      "dateFormat": "yyyy-MM-dd",
      "dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "messageToken": "<string>",
  "data": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
}

Documentation Index

Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

Path Parameters

taxYear
integer
required

The tax year to submit EPS for

Required range: 1800 <= x <= 3000

Query Parameters

preview
boolean
default:false

Whether to generate a preview without submitting to HMRC

Body

application/json

EPS submission request for tax years 2024-25 and 2025-26

taxYear
integer
required

Tax year (2024 or 2025)

Example:

2025

taxMonth
integer

Tax month

Required range: 1 <= x <= 12
Example:

1

finalSubmissionDetails
object

Final submission details for tax years 2024/2025 and 2025/2026

noPaymentForPeriod
object
periodOfInactivity
object
employmentAllowance
object

Employment allowance with De Minimis State Aid sectors (tax years before 2026-27)

recoverableAmounts
object

Recoverable amounts for tax years 2024-25 and 2025-26

apprenticeshipLevy
object
isPreview
boolean
default:false

Whether this is a preview

Response

EPS submission preview generated successfully

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

The EPS submission XML preview

Example:

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