PayOptions

This object forms the basis of the Employees payment.

Name / Description Type / Format Example
period string "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily" "Custom"
ordinal
Indicates whether to use first, second, third (etc) PaySchedule for this PayPeriod.
integer int32 0
payAmount
The amount the Employee is regularly paid each period
number double 0.0
basis 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 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 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}
tags string[]
{
  "period": "Monthly",
  "ordinal": 0,
  "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": {
    "offPayrollWorker": true,
    "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",
      "tags": [
        "string"
      ]
    }
  ],
  "tags": [
    "string"
  ]
}
Contained in Models
Employee
Employer
PayRunEntry
Payslip
Consumed by Operations
Apply PayOptions
Returned by Operations

- none -

Getting Started Understanding PayOptions
Getting Started The Ordinal property
Getting Started Using Tags