Skip to main content
PUT
Update the starter details for a specific employee

Authorizations

X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

X-Org-Id
string
header
required

Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).

Path Parameters

employeeId
string
required

The ID of the employee whose starter details are to be updated

Body

application/json
startDate
string
required

The start date of the employee.

Example:

"2024-01-15"

starterDeclaration
enum<string>
required

The starter declaration of the employee. Use 'ThisIsMyFirstJobSince6thApril', 'ThisIsMyOnlyJob', or 'IHaveAnotherJobOrPension' for a new starter. Use 'None' for an existing employee who has already been reported to HMRC (for example, one migrated mid-year from another payroll provider); in that case alreadySentToHmrcFps must be true.

Available options:
ThisIsMyFirstJobSince6thApril,
ThisIsMyOnlyJob,
IHaveAnotherJobOrPension,
None
Example:

"ThisIsMyOnlyJob"

alreadySentToHmrcFps
boolean
required

Whether the employee's starter details have already been reported to HMRC on an FPS. Set to false for a new starter (the starter declaration is reported on the next FPS). Set to true for an existing employee already reported to HMRC; this is required when starterDeclaration is 'None'.

Example:

false

secondedDetails
object | null

Response

Employee starter details were successfully updated

message
object
content
object
validationIssues
object[]
messageToken
string