Guides

Name / Description	Type / Format	Example
`cis`	`Contract.CisDetailsResponse`	`{Contract.CisDetailsResponse}`
`department`	`Contract.DepartmentResponse`	`{Contract.DepartmentResponse}`
`includeSecondedInfoOnStarter`	`boolean`	`true`
`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` Job Title of Primary role of the Employee	`string`	`"string"`
`onHold` Set to true to temporarily exclude the employee from payruns	`boolean`	`true`
`onFurlough` Set to true if the employee is on furlough.	`boolean`	`true`
`furloughStart` Furlough Start Date.	`string` date	`"2024-11-21"`
`furloughEnd` Furlough End Date.	`string` date	`"2024-11-21"`
`furloughCalculationBasis`	`string`	`"ActualPaidAmount"` `"DailyReferenceAmount"` `"MonthlyReferenceAmount"`
`furloughCalculationBasisAmount`	`number` double	`0.0`
`partialFurlough` Set to true if the employee is partially furloughed.	`boolean`	`true`
`furloughHoursNormallyWorked`	`number` double	`0.0`
`furloughHoursOnFurlough`	`number` double	`0.0`
`isApprentice` Set to True if this Employee is an apprentice. This affects the calculations for National Minimum Wage	`boolean`	`true`
`apprenticeshipStartDate`	`string` date	`"2024-11-21"`
`apprenticeshipEndDate`	`string` date	`"2024-11-21"`
`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`	`Contract.StarterDetails`	`{Contract.StarterDetails}`
`directorshipDetails`	`Contract.DirectorshipDetails`	`{Contract.DirectorshipDetails}`
`leaverDetails`	`Contract.LeaverDetails`	`{Contract.LeaverDetails}`
`roles` List of Roles held by Employee	`Contract.EmployeeRoleItem[]`	`{Contract.EmployeeRoleItem}`
`isWorkingInFreePort` Flag indicating the employee is employed in a Freeport	`boolean`	`true`
`isWorkingInInvestmentZone` Flag indicating the employee is employed in an Investment Zone	`boolean`	`true`
`veteranDetails`	`Contract.VeteranDetails`	`{Contract.VeteranDetails}`
`continuousEmploymentDate` Date of continuous employment	`string` date	`"2024-11-21"`

JSON Example

{
  "cis": {
    "verification": {
      "verificationRequest": "string",
      "manuallyEntered": true,
      "matchInsteadOfVerify": true,
      "number": "string",
      "date": "2024-11-21",
      "taxStatus": "Gross",
      "verificationResponse": {
        "employeeUniqueId": "string",
        "emailStatementTo": "string",
        "numberOfPayments": 0,
        "item": "error too many levels",
        "displayName": "string",
        "action": "string",
        "type": "string",
        "name": "error too many levels",
        "tradingName": "string",
        "worksRef": "string",
        "unmatchedRate": "string",
        "utr": "string",
        "crn": "string",
        "nino": "string",
        "partnership": "error too many levels",
        "address": "error too many levels",
        "telephone": "string",
        "totalPaymentsUnrounded": "string",
        "costOfMaterialsUnrounded": "string",
        "umbrellaFee": "string",
        "validationMsg": "string",
        "verificationNumber": "string",
        "totalPayments": "string",
        "costOfMaterials": "string",
        "totalDeducted": "string",
        "matched": "string",
        "taxTreatment": "string",
        "netPayment": "string"
      }
    },
    "type": "SoleTrader",
    "utr": "string",
    "tradingName": "string",
    "companyUtr": "string",
    "companyNumber": "string",
    "vatRegistered": true,
    "vatNumber": "string",
    "vatRate": 0.0,
    "reverseChargeVAT": true
  },
  "department": {
    "employeeCount": 0,
    "code": "string",
    "title": "string",
    "color": "string",
    "accountingCode": "string"
  },
  "includeSecondedInfoOnStarter": true,
  "cisSubContractor": true,
  "payrollCode": "string",
  "jobTitle": "string",
  "onHold": true,
  "onFurlough": true,
  "furloughStart": "2024-11-21",
  "furloughEnd": "2024-11-21",
  "furloughCalculationBasis": "ActualPaidAmount",
  "furloughCalculationBasisAmount": 0.0,
  "partialFurlough": true,
  "furloughHoursNormallyWorked": 0.0,
  "furloughHoursOnFurlough": 0.0,
  "isApprentice": true,
  "apprenticeshipStartDate": "2024-11-21",
  "apprenticeshipEndDate": "2024-11-21",
  "workingPattern": "string",
  "forcePreviousPayrollCode": "string",
  "starterDetails": {
    "startDate": "2024-11-21",
    "starterDeclaration": "A",
    "overseasEmployerDetails": {
      "overseasEmployer": true,
      "overseasSecondmentStatus": "None",
      "eeaCitizen": true,
      "epm6Scheme": true
    },
    "pensionerPayroll": {
      "inReceiptOfPension": true,
      "bereaved": true,
      "amount": 0.0,
      "startDate": "2024-11-21"
    }
  },
  "directorshipDetails": {
    "isDirector": true,
    "startDate": "2024-11-21",
    "leaveDate": "2024-11-21",
    "niAlternativeMethod": true
  },
  "leaverDetails": {
    "hasLeft": true,
    "leaveDate": "2024-11-21",
    "isDeceased": true,
    "paymentAfterLeaving": true,
    "p45Sent": true,
    "payAccruedBalance": true,
    "paymentMethodAfterLeaving": "RegularPayMethod"
  },
  "roles": [
    {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    }
  ],
  "isWorkingInFreePort": true,
  "isWorkingInInvestmentZone": true,
  "veteranDetails": {
    "isVeteran": true,
    "firstCivilianEmploymentDate": "2024-11-21"
  },
  "continuousEmploymentDate": "2024-11-21"
}

References

Contained in Models
Contract.EmployeeResponse

Consumed by Operations

- none -

Returned by Operations

- none -