fix: document OffPayrollWorker value in EmploymentStatus enum - #845
Merged
ryanNexus merged 2 commits intoSep 3, 2026
Merged
Conversation
… enum BREAKING CHANGE: adds a new EmploymentStatus enum value, which is treated as a breaking SDK change for generated clients.
mikkelgaub-planday
force-pushed
the
fix/employmentstatus-offpayrollworker
branch
from
September 3, 2026 12:18
cb17f39 to
fc67bd4
Compare
|
🎉 This PR is included in version 19.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Payroll UK API already returns
OffPayrollWorkeras anEmploymentStatusvalue, but it was omitted from the enum in the spec by oversight. This adds the missing value so generated SDKs can deserialize existing GET responses.Why this is not a breaking change
isOffPayrollWorkerboolean flag already exists on the employee DTO and is how off-payroll workers are created; that behaviour is unchanged.OffPayrollWorkeras anEmploymentStatuswhen creating a payee or adding a contract, so no new request capability is introduced.Replaces the approach in #802 (which was flagged as a breaking change). This is a documentation/deserialization fix, not a functional change.