Skip to content

Latest commit

 

History

History
29 lines (26 loc) · 3.13 KB

PayOptions.md

File metadata and controls

29 lines (26 loc) · 3.13 KB

# PayOptions

Properties

Name Type Description Notes
period \SynergiTech\Staffology\Model\PayPeriods [optional]
ordinal int Indicates whether to use first, second, third (etc) PaySchedule for this PayPeriod. [optional]
method \SynergiTech\Staffology\Model\PayMethod [optional]
withholdTaxRefundIfPayIsZero bool If you don't want negative PAYE values when the Gross pay is zero, set this to true [optional]
taxAndNi \SynergiTech\Staffology\Model\TaxAndNi [optional]
fpsFields \SynergiTech\Staffology\Model\FpsFields [optional]
tags string[] [optional]
basis \SynergiTech\Staffology\Model\PayBasis [optional]
nationalMinimumWage bool [optional]
payCode string If you want the Employees pay to be allocated to a code other than BASIC, specify it here [optional]
mileageVehicleType \SynergiTech\Staffology\Model\MileageVehicleType [optional]
mapsMiles int The number of miles to pay for as Mileage Allowance Payments [optional]
payAmount float The amount the Employee is regularly paid each period [optional]
payAmountMultiplier float 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. [optional]
baseHourlyRate float This property is used to calculate values for PayCodes that are set as multiples of the employees base hourly rate. Eg Overtime. If this is set as zero then we'll attempt to calculate a value based on the other fields [optional]
baseDailyRate float This property is used to calculate values for PayCodes that are set as multiples of the employees base daily rate. Eg sick. If this is set as zero then we'll attempt to calculate a value based on the other fields [optional]
basicPay float The amount of basic pay the Employee is regularly paid each period This amount is the combined total of all pay elements that contribute to basic pay [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]
niTable string [optional]
regularPayLines \SynergiTech\Staffology\Model\PayLine[] These are used to make additions/deductions to the pay for this Employee. You do not need to include Pension, Tax, NI, Loan Repayments, etc as these will all be automatically created. [optional]
excludedRegularPayLines \SynergiTech\Staffology\Model\PayLine[] These used to store the PayLines that have been excluded from RegularPaylines. [optional]

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