1. Employee
PayRun.IO
  • Employer
    • Delete an Employer
      DELETE
    • Gets the employer
      GET
    • Patches the employer
      PATCH
    • Updates the Employer
      PUT
    • Delete an Employer revision matching the specified revision number.
      DELETE
    • Gets the employer by revision number
      GET
    • Gets the employer revisions
      GET
    • Deletes employer secret
      DELETE
    • Get employer secret
      GET
    • Create a new employer secret
      PUT
    • Get all employer secret links
      GET
    • Create a new employer secret
      POST
    • Delete an Employer revision matching the specified revision date.
      DELETE
    • Gets the employer at the specified effective
      GET
    • Gets all employers
      GET
    • Create a new Employer
      POST
    • Gets all employers at the specified effective date
      GET
  • CIS
    • Delete an CIS line type
    • Get CIS line type from employer
    • Updates the CIS line type
    • Get CIS line types from employer.
    • Create a new CIS line type
    • Delete the CIS transaction
    • Get the CIS transaction
    • Get all CIS transactions for the employer
    • Delete a CIS instruction
    • Get CIS instruction from sub contractor
    • Patches the CIS instruction
    • Updates the CIS instruction
    • Get CIS instructions from sub contractor.
    • Create a new CIS instruction
    • Delete a CIS line
    • Get CIS line from sub contractor
    • Get CIS lines from sub contractor.
  • Tagging
    • Delete CIS line type tag
    • Get CIS line type tag
    • Insert CIS line type tag
    • Get all tags from the CIS line type
    • Get CIS line types with tag
    • Get all CIS line type tags
    • Delete pay instruction tag
    • Get pay instruction tag
    • Insert pay instruction tag
    • Get all tags from the pay instruction
    • Get pay instructions with tag
    • Get all pay instruction tags
    • Delete pay line tag
    • Get pay line tag
    • Insert pay line tag
    • Get all tags from the pay line
    • Get pay lines with tag
    • Get all pay line tags
    • Delete employee tag
    • Get employee tag
    • Insert employee tag
    • Get employee revision tag
    • Get all employee tags
    • Get all employee revision tags
    • Get employees with tag
    • Get all employee tags
    • Delete holiday scheme tag
    • Get holiday scheme tag
    • Insert holiday scheme tag
    • Get holiday scheme revision tag
    • Get all tags from the holiday scheme
    • Get all holiday scheme revision tags
    • Get holiday schemes with tag
    • Get all holiday scheme tags
    • Delete journal line tag
    • Get journal line tag
    • Insert journal line tag
    • Get tags from journal line
    • Get links to tagged journal lines
    • Get all journal line tags
    • Delete pay code tag
    • Get pay code tag
    • Insert pay code tag
    • Get all pay code tags
    • Get pay codes with tag
    • Get all pay code tags
    • Delete pay run tag
    • Get pay run tag
    • Insert pay run tag
    • Get all pay run tags
    • Get pay runs with tag
    • Get all pay run tags
    • Delete pay schedule tag
    • Get pay schedule tag
    • Insert pay schedule tag
    • Get all pay schedule tags
    • Get pay schedule with tag
    • Get all pay schedule tags
    • Delete RTI transaction tag
    • Get RTI transaction tag
    • Insert RTI transaction tag
    • Get all tags from RTI transaction
    • Get RTI transactions with tag
    • Get all RTI transaction tags
    • Delete CIS instruction tag
    • Get CIS instruction tag
    • Insert CIS instruction tag
    • Get all tags from the CIS instruction
    • Get CIS instructions with tag
    • Get all CIS instruction tags
    • Delete CIS line tag
    • Get CIS line tag
    • Insert CIS line tag
    • Get all tags from the CIS line
    • Get CIS lines with tag
    • Get all CIS line tags
    • Delete sub contractor tag
    • Get sub contractor tag
    • Insert sub contractor tag
    • Get sub contractor revision tag
    • Get all tags from the sub contractor
    • Get all sub contractor revision tags
    • Get sub contractors with tag
    • Get all sub contractor tags
    • Delete employer tag
    • Get employer tag
    • Insert employer tag
    • Get employer revision tag
    • Get all employer tags
    • Get all employer revision tags
    • Delete third party transaction tag
    • Get third party transaction tag
    • insert third party transaction tag
    • Get tags from third party transaction
    • Get links to tagged third party transactions
    • Get all third party transaction tags
    • Get employers with tag
    • Get all employer tags
    • Delete user tag
    • Get user tag
    • Insert user tag
    • Get tags from user
    • Get links to tagged users
    • Get all user tags
  • DpsMessage
    • Deletes the DPS message
    • Gets the DPS message
    • Patches the DPS message
    • Puts the DPS message
    • Gets the DPS messages
    • Posta the DPS message
  • Employee
    • Delete an Employee
      DELETE
    • Get employee from employer
      GET
    • Patches the employee
      PATCH
    • Updates the Employee
      PUT
    • Get links to all commentaries for the specified employee
      GET
    • Get commentary from employee
      GET
    • Delete an Employee revision matching the specified revision number.
      DELETE
    • Gets the employee by revision number
      GET
    • Get all employee revisions
      GET
    • Deletes employee secret
      DELETE
    • Get employee secret
      GET
    • Create a new employee secret
      PUT
    • Get all employee secret links
      GET
    • Create a new employee secret
      POST
    • Delete an Employee revision matching the specified revision date.
      DELETE
    • Get employee by effective date.
      GET
    • Get employees from employer.
      GET
    • Create a new Employee
      POST
    • Get employees from employer at a given effective date.
      GET
    • Get all employees revisions from a pay schedule.
      GET
    • Get employees from a pay schedule on effective date.
      GET
    • Get commentary from payrun by specified employee.
      GET
    • Get employees from the pay run
      GET
  • AEAssessment
    • Delete auto enrolment assessment
    • Get the auto enrolment assessment
    • Insert new auto enrolment assessment
    • Get the auto enrolment assessments
    • Insert new auto enrolment assessment
    • Get the auto enrolment assessments
  • Journals
    • Gets the journal Lines from the specified employee
    • Deletes a Journal instruction
    • Gets the specified journal instruction from the employer
    • Update a Journal Instruction
    • Gets the Journal instructions from the specified employer
    • Creates a new Journal Instruction
    • Gets the specified journal Line from the employer
    • Gets the Journal Lines from the specified employer
    • Gets the journal Lines from the specified pay run
    • Gets the journal Lines from the specified sub contractor
    • Deletes a Journal instruction template
    • Gets the Journal instructions template for the application
    • Update a Journal Instruction template
    • Gets the Journal instructions templates for the application
    • Creates a new Journal Instruction template
  • PayInstruction
    • Deletes a pay instruction
    • Gets the specified pay instruction from the employee
    • Sparse Update of a Pay Instruction
    • Update a Pay Instruction
    • Gets the pay instructions from the specified employee
    • Creates a new Pay Instruction
  • PayLine
    • Gets the specified pay line from the employee
    • Gets the pay lines from the specified employee
  • PayRun
    • Gets the pay runs from the employee
    • Deletes a pay run
    • Gets the pay run from the pay schedule
    • Get links to all commentaries for the specified pay run
    • Deletes a pay run employee
    • Gets the pay runs from the pay schedule
  • HolidayScheme
    • Delete an holiday scheme
    • Get holiday scheme from employer
    • Patches the holiday scheme
    • Updates the holiday scheme
    • Delete an HolidayScheme revision matching the specified revision number.
    • Gets the holiday scheme revision by revision number
    • Get all holiday scheme revisions
    • Delete an holiday scheme revision matching the specified revision date.
    • Get holiday scheme by effective date.
    • Get holiday schemes from employer.
    • Create a new holiday scheme
    • Get holiday schemes from employer at a given effective date.
  • NominalCode
    • Deletes the nominal codes
    • Gets the nominal code
    • Insert nominal code
    • Gets the nominal codes
    • Insert nominal code
  • PayCode
    • Gets the pay codes by nominal code
    • Deletes a pay code
    • Gets the specified pay code from the employer
    • Patches the pay code
    • Updates a pay code
    • Delete an PayCode revision matching the specified revision number.
    • Gets the pay code by revision number
    • Get all revisions of the Pay Code
    • Deletes a pay code revision
    • Gets pay code for specified date
    • Gets the pay codes from the employer
    • Create a new pay code
    • Gets all pay codes for specified date
  • PaySchedule
    • Deletes a pay schedule
    • Gets the specified pay schedule from the employer
    • Updates a pay schedule
    • Gets the pay schedule from the specified employer
    • Create a new pay schedule
  • ReportLine
    • Gets the report lines from the specified pay run
    • Gets the specified report line from the employer
    • Gets the report lines from the specified employer
  • Pension
    • Delete a Pension
    • Get pension from employer
    • Patches the pension
    • Updates the Pension
    • Delete an Pension revision matching the specified revision number.
    • Gets the pension by revision number
    • Get all pension revisions
    • Delete an Pension revision matching the specified revision date.
    • Get pension by effective date.
    • Get pensions from employer.
    • Create a new Pension
    • Get pensions from employer at a given effective date.
  • ReportLineInstruction
    • Deletes a reporting instruction
    • Gets the specified reporting instruction from the employer
    • Update a reporting Instruction
    • Gets the reporting instructions from the specified employer
    • Creates a new Reporting Instruction
  • RTI
    • Delete the RTI transaction
    • Get the RTI transaction
    • Get all RTI transactions for the employer
  • SubContractor
    • Delete an sub contractor
    • Get sub contractor from employer
    • Patches the sub contractor
    • Updates the sub contractor
    • Delete an SubContractor revision matching the specified revision number.
    • Gets the sub contractor by revision number
    • Get all sub contractor revisions
    • Delete an sub contractor revision matching the specified revision date.
    • Get sub contractor by effective date.
    • Get sub contractors from employer.
    • Create a new sub contractor
    • Get sub contractors from employer at a given effective date.
  • ThirdPartyTransmission
    • Delete third party transaction
    • Get a third party transaction
    • Get all third party transaction links
  • Healthcheck
    • Get health check status
  • Jobs
    • Get all Batch jobs
    • Create new Batch job
    • Delete the Batch job
    • Get the Batch job information
    • Get the Batch job progress
    • Get the Batch job status
    • Get all CIS jobs
    • Create new CIS job
    • Delete the CIS job
    • Get the CIS job information
    • Get the CIS job progress
    • Get the CIS job status
    • Get all DPS jobs
    • Create new DPS job
    • Delete the DPS job
    • Get the DPS job information
    • Get the DPS job progress
    • Get the DPS job status
    • Gets all jobs relating to the employer.
    • Get all PayRun jobs
    • Create new PayRun job
    • Delete the pay run job
    • Get the pay run job information
    • Get the pay run job progress
    • Get the pay run job status
    • Get all RTI jobs
    • Create new RTI job
    • Delete the RTI job
    • Get the RTI job information
    • Get the RTI job progress
    • Get the RTI job status
    • Get all Third Party jobs
    • Create new Third Party job
    • Delete the Third Party job
    • Get the Third Party job information
    • Get the Third Party job progress
    • Get the Third Party job status
  • Permission
    • Deletes the permission object
    • Gets the permission object
    • Patch permission object
    • Puts permisson object
    • Gets all permission objects
    • Post permisson object
  • Query
    • Get the query result
  • Reference
    • Gets the journal expression data schema
  • Reports
    • Runs the active pay instructions report
    • Runs the AOE liability report
    • Runs the DPS message report
    • Runs the employer summary report
    • Runs the gross to net report
    • Runs the holiday balance report
    • Runs the journal report
    • Runs the last pay date report
    • Runs the net pay report
    • Runs the next pay period report
    • Runs the P11 summary report
    • Runs the P32 report
    • Runs the P32 summary report
    • Runs the P45 report
    • Runs the P60 report
    • Runs the PAPDIS report
    • Runs the PASS report
    • Runs the Pay Dashboard payslips report
    • Runs the verbose payslip report
    • Runs the pension liability report
    • Deletes a report definition
    • Get the report definition
    • Updates a report definition
    • Runs the specified report definition
    • Gets all reports
    • Create a new report definition
    • Deletes a transform definition
    • Get the transform definition
    • Updates a transform definition
    • Gets all transform definitions
    • Create a new transform definition
  • Schemas
    • Get a list of all available schemas
    • Get XSD schema
  • Templates
    • Get the object template
    • Get a list of all available data object tempaltes
  • User
    • Deletes the user object
    • Gets the user object
    • Patch user object
    • Puts user object
    • Gets all user objects
    • Post user object
  • Schemas
    • Schemas
      • AEAssessment
      • BatchItemBase
      • BatchJobInstruction
      • CisInstruction
      • CisJobInstructionBase
      • CisLine
      • CisLineType
      • CisTransaction
      • Commentary
      • DpsJobInstruction
      • DpsMessage
      • Employee
      • EmployeeSecret
      • Employer
      • EmployerSecret
      • ErrorModel
      • HealthCheck
      • HolidayScheme
      • JobInfo
      • JournalExpressionDataTable
      • JournalInstruction
      • JournalLine
      • Link
      • LinkCollection
      • NominalCode
      • PayCode
      • PayInstruction
      • PayLine
      • PayRun
      • PayRunJobInstruction
      • PaySchedule
      • Pension
      • Permission
      • Query
      • ReportDefinition
      • ReportLine
      • ReportingInstruction
      • RtiJobInstruction
      • RtiTransactionBase
      • SubContractor
      • Tag
      • ThirdPartyJobInstruction
      • ThirdPartyTransaction
      • TransformDefinition
      • User
  1. Employee

Patches the employee

PATCH
/Employer/{EmployerId}/Employee/{EmployeeId}
Patches the specified employee with the supplied values

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200The employee object.
application/json
Body

🟠400Bad Request
🟠401Unauthorized
🟠404Not Found
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.test.payrun.io/Employer//Employee/' \
--header 'Authorization;' \
--header 'Api-Version;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Employee": {
        "AEAssessmentOverride": "None",
        "AEAssessmentOverrideDate": "2019-08-24",
        "AEExclusionReasonCode": "OtherNotKnown",
        "AEPostponementDate": "2019-08-24",
        "Address": {
            "Address1": "string",
            "Address2": "string",
            "Address3": "string",
            "Address4": "string",
            "Country": "string",
            "Postcode": "string"
        },
        "BankAccount": {
            "AccountName": "string",
            "AccountNumber": "string",
            "Reference": "string",
            "SortCode": "string"
        },
        "Code": "string",
        "DateOfBirth": "2019-08-24",
        "Deactivated": true,
        "DirectorshipAppointmentDate": "2019-08-24",
        "EEACitizen": true,
        "EPM6": true,
        "EffectiveDate": "2019-08-24",
        "EmployeePartner": {
            "FirstName": "string",
            "Initials": "string",
            "LastName": "string",
            "MiddleName": "string",
            "NiNumber": "string"
        },
        "FirstName": "string",
        "Gender": "Unknown",
        "HoursPerWeek": 0,
        "Initials": "string",
        "IrregularEmployment": true,
        "IsAgencyWorker": true,
        "LastName": "string",
        "LeaverReason": "Resigned",
        "LeavingDate": "2019-08-24",
        "MaritalStatus": "NotSet",
        "MetaData": {},
        "MiddleName": "string",
        "NiNumber": "string",
        "NicLiability": "HasOtherJob",
        "OffPayrollWorker": true,
        "OnStrike": true,
        "PassportNumber": "string",
        "PaySchedule": {
            "@href": "string",
            "@rel": "string",
            "@title": "string"
        },
        "PaymentMethod": "NotSet",
        "PaymentToANonIndividual": true,
        "Region": "NotSet",
        "Revision": 0,
        "RuleExclusions": "None",
        "Seconded": "NotSet",
        "StartDate": "2019-08-24",
        "StarterDeclaration": "PreviouslyReported",
        "Territory": "UnitedKingdom",
        "Title": "string",
        "WorkingWeek": "None"
    }
}'
Response Response Example
200 - Example 1
{
    "Employee": {
        "AEAssessmentOverride": "None",
        "AEAssessmentOverrideDate": "2019-08-24",
        "AEExclusionReasonCode": "OtherNotKnown",
        "AEPostponementDate": "2019-08-24",
        "Address": {
            "Address1": "string",
            "Address2": "string",
            "Address3": "string",
            "Address4": "string",
            "Country": "string",
            "Postcode": "string"
        },
        "BankAccount": {
            "AccountName": "string",
            "AccountNumber": "string",
            "Reference": "string",
            "SortCode": "string"
        },
        "Code": "string",
        "DateOfBirth": "2019-08-24",
        "Deactivated": true,
        "DirectorshipAppointmentDate": "2019-08-24",
        "EEACitizen": true,
        "EPM6": true,
        "EffectiveDate": "2019-08-24",
        "EmployeePartner": {
            "FirstName": "string",
            "Initials": "string",
            "LastName": "string",
            "MiddleName": "string",
            "NiNumber": "string"
        },
        "FirstName": "string",
        "Gender": "Unknown",
        "HoursPerWeek": 0,
        "Initials": "string",
        "IrregularEmployment": true,
        "IsAgencyWorker": true,
        "LastName": "string",
        "LeaverReason": "Resigned",
        "LeavingDate": "2019-08-24",
        "MaritalStatus": "NotSet",
        "MetaData": {},
        "MiddleName": "string",
        "NiNumber": "string",
        "NicLiability": "HasOtherJob",
        "OffPayrollWorker": true,
        "OnStrike": true,
        "PassportNumber": "string",
        "PaySchedule": {
            "@href": "string",
            "@rel": "string",
            "@title": "string"
        },
        "PaymentMethod": "NotSet",
        "PaymentToANonIndividual": true,
        "Region": "NotSet",
        "Revision": 0,
        "RuleExclusions": "None",
        "Seconded": "NotSet",
        "StartDate": "2019-08-24",
        "StarterDeclaration": "PreviouslyReported",
        "Territory": "UnitedKingdom",
        "Title": "string",
        "WorkingWeek": "None"
    }
}
Modified at 2022-09-10 20:12:17
Previous
Get employee from employer
Next
Updates the Employee
Built with