Skip to main content
GET
/
calculations
/
employees
/
{employeeId}
/
history
cURL
curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/statutory-pay/calculations/employees/{employeeId}/history \
  --header 'X-Auth-Token: <api-key>'
{
  "content": {
    "data": {
      "employeeId": "<string>",
      "sicknessChains": [
        {
          "chainId": "<string>",
          "startDate": "<string>",
          "endDate": "<string>",
          "totalWeeksUsed": 123,
          "remainingWeeks": 123,
          "periods": [
            {
              "id": "<string>",
              "startDate": "<string>",
              "endDate": "<string>",
              "totalAmount": 123,
              "averageEarnings": 123,
              "relevantPeriodEarnings": [
                {
                  "payDate": "<string>",
                  "amount": 123,
                  "description": "<string>"
                }
              ],
              "dailyBreakdown": [
                {
                  "date": "<string>",
                  "amount": 123,
                  "description": "<string>",
                  "isLinked": true
                }
              ]
            }
          ]
        }
      ],
      "otherPayments": [
        {
          "id": "<string>",
          "startDate": "<string>",
          "endDate": "<string>",
          "totalAmount": 123,
          "averageEarnings": 123,
          "relevantPeriodEarnings": [
            {
              "payDate": "<string>",
              "amount": 123,
              "description": "<string>"
            }
          ],
          "dailyBreakdown": [
            {
              "date": "<string>",
              "amount": 123,
              "description": "<string>",
              "isLinked": true
            }
          ]
        }
      ]
    },
    "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

Path Parameters

employeeId
string
required

Response

OK

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