Skip to main content
POST
/
pension-group
cURL
curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v2/pension/pension-group \
  --header 'Content-Type: application/json' \
  --data '
{
  "pensionSchemaId": "<string>",
  "name": "<string>",
  "basis": "<string>",
  "employeeFactor": 123,
  "employerFactor": 123,
  "isDefault": true,
  "isSalarySacrifice": true,
  "nationalInsuranceSavingsFactor": 123
}
'
{
  "content": {
    "data": {
      "id": "<string>",
      "organisationId": "<string>",
      "pensionSchemaId": "<string>",
      "name": "<string>",
      "isDefault": true,
      "basis": "<string>",
      "employeeFactor": 123,
      "employerFactor": 123,
      "nationalInsuranceSavingsFactor": 123,
      "createdBy": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "updatedDate": "2023-11-07T05:31:56Z",
      "isSalarySacrifice": 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.

Body

application/json
pensionSchemaId
string | null
required
name
string | null
required
basis
string | null
required
employeeFactor
number<float>
required
employerFactor
number<float>
required
isDefault
boolean
pensionType
enum<string> | null
Available options:
ReliefAtSource,
SalarySacrifice,
NetPayArrangement
isSalarySacrifice
boolean
nationalInsuranceSavingsFactor
number<float>

Response

200 - application/json

OK

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