PayOptions

This object forms the basis of the Employees payment.

Name / Description Type / Format Example
period
The frequency that this Employee is paid
string "Monthly" "FourWeekly" "Fortnightly" "Weekly"
payAmount
The amount the Employee is regularly paid each period
number double 0.0
basis
If the payAmount is an Daily or Hourly rate then you should set this accordingly.
If however it's a set amount for the period then set this to Monthly
string "Hourly" "Daily" "Monthly"
nationalMinimumWage boolean true
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
autoAdjustForLeave
Automatically reduce the PayAmount when the Employee has Leave that is either Not Paid or has Statutory Pay.
Can only be set to True if the Basis is Monthly (ie, employee is not paid an hourly or daily rate).
If set to false then you must manually reduce their payment to reflect any Leave
boolean true
method
The method used to actually pay the Employee
string "Cash" "Cheque" "Credit" "DirectDebit"
payCode
If you want the Employees pay to be allocated to a code other than BASIC, specify it here
string "string"
withholdTaxRefundIfPayIsZero
If you don't want negative PAYE values when the Gross pay is zero, set this to true
boolean true
mileageVehicleType
If you are paying employee for mileage in their own vehicle, set the type of vehicle here
string "Car" "Motorcycle" "Cycle"
mapsMiles
The number of miles to pay for as Mileage Allowance Payments
integer int32 0
taxAndNi TaxAndNi {TaxAndNi}
fpsFields FpsFields {FpsFields}
regularPayLines
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.
PayLine[] {PayLine}
{
  "period": "Monthly",
  "payAmount": 0.0,
  "basis": "Hourly",
  "nationalMinimumWage": true,
  "payAmountMultiplier": 0.0,
  "autoAdjustForLeave": true,
  "method": "Cash",
  "payCode": "string",
  "withholdTaxRefundIfPayIsZero": true,
  "mileageVehicleType": "Car",
  "mapsMiles": 0,
  "taxAndNi": {
    "niTable": "string",
    "secondaryClass1NotPayable": true,
    "postgradLoan": true,
    "studentLoan": "None",
    "taxCode": "string",
    "week1Month1": true
  },
  "fpsFields": {
    "irregularPaymentPattern": true,
    "nonIndividual": true,
    "hoursNormallyWorked": "LessThan16",
    "flexibleDrawdown": {
      "hasFlexibleDrawdown": true,
      "death": true,
      "pension": true,
      "taxablePayment": 0.0,
      "nonTaxablePayment": 0.0
    },
    "trivialCommutationPayment": {
      "hasTrivialCommutationPayment": true,
      "tcls": 0.0,
      "personalPension": 0.0,
      "occupationalPension": 0.0
    }
  },
  "regularPayLines": [
    {
      "value": 0.0,
      "rate": 0.0,
      "multiplier": 0.0,
      "description": "string",
      "code": "string"
    }
  ]
}
Contained in Models
Employee
Employer
PayRunEntry
Payslip
Consumed by Operations
Apply PayOptions
Returned by Operations

- none -

Getting Started Understanding PayOptions