PayLine

As well as the basic pay amount for an employee there are often additions and deductions such as bonuses.
These additions and deductions are represented using this model.

Name / Description Type / Format Example
value
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.
number double 0.0
rate
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
number double 0.0
multiplier
If the related PayCode has a MultiplierType other than None then this field will be used as number of days or hours
number double 0.0
description
A freeform description to accompany this line. It will be displayed on the payslip.
string "string"
code
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.
string "string"
{
  "value": 0.0,
  "rate": 0.0,
  "multiplier": 0.0,
  "description": "string",
  "code": "string"
}
Contained in Models
PayOptions
PayOptionsImport
Consumed by Operations

- none -

Returned by Operations

- none -