Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Breaking change: NZ Payroll PayTemplate method naming #446

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

rjaus
Copy link
Contributor

@rjaus rjaus commented Sep 1, 2021

NZ Payroll API: getEmployeePayTemplates method does not align with the overall method naming convention of the SDK, and differs from that of the same endpoint in the UK Payroll API.

Description

Release Notes

Standardises method naming convention between UK & NZ Payroll SDK's (same endpoint). Endpoint does not exist in the AU Payroll API or SDK.

XeroAPI/xero-ruby#173

This is a breaking change:
Requires references to getEmployeePayTemplates to change to getEmployeePayTemplate for NZ Payroll API.

Definitely affects the Ruby SDK. Will affect any other SDKs that name methods based on the operationId (possible all of them).

Screenshots (if appropriate):

Types of Changes

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • [ x ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

… getEmployeePayTemplate) in NZ Payroll API. Aligns the convention between UK & NZ Payroll, and the naming convention for other methods (endpoints are pluralised, methods are singular) Issue: XeroAPI/xero-ruby#173
@RettBehrens
Copy link
Contributor

Holding off on merging for now as this would be a breaking change

@RettBehrens RettBehrens added the Status: On Hold Provide an explanation in the comments label Sep 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: On Hold Provide an explanation in the comments
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants