Skip to content

Build for version - 8.0.0 | NI Category updates #182

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.

Sign up for GitHub

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

Merged
sangeet-joy-tw merged 4 commits into from
Apr 10, 2025
Merged

Build for version - 8.0.0 | NI Category updates #182

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8f6930a
PETOSS-712 | Ni category updates from OpenAPI
Apr 1, 2025
80bd1a9
Merge branch 'master' into release-7.1.1
sangeet-joy-tw Apr 8, 2025
01e9e14
version update OAS 8.0.0
Apr 9, 2025
a479dfb
NiCategoryLetter enum ordering changed
Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/v1/accounting/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6339,7 +6339,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>7.1.0</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>8.0.0</li>
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
<li data-group="Accounting" data-name="createAccount" class="">
<a href="#api-Accounting-createAccount">createAccount</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/appstore/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1241,7 +1241,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>7.1.0</li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>8.0.0</li>
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
<li data-group="AppStore" data-name="getSubscription" class="">
<a href="#api-AppStore-getSubscription">getSubscription</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/assets/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1392,7 +1392,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>7.1.0</li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>8.0.0</li>
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
<li data-group="Asset" data-name="createAsset" class="">
<a href="#api-Asset-createAsset">createAsset</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/files/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1170,7 +1170,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>7.1.0</li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>8.0.0</li>
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
<li data-group="Files" data-name="createFileAssociation" class="">
<a href="#api-Files-createFileAssociation">createFileAssociation</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/finance/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2716,7 +2716,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>7.1.0</li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>8.0.0</li>
<li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
<li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
<a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/payroll-au/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3412,7 +3412,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>7.1.0</li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>8.0.0</li>
<li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
<li data-group="PayrollAu" data-name="approveLeaveApplication" class="">
<a href="#api-PayrollAu-approveLeaveApplication">approveLeaveApplication</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/payroll-nz/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4087,7 +4087,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>7.1.0</li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>8.0.0</li>
<li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
<li data-group="PayrollNz" data-name="approveTimesheet" class="">
<a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>
Expand Down
99 changes: 92 additions & 7 deletions docs/v1/payroll-uk/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1595,6 +1595,16 @@
"format" : "date-time",
"x-is-datetime" : true
},
"niCategory" : {
"$ref" : "#/components/schemas/NICategoryLetter"
},
"niCategories" : {
"type" : "array",
"description" : "The employee's NI categories",
"items" : {
"$ref" : "#/components/schemas/NICategory"
}
},
"nationalInsuranceNumber" : {
"type" : "string",
"description" : "National insurance number of the employee",
Expand Down Expand Up @@ -2262,7 +2272,7 @@
};
defs["Employment"] = {
"title" : "",
"required" : [ "EmployeeNumber", "NICategory", "PayrollCalendarID", "StartDate" ],
"required" : [ "EmployeeNumber", "NICategories", "PayrollCalendarID", "StartDate" ],
"type" : "object",
"properties" : {
"payrollCalendarID" : {
Expand All @@ -2282,10 +2292,14 @@
"example" : "7"
},
"niCategory" : {
"type" : "string",
"description" : "The NI Category of the employee",
"example" : "A",
"enum" : [ "A", "B", "C", "F", "H", "I", "J", "L", "M", "S", "V", "X", "Z" ]
"$ref" : "#/components/schemas/NICategoryLetter"
},
"niCategories" : {
"type" : "array",
"description" : "The employee's NI categories",
"items" : {
"$ref" : "#/components/schemas/NICategory"
}
}
},
"description" : ""
Expand Down Expand Up @@ -2502,6 +2516,75 @@
}
},
"description" : ""
};
defs["NICategory"] = {
"title" : "",
"required" : [ "niCategory", "workplacePostcode" ],
"type" : "object",
"properties" : {
"startDate" : {
"type" : "string",
"description" : "The start date of the NI category (YYYY-MM-DD)",
"format" : "date",
"example" : "2024-12-02",
"x-is-date" : true
},
"niCategory" : {
"$ref" : "#/components/schemas/NICategoryLetter"
},
"niCategoryID" : {
"type" : "number",
"description" : "Xero unique identifier for the NI category",
"example" : 15
},
"dateFirstEmployedAsCivilian" : {
"type" : "string",
"description" : "The date in which the employee was first employed as a civilian (YYYY-MM-DD)",
"format" : "date",
"example" : "2024-12-02",
"x-is-date" : true
},
"workplacePostcode" : {
"type" : "string",
"description" : "The workplace postcode",
"example" : "SW1A 1AA"
}
},
"description" : "",
"oneOf" : [ {
"$ref" : "#/components/schemas/NICategory_oneOf"
}, {
"$ref" : "#/components/schemas/NICategory_oneOf_1"
} ]
};
defs["NICategoryLetter"] = {
"title" : "",
"type" : "string",
"description" : "The employee's NI Category letter.",
"example" : "I",
"enum" : [ "A", "B", "C", "D", "E", "F", "H", "I", "J", "K", "L", "M", "N", "S", "V", "X", "Z" ]
};
defs["NICategory_oneOf"] = {
"title" : "",
"required" : [ "workplacePostcode" ],
"properties" : {
"niCategory" : {
"type" : "string",
"enum" : [ "F", "I", "L", "S", "N", "E", "D", "K" ]
}
},
"description" : ""
};
defs["NICategory_oneOf_1"] = {
"title" : "",
"required" : [ "dateFirstEmployedAsCivilian" ],
"properties" : {
"niCategory" : {
"type" : "string",
"enum" : [ "V" ]
}
},
"description" : ""
};
defs["Pagination"] = {
"title" : "",
Expand Down Expand Up @@ -3517,7 +3600,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>7.1.0</li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>8.0.0</li>
<li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
<li data-group="PayrollUk" data-name="approveTimesheet" class="">
<a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>
Expand Down Expand Up @@ -5846,6 +5929,8 @@ <h3>Usage and SDK Samples</h3>
employment = Employment(
payroll_calendar_id = "00000000-0000-0000-0000-000000000000",
start_date = start_date)

ni_categories = NICategories(

try:
api_response = api_instance.create_employment(xero_tenant_id, employee_id, employment, idempotency_key)
Expand Down Expand Up @@ -5976,7 +6061,7 @@ <h2>Parameters</h2>
"schema" : {
"$ref" : "#/components/schemas/Employment"
},
"example" : "{ \"PayrollCalendarID\": \"216d80e6-af55-47b1-b718-9457c3f5d2fe\", \"StartDate\": \"2020-04-01\", \"EmployeeNumber\": \"123ABC\", \"NICategory\": \"A\" }"
"example" : "{ \"PayrollCalendarID\": \"216d80e6-af55-47b1-b718-9457c3f5d2fe\", \"StartDate\": \"2020-04-01\", \"NICategories\": [ { \"NICategory\": \"A\", \"StartDate\": \"2020-05-01\" } ], \"EmployeeNumber\": \"123ABC\" }"
}
},
"required" : true
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/projects/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1462,7 +1462,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Project"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Project"><strong>VSN: </strong>7.1.0</li>
<li class="nav-header" data-group="Project"><strong>VSN: </strong>8.0.0</li>
<li class="nav-header" data-group="Project"><a href="#api-Project">Methods</a></li>
<li data-group="Project" data-name="createProject" class="">
<a href="#api-Project-createProject">createProject</a>
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ def read_file(filename):
keywords="xero python sdk API oAuth",
name="xero_python",
packages=find_packages(include=["xero_python", "xero_python.*"]),
version="7.1.0",
version="8.0.0",
)
2 changes: 1 addition & 1 deletion xero_python/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

__author__ = """Xero Developer API"""
__email__ = "api@xero.com"
__version__ = "7.1.0"
__version__ = "8.0.0"
2 changes: 1 addition & 1 deletion xero_python/accounting/api/accounting_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"""

"""
OpenAPI spec version: 7.1.0
OpenAPI spec version: 8.0.0
"""


Expand Down
2 changes: 1 addition & 1 deletion xero_python/appstore/api/app_store_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"""

"""
OpenAPI spec version: 7.1.0
OpenAPI spec version: 8.0.0
"""


Expand Down
2 changes: 1 addition & 1 deletion xero_python/assets/api/asset_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"""

"""
OpenAPI spec version: 7.1.0
OpenAPI spec version: 8.0.0
"""


Expand Down
4 changes: 2 additions & 2 deletions xero_python/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ These endpoints are related to managing authentication tokens and identity for X

The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project:

- API version: 7.1.0
- Package version: 7.1.0
- API version: 8.0.0
- Package version: 8.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://developer.xero.com](https://developer.xero.com)

Expand Down
2 changes: 1 addition & 1 deletion xero_python/file/api/files_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"""

"""
OpenAPI spec version: 7.1.0
OpenAPI spec version: 8.0.0
"""


Expand Down
2 changes: 1 addition & 1 deletion xero_python/finance/api/finance_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"""

"""
OpenAPI spec version: 7.1.0
OpenAPI spec version: 8.0.0
"""


Expand Down
2 changes: 1 addition & 1 deletion xero_python/identity/api/identity_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"""

"""
OpenAPI spec version: 7.1.0
OpenAPI spec version: 8.0.0
"""


Expand Down
2 changes: 1 addition & 1 deletion xero_python/payrollau/api/payroll_au_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"""

"""
OpenAPI spec version: 7.1.0
OpenAPI spec version: 8.0.0
"""


Expand Down
2 changes: 1 addition & 1 deletion xero_python/payrollnz/api/payroll_nz_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"""

"""
OpenAPI spec version: 7.1.0
OpenAPI spec version: 8.0.0
"""


Expand Down
4 changes: 4 additions & 0 deletions xero_python/payrolluk/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@
from xero_python.payrolluk.models.leave_type import LeaveType
from xero_python.payrolluk.models.leave_type_object import LeaveTypeObject
from xero_python.payrolluk.models.leave_types import LeaveTypes
from xero_python.payrolluk.models.ni_category import NICategory
from xero_python.payrolluk.models.ni_category_letter import NICategoryLetter
from xero_python.payrolluk.models.ni_category_one_of import NICategoryOneOf
from xero_python.payrolluk.models.ni_category_one_of1 import NICategoryOneOf1
from xero_python.payrolluk.models.pagination import Pagination
from xero_python.payrolluk.models.pay_run import PayRun
from xero_python.payrolluk.models.pay_run_calendar import PayRunCalendar
Expand Down
2 changes: 1 addition & 1 deletion xero_python/payrolluk/api/payroll_uk_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"""

"""
OpenAPI spec version: 7.1.0
OpenAPI spec version: 8.0.0
"""


Expand Down
2 changes: 2 additions & 0 deletions xero_python/payrolluk/docs/Employee.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Name | Type | Description | Notes
**payroll_calendar_id** | **str** | Xero unique identifier for the payroll calendar of the employee | [optional]
**updated_date_utc** | **datetime** | UTC timestamp of last update to the employee | [optional]
**created_date_utc** | **datetime** | UTC timestamp when the employee was created in Xero | [optional]
**ni_category** | [**NICategoryLetter**](NICategoryLetter.md) | | [optional]
**ni_categories** | [**list[NICategory]**](NICategory.md) | The employee&#39;s NI categories | [optional]
**national_insurance_number** | **str** | National insurance number of the employee | [optional]
**is_off_payroll_worker** | **bool** | Whether the employee is an off payroll worker | [optional]

Expand Down
3 changes: 2 additions & 1 deletion xero_python/payrolluk/docs/Employment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Name | Type | Description | Notes
**payroll_calendar_id** | **str** | Xero unique identifier for the payroll calendar of the employee | [optional]
**start_date** | **date** | Start date of the employment (YYYY-MM-DD) | [optional]
**employee_number** | **str** | The employment number of the employee | [optional]
**ni_category** | **str** | The NI Category of the employee | [optional]
**ni_category** | [**NICategoryLetter**](NICategoryLetter.md) | | [optional]
**ni_categories** | [**list[NICategory]**](NICategory.md) | The employee&#39;s NI categories | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
14 changes: 14 additions & 0 deletions xero_python/payrolluk/docs/NICategory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# NICategory

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**start_date** | **date** | The start date of the NI category (YYYY-MM-DD) | [optional]
**ni_category** | [**NICategoryLetter**](NICategoryLetter.md) | |
**ni_category_id** | **float** | Xero unique identifier for the NI category | [optional]
**date_first_employed_as_civilian** | **date** | The date in which the employee was first employed as a civilian (YYYY-MM-DD) | [optional]
**workplace_postcode** | **str** | The workplace postcode |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


9 changes: 9 additions & 0 deletions xero_python/payrolluk/docs/NICategoryLetter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# NICategoryLetter

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


10 changes: 10 additions & 0 deletions xero_python/payrolluk/docs/NICategoryOneOf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# NICategoryOneOf

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ni_category** | **str** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading