| Name / Description | Type / Format | Example | |
|---|---|---|---|
uniqueId
Optional. If value is provided then update else create payline.
|
string
uuid
|
"string"
|
|
payrollCode
The payroll code of the employee to update
|
string
|
"string"
|
|
amount
The amount regularly paid to the Employee
|
number
double
|
0.0
|
|
hours
Payment Hours
|
number
double
|
0.0
|
|
days
Payment Days
|
number
double
|
0.0
|
|
percentage
Perentage
|
number
double
|
0.0
|
|
payCode
If you want to override the PayCode used for the Basic Pay then set the code here, otherwise leave this blank and the default will be used.
|
string
|
"string"
|
|
description
Description
|
string
|
"string"
|
|
effectiveFrom
EffectiveFrom date for imported pay lines
|
string
date
|
"2025-06-02"
|
|
effectiveTo
EffectiveTo date for imported pay lines
|
string
date
|
"2025-06-02"
|
|
isNetToGross
IsNetToGross (True/False)
|
boolean
|
true
|
|
department
Associated department of the employee
|
string
|
"string"
|
|
costCentre
Associated costcentre of the employee
|
string
|
"string"
|
|
isAutomaticBackPay
IsAutomaticBackPay for imported pay lines
Only import if 'Effective date salary changes' is enabled |
boolean
|
true
|
|
isAlreadyPaid
IsAlreadyPaid
Only import if 'Effective date salary changes' is enabled |
boolean
|
true
|
|
contributesToBasicPay
ContributesToBasicPay for imported pay lines
Only import if 'Effective date salary changes' is enabled |
boolean
|
true
|
|
proRataAdjustments
ProRataAdjustments (True/False)
|
boolean
|
true
|
|
roleReference
This is the unique reference of the Role that the employee is assigned to.
Only import if 'Multi-Role Settings' are enabled |
string
|
"string"
|
|
paySpine
PaySpine for imported pay lines
Only import if Pay Spines exist |
string
|
"string"
|
|
payGrade
PayGrade for imported pay lines
Only import if Pay Spines exist |
string
|
"string"
|
|
spinalPoint
SpinePoint for imported pay lines
Only import if Pay Spines exist |
string
|
"string"
|
|
londonAllowance
|
string
|
"Inner"
"Outer"
"Fringe"
|
|
treatAsWhenPaid
Only import if 'Education settings' are enabled
|
boolean
|
true
|
{
"uniqueId": "string",
"payrollCode": "string",
"amount": 0.0,
"hours": 0.0,
"days": 0.0,
"percentage": 0.0,
"payCode": "string",
"description": "string",
"effectiveFrom": "2025-06-02",
"effectiveTo": "2025-06-02",
"isNetToGross": true,
"department": "string",
"costCentre": "string",
"isAutomaticBackPay": true,
"isAlreadyPaid": true,
"contributesToBasicPay": true,
"proRataAdjustments": true,
"roleReference": "string",
"paySpine": "string",
"payGrade": "string",
"spinalPoint": "string",
"londonAllowance": "Inner",
"treatAsWhenPaid": true
}- none -
- none -