Skip to main content
POST
/
rti
/
eps
/
monthly-balances
/
{taxYear}
/
{taxMonth}
Submit EPS from monthly balances
curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/rti/eps/monthly-balances/{taxYear}/{taxMonth} \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
"Final submission details for the period"
'
{
  "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
taxMonth
integer
required

The tax month to submit EPS for

Required range: 1 <= x <= 12

Query Parameters

preview
boolean
default:false

Whether to generate a preview without submitting to HMRC

Body

application/json

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

becauseSchemeCeased
boolean | null

Indicates if the scheme has ceased

Example:

true

dateSchemeCeased
string<date> | null

The date when the scheme ceased (format: yyyy-MM-dd)

Example:

"2024-04-05"

forYear
boolean | null

Indicates if this is the final submission for the tax year

Example:

true

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\"?>..."