Skip to main content
POST
/
notifications
/
pagination
/
initialise
Initialize pagination states for all data types
curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/hmrc-dps/notifications/pagination/initialise \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "date": "2023-12-25",
  "overwriteExisting": true,
  "dataTypes": []
}
'
{
  "content": {
    "data": {
      "date": "2023-12-25",
      "results": [
        {
          "success": true,
          "skipped": true,
          "highWaterMark": 123,
          "error": "<string>"
        }
      ],
      "summary": {
        "totalProcessed": 123,
        "successful": 123,
        "skipped": 123,
        "failed": 123
      }
    },
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>"
    }
  },
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>"
  },
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "message": {
    "text": "<string>",
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<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

Authentication token for API access

Body

application/json
date
string<date>
overwriteExisting
boolean
dataTypes
enum<string>[] | null
Available options:
P6,
P9,
SL1,
SL2,
PGL1,
PGL2,
AR,
NOT,
RTI,
CIS,
P35,
CISINFO29,
All
service
enum<string> | null
Available options:
PAYE,
CIS,
All

Response

OK

content
object
metadata
object
errors
object[] | null
message
object