EmploymentDetails

Name / Description Type / Format Example
cisSubContractor
Set to True if this Employee is a CIS Subcontractor. The Cis property contains further information
boolean true
payrollCode
The Employees Payroll Code. Must be unique within the Employer.
string "string"
jobTitle
The Employees Job Title.
string "string"
onFurlough
Set to true if the emplotyee is on furlough.
boolean true
furloughStart
Furlough Start Date.
string date "2020-07-12"
furloughEnd
Furlough End Date.
string date "2020-07-12"
furloughCalculationBasis string "ActualPaidAmount" "DailyReferenceAmount" "MonthlyReferenceAmount"
furloughCalculationBasisAmount number double 0.0
isApprentice
Set to True if this Employee is an apprentice. This affects the calculations for National Minimum Wage
boolean true
workingPattern
Used when calculating payments for Leave.
If null then the default Working Pattern is used
string uuid "string"
forcePreviousPayrollCode
If this property has a non-empty value then a change of Payroll code will be declared on the next FPS.
string "string"
starterDetails StarterDetails {StarterDetails}
directorshipDetails DirectorshipDetails {DirectorshipDetails}
leaverDetails LeaverDetails {LeaverDetails}
cis
If an Employee is marked as a CIS Subcontractor then this model provides further details specifically related to the CIS details of the Employee.
CisDetails {CisDetails}
department Department {Department}
{
  "cisSubContractor": true,
  "payrollCode": "string",
  "jobTitle": "string",
  "onFurlough": true,
  "furloughStart": "2020-07-12",
  "furloughEnd": "2020-07-12",
  "furloughCalculationBasis": "ActualPaidAmount",
  "furloughCalculationBasisAmount": 0.0,
  "isApprentice": true,
  "workingPattern": "string",
  "forcePreviousPayrollCode": "string",
  "starterDetails": {
    "startDate": "2020-07-12",
    "starterDeclaration": "A",
    "overseasEmployerDetails": {
      "overseasEmployer": true,
      "overseasSecondmentStatus": "MoreThan183Days",
      "eeaCitizen": true,
      "epm6Scheme": true
    }
  },
  "directorshipDetails": {
    "isDirector": true,
    "startDate": "2020-07-12",
    "leaveDate": "2020-07-12",
    "niAlternativeMethod": true
  },
  "leaverDetails": {
    "hasLeft": true,
    "leaveDate": "2020-07-12",
    "isDeceased": true
  },
  "cis": {
    "type": "SoleTrader",
    "utr": "string",
    "tradingName": "string",
    "companyUtr": "string",
    "companyNumber": "string",
    "vatRegistered": true,
    "vatNumber": "string",
    "vatRate": 0.0,
    "verification": {
      "manuallyEntered": true,
      "matchInsteadOfVerify": true,
      "number": "string",
      "date": "2020-07-12",
      "taxStatus": "Gross",
      "verificationRequest": "string",
      "verificationResponse": {
        "employeeUniqueId": "string",
        "emailStatementTo": "string",
        "numberOfPayments": 0,
        "item": {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        },
        "displayName": "string",
        "action": "string",
        "type": "string",
        "name": {
          "ttl": "string",
          "fore": [
            "string"
          ],
          "initials": "string",
          "sur": "string"
        },
        "tradingName": "string",
        "worksRef": "string",
        "unmatchedRate": "string",
        "utr": "string",
        "crn": "string",
        "nino": "string",
        "partnership": {
          "name": "string",
          "utr": "string"
        },
        "address": {
          "line": [
            "string"
          ],
          "postcode": "string",
          "postCode": "string",
          "ukPostcode": "string",
          "country": "string"
        },
        "telephone": "string",
        "totalPaymentsUnrounded": "string",
        "costOfMaterialsUnrounded": "string",
        "umbrellaFee": "string",
        "validationMsg": "string",
        "verificationNumber": "string",
        "totalPayments": "string",
        "costOfMaterials": "string",
        "totalDeducted": "string",
        "matched": "string",
        "taxTreatment": "string"
      }
    }
  },
  "department": {
    "code": "string",
    "title": "string",
    "color": "string",
    "employeeCount": 0
  }
}
Contained in Models
Employee
PayRunEntry
Payslip
Consumed by Operations

- none -

Returned by Operations

- none -