Contract.PaySpineRequest

Name / Description Type / Format Example
name
Name of the Pay Spine
string "string"
fullTimeHours
Maximum Full Time Hours on this Pay Spine
number double 0.0
fullTimeWeeks
Maximum Full Time Weeks on this Pay Spine
number double 0.0
salaryFormula
Formula used to derive annual salary

The salary formula consists of the following elements and Round functions:
- PointValue (The value of an individual Spinal Point)
- HoursWorked (The hours an employee is contracted to work for in their role)
- FTHours (The full time hours specified for an employee in their role)
- WeeksWorked (The contracted weeks an employee works in their role)
- FTWeeks (The full weeks specified for an employee in their role)
Round functions:
- ROUND(Value,decimal places): Round the value to specific decimal places. The maximum value is between 0 and 15.
- ROUNDUP(Value)
- ROUNDDOWN(Value)
- TRUNCATE(Value)

For example: "PointValue * ROUND(HoursWorked * WeeksWorked * (7/365),3) / FTHours"
string "string"
hourlyDivisor
Hours used to determine Hourly Rate
number double 0.0
hourlyDecimals
Number of decimal places to calculate Hourly Rates
integer int32 0
dailyDivisor
Days used to determine Full time Daily Rate
number double 0.0
dailyDecimals
Number of decimal places to calculate Daily Rates
integer int32 0
annualDecimals
Number of decimal places to calculate Annual Salaries
integer int32 0
annualRoundingRule string "RoundOff" "Exact" "RoundUp" "RoundDown"
incrementRule string "Manual" "Annual" "April" "April6m"
requiresLondonAllowance
Requires LA column to be completed on the spine
boolean true
gradeEffectiveDate
Effective date for applicable grades
string date "2024-12-05"
pointEffectiveDate
Effective date for applicable spinal points
string date "2024-12-05"
useSpineHolidayRules
Flag to include holiday entitlements in Payspine (Default false)
boolean true
holidayEntitlements
PaySpine Holiday Entitlements
Contract.HolidayEntitlementRequest[] {Contract.HolidayEntitlementRequest}
{
  "name": "string",
  "fullTimeHours": 0.0,
  "fullTimeWeeks": 0.0,
  "salaryFormula": "string",
  "hourlyDivisor": 0.0,
  "hourlyDecimals": 0,
  "dailyDivisor": 0.0,
  "dailyDecimals": 0,
  "annualDecimals": 0,
  "annualRoundingRule": "RoundOff",
  "incrementRule": "Manual",
  "requiresLondonAllowance": true,
  "gradeEffectiveDate": "2024-12-05",
  "pointEffectiveDate": "2024-12-05",
  "useSpineHolidayRules": true,
  "holidayEntitlements": [
    {
      "effectiveDate": "2024-12-05",
      "baseHolidayEntitlement": 0.0,
      "yearsServiceEntitlementBasis": "RoleStartDate",
      "yearsServiceEntitlements": [
        {
          "yearsService": 0,
          "totalAdditionalDaysHoliday": 0.0
        }
      ]
    }
  ]
}
Contained in Models

- none -

Consumed by Operations
Create PaySpine
Returned by Operations

- none -