Update the National Insurance Record and P45 for the Employee

Request

PUT https://api.yourpayroll.co.uk/api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancerecord

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

The request body takes a complete TaxNationalInsuranceEditModel resource, containing the following writable properties:

{
    "nationalInsuranceRecord": {
        "appointmentEndDate": "date-time",
        "appointmentStartDate": "date-time",
        "benefitsInKind": "double",
        "dateOfBirth": "date-time",
        "dateSigned": "date-time",
        "employeeStarterType": "string",
        "employeeStatement": "string",
        "europeanEconomicAreaCitizen": "boolean",
        "gender": "string",
        "hasBenefitsInKind": "boolean",
        "hasPostGradLoan": "boolean",
        "hasStudentLoan": "boolean",
        "isApprentice": "boolean",
        "isCompanyDirector": "boolean",
        "isSecondedEmployee": "boolean",
        "nationalInsuranceCalculationMethod": "string",
        "nationalInsuranceCategory": "string",
        "nationalInsuranceNumber": "string",
        "nationalInsuranceRecordId": "int32",
        "nicCalculationOverrideWarning": "boolean",
        "notNoticeSequenceNumber": "int64",
        "occupationalPension": "boolean",
        "p6CodingNoticeSequenceNumber": "int64",
        "payrollId": "string",
        "pglCodingNoticeSequenceNumber": "int64",
        "secondmentType": "string",
        "slCodingNoticeSequenceNumber": "int64",
        "source": "string",
        "startDate": "date-time",
        "studentLoanType": "string",
        "taxCalculationMethod": "string",
        "taxCode": "string"
    },
    "previousEmployer": {
        "financialYearStarting": "int32",
        "leavingDate": "date-time",
        "officeNumber": "string",
        "referenceNumber": "string",
        "source": "string",
        "studentLoanDeductions": "boolean",
        "taxCode": "string",
        "taxPeriodFrequency": "string",
        "taxPeriodNumber": "int32",
        "taxWithheld": "double",
        "taxablePay": "double",
        "weekOneMonthOne": "boolean"
    }
}

Properties

Name Type Description
nationalInsuranceRecord object EmployeeNationalInsuranceRecordModel
nationalInsuranceRecord.appointmentEndDate date-time Nullable
nationalInsuranceRecord.appointmentStartDate date-time Nullable
nationalInsuranceRecord.benefitsInKind double Decimal
nationalInsuranceRecord.dateOfBirth date-time DateTime
nationalInsuranceRecord.dateSigned date-time Nullable
nationalInsuranceRecord.employeeStarterType string EmployeeStarterTypeEnum

Possible values are:

  • NewStarter
  • ReportedHmrc
nationalInsuranceRecord.employeeStatement string EmployeeStatementEnum

Possible values are:

  • Current
  • CurrentAfterStartOfFinancialYear
  • HasAnotherJob
nationalInsuranceRecord.europeanEconomicAreaCitizen boolean Nullable
nationalInsuranceRecord.gender string String
nationalInsuranceRecord.hasBenefitsInKind boolean Boolean
nationalInsuranceRecord.hasPostGradLoan boolean Boolean
nationalInsuranceRecord.hasStudentLoan boolean Boolean
nationalInsuranceRecord.isApprentice boolean Boolean
nationalInsuranceRecord.isCompanyDirector boolean Boolean
nationalInsuranceRecord.isSecondedEmployee boolean Nullable
nationalInsuranceRecord.nationalInsuranceCalculationMethod string NationalInsuranceCalculationMethodEnum

Possible values are:

  • Cumulative
  • NonCumulative
nationalInsuranceRecord.nationalInsuranceCategory string NationalInsuranceType

Possible values are:

  • A
  • B
  • C
  • H
  • J
  • M
  • X
  • Z
nationalInsuranceRecord.nationalInsuranceNumber string String
nationalInsuranceRecord.nationalInsuranceRecordId int32 Int32
nationalInsuranceRecord.nicCalculationOverrideWarning boolean Boolean
nationalInsuranceRecord.notNoticeSequenceNumber int64 Int64
nationalInsuranceRecord.occupationalPension boolean Nullable
nationalInsuranceRecord.p6CodingNoticeSequenceNumber int64 Int64
nationalInsuranceRecord.payrollId string String
nationalInsuranceRecord.pglCodingNoticeSequenceNumber int64 Int64
nationalInsuranceRecord.secondmentType string Nullable

Possible values are:

  • InOutUK
  • Stay183DaysOrMore
  • StayLessThan183Days
nationalInsuranceRecord.slCodingNoticeSequenceNumber int64 Int64
nationalInsuranceRecord.source string Nullable

Possible values are:

  • None
  • Saasu
  • Xero
  • MYOB
  • Deputy
  • EmployeeTimePunch
  • ClickSuper
  • IntegratedTimesheets
  • FileImport
  • FileExport
  • QuickBooks
  • Harmony
  • AwardStore
  • Attache
  • IntegratedRostering
  • ReckonAccounts
  • API
  • MicroPower
  • RosterLive
  • NetSuite
  • Kounta
  • TimeAndAttendanceKiosk
  • DetailedFileExport
  • JonasPremier
  • WageEasy
  • Maestrano
  • WorkZone
  • EmployeePortal
  • RosterTemplate
  • Onboarding
  • Admin
  • WorkZoneClockOnOff
  • NetSuiteOneWorld
  • Sage50
  • PensionSync
  • FinancialsOffice
  • ProntoXI
  • PayRunDefault
  • StandardWorkDay
  • Beam
  • PayRunAutomation
  • BureauDashboard
  • Wiise
  • QBOMigrationTool
  • AbridgedFileImport
  • QBOForcedMigration
  • HmrcDpsUpdate
  • HmrcDpsStudentLoan
  • HmrcDpsPostGradLoan
nationalInsuranceRecord.startDate date-time DateTime
nationalInsuranceRecord.studentLoanType string StudentLoanType

Possible values are:

  • None
  • Plan1
  • Plan2
  • PostGrad
nationalInsuranceRecord.taxCalculationMethod string TaxCalculationMethodEnum

Possible values are:

  • Cumulative
  • Week1Month1
nationalInsuranceRecord.taxCode string String
previousEmployer object PreviousEmployerEditModel
previousEmployer.financialYearStarting int32 Int32
previousEmployer.leavingDate date-time Nullable
previousEmployer.officeNumber string String
previousEmployer.referenceNumber string String
previousEmployer.source string Nullable

Possible values are:

  • None
  • Saasu
  • Xero
  • MYOB
  • Deputy
  • EmployeeTimePunch
  • ClickSuper
  • IntegratedTimesheets
  • FileImport
  • FileExport
  • QuickBooks
  • Harmony
  • AwardStore
  • Attache
  • IntegratedRostering
  • ReckonAccounts
  • API
  • MicroPower
  • RosterLive
  • NetSuite
  • Kounta
  • TimeAndAttendanceKiosk
  • DetailedFileExport
  • JonasPremier
  • WageEasy
  • Maestrano
  • WorkZone
  • EmployeePortal
  • RosterTemplate
  • Onboarding
  • Admin
  • WorkZoneClockOnOff
  • NetSuiteOneWorld
  • Sage50
  • PensionSync
  • FinancialsOffice
  • ProntoXI
  • PayRunDefault
  • StandardWorkDay
  • Beam
  • PayRunAutomation
  • BureauDashboard
  • Wiise
  • QBOMigrationTool
  • AbridgedFileImport
  • QBOForcedMigration
  • HmrcDpsUpdate
  • HmrcDpsStudentLoan
  • HmrcDpsPostGradLoan
previousEmployer.studentLoanDeductions boolean Boolean
previousEmployer.taxCode string String
previousEmployer.taxPeriodFrequency string String
previousEmployer.taxPeriodNumber int32 Nullable
previousEmployer.taxWithheld double Decimal
previousEmployer.taxablePay double Decimal
previousEmployer.weekOneMonthOne boolean Boolean

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

TaxNationalInsuranceEditModel