Skip to main content
POST
/
pension-calculation
cURL
curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/pension/pension-calculation \
  --header 'Content-Type: application/json' \
  --data '
{
  "employeeId": "<string>",
  "frequency": "<string>",
  "year": 123,
  "period": 123,
  "payrollConfigId": "<string>",
  "employeeAmount": 123,
  "employerAmount": 123,
  "periodStart": "2023-12-25",
  "periodEnd": "2023-12-25",
  "nationalInsuranceNumber": "<string>",
  "externalReferenceId": "<string>",
  "pensionProviderId": "<string>"
}
'
{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {
      "employeeId": "<string>",
      "frequency": "<string>",
      "year": 123,
      "period": 123,
      "payrollConfigId": "<string>",
      "organisationId": "<string>",
      "employeeAmount": 123,
      "employerAmount": 123,
      "periodStart": "2023-12-25",
      "periodEnd": "2023-12-25",
      "nationalInsuranceNumber": "<string>",
      "externalReferenceId": "<string>",
      "pensionProviderId": "<string>"
    },
    "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.

Body

application/json
employeeId
string
frequency
string
year
integer<int32>
period
integer<int32>
payrollConfigId
string
employeeAmount
number<decimal>
employerAmount
number<decimal>
periodStart
string<date>
periodEnd
string<date>
nationalInsuranceNumber
string
externalReferenceId
string
pensionProviderId
string

Response

message
object
content
object