Skip to main content
POST
/
calculations
/
preview
cURL
curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/statutory-pay/calculations/preview \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "startDate": "<string>",
  "employmentStartDate": "<string>",
  "payFrequency": "<string>",
  "earnings": [
    123
  ],
  "endDate": "<string>",
  "qualifyingEventDate": "<string>",
  "workingDays": {
    "standardWorkingDays": {
      "monday": true,
      "tuesday": true,
      "wednesday": true,
      "thursday": true,
      "friday": true,
      "saturday": true,
      "sunday": true
    },
    "shiftPattern": {
      "rotationStartDate": "<string>",
      "shifts": [
        {
          "name": "<string>",
          "workingDays": {
            "monday": true,
            "tuesday": true,
            "wednesday": true,
            "thursday": true,
            "friday": true,
            "saturday": true,
            "sunday": true
          },
          "durationInDays": 123,
          "weekNumber": 123
        }
      ],
      "patternType": "<string>",
      "patternWeeks": 123
    },
    "workingPattern": "<string>"
  },
  "paidWeeks": 123,
  "paidUntilDate": "<string>",
  "isReceivingStatutoryMaternityPay": true,
  "previousSicknessPeriods": [
    {
      "startDate": "<string>",
      "endDate": "<string>",
      "wereFirstThreeDaysPaid": true
    }
  ]
}
'
{
  "content": {
    "data": {
      "statutoryType": "<string>",
      "typeDiscriminator": "<string>",
      "totalAmount": 123,
      "statutoryId": "<string>",
      "uploadUrls": [
        {
          "attachmentId": "<string>",
          "filename": "<string>",
          "uploadUrl": "<string>",
          "expiresAt": "<string>"
        }
      ],
      "nonRoundedTotalAmount": 123,
      "requestDate": "<string>",
      "startDate": "<string>",
      "endDate": "<string>",
      "breakdown": [
        {
          "year": 123,
          "period": 123,
          "frequency": "<string>",
          "week": 123,
          "value": 123,
          "nonRoundedValue": 123,
          "status": "<string>"
        }
      ],
      "maxEndDate": "<string>",
      "dailyBreakdown": [
        {
          "date": "<string>",
          "amount": 123,
          "description": "<string>",
          "isLinked": true
        }
      ],
      "periodRange": "<string>",
      "warnings": [
        {
          "message": "<string>",
          "details": {
            "accruedWeeks": 123,
            "accruedAmount": 123,
            "accrualPaymentDate": "<string>",
            "closedPeriods": [
              {
                "year": 123,
                "period": 123,
                "payPeriodStartDate": "<string>",
                "payPeriodEndDate": "<string>",
                "paymentDate": "<string>"
              }
            ]
          }
        }
      ]
    },
    "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
startDate
string
required
Minimum string length: 1
employmentStartDate
string
required
Minimum string length: 1
payFrequency
string
required
Minimum string length: 1
earnings
number<double>[]
required
endDate
string | null
qualifyingEventDate
string | null
workingDays
object
paidWeeks
number<double> | null
paidUntilDate
string | null
isReceivingStatutoryMaternityPay
boolean
previousSicknessPeriods
object[] | null

Response

OK

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