This object is used to import payment information for a payrun entry
| Name / Description | Type / Format | Example | |
|---|---|---|---|
employerIdentifier
Optional. But if one entry has it then all must.
Allows you to import to multiple employers by specifying the Employers AlternativeIdentifier |
string
|
"string"
|
|
payrollCode
The payroll code of the employee to update
|
string
|
"string"
|
|
payAmount
The amount the Employee is regularly paid each period
|
number
double
|
0.0
|
|
basis
|
string
|
"Hourly"
"Daily"
"Monthly"
|
|
payCode
If you want to override the PayCode used for the Basic Pay then set the code here, otherwise leave this blank and the default will be used.
|
string
|
"string"
|
|
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
|
|
note
Any note that you'd like to appear on the payslip
|
string
|
"string"
|
|
tags
|
string[]
|
|
|
lines
|
PayLine[]
|
{PayLine}
|
{
"employerIdentifier": "string",
"payrollCode": "string",
"payAmount": 0.0,
"basis": "Hourly",
"payCode": "string",
"payAmountMultiplier": 0.0,
"note": "string",
"tags": [
"string"
],
"lines": [
{
"value": 0.0,
"rate": 0.0,
"multiplier": 0.0,
"description": "string",
"attachmentOrderId": "string",
"pensionId": "string",
"code": "string",
"tags": [
"string"
]
}
]
}