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

Update GET TaxRates spec #579

Merged
merged 6 commits into from
Feb 19, 2024

Conversation

jvcudis
Copy link
Contributor

@jvcudis jvcudis commented Jan 19, 2024

It's reported by users (see CX0014522641 CX ticket) that the TaxType query param is not working. This query param is not supported by the Accounting API. What is supported is record filtering which allows users to append the TaxType in the endpoint's URL to filter for TaxRate with specific TaxType.

Does not work -> /TaxRates?TaxType={TaxType}
Works -> /TaxRates/{TaxType}

Description

  • Remove the declaration of TaxType query param in GET TaxRates
  • Add a new spec for TaxRates/{TaxTypes}

Release Notes

We need to make this change to avoid confusing users since I few have used TaxType as query param.

Screenshots (if appropriate):

Types of Changes

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

Copy link

PETOSS-386

Copy link

Thanks for raising an issue, a ticket has been created to track your request

- OAuth2: [accounting.settings, accounting.settings.read]
tags:
- Accounting
operationId: getTaxRates
Copy link
Contributor

@0GH4J 0GH4J Jan 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jvcudis - can you update the operationId to "getTaxRateByTaxType"? This is how the other GETs by a given field are labelled in the spec. Also, "getTaxRates" causes an error because it is already used as the operationId for GET /TaxRates

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@0GH4J - thanks for reviewing the PR 😄
I updated the operationId value as requested.

@jvcudis jvcudis requested a review from 0GH4J February 7, 2024 21:13
"ProviderName": "Xero API Partner",
"DateTimeUTC": "\/Date(1550797359081)\/",
"TaxRates": [
{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please indent the example JSON?

@manishT72 manishT72 merged commit 1508638 into XeroAPI:master Feb 19, 2024
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.

3 participants