Skip to main content
GET
/
rti
/
eps
/
{taxYear}
/
submissions
Get all EPS submissions by tax year
curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/rti/eps/{taxYear}/submissions \
  --header 'X-Auth-Token: <api-key>'
{
  "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": [
    {
      "submissionId": "EPS_2025_001",
      "taxYear": 2025,
      "organisationId": "org_123",
      "hmrcEpsReportStatus": "Sent",
      "createdDate": "2025-01-01T00:00:00Z",
      "createdBy": "user_123",
      "updatedDate": "2025-01-02T00:00:00Z",
      "updatedBy": "user_456",
      "taxMonth": 6,
      "submissionBody": "Submission body content",
      "correlationID": "corr_123",
      "submissionDate": "2025-01-01T00:00:00Z",
      "submissionResponse": "Response from HMRC",
      "errors": [
        "Error message 1",
        "Error message 2"
      ]
    }
  ],
  "metadata": {
    "paginationToken": "<string>"
  }
}

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 retrieve EPS submissions for

Required range: 1800 <= x <= 3000

Query Parameters

​
pageSize
string

Number of items per page (default: 20, max: 100)

Pattern: ^[0-9]+$
​
paginationToken
string

Token for pagination to get the next page of results

Response

Successfully retrieved EPS submissions

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

List of EPS submissions

​
metadata
object