Skip to main content
GET
/
employees
/
{employeeId}
/
history
Get holiday history for an employee
curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/holiday/employees/{employeeId}/history \
  --header 'X-Auth-Token: <api-key>'
{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {
      "yearlySummaries": [
        {
          "year": 123,
          "yearStartDate": "<string>",
          "yearEndDate": "<string>",
          "openingBalanceHours": 123,
          "openingBalanceValue": 123,
          "accruedHours": 123,
          "accruedValue": 123,
          "takenHours": 123,
          "takenValue": 123,
          "closingBalanceHours": 123,
          "closingBalanceValue": 123
        }
      ],
      "transactions": [
        {
          "id": "<string>",
          "date": "<string>",
          "type": "<string>",
          "description": "<string>",
          "baseHours": 123,
          "baseValue": 123,
          "hours": 123,
          "value": 123,
          "configType": "<string>",
          "configRate": 123,
          "averageRate": 123,
          "weeksCount": 123,
          "balanceHours": 123,
          "balanceValue": 123
        }
      ]
    },
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<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

Query Parameters

fromDate
string
toDate
string

Response

OK

message
object
content
object