This object is used to import payment information for a payrun entry
| Name / Description | Type / Format | Example | |
|---|---|---|---|
employerIdentifier
Optional. But if one entry has it then all must.
Allows you to import to multiple employers by specifying the Employers AlternativeIdentifier |
string
|
"string"
|
|
payrollCode
The payroll code of the employee to update
|
string
|
"string"
|
|
payAmount
The amount the Employee is regularly paid each period
|
number
double
|
0.0
|
|
basis
|
string
|
"Hourly"
"Daily"
"Monthly"
|
|
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"
|
|
roleReference
This is the unique reference of the Role that the employee is assigned to.
|
string
|
"string"
|
|
payAmountMultiplier
This property is irrelevant if the basis is Monthly.
But if the basis is Daily or Hourly then this property sets how many days/hours the employee should be paid for in the period. |
number
double
|
0.0
|
|
note
Any note that you'd like to appear on the payslip
|
string
|
"string"
|
|
tags
|
string[]
|
|
|
isNetToGross
|
boolean
|
true
|
|
department
Any Department that you'd like to appear on the payslip
|
string
|
"string"
|
|
costCentre
Any CostCentre that you'd like to appear on the payslip
|
string
|
"string"
|
|
analysisCategoryCodes
List of Analysis Category Codes associated with this item on the payslip.
|
AnalysisCategoryCodes[]
|
{AnalysisCategoryCodes}
|
|
lines
|
PayLine[]
|
{PayLine}
|
|
effectiveFrom
EffectiveFrom date for imported pay lines
|
string
date
|
"2025-06-22"
|
|
effectiveTo
EffectiveTo date for imported pay lines
|
string
date
|
"2025-06-22"
|
|
isAutomaticBackPay
IsAutomaticBackPay for imported pay lines
|
boolean
|
true
|
|
ignoreInitialBackPay
IgnoreInitialBackPay for imported pay lines
|
boolean
|
true
|
|
contributesToBasicPay
ContributesToBasicPay for imported pay lines
|
boolean
|
true
|
|
autoAdjustForLeave
AutoAdjustForLeave for imported pay lines
|
boolean
|
true
|
|
paySpine
PaySpine for imported pay lines
|
string
|
"string"
|
|
payGrade
PayGrade for imported pay lines
|
string
|
"string"
|
|
spinePoint
SpinePoint for imported pay lines
|
string
|
"string"
|
{
"employerIdentifier": "string",
"payrollCode": "string",
"payAmount": 0.0,
"basis": "Hourly",
"payCode": "string",
"roleReference": "string",
"payAmountMultiplier": 0.0,
"note": "string",
"tags": [
"string"
],
"isNetToGross": true,
"department": "string",
"costCentre": "string",
"analysisCategoryCodes": [
{
"analysisCategory": "string",
"analysisCategoryCode": "string",
"analysisCategoryId": "string",
"analysisCategoryCodeId": "string"
}
],
"lines": [
{
"value": 0.0,
"rate": 0.0,
"multiplier": 0.0,
"description": "string",
"attachmentOrderId": "string",
"pensionId": "string",
"leaveId": "string",
"loanId": "string",
"benefitId": 0,
"leaveStatutoryDaysPaid": 0.0,
"leaveStatutoryWeeksPaid": 0.0,
"code": "string",
"tags": [
"string"
],
"childId": "string",
"isNetToGross": true,
"targetNetToGrossValue": 0.0,
"netToGrossDiscrepancy": 0.0,
"effectiveFrom": "2025-06-22",
"effectiveTo": "2025-06-22",
"department": "string",
"departmentTitle": "string",
"costCentre": "string",
"costCentreTitle": "string",
"departmentId": "string",
"costCentreId": "string",
"isAutoGeneratedBasicPayLine": true,
"percentageOfEffectiveDays": 0.0,
"totalWorkingDays": 0.0,
"isTaxable": true,
"isAutomaticBackPay": true,
"ignoreInitialBackPay": true,
"initialBackPayPublicPayRunId": "string",
"autoAdjustForLeave": true,
"contributesToBasicPay": true,
"calculateAsWhenPaid": true,
"totalPaidDays": 0.0,
"roleId": "string",
"employeeRoleReference": "string",
"earnedFrom": "2025-06-22",
"earnedTo": "2025-06-22",
"periodFrom": "2025-06-22",
"periodTo": "2025-06-22",
"annualValue": 0.0,
"parentId": "string",
"isAutoCalculatedBackPayLine": true,
"isZeroHoursTeachersBackPayLine": true,
"analysisCategoriesCodes": [
{
"analysisCategory": "string",
"analysisCategoryCode": "string",
"analysisCategoryId": "string",
"analysisCategoryCodeId": "string"
}
],
"analysisCategoryCodeIds": [
"string"
],
"paySpineId": "string",
"paySpineGradeId": "string",
"spinalPointId": "string",
"londonAllowanceId": 0,
"fullTimeAnnualValue": 0.0,
"paySpine": "string",
"payGrade": "string",
"spinePoint": "string",
"payrollCode": "string"
}
],
"effectiveFrom": "2025-06-22",
"effectiveTo": "2025-06-22",
"isAutomaticBackPay": true,
"ignoreInitialBackPay": true,
"contributesToBasicPay": true,
"autoAdjustForLeave": true,
"paySpine": "string",
"payGrade": "string",
"spinePoint": "string"
}- none -
- none -