Skip to content

fix: document OffPayrollWorker value in EmploymentStatus enum - #845

Open
mikkelgaub-planday wants to merge 1 commit into
XeroAPI:masterfrom
mikkelgaub-planday:fix/employmentstatus-offpayrollworker
Open

fix: document OffPayrollWorker value in EmploymentStatus enum#845
mikkelgaub-planday wants to merge 1 commit into
XeroAPI:masterfrom
mikkelgaub-planday:fix/employmentstatus-offpayrollworker

Conversation

@mikkelgaub-planday

Copy link
Copy Markdown

The Payroll UK API already returns OffPayrollWorker as an EmploymentStatus value, 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

  • The isOffPayrollWorker boolean flag already exists on the employee DTO and is how off-payroll workers are created; that behaviour is unchanged.
  • Domain validation already rejects attempts to pass OffPayrollWorker as an EmploymentStatus when creating a payee or adding a contract, so no new request capability is introduced.
  • Consumers cannot currently use this enum value; adding it simply documents existing API behaviour and fixes deserialization of GET responses.

Replaces the approach in #802 (which was flagged as a breaking change). This is a documentation/deserialization fix, not a functional change.

The API already returns OffPayrollWorker as an EmploymentStatus value; it was omitted from the enum by oversight. Adding it fixes deserialization of existing GET responses. No functional change to request handling.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant