PayRunEntry.md

# PayRunEntry

Properties

Name	Type	Description	Notes
aeNotEnroledWarning	bool	[readonly] If true then this Employee needs to be on an Auto Enrolment pension but isn't yet.	[optional]
bacsHashCode	string	[readonly] A Hash Code used for RTI BACS Hash Cross Reference	[optional]
bacsSubReference	string	[readonly] A randomly generated string for use with the RTI Hash Cross Reference	[optional]
differencePensionSummaries	\SynergiTech\Staffology\Model\PensionSummary[]	[readonly] A summary of the details for the Pensions (if any) that the Employee is assigned to.	[optional]
emailId	string	If the Payslip for this PayRunEntry has been emailed to the employee then the Id for an EmployerEmail will be provided here. if the value is all zeroes then the email is in the process of being created.	[optional]
employee	\SynergiTech\Staffology\Model\Item		[optional]
employeeRolePayItems	\SynergiTech\Staffology\Model\EmployeeRolePayItem[]	[readonly] Automatically populated. Array of base hourly and daily rates for the employee roles	[optional]
employmentDetails	\SynergiTech\Staffology\Model\EmploymentDetails		[optional]
endDate	\DateTime	[readonly]	[optional]
forcedCisVatAmount	float	If this employee is a CIS Subcontractor registered for VAT, we'll automatically work out VAT at the set rate. If you want to override this calculations then set this property to anything other than null.	[optional]
fps	\SynergiTech\Staffology\Model\Item		[optional]
hasAttachmentOrders	bool	[readonly] Indicates that there are AttachmentOrders for this Employee in this entry	[optional]
holidayAccrued	float	The amount of holiday days or hours accrued in the period.	[optional]
id	string	[readonly] The unique id of the object	[optional] [readonly]
isClosed	bool	[readonly] Set to True if the PayRun is Finalised and changes can no longer be made to the PayRunEntries	[optional] [readonly]
isLatestVersion	bool	[readonly] Indicates whether this is the latest version of the PayRunEntry.	[optional]
isNewStarter	bool	Determines whether or not this Employee will be declared as a new starter on the resulting FPS	[optional]
isRemoved	bool	Has the entry been removed from the payrun	[optional]
isRolledBack	bool	[readonly] Set to True if the Pay Run Entry is currently rolled back	[optional]
manualNi	bool	If set to true then you must provide your own value for NationalInsuranceCalculation. You'd normally leave this set to false and let us automatically calculate NI amounts.	[optional]
nationalInsuranceCalculation	\SynergiTech\Staffology\Model\NationalInsuranceCalculation		[optional]
niLetterError	\SynergiTech\Staffology\Model\NiLetterError		[optional]
niSplit	bool	If set to true Ni calculations are done for backdated pay for each pay period separately and then summed up	[optional]
note	string	Any note that you'd like to appear on the payslip	[optional]
ordinal	int	[readonly] Indicates whether this uses the first, second, third (etc) PaySchedule for this PayPeriod.	[optional]
originalPayRunEntryPaymentDate	\DateTime	[readonly] If this PayRunEntry is a supplementary PayRunEntry then this will be the date of the original PayRunEntry's Payment Date	[optional]
payOptions	\SynergiTech\Staffology\Model\PayOptions		[optional]
payPeriod	\SynergiTech\Staffology\Model\PayPeriods		[optional]
payRunVersion	int	[readonly] The supplementary pay run version of this PayRunEntry.	[optional]
paymentAfterLeaving	bool	[readonly] If this payment is for an employee that has left then this is set to true.	[optional]
paymentDate	\DateTime	The date this payment was or will be made	[optional]
payrollCodeChanged	bool	[readonly] Indicates whether or not the Payroll Code for this Employee has changed since the last FPS	[optional] [readonly]
pensionSummaries	\SynergiTech\Staffology\Model\PensionSummary[]	[readonly] A summary of the details for the Pensions (if any) that the Employee is assigned to.	[optional]
pensionSummary	\SynergiTech\Staffology\Model\PensionSummary		[optional]
percentageOfWorkingDaysPaidAsNormal	float	[readonly] If the employee is paid a set amount per period (ie, not an hourly or daily rate) and there is any Leave that is either Not Paid or Statutory Pay then this value will give the percentage of working days (based on the Working Pattern) that should be paid as normal. If there is no Leave in the period or PayOptions.AutoAdjustForLeave is false, then this will be 1.	[optional]
period	int	[readonly] The Tax Week or Tax Month number this PayRunEntry relates to	[optional]
periodOverrides	\SynergiTech\Staffology\Model\ValueOverride[]	Any calculated values for this period that should be overridden with a different value	[optional]
periodsCovered	int	[readonly] The amount of periods that the Pay Run Entry covers. This can be > 1 when back pay for previous periods is paid in the current period	[optional]
personalDetails	\SynergiTech\Staffology\Model\PersonalDetails		[optional]
previousVersionTotals	\SynergiTech\Staffology\Model\PayRunTotals		[optional]
priorPayrollCode	string	[readonly] If the FPS needs to declare a change of PayId then this will contain the previous code It's worked out automatically but can also be set from the Employees EmploymentDetails property.	[optional]
recievingOffsetPay	bool	If the pay is being topped up due to an applied Leave having the offset value set to true then this will be set to true	[optional]
startDate	\DateTime	[readonly]	[optional]
state	\SynergiTech\Staffology\Model\PayRunState		[optional]
taxMonth	int	[readonly] The Tax Month that the Payment Date falls in	[optional]
taxYear	\SynergiTech\Staffology\Model\TaxYear		[optional]
teachersPensionAgeWarning	\SynergiTech\Staffology\Model\TeachersPensionAgeWarning		[optional]
totals	\SynergiTech\Staffology\Model\PayRunTotals		[optional]
totalsYtd	\SynergiTech\Staffology\Model\PayRunTotals		[optional]
totalsYtdOverrides	\SynergiTech\Staffology\Model\ValueOverride[]	Any values of TotalsYtd that should be overridden with a different value	[optional]
umbrellaPayment	\SynergiTech\Staffology\Model\UmbrellaPayment		[optional]
unpaidAbsence	bool	[readonly] Indicates that there was unpaid absence in the pay period	[optional]
warnings	\SynergiTech\Staffology\Model\PayRunEntryWarningType		[optional]
workingDaysNotPaidAsNormal	float	[readonly] If PercentageOfWorkingDaysPaidAsNormal has a value other than 1 then this property will tell you how many working days have been deducted from the basic pay due to either being Not Paid or Statutory Pay	[optional]

[Back to Model list] [Back to API list] [Back to README]