| analysisCategoriesCodes |
\SynergiTech\Staffology\Model\ContractPaylineAnalysisCategoriesCodes[] |
List of analysiscategory id and analysiscategoryCode id |
[optional] |
| analysisCategoryCodeIds |
string[] |
Array of analysiscategoryCode uniqueId |
[optional] |
| annualValue |
float |
The original value from the PayLine before we modify it Currently only used when CalculationType is set to FixedAnnualAmount so we can determine whether the payline value needs calculating or not To recalculate set to null with annual amount recorded in Value |
[optional] |
| attachmentOrderId |
string |
[readonly] The Id of the associated AttachmentOrder. Only included if the Code is AEO |
[optional] |
| autoAdjustForLeave |
bool |
This sets whether the PayLine should be automatically adjusted or not for: Leave Entries; Starters/Leavers; PayLine effectiveFrom and effectiveTo values falling mid-way through a PayRun |
[optional] |
| calculateAsWhenPaid |
bool |
Indicates whether this pay line should be treated as When Paid rather than When Earned |
[optional] |
| childId |
string |
|
[optional] |
| code |
string |
The Code of the PayCode this line is assigned to. The PayCode determines the treatment of this line when it comes to NI, Tax and Pensions as well as whether it's a deduction or addition. |
[optional] |
| contributesToBasicPay |
bool |
Indicates whether this PayLine contributes to the basic pay of the Employee. |
[optional] |
| costCentre |
string |
CostCentre code which we want to override in payline |
[optional] |
| costCentreId |
string |
CostCentre uniqueId which we want to override in payline |
[optional] |
| department |
string |
Department code which we want to override in payline |
[optional] |
| departmentId |
string |
Department uniqueId which we want to override in payline |
[optional] |
| description |
string |
A freeform description to accompany this line. It will be displayed on the payslip. |
[optional] |
| earnedFrom |
\DateTime |
|
[optional] |
| earnedTo |
\DateTime |
|
[optional] |
| effectiveFrom |
\DateTime |
The date the payline starts being calculated in payrun |
[optional] |
| effectiveTo |
\DateTime |
The date the payline stops being calculated in payrun |
[optional] |
| fullTimeAnnualValue |
float |
Used to set Full Time Annual Value for payline |
[optional] |
| id |
string |
|
[optional] |
| ignoreInitialBackPay |
bool |
Skip the automatic backpay calculation on the first pay run, if the addition/deduction had been paid outside or Staffology. If set to false, the automatic backpay calculation will be performed on the first pay run. |
[optional] |
| initialBackPayPublicPayRunId |
string |
[readonly] Used to mark the first payrun where this payline has been payrolled for backpay |
[optional] |
| isAutoGeneratedBasicPayLine |
bool |
|
[optional] |
| isAutomaticBackPay |
bool |
Automatically calculate backpay and add or modify the necessary pay lines for this addition/deduction when a pay run is created. Applicable only to employee level addition/deduction pay lines. If set to false then you must manually handle the calculation and adding of backpay lines. |
[optional] |
| isNetToGross |
bool |
If the PayLine is a fixed ammount addition without multiplier then this property may be set to true so that the amount of the addition to be considered a take home pay target. |
[optional] |
| leaveId |
string |
[readonly] The Id of the associated Leave. Only included if the PayLine is a result of a Leave with Statutory pay |
[optional] |
| leaveStatutoryDaysPaid |
float |
[readonly] If the PayLine is a result of a Leave with Statutory Pay then this property tells you how many days they've been paid for (based on their Working Pattern). |
[optional] |
| leaveStatutoryWeeksPaid |
float |
[readonly] If the PayLine is a result of a Leave with Statutory Pay then this property tells you how many weeks they've been paid for (based on their Working Pattern). |
[optional] |
| loanId |
string |
[readonly] The Id of the associated Loan, if any. |
[optional] |
| londonAllowanceId |
int |
Used to set London allowance id for payline |
[optional] |
| multiplier |
float |
If the related PayCode has a MultiplierType other than None then this field will be used as number of days or hours |
[optional] |
| netToGrossDiscrepancy |
float |
The discrepancy between the targeted and the calculated grossed up value durig a net to gross calculation. |
[optional] |
| paySpineGradeId |
string |
[readonly] The Id of the associated pay spine grade. |
[optional] |
| paySpineId |
string |
[readonly] The Id of the associated pay spine. |
[optional] |
| pensionId |
string |
[readonly] The Id of the associated Pension. Only included if the Code is PENSION, PENSIONSS or PENSIONRAS |
[optional] |
| percentageOfEffectiveDays |
float |
The percentage of working days the effective dates span for pro-rata'ing values, calculated/set during each payrun |
[optional] |
| rate |
float |
If the related PayCode has a MultiplierType other than None then this field will be used as the rate per day or hour. Otherwise it isn't used |
[optional] |
| roleId |
string |
The employee role which is associated with this pay line. If set to null, the pay line is not related with a role. |
[optional] |
| spinalPointId |
string |
[readonly] The Id of the associated spinal point. |
[optional] |
| tags |
string[] |
|
[optional] |
| targetNetToGrossValue |
float |
The orginal net fixed addition amount that is considered to be a take home pay target. |
[optional] |
| totalPaidDays |
float |
|
[optional] |
| totalWorkingDays |
float |
|
[optional] |
| value |
float |
The amount to add or deduct (whether it is a deduction or addition depends on the PayCode used). If the PayCode has a CalculationType other than FixedAmount then this field will be a percentage. If the PayCode has a MultiplierType other than None then this field will be readonly and automatically calculated. |
[optional] |