Skip to main content
PUT
/
organisation
/
pay-element
/
{payElementId}
Update a specific pay element by ID
curl --request PUT \
  --url https://api.sandbox.flowpayroll.ai/v1/organisation/pay-element/{payElementId} \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "description": "Basic Salary",
  "taxType": "Taxable",
  "niType": "Niable",
  "payType": "Payable",
  "isPensionable": true,
  "accrueHoliday": true,
  "subjectToNmwCheck": true,
  "isClass1ANiable": false,
  "defaultUnitName": "Hour",
  "defaultPayRate": 15.5,
  "defaultUnitValue": 1,
  "defaultChargeRate": 20,
  "billType": "NotBillable",
  "eligibility": {
    "courtOrders": {
      "cmsDeo": true,
      "dea": true,
      "aeoPriority": false,
      "aeoNonPriority": false,
      "ctaeo": false,
      "ea": false,
      "mcaeo": false
    }
  }
}
'
{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {},
    "metadata": {
      "dateFormat": "yyyy-MM-dd",
      "dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "messageToken": "<string>",
  "data": {
    "id": "PE001",
    "description": "Basic Salary",
    "taxType": "Taxable",
    "niType": "Niable",
    "payType": "Payable",
    "isPensionable": true,
    "accrueHoliday": true,
    "subjectToNmwCheck": true,
    "organisationId": "org_123",
    "createdBy": "user_123",
    "updatedBy": "user_456",
    "createdDate": "2024-01-01T00:00:00Z",
    "updatedDate": "2024-01-02T00:00:00Z",
    "isClass1ANiable": false,
    "defaultUnitName": "Hour",
    "defaultPayRate": 15.5,
    "defaultUnitValue": 1,
    "defaultChargeRate": 20,
    "billType": "NotBillable",
    "eligibility": {
      "courtOrders": {
        "cmsDeo": true,
        "dea": true,
        "aeoPriority": false,
        "aeoNonPriority": false,
        "ctaeo": false,
        "ea": false,
        "mcaeo": false
      }
    },
    "isSystemCode": false
  }
}

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

Access token obtained from OAuth2 client credentials flow

Path Parameters

​
payElementId
string
required

The ID of the pay element to update

Body

application/json
​
description
string
required

The description of the pay element

Example:

"Basic Salary"

​
taxType
enum<string>
required

The tax type for the pay element

Available options:
Taxable,
NonTaxable
Example:

"Taxable"

​
niType
enum<string>
required

The National Insurance type for the pay element

Available options:
Niable,
NonNiable,
EmployerOnly
Example:

"Niable"

​
payType
enum<string>
required

The pay type for the pay element

Available options:
Payable,
Deductible,
Informational
Example:

"Payable"

​
isPensionable
boolean
required

Whether the pay element is pensionable

Example:

true

​
accrueHoliday
boolean
required

Whether the pay element accrues holiday

Example:

true

​
subjectToNmwCheck
boolean
required

Whether the pay element is subject to National Minimum Wage checks

Example:

true

​
isClass1ANiable
boolean

Whether the pay element is Class 1A National Insurance liable

Example:

false

​
defaultUnitName
enum<string> | null

The default unit name for the pay element

Available options:
Hour,
Day,
Week,
Month,
Year,
Fixed,
Informational,
Percentage
Example:

"Hour"

​
defaultPayRate
number<decimal> | null

The default pay rate for the pay element

Example:

15.5

​
defaultUnitValue
number<decimal> | null

The default unit value for the pay element

Example:

1

​
defaultChargeRate
number<decimal> | null

The default charge rate for the pay element

Example:

20

​
billType
enum<string>

The billing type for the pay element

Available options:
Billable,
NotBillable
Example:

"NotBillable"

​
eligibility
object

Eligibility flags for this pay element (court orders, pensions, etc.)

Example:
{
  "courtOrders": {
    "cmsDeo": true,
    "dea": true,
    "aeoPriority": false,
    "aeoNonPriority": false,
    "ctaeo": false,
    "ea": false,
    "mcaeo": false
  }
}

Response

The pay element was updated

​
message
object
​
content
object
​
validationIssues
object[]
​
messageToken
string
​
data
object

Pay element details