diff --git a/setup.py b/setup.py index 5b1fdf28..7f360a0a 100644 --- a/setup.py +++ b/setup.py @@ -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="1.0.13", + version="1.1.0", ) diff --git a/xero_python/__init__.py b/xero_python/__init__.py index f9e4abc7..adc124ea 100644 --- a/xero_python/__init__.py +++ b/xero_python/__init__.py @@ -2,4 +2,4 @@ __author__ = """Xero Developer API""" __email__ = "api@xero.com" -__version__ = "1.0.13" +__version__ = "1.1.0" diff --git a/xero_python/accounting/__init__.py b/xero_python/accounting/__init__.py index 08d3e014..79979586 100644 --- a/xero_python/accounting/__init__.py +++ b/xero_python/accounting/__init__.py @@ -7,7 +7,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ @@ -30,6 +30,7 @@ from xero_python.accounting.models.allocations import Allocations from xero_python.accounting.models.attachment import Attachment from xero_python.accounting.models.attachments import Attachments +from xero_python.accounting.models.balance_details import BalanceDetails from xero_python.accounting.models.balances import Balances from xero_python.accounting.models.bank_transaction import BankTransaction from xero_python.accounting.models.bank_transactions import BankTransactions @@ -49,6 +50,8 @@ from xero_python.accounting.models.contact_groups import ContactGroups from xero_python.accounting.models.contact_person import ContactPerson from xero_python.accounting.models.contacts import Contacts +from xero_python.accounting.models.conversion_balances import ConversionBalances +from xero_python.accounting.models.conversion_date import ConversionDate from xero_python.accounting.models.country_code import CountryCode from xero_python.accounting.models.credit_note import CreditNote from xero_python.accounting.models.credit_notes import CreditNotes @@ -64,6 +67,12 @@ from xero_python.accounting.models.external_link import ExternalLink from xero_python.accounting.models.history_record import HistoryRecord from xero_python.accounting.models.history_records import HistoryRecords +from xero_python.accounting.models.import_summary import ImportSummary +from xero_python.accounting.models.import_summary_accounts import ImportSummaryAccounts +from xero_python.accounting.models.import_summary_object import ImportSummaryObject +from xero_python.accounting.models.import_summary_organisation import ( + ImportSummaryOrganisation, +) from xero_python.accounting.models.invoice import Invoice from xero_python.accounting.models.invoice_reminder import InvoiceReminder from xero_python.accounting.models.invoice_reminders import InvoiceReminders @@ -121,6 +130,7 @@ from xero_python.accounting.models.row_type import RowType from xero_python.accounting.models.sales_tracking_category import SalesTrackingCategory from xero_python.accounting.models.schedule import Schedule +from xero_python.accounting.models.setup import Setup from xero_python.accounting.models.tax_component import TaxComponent from xero_python.accounting.models.tax_rate import TaxRate from xero_python.accounting.models.tax_rates import TaxRates diff --git a/xero_python/accounting/api/accounting_api.py b/xero_python/accounting/api/accounting_api.py index 3f7174ac..c01e5b4a 100644 --- a/xero_python/accounting/api/accounting_api.py +++ b/xero_python/accounting/api/accounting_api.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ @@ -15909,6 +15909,84 @@ def get_users( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "get_users") + def post_setup( + self, + xero_tenant_id, + setup, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Allows you to set the chart of accounts, the conversion date and conversion balances # noqa: E501 + OAuth2 scope: accounting.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param Setup setup: Object including an accounts array, a conversion balances array and a conversion date object in body of request (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: ImportSummaryObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `post_setup`" + ) + # verify the required parameter 'setup' is set + if setup is None: + raise ValueError( + "Missing the required parameter `setup` " "when calling `post_setup`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = setup + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Setup") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="ImportSummaryObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "post_setup") + def update_account( self, xero_tenant_id, diff --git a/xero_python/accounting/docs/AccountingApi.md b/xero_python/accounting/docs/AccountingApi.md index 118333df..cef57e48 100644 --- a/xero_python/accounting/docs/AccountingApi.md +++ b/xero_python/accounting/docs/AccountingApi.md @@ -191,6 +191,7 @@ Method | HTTP request | Description [**get_tracking_category**](AccountingApi.md#get_tracking_category) | **GET** /TrackingCategories/{TrackingCategoryID} | Allows you to retrieve tracking categories and options for specified category [**get_user**](AccountingApi.md#get_user) | **GET** /Users/{UserID} | Allows you to retrieve a specified user [**get_users**](AccountingApi.md#get_users) | **GET** /Users | Allows you to retrieve users +[**post_setup**](AccountingApi.md#post_setup) | **POST** /Setup | Allows you to set the chart of accounts, the conversion date and conversion balances [**update_account**](AccountingApi.md#update_account) | **POST** /Accounts/{AccountID} | Allows you to update a chart of accounts [**update_account_attachment_by_file_name**](AccountingApi.md#update_account_attachment_by_file_name) | **POST** /Accounts/{AccountID}/Attachments/{FileName} | Allows you to update Attachment on Account by Filename [**update_bank_transaction**](AccountingApi.md#update_bank_transaction) | **POST** /BankTransactions/{BankTransactionID} | Allows you to update a single spend or receive money transaction @@ -12441,6 +12442,69 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **post_setup** +> ImportSummaryObject post_setup(xero_tenant_id, setup) + +Allows you to set the chart of accounts, the conversion date and conversion balances + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.accounting import AccountingApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AccountingApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +setup = { "ConversionDate": {}, "ConversionBalances": [], "Accounts": [ { "Code": "200", "Name": "Sales", "Type": "SALES", "ReportingCode": "REV.TRA.GOO" }, { "Code": "400", "Name": "Advertising", "Type": "OVERHEADS", "ReportingCode": "EXP" }, { "Code": "610", "Name": "Accounts Receivable", "Type": "CURRENT", "SystemAccount": "DEBTORS", "ReportingCode": "ASS.CUR.REC.TRA" }, { "Code": "800", "Name": "Accounts Payable", "Type": "CURRLIAB", "SystemAccount": "CREDITORS", "ReportingCode": "LIA.CUR.PAY" } ] } # Setup | Object including an accounts array, a conversion balances array and a conversion date object in body of request +try: + # Allows you to set the chart of accounts, the conversion date and conversion balances + api_response = api_instance.post_setup(xero_tenant_id, setup) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountingApi->post_setup: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **setup** | [**Setup**](Setup.md)| Object including an accounts array, a conversion balances array and a conversion date object in body of request | + +### Return type + +[**ImportSummaryObject**](ImportSummaryObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **update_account** > Accounts update_account(xero_tenant_id, account_id, accounts) diff --git a/xero_python/accounting/docs/BalanceDetails.md b/xero_python/accounting/docs/BalanceDetails.md new file mode 100644 index 00000000..6e215200 --- /dev/null +++ b/xero_python/accounting/docs/BalanceDetails.md @@ -0,0 +1,12 @@ +# BalanceDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**balance** | **float** | The opening balances of the account. Debits are positive, credits are negative values | [optional] +**currency_code** | **str** | The currency of the balance (Not required for base currency) | [optional] +**currency_rate** | **float** | (Optional) Exchange rate to base currency when money is spent or received. If not specified, XE rate for the day is applied | [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) + + diff --git a/xero_python/accounting/docs/ConversionBalances.md b/xero_python/accounting/docs/ConversionBalances.md new file mode 100644 index 00000000..c9ebbb81 --- /dev/null +++ b/xero_python/accounting/docs/ConversionBalances.md @@ -0,0 +1,12 @@ +# ConversionBalances + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_code** | **str** | The account code for a account | [optional] +**balance** | **float** | The opening balances of the account. Debits are positive, credits are negative values | [optional] +**balance_details** | [**list[BalanceDetails]**](BalanceDetails.md) | | [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) + + diff --git a/xero_python/accounting/docs/ConversionDate.md b/xero_python/accounting/docs/ConversionDate.md new file mode 100644 index 00000000..69647422 --- /dev/null +++ b/xero_python/accounting/docs/ConversionDate.md @@ -0,0 +1,11 @@ +# ConversionDate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**month** | **int** | The month the organisation starts using Xero. Value is an integer between 1 and 12 | [optional] +**year** | **int** | The year the organisation starts using Xero. Value is an integer greater than 2006 | [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) + + diff --git a/xero_python/accounting/docs/ImportSummary.md b/xero_python/accounting/docs/ImportSummary.md new file mode 100644 index 00000000..08a185ca --- /dev/null +++ b/xero_python/accounting/docs/ImportSummary.md @@ -0,0 +1,11 @@ +# ImportSummary + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accounts** | [**ImportSummaryAccounts**](ImportSummaryAccounts.md) | | [optional] +**organisation** | [**ImportSummaryOrganisation**](ImportSummaryOrganisation.md) | | [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) + + diff --git a/xero_python/accounting/docs/ImportSummaryAccounts.md b/xero_python/accounting/docs/ImportSummaryAccounts.md new file mode 100644 index 00000000..bd71f7d9 --- /dev/null +++ b/xero_python/accounting/docs/ImportSummaryAccounts.md @@ -0,0 +1,18 @@ +# ImportSummaryAccounts + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **float** | The total number of accounts in the org | [optional] +**new** | **float** | The number of new accounts created | [optional] +**updated** | **float** | The number of accounts updated | [optional] +**deleted** | **float** | The number of accounts deleted | [optional] +**locked** | **float** | The number of locked accounts | [optional] +**system** | **float** | The number of system accounts | [optional] +**errored** | **float** | The number of accounts that had an error | [optional] +**present** | **bool** | | [optional] +**new_or_updated** | **float** | The number of new or updated accounts | [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) + + diff --git a/xero_python/accounting/docs/ImportSummaryObject.md b/xero_python/accounting/docs/ImportSummaryObject.md new file mode 100644 index 00000000..62938132 --- /dev/null +++ b/xero_python/accounting/docs/ImportSummaryObject.md @@ -0,0 +1,10 @@ +# ImportSummaryObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**import_summary** | [**ImportSummary**](ImportSummary.md) | | [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) + + diff --git a/xero_python/accounting/docs/ImportSummaryOrganisation.md b/xero_python/accounting/docs/ImportSummaryOrganisation.md new file mode 100644 index 00000000..9014663a --- /dev/null +++ b/xero_python/accounting/docs/ImportSummaryOrganisation.md @@ -0,0 +1,10 @@ +# ImportSummaryOrganisation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**present** | **bool** | | [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) + + diff --git a/xero_python/accounting/docs/Setup.md b/xero_python/accounting/docs/Setup.md new file mode 100644 index 00000000..f2279f9d --- /dev/null +++ b/xero_python/accounting/docs/Setup.md @@ -0,0 +1,12 @@ +# Setup + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**conversion_date** | [**ConversionDate**](ConversionDate.md) | | [optional] +**conversion_balances** | [**list[ConversionBalances]**](ConversionBalances.md) | Balance supplied for each account that has a value as at the conversion date. | [optional] +**accounts** | [**list[Account]**](Account.md) | | [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) + + diff --git a/xero_python/accounting/models/__init__.py b/xero_python/accounting/models/__init__.py index 583325e3..0372ae54 100644 --- a/xero_python/accounting/models/__init__.py +++ b/xero_python/accounting/models/__init__.py @@ -6,7 +6,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ @@ -25,6 +25,7 @@ from xero_python.accounting.models.allocations import Allocations from xero_python.accounting.models.attachment import Attachment from xero_python.accounting.models.attachments import Attachments +from xero_python.accounting.models.balance_details import BalanceDetails from xero_python.accounting.models.balances import Balances from xero_python.accounting.models.bank_transaction import BankTransaction from xero_python.accounting.models.bank_transactions import BankTransactions @@ -44,6 +45,8 @@ from xero_python.accounting.models.contact_groups import ContactGroups from xero_python.accounting.models.contact_person import ContactPerson from xero_python.accounting.models.contacts import Contacts +from xero_python.accounting.models.conversion_balances import ConversionBalances +from xero_python.accounting.models.conversion_date import ConversionDate from xero_python.accounting.models.country_code import CountryCode from xero_python.accounting.models.credit_note import CreditNote from xero_python.accounting.models.credit_notes import CreditNotes @@ -59,6 +62,12 @@ from xero_python.accounting.models.external_link import ExternalLink from xero_python.accounting.models.history_record import HistoryRecord from xero_python.accounting.models.history_records import HistoryRecords +from xero_python.accounting.models.import_summary import ImportSummary +from xero_python.accounting.models.import_summary_accounts import ImportSummaryAccounts +from xero_python.accounting.models.import_summary_object import ImportSummaryObject +from xero_python.accounting.models.import_summary_organisation import ( + ImportSummaryOrganisation, +) from xero_python.accounting.models.invoice import Invoice from xero_python.accounting.models.invoice_reminder import InvoiceReminder from xero_python.accounting.models.invoice_reminders import InvoiceReminders @@ -116,6 +125,7 @@ from xero_python.accounting.models.row_type import RowType from xero_python.accounting.models.sales_tracking_category import SalesTrackingCategory from xero_python.accounting.models.schedule import Schedule +from xero_python.accounting.models.setup import Setup from xero_python.accounting.models.tax_component import TaxComponent from xero_python.accounting.models.tax_rate import TaxRate from xero_python.accounting.models.tax_rates import TaxRates diff --git a/xero_python/accounting/models/account.py b/xero_python/accounting/models/account.py index d64e92cf..54ca6dd5 100644 --- a/xero_python/accounting/models/account.py +++ b/xero_python/accounting/models/account.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/account_type.py b/xero_python/accounting/models/account_type.py index 9f23dd2d..4e2938a9 100644 --- a/xero_python/accounting/models/account_type.py +++ b/xero_python/accounting/models/account_type.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/accounts.py b/xero_python/accounting/models/accounts.py index 24d1ecea..35a605ae 100644 --- a/xero_python/accounting/models/accounts.py +++ b/xero_python/accounting/models/accounts.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/accounts_payable.py b/xero_python/accounting/models/accounts_payable.py index b5e9ec50..9b0bf770 100644 --- a/xero_python/accounting/models/accounts_payable.py +++ b/xero_python/accounting/models/accounts_payable.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/accounts_receivable.py b/xero_python/accounting/models/accounts_receivable.py index c2c52ca5..72727889 100644 --- a/xero_python/accounting/models/accounts_receivable.py +++ b/xero_python/accounting/models/accounts_receivable.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/action.py b/xero_python/accounting/models/action.py index 27bbdfda..b1b8a482 100644 --- a/xero_python/accounting/models/action.py +++ b/xero_python/accounting/models/action.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/actions.py b/xero_python/accounting/models/actions.py index 2bde42da..e13eaea0 100644 --- a/xero_python/accounting/models/actions.py +++ b/xero_python/accounting/models/actions.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/address.py b/xero_python/accounting/models/address.py index e4860c9f..885a8163 100644 --- a/xero_python/accounting/models/address.py +++ b/xero_python/accounting/models/address.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/allocation.py b/xero_python/accounting/models/allocation.py index e5d45bfd..53d20e0b 100644 --- a/xero_python/accounting/models/allocation.py +++ b/xero_python/accounting/models/allocation.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/allocations.py b/xero_python/accounting/models/allocations.py index 70f98072..420d7768 100644 --- a/xero_python/accounting/models/allocations.py +++ b/xero_python/accounting/models/allocations.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/attachment.py b/xero_python/accounting/models/attachment.py index efabdac4..49dfa2c6 100644 --- a/xero_python/accounting/models/attachment.py +++ b/xero_python/accounting/models/attachment.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/attachments.py b/xero_python/accounting/models/attachments.py index 5544393a..690a2890 100644 --- a/xero_python/accounting/models/attachments.py +++ b/xero_python/accounting/models/attachments.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/balance_details.py b/xero_python/accounting/models/balance_details.py new file mode 100644 index 00000000..bd9e8c98 --- /dev/null +++ b/xero_python/accounting/models/balance_details.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class BalanceDetails(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "balance": "float", + "currency_code": "str", + "currency_rate": "float", + } + + attribute_map = { + "balance": "Balance", + "currency_code": "CurrencyCode", + "currency_rate": "CurrencyRate", + } + + def __init__( + self, balance=None, currency_code=None, currency_rate=None + ): # noqa: E501 + """BalanceDetails - a model defined in OpenAPI""" # noqa: E501 + + self._balance = None + self._currency_code = None + self._currency_rate = None + self.discriminator = None + + if balance is not None: + self.balance = balance + if currency_code is not None: + self.currency_code = currency_code + if currency_rate is not None: + self.currency_rate = currency_rate + + @property + def balance(self): + """Gets the balance of this BalanceDetails. # noqa: E501 + + The opening balances of the account. Debits are positive, credits are negative values # noqa: E501 + + :return: The balance of this BalanceDetails. # noqa: E501 + :rtype: float + """ + return self._balance + + @balance.setter + def balance(self, balance): + """Sets the balance of this BalanceDetails. + + The opening balances of the account. Debits are positive, credits are negative values # noqa: E501 + + :param balance: The balance of this BalanceDetails. # noqa: E501 + :type: float + """ + + self._balance = balance + + @property + def currency_code(self): + """Gets the currency_code of this BalanceDetails. # noqa: E501 + + The currency of the balance (Not required for base currency) # noqa: E501 + + :return: The currency_code of this BalanceDetails. # noqa: E501 + :rtype: str + """ + return self._currency_code + + @currency_code.setter + def currency_code(self, currency_code): + """Sets the currency_code of this BalanceDetails. + + The currency of the balance (Not required for base currency) # noqa: E501 + + :param currency_code: The currency_code of this BalanceDetails. # noqa: E501 + :type: str + """ + + self._currency_code = currency_code + + @property + def currency_rate(self): + """Gets the currency_rate of this BalanceDetails. # noqa: E501 + + (Optional) Exchange rate to base currency when money is spent or received. If not specified, XE rate for the day is applied # noqa: E501 + + :return: The currency_rate of this BalanceDetails. # noqa: E501 + :rtype: float + """ + return self._currency_rate + + @currency_rate.setter + def currency_rate(self, currency_rate): + """Sets the currency_rate of this BalanceDetails. + + (Optional) Exchange rate to base currency when money is spent or received. If not specified, XE rate for the day is applied # noqa: E501 + + :param currency_rate: The currency_rate of this BalanceDetails. # noqa: E501 + :type: float + """ + + self._currency_rate = currency_rate diff --git a/xero_python/accounting/models/balances.py b/xero_python/accounting/models/balances.py index 01cfc92f..8e1f7a14 100644 --- a/xero_python/accounting/models/balances.py +++ b/xero_python/accounting/models/balances.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/bank_transaction.py b/xero_python/accounting/models/bank_transaction.py index 2a49a64d..e4ee6729 100644 --- a/xero_python/accounting/models/bank_transaction.py +++ b/xero_python/accounting/models/bank_transaction.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/bank_transactions.py b/xero_python/accounting/models/bank_transactions.py index 34bde7c2..84af633c 100644 --- a/xero_python/accounting/models/bank_transactions.py +++ b/xero_python/accounting/models/bank_transactions.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/bank_transfer.py b/xero_python/accounting/models/bank_transfer.py index 5281010c..5ba910b3 100644 --- a/xero_python/accounting/models/bank_transfer.py +++ b/xero_python/accounting/models/bank_transfer.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/bank_transfers.py b/xero_python/accounting/models/bank_transfers.py index 7a454a65..32d36e77 100644 --- a/xero_python/accounting/models/bank_transfers.py +++ b/xero_python/accounting/models/bank_transfers.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/batch_payment.py b/xero_python/accounting/models/batch_payment.py index 5edcf442..619df7a5 100644 --- a/xero_python/accounting/models/batch_payment.py +++ b/xero_python/accounting/models/batch_payment.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/batch_payment_details.py b/xero_python/accounting/models/batch_payment_details.py index 837585ed..1d927fbd 100644 --- a/xero_python/accounting/models/batch_payment_details.py +++ b/xero_python/accounting/models/batch_payment_details.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/batch_payments.py b/xero_python/accounting/models/batch_payments.py index d166bfdd..f1cde104 100644 --- a/xero_python/accounting/models/batch_payments.py +++ b/xero_python/accounting/models/batch_payments.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/bill.py b/xero_python/accounting/models/bill.py index c04b5169..257c9b01 100644 --- a/xero_python/accounting/models/bill.py +++ b/xero_python/accounting/models/bill.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/branding_theme.py b/xero_python/accounting/models/branding_theme.py index 24e89c49..e7b023b4 100644 --- a/xero_python/accounting/models/branding_theme.py +++ b/xero_python/accounting/models/branding_theme.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/branding_themes.py b/xero_python/accounting/models/branding_themes.py index 97350510..eb7499e5 100644 --- a/xero_python/accounting/models/branding_themes.py +++ b/xero_python/accounting/models/branding_themes.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/cis_org_setting.py b/xero_python/accounting/models/cis_org_setting.py index 1572726b..97e2fb36 100644 --- a/xero_python/accounting/models/cis_org_setting.py +++ b/xero_python/accounting/models/cis_org_setting.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/cis_setting.py b/xero_python/accounting/models/cis_setting.py index 58a49c4c..384e757d 100644 --- a/xero_python/accounting/models/cis_setting.py +++ b/xero_python/accounting/models/cis_setting.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/cis_settings.py b/xero_python/accounting/models/cis_settings.py index 003ac5c9..e661e986 100644 --- a/xero_python/accounting/models/cis_settings.py +++ b/xero_python/accounting/models/cis_settings.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/contact.py b/xero_python/accounting/models/contact.py index ff1e8a06..7e623be2 100644 --- a/xero_python/accounting/models/contact.py +++ b/xero_python/accounting/models/contact.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/contact_group.py b/xero_python/accounting/models/contact_group.py index 37c48d05..11eca0c3 100644 --- a/xero_python/accounting/models/contact_group.py +++ b/xero_python/accounting/models/contact_group.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/contact_groups.py b/xero_python/accounting/models/contact_groups.py index bd309311..648a7033 100644 --- a/xero_python/accounting/models/contact_groups.py +++ b/xero_python/accounting/models/contact_groups.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/contact_person.py b/xero_python/accounting/models/contact_person.py index 665da1c5..a02e4f22 100644 --- a/xero_python/accounting/models/contact_person.py +++ b/xero_python/accounting/models/contact_person.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/contacts.py b/xero_python/accounting/models/contacts.py index f4bc7b88..45b6468a 100644 --- a/xero_python/accounting/models/contacts.py +++ b/xero_python/accounting/models/contacts.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/conversion_balances.py b/xero_python/accounting/models/conversion_balances.py new file mode 100644 index 00000000..76b2da88 --- /dev/null +++ b/xero_python/accounting/models/conversion_balances.py @@ -0,0 +1,127 @@ +# coding: utf-8 + +""" + Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class ConversionBalances(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "account_code": "str", + "balance": "float", + "balance_details": "list[BalanceDetails]", + } + + attribute_map = { + "account_code": "AccountCode", + "balance": "Balance", + "balance_details": "BalanceDetails", + } + + def __init__( + self, account_code=None, balance=None, balance_details=None + ): # noqa: E501 + """ConversionBalances - a model defined in OpenAPI""" # noqa: E501 + + self._account_code = None + self._balance = None + self._balance_details = None + self.discriminator = None + + if account_code is not None: + self.account_code = account_code + if balance is not None: + self.balance = balance + if balance_details is not None: + self.balance_details = balance_details + + @property + def account_code(self): + """Gets the account_code of this ConversionBalances. # noqa: E501 + + The account code for a account # noqa: E501 + + :return: The account_code of this ConversionBalances. # noqa: E501 + :rtype: str + """ + return self._account_code + + @account_code.setter + def account_code(self, account_code): + """Sets the account_code of this ConversionBalances. + + The account code for a account # noqa: E501 + + :param account_code: The account_code of this ConversionBalances. # noqa: E501 + :type: str + """ + + self._account_code = account_code + + @property + def balance(self): + """Gets the balance of this ConversionBalances. # noqa: E501 + + The opening balances of the account. Debits are positive, credits are negative values # noqa: E501 + + :return: The balance of this ConversionBalances. # noqa: E501 + :rtype: float + """ + return self._balance + + @balance.setter + def balance(self, balance): + """Sets the balance of this ConversionBalances. + + The opening balances of the account. Debits are positive, credits are negative values # noqa: E501 + + :param balance: The balance of this ConversionBalances. # noqa: E501 + :type: float + """ + + self._balance = balance + + @property + def balance_details(self): + """Gets the balance_details of this ConversionBalances. # noqa: E501 + + + :return: The balance_details of this ConversionBalances. # noqa: E501 + :rtype: list[BalanceDetails] + """ + return self._balance_details + + @balance_details.setter + def balance_details(self, balance_details): + """Sets the balance_details of this ConversionBalances. + + + :param balance_details: The balance_details of this ConversionBalances. # noqa: E501 + :type: list[BalanceDetails] + """ + + self._balance_details = balance_details diff --git a/xero_python/accounting/models/conversion_date.py b/xero_python/accounting/models/conversion_date.py new file mode 100644 index 00000000..9affe6e4 --- /dev/null +++ b/xero_python/accounting/models/conversion_date.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class ConversionDate(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"month": "int", "year": "int"} + + attribute_map = {"month": "Month", "year": "Year"} + + def __init__(self, month=None, year=None): # noqa: E501 + """ConversionDate - a model defined in OpenAPI""" # noqa: E501 + + self._month = None + self._year = None + self.discriminator = None + + if month is not None: + self.month = month + if year is not None: + self.year = year + + @property + def month(self): + """Gets the month of this ConversionDate. # noqa: E501 + + The month the organisation starts using Xero. Value is an integer between 1 and 12 # noqa: E501 + + :return: The month of this ConversionDate. # noqa: E501 + :rtype: int + """ + return self._month + + @month.setter + def month(self, month): + """Sets the month of this ConversionDate. + + The month the organisation starts using Xero. Value is an integer between 1 and 12 # noqa: E501 + + :param month: The month of this ConversionDate. # noqa: E501 + :type: int + """ + + self._month = month + + @property + def year(self): + """Gets the year of this ConversionDate. # noqa: E501 + + The year the organisation starts using Xero. Value is an integer greater than 2006 # noqa: E501 + + :return: The year of this ConversionDate. # noqa: E501 + :rtype: int + """ + return self._year + + @year.setter + def year(self, year): + """Sets the year of this ConversionDate. + + The year the organisation starts using Xero. Value is an integer greater than 2006 # noqa: E501 + + :param year: The year of this ConversionDate. # noqa: E501 + :type: int + """ + + self._year = year diff --git a/xero_python/accounting/models/country_code.py b/xero_python/accounting/models/country_code.py index f444ce79..2c3e6c1f 100644 --- a/xero_python/accounting/models/country_code.py +++ b/xero_python/accounting/models/country_code.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/credit_note.py b/xero_python/accounting/models/credit_note.py index 4d495434..9b67eb77 100644 --- a/xero_python/accounting/models/credit_note.py +++ b/xero_python/accounting/models/credit_note.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/credit_notes.py b/xero_python/accounting/models/credit_notes.py index 751213d7..52fe30fe 100644 --- a/xero_python/accounting/models/credit_notes.py +++ b/xero_python/accounting/models/credit_notes.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/currencies.py b/xero_python/accounting/models/currencies.py index f09e3d7e..efac6de6 100644 --- a/xero_python/accounting/models/currencies.py +++ b/xero_python/accounting/models/currencies.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/currency.py b/xero_python/accounting/models/currency.py index 5c1604ea..5da3bade 100644 --- a/xero_python/accounting/models/currency.py +++ b/xero_python/accounting/models/currency.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/currency_code.py b/xero_python/accounting/models/currency_code.py index dd883819..2c0c4817 100644 --- a/xero_python/accounting/models/currency_code.py +++ b/xero_python/accounting/models/currency_code.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/element.py b/xero_python/accounting/models/element.py index 253a084a..0d359608 100644 --- a/xero_python/accounting/models/element.py +++ b/xero_python/accounting/models/element.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/employee.py b/xero_python/accounting/models/employee.py index 9cca82a3..fd44c953 100644 --- a/xero_python/accounting/models/employee.py +++ b/xero_python/accounting/models/employee.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/employees.py b/xero_python/accounting/models/employees.py index 601ed28a..254d0354 100644 --- a/xero_python/accounting/models/employees.py +++ b/xero_python/accounting/models/employees.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/error.py b/xero_python/accounting/models/error.py index 96a657b3..e1186573 100644 --- a/xero_python/accounting/models/error.py +++ b/xero_python/accounting/models/error.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/expense_claim.py b/xero_python/accounting/models/expense_claim.py index 9da55182..dd5583fc 100644 --- a/xero_python/accounting/models/expense_claim.py +++ b/xero_python/accounting/models/expense_claim.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/expense_claims.py b/xero_python/accounting/models/expense_claims.py index ac49500f..d22d2406 100644 --- a/xero_python/accounting/models/expense_claims.py +++ b/xero_python/accounting/models/expense_claims.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/external_link.py b/xero_python/accounting/models/external_link.py index 8c83af57..cc0decd0 100644 --- a/xero_python/accounting/models/external_link.py +++ b/xero_python/accounting/models/external_link.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/history_record.py b/xero_python/accounting/models/history_record.py index 625ab3de..0a8ccf3f 100644 --- a/xero_python/accounting/models/history_record.py +++ b/xero_python/accounting/models/history_record.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/history_records.py b/xero_python/accounting/models/history_records.py index 1da78bd0..daf04dce 100644 --- a/xero_python/accounting/models/history_records.py +++ b/xero_python/accounting/models/history_records.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/import_summary.py b/xero_python/accounting/models/import_summary.py new file mode 100644 index 00000000..64f8fbdf --- /dev/null +++ b/xero_python/accounting/models/import_summary.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class ImportSummary(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "accounts": "ImportSummaryAccounts", + "organisation": "ImportSummaryOrganisation", + } + + attribute_map = {"accounts": "Accounts", "organisation": "Organisation"} + + def __init__(self, accounts=None, organisation=None): # noqa: E501 + """ImportSummary - a model defined in OpenAPI""" # noqa: E501 + + self._accounts = None + self._organisation = None + self.discriminator = None + + if accounts is not None: + self.accounts = accounts + if organisation is not None: + self.organisation = organisation + + @property + def accounts(self): + """Gets the accounts of this ImportSummary. # noqa: E501 + + + :return: The accounts of this ImportSummary. # noqa: E501 + :rtype: ImportSummaryAccounts + """ + return self._accounts + + @accounts.setter + def accounts(self, accounts): + """Sets the accounts of this ImportSummary. + + + :param accounts: The accounts of this ImportSummary. # noqa: E501 + :type: ImportSummaryAccounts + """ + + self._accounts = accounts + + @property + def organisation(self): + """Gets the organisation of this ImportSummary. # noqa: E501 + + + :return: The organisation of this ImportSummary. # noqa: E501 + :rtype: ImportSummaryOrganisation + """ + return self._organisation + + @organisation.setter + def organisation(self, organisation): + """Sets the organisation of this ImportSummary. + + + :param organisation: The organisation of this ImportSummary. # noqa: E501 + :type: ImportSummaryOrganisation + """ + + self._organisation = organisation diff --git a/xero_python/accounting/models/import_summary_accounts.py b/xero_python/accounting/models/import_summary_accounts.py new file mode 100644 index 00000000..0173047b --- /dev/null +++ b/xero_python/accounting/models/import_summary_accounts.py @@ -0,0 +1,304 @@ +# coding: utf-8 + +""" + Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class ImportSummaryAccounts(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "total": "float", + "new": "float", + "updated": "float", + "deleted": "float", + "locked": "float", + "system": "float", + "errored": "float", + "present": "bool", + "new_or_updated": "float", + } + + attribute_map = { + "total": "Total", + "new": "New", + "updated": "Updated", + "deleted": "Deleted", + "locked": "Locked", + "system": "System", + "errored": "Errored", + "present": "Present", + "new_or_updated": "NewOrUpdated", + } + + def __init__( + self, + total=None, + new=None, + updated=None, + deleted=None, + locked=None, + system=None, + errored=None, + present=None, + new_or_updated=None, + ): # noqa: E501 + """ImportSummaryAccounts - a model defined in OpenAPI""" # noqa: E501 + + self._total = None + self._new = None + self._updated = None + self._deleted = None + self._locked = None + self._system = None + self._errored = None + self._present = None + self._new_or_updated = None + self.discriminator = None + + if total is not None: + self.total = total + if new is not None: + self.new = new + if updated is not None: + self.updated = updated + if deleted is not None: + self.deleted = deleted + if locked is not None: + self.locked = locked + if system is not None: + self.system = system + if errored is not None: + self.errored = errored + if present is not None: + self.present = present + if new_or_updated is not None: + self.new_or_updated = new_or_updated + + @property + def total(self): + """Gets the total of this ImportSummaryAccounts. # noqa: E501 + + The total number of accounts in the org # noqa: E501 + + :return: The total of this ImportSummaryAccounts. # noqa: E501 + :rtype: float + """ + return self._total + + @total.setter + def total(self, total): + """Sets the total of this ImportSummaryAccounts. + + The total number of accounts in the org # noqa: E501 + + :param total: The total of this ImportSummaryAccounts. # noqa: E501 + :type: float + """ + + self._total = total + + @property + def new(self): + """Gets the new of this ImportSummaryAccounts. # noqa: E501 + + The number of new accounts created # noqa: E501 + + :return: The new of this ImportSummaryAccounts. # noqa: E501 + :rtype: float + """ + return self._new + + @new.setter + def new(self, new): + """Sets the new of this ImportSummaryAccounts. + + The number of new accounts created # noqa: E501 + + :param new: The new of this ImportSummaryAccounts. # noqa: E501 + :type: float + """ + + self._new = new + + @property + def updated(self): + """Gets the updated of this ImportSummaryAccounts. # noqa: E501 + + The number of accounts updated # noqa: E501 + + :return: The updated of this ImportSummaryAccounts. # noqa: E501 + :rtype: float + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this ImportSummaryAccounts. + + The number of accounts updated # noqa: E501 + + :param updated: The updated of this ImportSummaryAccounts. # noqa: E501 + :type: float + """ + + self._updated = updated + + @property + def deleted(self): + """Gets the deleted of this ImportSummaryAccounts. # noqa: E501 + + The number of accounts deleted # noqa: E501 + + :return: The deleted of this ImportSummaryAccounts. # noqa: E501 + :rtype: float + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this ImportSummaryAccounts. + + The number of accounts deleted # noqa: E501 + + :param deleted: The deleted of this ImportSummaryAccounts. # noqa: E501 + :type: float + """ + + self._deleted = deleted + + @property + def locked(self): + """Gets the locked of this ImportSummaryAccounts. # noqa: E501 + + The number of locked accounts # noqa: E501 + + :return: The locked of this ImportSummaryAccounts. # noqa: E501 + :rtype: float + """ + return self._locked + + @locked.setter + def locked(self, locked): + """Sets the locked of this ImportSummaryAccounts. + + The number of locked accounts # noqa: E501 + + :param locked: The locked of this ImportSummaryAccounts. # noqa: E501 + :type: float + """ + + self._locked = locked + + @property + def system(self): + """Gets the system of this ImportSummaryAccounts. # noqa: E501 + + The number of system accounts # noqa: E501 + + :return: The system of this ImportSummaryAccounts. # noqa: E501 + :rtype: float + """ + return self._system + + @system.setter + def system(self, system): + """Sets the system of this ImportSummaryAccounts. + + The number of system accounts # noqa: E501 + + :param system: The system of this ImportSummaryAccounts. # noqa: E501 + :type: float + """ + + self._system = system + + @property + def errored(self): + """Gets the errored of this ImportSummaryAccounts. # noqa: E501 + + The number of accounts that had an error # noqa: E501 + + :return: The errored of this ImportSummaryAccounts. # noqa: E501 + :rtype: float + """ + return self._errored + + @errored.setter + def errored(self, errored): + """Sets the errored of this ImportSummaryAccounts. + + The number of accounts that had an error # noqa: E501 + + :param errored: The errored of this ImportSummaryAccounts. # noqa: E501 + :type: float + """ + + self._errored = errored + + @property + def present(self): + """Gets the present of this ImportSummaryAccounts. # noqa: E501 + + + :return: The present of this ImportSummaryAccounts. # noqa: E501 + :rtype: bool + """ + return self._present + + @present.setter + def present(self, present): + """Sets the present of this ImportSummaryAccounts. + + + :param present: The present of this ImportSummaryAccounts. # noqa: E501 + :type: bool + """ + + self._present = present + + @property + def new_or_updated(self): + """Gets the new_or_updated of this ImportSummaryAccounts. # noqa: E501 + + The number of new or updated accounts # noqa: E501 + + :return: The new_or_updated of this ImportSummaryAccounts. # noqa: E501 + :rtype: float + """ + return self._new_or_updated + + @new_or_updated.setter + def new_or_updated(self, new_or_updated): + """Sets the new_or_updated of this ImportSummaryAccounts. + + The number of new or updated accounts # noqa: E501 + + :param new_or_updated: The new_or_updated of this ImportSummaryAccounts. # noqa: E501 + :type: float + """ + + self._new_or_updated = new_or_updated diff --git a/xero_python/accounting/models/import_summary_object.py b/xero_python/accounting/models/import_summary_object.py new file mode 100644 index 00000000..ba84a28a --- /dev/null +++ b/xero_python/accounting/models/import_summary_object.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class ImportSummaryObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"import_summary": "ImportSummary"} + + attribute_map = {"import_summary": "ImportSummary"} + + def __init__(self, import_summary=None): # noqa: E501 + """ImportSummaryObject - a model defined in OpenAPI""" # noqa: E501 + + self._import_summary = None + self.discriminator = None + + if import_summary is not None: + self.import_summary = import_summary + + @property + def import_summary(self): + """Gets the import_summary of this ImportSummaryObject. # noqa: E501 + + + :return: The import_summary of this ImportSummaryObject. # noqa: E501 + :rtype: ImportSummary + """ + return self._import_summary + + @import_summary.setter + def import_summary(self, import_summary): + """Sets the import_summary of this ImportSummaryObject. + + + :param import_summary: The import_summary of this ImportSummaryObject. # noqa: E501 + :type: ImportSummary + """ + + self._import_summary = import_summary diff --git a/xero_python/accounting/models/import_summary_organisation.py b/xero_python/accounting/models/import_summary_organisation.py new file mode 100644 index 00000000..1428471f --- /dev/null +++ b/xero_python/accounting/models/import_summary_organisation.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class ImportSummaryOrganisation(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"present": "bool"} + + attribute_map = {"present": "Present"} + + def __init__(self, present=None): # noqa: E501 + """ImportSummaryOrganisation - a model defined in OpenAPI""" # noqa: E501 + + self._present = None + self.discriminator = None + + if present is not None: + self.present = present + + @property + def present(self): + """Gets the present of this ImportSummaryOrganisation. # noqa: E501 + + + :return: The present of this ImportSummaryOrganisation. # noqa: E501 + :rtype: bool + """ + return self._present + + @present.setter + def present(self, present): + """Sets the present of this ImportSummaryOrganisation. + + + :param present: The present of this ImportSummaryOrganisation. # noqa: E501 + :type: bool + """ + + self._present = present diff --git a/xero_python/accounting/models/invoice.py b/xero_python/accounting/models/invoice.py index 5544806a..14b19096 100644 --- a/xero_python/accounting/models/invoice.py +++ b/xero_python/accounting/models/invoice.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/invoice_reminder.py b/xero_python/accounting/models/invoice_reminder.py index 42b08743..10b4dc92 100644 --- a/xero_python/accounting/models/invoice_reminder.py +++ b/xero_python/accounting/models/invoice_reminder.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/invoice_reminders.py b/xero_python/accounting/models/invoice_reminders.py index 64c8f1c2..754bec15 100644 --- a/xero_python/accounting/models/invoice_reminders.py +++ b/xero_python/accounting/models/invoice_reminders.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/invoices.py b/xero_python/accounting/models/invoices.py index cd2d50da..d81f600f 100644 --- a/xero_python/accounting/models/invoices.py +++ b/xero_python/accounting/models/invoices.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/item.py b/xero_python/accounting/models/item.py index 3a04e8c5..9a48a242 100644 --- a/xero_python/accounting/models/item.py +++ b/xero_python/accounting/models/item.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/items.py b/xero_python/accounting/models/items.py index d119c8aa..4230c8fc 100644 --- a/xero_python/accounting/models/items.py +++ b/xero_python/accounting/models/items.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/journal.py b/xero_python/accounting/models/journal.py index 960eec77..fdb8db84 100644 --- a/xero_python/accounting/models/journal.py +++ b/xero_python/accounting/models/journal.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/journal_line.py b/xero_python/accounting/models/journal_line.py index bce1f1b1..85ac6a36 100644 --- a/xero_python/accounting/models/journal_line.py +++ b/xero_python/accounting/models/journal_line.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/journals.py b/xero_python/accounting/models/journals.py index e9012a0f..bf315068 100644 --- a/xero_python/accounting/models/journals.py +++ b/xero_python/accounting/models/journals.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/line_amount_types.py b/xero_python/accounting/models/line_amount_types.py index ef7bc436..f5d7674d 100644 --- a/xero_python/accounting/models/line_amount_types.py +++ b/xero_python/accounting/models/line_amount_types.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/line_item.py b/xero_python/accounting/models/line_item.py index 92b787c5..2a325e2e 100644 --- a/xero_python/accounting/models/line_item.py +++ b/xero_python/accounting/models/line_item.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/line_item_tracking.py b/xero_python/accounting/models/line_item_tracking.py index 4635ebae..23b7a9a3 100644 --- a/xero_python/accounting/models/line_item_tracking.py +++ b/xero_python/accounting/models/line_item_tracking.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/linked_transaction.py b/xero_python/accounting/models/linked_transaction.py index 328f37eb..d1d421a0 100644 --- a/xero_python/accounting/models/linked_transaction.py +++ b/xero_python/accounting/models/linked_transaction.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/linked_transactions.py b/xero_python/accounting/models/linked_transactions.py index 92219402..92b02b95 100644 --- a/xero_python/accounting/models/linked_transactions.py +++ b/xero_python/accounting/models/linked_transactions.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/manual_journal.py b/xero_python/accounting/models/manual_journal.py index b3bfe90e..8e2b9c1f 100644 --- a/xero_python/accounting/models/manual_journal.py +++ b/xero_python/accounting/models/manual_journal.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/manual_journal_line.py b/xero_python/accounting/models/manual_journal_line.py index b9aa66aa..25c663c0 100644 --- a/xero_python/accounting/models/manual_journal_line.py +++ b/xero_python/accounting/models/manual_journal_line.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/manual_journals.py b/xero_python/accounting/models/manual_journals.py index 9265286b..f499fe75 100644 --- a/xero_python/accounting/models/manual_journals.py +++ b/xero_python/accounting/models/manual_journals.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/online_invoice.py b/xero_python/accounting/models/online_invoice.py index 5926ace3..fa369df5 100644 --- a/xero_python/accounting/models/online_invoice.py +++ b/xero_python/accounting/models/online_invoice.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/online_invoices.py b/xero_python/accounting/models/online_invoices.py index d30edc90..f1bf4d8c 100644 --- a/xero_python/accounting/models/online_invoices.py +++ b/xero_python/accounting/models/online_invoices.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/organisation.py b/xero_python/accounting/models/organisation.py index cecce046..04669563 100644 --- a/xero_python/accounting/models/organisation.py +++ b/xero_python/accounting/models/organisation.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/organisations.py b/xero_python/accounting/models/organisations.py index b105e378..63c975c0 100644 --- a/xero_python/accounting/models/organisations.py +++ b/xero_python/accounting/models/organisations.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/overpayment.py b/xero_python/accounting/models/overpayment.py index b3aa1d36..bcf23a02 100644 --- a/xero_python/accounting/models/overpayment.py +++ b/xero_python/accounting/models/overpayment.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/overpayments.py b/xero_python/accounting/models/overpayments.py index 15fdcce4..f2401aaa 100644 --- a/xero_python/accounting/models/overpayments.py +++ b/xero_python/accounting/models/overpayments.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/payment.py b/xero_python/accounting/models/payment.py index 23952fc3..5b1950e1 100644 --- a/xero_python/accounting/models/payment.py +++ b/xero_python/accounting/models/payment.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/payment_delete.py b/xero_python/accounting/models/payment_delete.py index 776c5dcc..76254fb4 100644 --- a/xero_python/accounting/models/payment_delete.py +++ b/xero_python/accounting/models/payment_delete.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/payment_service.py b/xero_python/accounting/models/payment_service.py index 00b4a55d..8758e190 100644 --- a/xero_python/accounting/models/payment_service.py +++ b/xero_python/accounting/models/payment_service.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/payment_services.py b/xero_python/accounting/models/payment_services.py index 6ddae2de..ed53d40d 100644 --- a/xero_python/accounting/models/payment_services.py +++ b/xero_python/accounting/models/payment_services.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/payment_term.py b/xero_python/accounting/models/payment_term.py index 6596474c..bd571e62 100644 --- a/xero_python/accounting/models/payment_term.py +++ b/xero_python/accounting/models/payment_term.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/payment_term_type.py b/xero_python/accounting/models/payment_term_type.py index 6c7f8f0a..5fcfb9fe 100644 --- a/xero_python/accounting/models/payment_term_type.py +++ b/xero_python/accounting/models/payment_term_type.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/payments.py b/xero_python/accounting/models/payments.py index 3abaf4fc..ed2c486f 100644 --- a/xero_python/accounting/models/payments.py +++ b/xero_python/accounting/models/payments.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/phone.py b/xero_python/accounting/models/phone.py index 57c029bd..d5670f70 100644 --- a/xero_python/accounting/models/phone.py +++ b/xero_python/accounting/models/phone.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/prepayment.py b/xero_python/accounting/models/prepayment.py index 9fc181a1..7dffc50d 100644 --- a/xero_python/accounting/models/prepayment.py +++ b/xero_python/accounting/models/prepayment.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/prepayments.py b/xero_python/accounting/models/prepayments.py index f5ebe45b..8f7b7375 100644 --- a/xero_python/accounting/models/prepayments.py +++ b/xero_python/accounting/models/prepayments.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/purchase.py b/xero_python/accounting/models/purchase.py index d4f17064..c80013f6 100644 --- a/xero_python/accounting/models/purchase.py +++ b/xero_python/accounting/models/purchase.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/purchase_order.py b/xero_python/accounting/models/purchase_order.py index de9ea491..4811fc82 100644 --- a/xero_python/accounting/models/purchase_order.py +++ b/xero_python/accounting/models/purchase_order.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/purchase_orders.py b/xero_python/accounting/models/purchase_orders.py index c301ea1c..a81b9b61 100644 --- a/xero_python/accounting/models/purchase_orders.py +++ b/xero_python/accounting/models/purchase_orders.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/quote.py b/xero_python/accounting/models/quote.py index 498bf236..419a69a6 100644 --- a/xero_python/accounting/models/quote.py +++ b/xero_python/accounting/models/quote.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/quote_line_amount_types.py b/xero_python/accounting/models/quote_line_amount_types.py index c411758b..f06f5301 100644 --- a/xero_python/accounting/models/quote_line_amount_types.py +++ b/xero_python/accounting/models/quote_line_amount_types.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/quote_status_codes.py b/xero_python/accounting/models/quote_status_codes.py index 84247c10..84b1ee17 100644 --- a/xero_python/accounting/models/quote_status_codes.py +++ b/xero_python/accounting/models/quote_status_codes.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/quotes.py b/xero_python/accounting/models/quotes.py index 8e461774..f46b30a3 100644 --- a/xero_python/accounting/models/quotes.py +++ b/xero_python/accounting/models/quotes.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/receipt.py b/xero_python/accounting/models/receipt.py index 22daf549..b05ce9a2 100644 --- a/xero_python/accounting/models/receipt.py +++ b/xero_python/accounting/models/receipt.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/receipts.py b/xero_python/accounting/models/receipts.py index 9e620d5f..c5ed5566 100644 --- a/xero_python/accounting/models/receipts.py +++ b/xero_python/accounting/models/receipts.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/repeating_invoice.py b/xero_python/accounting/models/repeating_invoice.py index 2e201dd8..75456ab6 100644 --- a/xero_python/accounting/models/repeating_invoice.py +++ b/xero_python/accounting/models/repeating_invoice.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/repeating_invoices.py b/xero_python/accounting/models/repeating_invoices.py index 06daf5f4..05a17cde 100644 --- a/xero_python/accounting/models/repeating_invoices.py +++ b/xero_python/accounting/models/repeating_invoices.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report.py b/xero_python/accounting/models/report.py index 0b647864..29276722 100644 --- a/xero_python/accounting/models/report.py +++ b/xero_python/accounting/models/report.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report_attribute.py b/xero_python/accounting/models/report_attribute.py index b01a628e..401e0ef1 100644 --- a/xero_python/accounting/models/report_attribute.py +++ b/xero_python/accounting/models/report_attribute.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report_cell.py b/xero_python/accounting/models/report_cell.py index cfa1fc10..029160a0 100644 --- a/xero_python/accounting/models/report_cell.py +++ b/xero_python/accounting/models/report_cell.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report_fields.py b/xero_python/accounting/models/report_fields.py index 08ef88f9..96f67d91 100644 --- a/xero_python/accounting/models/report_fields.py +++ b/xero_python/accounting/models/report_fields.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report_row.py b/xero_python/accounting/models/report_row.py index 05f855ee..bae3c3d1 100644 --- a/xero_python/accounting/models/report_row.py +++ b/xero_python/accounting/models/report_row.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report_rows.py b/xero_python/accounting/models/report_rows.py index 9bea0b27..fbaca5ab 100644 --- a/xero_python/accounting/models/report_rows.py +++ b/xero_python/accounting/models/report_rows.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report_with_row.py b/xero_python/accounting/models/report_with_row.py index 4826e8d8..d49e7e85 100644 --- a/xero_python/accounting/models/report_with_row.py +++ b/xero_python/accounting/models/report_with_row.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/report_with_rows.py b/xero_python/accounting/models/report_with_rows.py index f75634cc..1428bab0 100644 --- a/xero_python/accounting/models/report_with_rows.py +++ b/xero_python/accounting/models/report_with_rows.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/reports.py b/xero_python/accounting/models/reports.py index 6733ff6e..499c2442 100644 --- a/xero_python/accounting/models/reports.py +++ b/xero_python/accounting/models/reports.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/request_empty.py b/xero_python/accounting/models/request_empty.py index b79772c9..dd1184f9 100644 --- a/xero_python/accounting/models/request_empty.py +++ b/xero_python/accounting/models/request_empty.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/row_type.py b/xero_python/accounting/models/row_type.py index a90c693a..69dcbaf9 100644 --- a/xero_python/accounting/models/row_type.py +++ b/xero_python/accounting/models/row_type.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/sales_tracking_category.py b/xero_python/accounting/models/sales_tracking_category.py index 61208d8f..b2d21699 100644 --- a/xero_python/accounting/models/sales_tracking_category.py +++ b/xero_python/accounting/models/sales_tracking_category.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/schedule.py b/xero_python/accounting/models/schedule.py index f5127b69..55c66d80 100644 --- a/xero_python/accounting/models/schedule.py +++ b/xero_python/accounting/models/schedule.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/setup.py b/xero_python/accounting/models/setup.py new file mode 100644 index 00000000..598f6b7d --- /dev/null +++ b/xero_python/accounting/models/setup.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Setup(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "conversion_date": "ConversionDate", + "conversion_balances": "list[ConversionBalances]", + "accounts": "list[Account]", + } + + attribute_map = { + "conversion_date": "ConversionDate", + "conversion_balances": "ConversionBalances", + "accounts": "Accounts", + } + + def __init__( + self, conversion_date=None, conversion_balances=None, accounts=None + ): # noqa: E501 + """Setup - a model defined in OpenAPI""" # noqa: E501 + + self._conversion_date = None + self._conversion_balances = None + self._accounts = None + self.discriminator = None + + if conversion_date is not None: + self.conversion_date = conversion_date + if conversion_balances is not None: + self.conversion_balances = conversion_balances + if accounts is not None: + self.accounts = accounts + + @property + def conversion_date(self): + """Gets the conversion_date of this Setup. # noqa: E501 + + + :return: The conversion_date of this Setup. # noqa: E501 + :rtype: ConversionDate + """ + return self._conversion_date + + @conversion_date.setter + def conversion_date(self, conversion_date): + """Sets the conversion_date of this Setup. + + + :param conversion_date: The conversion_date of this Setup. # noqa: E501 + :type: ConversionDate + """ + + self._conversion_date = conversion_date + + @property + def conversion_balances(self): + """Gets the conversion_balances of this Setup. # noqa: E501 + + Balance supplied for each account that has a value as at the conversion date. # noqa: E501 + + :return: The conversion_balances of this Setup. # noqa: E501 + :rtype: list[ConversionBalances] + """ + return self._conversion_balances + + @conversion_balances.setter + def conversion_balances(self, conversion_balances): + """Sets the conversion_balances of this Setup. + + Balance supplied for each account that has a value as at the conversion date. # noqa: E501 + + :param conversion_balances: The conversion_balances of this Setup. # noqa: E501 + :type: list[ConversionBalances] + """ + + self._conversion_balances = conversion_balances + + @property + def accounts(self): + """Gets the accounts of this Setup. # noqa: E501 + + + :return: The accounts of this Setup. # noqa: E501 + :rtype: list[Account] + """ + return self._accounts + + @accounts.setter + def accounts(self, accounts): + """Sets the accounts of this Setup. + + + :param accounts: The accounts of this Setup. # noqa: E501 + :type: list[Account] + """ + + self._accounts = accounts diff --git a/xero_python/accounting/models/tax_component.py b/xero_python/accounting/models/tax_component.py index 47fb975b..b922f493 100644 --- a/xero_python/accounting/models/tax_component.py +++ b/xero_python/accounting/models/tax_component.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tax_rate.py b/xero_python/accounting/models/tax_rate.py index 99777b52..7b795bed 100644 --- a/xero_python/accounting/models/tax_rate.py +++ b/xero_python/accounting/models/tax_rate.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tax_rates.py b/xero_python/accounting/models/tax_rates.py index c91c3978..008d38d0 100644 --- a/xero_python/accounting/models/tax_rates.py +++ b/xero_python/accounting/models/tax_rates.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tax_type.py b/xero_python/accounting/models/tax_type.py index c09f8f8d..e1df6f70 100644 --- a/xero_python/accounting/models/tax_type.py +++ b/xero_python/accounting/models/tax_type.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/ten_ninety_nine_contact.py b/xero_python/accounting/models/ten_ninety_nine_contact.py index 2569633f..05a7863e 100644 --- a/xero_python/accounting/models/ten_ninety_nine_contact.py +++ b/xero_python/accounting/models/ten_ninety_nine_contact.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/time_zone.py b/xero_python/accounting/models/time_zone.py index 88a58acd..ee619df5 100644 --- a/xero_python/accounting/models/time_zone.py +++ b/xero_python/accounting/models/time_zone.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tracking_categories.py b/xero_python/accounting/models/tracking_categories.py index 75f721f2..d563265e 100644 --- a/xero_python/accounting/models/tracking_categories.py +++ b/xero_python/accounting/models/tracking_categories.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tracking_category.py b/xero_python/accounting/models/tracking_category.py index 9a3c8db1..bb3f9803 100644 --- a/xero_python/accounting/models/tracking_category.py +++ b/xero_python/accounting/models/tracking_category.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tracking_option.py b/xero_python/accounting/models/tracking_option.py index 3160c72f..2d800fe1 100644 --- a/xero_python/accounting/models/tracking_option.py +++ b/xero_python/accounting/models/tracking_option.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tracking_options.py b/xero_python/accounting/models/tracking_options.py index 3d9fb24c..d5e3c546 100644 --- a/xero_python/accounting/models/tracking_options.py +++ b/xero_python/accounting/models/tracking_options.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/user.py b/xero_python/accounting/models/user.py index e7a42d81..ed591982 100644 --- a/xero_python/accounting/models/user.py +++ b/xero_python/accounting/models/user.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/users.py b/xero_python/accounting/models/users.py index a9419b7b..1ed60097 100644 --- a/xero_python/accounting/models/users.py +++ b/xero_python/accounting/models/users.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/validation_error.py b/xero_python/accounting/models/validation_error.py index d44cbc6f..f321ac50 100644 --- a/xero_python/accounting/models/validation_error.py +++ b/xero_python/accounting/models/validation_error.py @@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/__init__.py b/xero_python/assets/__init__.py index 30ecad60..8215f0ca 100644 --- a/xero_python/assets/__init__.py +++ b/xero_python/assets/__init__.py @@ -7,7 +7,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/api/asset_api.py b/xero_python/assets/api/asset_api.py index 68b3db79..fcaa8127 100644 --- a/xero_python/assets/api/asset_api.py +++ b/xero_python/assets/api/asset_api.py @@ -5,7 +5,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/__init__.py b/xero_python/assets/models/__init__.py index 60ebac7b..da553664 100644 --- a/xero_python/assets/models/__init__.py +++ b/xero_python/assets/models/__init__.py @@ -6,7 +6,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/asset.py b/xero_python/assets/models/asset.py index 1210b358..39214595 100644 --- a/xero_python/assets/models/asset.py +++ b/xero_python/assets/models/asset.py @@ -5,7 +5,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/asset_status.py b/xero_python/assets/models/asset_status.py index 38a9d8cc..c38fab3e 100644 --- a/xero_python/assets/models/asset_status.py +++ b/xero_python/assets/models/asset_status.py @@ -5,7 +5,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/asset_status_query_param.py b/xero_python/assets/models/asset_status_query_param.py index a22aa76a..5f341106 100644 --- a/xero_python/assets/models/asset_status_query_param.py +++ b/xero_python/assets/models/asset_status_query_param.py @@ -5,7 +5,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/asset_type.py b/xero_python/assets/models/asset_type.py index fdbbc2d0..5809cb9e 100644 --- a/xero_python/assets/models/asset_type.py +++ b/xero_python/assets/models/asset_type.py @@ -5,7 +5,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/assets.py b/xero_python/assets/models/assets.py index 97edcdd4..fad057b6 100644 --- a/xero_python/assets/models/assets.py +++ b/xero_python/assets/models/assets.py @@ -5,7 +5,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/book_depreciation_detail.py b/xero_python/assets/models/book_depreciation_detail.py index dda0c5a4..363434ae 100644 --- a/xero_python/assets/models/book_depreciation_detail.py +++ b/xero_python/assets/models/book_depreciation_detail.py @@ -5,7 +5,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/book_depreciation_setting.py b/xero_python/assets/models/book_depreciation_setting.py index 709d4070..59390e47 100644 --- a/xero_python/assets/models/book_depreciation_setting.py +++ b/xero_python/assets/models/book_depreciation_setting.py @@ -5,7 +5,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/error.py b/xero_python/assets/models/error.py index 516d7ae8..b4a66c73 100644 --- a/xero_python/assets/models/error.py +++ b/xero_python/assets/models/error.py @@ -5,7 +5,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/field_validation_errors_element.py b/xero_python/assets/models/field_validation_errors_element.py index 25752e8e..9402b82d 100644 --- a/xero_python/assets/models/field_validation_errors_element.py +++ b/xero_python/assets/models/field_validation_errors_element.py @@ -5,7 +5,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/pagination.py b/xero_python/assets/models/pagination.py index 8e60f6eb..da1650eb 100644 --- a/xero_python/assets/models/pagination.py +++ b/xero_python/assets/models/pagination.py @@ -5,7 +5,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/resource_validation_errors_element.py b/xero_python/assets/models/resource_validation_errors_element.py index 0ccceab0..d8741def 100644 --- a/xero_python/assets/models/resource_validation_errors_element.py +++ b/xero_python/assets/models/resource_validation_errors_element.py @@ -5,7 +5,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/assets/models/setting.py b/xero_python/assets/models/setting.py index 4e41afda..3cf480f5 100644 --- a/xero_python/assets/models/setting.py +++ b/xero_python/assets/models/setting.py @@ -5,7 +5,7 @@ This is the Xero Assets API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/docs/README.md b/xero_python/docs/README.md index 81786247..5d205cf3 100644 --- a/xero_python/docs/README.md +++ b/xero_python/docs/README.md @@ -3,8 +3,8 @@ This specifing endpoints related to managing authentication tokens and identity 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: 2.4.0 -- Package version: 1.0.13 +- API version: 2.4.4 +- Package version: 1.1.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://developer.xero.com](https://developer.xero.com) diff --git a/xero_python/identity/__init__.py b/xero_python/identity/__init__.py index 5e9a74f6..bd69524a 100644 --- a/xero_python/identity/__init__.py +++ b/xero_python/identity/__init__.py @@ -7,7 +7,7 @@ This specifing endpoints related to managing authentication tokens and identity for Xero API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/identity/api/identity_api.py b/xero_python/identity/api/identity_api.py index 6cf932ea..ef5827ab 100644 --- a/xero_python/identity/api/identity_api.py +++ b/xero_python/identity/api/identity_api.py @@ -5,7 +5,7 @@ This specifing endpoints related to managing authentication tokens and identity for Xero API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/identity/models/__init__.py b/xero_python/identity/models/__init__.py index 6cf9259c..1394dabb 100644 --- a/xero_python/identity/models/__init__.py +++ b/xero_python/identity/models/__init__.py @@ -6,7 +6,7 @@ This specifing endpoints related to managing authentication tokens and identity for Xero API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/identity/models/access_token.py b/xero_python/identity/models/access_token.py index 85b416d9..6602a603 100644 --- a/xero_python/identity/models/access_token.py +++ b/xero_python/identity/models/access_token.py @@ -5,7 +5,7 @@ This specifing endpoints related to managing authentication tokens and identity for Xero API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/identity/models/connection.py b/xero_python/identity/models/connection.py index f763ef36..e370cd4d 100644 --- a/xero_python/identity/models/connection.py +++ b/xero_python/identity/models/connection.py @@ -5,7 +5,7 @@ This specifing endpoints related to managing authentication tokens and identity for Xero API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/identity/models/refresh_token.py b/xero_python/identity/models/refresh_token.py index e953fc9e..a4aabcc1 100644 --- a/xero_python/identity/models/refresh_token.py +++ b/xero_python/identity/models/refresh_token.py @@ -5,7 +5,7 @@ This specifing endpoints related to managing authentication tokens and identity for Xero API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/__init__.py b/xero_python/payrollau/__init__.py index fc893e46..2c022189 100644 --- a/xero_python/payrollau/__init__.py +++ b/xero_python/payrollau/__init__.py @@ -7,7 +7,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/api/payroll_au_api.py b/xero_python/payrollau/api/payroll_au_api.py index d67c8293..4d2ca86d 100644 --- a/xero_python/payrollau/api/payroll_au_api.py +++ b/xero_python/payrollau/api/payroll_au_api.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/__init__.py b/xero_python/payrollau/models/__init__.py index 2cb5e700..7663fecf 100644 --- a/xero_python/payrollau/models/__init__.py +++ b/xero_python/payrollau/models/__init__.py @@ -6,7 +6,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/account.py b/xero_python/payrollau/models/account.py index 22e25567..00e49f37 100644 --- a/xero_python/payrollau/models/account.py +++ b/xero_python/payrollau/models/account.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/account_type.py b/xero_python/payrollau/models/account_type.py index f09d5c13..04a61ac2 100644 --- a/xero_python/payrollau/models/account_type.py +++ b/xero_python/payrollau/models/account_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/allowance_type.py b/xero_python/payrollau/models/allowance_type.py index b8e6d7ee..d6bc690f 100644 --- a/xero_python/payrollau/models/allowance_type.py +++ b/xero_python/payrollau/models/allowance_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/api_exception.py b/xero_python/payrollau/models/api_exception.py index 080cce7e..3f0df313 100644 --- a/xero_python/payrollau/models/api_exception.py +++ b/xero_python/payrollau/models/api_exception.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/bank_account.py b/xero_python/payrollau/models/bank_account.py index 36208ae2..9ea8a7d4 100644 --- a/xero_python/payrollau/models/bank_account.py +++ b/xero_python/payrollau/models/bank_account.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/calendar_type.py b/xero_python/payrollau/models/calendar_type.py index 199b5e70..209a3a96 100644 --- a/xero_python/payrollau/models/calendar_type.py +++ b/xero_python/payrollau/models/calendar_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/deduction_line.py b/xero_python/payrollau/models/deduction_line.py index 8c0b8f0c..128d886e 100644 --- a/xero_python/payrollau/models/deduction_line.py +++ b/xero_python/payrollau/models/deduction_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/deduction_type.py b/xero_python/payrollau/models/deduction_type.py index 2104e89d..21006f3c 100644 --- a/xero_python/payrollau/models/deduction_type.py +++ b/xero_python/payrollau/models/deduction_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/deduction_type_calculation_type.py b/xero_python/payrollau/models/deduction_type_calculation_type.py index 5d242258..2d0e63b8 100644 --- a/xero_python/payrollau/models/deduction_type_calculation_type.py +++ b/xero_python/payrollau/models/deduction_type_calculation_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/earnings_line.py b/xero_python/payrollau/models/earnings_line.py index bc3c6a23..30d844e5 100644 --- a/xero_python/payrollau/models/earnings_line.py +++ b/xero_python/payrollau/models/earnings_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/earnings_rate.py b/xero_python/payrollau/models/earnings_rate.py index a997fc09..b8660f24 100644 --- a/xero_python/payrollau/models/earnings_rate.py +++ b/xero_python/payrollau/models/earnings_rate.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/earnings_rate_calculation_type.py b/xero_python/payrollau/models/earnings_rate_calculation_type.py index d3e1eef9..b6af0434 100644 --- a/xero_python/payrollau/models/earnings_rate_calculation_type.py +++ b/xero_python/payrollau/models/earnings_rate_calculation_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/earnings_type.py b/xero_python/payrollau/models/earnings_type.py index 00c0e288..0700406b 100644 --- a/xero_python/payrollau/models/earnings_type.py +++ b/xero_python/payrollau/models/earnings_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/employee.py b/xero_python/payrollau/models/employee.py index e7281e99..d069034c 100644 --- a/xero_python/payrollau/models/employee.py +++ b/xero_python/payrollau/models/employee.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/employee_status.py b/xero_python/payrollau/models/employee_status.py index 34123110..f9e58008 100644 --- a/xero_python/payrollau/models/employee_status.py +++ b/xero_python/payrollau/models/employee_status.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/employees.py b/xero_python/payrollau/models/employees.py index e6f28365..cddf3c2c 100644 --- a/xero_python/payrollau/models/employees.py +++ b/xero_python/payrollau/models/employees.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/employment_basis.py b/xero_python/payrollau/models/employment_basis.py index d0d03f24..bd3a7764 100644 --- a/xero_python/payrollau/models/employment_basis.py +++ b/xero_python/payrollau/models/employment_basis.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/employment_termination_payment_type.py b/xero_python/payrollau/models/employment_termination_payment_type.py index 0c50d854..1449e1bb 100644 --- a/xero_python/payrollau/models/employment_termination_payment_type.py +++ b/xero_python/payrollau/models/employment_termination_payment_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/entitlement_final_pay_payout_type.py b/xero_python/payrollau/models/entitlement_final_pay_payout_type.py index affc6450..bb89ee68 100644 --- a/xero_python/payrollau/models/entitlement_final_pay_payout_type.py +++ b/xero_python/payrollau/models/entitlement_final_pay_payout_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/home_address.py b/xero_python/payrollau/models/home_address.py index 4c8ee59e..499301be 100644 --- a/xero_python/payrollau/models/home_address.py +++ b/xero_python/payrollau/models/home_address.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_accrual_line.py b/xero_python/payrollau/models/leave_accrual_line.py index 28f071d6..aa45308f 100644 --- a/xero_python/payrollau/models/leave_accrual_line.py +++ b/xero_python/payrollau/models/leave_accrual_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_application.py b/xero_python/payrollau/models/leave_application.py index 927e8251..9c2593dc 100644 --- a/xero_python/payrollau/models/leave_application.py +++ b/xero_python/payrollau/models/leave_application.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_applications.py b/xero_python/payrollau/models/leave_applications.py index a70bdd63..9e5c6af0 100644 --- a/xero_python/payrollau/models/leave_applications.py +++ b/xero_python/payrollau/models/leave_applications.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_balance.py b/xero_python/payrollau/models/leave_balance.py index db3e7e8c..e3444471 100644 --- a/xero_python/payrollau/models/leave_balance.py +++ b/xero_python/payrollau/models/leave_balance.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_earnings_line.py b/xero_python/payrollau/models/leave_earnings_line.py index c03cf862..09265b51 100644 --- a/xero_python/payrollau/models/leave_earnings_line.py +++ b/xero_python/payrollau/models/leave_earnings_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_line.py b/xero_python/payrollau/models/leave_line.py index c3bc5d0d..de99dfbe 100644 --- a/xero_python/payrollau/models/leave_line.py +++ b/xero_python/payrollau/models/leave_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_line_calculation_type.py b/xero_python/payrollau/models/leave_line_calculation_type.py index 77c8bf90..49ed775e 100644 --- a/xero_python/payrollau/models/leave_line_calculation_type.py +++ b/xero_python/payrollau/models/leave_line_calculation_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_lines.py b/xero_python/payrollau/models/leave_lines.py index 14cf35a5..89b7a5ea 100644 --- a/xero_python/payrollau/models/leave_lines.py +++ b/xero_python/payrollau/models/leave_lines.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_period.py b/xero_python/payrollau/models/leave_period.py index 08675ae3..6460f7d2 100644 --- a/xero_python/payrollau/models/leave_period.py +++ b/xero_python/payrollau/models/leave_period.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_period_status.py b/xero_python/payrollau/models/leave_period_status.py index db6e0876..69e355bc 100644 --- a/xero_python/payrollau/models/leave_period_status.py +++ b/xero_python/payrollau/models/leave_period_status.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_type.py b/xero_python/payrollau/models/leave_type.py index d4d8f799..7d50a462 100644 --- a/xero_python/payrollau/models/leave_type.py +++ b/xero_python/payrollau/models/leave_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/leave_type_contribution_type.py b/xero_python/payrollau/models/leave_type_contribution_type.py index 751f6e46..240ed629 100644 --- a/xero_python/payrollau/models/leave_type_contribution_type.py +++ b/xero_python/payrollau/models/leave_type_contribution_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/manual_tax_type.py b/xero_python/payrollau/models/manual_tax_type.py index 6fd351f8..7aea6271 100644 --- a/xero_python/payrollau/models/manual_tax_type.py +++ b/xero_python/payrollau/models/manual_tax_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/opening_balances.py b/xero_python/payrollau/models/opening_balances.py index 3290b9cc..309b46e4 100644 --- a/xero_python/payrollau/models/opening_balances.py +++ b/xero_python/payrollau/models/opening_balances.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/pay_item.py b/xero_python/payrollau/models/pay_item.py index 35aaaf13..ca250e25 100644 --- a/xero_python/payrollau/models/pay_item.py +++ b/xero_python/payrollau/models/pay_item.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/pay_items.py b/xero_python/payrollau/models/pay_items.py index b7810531..137fd81a 100644 --- a/xero_python/payrollau/models/pay_items.py +++ b/xero_python/payrollau/models/pay_items.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/pay_run.py b/xero_python/payrollau/models/pay_run.py index 35f1ac52..6cf2f41d 100644 --- a/xero_python/payrollau/models/pay_run.py +++ b/xero_python/payrollau/models/pay_run.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/pay_run_status.py b/xero_python/payrollau/models/pay_run_status.py index 9edcbca2..8bff851c 100644 --- a/xero_python/payrollau/models/pay_run_status.py +++ b/xero_python/payrollau/models/pay_run_status.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/pay_runs.py b/xero_python/payrollau/models/pay_runs.py index 265b9a6d..4781679a 100644 --- a/xero_python/payrollau/models/pay_runs.py +++ b/xero_python/payrollau/models/pay_runs.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/pay_template.py b/xero_python/payrollau/models/pay_template.py index a2ac7f79..fb67dd00 100644 --- a/xero_python/payrollau/models/pay_template.py +++ b/xero_python/payrollau/models/pay_template.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payment_frequency_type.py b/xero_python/payrollau/models/payment_frequency_type.py index fb774b42..8eb15d72 100644 --- a/xero_python/payrollau/models/payment_frequency_type.py +++ b/xero_python/payrollau/models/payment_frequency_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payroll_calendar.py b/xero_python/payrollau/models/payroll_calendar.py index 5b3496e1..77232e28 100644 --- a/xero_python/payrollau/models/payroll_calendar.py +++ b/xero_python/payrollau/models/payroll_calendar.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payroll_calendars.py b/xero_python/payrollau/models/payroll_calendars.py index 5caae65f..061903de 100644 --- a/xero_python/payrollau/models/payroll_calendars.py +++ b/xero_python/payrollau/models/payroll_calendars.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payslip.py b/xero_python/payrollau/models/payslip.py index 0b70c85c..6461fb02 100644 --- a/xero_python/payrollau/models/payslip.py +++ b/xero_python/payrollau/models/payslip.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payslip_lines.py b/xero_python/payrollau/models/payslip_lines.py index 9440de6b..4f0c095b 100644 --- a/xero_python/payrollau/models/payslip_lines.py +++ b/xero_python/payrollau/models/payslip_lines.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payslip_object.py b/xero_python/payrollau/models/payslip_object.py index d4f02892..f5c4036f 100644 --- a/xero_python/payrollau/models/payslip_object.py +++ b/xero_python/payrollau/models/payslip_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payslip_summary.py b/xero_python/payrollau/models/payslip_summary.py index 83e4d598..c8da234a 100644 --- a/xero_python/payrollau/models/payslip_summary.py +++ b/xero_python/payrollau/models/payslip_summary.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/payslips.py b/xero_python/payrollau/models/payslips.py index ccdbebd3..12912c17 100644 --- a/xero_python/payrollau/models/payslips.py +++ b/xero_python/payrollau/models/payslips.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/rate_type.py b/xero_python/payrollau/models/rate_type.py index 8e6c70b3..38786dba 100644 --- a/xero_python/payrollau/models/rate_type.py +++ b/xero_python/payrollau/models/rate_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/reimbursement_line.py b/xero_python/payrollau/models/reimbursement_line.py index 369cc127..2b03248f 100644 --- a/xero_python/payrollau/models/reimbursement_line.py +++ b/xero_python/payrollau/models/reimbursement_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/reimbursement_lines.py b/xero_python/payrollau/models/reimbursement_lines.py index 6d12767d..62deaba0 100644 --- a/xero_python/payrollau/models/reimbursement_lines.py +++ b/xero_python/payrollau/models/reimbursement_lines.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/reimbursement_type.py b/xero_python/payrollau/models/reimbursement_type.py index 301952cb..f1555b32 100644 --- a/xero_python/payrollau/models/reimbursement_type.py +++ b/xero_python/payrollau/models/reimbursement_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/residency_status.py b/xero_python/payrollau/models/residency_status.py index a8bd6013..213becca 100644 --- a/xero_python/payrollau/models/residency_status.py +++ b/xero_python/payrollau/models/residency_status.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/settings.py b/xero_python/payrollau/models/settings.py index a675faf9..58546cc8 100644 --- a/xero_python/payrollau/models/settings.py +++ b/xero_python/payrollau/models/settings.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/settings_object.py b/xero_python/payrollau/models/settings_object.py index 3e6a9c0a..1c0e2d99 100644 --- a/xero_python/payrollau/models/settings_object.py +++ b/xero_python/payrollau/models/settings_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/settings_tracking_categories.py b/xero_python/payrollau/models/settings_tracking_categories.py index 0779f430..4b2376be 100644 --- a/xero_python/payrollau/models/settings_tracking_categories.py +++ b/xero_python/payrollau/models/settings_tracking_categories.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py b/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py index cf8420aa..946f8949 100644 --- a/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py +++ b/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py b/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py index 76317816..1f517bb2 100644 --- a/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py +++ b/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/state.py b/xero_python/payrollau/models/state.py index 900c1e29..d8dbcc2d 100644 --- a/xero_python/payrollau/models/state.py +++ b/xero_python/payrollau/models/state.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/super_fund.py b/xero_python/payrollau/models/super_fund.py index 376141a3..3bca8a78 100644 --- a/xero_python/payrollau/models/super_fund.py +++ b/xero_python/payrollau/models/super_fund.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/super_fund_product.py b/xero_python/payrollau/models/super_fund_product.py index 89d0f5ad..60ee5406 100644 --- a/xero_python/payrollau/models/super_fund_product.py +++ b/xero_python/payrollau/models/super_fund_product.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/super_fund_products.py b/xero_python/payrollau/models/super_fund_products.py index d1bf902b..0c13ab7e 100644 --- a/xero_python/payrollau/models/super_fund_products.py +++ b/xero_python/payrollau/models/super_fund_products.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/super_fund_type.py b/xero_python/payrollau/models/super_fund_type.py index a0f0a2b9..e2af5a5d 100644 --- a/xero_python/payrollau/models/super_fund_type.py +++ b/xero_python/payrollau/models/super_fund_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/super_funds.py b/xero_python/payrollau/models/super_funds.py index d532392c..c3573575 100644 --- a/xero_python/payrollau/models/super_funds.py +++ b/xero_python/payrollau/models/super_funds.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/super_line.py b/xero_python/payrollau/models/super_line.py index 1c91f4b4..1a06c7eb 100644 --- a/xero_python/payrollau/models/super_line.py +++ b/xero_python/payrollau/models/super_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/super_membership.py b/xero_python/payrollau/models/super_membership.py index ada30f57..195e877c 100644 --- a/xero_python/payrollau/models/super_membership.py +++ b/xero_python/payrollau/models/super_membership.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/superannuation_calculation_type.py b/xero_python/payrollau/models/superannuation_calculation_type.py index 4b3e6372..51d1d407 100644 --- a/xero_python/payrollau/models/superannuation_calculation_type.py +++ b/xero_python/payrollau/models/superannuation_calculation_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/superannuation_contribution_type.py b/xero_python/payrollau/models/superannuation_contribution_type.py index 5c68651f..91706819 100644 --- a/xero_python/payrollau/models/superannuation_contribution_type.py +++ b/xero_python/payrollau/models/superannuation_contribution_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/superannuation_line.py b/xero_python/payrollau/models/superannuation_line.py index 9e5e1f88..ecfb62a3 100644 --- a/xero_python/payrollau/models/superannuation_line.py +++ b/xero_python/payrollau/models/superannuation_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/tax_declaration.py b/xero_python/payrollau/models/tax_declaration.py index eed54506..391102ba 100644 --- a/xero_python/payrollau/models/tax_declaration.py +++ b/xero_python/payrollau/models/tax_declaration.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/tax_line.py b/xero_python/payrollau/models/tax_line.py index 5deea1f9..a0e6c2c1 100644 --- a/xero_python/payrollau/models/tax_line.py +++ b/xero_python/payrollau/models/tax_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/tfn_exemption_type.py b/xero_python/payrollau/models/tfn_exemption_type.py index 52637d92..771cdd28 100644 --- a/xero_python/payrollau/models/tfn_exemption_type.py +++ b/xero_python/payrollau/models/tfn_exemption_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/timesheet.py b/xero_python/payrollau/models/timesheet.py index bda0680d..bbee341b 100644 --- a/xero_python/payrollau/models/timesheet.py +++ b/xero_python/payrollau/models/timesheet.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/timesheet_line.py b/xero_python/payrollau/models/timesheet_line.py index 65677945..b32b5145 100644 --- a/xero_python/payrollau/models/timesheet_line.py +++ b/xero_python/payrollau/models/timesheet_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/timesheet_object.py b/xero_python/payrollau/models/timesheet_object.py index bbac624e..071649cd 100644 --- a/xero_python/payrollau/models/timesheet_object.py +++ b/xero_python/payrollau/models/timesheet_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/timesheet_status.py b/xero_python/payrollau/models/timesheet_status.py index eef400be..004deb3e 100644 --- a/xero_python/payrollau/models/timesheet_status.py +++ b/xero_python/payrollau/models/timesheet_status.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/timesheets.py b/xero_python/payrollau/models/timesheets.py index 1862a090..b3ed2e7e 100644 --- a/xero_python/payrollau/models/timesheets.py +++ b/xero_python/payrollau/models/timesheets.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/models/validation_error.py b/xero_python/payrollau/models/validation_error.py index 91db8ce6..ae89d420 100644 --- a/xero_python/payrollau/models/validation_error.py +++ b/xero_python/payrollau/models/validation_error.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in Australia region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollnz/__init__.py b/xero_python/payrollnz/__init__.py new file mode 100644 index 00000000..4dd3534b --- /dev/null +++ b/xero_python/payrollnz/__init__.py @@ -0,0 +1,146 @@ +# coding: utf-8 + +# flake8: noqa + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +# import apis into sdk package +from xero_python.payrollnz.api.payroll_nz_api import PayrollNzApi + + +# import models into sdk package +from xero_python.payrollnz.models.account import Account +from xero_python.payrollnz.models.accounts import Accounts +from xero_python.payrollnz.models.address import Address +from xero_python.payrollnz.models.bank_account import BankAccount +from xero_python.payrollnz.models.benefit import Benefit +from xero_python.payrollnz.models.deduction import Deduction +from xero_python.payrollnz.models.deduction_line import DeductionLine +from xero_python.payrollnz.models.deduction_object import DeductionObject +from xero_python.payrollnz.models.deductions import Deductions +from xero_python.payrollnz.models.earnings_line import EarningsLine +from xero_python.payrollnz.models.earnings_order import EarningsOrder +from xero_python.payrollnz.models.earnings_order_object import EarningsOrderObject +from xero_python.payrollnz.models.earnings_orders import EarningsOrders +from xero_python.payrollnz.models.earnings_rate import EarningsRate +from xero_python.payrollnz.models.earnings_rate_object import EarningsRateObject +from xero_python.payrollnz.models.earnings_rates import EarningsRates +from xero_python.payrollnz.models.earnings_template import EarningsTemplate +from xero_python.payrollnz.models.earnings_template_object import EarningsTemplateObject +from xero_python.payrollnz.models.employee import Employee +from xero_python.payrollnz.models.employee_earnings_templates import ( + EmployeeEarningsTemplates, +) +from xero_python.payrollnz.models.employee_leave import EmployeeLeave +from xero_python.payrollnz.models.employee_leave_balance import EmployeeLeaveBalance +from xero_python.payrollnz.models.employee_leave_balances import EmployeeLeaveBalances +from xero_python.payrollnz.models.employee_leave_object import EmployeeLeaveObject +from xero_python.payrollnz.models.employee_leave_setup import EmployeeLeaveSetup +from xero_python.payrollnz.models.employee_leave_setup_object import ( + EmployeeLeaveSetupObject, +) +from xero_python.payrollnz.models.employee_leave_type import EmployeeLeaveType +from xero_python.payrollnz.models.employee_leave_type_object import ( + EmployeeLeaveTypeObject, +) +from xero_python.payrollnz.models.employee_leave_types import EmployeeLeaveTypes +from xero_python.payrollnz.models.employee_leaves import EmployeeLeaves +from xero_python.payrollnz.models.employee_object import EmployeeObject +from xero_python.payrollnz.models.employee_opening_balance import EmployeeOpeningBalance +from xero_python.payrollnz.models.employee_opening_balances_object import ( + EmployeeOpeningBalancesObject, +) +from xero_python.payrollnz.models.employee_pay_template import EmployeePayTemplate +from xero_python.payrollnz.models.employee_pay_template_object import ( + EmployeePayTemplateObject, +) +from xero_python.payrollnz.models.employee_pay_templates import EmployeePayTemplates +from xero_python.payrollnz.models.employee_statutory_leave_balance import ( + EmployeeStatutoryLeaveBalance, +) +from xero_python.payrollnz.models.employee_statutory_leave_balance_object import ( + EmployeeStatutoryLeaveBalanceObject, +) +from xero_python.payrollnz.models.employee_statutory_leave_summary import ( + EmployeeStatutoryLeaveSummary, +) +from xero_python.payrollnz.models.employee_statutory_leaves_summaries import ( + EmployeeStatutoryLeavesSummaries, +) +from xero_python.payrollnz.models.employee_statutory_sick_leave import ( + EmployeeStatutorySickLeave, +) +from xero_python.payrollnz.models.employee_statutory_sick_leave_object import ( + EmployeeStatutorySickLeaveObject, +) +from xero_python.payrollnz.models.employee_statutory_sick_leaves import ( + EmployeeStatutorySickLeaves, +) +from xero_python.payrollnz.models.employee_tax import EmployeeTax +from xero_python.payrollnz.models.employee_tax_object import EmployeeTaxObject +from xero_python.payrollnz.models.employees import Employees +from xero_python.payrollnz.models.employment import Employment +from xero_python.payrollnz.models.employment_object import EmploymentObject +from xero_python.payrollnz.models.gross_earnings_history import GrossEarningsHistory +from xero_python.payrollnz.models.invalid_field import InvalidField +from xero_python.payrollnz.models.leave_accrual_line import LeaveAccrualLine +from xero_python.payrollnz.models.leave_earnings_line import LeaveEarningsLine +from xero_python.payrollnz.models.leave_period import LeavePeriod +from xero_python.payrollnz.models.leave_periods import LeavePeriods +from xero_python.payrollnz.models.leave_type import LeaveType +from xero_python.payrollnz.models.leave_type_object import LeaveTypeObject +from xero_python.payrollnz.models.leave_types import LeaveTypes +from xero_python.payrollnz.models.pagination import Pagination +from xero_python.payrollnz.models.pay_run import PayRun +from xero_python.payrollnz.models.pay_run_calendar import PayRunCalendar +from xero_python.payrollnz.models.pay_run_calendar_object import PayRunCalendarObject +from xero_python.payrollnz.models.pay_run_calendars import PayRunCalendars +from xero_python.payrollnz.models.pay_run_object import PayRunObject +from xero_python.payrollnz.models.pay_runs import PayRuns +from xero_python.payrollnz.models.pay_slip import PaySlip +from xero_python.payrollnz.models.pay_slip_object import PaySlipObject +from xero_python.payrollnz.models.pay_slips import PaySlips +from xero_python.payrollnz.models.payment_line import PaymentLine +from xero_python.payrollnz.models.payment_method import PaymentMethod +from xero_python.payrollnz.models.payment_method_object import PaymentMethodObject +from xero_python.payrollnz.models.problem import Problem +from xero_python.payrollnz.models.reimbursement import Reimbursement +from xero_python.payrollnz.models.reimbursement_line import ReimbursementLine +from xero_python.payrollnz.models.reimbursement_object import ReimbursementObject +from xero_python.payrollnz.models.reimbursements import Reimbursements +from xero_python.payrollnz.models.salary_and_wage import SalaryAndWage +from xero_python.payrollnz.models.salary_and_wage_object import SalaryAndWageObject +from xero_python.payrollnz.models.salary_and_wages import SalaryAndWages +from xero_python.payrollnz.models.settings import Settings +from xero_python.payrollnz.models.statutory_deduction import StatutoryDeduction +from xero_python.payrollnz.models.statutory_deduction_category import ( + StatutoryDeductionCategory, +) +from xero_python.payrollnz.models.statutory_deduction_line import StatutoryDeductionLine +from xero_python.payrollnz.models.statutory_deduction_object import ( + StatutoryDeductionObject, +) +from xero_python.payrollnz.models.statutory_deductions import StatutoryDeductions +from xero_python.payrollnz.models.superannuation_line import SuperannuationLine +from xero_python.payrollnz.models.superannuation_object import SuperannuationObject +from xero_python.payrollnz.models.superannuations import Superannuations +from xero_python.payrollnz.models.tax_code import TaxCode +from xero_python.payrollnz.models.tax_line import TaxLine +from xero_python.payrollnz.models.tax_settings import TaxSettings +from xero_python.payrollnz.models.timesheet import Timesheet +from xero_python.payrollnz.models.timesheet_earnings_line import TimesheetEarningsLine +from xero_python.payrollnz.models.timesheet_line import TimesheetLine +from xero_python.payrollnz.models.timesheet_line_object import TimesheetLineObject +from xero_python.payrollnz.models.timesheet_object import TimesheetObject +from xero_python.payrollnz.models.timesheets import Timesheets +from xero_python.payrollnz.models.tracking_categories import TrackingCategories +from xero_python.payrollnz.models.tracking_category import TrackingCategory diff --git a/xero_python/payrollnz/api/__init__.py b/xero_python/payrollnz/api/__init__.py new file mode 100644 index 00000000..50c5461e --- /dev/null +++ b/xero_python/payrollnz/api/__init__.py @@ -0,0 +1,4 @@ +# flake8: noqa + +# import apis into api package +from xero_python.payrollnz.api.payroll_nz_api import PayrollNzApi diff --git a/xero_python/payrollnz/api/payroll_nz_api.py b/xero_python/payrollnz/api/payroll_nz_api.py new file mode 100644 index 00000000..52fac476 --- /dev/null +++ b/xero_python/payrollnz/api/payroll_nz_api.py @@ -0,0 +1,5579 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import importlib +import re # noqa: F401 + +from xero_python import exceptions +from xero_python.api_client import ApiClient, ModelFinder + +try: + from .exception_handler import translate_status_exception +except ImportError: + translate_status_exception = exceptions.translate_status_exception + + +class empty: + """ empty object to mark optional parameter not set """ + + +class PayrollNzApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + base_url = "https://api.xero.com/payroll.xro/2.0" + models_module = importlib.import_module("xero_python.payrollnz.models") + + def __init__(self, api_client=None, base_url=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.base_url = base_url or self.base_url + + def get_resource_url(self, resource_path): + """ + Combine API base url with resource specific path + :param str resource_path: API endpoint specific path + :return: str full resource path + """ + return self.base_url + resource_path + + def get_model_finder(self): + return ModelFinder(self.models_module) + + def approve_timesheet( + self, + xero_tenant_id, + timesheet_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """approve a timesheet # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `approve_timesheet`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `approve_timesheet`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/Approve") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "approve_timesheet") + + def create_deduction( + self, + xero_tenant_id, + deduction, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """create a new deduction # noqa: E501 + OAuth2 scope: payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param Deduction deduction: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: DeductionObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_deduction`" + ) + # verify the required parameter 'deduction' is set + if deduction is None: + raise ValueError( + "Missing the required parameter `deduction` " + "when calling `create_deduction`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = deduction + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Deductions") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="DeductionObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_deduction") + + def create_earnings_rate( + self, + xero_tenant_id, + earnings_rate, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """create a new earnings rate # noqa: E501 + OAuth2 scope: payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param EarningsRate earnings_rate: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EarningsRateObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_earnings_rate`" + ) + # verify the required parameter 'earnings_rate' is set + if earnings_rate is None: + raise ValueError( + "Missing the required parameter `earnings_rate` " + "when calling `create_earnings_rate`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = earnings_rate + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/EarningsRates") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EarningsRateObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_earnings_rate") + + def create_employee( + self, + xero_tenant_id, + employee, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """creates employees # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param Employee employee: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_employee`" + ) + # verify the required parameter 'employee' is set + if employee is None: + raise ValueError( + "Missing the required parameter `employee` " + "when calling `create_employee`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = employee + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_employee") + + def create_employee_earnings_template( + self, + xero_tenant_id, + employee_id, + earnings_template, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """creates employee earnings template records # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param EarningsTemplate earnings_template: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EarningsTemplateObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_employee_earnings_template`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `create_employee_earnings_template`" + ) + # verify the required parameter 'earnings_template' is set + if earnings_template is None: + raise ValueError( + "Missing the required parameter `earnings_template` " + "when calling `create_employee_earnings_template`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = earnings_template + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/PayTemplates/earnings") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EarningsTemplateObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "create_employee_earnings_template" + ) + + def create_employee_leave( + self, + xero_tenant_id, + employee_id, + employee_leave, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """creates employee leave records # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param EmployeeLeave employee_leave: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeLeaveObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_employee_leave`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `create_employee_leave`" + ) + # verify the required parameter 'employee_leave' is set + if employee_leave is None: + raise ValueError( + "Missing the required parameter `employee_leave` " + "when calling `create_employee_leave`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = employee_leave + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/Leave") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeLeaveObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_employee_leave") + + def create_employee_leave_setup( + self, + xero_tenant_id, + employee_id, + employee_leave_setup, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Allows you to set-up leave for a specific employee. This is required before viewing, configuring and requesting leave for an employee # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param EmployeeLeaveSetup employee_leave_setup: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeLeaveSetupObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_employee_leave_setup`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `create_employee_leave_setup`" + ) + # verify the required parameter 'employee_leave_setup' is set + if employee_leave_setup is None: + raise ValueError( + "Missing the required parameter `employee_leave_setup` " + "when calling `create_employee_leave_setup`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = employee_leave_setup + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/leaveSetup") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeLeaveSetupObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_employee_leave_setup") + + def create_employee_leave_type( + self, + xero_tenant_id, + employee_id, + employee_leave_type, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """creates employee leave type records # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param EmployeeLeaveType employee_leave_type: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeLeaveTypeObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_employee_leave_type`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `create_employee_leave_type`" + ) + # verify the required parameter 'employee_leave_type' is set + if employee_leave_type is None: + raise ValueError( + "Missing the required parameter `employee_leave_type` " + "when calling `create_employee_leave_type`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = employee_leave_type + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/LeaveTypes") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeLeaveTypeObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_employee_leave_type") + + def create_employee_opening_balances( + self, + xero_tenant_id, + employee_id, + employee_opening_balance, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """creates employee opening balances # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param list[EmployeeOpeningBalance] employee_opening_balance: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeOpeningBalancesObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_employee_opening_balances`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `create_employee_opening_balances`" + ) + # verify the required parameter 'employee_opening_balance' is set + if employee_opening_balance is None: + raise ValueError( + "Missing the required parameter `employee_opening_balance` " + "when calling `create_employee_opening_balances`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = employee_opening_balance + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/openingBalances") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeOpeningBalancesObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "create_employee_opening_balances" + ) + + def create_employee_payment_method( + self, + xero_tenant_id, + employee_id, + payment_method, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """creates employee payment method # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param PaymentMethod payment_method: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: PaymentMethodObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_employee_payment_method`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `create_employee_payment_method`" + ) + # verify the required parameter 'payment_method' is set + if payment_method is None: + raise ValueError( + "Missing the required parameter `payment_method` " + "when calling `create_employee_payment_method`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = payment_method + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/PaymentMethods") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="PaymentMethodObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "create_employee_payment_method" + ) + + def create_employee_salary_and_wage( + self, + xero_tenant_id, + employee_id, + salary_and_wage, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """creates employee salary and wage record # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param SalaryAndWage salary_and_wage: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: SalaryAndWageObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_employee_salary_and_wage`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `create_employee_salary_and_wage`" + ) + # verify the required parameter 'salary_and_wage' is set + if salary_and_wage is None: + raise ValueError( + "Missing the required parameter `salary_and_wage` " + "when calling `create_employee_salary_and_wage`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = salary_and_wage + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/SalaryAndWages") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="SalaryAndWageObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "create_employee_salary_and_wage" + ) + + def create_employment( + self, + xero_tenant_id, + employee_id, + employment, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """creates employment # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param Employment employment: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmploymentObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_employment`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `create_employment`" + ) + # verify the required parameter 'employment' is set + if employment is None: + raise ValueError( + "Missing the required parameter `employment` " + "when calling `create_employment`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = employment + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/Employment") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmploymentObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_employment") + + def create_leave_type( + self, + xero_tenant_id, + leave_type, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """create a new leave type # noqa: E501 + OAuth2 scope: payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param LeaveType leave_type: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: LeaveTypeObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_leave_type`" + ) + # verify the required parameter 'leave_type' is set + if leave_type is None: + raise ValueError( + "Missing the required parameter `leave_type` " + "when calling `create_leave_type`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = leave_type + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/LeaveTypes") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="LeaveTypeObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_leave_type") + + def create_multiple_employee_earnings_template( + self, + xero_tenant_id, + employee_id, + earnings_template, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """creates multiple employee earnings template records # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param list[EarningsTemplate] earnings_template: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeEarningsTemplates + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_multiple_employee_earnings_template`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `create_multiple_employee_earnings_template`" + ) + # verify the required parameter 'earnings_template' is set + if earnings_template is None: + raise ValueError( + "Missing the required parameter `earnings_template` " + "when calling `create_multiple_employee_earnings_template`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = earnings_template + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/paytemplateearnings") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeEarningsTemplates", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "create_multiple_employee_earnings_template" + ) + + def create_pay_run( + self, + xero_tenant_id, + pay_run, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """create a pay run # noqa: E501 + OAuth2 scope: payroll.payruns + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param PayRun pay_run: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: PayRunObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_pay_run`" + ) + # verify the required parameter 'pay_run' is set + if pay_run is None: + raise ValueError( + "Missing the required parameter `pay_run` " + "when calling `create_pay_run`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = pay_run + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/PayRuns") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="PayRunObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_pay_run") + + def create_pay_run_calendar( + self, + xero_tenant_id, + pay_run_calendar, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """create a new payrun calendar # noqa: E501 + OAuth2 scope: payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param PayRunCalendar pay_run_calendar: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: PayRunCalendarObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_pay_run_calendar`" + ) + # verify the required parameter 'pay_run_calendar' is set + if pay_run_calendar is None: + raise ValueError( + "Missing the required parameter `pay_run_calendar` " + "when calling `create_pay_run_calendar`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = pay_run_calendar + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/PayRunCalendars") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="PayRunCalendarObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_pay_run_calendar") + + def create_reimbursement( + self, + xero_tenant_id, + reimbursement, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """create a new reimbursement # noqa: E501 + OAuth2 scope: payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param Reimbursement reimbursement: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: ReimbursementObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_reimbursement`" + ) + # verify the required parameter 'reimbursement' is set + if reimbursement is None: + raise ValueError( + "Missing the required parameter `reimbursement` " + "when calling `create_reimbursement`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = reimbursement + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Reimbursements") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="ReimbursementObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_reimbursement") + + def create_superannuation( + self, + xero_tenant_id, + benefit, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """create a new superannuation # noqa: E501 + OAuth2 scope: payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param Benefit benefit: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: SuperannuationObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_superannuation`" + ) + # verify the required parameter 'benefit' is set + if benefit is None: + raise ValueError( + "Missing the required parameter `benefit` " + "when calling `create_superannuation`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = benefit + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/superannuations") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="SuperannuationObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_superannuation") + + def create_timesheet( + self, + xero_tenant_id, + timesheet, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """create a new timesheet # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param Timesheet timesheet: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_timesheet`" + ) + # verify the required parameter 'timesheet' is set + if timesheet is None: + raise ValueError( + "Missing the required parameter `timesheet` " + "when calling `create_timesheet`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = timesheet + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_timesheet") + + def create_timesheet_line( + self, + xero_tenant_id, + timesheet_id, + timesheet_line, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """create a new timesheet line # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param TimesheetLine timesheet_line: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetLineObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_timesheet_line`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `create_timesheet_line`" + ) + # verify the required parameter 'timesheet_line' is set + if timesheet_line is None: + raise ValueError( + "Missing the required parameter `timesheet_line` " + "when calling `create_timesheet_line`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = timesheet_line + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/Lines") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetLineObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_timesheet_line") + + def delete_employee_earnings_template( + self, + xero_tenant_id, + employee_id, + pay_template_earning_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """deletes an employee earnings template record # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param str pay_template_earning_id: Id for single pay template earnings object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EarningsTemplateObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_employee_earnings_template`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `delete_employee_earnings_template`" + ) + # verify the required parameter 'pay_template_earning_id' is set + if pay_template_earning_id is None: + raise ValueError( + "Missing the required parameter `pay_template_earning_id` " + "when calling `delete_employee_earnings_template`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + "PayTemplateEarningID": pay_template_earning_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url( + "/Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID}" + ) + + try: + return self.api_client.call_api( + url, + "DELETE", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EarningsTemplateObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "delete_employee_earnings_template" + ) + + def delete_employee_leave( + self, + xero_tenant_id, + employee_id, + leave_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """deletes an employee leave record # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param str leave_id: Leave id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeLeaveObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_employee_leave`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `delete_employee_leave`" + ) + # verify the required parameter 'leave_id' is set + if leave_id is None: + raise ValueError( + "Missing the required parameter `leave_id` " + "when calling `delete_employee_leave`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + "LeaveID": leave_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/Leave/{LeaveID}") + + try: + return self.api_client.call_api( + url, + "DELETE", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeLeaveObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "delete_employee_leave") + + def delete_employee_salary_and_wage( + self, + xero_tenant_id, + employee_id, + salary_and_wages_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """deletes an employee salary and wages record # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param str salary_and_wages_id: Id for single salary and wages object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: SalaryAndWageObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_employee_salary_and_wage`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `delete_employee_salary_and_wage`" + ) + # verify the required parameter 'salary_and_wages_id' is set + if salary_and_wages_id is None: + raise ValueError( + "Missing the required parameter `salary_and_wages_id` " + "when calling `delete_employee_salary_and_wage`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + "SalaryAndWagesID": salary_and_wages_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url( + "/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}" + ) + + try: + return self.api_client.call_api( + url, + "DELETE", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="SalaryAndWageObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "delete_employee_salary_and_wage" + ) + + def delete_timesheet( + self, + xero_tenant_id, + timesheet_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """delete a timesheet # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetLine + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_timesheet`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `delete_timesheet`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}") + + try: + return self.api_client.call_api( + url, + "DELETE", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetLine", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "delete_timesheet") + + def delete_timesheet_line( + self, + xero_tenant_id, + timesheet_id, + timesheet_line_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """delete a timesheet line # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param str timesheet_line_id: Identifier for the timesheet line (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetLine + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_timesheet_line`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `delete_timesheet_line`" + ) + # verify the required parameter 'timesheet_line_id' is set + if timesheet_line_id is None: + raise ValueError( + "Missing the required parameter `timesheet_line_id` " + "when calling `delete_timesheet_line`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + "TimesheetLineID": timesheet_line_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}") + + try: + return self.api_client.call_api( + url, + "DELETE", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetLine", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "delete_timesheet_line") + + def get_deduction( + self, + xero_tenant_id, + deduction_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """retrieve a single deduction by id # noqa: E501 + OAuth2 scope: payroll.settings.read, payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str deduction_id: Identifier for the deduction (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: DeductionObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_deduction`" + ) + # verify the required parameter 'deduction_id' is set + if deduction_id is None: + raise ValueError( + "Missing the required parameter `deduction_id` " + "when calling `get_deduction`" + ) + + collection_formats = {} + path_params = { + "deductionId": deduction_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Deductions/{deductionId}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="DeductionObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_deduction") + + def get_deductions( + self, + xero_tenant_id, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches deductions # noqa: E501 + OAuth2 scope: payroll.settings.read, payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: Deductions + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_deductions`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Deductions") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="Deductions", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_deductions") + + def get_earnings_rate( + self, + xero_tenant_id, + earnings_rate_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """retrieve a single earnings rates by id # noqa: E501 + OAuth2 scope: payroll.settings.read, payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str earnings_rate_id: Identifier for the earnings rate (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EarningsRateObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_earnings_rate`" + ) + # verify the required parameter 'earnings_rate_id' is set + if earnings_rate_id is None: + raise ValueError( + "Missing the required parameter `earnings_rate_id` " + "when calling `get_earnings_rate`" + ) + + collection_formats = {} + path_params = { + "EarningsRateID": earnings_rate_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/EarningsRates/{EarningsRateID}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EarningsRateObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_earnings_rate") + + def get_earnings_rates( + self, + xero_tenant_id, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches earnings rates # noqa: E501 + OAuth2 scope: payroll.settings.read, payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EarningsRates + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_earnings_rates`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/EarningsRates") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EarningsRates", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_earnings_rates") + + def get_employee( + self, + xero_tenant_id, + employee_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches employees # noqa: E501 + OAuth2 scope: payroll.employees.read, payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_employee") + + def get_employee_leave_balances( + self, + xero_tenant_id, + employee_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """search employee leave balances # noqa: E501 + OAuth2 scope: payroll.employees.read, payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeLeaveBalances + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee_leave_balances`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee_leave_balances`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/LeaveBalances") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeLeaveBalances", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_employee_leave_balances") + + def get_employee_leave_periods( + self, + xero_tenant_id, + employee_id, + start_date=empty, + end_date=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches employee leave periods # noqa: E501 + OAuth2 scope: payroll.employees.read, payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param date start_date: Filter by start date + :param date end_date: Filter by end date + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: LeavePeriods + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee_leave_periods`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee_leave_periods`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + if start_date is not empty: + query_params.append(("startDate", start_date)) + + if end_date is not empty: + query_params.append(("endDate", end_date)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/LeavePeriods") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="LeavePeriods", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_employee_leave_periods") + + def get_employee_leave_types( + self, + xero_tenant_id, + employee_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches employee leave types # noqa: E501 + OAuth2 scope: payroll.employees.read, payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeLeaveTypes + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee_leave_types`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee_leave_types`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/LeaveTypes") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeLeaveTypes", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_employee_leave_types") + + def get_employee_leaves( + self, + xero_tenant_id, + employee_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """search employee leave records # noqa: E501 + OAuth2 scope: payroll.employees.read, payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeLeaves + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee_leaves`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee_leaves`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/Leave") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeLeaves", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_employee_leaves") + + def get_employee_opening_balances( + self, + xero_tenant_id, + employee_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """retrieve employee openingbalances # noqa: E501 + OAuth2 scope: payroll.employees.read, payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeOpeningBalancesObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee_opening_balances`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee_opening_balances`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/openingBalances") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeOpeningBalancesObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "get_employee_opening_balances" + ) + + def get_employee_pay_templates( + self, + xero_tenant_id, + employee_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches employee pay templates # noqa: E501 + OAuth2 scope: payroll.employees.read, payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeePayTemplates + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee_pay_templates`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee_pay_templates`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/PayTemplates") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeePayTemplates", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_employee_pay_templates") + + def get_employee_payment_method( + self, + xero_tenant_id, + employee_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """retrieves an employee's payment method # noqa: E501 + OAuth2 scope: payroll.employees.read, payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: PaymentMethodObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee_payment_method`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee_payment_method`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/PaymentMethods") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="PaymentMethodObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_employee_payment_method") + + def get_employee_salary_and_wage( + self, + xero_tenant_id, + employee_id, + salary_and_wages_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """get employee salary and wages record by id # noqa: E501 + OAuth2 scope: payroll.employees, payroll.employees.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param str salary_and_wages_id: Id for single pay template earnings object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: SalaryAndWages + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee_salary_and_wage`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee_salary_and_wage`" + ) + # verify the required parameter 'salary_and_wages_id' is set + if salary_and_wages_id is None: + raise ValueError( + "Missing the required parameter `salary_and_wages_id` " + "when calling `get_employee_salary_and_wage`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + "SalaryAndWagesID": salary_and_wages_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url( + "/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}" + ) + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="SalaryAndWages", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "get_employee_salary_and_wage" + ) + + def get_employee_salary_and_wages( + self, + xero_tenant_id, + employee_id, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """retrieves an employee's salary and wages # noqa: E501 + OAuth2 scope: payroll.employees.read, payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: SalaryAndWages + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee_salary_and_wages`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee_salary_and_wages`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/SalaryAndWages") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="SalaryAndWages", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "get_employee_salary_and_wages" + ) + + def get_employee_tax( + self, + xero_tenant_id, + employee_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches tax records for an employee # noqa: E501 + OAuth2 scope: payroll.employees.read, payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeTaxObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee_tax`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee_tax`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/Tax") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeTaxObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_employee_tax") + + def get_employees( + self, + xero_tenant_id, + first_name=empty, + last_name=empty, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches employees # noqa: E501 + OAuth2 scope: payroll.employees.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str first_name: Filter by first name + :param str last_name: Filter by last name + :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: Employees + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employees`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if first_name is not empty: + query_params.append(("firstName", first_name)) + + if last_name is not empty: + query_params.append(("lastName", last_name)) + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="Employees", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_employees") + + def get_leave_type( + self, + xero_tenant_id, + leave_type_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """retrieve a single leave type by id # noqa: E501 + OAuth2 scope: payroll.settings.read, payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str leave_type_id: Identifier for the leave type (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: LeaveTypeObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_leave_type`" + ) + # verify the required parameter 'leave_type_id' is set + if leave_type_id is None: + raise ValueError( + "Missing the required parameter `leave_type_id` " + "when calling `get_leave_type`" + ) + + collection_formats = {} + path_params = { + "LeaveTypeID": leave_type_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/LeaveTypes/{LeaveTypeID}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="LeaveTypeObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_leave_type") + + def get_leave_types( + self, + xero_tenant_id, + page=empty, + active_only=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches leave types # noqa: E501 + OAuth2 scope: payroll.settings.read, payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + :param bool active_only: Filters leave types by active status. By default the API returns all leave types. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: LeaveTypes + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_leave_types`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if page is not empty: + query_params.append(("page", page)) + + if active_only is not empty: + query_params.append(("ActiveOnly", active_only)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/LeaveTypes") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="LeaveTypes", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_leave_types") + + def get_pay_run( + self, + xero_tenant_id, + pay_run_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """retrieve a single pay run by id # noqa: E501 + OAuth2 scope: payroll.payruns.read, payroll.payruns + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str pay_run_id: Identifier for the pay run (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: PayRunObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_pay_run`" + ) + # verify the required parameter 'pay_run_id' is set + if pay_run_id is None: + raise ValueError( + "Missing the required parameter `pay_run_id` " + "when calling `get_pay_run`" + ) + + collection_formats = {} + path_params = { + "PayRunID": pay_run_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/PayRuns/{PayRunID}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="PayRunObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_pay_run") + + def get_pay_run_calendar( + self, + xero_tenant_id, + payroll_calendar_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """retrieve a single payrun calendar by id # noqa: E501 + OAuth2 scope: payroll.settings.read, payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str payroll_calendar_id: Identifier for the payrun calendars (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: PayRunCalendarObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_pay_run_calendar`" + ) + # verify the required parameter 'payroll_calendar_id' is set + if payroll_calendar_id is None: + raise ValueError( + "Missing the required parameter `payroll_calendar_id` " + "when calling `get_pay_run_calendar`" + ) + + collection_formats = {} + path_params = { + "PayrollCalendarID": payroll_calendar_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/PayRunCalendars/{PayrollCalendarID}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="PayRunCalendarObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_pay_run_calendar") + + def get_pay_run_calendars( + self, + xero_tenant_id, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches payrun calendars # noqa: E501 + OAuth2 scope: payroll.settings.read, payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: PayRunCalendars + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_pay_run_calendars`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/PayRunCalendars") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="PayRunCalendars", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_pay_run_calendars") + + def get_pay_runs( + self, + xero_tenant_id, + page=empty, + status=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches pay runs # noqa: E501 + OAuth2 scope: payroll.payruns.read, payroll.payruns + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + :param str status: By default get payruns will return all the payruns for an organization. You can add GET https://api.xero.com/payroll.xro/2.0/payRuns?statu={PayRunStatus} to filter the payruns by status. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: PayRuns + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_pay_runs`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if page is not empty: + query_params.append(("page", page)) + + if status is not empty: + query_params.append(("status", status)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/PayRuns") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="PayRuns", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_pay_runs") + + def get_pay_slip( + self, + xero_tenant_id, + pay_slip_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """retrieve a single payslip by id # noqa: E501 + OAuth2 scope: payroll.payslip.read, payroll.payslip + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str pay_slip_id: Identifier for the payslip (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: PaySlipObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_pay_slip`" + ) + # verify the required parameter 'pay_slip_id' is set + if pay_slip_id is None: + raise ValueError( + "Missing the required parameter `pay_slip_id` " + "when calling `get_pay_slip`" + ) + + collection_formats = {} + path_params = { + "PaySlipID": pay_slip_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/PaySlips/{PaySlipID}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="PaySlipObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_pay_slip") + + def get_pay_slips( + self, + xero_tenant_id, + pay_run_id, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches payslips # noqa: E501 + OAuth2 scope: payroll.payslip.read, payroll.payslip + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str pay_run_id: PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun. (required) + :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: PaySlips + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_pay_slips`" + ) + # verify the required parameter 'pay_run_id' is set + if pay_run_id is None: + raise ValueError( + "Missing the required parameter `pay_run_id` " + "when calling `get_pay_slips`" + ) + + collection_formats = {} + path_params = {} + + query_params = [ + ("PayRunID", pay_run_id), + ] + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/PaySlips") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="PaySlips", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_pay_slips") + + def get_reimbursement( + self, + xero_tenant_id, + reimbursement_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """retrieve a single reimbursement by id # noqa: E501 + OAuth2 scope: payroll.settings.read, payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str reimbursement_id: Identifier for the reimbursement (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: ReimbursementObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_reimbursement`" + ) + # verify the required parameter 'reimbursement_id' is set + if reimbursement_id is None: + raise ValueError( + "Missing the required parameter `reimbursement_id` " + "when calling `get_reimbursement`" + ) + + collection_formats = {} + path_params = { + "ReimbursementID": reimbursement_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Reimbursements/{ReimbursementID}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="ReimbursementObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_reimbursement") + + def get_reimbursements( + self, + xero_tenant_id, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches reimbursements # noqa: E501 + OAuth2 scope: payroll.settings.read, payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: Reimbursements + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_reimbursements`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Reimbursements") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="Reimbursements", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_reimbursements") + + def get_settings( + self, + xero_tenant_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches settings # noqa: E501 + OAuth2 scope: payroll.settings.read, settings.payslip + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: Settings + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_settings`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Settings") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="Settings", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_settings") + + def get_statutory_deduction( + self, + xero_tenant_id, + id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """retrieve a single statutory deduction by id # noqa: E501 + OAuth2 scope: payroll.settings.read, payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str id: Identifier for the statutory deduction (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: StatutoryDeductionObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_statutory_deduction`" + ) + # verify the required parameter 'id' is set + if id is None: + raise ValueError( + "Missing the required parameter `id` " + "when calling `get_statutory_deduction`" + ) + + collection_formats = {} + path_params = { + "Id": id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/StatutoryDeductions/{Id}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="StatutoryDeductionObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_statutory_deduction") + + def get_statutory_deductions( + self, + xero_tenant_id, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches statutory deductions # noqa: E501 + OAuth2 scope: payroll.settings.read, payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: StatutoryDeductions + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_statutory_deductions`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/StatutoryDeductions") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="StatutoryDeductions", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_statutory_deductions") + + def get_superannuation( + self, + xero_tenant_id, + superannuation_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches for a unique superannuation # noqa: E501 + OAuth2 scope: payroll.settings.read, payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str superannuation_id: Identifier for the superannuation (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: SuperannuationObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_superannuation`" + ) + # verify the required parameter 'superannuation_id' is set + if superannuation_id is None: + raise ValueError( + "Missing the required parameter `superannuation_id` " + "when calling `get_superannuation`" + ) + + collection_formats = {} + path_params = { + "SuperannuationID": superannuation_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/superannuations/{SuperannuationID}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="SuperannuationObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_superannuation") + + def get_superannuations( + self, + xero_tenant_id, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches statutory deductions # noqa: E501 + OAuth2 scope: payroll.settings.read, payroll.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: Superannuations + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_superannuations`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/superannuations") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="Superannuations", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_superannuations") + + def get_timesheet( + self, + xero_tenant_id, + timesheet_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """retrieve a single timesheet by id # noqa: E501 + OAuth2 scope: payroll.timesheets.read, timesheets.settings + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_timesheet`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `get_timesheet`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_timesheet") + + def get_timesheets( + self, + xero_tenant_id, + page=empty, + employee_id=empty, + payroll_calendar_id=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches timesheets # noqa: E501 + OAuth2 scope: payroll.timesheets.read, payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + :param str employee_id: By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeId} to get only the timesheets of a particular employee. + :param str payroll_calendar_id: By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: Timesheets + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_timesheets`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if page is not empty: + query_params.append(("page", page)) + + if employee_id is not empty: + query_params.append(("employeeId", employee_id)) + + if payroll_calendar_id is not empty: + query_params.append(("payrollCalendarId", payroll_calendar_id)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="Timesheets", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_timesheets") + + def get_tracking_categories( + self, + xero_tenant_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches tracking categories # noqa: E501 + OAuth2 scope: payroll.settings.read, settings.payslip + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TrackingCategories + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_tracking_categories`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/settings/trackingCategories") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TrackingCategories", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_tracking_categories") + + def revert_timesheet( + self, + xero_tenant_id, + timesheet_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """revert a timesheet to draft # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `revert_timesheet`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `revert_timesheet`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/RevertToDraft") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "revert_timesheet") + + def update_employee( + self, + xero_tenant_id, + employee_id, + employee, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """updates employee # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param Employee employee: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `update_employee`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `update_employee`" + ) + # verify the required parameter 'employee' is set + if employee is None: + raise ValueError( + "Missing the required parameter `employee` " + "when calling `update_employee`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = employee + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}") + + try: + return self.api_client.call_api( + url, + "PUT", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "update_employee") + + def update_employee_earnings_template( + self, + xero_tenant_id, + employee_id, + pay_template_earning_id, + earnings_template, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """updates employee earnings template records # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param str pay_template_earning_id: Id for single pay template earnings object (required) + :param EarningsTemplate earnings_template: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EarningsTemplateObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `update_employee_earnings_template`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `update_employee_earnings_template`" + ) + # verify the required parameter 'pay_template_earning_id' is set + if pay_template_earning_id is None: + raise ValueError( + "Missing the required parameter `pay_template_earning_id` " + "when calling `update_employee_earnings_template`" + ) + # verify the required parameter 'earnings_template' is set + if earnings_template is None: + raise ValueError( + "Missing the required parameter `earnings_template` " + "when calling `update_employee_earnings_template`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + "PayTemplateEarningID": pay_template_earning_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = earnings_template + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url( + "/Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID}" + ) + + try: + return self.api_client.call_api( + url, + "PUT", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EarningsTemplateObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "update_employee_earnings_template" + ) + + def update_employee_leave( + self, + xero_tenant_id, + employee_id, + leave_id, + employee_leave, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """updates employee leave records # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param str leave_id: Leave id for single object (required) + :param EmployeeLeave employee_leave: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeLeaveObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `update_employee_leave`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `update_employee_leave`" + ) + # verify the required parameter 'leave_id' is set + if leave_id is None: + raise ValueError( + "Missing the required parameter `leave_id` " + "when calling `update_employee_leave`" + ) + # verify the required parameter 'employee_leave' is set + if employee_leave is None: + raise ValueError( + "Missing the required parameter `employee_leave` " + "when calling `update_employee_leave`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + "LeaveID": leave_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = employee_leave + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/Leave/{LeaveID}") + + try: + return self.api_client.call_api( + url, + "PUT", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeLeaveObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "update_employee_leave") + + def update_employee_salary_and_wage( + self, + xero_tenant_id, + employee_id, + salary_and_wages_id, + salary_and_wage, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """updates employee salary and wages record # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param str salary_and_wages_id: Id for single pay template earnings object (required) + :param SalaryAndWage salary_and_wage: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: SalaryAndWageObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `update_employee_salary_and_wage`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `update_employee_salary_and_wage`" + ) + # verify the required parameter 'salary_and_wages_id' is set + if salary_and_wages_id is None: + raise ValueError( + "Missing the required parameter `salary_and_wages_id` " + "when calling `update_employee_salary_and_wage`" + ) + # verify the required parameter 'salary_and_wage' is set + if salary_and_wage is None: + raise ValueError( + "Missing the required parameter `salary_and_wage` " + "when calling `update_employee_salary_and_wage`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + "SalaryAndWagesID": salary_and_wages_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = salary_and_wage + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url( + "/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}" + ) + + try: + return self.api_client.call_api( + url, + "PUT", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="SalaryAndWageObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "update_employee_salary_and_wage" + ) + + def update_employee_tax( + self, + xero_tenant_id, + employee_id, + employee_tax, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """updates the tax records for an employee # noqa: E501 + OAuth2 scope: payroll.employees.read, payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param EmployeeTax employee_tax: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeTaxObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `update_employee_tax`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `update_employee_tax`" + ) + # verify the required parameter 'employee_tax' is set + if employee_tax is None: + raise ValueError( + "Missing the required parameter `employee_tax` " + "when calling `update_employee_tax`" + ) + + collection_formats = {} + path_params = { + "EmployeeId": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = employee_tax + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeId}/Tax") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeTaxObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "update_employee_tax") + + def update_pay_run( + self, + xero_tenant_id, + pay_run_id, + pay_run, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """update a pay run # noqa: E501 + OAuth2 scope: payroll.payruns + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str pay_run_id: Identifier for the pay run (required) + :param PayRun pay_run: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: PayRunObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `update_pay_run`" + ) + # verify the required parameter 'pay_run_id' is set + if pay_run_id is None: + raise ValueError( + "Missing the required parameter `pay_run_id` " + "when calling `update_pay_run`" + ) + # verify the required parameter 'pay_run' is set + if pay_run is None: + raise ValueError( + "Missing the required parameter `pay_run` " + "when calling `update_pay_run`" + ) + + collection_formats = {} + path_params = { + "PayRunID": pay_run_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = pay_run + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/PayRuns/{PayRunID}") + + try: + return self.api_client.call_api( + url, + "PUT", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="PayRunObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "update_pay_run") + + def update_pay_slip_line_items( + self, + xero_tenant_id, + pay_slip_id, + pay_slip, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """creates employee pay slip # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str pay_slip_id: Identifier for the payslip (required) + :param PaySlip pay_slip: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: PaySlipObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `update_pay_slip_line_items`" + ) + # verify the required parameter 'pay_slip_id' is set + if pay_slip_id is None: + raise ValueError( + "Missing the required parameter `pay_slip_id` " + "when calling `update_pay_slip_line_items`" + ) + # verify the required parameter 'pay_slip' is set + if pay_slip is None: + raise ValueError( + "Missing the required parameter `pay_slip` " + "when calling `update_pay_slip_line_items`" + ) + + collection_formats = {} + path_params = { + "PaySlipID": pay_slip_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = pay_slip + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/PaySlips/{PaySlipID}") + + try: + return self.api_client.call_api( + url, + "PUT", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="PaySlipObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "update_pay_slip_line_items") + + def update_timesheet_line( + self, + xero_tenant_id, + timesheet_id, + timesheet_line_id, + timesheet_line, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """update a timesheet line # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param str timesheet_line_id: Identifier for the timesheet line (required) + :param TimesheetLine timesheet_line: (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetLineObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `update_timesheet_line`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `update_timesheet_line`" + ) + # verify the required parameter 'timesheet_line_id' is set + if timesheet_line_id is None: + raise ValueError( + "Missing the required parameter `timesheet_line_id` " + "when calling `update_timesheet_line`" + ) + # verify the required parameter 'timesheet_line' is set + if timesheet_line is None: + raise ValueError( + "Missing the required parameter `timesheet_line` " + "when calling `update_timesheet_line`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + "TimesheetLineID": timesheet_line_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = timesheet_line + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}") + + try: + return self.api_client.call_api( + url, + "PUT", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetLineObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "update_timesheet_line") diff --git a/xero_python/payrollnz/docs/Account.md b/xero_python/payrollnz/docs/Account.md new file mode 100644 index 00000000..44f3e964 --- /dev/null +++ b/xero_python/payrollnz/docs/Account.md @@ -0,0 +1,13 @@ +# Account + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | The Xero identifier for Settings. | [optional] +**type** | **str** | The assigned AccountType | [optional] +**code** | **str** | A unique 3 digit number for each Account | [optional] +**name** | **str** | Name of the Account. | [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) + + diff --git a/xero_python/payrollnz/docs/Accounts.md b/xero_python/payrollnz/docs/Accounts.md new file mode 100644 index 00000000..7dd1b22e --- /dev/null +++ b/xero_python/payrollnz/docs/Accounts.md @@ -0,0 +1,10 @@ +# Accounts + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accounts** | [**list[Account]**](Account.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/Address.md b/xero_python/payrollnz/docs/Address.md new file mode 100644 index 00000000..15a9872e --- /dev/null +++ b/xero_python/payrollnz/docs/Address.md @@ -0,0 +1,15 @@ +# Address + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address_line1** | **str** | Address line 1 for employee home address | +**address_line2** | **str** | Address line 2 for employee home address | [optional] +**city** | **str** | Suburb for employee home address | +**suburb** | **str** | Suburb for employee home address | [optional] +**post_code** | **str** | PostCode for employee home address | +**country_name** | **str** | Country of HomeAddress | [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) + + diff --git a/xero_python/payrollnz/docs/BankAccount.md b/xero_python/payrollnz/docs/BankAccount.md new file mode 100644 index 00000000..48a122d4 --- /dev/null +++ b/xero_python/payrollnz/docs/BankAccount.md @@ -0,0 +1,17 @@ +# BankAccount + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_name** | **str** | Bank account name (max length = 32) | +**account_number** | **str** | Bank account number (digits only; max length = 8) | +**sort_code** | **str** | Bank account sort code (6 digits) | +**particulars** | **str** | Particulars that appear on the statement. | [optional] +**code** | **str** | Code of a transaction that appear on the statement. | [optional] +**dollar_amount** | **float** | Dollar amount of a transaction. | [optional] +**reference** | **str** | Statement Text/reference for a transaction that appear on the statement. | [optional] +**calculation_type** | **str** | Calculation type for the transaction can be 'Fixed Amount' or 'Balance' | [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) + + diff --git a/xero_python/payrollnz/docs/Benefit.md b/xero_python/payrollnz/docs/Benefit.md new file mode 100644 index 00000000..76c3f409 --- /dev/null +++ b/xero_python/payrollnz/docs/Benefit.md @@ -0,0 +1,19 @@ +# Benefit + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The Xero identifier for superannuation | [optional] +**name** | **str** | Name of the superannuations | +**category** | **str** | Superannuations Category type | +**liability_account_id** | **str** | Xero identifier for Liability Account | +**expense_account_id** | **str** | Xero identifier for Expense Account | +**calculation_type_nz** | **str** | Calculation Type of the superannuation either FixedAmount or PercentageOfTaxableEarnings | [optional] +**standard_amount** | **float** | Standard amount of the superannuation | [optional] +**percentage** | **float** | Percentage of Taxable Earnings of the superannuation | [optional] +**company_max** | **float** | Company Maximum amount of the superannuation | [optional] +**current_record** | **bool** | Identifier of a record is active or not. | [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) + + diff --git a/xero_python/payrollnz/docs/Deduction.md b/xero_python/payrollnz/docs/Deduction.md new file mode 100644 index 00000000..b9b066e6 --- /dev/null +++ b/xero_python/payrollnz/docs/Deduction.md @@ -0,0 +1,15 @@ +# Deduction + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**deduction_id** | **str** | The Xero identifier for Deduction | [optional] +**deduction_name** | **str** | Name of the deduction | +**deduction_category** | **str** | Deduction Category type | +**liability_account_id** | **str** | Xero identifier for Liability Account | +**current_record** | **bool** | Identifier of a record is active or not. | [optional] +**standard_amount** | **float** | Standard amount of the deduction. | [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) + + diff --git a/xero_python/payrollnz/docs/DeductionLine.md b/xero_python/payrollnz/docs/DeductionLine.md new file mode 100644 index 00000000..316b57b7 --- /dev/null +++ b/xero_python/payrollnz/docs/DeductionLine.md @@ -0,0 +1,14 @@ +# DeductionLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**deduction_type_id** | **str** | Xero identifier for payroll deduction | [optional] +**display_name** | **str** | name of earnings rate for display in UI | [optional] +**amount** | **float** | The amount of the deduction line | [optional] +**subject_to_tax** | **bool** | Identifies if the deduction is subject to tax | [optional] +**percentage** | **float** | Deduction rate percentage | [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) + + diff --git a/xero_python/payrollnz/docs/DeductionObject.md b/xero_python/payrollnz/docs/DeductionObject.md new file mode 100644 index 00000000..5b48e9da --- /dev/null +++ b/xero_python/payrollnz/docs/DeductionObject.md @@ -0,0 +1,12 @@ +# DeductionObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**deduction** | [**Deduction**](Deduction.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/Deductions.md b/xero_python/payrollnz/docs/Deductions.md new file mode 100644 index 00000000..2cde9381 --- /dev/null +++ b/xero_python/payrollnz/docs/Deductions.md @@ -0,0 +1,12 @@ +# Deductions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**deductions** | [**list[Deduction]**](Deduction.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EarningsLine.md b/xero_python/payrollnz/docs/EarningsLine.md new file mode 100644 index 00000000..4d25ede3 --- /dev/null +++ b/xero_python/payrollnz/docs/EarningsLine.md @@ -0,0 +1,19 @@ +# EarningsLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**earnings_line_id** | **str** | Xero identifier for payroll earnings line | [optional] +**earnings_rate_id** | **str** | Xero identifier for payroll earnings rate | [optional] +**display_name** | **str** | name of earnings rate for display in UI | [optional] +**rate_per_unit** | **float** | Rate per unit for earnings line | [optional] +**number_of_units** | **float** | Earnings number of units | [optional] +**fixed_amount** | **float** | Earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed | [optional] +**amount** | **float** | The amount of the earnings line. | [optional] +**is_linked_to_timesheet** | **bool** | Identifies if the earnings is taken from the timesheet. False for earnings line | [optional] +**is_average_daily_pay_rate** | **bool** | Identifies if the earnings is using an average daily pay rate | [optional] +**is_system_generated** | **bool** | Flag to indentify whether the earnings line is system generated or not. | [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) + + diff --git a/xero_python/payrollnz/docs/EarningsOrder.md b/xero_python/payrollnz/docs/EarningsOrder.md new file mode 100644 index 00000000..93b06c70 --- /dev/null +++ b/xero_python/payrollnz/docs/EarningsOrder.md @@ -0,0 +1,14 @@ +# EarningsOrder + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Xero unique identifier for an earning rate | [optional] +**name** | **str** | Name of the earning order | +**statutory_deduction_category** | [**StatutoryDeductionCategory**](StatutoryDeductionCategory.md) | | [optional] +**liability_account_id** | **str** | Xero identifier for Liability Account | [optional] +**current_record** | **bool** | Identifier of a record is active or not. | [optional] [default to True] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/docs/EarningsOrderObject.md b/xero_python/payrollnz/docs/EarningsOrderObject.md new file mode 100644 index 00000000..c12d5998 --- /dev/null +++ b/xero_python/payrollnz/docs/EarningsOrderObject.md @@ -0,0 +1,12 @@ +# EarningsOrderObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**statutory_deduction** | [**EarningsOrder**](EarningsOrder.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EarningsOrders.md b/xero_python/payrollnz/docs/EarningsOrders.md new file mode 100644 index 00000000..fc872b19 --- /dev/null +++ b/xero_python/payrollnz/docs/EarningsOrders.md @@ -0,0 +1,12 @@ +# EarningsOrders + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**statutory_deductions** | [**list[EarningsOrder]**](EarningsOrder.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EarningsRate.md b/xero_python/payrollnz/docs/EarningsRate.md new file mode 100644 index 00000000..18367d44 --- /dev/null +++ b/xero_python/payrollnz/docs/EarningsRate.md @@ -0,0 +1,19 @@ +# EarningsRate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**earnings_rate_id** | **str** | Xero unique identifier for an earning rate | [optional] +**name** | **str** | Name of the earning rate | +**earnings_type** | **str** | Indicates how an employee will be paid when taking this type of earning | +**rate_type** | **str** | Indicates the type of the earning rate | +**type_of_units** | **str** | The type of units used to record earnings | +**current_record** | **bool** | Indicates whether an earning type is active | [optional] +**expense_account_id** | **str** | The account that will be used for the earnings rate | +**rate_per_unit** | **float** | Default rate per unit (optional). Only applicable if RateType is RatePerUnit | [optional] +**multiple_of_ordinary_earnings_rate** | **float** | This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate. For example, for time and a half enter 1.5. Only applicable if RateType is MultipleOfOrdinaryEarningsRate | [optional] +**fixed_amount** | **float** | Optional Fixed Rate Amount. Applicable for FixedAmount Rate | [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) + + diff --git a/xero_python/payrollnz/docs/EarningsRateObject.md b/xero_python/payrollnz/docs/EarningsRateObject.md new file mode 100644 index 00000000..62aae5e9 --- /dev/null +++ b/xero_python/payrollnz/docs/EarningsRateObject.md @@ -0,0 +1,12 @@ +# EarningsRateObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**earnings_rate** | [**EarningsRate**](EarningsRate.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EarningsRates.md b/xero_python/payrollnz/docs/EarningsRates.md new file mode 100644 index 00000000..2bbd8155 --- /dev/null +++ b/xero_python/payrollnz/docs/EarningsRates.md @@ -0,0 +1,12 @@ +# EarningsRates + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**earnings_rates** | [**list[EarningsRate]**](EarningsRate.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EarningsTemplate.md b/xero_python/payrollnz/docs/EarningsTemplate.md new file mode 100644 index 00000000..5e4d483e --- /dev/null +++ b/xero_python/payrollnz/docs/EarningsTemplate.md @@ -0,0 +1,15 @@ +# EarningsTemplate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pay_template_earning_id** | **str** | The Xero identifier for the earnings template | [optional] +**rate_per_unit** | **float** | The rate per unit | [optional] +**number_of_units** | **float** | The rate per unit | [optional] +**fixed_amount** | **float** | The fixed amount per period | [optional] +**earnings_rate_id** | **str** | The corresponding earnings rate identifier | [optional] +**name** | **str** | The read-only name of the Earning Template. | [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) + + diff --git a/xero_python/payrollnz/docs/EarningsTemplateObject.md b/xero_python/payrollnz/docs/EarningsTemplateObject.md new file mode 100644 index 00000000..18435d4a --- /dev/null +++ b/xero_python/payrollnz/docs/EarningsTemplateObject.md @@ -0,0 +1,12 @@ +# EarningsTemplateObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**earning_template** | [**EarningsTemplate**](EarningsTemplate.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/Employee.md b/xero_python/payrollnz/docs/Employee.md new file mode 100644 index 00000000..307246c4 --- /dev/null +++ b/xero_python/payrollnz/docs/Employee.md @@ -0,0 +1,23 @@ +# Employee + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee_id** | **str** | Xero unique identifier for the employee | [optional] +**title** | **str** | Title of the employee | [optional] +**first_name** | **str** | First name of employee | [optional] +**last_name** | **str** | Last name of employee | [optional] +**date_of_birth** | **date** | Date of birth of the employee (YYYY-MM-DD) | [optional] +**address** | [**Address**](Address.md) | | [optional] +**email** | **str** | The email address for the employee | [optional] +**gender** | **str** | The employee’s gender | [optional] +**phone_number** | **str** | Employee phone number | [optional] +**start_date** | **date** | Employment start date of the employee at the time it was requested | [optional] +**end_date** | **date** | Employment end date of the employee at the time it was requested | [optional] +**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] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/docs/EmployeeEarningsTemplates.md b/xero_python/payrollnz/docs/EmployeeEarningsTemplates.md new file mode 100644 index 00000000..38598e76 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeEarningsTemplates.md @@ -0,0 +1,12 @@ +# EmployeeEarningsTemplates + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**earning_templates** | [**list[EarningsTemplate]**](EarningsTemplate.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeLeave.md b/xero_python/payrollnz/docs/EmployeeLeave.md new file mode 100644 index 00000000..879609da --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeLeave.md @@ -0,0 +1,16 @@ +# EmployeeLeave + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leave_id** | **str** | The Xero identifier for LeaveType | [optional] +**leave_type_id** | **str** | The Xero identifier for LeaveType | +**description** | **str** | The description of the leave (max length = 50) | +**start_date** | **date** | Start date of the leave (YYYY-MM-DD) | +**end_date** | **date** | End date of the leave (YYYY-MM-DD) | +**periods** | [**list[LeavePeriod]**](LeavePeriod.md) | The leave period information. The StartDate, EndDate and NumberOfUnits needs to be specified when you do not want to calculate NumberOfUnits automatically. Using incorrect period StartDate and EndDate will result in automatic computation of the NumberOfUnits. | [optional] +**updated_date_utc** | **datetime** | UTC timestamp of last update to the leave type note | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeLeaveBalance.md b/xero_python/payrollnz/docs/EmployeeLeaveBalance.md new file mode 100644 index 00000000..4b1f4580 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeLeaveBalance.md @@ -0,0 +1,13 @@ +# EmployeeLeaveBalance + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the leave type. | [optional] +**leave_type_id** | **str** | The Xero identifier for leave type | [optional] +**balance** | **float** | The employees current balance for the corresponding leave type. | [optional] +**type_of_units** | **str** | The type of the units of the leave. | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeLeaveBalances.md b/xero_python/payrollnz/docs/EmployeeLeaveBalances.md new file mode 100644 index 00000000..bb0e6cf4 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeLeaveBalances.md @@ -0,0 +1,12 @@ +# EmployeeLeaveBalances + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**leave_balances** | [**list[EmployeeLeaveBalance]**](EmployeeLeaveBalance.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeLeaveObject.md b/xero_python/payrollnz/docs/EmployeeLeaveObject.md new file mode 100644 index 00000000..f014a907 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeLeaveObject.md @@ -0,0 +1,12 @@ +# EmployeeLeaveObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**leave** | [**EmployeeLeave**](EmployeeLeave.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeLeaveSetup.md b/xero_python/payrollnz/docs/EmployeeLeaveSetup.md new file mode 100644 index 00000000..b9bf6d82 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeLeaveSetup.md @@ -0,0 +1,16 @@ +# EmployeeLeaveSetup + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**include_holiday_pay** | **bool** | Identifier if holiday pay will be included in each payslip | [optional] +**holiday_pay_opening_balance** | **float** | Initial holiday pay balance. A percentage — usually 8% — of gross earnings since their last work anniversary. | [optional] +**annual_leave_opening_balance** | **float** | Initial annual leave balance. The balance at their last anniversary, less any leave taken since then and excluding accrued annual leave. | [optional] +**negative_annual_leave_balance_paid_amount** | **float** | The dollar value of annual leave opening balance if negative. | [optional] +**sick_leave_hours_to_accrue_annually** | **float** | Number of hours accrued annually for sick leave. Multiply the number of days they're entitled to by the hours worked per day | [optional] +**sick_leave_maximum_hours_to_accrue** | **float** | Maximum number of hours accrued annually for sick leave. Multiply the maximum days they can accrue by the hours worked per day | [optional] +**sick_leave_opening_balance** | **float** | Initial sick leave balance. This will be positive unless they've taken sick leave in advance | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeLeaveSetupObject.md b/xero_python/payrollnz/docs/EmployeeLeaveSetupObject.md new file mode 100644 index 00000000..9c291da0 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeLeaveSetupObject.md @@ -0,0 +1,12 @@ +# EmployeeLeaveSetupObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**leave_setup** | [**EmployeeLeaveSetup**](EmployeeLeaveSetup.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeLeaveType.md b/xero_python/payrollnz/docs/EmployeeLeaveType.md new file mode 100644 index 00000000..eca4056f --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeLeaveType.md @@ -0,0 +1,19 @@ +# EmployeeLeaveType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leave_type_id** | **str** | The Xero identifier for leave type | [optional] +**schedule_of_accrual** | **str** | The schedule of accrual | [optional] +**hours_accrued_annually** | **float** | The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is \"OnHourWorked\" | [optional] +**maximum_to_accrue** | **float** | The maximum number of hours that can be accrued for the leave | [optional] +**opening_balance** | **float** | The initial number of hours assigned when the leave was added to the employee | [optional] +**rate_accrued_hourly** | **float** | The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\" | [optional] +**percentage_of_gross_earnings** | **float** | Specific for scheduleOfAccrual having percentage of gross earnings. Identifies how much percentage of gross earnings is accrued per pay period. | [optional] +**include_holiday_pay_every_pay** | **bool** | Specific to Holiday pay. Flag determining if pay for leave type is added on each pay run. | [optional] +**show_annual_leave_in_advance** | **bool** | Specific to Annual Leave. Flag to include leave available to take in advance in the balance in the payslip | [optional] +**annual_leave_total_amount_paid** | **float** | Specific to Annual Leave. Annual leave balance in dollars | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeLeaveTypeObject.md b/xero_python/payrollnz/docs/EmployeeLeaveTypeObject.md new file mode 100644 index 00000000..89cdcc15 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeLeaveTypeObject.md @@ -0,0 +1,12 @@ +# EmployeeLeaveTypeObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**leave_type** | [**EmployeeLeaveType**](EmployeeLeaveType.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeLeaveTypes.md b/xero_python/payrollnz/docs/EmployeeLeaveTypes.md new file mode 100644 index 00000000..77e89433 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeLeaveTypes.md @@ -0,0 +1,12 @@ +# EmployeeLeaveTypes + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**leave_types** | [**list[EmployeeLeaveType]**](EmployeeLeaveType.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeLeaves.md b/xero_python/payrollnz/docs/EmployeeLeaves.md new file mode 100644 index 00000000..d3e56405 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeLeaves.md @@ -0,0 +1,12 @@ +# EmployeeLeaves + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**leave** | [**list[EmployeeLeave]**](EmployeeLeave.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeObject.md b/xero_python/payrollnz/docs/EmployeeObject.md new file mode 100644 index 00000000..1afa6765 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeObject.md @@ -0,0 +1,12 @@ +# EmployeeObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**employee** | [**Employee**](Employee.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeOpeningBalance.md b/xero_python/payrollnz/docs/EmployeeOpeningBalance.md new file mode 100644 index 00000000..0a9808cf --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeOpeningBalance.md @@ -0,0 +1,13 @@ +# EmployeeOpeningBalance + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**period_end_date** | **date** | The opening balance period end date. | [optional] +**days_paid** | **int** | The paid number of days. | [optional] +**unpaid_weeks** | **int** | The number of unpaid weeks. | [optional] +**gross_earnings** | **float** | The gross earnings during the period. | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeOpeningBalancesObject.md b/xero_python/payrollnz/docs/EmployeeOpeningBalancesObject.md new file mode 100644 index 00000000..bf49f3cb --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeOpeningBalancesObject.md @@ -0,0 +1,12 @@ +# EmployeeOpeningBalancesObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**opening_balances** | [**list[EmployeeOpeningBalance]**](EmployeeOpeningBalance.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeePayTemplate.md b/xero_python/payrollnz/docs/EmployeePayTemplate.md new file mode 100644 index 00000000..6fc2e482 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeePayTemplate.md @@ -0,0 +1,11 @@ +# EmployeePayTemplate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee_id** | **str** | Unique identifier for the employee | [optional] +**earning_templates** | [**list[EarningsTemplate]**](EarningsTemplate.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeePayTemplateObject.md b/xero_python/payrollnz/docs/EmployeePayTemplateObject.md new file mode 100644 index 00000000..edbec2d8 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeePayTemplateObject.md @@ -0,0 +1,12 @@ +# EmployeePayTemplateObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**pay_template** | [**EmployeePayTemplate**](EmployeePayTemplate.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeePayTemplates.md b/xero_python/payrollnz/docs/EmployeePayTemplates.md new file mode 100644 index 00000000..42e4780c --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeePayTemplates.md @@ -0,0 +1,12 @@ +# EmployeePayTemplates + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**pay_template** | [**EmployeePayTemplate**](EmployeePayTemplate.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeStatutoryLeaveBalance.md b/xero_python/payrollnz/docs/EmployeeStatutoryLeaveBalance.md new file mode 100644 index 00000000..484627cd --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeStatutoryLeaveBalance.md @@ -0,0 +1,12 @@ +# EmployeeStatutoryLeaveBalance + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leave_type** | **str** | The type of statutory leave | [optional] +**balance_remaining** | **float** | The balance remaining for the corresponding leave type as of specified date. | [optional] +**units** | **str** | The units will be \"Hours\" | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeStatutoryLeaveBalanceObject.md b/xero_python/payrollnz/docs/EmployeeStatutoryLeaveBalanceObject.md new file mode 100644 index 00000000..d66c0c46 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeStatutoryLeaveBalanceObject.md @@ -0,0 +1,12 @@ +# EmployeeStatutoryLeaveBalanceObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**leave_balance** | [**EmployeeStatutoryLeaveBalance**](EmployeeStatutoryLeaveBalance.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeStatutoryLeaveSummary.md b/xero_python/payrollnz/docs/EmployeeStatutoryLeaveSummary.md new file mode 100644 index 00000000..a308c9e6 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeStatutoryLeaveSummary.md @@ -0,0 +1,16 @@ +# EmployeeStatutoryLeaveSummary + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**statutory_leave_id** | **str** | The unique identifier (guid) of a statutory leave. | [optional] +**employee_id** | **str** | The unique identifier (guid) of the employee | [optional] +**type** | **str** | The category of statutory leave | [optional] +**start_date** | **date** | The date when the leave starts | [optional] +**end_date** | **date** | The date when the leave ends | [optional] +**is_entitled** | **bool** | Whether the leave was entitled to receive payment | [optional] +**status** | **str** | The status of the leave | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeStatutoryLeavesSummaries.md b/xero_python/payrollnz/docs/EmployeeStatutoryLeavesSummaries.md new file mode 100644 index 00000000..4271274c --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeStatutoryLeavesSummaries.md @@ -0,0 +1,12 @@ +# EmployeeStatutoryLeavesSummaries + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**statutory_leaves** | [**list[EmployeeStatutoryLeaveSummary]**](EmployeeStatutoryLeaveSummary.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeStatutorySickLeave.md b/xero_python/payrollnz/docs/EmployeeStatutorySickLeave.md new file mode 100644 index 00000000..1b5443c0 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeStatutorySickLeave.md @@ -0,0 +1,25 @@ +# EmployeeStatutorySickLeave + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**statutory_leave_id** | **str** | The unique identifier (guid) of a statutory leave | [optional] +**employee_id** | **str** | The unique identifier (guid) of the employee | +**leave_type_id** | **str** | The unique identifier (guid) of the \"Statutory Sick Leave (non-pensionable)\" pay item | +**start_date** | **date** | The date when the leave starts | +**end_date** | **date** | The date when the leave ends | +**type** | **str** | the type of statutory leave | [optional] +**status** | **str** | the type of statutory leave | [optional] +**work_pattern** | **list[str]** | The days of the work week the employee is scheduled to work at the time the leave is taken | +**is_pregnancy_related** | **bool** | Whether the sick leave was pregnancy related | +**sufficient_notice** | **bool** | Whether the employee provided sufficent notice and documentation as required by the employer supporting the sick leave request | +**is_entitled** | **bool** | Whether the leave was entitled to receive payment | [optional] +**entitlement_weeks_requested** | **float** | The amount of requested time (in weeks) | [optional] +**entitlement_weeks_qualified** | **float** | The amount of statutory sick leave time off (in weeks) that is available to take at the time the leave was requested | [optional] +**entitlement_weeks_remaining** | **float** | A calculated amount of time (in weeks) that remains for the statutory sick leave period | [optional] +**overlaps_with_other_leave** | **bool** | Whether another leave (Paternity, Shared Parental specifically) occurs during the requested leave's period. While this is allowed it could affect payment amounts | [optional] +**entitlement_failure_reasons** | **list[str]** | If the leave requested was considered \"not entitled\", the reasons why are listed here. | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeStatutorySickLeaveObject.md b/xero_python/payrollnz/docs/EmployeeStatutorySickLeaveObject.md new file mode 100644 index 00000000..2d3fbcd4 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeStatutorySickLeaveObject.md @@ -0,0 +1,12 @@ +# EmployeeStatutorySickLeaveObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**statutory_sick_leave** | [**EmployeeStatutorySickLeave**](EmployeeStatutorySickLeave.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeStatutorySickLeaves.md b/xero_python/payrollnz/docs/EmployeeStatutorySickLeaves.md new file mode 100644 index 00000000..b11040af --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeStatutorySickLeaves.md @@ -0,0 +1,12 @@ +# EmployeeStatutorySickLeaves + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**statutory_sick_leave** | [**list[EmployeeStatutorySickLeave]**](EmployeeStatutorySickLeave.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeTax.md b/xero_python/payrollnz/docs/EmployeeTax.md new file mode 100644 index 00000000..c2f0f2a4 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeTax.md @@ -0,0 +1,25 @@ +# EmployeeTax + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ird_number** | **str** | The IRD Number. | [optional] +**tax_code** | [**TaxCode**](TaxCode.md) | | [optional] +**special_tax_rate_percentage** | **float** | Special tax rate percentage. | [optional] +**has_special_student_loan_rate** | **bool** | Does the employee has a special student loan rate? | [optional] +**special_student_loan_rate_percentage** | **float** | The employee student loan rate percentage. | [optional] +**is_eligible_for_kiwi_saver** | **bool** | The employee eligibility for KiwiSaver. | [optional] +**esct_rate_percentage** | **float** | Employer superannuation contribution tax rate. | [optional] +**kiwi_saver_contributions** | **str** | Contribution Option which can be 'MakeContributions' 'OptOut', 'OnAContributionsHoliday', 'OnASavingsSuspension', 'NotCurrentlyAKiwiSaverMember' for employees without a KiwiSaver membership | [optional] +**kiwi_saver_employee_contribution_rate_percentage** | **float** | Employee Contribution percentage. | [optional] +**kiwi_saver_employer_contribution_rate_percentage** | **float** | Employer Contribution percentage. | [optional] +**kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage** | **float** | Employer Contribution through Salary Sacrifice percentage. | [optional] +**kiwi_saver_opt_out_date** | **date** | Opt Out Date. | [optional] +**kiwi_saver_contribution_holiday_end_date** | **date** | Contribution holiday expiry date or end date. | [optional] +**has_student_loan_balance** | **bool** | Does the employee have a remaining student loan balance? Set a remaining balance if you have received a letter from IR. | [optional] +**student_loan_balance** | **float** | The employee's student loan balance shown on the letter from IR. | [optional] +**student_loan_as_at** | **date** | The date of the letter from IR. | [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) + + diff --git a/xero_python/payrollnz/docs/EmployeeTaxObject.md b/xero_python/payrollnz/docs/EmployeeTaxObject.md new file mode 100644 index 00000000..9a9bded7 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeTaxObject.md @@ -0,0 +1,12 @@ +# EmployeeTaxObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**employee_tax** | [**EmployeeTax**](EmployeeTax.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/Employees.md b/xero_python/payrollnz/docs/Employees.md new file mode 100644 index 00000000..22a08c61 --- /dev/null +++ b/xero_python/payrollnz/docs/Employees.md @@ -0,0 +1,12 @@ +# Employees + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**employees** | [**list[Employee]**](Employee.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/Employment.md b/xero_python/payrollnz/docs/Employment.md new file mode 100644 index 00000000..70b6e694 --- /dev/null +++ b/xero_python/payrollnz/docs/Employment.md @@ -0,0 +1,12 @@ +# Employment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payroll_calendar_id** | **str** | Xero unique identifier for the payroll calendar of the employee | [optional] +**pay_run_calendar_id** | **str** | Xero unique identifier for the payrun calendar for the employee (Deprecated in version 1.1.6) | [optional] +**start_date** | **date** | Start date of the employment (YYYY-MM-DD) | [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) + + diff --git a/xero_python/payrollnz/docs/EmploymentObject.md b/xero_python/payrollnz/docs/EmploymentObject.md new file mode 100644 index 00000000..2779aef7 --- /dev/null +++ b/xero_python/payrollnz/docs/EmploymentObject.md @@ -0,0 +1,12 @@ +# EmploymentObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**employment** | [**Employment**](Employment.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/GrossEarningsHistory.md b/xero_python/payrollnz/docs/GrossEarningsHistory.md new file mode 100644 index 00000000..3f0b97b2 --- /dev/null +++ b/xero_python/payrollnz/docs/GrossEarningsHistory.md @@ -0,0 +1,11 @@ +# GrossEarningsHistory + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**days_paid** | **int** | Number of days the employee worked in the pay period (0 - 365) | [optional] +**unpaid_weeks** | **int** | Number of full weeks the employee didn't work in the pay period (0 - 52) | [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) + + diff --git a/xero_python/payrollnz/docs/InvalidField.md b/xero_python/payrollnz/docs/InvalidField.md new file mode 100644 index 00000000..fbb1b5b2 --- /dev/null +++ b/xero_python/payrollnz/docs/InvalidField.md @@ -0,0 +1,11 @@ +# InvalidField + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the field that caused the error | [optional] +**reason** | **str** | The reason the error occurred | [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) + + diff --git a/xero_python/payrollnz/docs/LeaveAccrualLine.md b/xero_python/payrollnz/docs/LeaveAccrualLine.md new file mode 100644 index 00000000..3e92ab51 --- /dev/null +++ b/xero_python/payrollnz/docs/LeaveAccrualLine.md @@ -0,0 +1,11 @@ +# LeaveAccrualLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leave_type_id** | **str** | Xero identifier for the Leave type | [optional] +**number_of_units** | **float** | Leave accrual number of units | [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) + + diff --git a/xero_python/payrollnz/docs/LeaveEarningsLine.md b/xero_python/payrollnz/docs/LeaveEarningsLine.md new file mode 100644 index 00000000..18f5951b --- /dev/null +++ b/xero_python/payrollnz/docs/LeaveEarningsLine.md @@ -0,0 +1,19 @@ +# LeaveEarningsLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**earnings_line_id** | **str** | Xero identifier for payroll earnings line | [optional] +**earnings_rate_id** | **str** | Xero identifier for payroll leave earnings rate | [optional] +**display_name** | **str** | name of earnings rate for display in UI | [optional] +**rate_per_unit** | **float** | Rate per unit for leave earnings line | [optional] +**number_of_units** | **float** | Leave earnings number of units | [optional] +**fixed_amount** | **float** | Leave earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed | [optional] +**amount** | **float** | The amount of the earnings line. | [optional] +**is_linked_to_timesheet** | **bool** | Identifies if the leave earnings is taken from the timesheet. False for leave earnings line | [optional] +**is_average_daily_pay_rate** | **bool** | Identifies if the earnings is using an average daily pay rate | [optional] +**is_system_generated** | **bool** | Flag to indentify whether the earnings line is system generated or not. | [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) + + diff --git a/xero_python/payrollnz/docs/LeavePeriod.md b/xero_python/payrollnz/docs/LeavePeriod.md new file mode 100644 index 00000000..ad97b401 --- /dev/null +++ b/xero_python/payrollnz/docs/LeavePeriod.md @@ -0,0 +1,13 @@ +# LeavePeriod + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**period_start_date** | **date** | The Pay Period Start Date (YYYY-MM-DD) | [optional] +**period_end_date** | **date** | The Pay Period End Date (YYYY-MM-DD) | [optional] +**number_of_units** | **float** | The Number of Units for the leave | [optional] +**period_status** | **str** | Period Status | [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) + + diff --git a/xero_python/payrollnz/docs/LeavePeriods.md b/xero_python/payrollnz/docs/LeavePeriods.md new file mode 100644 index 00000000..df263d10 --- /dev/null +++ b/xero_python/payrollnz/docs/LeavePeriods.md @@ -0,0 +1,12 @@ +# LeavePeriods + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**periods** | [**list[LeavePeriod]**](LeavePeriod.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/LeaveType.md b/xero_python/payrollnz/docs/LeaveType.md new file mode 100644 index 00000000..49553d40 --- /dev/null +++ b/xero_python/payrollnz/docs/LeaveType.md @@ -0,0 +1,15 @@ +# LeaveType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leave_type_id** | **str** | Xero unique identifier for the leave type | [optional] +**name** | **str** | Name of the leave type | +**is_paid_leave** | **bool** | Indicate that an employee will be paid when taking this type of leave | +**show_on_payslip** | **bool** | Indicate that a balance for this leave type to be shown on the employee’s payslips | +**updated_date_utc** | **datetime** | UTC timestamp of last update to the leave type note | [optional] +**is_active** | **bool** | Shows whether the leave type is active or not | [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) + + diff --git a/xero_python/payrollnz/docs/LeaveTypeObject.md b/xero_python/payrollnz/docs/LeaveTypeObject.md new file mode 100644 index 00000000..ed11135b --- /dev/null +++ b/xero_python/payrollnz/docs/LeaveTypeObject.md @@ -0,0 +1,12 @@ +# LeaveTypeObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**leave_type** | [**LeaveType**](LeaveType.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/LeaveTypes.md b/xero_python/payrollnz/docs/LeaveTypes.md new file mode 100644 index 00000000..b6323e47 --- /dev/null +++ b/xero_python/payrollnz/docs/LeaveTypes.md @@ -0,0 +1,12 @@ +# LeaveTypes + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**leave_types** | [**list[LeaveType]**](LeaveType.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/Pagination.md b/xero_python/payrollnz/docs/Pagination.md new file mode 100644 index 00000000..7d4aa488 --- /dev/null +++ b/xero_python/payrollnz/docs/Pagination.md @@ -0,0 +1,13 @@ +# Pagination + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**page** | **int** | | [optional] +**page_size** | **int** | | [optional] +**page_count** | **int** | | [optional] +**item_count** | **int** | | [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) + + diff --git a/xero_python/payrollnz/docs/PayRun.md b/xero_python/payrollnz/docs/PayRun.md new file mode 100644 index 00000000..a68371ae --- /dev/null +++ b/xero_python/payrollnz/docs/PayRun.md @@ -0,0 +1,21 @@ +# PayRun + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pay_run_id** | **str** | Xero unique identifier for the pay run | [optional] +**payroll_calendar_id** | **str** | Xero unique identifier for the payroll calendar | [optional] +**period_start_date** | **date** | Period start date of the payroll calendar | [optional] +**period_end_date** | **date** | Period end date of the payroll calendar | [optional] +**payment_date** | **date** | Payment date of the pay run | [optional] +**total_cost** | **float** | Total cost of the pay run | [optional] +**total_pay** | **float** | Total pay of the pay run | [optional] +**pay_run_status** | **str** | Pay run status | [optional] +**pay_run_type** | **str** | Pay run type | [optional] +**calendar_type** | **str** | Calendar type of the pay run | [optional] +**posted_date_time** | **date** | Posted date time of the pay run | [optional] +**pay_slips** | [**list[PaySlip]**](PaySlip.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/PayRunCalendar.md b/xero_python/payrollnz/docs/PayRunCalendar.md new file mode 100644 index 00000000..27a88fbf --- /dev/null +++ b/xero_python/payrollnz/docs/PayRunCalendar.md @@ -0,0 +1,16 @@ +# PayRunCalendar + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payroll_calendar_id** | **str** | Xero unique identifier for the payroll calendar | [optional] +**name** | **str** | Name of the calendar | +**calendar_type** | **str** | Type of the calendar | +**period_start_date** | **date** | Period start date of the calendar | +**period_end_date** | **date** | Period end date of the calendar | [optional] +**payment_date** | **date** | Payment date of the calendar | +**updated_date_utc** | **datetime** | UTC timestamp of the last update to the pay run calendar | [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) + + diff --git a/xero_python/payrollnz/docs/PayRunCalendarObject.md b/xero_python/payrollnz/docs/PayRunCalendarObject.md new file mode 100644 index 00000000..50caa423 --- /dev/null +++ b/xero_python/payrollnz/docs/PayRunCalendarObject.md @@ -0,0 +1,12 @@ +# PayRunCalendarObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**pay_run_calendar** | [**PayRunCalendar**](PayRunCalendar.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/PayRunCalendars.md b/xero_python/payrollnz/docs/PayRunCalendars.md new file mode 100644 index 00000000..f0a2872d --- /dev/null +++ b/xero_python/payrollnz/docs/PayRunCalendars.md @@ -0,0 +1,12 @@ +# PayRunCalendars + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**pay_run_calendars** | [**list[PayRunCalendar]**](PayRunCalendar.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/PayRunObject.md b/xero_python/payrollnz/docs/PayRunObject.md new file mode 100644 index 00000000..abfe81a5 --- /dev/null +++ b/xero_python/payrollnz/docs/PayRunObject.md @@ -0,0 +1,12 @@ +# PayRunObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**pay_run** | [**PayRun**](PayRun.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/PayRuns.md b/xero_python/payrollnz/docs/PayRuns.md new file mode 100644 index 00000000..59ad3d87 --- /dev/null +++ b/xero_python/payrollnz/docs/PayRuns.md @@ -0,0 +1,12 @@ +# PayRuns + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**pay_runs** | [**list[PayRun]**](PayRun.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/PaySlip.md b/xero_python/payrollnz/docs/PaySlip.md new file mode 100644 index 00000000..1dd1ac25 --- /dev/null +++ b/xero_python/payrollnz/docs/PaySlip.md @@ -0,0 +1,39 @@ +# PaySlip + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pay_slip_id** | **str** | The Xero identifier for a PaySlip | [optional] +**employee_id** | **str** | The Xero identifier for payroll employee | [optional] +**pay_run_id** | **str** | The Xero identifier for the associated payrun | [optional] +**last_edited** | **date** | The date payslip was last updated | [optional] +**first_name** | **str** | Employee first name | [optional] +**last_name** | **str** | Employee last name | [optional] +**total_earnings** | **float** | Total earnings before any deductions. Same as gross earnings for NZ. | [optional] +**gross_earnings** | **float** | Total earnings before any deductions. Same as total earnings for NZ. | [optional] +**total_pay** | **float** | The employee net pay | [optional] +**total_employer_taxes** | **float** | The employer's tax obligation | [optional] +**total_employee_taxes** | **float** | The part of an employee's earnings that is deducted for tax purposes | [optional] +**total_deductions** | **float** | Total amount subtracted from an employee's earnings to reach total pay | [optional] +**total_reimbursements** | **float** | Total reimbursements are nontaxable payments to an employee used to repay out-of-pocket expenses when the person incurs those expenses through employment | [optional] +**total_statutory_deductions** | **float** | Total amounts required by law to subtract from the employee's earnings | [optional] +**total_superannuation** | **float** | Benefits (also called fringe benefits, perquisites or perks) are various non-earnings compensations provided to employees in addition to their normal earnings or salaries | [optional] +**bacs_hash** | **str** | BACS Service User Number | [optional] +**payment_method** | **str** | The payment method code | [optional] +**earnings_lines** | [**list[EarningsLine]**](EarningsLine.md) | | [optional] +**leave_earnings_lines** | [**list[LeaveEarningsLine]**](LeaveEarningsLine.md) | | [optional] +**timesheet_earnings_lines** | [**list[TimesheetEarningsLine]**](TimesheetEarningsLine.md) | | [optional] +**deduction_lines** | [**list[DeductionLine]**](DeductionLine.md) | | [optional] +**reimbursement_lines** | [**list[ReimbursementLine]**](ReimbursementLine.md) | | [optional] +**leave_accrual_lines** | [**list[LeaveAccrualLine]**](LeaveAccrualLine.md) | | [optional] +**superannuation_lines** | [**list[SuperannuationLine]**](SuperannuationLine.md) | | [optional] +**payment_lines** | [**list[PaymentLine]**](PaymentLine.md) | | [optional] +**employee_tax_lines** | [**list[TaxLine]**](TaxLine.md) | | [optional] +**employer_tax_lines** | [**list[TaxLine]**](TaxLine.md) | | [optional] +**statutory_deduction_lines** | [**list[StatutoryDeductionLine]**](StatutoryDeductionLine.md) | | [optional] +**tax_settings** | [**TaxSettings**](TaxSettings.md) | | [optional] +**gross_earnings_history** | [**GrossEarningsHistory**](GrossEarningsHistory.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/PaySlipObject.md b/xero_python/payrollnz/docs/PaySlipObject.md new file mode 100644 index 00000000..3433206e --- /dev/null +++ b/xero_python/payrollnz/docs/PaySlipObject.md @@ -0,0 +1,12 @@ +# PaySlipObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**pay_slip** | [**PaySlip**](PaySlip.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/PaySlips.md b/xero_python/payrollnz/docs/PaySlips.md new file mode 100644 index 00000000..d07824f1 --- /dev/null +++ b/xero_python/payrollnz/docs/PaySlips.md @@ -0,0 +1,12 @@ +# PaySlips + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**pay_slips** | [**list[PaySlip]**](PaySlip.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/PaymentLine.md b/xero_python/payrollnz/docs/PaymentLine.md new file mode 100644 index 00000000..e55242a8 --- /dev/null +++ b/xero_python/payrollnz/docs/PaymentLine.md @@ -0,0 +1,14 @@ +# PaymentLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payment_line_id** | **str** | Xero identifier for payroll payment line | [optional] +**amount** | **float** | The amount of the payment line | [optional] +**account_number** | **str** | The account number | [optional] +**sort_code** | **str** | The account sort code | [optional] +**account_name** | **str** | The account name | [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) + + diff --git a/xero_python/payrollnz/docs/PaymentMethod.md b/xero_python/payrollnz/docs/PaymentMethod.md new file mode 100644 index 00000000..7edcc42c --- /dev/null +++ b/xero_python/payrollnz/docs/PaymentMethod.md @@ -0,0 +1,11 @@ +# PaymentMethod + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payment_method** | **str** | The payment method code | [optional] +**bank_accounts** | [**list[BankAccount]**](BankAccount.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/PaymentMethodObject.md b/xero_python/payrollnz/docs/PaymentMethodObject.md new file mode 100644 index 00000000..9d4c69b0 --- /dev/null +++ b/xero_python/payrollnz/docs/PaymentMethodObject.md @@ -0,0 +1,12 @@ +# PaymentMethodObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**payment_method** | [**PaymentMethod**](PaymentMethod.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/PayrollNZApi.md b/xero_python/payrollnz/docs/PayrollNZApi.md new file mode 100644 index 00000000..fedc40a9 --- /dev/null +++ b/xero_python/payrollnz/docs/PayrollNZApi.md @@ -0,0 +1,4430 @@ +# xero_python.payrollnz.PayrollNzApi + +All URIs are relative to *https://api.xero.com/payroll.xro/2.0* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve_timesheet**](PayrollNzApi.md#approve_timesheet) | **POST** /Timesheets/{TimesheetID}/Approve | approve a timesheet +[**create_deduction**](PayrollNzApi.md#create_deduction) | **POST** /Deductions | create a new deduction +[**create_earnings_rate**](PayrollNzApi.md#create_earnings_rate) | **POST** /EarningsRates | create a new earnings rate +[**create_employee**](PayrollNzApi.md#create_employee) | **POST** /Employees | creates employees +[**create_employee_earnings_template**](PayrollNzApi.md#create_employee_earnings_template) | **POST** /Employees/{EmployeeId}/PayTemplates/earnings | creates employee earnings template records +[**create_employee_leave**](PayrollNzApi.md#create_employee_leave) | **POST** /Employees/{EmployeeId}/Leave | creates employee leave records +[**create_employee_leave_setup**](PayrollNzApi.md#create_employee_leave_setup) | **POST** /Employees/{EmployeeId}/leaveSetup | Allows you to set-up leave for a specific employee. This is required before viewing, configuring and requesting leave for an employee +[**create_employee_leave_type**](PayrollNzApi.md#create_employee_leave_type) | **POST** /Employees/{EmployeeId}/LeaveTypes | creates employee leave type records +[**create_employee_opening_balances**](PayrollNzApi.md#create_employee_opening_balances) | **POST** /Employees/{EmployeeId}/openingBalances | creates employee opening balances +[**create_employee_payment_method**](PayrollNzApi.md#create_employee_payment_method) | **POST** /Employees/{EmployeeId}/PaymentMethods | creates employee payment method +[**create_employee_salary_and_wage**](PayrollNzApi.md#create_employee_salary_and_wage) | **POST** /Employees/{EmployeeId}/SalaryAndWages | creates employee salary and wage record +[**create_employment**](PayrollNzApi.md#create_employment) | **POST** /Employees/{EmployeeId}/Employment | creates employment +[**create_leave_type**](PayrollNzApi.md#create_leave_type) | **POST** /LeaveTypes | create a new leave type +[**create_multiple_employee_earnings_template**](PayrollNzApi.md#create_multiple_employee_earnings_template) | **POST** /Employees/{EmployeeId}/paytemplateearnings | creates multiple employee earnings template records +[**create_pay_run**](PayrollNzApi.md#create_pay_run) | **POST** /PayRuns | create a pay run +[**create_pay_run_calendar**](PayrollNzApi.md#create_pay_run_calendar) | **POST** /PayRunCalendars | create a new payrun calendar +[**create_reimbursement**](PayrollNzApi.md#create_reimbursement) | **POST** /Reimbursements | create a new reimbursement +[**create_superannuation**](PayrollNzApi.md#create_superannuation) | **POST** /superannuations | create a new superannuation +[**create_timesheet**](PayrollNzApi.md#create_timesheet) | **POST** /Timesheets | create a new timesheet +[**create_timesheet_line**](PayrollNzApi.md#create_timesheet_line) | **POST** /Timesheets/{TimesheetID}/Lines | create a new timesheet line +[**delete_employee_earnings_template**](PayrollNzApi.md#delete_employee_earnings_template) | **DELETE** /Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID} | deletes an employee earnings template record +[**delete_employee_leave**](PayrollNzApi.md#delete_employee_leave) | **DELETE** /Employees/{EmployeeId}/Leave/{LeaveID} | deletes an employee leave record +[**delete_employee_salary_and_wage**](PayrollNzApi.md#delete_employee_salary_and_wage) | **DELETE** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | deletes an employee salary and wages record +[**delete_timesheet**](PayrollNzApi.md#delete_timesheet) | **DELETE** /Timesheets/{TimesheetID} | delete a timesheet +[**delete_timesheet_line**](PayrollNzApi.md#delete_timesheet_line) | **DELETE** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | delete a timesheet line +[**get_deduction**](PayrollNzApi.md#get_deduction) | **GET** /Deductions/{deductionId} | retrieve a single deduction by id +[**get_deductions**](PayrollNzApi.md#get_deductions) | **GET** /Deductions | searches deductions +[**get_earnings_rate**](PayrollNzApi.md#get_earnings_rate) | **GET** /EarningsRates/{EarningsRateID} | retrieve a single earnings rates by id +[**get_earnings_rates**](PayrollNzApi.md#get_earnings_rates) | **GET** /EarningsRates | searches earnings rates +[**get_employee**](PayrollNzApi.md#get_employee) | **GET** /Employees/{EmployeeId} | searches employees +[**get_employee_leave_balances**](PayrollNzApi.md#get_employee_leave_balances) | **GET** /Employees/{EmployeeId}/LeaveBalances | search employee leave balances +[**get_employee_leave_periods**](PayrollNzApi.md#get_employee_leave_periods) | **GET** /Employees/{EmployeeId}/LeavePeriods | searches employee leave periods +[**get_employee_leave_types**](PayrollNzApi.md#get_employee_leave_types) | **GET** /Employees/{EmployeeId}/LeaveTypes | searches employee leave types +[**get_employee_leaves**](PayrollNzApi.md#get_employee_leaves) | **GET** /Employees/{EmployeeId}/Leave | search employee leave records +[**get_employee_opening_balances**](PayrollNzApi.md#get_employee_opening_balances) | **GET** /Employees/{EmployeeId}/openingBalances | retrieve employee openingbalances +[**get_employee_pay_templates**](PayrollNzApi.md#get_employee_pay_templates) | **GET** /Employees/{EmployeeId}/PayTemplates | searches employee pay templates +[**get_employee_payment_method**](PayrollNzApi.md#get_employee_payment_method) | **GET** /Employees/{EmployeeId}/PaymentMethods | retrieves an employee's payment method +[**get_employee_salary_and_wage**](PayrollNzApi.md#get_employee_salary_and_wage) | **GET** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | get employee salary and wages record by id +[**get_employee_salary_and_wages**](PayrollNzApi.md#get_employee_salary_and_wages) | **GET** /Employees/{EmployeeId}/SalaryAndWages | retrieves an employee's salary and wages +[**get_employee_tax**](PayrollNzApi.md#get_employee_tax) | **GET** /Employees/{EmployeeId}/Tax | searches tax records for an employee +[**get_employees**](PayrollNzApi.md#get_employees) | **GET** /Employees | searches employees +[**get_leave_type**](PayrollNzApi.md#get_leave_type) | **GET** /LeaveTypes/{LeaveTypeID} | retrieve a single leave type by id +[**get_leave_types**](PayrollNzApi.md#get_leave_types) | **GET** /LeaveTypes | searches leave types +[**get_pay_run**](PayrollNzApi.md#get_pay_run) | **GET** /PayRuns/{PayRunID} | retrieve a single pay run by id +[**get_pay_run_calendar**](PayrollNzApi.md#get_pay_run_calendar) | **GET** /PayRunCalendars/{PayrollCalendarID} | retrieve a single payrun calendar by id +[**get_pay_run_calendars**](PayrollNzApi.md#get_pay_run_calendars) | **GET** /PayRunCalendars | searches payrun calendars +[**get_pay_runs**](PayrollNzApi.md#get_pay_runs) | **GET** /PayRuns | searches pay runs +[**get_pay_slip**](PayrollNzApi.md#get_pay_slip) | **GET** /PaySlips/{PaySlipID} | retrieve a single payslip by id +[**get_pay_slips**](PayrollNzApi.md#get_pay_slips) | **GET** /PaySlips | searches payslips +[**get_reimbursement**](PayrollNzApi.md#get_reimbursement) | **GET** /Reimbursements/{ReimbursementID} | retrieve a single reimbursement by id +[**get_reimbursements**](PayrollNzApi.md#get_reimbursements) | **GET** /Reimbursements | searches reimbursements +[**get_settings**](PayrollNzApi.md#get_settings) | **GET** /Settings | searches settings +[**get_statutory_deduction**](PayrollNzApi.md#get_statutory_deduction) | **GET** /StatutoryDeductions/{Id} | retrieve a single statutory deduction by id +[**get_statutory_deductions**](PayrollNzApi.md#get_statutory_deductions) | **GET** /StatutoryDeductions | searches statutory deductions +[**get_superannuation**](PayrollNzApi.md#get_superannuation) | **GET** /superannuations/{SuperannuationID} | searches for a unique superannuation +[**get_superannuations**](PayrollNzApi.md#get_superannuations) | **GET** /superannuations | searches statutory deductions +[**get_timesheet**](PayrollNzApi.md#get_timesheet) | **GET** /Timesheets/{TimesheetID} | retrieve a single timesheet by id +[**get_timesheets**](PayrollNzApi.md#get_timesheets) | **GET** /Timesheets | searches timesheets +[**get_tracking_categories**](PayrollNzApi.md#get_tracking_categories) | **GET** /settings/trackingCategories | searches tracking categories +[**revert_timesheet**](PayrollNzApi.md#revert_timesheet) | **POST** /Timesheets/{TimesheetID}/RevertToDraft | revert a timesheet to draft +[**update_employee**](PayrollNzApi.md#update_employee) | **PUT** /Employees/{EmployeeId} | updates employee +[**update_employee_earnings_template**](PayrollNzApi.md#update_employee_earnings_template) | **PUT** /Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID} | updates employee earnings template records +[**update_employee_leave**](PayrollNzApi.md#update_employee_leave) | **PUT** /Employees/{EmployeeId}/Leave/{LeaveID} | updates employee leave records +[**update_employee_salary_and_wage**](PayrollNzApi.md#update_employee_salary_and_wage) | **PUT** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | updates employee salary and wages record +[**update_employee_tax**](PayrollNzApi.md#update_employee_tax) | **POST** /Employees/{EmployeeId}/Tax | updates the tax records for an employee +[**update_pay_run**](PayrollNzApi.md#update_pay_run) | **PUT** /PayRuns/{PayRunID} | update a pay run +[**update_pay_slip_line_items**](PayrollNzApi.md#update_pay_slip_line_items) | **PUT** /PaySlips/{PaySlipID} | creates employee pay slip +[**update_timesheet_line**](PayrollNzApi.md#update_timesheet_line) | **PUT** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | update a timesheet line + + +# **approve_timesheet** +> TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id) + +approve a timesheet + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +try: + # approve a timesheet + api_response = api_instance.approve_timesheet(xero_tenant_id, timesheet_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->approve_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + +### Return type + +[**TimesheetObject**](TimesheetObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_deduction** +> DeductionObject create_deduction(xero_tenant_id, deduction) + +create a new deduction + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +deduction = { "deductionName": "My new deducation", "deductionCategory": "NzOther", "liabilityAccountId": "568f2e9a-0870-46cc-8678-f83f132ed4e3" } # Deduction | +try: + # create a new deduction + api_response = api_instance.create_deduction(xero_tenant_id, deduction) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_deduction: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **deduction** | [**Deduction**](Deduction.md)| | + +### Return type + +[**DeductionObject**](DeductionObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_earnings_rate** +> EarningsRateObject create_earnings_rate(xero_tenant_id, earnings_rate) + +create a new earnings rate + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +earnings_rate = { "name": "My Earnings Rate", "earningsType": "RegularEarnings", "rateType": "RatePerUnit", "typeOfUnits": "hours", "expenseAccountID": "e4eb36f6-97e3-4427-a394-dd4e1b355c2e" } # EarningsRate | +try: + # create a new earnings rate + api_response = api_instance.create_earnings_rate(xero_tenant_id, earnings_rate) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_earnings_rate: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **earnings_rate** | [**EarningsRate**](EarningsRate.md)| | + +### Return type + +[**EarningsRateObject**](EarningsRateObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_employee** +> EmployeeObject create_employee(xero_tenant_id, employee) + +creates employees + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee = { "title": "Mr", "firstName": "Mike", "lastName": "Johntzxzpxhmkgson", "dateOfBirth": "2000-01-01", "address": { "addressLine1": "101 Green St", "city": "San Francisco", "postCode": "4351", "countryName": "United Kingdom" }, "email": "83139@starkindustries.com", "gender": "M" } # Employee | +try: + # creates employees + api_response = api_instance.create_employee(xero_tenant_id, employee) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_employee: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee** | [**Employee**](Employee.md)| | + +### Return type + +[**EmployeeObject**](EmployeeObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_employee_earnings_template** +> EarningsTemplateObject create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) + +creates employee earnings template records + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +earnings_template = { "ratePerUnit": 20, "numberOfUnits": 8, "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "name": "My New One" } # EarningsTemplate | +try: + # creates employee earnings template records + api_response = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_employee_earnings_template: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **earnings_template** | [**EarningsTemplate**](EarningsTemplate.md)| | + +### Return type + +[**EarningsTemplateObject**](EarningsTemplateObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_employee_leave** +> EmployeeLeaveObject create_employee_leave(xero_tenant_id, employee_id, employee_leave) + +creates employee leave records + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +employee_leave = { "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4", "description": "Creating a Desription", "startDate": "2020-04-24", "endDate": "2020-04-26" } # EmployeeLeave | +try: + # creates employee leave records + api_response = api_instance.create_employee_leave(xero_tenant_id, employee_id, employee_leave) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_employee_leave: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **employee_leave** | [**EmployeeLeave**](EmployeeLeave.md)| | + +### Return type + +[**EmployeeLeaveObject**](EmployeeLeaveObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_employee_leave_setup** +> EmployeeLeaveSetupObject create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setup) + +Allows you to set-up leave for a specific employee. This is required before viewing, configuring and requesting leave for an employee + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +employee_leave_setup = { "holidayPayOpeningBalance": 10, "annualLeaveOpeningBalance": 100, "sickLeaveHoursToAccrueAnnually": 20, "sickLeaveOpeningBalance": 10 } # EmployeeLeaveSetup | +try: + # Allows you to set-up leave for a specific employee. This is required before viewing, configuring and requesting leave for an employee + api_response = api_instance.create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setup) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_employee_leave_setup: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **employee_leave_setup** | [**EmployeeLeaveSetup**](EmployeeLeaveSetup.md)| | + +### Return type + +[**EmployeeLeaveSetupObject**](EmployeeLeaveSetupObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_employee_leave_type** +> EmployeeLeaveTypeObject create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type) + +creates employee leave type records + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +employee_leave_type = { "leaveTypeID": "35da97ae-05b9-427f-9a98-69157ba42cec", "scheduleOfAccrual": "AnnuallyAfter6Months", "hoursAccruedAnnually": 10, "maximumToAccrue": 80, "openingBalance": 100, "rateAccruedHourly": 3.5 } # EmployeeLeaveType | +try: + # creates employee leave type records + api_response = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_employee_leave_type: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **employee_leave_type** | [**EmployeeLeaveType**](EmployeeLeaveType.md)| | + +### Return type + +[**EmployeeLeaveTypeObject**](EmployeeLeaveTypeObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_employee_opening_balances** +> EmployeeOpeningBalancesObject create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance) + +creates employee opening balances + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +employee_opening_balance = [{"periodEndDate":"2020-10-01","daysPaid":3,"unpaidWeeks":2,"grossEarnings":40.0}] # list[EmployeeOpeningBalance] | +try: + # creates employee opening balances + api_response = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_employee_opening_balances: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **employee_opening_balance** | [**list[EmployeeOpeningBalance]**](EmployeeOpeningBalance.md)| | + +### Return type + +[**EmployeeOpeningBalancesObject**](EmployeeOpeningBalancesObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_employee_payment_method** +> PaymentMethodObject create_employee_payment_method(xero_tenant_id, employee_id, payment_method) + +creates employee payment method + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +payment_method = xero_python.payrollnz.PaymentMethod() # PaymentMethod | +try: + # creates employee payment method + api_response = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, payment_method) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_employee_payment_method: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **payment_method** | [**PaymentMethod**](PaymentMethod.md)| | + +### Return type + +[**PaymentMethodObject**](PaymentMethodObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_employee_salary_and_wage** +> SalaryAndWageObject create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage) + +creates employee salary and wage record + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +salary_and_wage = { "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnitsPerWeek": 2, "ratePerUnit": 10, "numberOfUnitsPerDay": 2, "daysPerWeek": 1, "effectiveFrom": "2020-05-01", "annualSalary": 100, "status": "Active", "paymentType": "Salary" } # SalaryAndWage | +try: + # creates employee salary and wage record + api_response = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_employee_salary_and_wage: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **salary_and_wage** | [**SalaryAndWage**](SalaryAndWage.md)| | + +### Return type + +[**SalaryAndWageObject**](SalaryAndWageObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_employment** +> EmploymentObject create_employment(xero_tenant_id, employee_id, employment) + +creates employment + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +employment = { "payrollCalendarID": "9aa56064-990f-4ad3-a189-d966d8f6a030", "startDate": "2020-09-02" } # Employment | +try: + # creates employment + api_response = api_instance.create_employment(xero_tenant_id, employee_id, employment) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_employment: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **employment** | [**Employment**](Employment.md)| | + +### Return type + +[**EmploymentObject**](EmploymentObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_leave_type** +> LeaveTypeObject create_leave_type(xero_tenant_id, leave_type) + +create a new leave type + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +leave_type = { "name": "My wqwhhiktun Leave", "isPaidLeave": false, "showOnPayslip": true } # LeaveType | +try: + # create a new leave type + api_response = api_instance.create_leave_type(xero_tenant_id, leave_type) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_leave_type: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **leave_type** | [**LeaveType**](LeaveType.md)| | + +### Return type + +[**LeaveTypeObject**](LeaveTypeObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_multiple_employee_earnings_template** +> EmployeeEarningsTemplates create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) + +creates multiple employee earnings template records + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +earnings_template = [{"ratePerUnit":20.0,"numberOfUnits":8.0,"earningsRateID":"f9d8f5b5-9049-47f4-8541-35e200f750a5"},{"ratePerUnit":0.0,"numberOfUnits":8.0,"earningsRateID":"65b83d94-f20f-45e1-85ae-387fcf460c26"}] # list[EarningsTemplate] | +try: + # creates multiple employee earnings template records + api_response = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_multiple_employee_earnings_template: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **earnings_template** | [**list[EarningsTemplate]**](EarningsTemplate.md)| | + +### Return type + +[**EmployeeEarningsTemplates**](EmployeeEarningsTemplates.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_pay_run** +> PayRunObject create_pay_run(xero_tenant_id, pay_run) + +create a pay run + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +pay_run = { "payrollCalendarID": "9aa56064-990f-4ad3-a189-d966d8f6a030", "periodStartDate": "2020-09-08", "periodEndDate": "2020-09-15", "paymentDate": "2020-09-20", "payRunStatus": "Draft", "payRunType": "Scheduled", "calendarType": "Weekly" } # PayRun | +try: + # create a pay run + api_response = api_instance.create_pay_run(xero_tenant_id, pay_run) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_pay_run: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **pay_run** | [**PayRun**](PayRun.md)| | + +### Return type + +[**PayRunObject**](PayRunObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_pay_run_calendar** +> PayRunCalendarObject create_pay_run_calendar(xero_tenant_id, pay_run_calendar) + +create a new payrun calendar + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +pay_run_calendar = { "name": "My Weekly Cal", "calendarType": "Weekly", "periodStartDate": "2020-05-01", "paymentDate": "2020-05-15" } # PayRunCalendar | +try: + # create a new payrun calendar + api_response = api_instance.create_pay_run_calendar(xero_tenant_id, pay_run_calendar) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_pay_run_calendar: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **pay_run_calendar** | [**PayRunCalendar**](PayRunCalendar.md)| | + +### Return type + +[**PayRunCalendarObject**](PayRunCalendarObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_reimbursement** +> ReimbursementObject create_reimbursement(xero_tenant_id, reimbursement) + +create a new reimbursement + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +reimbursement = { "name": "My new Reimburse", "accountID": "fa5cdc43-643b-4ad8-b4ac-3ffe0d0f4488", "reimbursementCategory": "GSTInclusive", "calculationType": "FixedAmount" } # Reimbursement | +try: + # create a new reimbursement + api_response = api_instance.create_reimbursement(xero_tenant_id, reimbursement) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_reimbursement: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **reimbursement** | [**Reimbursement**](Reimbursement.md)| | + +### Return type + +[**ReimbursementObject**](ReimbursementObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_superannuation** +> SuperannuationObject create_superannuation(xero_tenant_id, benefit) + +create a new superannuation + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +benefit = { "name": "SidSaver", "category": "Other", "liabilityAccountId": "568f2e9a-0870-46cc-8678-f83f132ed4e3", "expenseAccountId": "e4eb36f6-97e3-4427-a394-dd4e1b355c2e", "CalculationTypeNZ": "FixedAmount", "standardAmount": 10 } # Benefit | +try: + # create a new superannuation + api_response = api_instance.create_superannuation(xero_tenant_id, benefit) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_superannuation: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **benefit** | [**Benefit**](Benefit.md)| | + +### Return type + +[**SuperannuationObject**](SuperannuationObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_timesheet** +> TimesheetObject create_timesheet(xero_tenant_id, timesheet) + +create a new timesheet + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet = { "payrollCalendarID": "9aa56064-990f-4ad3-a189-d966d8f6a030", "employeeID": "68342973-c405-4b86-b5d3-d7b877c27995", "startDate": "2020-04-13", "endDate": "2020-04-19", "timesheetLines": [ { "date": "2020-04-13", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 8 }, { "date": "2020-04-15", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 6 } ] } # Timesheet | +try: + # create a new timesheet + api_response = api_instance.create_timesheet(xero_tenant_id, timesheet) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet** | [**Timesheet**](Timesheet.md)| | + +### Return type + +[**TimesheetObject**](TimesheetObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_timesheet_line** +> TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line) + +create a new timesheet line + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +timesheet_line = { "date": "2020-08-03", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 1 } # TimesheetLine | +try: + # create a new timesheet line + api_response = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_timesheet_line: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)| | + +### Return type + +[**TimesheetLineObject**](TimesheetLineObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_employee_earnings_template** +> EarningsTemplateObject delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id) + +deletes an employee earnings template record + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object +try: + # deletes an employee earnings template record + api_response = api_instance.delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->delete_employee_earnings_template: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **pay_template_earning_id** | [**str**](.md)| Id for single pay template earnings object | + +### Return type + +[**EarningsTemplateObject**](EarningsTemplateObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_employee_leave** +> EmployeeLeaveObject delete_employee_leave(xero_tenant_id, employee_id, leave_id) + +deletes an employee leave record + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314' # str | Leave id for single object +try: + # deletes an employee leave record + api_response = api_instance.delete_employee_leave(xero_tenant_id, employee_id, leave_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->delete_employee_leave: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **leave_id** | [**str**](.md)| Leave id for single object | + +### Return type + +[**EmployeeLeaveObject**](EmployeeLeaveObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_employee_salary_and_wage** +> SalaryAndWageObject delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) + +deletes an employee salary and wages record + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single salary and wages object +try: + # deletes an employee salary and wages record + api_response = api_instance.delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->delete_employee_salary_and_wage: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **salary_and_wages_id** | [**str**](.md)| Id for single salary and wages object | + +### Return type + +[**SalaryAndWageObject**](SalaryAndWageObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_timesheet** +> TimesheetLine delete_timesheet(xero_tenant_id, timesheet_id) + +delete a timesheet + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +try: + # delete a timesheet + api_response = api_instance.delete_timesheet(xero_tenant_id, timesheet_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->delete_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + +### Return type + +[**TimesheetLine**](TimesheetLine.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_timesheet_line** +> TimesheetLine delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id) + +delete a timesheet line + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +timesheet_line_id = 'timesheet_line_id_example' # str | Identifier for the timesheet line +try: + # delete a timesheet line + api_response = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->delete_timesheet_line: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **timesheet_line_id** | [**str**](.md)| Identifier for the timesheet line | + +### Return type + +[**TimesheetLine**](TimesheetLine.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_deduction** +> DeductionObject get_deduction(xero_tenant_id, deduction_id) + +retrieve a single deduction by id + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +deduction_id = 'deduction_id_example' # str | Identifier for the deduction +try: + # retrieve a single deduction by id + api_response = api_instance.get_deduction(xero_tenant_id, deduction_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_deduction: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **deduction_id** | [**str**](.md)| Identifier for the deduction | + +### Return type + +[**DeductionObject**](DeductionObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_deductions** +> Deductions get_deductions(xero_tenant_id, page=page) + +searches deductions + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +try: + # searches deductions + api_response = api_instance.get_deductions(xero_tenant_id, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_deductions: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] + +### Return type + +[**Deductions**](Deductions.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_earnings_rate** +> EarningsRateObject get_earnings_rate(xero_tenant_id, earnings_rate_id) + +retrieve a single earnings rates by id + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +earnings_rate_id = 'earnings_rate_id_example' # str | Identifier for the earnings rate +try: + # retrieve a single earnings rates by id + api_response = api_instance.get_earnings_rate(xero_tenant_id, earnings_rate_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_earnings_rate: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **earnings_rate_id** | [**str**](.md)| Identifier for the earnings rate | + +### Return type + +[**EarningsRateObject**](EarningsRateObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_earnings_rates** +> EarningsRates get_earnings_rates(xero_tenant_id, page=page) + +searches earnings rates + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +try: + # searches earnings rates + api_response = api_instance.get_earnings_rates(xero_tenant_id, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_earnings_rates: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] + +### Return type + +[**EarningsRates**](EarningsRates.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_employee** +> EmployeeObject get_employee(xero_tenant_id, employee_id) + +searches employees + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +try: + # searches employees + api_response = api_instance.get_employee(xero_tenant_id, employee_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + +### Return type + +[**EmployeeObject**](EmployeeObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_employee_leave_balances** +> EmployeeLeaveBalances get_employee_leave_balances(xero_tenant_id, employee_id) + +search employee leave balances + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +try: + # search employee leave balances + api_response = api_instance.get_employee_leave_balances(xero_tenant_id, employee_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee_leave_balances: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + +### Return type + +[**EmployeeLeaveBalances**](EmployeeLeaveBalances.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_employee_leave_periods** +> LeavePeriods get_employee_leave_periods(xero_tenant_id, employee_id, start_date=start_date, end_date=end_date) + +searches employee leave periods + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +start_date = '2013-10-20' # date | Filter by start date (optional) +end_date = 'Johnson' # date | Filter by end date (optional) +try: + # searches employee leave periods + api_response = api_instance.get_employee_leave_periods(xero_tenant_id, employee_id, start_date=start_date, end_date=end_date) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee_leave_periods: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **start_date** | **date**| Filter by start date | [optional] + **end_date** | **date**| Filter by end date | [optional] + +### Return type + +[**LeavePeriods**](LeavePeriods.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_employee_leave_types** +> EmployeeLeaveTypes get_employee_leave_types(xero_tenant_id, employee_id) + +searches employee leave types + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +try: + # searches employee leave types + api_response = api_instance.get_employee_leave_types(xero_tenant_id, employee_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee_leave_types: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + +### Return type + +[**EmployeeLeaveTypes**](EmployeeLeaveTypes.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_employee_leaves** +> EmployeeLeaves get_employee_leaves(xero_tenant_id, employee_id) + +search employee leave records + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +try: + # search employee leave records + api_response = api_instance.get_employee_leaves(xero_tenant_id, employee_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee_leaves: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + +### Return type + +[**EmployeeLeaves**](EmployeeLeaves.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_employee_opening_balances** +> EmployeeOpeningBalancesObject get_employee_opening_balances(xero_tenant_id, employee_id) + +retrieve employee openingbalances + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +try: + # retrieve employee openingbalances + api_response = api_instance.get_employee_opening_balances(xero_tenant_id, employee_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee_opening_balances: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + +### Return type + +[**EmployeeOpeningBalancesObject**](EmployeeOpeningBalancesObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_employee_pay_templates** +> EmployeePayTemplates get_employee_pay_templates(xero_tenant_id, employee_id) + +searches employee pay templates + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +try: + # searches employee pay templates + api_response = api_instance.get_employee_pay_templates(xero_tenant_id, employee_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee_pay_templates: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + +### Return type + +[**EmployeePayTemplates**](EmployeePayTemplates.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_employee_payment_method** +> PaymentMethodObject get_employee_payment_method(xero_tenant_id, employee_id) + +retrieves an employee's payment method + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +try: + # retrieves an employee's payment method + api_response = api_instance.get_employee_payment_method(xero_tenant_id, employee_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee_payment_method: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + +### Return type + +[**PaymentMethodObject**](PaymentMethodObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_employee_salary_and_wage** +> SalaryAndWages get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) + +get employee salary and wages record by id + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object +try: + # get employee salary and wages record by id + api_response = api_instance.get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee_salary_and_wage: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **salary_and_wages_id** | [**str**](.md)| Id for single pay template earnings object | + +### Return type + +[**SalaryAndWages**](SalaryAndWages.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_employee_salary_and_wages** +> SalaryAndWages get_employee_salary_and_wages(xero_tenant_id, employee_id, page=page) + +retrieves an employee's salary and wages + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +try: + # retrieves an employee's salary and wages + api_response = api_instance.get_employee_salary_and_wages(xero_tenant_id, employee_id, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee_salary_and_wages: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] + +### Return type + +[**SalaryAndWages**](SalaryAndWages.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_employee_tax** +> EmployeeTaxObject get_employee_tax(xero_tenant_id, employee_id) + +searches tax records for an employee + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +try: + # searches tax records for an employee + api_response = api_instance.get_employee_tax(xero_tenant_id, employee_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee_tax: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + +### Return type + +[**EmployeeTaxObject**](EmployeeTaxObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_employees** +> Employees get_employees(xero_tenant_id, first_name=first_name, last_name=last_name, page=page) + +searches employees + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +first_name = 'John' # str | Filter by first name (optional) +last_name = 'Johnson' # str | Filter by last name (optional) +page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +try: + # searches employees + api_response = api_instance.get_employees(xero_tenant_id, first_name=first_name, last_name=last_name, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employees: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **first_name** | **str**| Filter by first name | [optional] + **last_name** | **str**| Filter by last name | [optional] + **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] + +### Return type + +[**Employees**](Employees.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_leave_type** +> LeaveTypeObject get_leave_type(xero_tenant_id, leave_type_id) + +retrieve a single leave type by id + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +leave_type_id = 'leave_type_id_example' # str | Identifier for the leave type +try: + # retrieve a single leave type by id + api_response = api_instance.get_leave_type(xero_tenant_id, leave_type_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_leave_type: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **leave_type_id** | [**str**](.md)| Identifier for the leave type | + +### Return type + +[**LeaveTypeObject**](LeaveTypeObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_leave_types** +> LeaveTypes get_leave_types(xero_tenant_id, page=page, active_only=active_only) + +searches leave types + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +active_only = True # bool | Filters leave types by active status. By default the API returns all leave types. (optional) +try: + # searches leave types + api_response = api_instance.get_leave_types(xero_tenant_id, page=page, active_only=active_only) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_leave_types: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] + **active_only** | **bool**| Filters leave types by active status. By default the API returns all leave types. | [optional] + +### Return type + +[**LeaveTypes**](LeaveTypes.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pay_run** +> PayRunObject get_pay_run(xero_tenant_id, pay_run_id) + +retrieve a single pay run by id + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +pay_run_id = 'pay_run_id_example' # str | Identifier for the pay run +try: + # retrieve a single pay run by id + api_response = api_instance.get_pay_run(xero_tenant_id, pay_run_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_pay_run: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **pay_run_id** | [**str**](.md)| Identifier for the pay run | + +### Return type + +[**PayRunObject**](PayRunObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pay_run_calendar** +> PayRunCalendarObject get_pay_run_calendar(xero_tenant_id, payroll_calendar_id) + +retrieve a single payrun calendar by id + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +payroll_calendar_id = 'payroll_calendar_id_example' # str | Identifier for the payrun calendars +try: + # retrieve a single payrun calendar by id + api_response = api_instance.get_pay_run_calendar(xero_tenant_id, payroll_calendar_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_pay_run_calendar: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **payroll_calendar_id** | [**str**](.md)| Identifier for the payrun calendars | + +### Return type + +[**PayRunCalendarObject**](PayRunCalendarObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pay_run_calendars** +> PayRunCalendars get_pay_run_calendars(xero_tenant_id, page=page) + +searches payrun calendars + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +try: + # searches payrun calendars + api_response = api_instance.get_pay_run_calendars(xero_tenant_id, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_pay_run_calendars: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] + +### Return type + +[**PayRunCalendars**](PayRunCalendars.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pay_runs** +> PayRuns get_pay_runs(xero_tenant_id, page=page, status=status) + +searches pay runs + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +status = 'status_example' # str | By default get payruns will return all the payruns for an organization. You can add GET https://api.xero.com/payroll.xro/2.0/payRuns?statu={PayRunStatus} to filter the payruns by status. (optional) +try: + # searches pay runs + api_response = api_instance.get_pay_runs(xero_tenant_id, page=page, status=status) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_pay_runs: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] + **status** | **str**| By default get payruns will return all the payruns for an organization. You can add GET https://api.xero.com/payroll.xro/2.0/payRuns?statu={PayRunStatus} to filter the payruns by status. | [optional] + +### Return type + +[**PayRuns**](PayRuns.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pay_slip** +> PaySlipObject get_pay_slip(xero_tenant_id, pay_slip_id) + +retrieve a single payslip by id + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +pay_slip_id = 'pay_slip_id_example' # str | Identifier for the payslip +try: + # retrieve a single payslip by id + api_response = api_instance.get_pay_slip(xero_tenant_id, pay_slip_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_pay_slip: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **pay_slip_id** | [**str**](.md)| Identifier for the payslip | + +### Return type + +[**PaySlipObject**](PaySlipObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pay_slips** +> PaySlips get_pay_slips(xero_tenant_id, pay_run_id, page=page) + +searches payslips + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +pay_run_id = 'pay_run_id_example' # str | PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun. +page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +try: + # searches payslips + api_response = api_instance.get_pay_slips(xero_tenant_id, pay_run_id, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_pay_slips: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **pay_run_id** | [**str**](.md)| PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun. | + **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] + +### Return type + +[**PaySlips**](PaySlips.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_reimbursement** +> ReimbursementObject get_reimbursement(xero_tenant_id, reimbursement_id) + +retrieve a single reimbursement by id + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +reimbursement_id = 'reimbursement_id_example' # str | Identifier for the reimbursement +try: + # retrieve a single reimbursement by id + api_response = api_instance.get_reimbursement(xero_tenant_id, reimbursement_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_reimbursement: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **reimbursement_id** | [**str**](.md)| Identifier for the reimbursement | + +### Return type + +[**ReimbursementObject**](ReimbursementObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_reimbursements** +> Reimbursements get_reimbursements(xero_tenant_id, page=page) + +searches reimbursements + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +try: + # searches reimbursements + api_response = api_instance.get_reimbursements(xero_tenant_id, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_reimbursements: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] + +### Return type + +[**Reimbursements**](Reimbursements.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_settings** +> Settings get_settings(xero_tenant_id) + +searches settings + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +try: + # searches settings + api_response = api_instance.get_settings(xero_tenant_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_settings: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + +### Return type + +[**Settings**](Settings.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_statutory_deduction** +> StatutoryDeductionObject get_statutory_deduction(xero_tenant_id, id) + +retrieve a single statutory deduction by id + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +id = 'id_example' # str | Identifier for the statutory deduction +try: + # retrieve a single statutory deduction by id + api_response = api_instance.get_statutory_deduction(xero_tenant_id, id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_statutory_deduction: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **id** | [**str**](.md)| Identifier for the statutory deduction | + +### Return type + +[**StatutoryDeductionObject**](StatutoryDeductionObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_statutory_deductions** +> StatutoryDeductions get_statutory_deductions(xero_tenant_id, page=page) + +searches statutory deductions + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +try: + # searches statutory deductions + api_response = api_instance.get_statutory_deductions(xero_tenant_id, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_statutory_deductions: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] + +### Return type + +[**StatutoryDeductions**](StatutoryDeductions.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_superannuation** +> SuperannuationObject get_superannuation(xero_tenant_id, superannuation_id) + +searches for a unique superannuation + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +superannuation_id = 'superannuation_id_example' # str | Identifier for the superannuation +try: + # searches for a unique superannuation + api_response = api_instance.get_superannuation(xero_tenant_id, superannuation_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_superannuation: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **superannuation_id** | [**str**](.md)| Identifier for the superannuation | + +### Return type + +[**SuperannuationObject**](SuperannuationObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_superannuations** +> Superannuations get_superannuations(xero_tenant_id, page=page) + +searches statutory deductions + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +try: + # searches statutory deductions + api_response = api_instance.get_superannuations(xero_tenant_id, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_superannuations: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] + +### Return type + +[**Superannuations**](Superannuations.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_timesheet** +> TimesheetObject get_timesheet(xero_tenant_id, timesheet_id) + +retrieve a single timesheet by id + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +try: + # retrieve a single timesheet by id + api_response = api_instance.get_timesheet(xero_tenant_id, timesheet_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + +### Return type + +[**TimesheetObject**](TimesheetObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_timesheets** +> Timesheets get_timesheets(xero_tenant_id, page=page, employee_id=employee_id, payroll_calendar_id=payroll_calendar_id) + +searches timesheets + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +employee_id = 'employee_id_example' # str | By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeId} to get only the timesheets of a particular employee. (optional) +payroll_calendar_id = 'payroll_calendar_id_example' # str | By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id (optional) +try: + # searches timesheets + api_response = api_instance.get_timesheets(xero_tenant_id, page=page, employee_id=employee_id, payroll_calendar_id=payroll_calendar_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_timesheets: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] + **employee_id** | [**str**](.md)| By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeId} to get only the timesheets of a particular employee. | [optional] + **payroll_calendar_id** | [**str**](.md)| By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id | [optional] + +### Return type + +[**Timesheets**](Timesheets.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_tracking_categories** +> TrackingCategories get_tracking_categories(xero_tenant_id) + +searches tracking categories + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +try: + # searches tracking categories + api_response = api_instance.get_tracking_categories(xero_tenant_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_tracking_categories: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + +### Return type + +[**TrackingCategories**](TrackingCategories.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **revert_timesheet** +> TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id) + +revert a timesheet to draft + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +try: + # revert a timesheet to draft + api_response = api_instance.revert_timesheet(xero_tenant_id, timesheet_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->revert_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + +### Return type + +[**TimesheetObject**](TimesheetObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_employee** +> EmployeeObject update_employee(xero_tenant_id, employee_id, employee) + +updates employee + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +employee = { "title": "Mr", "firstName": "Tony", "lastName": "Starkgtrzgquusrson", "dateOfBirth": "1999-01-01", "address": { "addressLine1": "101 Green St", "city": "San Francisco", "postCode": "4432", "countryName": "United Kingdom" }, "email": "58315@starkindustries.com", "gender": "M" } # Employee | +try: + # updates employee + api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->update_employee: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **employee** | [**Employee**](Employee.md)| | + +### Return type + +[**EmployeeObject**](EmployeeObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_employee_earnings_template** +> EarningsTemplateObject update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template) + +updates employee earnings template records + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object +earnings_template = { "ratePerUnit": 25, "numberOfUnits": 4, "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5" } # EarningsTemplate | +try: + # updates employee earnings template records + api_response = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->update_employee_earnings_template: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **pay_template_earning_id** | [**str**](.md)| Id for single pay template earnings object | + **earnings_template** | [**EarningsTemplate**](EarningsTemplate.md)| | + +### Return type + +[**EarningsTemplateObject**](EarningsTemplateObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_employee_leave** +> EmployeeLeaveObject update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave) + +updates employee leave records + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314' # str | Leave id for single object +employee_leave = { "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4", "description": "Creating a Desription", "startDate": "2020-04-24", "endDate": "2020-04-26", "periods": [ { "periodStartDate": "2020-04-20", "periodEndDate": "2020-04-26", "numberOfUnits": 1, "periodStatus": "Approved" } ] } # EmployeeLeave | +try: + # updates employee leave records + api_response = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->update_employee_leave: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **leave_id** | [**str**](.md)| Leave id for single object | + **employee_leave** | [**EmployeeLeave**](EmployeeLeave.md)| | + +### Return type + +[**EmployeeLeaveObject**](EmployeeLeaveObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_employee_salary_and_wage** +> SalaryAndWageObject update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage) + +updates employee salary and wages record + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object +salary_and_wage = { "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnitsPerWeek": 3, "ratePerUnit": 11, "numberOfUnitsPerDay": 3, "daysPerWeek": 1, "effectiveFrom": "2020-05-15", "annualSalary": 101, "status": "Active", "paymentType": "Salary" } # SalaryAndWage | +try: + # updates employee salary and wages record + api_response = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->update_employee_salary_and_wage: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **salary_and_wages_id** | [**str**](.md)| Id for single pay template earnings object | + **salary_and_wage** | [**SalaryAndWage**](SalaryAndWage.md)| | + +### Return type + +[**SalaryAndWageObject**](SalaryAndWageObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_employee_tax** +> EmployeeTaxObject update_employee_tax(xero_tenant_id, employee_id, employee_tax) + +updates the tax records for an employee + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +employee_tax = xero_python.payrollnz.EmployeeTax() # EmployeeTax | +try: + # updates the tax records for an employee + api_response = api_instance.update_employee_tax(xero_tenant_id, employee_id, employee_tax) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->update_employee_tax: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **employee_tax** | [**EmployeeTax**](EmployeeTax.md)| | + +### Return type + +[**EmployeeTaxObject**](EmployeeTaxObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_pay_run** +> PayRunObject update_pay_run(xero_tenant_id, pay_run_id, pay_run) + +update a pay run + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +pay_run_id = 'pay_run_id_example' # str | Identifier for the pay run +pay_run = { "paymentDate": "2019-07-01" } # PayRun | +try: + # update a pay run + api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->update_pay_run: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **pay_run_id** | [**str**](.md)| Identifier for the pay run | + **pay_run** | [**PayRun**](PayRun.md)| | + +### Return type + +[**PayRunObject**](PayRunObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_pay_slip_line_items** +> PaySlipObject update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip) + +creates employee pay slip + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +pay_slip_id = 'pay_slip_id_example' # str | Identifier for the payslip +pay_slip = { "earningsLines": [ { "earningsLineID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "displayName": "Ordinary Time", "ratePerUnit": 25, "numberOfUnits": 0, "amount": 0, "isLinkedToTimesheet": false, "isSystemGenerated": true }, { "earningsLineID": "65b83d94-f20f-45e1-85ae-387fcf460c26", "earningsRateID": "65b83d94-f20f-45e1-85ae-387fcf460c26", "displayName": "Salary", "ratePerUnit": 0, "numberOfUnits": 8, "amount": 0, "isLinkedToTimesheet": false, "isSystemGenerated": false } ], "leaveEarningsLines": [ { "earningsLineID": "0441497f-5dc7-4cd3-a90d-f2e07e21b2a6", "earningsRateID": "39b3560a-5d2f-4538-924a-4349dc86396e", "displayName": "Holiday Pay", "fixedAmount": 268.8, "amount": 268.8, "isLinkedToTimesheet": false, "isSystemGenerated": true } ], "deductionLines": [ { "deductionTypeID": "a3760fe4-68a4-4e38-8326-fe616af7dc74", "amount": 100 } ], "leaveAccrualLines": [ { "leaveTypeID": "0441497f-5dc7-4cd3-a90d-f2e07e21b2a6", "numberOfUnits": 268.8 }, { "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4", "numberOfUnits": 0 }, { "leaveTypeID": "f2f994cf-1899-46f3-ad4f-5d92d78c3719", "numberOfUnits": 0 }, { "leaveTypeID": "34129765-11cb-4d8c-b568-84a2219beda3", "numberOfUnits": 0 } ], "superannuationLines": [ { "superannuationTypeID": "563273ea-0dae-4f82-86a4-e0db77c008ea", "displayName": "KiwiSaver", "amount": 108.86, "fixedAmount": 3, "percentage": 3, "manualAdjustment": false } ], "employeeTaxLines": [ { "taxLineID": "1084146b-e890-489c-aed3-06de80f63d84", "amount": 1057.22, "globalTaxTypeID": "11", "manualAdjustment": false } ], "employerTaxLines": [ { "taxLineID": "6f9eb8cd-0f4a-440b-939c-bdb0f6ad694c", "amount": 18.9, "globalTaxTypeID": "10", "manualAdjustment": false } ], "statutoryDeductionLines": [ { "statutoryDeductionTypeID": "b5efd8d1-0c93-4a14-a314-b5cba4a4e6b3", "amount": 108.86 } ], "grossEarningsHistory": { "daysPaid": 3, "unpaidWeeks": 0 } } # PaySlip | +try: + # creates employee pay slip + api_response = api_instance.update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->update_pay_slip_line_items: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **pay_slip_id** | [**str**](.md)| Identifier for the payslip | + **pay_slip** | [**PaySlip**](PaySlip.md)| | + +### Return type + +[**PaySlipObject**](PaySlipObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_timesheet_line** +> TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line) + +update a timesheet line + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +timesheet_line_id = 'timesheet_line_id_example' # str | Identifier for the timesheet line +timesheet_line = { "date": "2020-08-04", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 2 } # TimesheetLine | +try: + # update a timesheet line + api_response = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->update_timesheet_line: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **timesheet_line_id** | [**str**](.md)| Identifier for the timesheet line | + **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)| | + +### Return type + +[**TimesheetLineObject**](TimesheetLineObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/xero_python/payrollnz/docs/Problem.md b/xero_python/payrollnz/docs/Problem.md new file mode 100644 index 00000000..edbdda5b --- /dev/null +++ b/xero_python/payrollnz/docs/Problem.md @@ -0,0 +1,15 @@ +# Problem + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The type of error format | [optional] +**title** | **str** | The type of the error | [optional] +**status** | **str** | The error status code | [optional] +**detail** | **str** | A description of the error | [optional] +**instance** | **str** | | [optional] +**invalid_fields** | [**list[InvalidField]**](InvalidField.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/Reimbursement.md b/xero_python/payrollnz/docs/Reimbursement.md new file mode 100644 index 00000000..810a2666 --- /dev/null +++ b/xero_python/payrollnz/docs/Reimbursement.md @@ -0,0 +1,18 @@ +# Reimbursement + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reimbursement_id** | **str** | Xero unique identifier for a reimbursement | [optional] +**name** | **str** | Name of the reimbursement | +**account_id** | **str** | Xero unique identifier for the account used for the reimbursement | +**current_record** | **bool** | Indicates that whether the reimbursement is active | [optional] +**reimbursement_category** | **str** | See Reimbursement Categories | [optional] +**calculation_type** | **str** | See Calculation Types | [optional] +**standard_amount** | **str** | Optional Fixed Rate Amount. Applicable when calculation type is Fixed Amount | [optional] +**standard_type_of_units** | **str** | Optional Type Of Units. Applicable when calculation type is Rate Per Unit | [optional] +**standard_rate_per_unit** | **float** | Optional Rate Per Unit. Applicable when calculation type is Rate Per Unit | [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) + + diff --git a/xero_python/payrollnz/docs/ReimbursementLine.md b/xero_python/payrollnz/docs/ReimbursementLine.md new file mode 100644 index 00000000..8457e971 --- /dev/null +++ b/xero_python/payrollnz/docs/ReimbursementLine.md @@ -0,0 +1,14 @@ +# ReimbursementLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reimbursement_type_id** | **str** | Xero identifier for payroll reimbursement | [optional] +**description** | **str** | Reimbursement line description | [optional] +**amount** | **float** | Reimbursement amount | [optional] +**rate_per_unit** | **float** | Rate per unit for leave earnings line | [optional] +**number_of_units** | **float** | Leave earnings number of units | [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) + + diff --git a/xero_python/payrollnz/docs/ReimbursementObject.md b/xero_python/payrollnz/docs/ReimbursementObject.md new file mode 100644 index 00000000..f8276fb8 --- /dev/null +++ b/xero_python/payrollnz/docs/ReimbursementObject.md @@ -0,0 +1,12 @@ +# ReimbursementObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**reimbursement** | [**Reimbursement**](Reimbursement.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/Reimbursements.md b/xero_python/payrollnz/docs/Reimbursements.md new file mode 100644 index 00000000..ccf18f79 --- /dev/null +++ b/xero_python/payrollnz/docs/Reimbursements.md @@ -0,0 +1,12 @@ +# Reimbursements + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**reimbursements** | [**list[Reimbursement]**](Reimbursement.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/SalaryAndWage.md b/xero_python/payrollnz/docs/SalaryAndWage.md new file mode 100644 index 00000000..f337f519 --- /dev/null +++ b/xero_python/payrollnz/docs/SalaryAndWage.md @@ -0,0 +1,19 @@ +# SalaryAndWage + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**salary_and_wages_id** | **str** | Xero unique identifier for a salary and wages record | [optional] +**earnings_rate_id** | **str** | Xero unique identifier for an earnings rate | +**number_of_units_per_week** | **float** | The Number of Units per week for the corresponding salary and wages | +**rate_per_unit** | **float** | The rate of each unit for the corresponding salary and wages | [optional] +**number_of_units_per_day** | **float** | The Number of Units per day for the corresponding salary and wages | +**days_per_week** | **int** | The days per week for the salary. | [optional] +**effective_from** | **date** | The effective date of the corresponding salary and wages | +**annual_salary** | **float** | The annual salary | +**status** | **str** | The current status of the corresponding salary and wages | +**payment_type** | **str** | The type of the payment of the corresponding salary and wages | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/docs/SalaryAndWageObject.md b/xero_python/payrollnz/docs/SalaryAndWageObject.md new file mode 100644 index 00000000..2aaf607b --- /dev/null +++ b/xero_python/payrollnz/docs/SalaryAndWageObject.md @@ -0,0 +1,12 @@ +# SalaryAndWageObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**salary_and_wages** | [**SalaryAndWage**](SalaryAndWage.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/SalaryAndWages.md b/xero_python/payrollnz/docs/SalaryAndWages.md new file mode 100644 index 00000000..b5c8fa0b --- /dev/null +++ b/xero_python/payrollnz/docs/SalaryAndWages.md @@ -0,0 +1,12 @@ +# SalaryAndWages + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**salary_and_wages** | [**list[SalaryAndWage]**](SalaryAndWage.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/Settings.md b/xero_python/payrollnz/docs/Settings.md new file mode 100644 index 00000000..da7d9d1b --- /dev/null +++ b/xero_python/payrollnz/docs/Settings.md @@ -0,0 +1,12 @@ +# Settings + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**settings** | [**Accounts**](Accounts.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/StatutoryDeduction.md b/xero_python/payrollnz/docs/StatutoryDeduction.md new file mode 100644 index 00000000..43730c6d --- /dev/null +++ b/xero_python/payrollnz/docs/StatutoryDeduction.md @@ -0,0 +1,14 @@ +# StatutoryDeduction + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The Xero identifier for earnings order | [optional] +**name** | **str** | Name of the earnings order | [optional] +**statutory_deduction_category** | [**StatutoryDeductionCategory**](StatutoryDeductionCategory.md) | | [optional] +**liability_account_id** | **str** | Xero identifier for Liability Account | [optional] +**current_record** | **bool** | Identifier of a record is active or not. | [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) + + diff --git a/xero_python/payrollnz/docs/StatutoryDeductionCategory.md b/xero_python/payrollnz/docs/StatutoryDeductionCategory.md new file mode 100644 index 00000000..d018e088 --- /dev/null +++ b/xero_python/payrollnz/docs/StatutoryDeductionCategory.md @@ -0,0 +1,9 @@ +# StatutoryDeductionCategory + +## 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) + + diff --git a/xero_python/payrollnz/docs/StatutoryDeductionLine.md b/xero_python/payrollnz/docs/StatutoryDeductionLine.md new file mode 100644 index 00000000..33cc5bc8 --- /dev/null +++ b/xero_python/payrollnz/docs/StatutoryDeductionLine.md @@ -0,0 +1,13 @@ +# StatutoryDeductionLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**statutory_deduction_type_id** | **str** | Xero identifier for payroll statutory deduction type | [optional] +**amount** | **float** | The amount of the statutory deduction line | [optional] +**fixed_amount** | **float** | Fixed Amount | [optional] +**manual_adjustment** | **bool** | Identifies if the tax line is a manual adjustment | [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) + + diff --git a/xero_python/payrollnz/docs/StatutoryDeductionObject.md b/xero_python/payrollnz/docs/StatutoryDeductionObject.md new file mode 100644 index 00000000..b337735e --- /dev/null +++ b/xero_python/payrollnz/docs/StatutoryDeductionObject.md @@ -0,0 +1,12 @@ +# StatutoryDeductionObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**statutory_deduction** | [**StatutoryDeduction**](StatutoryDeduction.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/StatutoryDeductions.md b/xero_python/payrollnz/docs/StatutoryDeductions.md new file mode 100644 index 00000000..82ff30fd --- /dev/null +++ b/xero_python/payrollnz/docs/StatutoryDeductions.md @@ -0,0 +1,12 @@ +# StatutoryDeductions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**statutory_deductions** | [**list[StatutoryDeduction]**](StatutoryDeduction.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/SuperannuationLine.md b/xero_python/payrollnz/docs/SuperannuationLine.md new file mode 100644 index 00000000..404c88ee --- /dev/null +++ b/xero_python/payrollnz/docs/SuperannuationLine.md @@ -0,0 +1,15 @@ +# SuperannuationLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**superannuation_type_id** | **str** | Xero identifier for payroll superannucation type | [optional] +**display_name** | **str** | Benefit display name | [optional] +**amount** | **float** | The amount of the superannuation line | [optional] +**fixed_amount** | **float** | Superannuation fixed amount | [optional] +**percentage** | **float** | Superannuation rate percentage | [optional] +**manual_adjustment** | **bool** | manual adjustment made | [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) + + diff --git a/xero_python/payrollnz/docs/SuperannuationObject.md b/xero_python/payrollnz/docs/SuperannuationObject.md new file mode 100644 index 00000000..93ab3bd7 --- /dev/null +++ b/xero_python/payrollnz/docs/SuperannuationObject.md @@ -0,0 +1,12 @@ +# SuperannuationObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**benefit** | [**Benefit**](Benefit.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/Superannuations.md b/xero_python/payrollnz/docs/Superannuations.md new file mode 100644 index 00000000..cd531a37 --- /dev/null +++ b/xero_python/payrollnz/docs/Superannuations.md @@ -0,0 +1,12 @@ +# Superannuations + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**benefits** | [**list[Benefit]**](Benefit.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/TaxCode.md b/xero_python/payrollnz/docs/TaxCode.md new file mode 100644 index 00000000..f82a0851 --- /dev/null +++ b/xero_python/payrollnz/docs/TaxCode.md @@ -0,0 +1,9 @@ +# TaxCode + +## 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) + + diff --git a/xero_python/payrollnz/docs/TaxLine.md b/xero_python/payrollnz/docs/TaxLine.md new file mode 100644 index 00000000..b35e12c8 --- /dev/null +++ b/xero_python/payrollnz/docs/TaxLine.md @@ -0,0 +1,14 @@ +# TaxLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tax_line_id** | **str** | Xero identifier for payroll tax line | [optional] +**description** | **str** | Tax line description | [optional] +**amount** | **float** | The amount of the tax line | [optional] +**global_tax_type_id** | **str** | Tax type ID | [optional] +**manual_adjustment** | **bool** | Identifies if the tax line is a manual adjustment | [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) + + diff --git a/xero_python/payrollnz/docs/TaxSettings.md b/xero_python/payrollnz/docs/TaxSettings.md new file mode 100644 index 00000000..c0da22e7 --- /dev/null +++ b/xero_python/payrollnz/docs/TaxSettings.md @@ -0,0 +1,15 @@ +# TaxSettings + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**period_units** | **int** | The number of units for the period type | [optional] +**period_type** | **str** | The type of period (\"weeks\" or \"months\") | [optional] +**tax_code** | [**TaxCode**](TaxCode.md) | | [optional] +**special_tax_rate** | **str** | Tax rate for STC and WT | [optional] +**lump_sum_tax_code** | **str** | Tax code for a lump sum amount | [optional] +**lump_sum_amount** | **str** | The total of the lump sum amount | [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) + + diff --git a/xero_python/payrollnz/docs/Timesheet.md b/xero_python/payrollnz/docs/Timesheet.md new file mode 100644 index 00000000..5c21ef69 --- /dev/null +++ b/xero_python/payrollnz/docs/Timesheet.md @@ -0,0 +1,18 @@ +# Timesheet + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**timesheet_id** | **str** | The Xero identifier for a Timesheet | [optional] +**payroll_calendar_id** | **str** | The Xero identifier for the Payroll Calandar that the Timesheet applies to | +**employee_id** | **str** | The Xero identifier for the Employee that the Timesheet is for | +**start_date** | **date** | The Start Date of the Timesheet period (YYYY-MM-DD) | +**end_date** | **date** | The End Date of the Timesheet period (YYYY-MM-DD) | +**status** | **str** | Status of the timesheet | [optional] +**total_hours** | **float** | The Total Hours of the Timesheet | [optional] +**updated_date_utc** | **datetime** | The UTC date time that the Timesheet was last updated | [optional] +**timesheet_lines** | [**list[TimesheetLine]**](TimesheetLine.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/TimesheetEarningsLine.md b/xero_python/payrollnz/docs/TimesheetEarningsLine.md new file mode 100644 index 00000000..09c6e986 --- /dev/null +++ b/xero_python/payrollnz/docs/TimesheetEarningsLine.md @@ -0,0 +1,19 @@ +# TimesheetEarningsLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**earnings_line_id** | **str** | Xero identifier for payroll earnings line | [optional] +**earnings_rate_id** | **str** | Xero identifier for payroll leave earnings rate | [optional] +**display_name** | **str** | name of earnings rate for display in UI | [optional] +**rate_per_unit** | **float** | Rate per unit for leave earnings line | [optional] +**number_of_units** | **float** | Leave earnings number of units | [optional] +**fixed_amount** | **float** | Leave earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed | [optional] +**amount** | **float** | The amount of the earnings line. | [optional] +**is_linked_to_timesheet** | **bool** | Identifies if the leave earnings is taken from the timesheet. False for leave earnings line | [optional] +**is_average_daily_pay_rate** | **bool** | Identifies if the earnings is using an average daily pay rate | [optional] +**is_system_generated** | **bool** | Flag to indentify whether the earnings line is system generated or not. | [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) + + diff --git a/xero_python/payrollnz/docs/TimesheetLine.md b/xero_python/payrollnz/docs/TimesheetLine.md new file mode 100644 index 00000000..c5124b94 --- /dev/null +++ b/xero_python/payrollnz/docs/TimesheetLine.md @@ -0,0 +1,14 @@ +# TimesheetLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**timesheet_line_id** | **str** | The Xero identifier for a Timesheet Line | [optional] +**date** | **date** | The Date that this Timesheet Line is for (YYYY-MM-DD) | +**earnings_rate_id** | **str** | The Xero identifier for the Earnings Rate that the Timesheet is for | +**tracking_item_id** | **str** | The Xero identifier for the Tracking Item that the Timesheet is for | [optional] +**number_of_units** | **float** | The Number of Units of the Timesheet Line | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/docs/TimesheetLineObject.md b/xero_python/payrollnz/docs/TimesheetLineObject.md new file mode 100644 index 00000000..a6d06d1e --- /dev/null +++ b/xero_python/payrollnz/docs/TimesheetLineObject.md @@ -0,0 +1,12 @@ +# TimesheetLineObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**timesheet_line** | [**TimesheetLine**](TimesheetLine.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/TimesheetObject.md b/xero_python/payrollnz/docs/TimesheetObject.md new file mode 100644 index 00000000..4ab9cc40 --- /dev/null +++ b/xero_python/payrollnz/docs/TimesheetObject.md @@ -0,0 +1,12 @@ +# TimesheetObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**timesheet** | [**Timesheet**](Timesheet.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/Timesheets.md b/xero_python/payrollnz/docs/Timesheets.md new file mode 100644 index 00000000..ae42a3b6 --- /dev/null +++ b/xero_python/payrollnz/docs/Timesheets.md @@ -0,0 +1,12 @@ +# Timesheets + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**timesheets** | [**list[Timesheet]**](Timesheet.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/TrackingCategories.md b/xero_python/payrollnz/docs/TrackingCategories.md new file mode 100644 index 00000000..72b557aa --- /dev/null +++ b/xero_python/payrollnz/docs/TrackingCategories.md @@ -0,0 +1,12 @@ +# TrackingCategories + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**tracking_categories** | [**TrackingCategory**](TrackingCategory.md) | | [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) + + diff --git a/xero_python/payrollnz/docs/TrackingCategory.md b/xero_python/payrollnz/docs/TrackingCategory.md new file mode 100644 index 00000000..4a3350c5 --- /dev/null +++ b/xero_python/payrollnz/docs/TrackingCategory.md @@ -0,0 +1,11 @@ +# TrackingCategory + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee_groups_tracking_category_id** | **str** | The Xero identifier for Employee groups tracking category. | [optional] +**timesheet_tracking_category_id** | **str** | The Xero identifier for Timesheet tracking category. | [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) + + diff --git a/xero_python/payrollnz/models/__init__.py b/xero_python/payrollnz/models/__init__.py new file mode 100644 index 00000000..9154cd62 --- /dev/null +++ b/xero_python/payrollnz/models/__init__.py @@ -0,0 +1,141 @@ +# coding: utf-8 + +# flake8: noqa +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +# import models into model package +from xero_python.payrollnz.models.account import Account +from xero_python.payrollnz.models.accounts import Accounts +from xero_python.payrollnz.models.address import Address +from xero_python.payrollnz.models.bank_account import BankAccount +from xero_python.payrollnz.models.benefit import Benefit +from xero_python.payrollnz.models.deduction import Deduction +from xero_python.payrollnz.models.deduction_line import DeductionLine +from xero_python.payrollnz.models.deduction_object import DeductionObject +from xero_python.payrollnz.models.deductions import Deductions +from xero_python.payrollnz.models.earnings_line import EarningsLine +from xero_python.payrollnz.models.earnings_order import EarningsOrder +from xero_python.payrollnz.models.earnings_order_object import EarningsOrderObject +from xero_python.payrollnz.models.earnings_orders import EarningsOrders +from xero_python.payrollnz.models.earnings_rate import EarningsRate +from xero_python.payrollnz.models.earnings_rate_object import EarningsRateObject +from xero_python.payrollnz.models.earnings_rates import EarningsRates +from xero_python.payrollnz.models.earnings_template import EarningsTemplate +from xero_python.payrollnz.models.earnings_template_object import EarningsTemplateObject +from xero_python.payrollnz.models.employee import Employee +from xero_python.payrollnz.models.employee_earnings_templates import ( + EmployeeEarningsTemplates, +) +from xero_python.payrollnz.models.employee_leave import EmployeeLeave +from xero_python.payrollnz.models.employee_leave_balance import EmployeeLeaveBalance +from xero_python.payrollnz.models.employee_leave_balances import EmployeeLeaveBalances +from xero_python.payrollnz.models.employee_leave_object import EmployeeLeaveObject +from xero_python.payrollnz.models.employee_leave_setup import EmployeeLeaveSetup +from xero_python.payrollnz.models.employee_leave_setup_object import ( + EmployeeLeaveSetupObject, +) +from xero_python.payrollnz.models.employee_leave_type import EmployeeLeaveType +from xero_python.payrollnz.models.employee_leave_type_object import ( + EmployeeLeaveTypeObject, +) +from xero_python.payrollnz.models.employee_leave_types import EmployeeLeaveTypes +from xero_python.payrollnz.models.employee_leaves import EmployeeLeaves +from xero_python.payrollnz.models.employee_object import EmployeeObject +from xero_python.payrollnz.models.employee_opening_balance import EmployeeOpeningBalance +from xero_python.payrollnz.models.employee_opening_balances_object import ( + EmployeeOpeningBalancesObject, +) +from xero_python.payrollnz.models.employee_pay_template import EmployeePayTemplate +from xero_python.payrollnz.models.employee_pay_template_object import ( + EmployeePayTemplateObject, +) +from xero_python.payrollnz.models.employee_pay_templates import EmployeePayTemplates +from xero_python.payrollnz.models.employee_statutory_leave_balance import ( + EmployeeStatutoryLeaveBalance, +) +from xero_python.payrollnz.models.employee_statutory_leave_balance_object import ( + EmployeeStatutoryLeaveBalanceObject, +) +from xero_python.payrollnz.models.employee_statutory_leave_summary import ( + EmployeeStatutoryLeaveSummary, +) +from xero_python.payrollnz.models.employee_statutory_leaves_summaries import ( + EmployeeStatutoryLeavesSummaries, +) +from xero_python.payrollnz.models.employee_statutory_sick_leave import ( + EmployeeStatutorySickLeave, +) +from xero_python.payrollnz.models.employee_statutory_sick_leave_object import ( + EmployeeStatutorySickLeaveObject, +) +from xero_python.payrollnz.models.employee_statutory_sick_leaves import ( + EmployeeStatutorySickLeaves, +) +from xero_python.payrollnz.models.employee_tax import EmployeeTax +from xero_python.payrollnz.models.employee_tax_object import EmployeeTaxObject +from xero_python.payrollnz.models.employees import Employees +from xero_python.payrollnz.models.employment import Employment +from xero_python.payrollnz.models.employment_object import EmploymentObject +from xero_python.payrollnz.models.gross_earnings_history import GrossEarningsHistory +from xero_python.payrollnz.models.invalid_field import InvalidField +from xero_python.payrollnz.models.leave_accrual_line import LeaveAccrualLine +from xero_python.payrollnz.models.leave_earnings_line import LeaveEarningsLine +from xero_python.payrollnz.models.leave_period import LeavePeriod +from xero_python.payrollnz.models.leave_periods import LeavePeriods +from xero_python.payrollnz.models.leave_type import LeaveType +from xero_python.payrollnz.models.leave_type_object import LeaveTypeObject +from xero_python.payrollnz.models.leave_types import LeaveTypes +from xero_python.payrollnz.models.pagination import Pagination +from xero_python.payrollnz.models.pay_run import PayRun +from xero_python.payrollnz.models.pay_run_calendar import PayRunCalendar +from xero_python.payrollnz.models.pay_run_calendar_object import PayRunCalendarObject +from xero_python.payrollnz.models.pay_run_calendars import PayRunCalendars +from xero_python.payrollnz.models.pay_run_object import PayRunObject +from xero_python.payrollnz.models.pay_runs import PayRuns +from xero_python.payrollnz.models.pay_slip import PaySlip +from xero_python.payrollnz.models.pay_slip_object import PaySlipObject +from xero_python.payrollnz.models.pay_slips import PaySlips +from xero_python.payrollnz.models.payment_line import PaymentLine +from xero_python.payrollnz.models.payment_method import PaymentMethod +from xero_python.payrollnz.models.payment_method_object import PaymentMethodObject +from xero_python.payrollnz.models.problem import Problem +from xero_python.payrollnz.models.reimbursement import Reimbursement +from xero_python.payrollnz.models.reimbursement_line import ReimbursementLine +from xero_python.payrollnz.models.reimbursement_object import ReimbursementObject +from xero_python.payrollnz.models.reimbursements import Reimbursements +from xero_python.payrollnz.models.salary_and_wage import SalaryAndWage +from xero_python.payrollnz.models.salary_and_wage_object import SalaryAndWageObject +from xero_python.payrollnz.models.salary_and_wages import SalaryAndWages +from xero_python.payrollnz.models.settings import Settings +from xero_python.payrollnz.models.statutory_deduction import StatutoryDeduction +from xero_python.payrollnz.models.statutory_deduction_category import ( + StatutoryDeductionCategory, +) +from xero_python.payrollnz.models.statutory_deduction_line import StatutoryDeductionLine +from xero_python.payrollnz.models.statutory_deduction_object import ( + StatutoryDeductionObject, +) +from xero_python.payrollnz.models.statutory_deductions import StatutoryDeductions +from xero_python.payrollnz.models.superannuation_line import SuperannuationLine +from xero_python.payrollnz.models.superannuation_object import SuperannuationObject +from xero_python.payrollnz.models.superannuations import Superannuations +from xero_python.payrollnz.models.tax_code import TaxCode +from xero_python.payrollnz.models.tax_line import TaxLine +from xero_python.payrollnz.models.tax_settings import TaxSettings +from xero_python.payrollnz.models.timesheet import Timesheet +from xero_python.payrollnz.models.timesheet_earnings_line import TimesheetEarningsLine +from xero_python.payrollnz.models.timesheet_line import TimesheetLine +from xero_python.payrollnz.models.timesheet_line_object import TimesheetLineObject +from xero_python.payrollnz.models.timesheet_object import TimesheetObject +from xero_python.payrollnz.models.timesheets import Timesheets +from xero_python.payrollnz.models.tracking_categories import TrackingCategories +from xero_python.payrollnz.models.tracking_category import TrackingCategory diff --git a/xero_python/payrollnz/models/account.py b/xero_python/payrollnz/models/account.py new file mode 100644 index 00000000..d0aaacac --- /dev/null +++ b/xero_python/payrollnz/models/account.py @@ -0,0 +1,163 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Account(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"account_id": "str", "type": "str", "code": "str", "name": "str"} + + attribute_map = { + "account_id": "accountID", + "type": "type", + "code": "code", + "name": "name", + } + + def __init__(self, account_id=None, type=None, code=None, name=None): # noqa: E501 + """Account - a model defined in OpenAPI""" # noqa: E501 + + self._account_id = None + self._type = None + self._code = None + self._name = None + self.discriminator = None + + if account_id is not None: + self.account_id = account_id + if type is not None: + self.type = type + if code is not None: + self.code = code + if name is not None: + self.name = name + + @property + def account_id(self): + """Gets the account_id of this Account. # noqa: E501 + + The Xero identifier for Settings. # noqa: E501 + + :return: The account_id of this Account. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this Account. + + The Xero identifier for Settings. # noqa: E501 + + :param account_id: The account_id of this Account. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def type(self): + """Gets the type of this Account. # noqa: E501 + + The assigned AccountType # noqa: E501 + + :return: The type of this Account. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this Account. + + The assigned AccountType # noqa: E501 + + :param type: The type of this Account. # noqa: E501 + :type: str + """ + allowed_values = [ + "PAYELIABILITY", + "WAGESPAYABLE", + "WAGESEXPENSE", + "BANK", + "None", + ] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}".format( # noqa: E501 + type, allowed_values + ) + ) + + self._type = type + + @property + def code(self): + """Gets the code of this Account. # noqa: E501 + + A unique 3 digit number for each Account # noqa: E501 + + :return: The code of this Account. # noqa: E501 + :rtype: str + """ + return self._code + + @code.setter + def code(self, code): + """Sets the code of this Account. + + A unique 3 digit number for each Account # noqa: E501 + + :param code: The code of this Account. # noqa: E501 + :type: str + """ + + self._code = code + + @property + def name(self): + """Gets the name of this Account. # noqa: E501 + + Name of the Account. # noqa: E501 + + :return: The name of this Account. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this Account. + + Name of the Account. # noqa: E501 + + :param name: The name of this Account. # noqa: E501 + :type: str + """ + + self._name = name diff --git a/xero_python/payrollnz/models/accounts.py b/xero_python/payrollnz/models/accounts.py new file mode 100644 index 00000000..b8057e29 --- /dev/null +++ b/xero_python/payrollnz/models/accounts.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Accounts(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"accounts": "list[Account]"} + + attribute_map = {"accounts": "accounts"} + + def __init__(self, accounts=None): # noqa: E501 + """Accounts - a model defined in OpenAPI""" # noqa: E501 + + self._accounts = None + self.discriminator = None + + if accounts is not None: + self.accounts = accounts + + @property + def accounts(self): + """Gets the accounts of this Accounts. # noqa: E501 + + + :return: The accounts of this Accounts. # noqa: E501 + :rtype: list[Account] + """ + return self._accounts + + @accounts.setter + def accounts(self, accounts): + """Sets the accounts of this Accounts. + + + :param accounts: The accounts of this Accounts. # noqa: E501 + :type: list[Account] + """ + + self._accounts = accounts diff --git a/xero_python/payrollnz/models/address.py b/xero_python/payrollnz/models/address.py new file mode 100644 index 00000000..e011b9b4 --- /dev/null +++ b/xero_python/payrollnz/models/address.py @@ -0,0 +1,228 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Address(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "address_line1": "str", + "address_line2": "str", + "city": "str", + "suburb": "str", + "post_code": "str", + "country_name": "str", + } + + attribute_map = { + "address_line1": "addressLine1", + "address_line2": "addressLine2", + "city": "city", + "suburb": "suburb", + "post_code": "postCode", + "country_name": "countryName", + } + + def __init__( + self, + address_line1=None, + address_line2=None, + city=None, + suburb=None, + post_code=None, + country_name=None, + ): # noqa: E501 + """Address - a model defined in OpenAPI""" # noqa: E501 + + self._address_line1 = None + self._address_line2 = None + self._city = None + self._suburb = None + self._post_code = None + self._country_name = None + self.discriminator = None + + self.address_line1 = address_line1 + if address_line2 is not None: + self.address_line2 = address_line2 + self.city = city + if suburb is not None: + self.suburb = suburb + self.post_code = post_code + if country_name is not None: + self.country_name = country_name + + @property + def address_line1(self): + """Gets the address_line1 of this Address. # noqa: E501 + + Address line 1 for employee home address # noqa: E501 + + :return: The address_line1 of this Address. # noqa: E501 + :rtype: str + """ + return self._address_line1 + + @address_line1.setter + def address_line1(self, address_line1): + """Sets the address_line1 of this Address. + + Address line 1 for employee home address # noqa: E501 + + :param address_line1: The address_line1 of this Address. # noqa: E501 + :type: str + """ + if address_line1 is None: + raise ValueError( + "Invalid value for `address_line1`, must not be `None`" + ) # noqa: E501 + + self._address_line1 = address_line1 + + @property + def address_line2(self): + """Gets the address_line2 of this Address. # noqa: E501 + + Address line 2 for employee home address # noqa: E501 + + :return: The address_line2 of this Address. # noqa: E501 + :rtype: str + """ + return self._address_line2 + + @address_line2.setter + def address_line2(self, address_line2): + """Sets the address_line2 of this Address. + + Address line 2 for employee home address # noqa: E501 + + :param address_line2: The address_line2 of this Address. # noqa: E501 + :type: str + """ + + self._address_line2 = address_line2 + + @property + def city(self): + """Gets the city of this Address. # noqa: E501 + + Suburb for employee home address # noqa: E501 + + :return: The city of this Address. # noqa: E501 + :rtype: str + """ + return self._city + + @city.setter + def city(self, city): + """Sets the city of this Address. + + Suburb for employee home address # noqa: E501 + + :param city: The city of this Address. # noqa: E501 + :type: str + """ + if city is None: + raise ValueError( + "Invalid value for `city`, must not be `None`" + ) # noqa: E501 + + self._city = city + + @property + def suburb(self): + """Gets the suburb of this Address. # noqa: E501 + + Suburb for employee home address # noqa: E501 + + :return: The suburb of this Address. # noqa: E501 + :rtype: str + """ + return self._suburb + + @suburb.setter + def suburb(self, suburb): + """Sets the suburb of this Address. + + Suburb for employee home address # noqa: E501 + + :param suburb: The suburb of this Address. # noqa: E501 + :type: str + """ + + self._suburb = suburb + + @property + def post_code(self): + """Gets the post_code of this Address. # noqa: E501 + + PostCode for employee home address # noqa: E501 + + :return: The post_code of this Address. # noqa: E501 + :rtype: str + """ + return self._post_code + + @post_code.setter + def post_code(self, post_code): + """Sets the post_code of this Address. + + PostCode for employee home address # noqa: E501 + + :param post_code: The post_code of this Address. # noqa: E501 + :type: str + """ + if post_code is None: + raise ValueError( + "Invalid value for `post_code`, must not be `None`" + ) # noqa: E501 + + self._post_code = post_code + + @property + def country_name(self): + """Gets the country_name of this Address. # noqa: E501 + + Country of HomeAddress # noqa: E501 + + :return: The country_name of this Address. # noqa: E501 + :rtype: str + """ + return self._country_name + + @country_name.setter + def country_name(self, country_name): + """Sets the country_name of this Address. + + Country of HomeAddress # noqa: E501 + + :param country_name: The country_name of this Address. # noqa: E501 + :type: str + """ + + self._country_name = country_name diff --git a/xero_python/payrollnz/models/bank_account.py b/xero_python/payrollnz/models/bank_account.py new file mode 100644 index 00000000..ca77f18c --- /dev/null +++ b/xero_python/payrollnz/models/bank_account.py @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class BankAccount(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "account_name": "str", + "account_number": "str", + "sort_code": "str", + "particulars": "str", + "code": "str", + "dollar_amount": "float", + "reference": "str", + "calculation_type": "str", + } + + attribute_map = { + "account_name": "accountName", + "account_number": "accountNumber", + "sort_code": "sortCode", + "particulars": "particulars", + "code": "code", + "dollar_amount": "dollarAmount", + "reference": "reference", + "calculation_type": "calculationType", + } + + def __init__( + self, + account_name=None, + account_number=None, + sort_code=None, + particulars=None, + code=None, + dollar_amount=None, + reference=None, + calculation_type=None, + ): # noqa: E501 + """BankAccount - a model defined in OpenAPI""" # noqa: E501 + + self._account_name = None + self._account_number = None + self._sort_code = None + self._particulars = None + self._code = None + self._dollar_amount = None + self._reference = None + self._calculation_type = None + self.discriminator = None + + self.account_name = account_name + self.account_number = account_number + self.sort_code = sort_code + if particulars is not None: + self.particulars = particulars + if code is not None: + self.code = code + if dollar_amount is not None: + self.dollar_amount = dollar_amount + if reference is not None: + self.reference = reference + if calculation_type is not None: + self.calculation_type = calculation_type + + @property + def account_name(self): + """Gets the account_name of this BankAccount. # noqa: E501 + + Bank account name (max length = 32) # noqa: E501 + + :return: The account_name of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._account_name + + @account_name.setter + def account_name(self, account_name): + """Sets the account_name of this BankAccount. + + Bank account name (max length = 32) # noqa: E501 + + :param account_name: The account_name of this BankAccount. # noqa: E501 + :type: str + """ + if account_name is None: + raise ValueError( + "Invalid value for `account_name`, must not be `None`" + ) # noqa: E501 + + self._account_name = account_name + + @property + def account_number(self): + """Gets the account_number of this BankAccount. # noqa: E501 + + Bank account number (digits only; max length = 8) # noqa: E501 + + :return: The account_number of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._account_number + + @account_number.setter + def account_number(self, account_number): + """Sets the account_number of this BankAccount. + + Bank account number (digits only; max length = 8) # noqa: E501 + + :param account_number: The account_number of this BankAccount. # noqa: E501 + :type: str + """ + if account_number is None: + raise ValueError( + "Invalid value for `account_number`, must not be `None`" + ) # noqa: E501 + + self._account_number = account_number + + @property + def sort_code(self): + """Gets the sort_code of this BankAccount. # noqa: E501 + + Bank account sort code (6 digits) # noqa: E501 + + :return: The sort_code of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._sort_code + + @sort_code.setter + def sort_code(self, sort_code): + """Sets the sort_code of this BankAccount. + + Bank account sort code (6 digits) # noqa: E501 + + :param sort_code: The sort_code of this BankAccount. # noqa: E501 + :type: str + """ + if sort_code is None: + raise ValueError( + "Invalid value for `sort_code`, must not be `None`" + ) # noqa: E501 + + self._sort_code = sort_code + + @property + def particulars(self): + """Gets the particulars of this BankAccount. # noqa: E501 + + Particulars that appear on the statement. # noqa: E501 + + :return: The particulars of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._particulars + + @particulars.setter + def particulars(self, particulars): + """Sets the particulars of this BankAccount. + + Particulars that appear on the statement. # noqa: E501 + + :param particulars: The particulars of this BankAccount. # noqa: E501 + :type: str + """ + + self._particulars = particulars + + @property + def code(self): + """Gets the code of this BankAccount. # noqa: E501 + + Code of a transaction that appear on the statement. # noqa: E501 + + :return: The code of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._code + + @code.setter + def code(self, code): + """Sets the code of this BankAccount. + + Code of a transaction that appear on the statement. # noqa: E501 + + :param code: The code of this BankAccount. # noqa: E501 + :type: str + """ + + self._code = code + + @property + def dollar_amount(self): + """Gets the dollar_amount of this BankAccount. # noqa: E501 + + Dollar amount of a transaction. # noqa: E501 + + :return: The dollar_amount of this BankAccount. # noqa: E501 + :rtype: float + """ + return self._dollar_amount + + @dollar_amount.setter + def dollar_amount(self, dollar_amount): + """Sets the dollar_amount of this BankAccount. + + Dollar amount of a transaction. # noqa: E501 + + :param dollar_amount: The dollar_amount of this BankAccount. # noqa: E501 + :type: float + """ + + self._dollar_amount = dollar_amount + + @property + def reference(self): + """Gets the reference of this BankAccount. # noqa: E501 + + Statement Text/reference for a transaction that appear on the statement. # noqa: E501 + + :return: The reference of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._reference + + @reference.setter + def reference(self, reference): + """Sets the reference of this BankAccount. + + Statement Text/reference for a transaction that appear on the statement. # noqa: E501 + + :param reference: The reference of this BankAccount. # noqa: E501 + :type: str + """ + + self._reference = reference + + @property + def calculation_type(self): + """Gets the calculation_type of this BankAccount. # noqa: E501 + + Calculation type for the transaction can be 'Fixed Amount' or 'Balance' # noqa: E501 + + :return: The calculation_type of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._calculation_type + + @calculation_type.setter + def calculation_type(self, calculation_type): + """Sets the calculation_type of this BankAccount. + + Calculation type for the transaction can be 'Fixed Amount' or 'Balance' # noqa: E501 + + :param calculation_type: The calculation_type of this BankAccount. # noqa: E501 + :type: str + """ + allowed_values = ["FixedAmount", "Balance", "None"] # noqa: E501 + if calculation_type not in allowed_values: + raise ValueError( + "Invalid value for `calculation_type` ({0}), must be one of {1}".format( # noqa: E501 + calculation_type, allowed_values + ) + ) + + self._calculation_type = calculation_type diff --git a/xero_python/payrollnz/models/benefit.py b/xero_python/payrollnz/models/benefit.py new file mode 100644 index 00000000..cf292d21 --- /dev/null +++ b/xero_python/payrollnz/models/benefit.py @@ -0,0 +1,365 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Benefit(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "id": "str", + "name": "str", + "category": "str", + "liability_account_id": "str", + "expense_account_id": "str", + "calculation_type_nz": "str", + "standard_amount": "float", + "percentage": "float", + "company_max": "float", + "current_record": "bool", + } + + attribute_map = { + "id": "id", + "name": "name", + "category": "category", + "liability_account_id": "liabilityAccountId", + "expense_account_id": "expenseAccountId", + "calculation_type_nz": "calculationTypeNZ", + "standard_amount": "standardAmount", + "percentage": "percentage", + "company_max": "companyMax", + "current_record": "currentRecord", + } + + def __init__( + self, + id=None, + name=None, + category=None, + liability_account_id=None, + expense_account_id=None, + calculation_type_nz=None, + standard_amount=None, + percentage=None, + company_max=None, + current_record=None, + ): # noqa: E501 + """Benefit - a model defined in OpenAPI""" # noqa: E501 + + self._id = None + self._name = None + self._category = None + self._liability_account_id = None + self._expense_account_id = None + self._calculation_type_nz = None + self._standard_amount = None + self._percentage = None + self._company_max = None + self._current_record = None + self.discriminator = None + + if id is not None: + self.id = id + self.name = name + self.category = category + self.liability_account_id = liability_account_id + self.expense_account_id = expense_account_id + if calculation_type_nz is not None: + self.calculation_type_nz = calculation_type_nz + if standard_amount is not None: + self.standard_amount = standard_amount + if percentage is not None: + self.percentage = percentage + if company_max is not None: + self.company_max = company_max + if current_record is not None: + self.current_record = current_record + + @property + def id(self): + """Gets the id of this Benefit. # noqa: E501 + + The Xero identifier for superannuation # noqa: E501 + + :return: The id of this Benefit. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this Benefit. + + The Xero identifier for superannuation # noqa: E501 + + :param id: The id of this Benefit. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def name(self): + """Gets the name of this Benefit. # noqa: E501 + + Name of the superannuations # noqa: E501 + + :return: The name of this Benefit. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this Benefit. + + Name of the superannuations # noqa: E501 + + :param name: The name of this Benefit. # noqa: E501 + :type: str + """ + if name is None: + raise ValueError( + "Invalid value for `name`, must not be `None`" + ) # noqa: E501 + + self._name = name + + @property + def category(self): + """Gets the category of this Benefit. # noqa: E501 + + Superannuations Category type # noqa: E501 + + :return: The category of this Benefit. # noqa: E501 + :rtype: str + """ + return self._category + + @category.setter + def category(self, category): + """Sets the category of this Benefit. + + Superannuations Category type # noqa: E501 + + :param category: The category of this Benefit. # noqa: E501 + :type: str + """ + if category is None: + raise ValueError( + "Invalid value for `category`, must not be `None`" + ) # noqa: E501 + allowed_values = ["KiwiSaver", "ComplyingFund", "Other", "None"] # noqa: E501 + if category not in allowed_values: + raise ValueError( + "Invalid value for `category` ({0}), must be one of {1}".format( # noqa: E501 + category, allowed_values + ) + ) + + self._category = category + + @property + def liability_account_id(self): + """Gets the liability_account_id of this Benefit. # noqa: E501 + + Xero identifier for Liability Account # noqa: E501 + + :return: The liability_account_id of this Benefit. # noqa: E501 + :rtype: str + """ + return self._liability_account_id + + @liability_account_id.setter + def liability_account_id(self, liability_account_id): + """Sets the liability_account_id of this Benefit. + + Xero identifier for Liability Account # noqa: E501 + + :param liability_account_id: The liability_account_id of this Benefit. # noqa: E501 + :type: str + """ + if liability_account_id is None: + raise ValueError( + "Invalid value for `liability_account_id`, must not be `None`" + ) # noqa: E501 + + self._liability_account_id = liability_account_id + + @property + def expense_account_id(self): + """Gets the expense_account_id of this Benefit. # noqa: E501 + + Xero identifier for Expense Account # noqa: E501 + + :return: The expense_account_id of this Benefit. # noqa: E501 + :rtype: str + """ + return self._expense_account_id + + @expense_account_id.setter + def expense_account_id(self, expense_account_id): + """Sets the expense_account_id of this Benefit. + + Xero identifier for Expense Account # noqa: E501 + + :param expense_account_id: The expense_account_id of this Benefit. # noqa: E501 + :type: str + """ + if expense_account_id is None: + raise ValueError( + "Invalid value for `expense_account_id`, must not be `None`" + ) # noqa: E501 + + self._expense_account_id = expense_account_id + + @property + def calculation_type_nz(self): + """Gets the calculation_type_nz of this Benefit. # noqa: E501 + + Calculation Type of the superannuation either FixedAmount or PercentageOfTaxableEarnings # noqa: E501 + + :return: The calculation_type_nz of this Benefit. # noqa: E501 + :rtype: str + """ + return self._calculation_type_nz + + @calculation_type_nz.setter + def calculation_type_nz(self, calculation_type_nz): + """Sets the calculation_type_nz of this Benefit. + + Calculation Type of the superannuation either FixedAmount or PercentageOfTaxableEarnings # noqa: E501 + + :param calculation_type_nz: The calculation_type_nz of this Benefit. # noqa: E501 + :type: str + """ + allowed_values = [ + "FixedAmount", + "PercentageOfTaxableEarnings", + "None", + ] # noqa: E501 + if calculation_type_nz not in allowed_values: + raise ValueError( + "Invalid value for `calculation_type_nz` ({0}), must be one of {1}".format( # noqa: E501 + calculation_type_nz, allowed_values + ) + ) + + self._calculation_type_nz = calculation_type_nz + + @property + def standard_amount(self): + """Gets the standard_amount of this Benefit. # noqa: E501 + + Standard amount of the superannuation # noqa: E501 + + :return: The standard_amount of this Benefit. # noqa: E501 + :rtype: float + """ + return self._standard_amount + + @standard_amount.setter + def standard_amount(self, standard_amount): + """Sets the standard_amount of this Benefit. + + Standard amount of the superannuation # noqa: E501 + + :param standard_amount: The standard_amount of this Benefit. # noqa: E501 + :type: float + """ + + self._standard_amount = standard_amount + + @property + def percentage(self): + """Gets the percentage of this Benefit. # noqa: E501 + + Percentage of Taxable Earnings of the superannuation # noqa: E501 + + :return: The percentage of this Benefit. # noqa: E501 + :rtype: float + """ + return self._percentage + + @percentage.setter + def percentage(self, percentage): + """Sets the percentage of this Benefit. + + Percentage of Taxable Earnings of the superannuation # noqa: E501 + + :param percentage: The percentage of this Benefit. # noqa: E501 + :type: float + """ + + self._percentage = percentage + + @property + def company_max(self): + """Gets the company_max of this Benefit. # noqa: E501 + + Company Maximum amount of the superannuation # noqa: E501 + + :return: The company_max of this Benefit. # noqa: E501 + :rtype: float + """ + return self._company_max + + @company_max.setter + def company_max(self, company_max): + """Sets the company_max of this Benefit. + + Company Maximum amount of the superannuation # noqa: E501 + + :param company_max: The company_max of this Benefit. # noqa: E501 + :type: float + """ + + self._company_max = company_max + + @property + def current_record(self): + """Gets the current_record of this Benefit. # noqa: E501 + + Identifier of a record is active or not. # noqa: E501 + + :return: The current_record of this Benefit. # noqa: E501 + :rtype: bool + """ + return self._current_record + + @current_record.setter + def current_record(self, current_record): + """Sets the current_record of this Benefit. + + Identifier of a record is active or not. # noqa: E501 + + :param current_record: The current_record of this Benefit. # noqa: E501 + :type: bool + """ + + self._current_record = current_record diff --git a/xero_python/payrollnz/models/deduction.py b/xero_python/payrollnz/models/deduction.py new file mode 100644 index 00000000..e900306a --- /dev/null +++ b/xero_python/payrollnz/models/deduction.py @@ -0,0 +1,241 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Deduction(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "deduction_id": "str", + "deduction_name": "str", + "deduction_category": "str", + "liability_account_id": "str", + "current_record": "bool", + "standard_amount": "float", + } + + attribute_map = { + "deduction_id": "deductionId", + "deduction_name": "deductionName", + "deduction_category": "deductionCategory", + "liability_account_id": "liabilityAccountId", + "current_record": "currentRecord", + "standard_amount": "standardAmount", + } + + def __init__( + self, + deduction_id=None, + deduction_name=None, + deduction_category=None, + liability_account_id=None, + current_record=None, + standard_amount=None, + ): # noqa: E501 + """Deduction - a model defined in OpenAPI""" # noqa: E501 + + self._deduction_id = None + self._deduction_name = None + self._deduction_category = None + self._liability_account_id = None + self._current_record = None + self._standard_amount = None + self.discriminator = None + + if deduction_id is not None: + self.deduction_id = deduction_id + self.deduction_name = deduction_name + self.deduction_category = deduction_category + self.liability_account_id = liability_account_id + if current_record is not None: + self.current_record = current_record + if standard_amount is not None: + self.standard_amount = standard_amount + + @property + def deduction_id(self): + """Gets the deduction_id of this Deduction. # noqa: E501 + + The Xero identifier for Deduction # noqa: E501 + + :return: The deduction_id of this Deduction. # noqa: E501 + :rtype: str + """ + return self._deduction_id + + @deduction_id.setter + def deduction_id(self, deduction_id): + """Sets the deduction_id of this Deduction. + + The Xero identifier for Deduction # noqa: E501 + + :param deduction_id: The deduction_id of this Deduction. # noqa: E501 + :type: str + """ + + self._deduction_id = deduction_id + + @property + def deduction_name(self): + """Gets the deduction_name of this Deduction. # noqa: E501 + + Name of the deduction # noqa: E501 + + :return: The deduction_name of this Deduction. # noqa: E501 + :rtype: str + """ + return self._deduction_name + + @deduction_name.setter + def deduction_name(self, deduction_name): + """Sets the deduction_name of this Deduction. + + Name of the deduction # noqa: E501 + + :param deduction_name: The deduction_name of this Deduction. # noqa: E501 + :type: str + """ + if deduction_name is None: + raise ValueError( + "Invalid value for `deduction_name`, must not be `None`" + ) # noqa: E501 + + self._deduction_name = deduction_name + + @property + def deduction_category(self): + """Gets the deduction_category of this Deduction. # noqa: E501 + + Deduction Category type # noqa: E501 + + :return: The deduction_category of this Deduction. # noqa: E501 + :rtype: str + """ + return self._deduction_category + + @deduction_category.setter + def deduction_category(self, deduction_category): + """Sets the deduction_category of this Deduction. + + Deduction Category type # noqa: E501 + + :param deduction_category: The deduction_category of this Deduction. # noqa: E501 + :type: str + """ + if deduction_category is None: + raise ValueError( + "Invalid value for `deduction_category`, must not be `None`" + ) # noqa: E501 + allowed_values = [ + "PayrollGiving", + "KiwiSaverVoluntaryContributions", + "Superannuation", + "NzOther", + "None", + ] # noqa: E501 + if deduction_category not in allowed_values: + raise ValueError( + "Invalid value for `deduction_category` ({0}), must be one of {1}".format( # noqa: E501 + deduction_category, allowed_values + ) + ) + + self._deduction_category = deduction_category + + @property + def liability_account_id(self): + """Gets the liability_account_id of this Deduction. # noqa: E501 + + Xero identifier for Liability Account # noqa: E501 + + :return: The liability_account_id of this Deduction. # noqa: E501 + :rtype: str + """ + return self._liability_account_id + + @liability_account_id.setter + def liability_account_id(self, liability_account_id): + """Sets the liability_account_id of this Deduction. + + Xero identifier for Liability Account # noqa: E501 + + :param liability_account_id: The liability_account_id of this Deduction. # noqa: E501 + :type: str + """ + if liability_account_id is None: + raise ValueError( + "Invalid value for `liability_account_id`, must not be `None`" + ) # noqa: E501 + + self._liability_account_id = liability_account_id + + @property + def current_record(self): + """Gets the current_record of this Deduction. # noqa: E501 + + Identifier of a record is active or not. # noqa: E501 + + :return: The current_record of this Deduction. # noqa: E501 + :rtype: bool + """ + return self._current_record + + @current_record.setter + def current_record(self, current_record): + """Sets the current_record of this Deduction. + + Identifier of a record is active or not. # noqa: E501 + + :param current_record: The current_record of this Deduction. # noqa: E501 + :type: bool + """ + + self._current_record = current_record + + @property + def standard_amount(self): + """Gets the standard_amount of this Deduction. # noqa: E501 + + Standard amount of the deduction. # noqa: E501 + + :return: The standard_amount of this Deduction. # noqa: E501 + :rtype: float + """ + return self._standard_amount + + @standard_amount.setter + def standard_amount(self, standard_amount): + """Sets the standard_amount of this Deduction. + + Standard amount of the deduction. # noqa: E501 + + :param standard_amount: The standard_amount of this Deduction. # noqa: E501 + :type: float + """ + + self._standard_amount = standard_amount diff --git a/xero_python/payrollnz/models/deduction_line.py b/xero_python/payrollnz/models/deduction_line.py new file mode 100644 index 00000000..c7f0bb12 --- /dev/null +++ b/xero_python/payrollnz/models/deduction_line.py @@ -0,0 +1,190 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class DeductionLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "deduction_type_id": "str", + "display_name": "str", + "amount": "float", + "subject_to_tax": "bool", + "percentage": "float", + } + + attribute_map = { + "deduction_type_id": "deductionTypeID", + "display_name": "displayName", + "amount": "amount", + "subject_to_tax": "subjectToTax", + "percentage": "percentage", + } + + def __init__( + self, + deduction_type_id=None, + display_name=None, + amount=None, + subject_to_tax=None, + percentage=None, + ): # noqa: E501 + """DeductionLine - a model defined in OpenAPI""" # noqa: E501 + + self._deduction_type_id = None + self._display_name = None + self._amount = None + self._subject_to_tax = None + self._percentage = None + self.discriminator = None + + if deduction_type_id is not None: + self.deduction_type_id = deduction_type_id + if display_name is not None: + self.display_name = display_name + if amount is not None: + self.amount = amount + if subject_to_tax is not None: + self.subject_to_tax = subject_to_tax + if percentage is not None: + self.percentage = percentage + + @property + def deduction_type_id(self): + """Gets the deduction_type_id of this DeductionLine. # noqa: E501 + + Xero identifier for payroll deduction # noqa: E501 + + :return: The deduction_type_id of this DeductionLine. # noqa: E501 + :rtype: str + """ + return self._deduction_type_id + + @deduction_type_id.setter + def deduction_type_id(self, deduction_type_id): + """Sets the deduction_type_id of this DeductionLine. + + Xero identifier for payroll deduction # noqa: E501 + + :param deduction_type_id: The deduction_type_id of this DeductionLine. # noqa: E501 + :type: str + """ + + self._deduction_type_id = deduction_type_id + + @property + def display_name(self): + """Gets the display_name of this DeductionLine. # noqa: E501 + + name of earnings rate for display in UI # noqa: E501 + + :return: The display_name of this DeductionLine. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this DeductionLine. + + name of earnings rate for display in UI # noqa: E501 + + :param display_name: The display_name of this DeductionLine. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def amount(self): + """Gets the amount of this DeductionLine. # noqa: E501 + + The amount of the deduction line # noqa: E501 + + :return: The amount of this DeductionLine. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this DeductionLine. + + The amount of the deduction line # noqa: E501 + + :param amount: The amount of this DeductionLine. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def subject_to_tax(self): + """Gets the subject_to_tax of this DeductionLine. # noqa: E501 + + Identifies if the deduction is subject to tax # noqa: E501 + + :return: The subject_to_tax of this DeductionLine. # noqa: E501 + :rtype: bool + """ + return self._subject_to_tax + + @subject_to_tax.setter + def subject_to_tax(self, subject_to_tax): + """Sets the subject_to_tax of this DeductionLine. + + Identifies if the deduction is subject to tax # noqa: E501 + + :param subject_to_tax: The subject_to_tax of this DeductionLine. # noqa: E501 + :type: bool + """ + + self._subject_to_tax = subject_to_tax + + @property + def percentage(self): + """Gets the percentage of this DeductionLine. # noqa: E501 + + Deduction rate percentage # noqa: E501 + + :return: The percentage of this DeductionLine. # noqa: E501 + :rtype: float + """ + return self._percentage + + @percentage.setter + def percentage(self, percentage): + """Sets the percentage of this DeductionLine. + + Deduction rate percentage # noqa: E501 + + :param percentage: The percentage of this DeductionLine. # noqa: E501 + :type: float + """ + + self._percentage = percentage diff --git a/xero_python/payrollnz/models/deduction_object.py b/xero_python/payrollnz/models/deduction_object.py new file mode 100644 index 00000000..f02f3889 --- /dev/null +++ b/xero_python/payrollnz/models/deduction_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class DeductionObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "deduction": "Deduction", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "deduction": "deduction", + } + + def __init__(self, pagination=None, problem=None, deduction=None): # noqa: E501 + """DeductionObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._deduction = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if deduction is not None: + self.deduction = deduction + + @property + def pagination(self): + """Gets the pagination of this DeductionObject. # noqa: E501 + + + :return: The pagination of this DeductionObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this DeductionObject. + + + :param pagination: The pagination of this DeductionObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this DeductionObject. # noqa: E501 + + + :return: The problem of this DeductionObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this DeductionObject. + + + :param problem: The problem of this DeductionObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def deduction(self): + """Gets the deduction of this DeductionObject. # noqa: E501 + + + :return: The deduction of this DeductionObject. # noqa: E501 + :rtype: Deduction + """ + return self._deduction + + @deduction.setter + def deduction(self, deduction): + """Sets the deduction of this DeductionObject. + + + :param deduction: The deduction of this DeductionObject. # noqa: E501 + :type: Deduction + """ + + self._deduction = deduction diff --git a/xero_python/payrollnz/models/deductions.py b/xero_python/payrollnz/models/deductions.py new file mode 100644 index 00000000..4f1d0a8f --- /dev/null +++ b/xero_python/payrollnz/models/deductions.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Deductions(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "deductions": "list[Deduction]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "deductions": "deductions", + } + + def __init__(self, pagination=None, problem=None, deductions=None): # noqa: E501 + """Deductions - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._deductions = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if deductions is not None: + self.deductions = deductions + + @property + def pagination(self): + """Gets the pagination of this Deductions. # noqa: E501 + + + :return: The pagination of this Deductions. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this Deductions. + + + :param pagination: The pagination of this Deductions. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this Deductions. # noqa: E501 + + + :return: The problem of this Deductions. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this Deductions. + + + :param problem: The problem of this Deductions. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def deductions(self): + """Gets the deductions of this Deductions. # noqa: E501 + + + :return: The deductions of this Deductions. # noqa: E501 + :rtype: list[Deduction] + """ + return self._deductions + + @deductions.setter + def deductions(self, deductions): + """Sets the deductions of this Deductions. + + + :param deductions: The deductions of this Deductions. # noqa: E501 + :type: list[Deduction] + """ + + self._deductions = deductions diff --git a/xero_python/payrollnz/models/earnings_line.py b/xero_python/payrollnz/models/earnings_line.py new file mode 100644 index 00000000..8ea181d8 --- /dev/null +++ b/xero_python/payrollnz/models/earnings_line.py @@ -0,0 +1,335 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EarningsLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "earnings_line_id": "str", + "earnings_rate_id": "str", + "display_name": "str", + "rate_per_unit": "float", + "number_of_units": "float", + "fixed_amount": "float", + "amount": "float", + "is_linked_to_timesheet": "bool", + "is_average_daily_pay_rate": "bool", + "is_system_generated": "bool", + } + + attribute_map = { + "earnings_line_id": "earningsLineID", + "earnings_rate_id": "earningsRateID", + "display_name": "displayName", + "rate_per_unit": "ratePerUnit", + "number_of_units": "numberOfUnits", + "fixed_amount": "fixedAmount", + "amount": "amount", + "is_linked_to_timesheet": "isLinkedToTimesheet", + "is_average_daily_pay_rate": "isAverageDailyPayRate", + "is_system_generated": "isSystemGenerated", + } + + def __init__( + self, + earnings_line_id=None, + earnings_rate_id=None, + display_name=None, + rate_per_unit=None, + number_of_units=None, + fixed_amount=None, + amount=None, + is_linked_to_timesheet=None, + is_average_daily_pay_rate=None, + is_system_generated=None, + ): # noqa: E501 + """EarningsLine - a model defined in OpenAPI""" # noqa: E501 + + self._earnings_line_id = None + self._earnings_rate_id = None + self._display_name = None + self._rate_per_unit = None + self._number_of_units = None + self._fixed_amount = None + self._amount = None + self._is_linked_to_timesheet = None + self._is_average_daily_pay_rate = None + self._is_system_generated = None + self.discriminator = None + + if earnings_line_id is not None: + self.earnings_line_id = earnings_line_id + if earnings_rate_id is not None: + self.earnings_rate_id = earnings_rate_id + if display_name is not None: + self.display_name = display_name + if rate_per_unit is not None: + self.rate_per_unit = rate_per_unit + if number_of_units is not None: + self.number_of_units = number_of_units + if fixed_amount is not None: + self.fixed_amount = fixed_amount + if amount is not None: + self.amount = amount + if is_linked_to_timesheet is not None: + self.is_linked_to_timesheet = is_linked_to_timesheet + if is_average_daily_pay_rate is not None: + self.is_average_daily_pay_rate = is_average_daily_pay_rate + if is_system_generated is not None: + self.is_system_generated = is_system_generated + + @property + def earnings_line_id(self): + """Gets the earnings_line_id of this EarningsLine. # noqa: E501 + + Xero identifier for payroll earnings line # noqa: E501 + + :return: The earnings_line_id of this EarningsLine. # noqa: E501 + :rtype: str + """ + return self._earnings_line_id + + @earnings_line_id.setter + def earnings_line_id(self, earnings_line_id): + """Sets the earnings_line_id of this EarningsLine. + + Xero identifier for payroll earnings line # noqa: E501 + + :param earnings_line_id: The earnings_line_id of this EarningsLine. # noqa: E501 + :type: str + """ + + self._earnings_line_id = earnings_line_id + + @property + def earnings_rate_id(self): + """Gets the earnings_rate_id of this EarningsLine. # noqa: E501 + + Xero identifier for payroll earnings rate # noqa: E501 + + :return: The earnings_rate_id of this EarningsLine. # noqa: E501 + :rtype: str + """ + return self._earnings_rate_id + + @earnings_rate_id.setter + def earnings_rate_id(self, earnings_rate_id): + """Sets the earnings_rate_id of this EarningsLine. + + Xero identifier for payroll earnings rate # noqa: E501 + + :param earnings_rate_id: The earnings_rate_id of this EarningsLine. # noqa: E501 + :type: str + """ + + self._earnings_rate_id = earnings_rate_id + + @property + def display_name(self): + """Gets the display_name of this EarningsLine. # noqa: E501 + + name of earnings rate for display in UI # noqa: E501 + + :return: The display_name of this EarningsLine. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this EarningsLine. + + name of earnings rate for display in UI # noqa: E501 + + :param display_name: The display_name of this EarningsLine. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def rate_per_unit(self): + """Gets the rate_per_unit of this EarningsLine. # noqa: E501 + + Rate per unit for earnings line # noqa: E501 + + :return: The rate_per_unit of this EarningsLine. # noqa: E501 + :rtype: float + """ + return self._rate_per_unit + + @rate_per_unit.setter + def rate_per_unit(self, rate_per_unit): + """Sets the rate_per_unit of this EarningsLine. + + Rate per unit for earnings line # noqa: E501 + + :param rate_per_unit: The rate_per_unit of this EarningsLine. # noqa: E501 + :type: float + """ + + self._rate_per_unit = rate_per_unit + + @property + def number_of_units(self): + """Gets the number_of_units of this EarningsLine. # noqa: E501 + + Earnings number of units # noqa: E501 + + :return: The number_of_units of this EarningsLine. # noqa: E501 + :rtype: float + """ + return self._number_of_units + + @number_of_units.setter + def number_of_units(self, number_of_units): + """Sets the number_of_units of this EarningsLine. + + Earnings number of units # noqa: E501 + + :param number_of_units: The number_of_units of this EarningsLine. # noqa: E501 + :type: float + """ + + self._number_of_units = number_of_units + + @property + def fixed_amount(self): + """Gets the fixed_amount of this EarningsLine. # noqa: E501 + + Earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed # noqa: E501 + + :return: The fixed_amount of this EarningsLine. # noqa: E501 + :rtype: float + """ + return self._fixed_amount + + @fixed_amount.setter + def fixed_amount(self, fixed_amount): + """Sets the fixed_amount of this EarningsLine. + + Earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed # noqa: E501 + + :param fixed_amount: The fixed_amount of this EarningsLine. # noqa: E501 + :type: float + """ + + self._fixed_amount = fixed_amount + + @property + def amount(self): + """Gets the amount of this EarningsLine. # noqa: E501 + + The amount of the earnings line. # noqa: E501 + + :return: The amount of this EarningsLine. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this EarningsLine. + + The amount of the earnings line. # noqa: E501 + + :param amount: The amount of this EarningsLine. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def is_linked_to_timesheet(self): + """Gets the is_linked_to_timesheet of this EarningsLine. # noqa: E501 + + Identifies if the earnings is taken from the timesheet. False for earnings line # noqa: E501 + + :return: The is_linked_to_timesheet of this EarningsLine. # noqa: E501 + :rtype: bool + """ + return self._is_linked_to_timesheet + + @is_linked_to_timesheet.setter + def is_linked_to_timesheet(self, is_linked_to_timesheet): + """Sets the is_linked_to_timesheet of this EarningsLine. + + Identifies if the earnings is taken from the timesheet. False for earnings line # noqa: E501 + + :param is_linked_to_timesheet: The is_linked_to_timesheet of this EarningsLine. # noqa: E501 + :type: bool + """ + + self._is_linked_to_timesheet = is_linked_to_timesheet + + @property + def is_average_daily_pay_rate(self): + """Gets the is_average_daily_pay_rate of this EarningsLine. # noqa: E501 + + Identifies if the earnings is using an average daily pay rate # noqa: E501 + + :return: The is_average_daily_pay_rate of this EarningsLine. # noqa: E501 + :rtype: bool + """ + return self._is_average_daily_pay_rate + + @is_average_daily_pay_rate.setter + def is_average_daily_pay_rate(self, is_average_daily_pay_rate): + """Sets the is_average_daily_pay_rate of this EarningsLine. + + Identifies if the earnings is using an average daily pay rate # noqa: E501 + + :param is_average_daily_pay_rate: The is_average_daily_pay_rate of this EarningsLine. # noqa: E501 + :type: bool + """ + + self._is_average_daily_pay_rate = is_average_daily_pay_rate + + @property + def is_system_generated(self): + """Gets the is_system_generated of this EarningsLine. # noqa: E501 + + Flag to indentify whether the earnings line is system generated or not. # noqa: E501 + + :return: The is_system_generated of this EarningsLine. # noqa: E501 + :rtype: bool + """ + return self._is_system_generated + + @is_system_generated.setter + def is_system_generated(self, is_system_generated): + """Sets the is_system_generated of this EarningsLine. + + Flag to indentify whether the earnings line is system generated or not. # noqa: E501 + + :param is_system_generated: The is_system_generated of this EarningsLine. # noqa: E501 + :type: bool + """ + + self._is_system_generated = is_system_generated diff --git a/xero_python/payrollnz/models/earnings_order.py b/xero_python/payrollnz/models/earnings_order.py new file mode 100644 index 00000000..ce33ea60 --- /dev/null +++ b/xero_python/payrollnz/models/earnings_order.py @@ -0,0 +1,191 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EarningsOrder(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "id": "str", + "name": "str", + "statutory_deduction_category": "StatutoryDeductionCategory", + "liability_account_id": "str", + "current_record": "bool", + } + + attribute_map = { + "id": "id", + "name": "name", + "statutory_deduction_category": "statutoryDeductionCategory", + "liability_account_id": "liabilityAccountId", + "current_record": "currentRecord", + } + + def __init__( + self, + id=None, + name=None, + statutory_deduction_category=None, + liability_account_id=None, + current_record=True, + ): # noqa: E501 + """EarningsOrder - a model defined in OpenAPI""" # noqa: E501 + + self._id = None + self._name = None + self._statutory_deduction_category = None + self._liability_account_id = None + self._current_record = None + self.discriminator = None + + if id is not None: + self.id = id + self.name = name + if statutory_deduction_category is not None: + self.statutory_deduction_category = statutory_deduction_category + if liability_account_id is not None: + self.liability_account_id = liability_account_id + if current_record is not None: + self.current_record = current_record + + @property + def id(self): + """Gets the id of this EarningsOrder. # noqa: E501 + + Xero unique identifier for an earning rate # noqa: E501 + + :return: The id of this EarningsOrder. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this EarningsOrder. + + Xero unique identifier for an earning rate # noqa: E501 + + :param id: The id of this EarningsOrder. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def name(self): + """Gets the name of this EarningsOrder. # noqa: E501 + + Name of the earning order # noqa: E501 + + :return: The name of this EarningsOrder. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this EarningsOrder. + + Name of the earning order # noqa: E501 + + :param name: The name of this EarningsOrder. # noqa: E501 + :type: str + """ + if name is None: + raise ValueError( + "Invalid value for `name`, must not be `None`" + ) # noqa: E501 + + self._name = name + + @property + def statutory_deduction_category(self): + """Gets the statutory_deduction_category of this EarningsOrder. # noqa: E501 + + + :return: The statutory_deduction_category of this EarningsOrder. # noqa: E501 + :rtype: StatutoryDeductionCategory + """ + return self._statutory_deduction_category + + @statutory_deduction_category.setter + def statutory_deduction_category(self, statutory_deduction_category): + """Sets the statutory_deduction_category of this EarningsOrder. + + + :param statutory_deduction_category: The statutory_deduction_category of this EarningsOrder. # noqa: E501 + :type: StatutoryDeductionCategory + """ + + self._statutory_deduction_category = statutory_deduction_category + + @property + def liability_account_id(self): + """Gets the liability_account_id of this EarningsOrder. # noqa: E501 + + Xero identifier for Liability Account # noqa: E501 + + :return: The liability_account_id of this EarningsOrder. # noqa: E501 + :rtype: str + """ + return self._liability_account_id + + @liability_account_id.setter + def liability_account_id(self, liability_account_id): + """Sets the liability_account_id of this EarningsOrder. + + Xero identifier for Liability Account # noqa: E501 + + :param liability_account_id: The liability_account_id of this EarningsOrder. # noqa: E501 + :type: str + """ + + self._liability_account_id = liability_account_id + + @property + def current_record(self): + """Gets the current_record of this EarningsOrder. # noqa: E501 + + Identifier of a record is active or not. # noqa: E501 + + :return: The current_record of this EarningsOrder. # noqa: E501 + :rtype: bool + """ + return self._current_record + + @current_record.setter + def current_record(self, current_record): + """Sets the current_record of this EarningsOrder. + + Identifier of a record is active or not. # noqa: E501 + + :param current_record: The current_record of this EarningsOrder. # noqa: E501 + :type: bool + """ + + self._current_record = current_record diff --git a/xero_python/payrollnz/models/earnings_order_object.py b/xero_python/payrollnz/models/earnings_order_object.py new file mode 100644 index 00000000..3a2fd2c4 --- /dev/null +++ b/xero_python/payrollnz/models/earnings_order_object.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EarningsOrderObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "statutory_deduction": "EarningsOrder", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "statutory_deduction": "statutoryDeduction", + } + + def __init__( + self, pagination=None, problem=None, statutory_deduction=None + ): # noqa: E501 + """EarningsOrderObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._statutory_deduction = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if statutory_deduction is not None: + self.statutory_deduction = statutory_deduction + + @property + def pagination(self): + """Gets the pagination of this EarningsOrderObject. # noqa: E501 + + + :return: The pagination of this EarningsOrderObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EarningsOrderObject. + + + :param pagination: The pagination of this EarningsOrderObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EarningsOrderObject. # noqa: E501 + + + :return: The problem of this EarningsOrderObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EarningsOrderObject. + + + :param problem: The problem of this EarningsOrderObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def statutory_deduction(self): + """Gets the statutory_deduction of this EarningsOrderObject. # noqa: E501 + + + :return: The statutory_deduction of this EarningsOrderObject. # noqa: E501 + :rtype: EarningsOrder + """ + return self._statutory_deduction + + @statutory_deduction.setter + def statutory_deduction(self, statutory_deduction): + """Sets the statutory_deduction of this EarningsOrderObject. + + + :param statutory_deduction: The statutory_deduction of this EarningsOrderObject. # noqa: E501 + :type: EarningsOrder + """ + + self._statutory_deduction = statutory_deduction diff --git a/xero_python/payrollnz/models/earnings_orders.py b/xero_python/payrollnz/models/earnings_orders.py new file mode 100644 index 00000000..09f60eb7 --- /dev/null +++ b/xero_python/payrollnz/models/earnings_orders.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EarningsOrders(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "statutory_deductions": "list[EarningsOrder]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "statutory_deductions": "statutoryDeductions", + } + + def __init__( + self, pagination=None, problem=None, statutory_deductions=None + ): # noqa: E501 + """EarningsOrders - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._statutory_deductions = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if statutory_deductions is not None: + self.statutory_deductions = statutory_deductions + + @property + def pagination(self): + """Gets the pagination of this EarningsOrders. # noqa: E501 + + + :return: The pagination of this EarningsOrders. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EarningsOrders. + + + :param pagination: The pagination of this EarningsOrders. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EarningsOrders. # noqa: E501 + + + :return: The problem of this EarningsOrders. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EarningsOrders. + + + :param problem: The problem of this EarningsOrders. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def statutory_deductions(self): + """Gets the statutory_deductions of this EarningsOrders. # noqa: E501 + + + :return: The statutory_deductions of this EarningsOrders. # noqa: E501 + :rtype: list[EarningsOrder] + """ + return self._statutory_deductions + + @statutory_deductions.setter + def statutory_deductions(self, statutory_deductions): + """Sets the statutory_deductions of this EarningsOrders. + + + :param statutory_deductions: The statutory_deductions of this EarningsOrders. # noqa: E501 + :type: list[EarningsOrder] + """ + + self._statutory_deductions = statutory_deductions diff --git a/xero_python/payrollnz/models/earnings_rate.py b/xero_python/payrollnz/models/earnings_rate.py new file mode 100644 index 00000000..617ab7a3 --- /dev/null +++ b/xero_python/payrollnz/models/earnings_rate.py @@ -0,0 +1,386 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EarningsRate(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "earnings_rate_id": "str", + "name": "str", + "earnings_type": "str", + "rate_type": "str", + "type_of_units": "str", + "current_record": "bool", + "expense_account_id": "str", + "rate_per_unit": "float", + "multiple_of_ordinary_earnings_rate": "float", + "fixed_amount": "float", + } + + attribute_map = { + "earnings_rate_id": "earningsRateID", + "name": "name", + "earnings_type": "earningsType", + "rate_type": "rateType", + "type_of_units": "typeOfUnits", + "current_record": "currentRecord", + "expense_account_id": "expenseAccountID", + "rate_per_unit": "ratePerUnit", + "multiple_of_ordinary_earnings_rate": "multipleOfOrdinaryEarningsRate", + "fixed_amount": "fixedAmount", + } + + def __init__( + self, + earnings_rate_id=None, + name=None, + earnings_type=None, + rate_type=None, + type_of_units=None, + current_record=None, + expense_account_id=None, + rate_per_unit=None, + multiple_of_ordinary_earnings_rate=None, + fixed_amount=None, + ): # noqa: E501 + """EarningsRate - a model defined in OpenAPI""" # noqa: E501 + + self._earnings_rate_id = None + self._name = None + self._earnings_type = None + self._rate_type = None + self._type_of_units = None + self._current_record = None + self._expense_account_id = None + self._rate_per_unit = None + self._multiple_of_ordinary_earnings_rate = None + self._fixed_amount = None + self.discriminator = None + + if earnings_rate_id is not None: + self.earnings_rate_id = earnings_rate_id + self.name = name + self.earnings_type = earnings_type + self.rate_type = rate_type + self.type_of_units = type_of_units + if current_record is not None: + self.current_record = current_record + self.expense_account_id = expense_account_id + if rate_per_unit is not None: + self.rate_per_unit = rate_per_unit + if multiple_of_ordinary_earnings_rate is not None: + self.multiple_of_ordinary_earnings_rate = multiple_of_ordinary_earnings_rate + if fixed_amount is not None: + self.fixed_amount = fixed_amount + + @property + def earnings_rate_id(self): + """Gets the earnings_rate_id of this EarningsRate. # noqa: E501 + + Xero unique identifier for an earning rate # noqa: E501 + + :return: The earnings_rate_id of this EarningsRate. # noqa: E501 + :rtype: str + """ + return self._earnings_rate_id + + @earnings_rate_id.setter + def earnings_rate_id(self, earnings_rate_id): + """Sets the earnings_rate_id of this EarningsRate. + + Xero unique identifier for an earning rate # noqa: E501 + + :param earnings_rate_id: The earnings_rate_id of this EarningsRate. # noqa: E501 + :type: str + """ + + self._earnings_rate_id = earnings_rate_id + + @property + def name(self): + """Gets the name of this EarningsRate. # noqa: E501 + + Name of the earning rate # noqa: E501 + + :return: The name of this EarningsRate. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this EarningsRate. + + Name of the earning rate # noqa: E501 + + :param name: The name of this EarningsRate. # noqa: E501 + :type: str + """ + if name is None: + raise ValueError( + "Invalid value for `name`, must not be `None`" + ) # noqa: E501 + + self._name = name + + @property + def earnings_type(self): + """Gets the earnings_type of this EarningsRate. # noqa: E501 + + Indicates how an employee will be paid when taking this type of earning # noqa: E501 + + :return: The earnings_type of this EarningsRate. # noqa: E501 + :rtype: str + """ + return self._earnings_type + + @earnings_type.setter + def earnings_type(self, earnings_type): + """Sets the earnings_type of this EarningsRate. + + Indicates how an employee will be paid when taking this type of earning # noqa: E501 + + :param earnings_type: The earnings_type of this EarningsRate. # noqa: E501 + :type: str + """ + if earnings_type is None: + raise ValueError( + "Invalid value for `earnings_type`, must not be `None`" + ) # noqa: E501 + allowed_values = [ + "Allowance", + "Backpay", + "Bonus", + "Commission", + "DiscretionaryPayments", + "HolidayPay", + "LumpSum", + "OtherEarnings", + "OtherGrossEarnings", + "OvertimeEarnings", + "RegularEarnings", + "SalarySacrificeForKiwiSaver", + "Tips(Direct)", + "Tips(Non-Direct)", + "WithholdingIncome", + "None", + ] # noqa: E501 + if earnings_type not in allowed_values: + raise ValueError( + "Invalid value for `earnings_type` ({0}), must be one of {1}".format( # noqa: E501 + earnings_type, allowed_values + ) + ) + + self._earnings_type = earnings_type + + @property + def rate_type(self): + """Gets the rate_type of this EarningsRate. # noqa: E501 + + Indicates the type of the earning rate # noqa: E501 + + :return: The rate_type of this EarningsRate. # noqa: E501 + :rtype: str + """ + return self._rate_type + + @rate_type.setter + def rate_type(self, rate_type): + """Sets the rate_type of this EarningsRate. + + Indicates the type of the earning rate # noqa: E501 + + :param rate_type: The rate_type of this EarningsRate. # noqa: E501 + :type: str + """ + if rate_type is None: + raise ValueError( + "Invalid value for `rate_type`, must not be `None`" + ) # noqa: E501 + allowed_values = [ + "RatePerUnit", + "MultipleOfOrdinaryEarningsRate", + "FixedAmount", + "None", + ] # noqa: E501 + if rate_type not in allowed_values: + raise ValueError( + "Invalid value for `rate_type` ({0}), must be one of {1}".format( # noqa: E501 + rate_type, allowed_values + ) + ) + + self._rate_type = rate_type + + @property + def type_of_units(self): + """Gets the type_of_units of this EarningsRate. # noqa: E501 + + The type of units used to record earnings # noqa: E501 + + :return: The type_of_units of this EarningsRate. # noqa: E501 + :rtype: str + """ + return self._type_of_units + + @type_of_units.setter + def type_of_units(self, type_of_units): + """Sets the type_of_units of this EarningsRate. + + The type of units used to record earnings # noqa: E501 + + :param type_of_units: The type_of_units of this EarningsRate. # noqa: E501 + :type: str + """ + if type_of_units is None: + raise ValueError( + "Invalid value for `type_of_units`, must not be `None`" + ) # noqa: E501 + + self._type_of_units = type_of_units + + @property + def current_record(self): + """Gets the current_record of this EarningsRate. # noqa: E501 + + Indicates whether an earning type is active # noqa: E501 + + :return: The current_record of this EarningsRate. # noqa: E501 + :rtype: bool + """ + return self._current_record + + @current_record.setter + def current_record(self, current_record): + """Sets the current_record of this EarningsRate. + + Indicates whether an earning type is active # noqa: E501 + + :param current_record: The current_record of this EarningsRate. # noqa: E501 + :type: bool + """ + + self._current_record = current_record + + @property + def expense_account_id(self): + """Gets the expense_account_id of this EarningsRate. # noqa: E501 + + The account that will be used for the earnings rate # noqa: E501 + + :return: The expense_account_id of this EarningsRate. # noqa: E501 + :rtype: str + """ + return self._expense_account_id + + @expense_account_id.setter + def expense_account_id(self, expense_account_id): + """Sets the expense_account_id of this EarningsRate. + + The account that will be used for the earnings rate # noqa: E501 + + :param expense_account_id: The expense_account_id of this EarningsRate. # noqa: E501 + :type: str + """ + if expense_account_id is None: + raise ValueError( + "Invalid value for `expense_account_id`, must not be `None`" + ) # noqa: E501 + + self._expense_account_id = expense_account_id + + @property + def rate_per_unit(self): + """Gets the rate_per_unit of this EarningsRate. # noqa: E501 + + Default rate per unit (optional). Only applicable if RateType is RatePerUnit # noqa: E501 + + :return: The rate_per_unit of this EarningsRate. # noqa: E501 + :rtype: float + """ + return self._rate_per_unit + + @rate_per_unit.setter + def rate_per_unit(self, rate_per_unit): + """Sets the rate_per_unit of this EarningsRate. + + Default rate per unit (optional). Only applicable if RateType is RatePerUnit # noqa: E501 + + :param rate_per_unit: The rate_per_unit of this EarningsRate. # noqa: E501 + :type: float + """ + + self._rate_per_unit = rate_per_unit + + @property + def multiple_of_ordinary_earnings_rate(self): + """Gets the multiple_of_ordinary_earnings_rate of this EarningsRate. # noqa: E501 + + This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate. For example, for time and a half enter 1.5. Only applicable if RateType is MultipleOfOrdinaryEarningsRate # noqa: E501 + + :return: The multiple_of_ordinary_earnings_rate of this EarningsRate. # noqa: E501 + :rtype: float + """ + return self._multiple_of_ordinary_earnings_rate + + @multiple_of_ordinary_earnings_rate.setter + def multiple_of_ordinary_earnings_rate(self, multiple_of_ordinary_earnings_rate): + """Sets the multiple_of_ordinary_earnings_rate of this EarningsRate. + + This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate. For example, for time and a half enter 1.5. Only applicable if RateType is MultipleOfOrdinaryEarningsRate # noqa: E501 + + :param multiple_of_ordinary_earnings_rate: The multiple_of_ordinary_earnings_rate of this EarningsRate. # noqa: E501 + :type: float + """ + + self._multiple_of_ordinary_earnings_rate = multiple_of_ordinary_earnings_rate + + @property + def fixed_amount(self): + """Gets the fixed_amount of this EarningsRate. # noqa: E501 + + Optional Fixed Rate Amount. Applicable for FixedAmount Rate # noqa: E501 + + :return: The fixed_amount of this EarningsRate. # noqa: E501 + :rtype: float + """ + return self._fixed_amount + + @fixed_amount.setter + def fixed_amount(self, fixed_amount): + """Sets the fixed_amount of this EarningsRate. + + Optional Fixed Rate Amount. Applicable for FixedAmount Rate # noqa: E501 + + :param fixed_amount: The fixed_amount of this EarningsRate. # noqa: E501 + :type: float + """ + + self._fixed_amount = fixed_amount diff --git a/xero_python/payrollnz/models/earnings_rate_object.py b/xero_python/payrollnz/models/earnings_rate_object.py new file mode 100644 index 00000000..9d76628e --- /dev/null +++ b/xero_python/payrollnz/models/earnings_rate_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EarningsRateObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "earnings_rate": "EarningsRate", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "earnings_rate": "earningsRate", + } + + def __init__(self, pagination=None, problem=None, earnings_rate=None): # noqa: E501 + """EarningsRateObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._earnings_rate = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if earnings_rate is not None: + self.earnings_rate = earnings_rate + + @property + def pagination(self): + """Gets the pagination of this EarningsRateObject. # noqa: E501 + + + :return: The pagination of this EarningsRateObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EarningsRateObject. + + + :param pagination: The pagination of this EarningsRateObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EarningsRateObject. # noqa: E501 + + + :return: The problem of this EarningsRateObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EarningsRateObject. + + + :param problem: The problem of this EarningsRateObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def earnings_rate(self): + """Gets the earnings_rate of this EarningsRateObject. # noqa: E501 + + + :return: The earnings_rate of this EarningsRateObject. # noqa: E501 + :rtype: EarningsRate + """ + return self._earnings_rate + + @earnings_rate.setter + def earnings_rate(self, earnings_rate): + """Sets the earnings_rate of this EarningsRateObject. + + + :param earnings_rate: The earnings_rate of this EarningsRateObject. # noqa: E501 + :type: EarningsRate + """ + + self._earnings_rate = earnings_rate diff --git a/xero_python/payrollnz/models/earnings_rates.py b/xero_python/payrollnz/models/earnings_rates.py new file mode 100644 index 00000000..d7ef4162 --- /dev/null +++ b/xero_python/payrollnz/models/earnings_rates.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EarningsRates(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "earnings_rates": "list[EarningsRate]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "earnings_rates": "earningsRates", + } + + def __init__( + self, pagination=None, problem=None, earnings_rates=None + ): # noqa: E501 + """EarningsRates - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._earnings_rates = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if earnings_rates is not None: + self.earnings_rates = earnings_rates + + @property + def pagination(self): + """Gets the pagination of this EarningsRates. # noqa: E501 + + + :return: The pagination of this EarningsRates. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EarningsRates. + + + :param pagination: The pagination of this EarningsRates. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EarningsRates. # noqa: E501 + + + :return: The problem of this EarningsRates. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EarningsRates. + + + :param problem: The problem of this EarningsRates. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def earnings_rates(self): + """Gets the earnings_rates of this EarningsRates. # noqa: E501 + + + :return: The earnings_rates of this EarningsRates. # noqa: E501 + :rtype: list[EarningsRate] + """ + return self._earnings_rates + + @earnings_rates.setter + def earnings_rates(self, earnings_rates): + """Sets the earnings_rates of this EarningsRates. + + + :param earnings_rates: The earnings_rates of this EarningsRates. # noqa: E501 + :type: list[EarningsRate] + """ + + self._earnings_rates = earnings_rates diff --git a/xero_python/payrollnz/models/earnings_template.py b/xero_python/payrollnz/models/earnings_template.py new file mode 100644 index 00000000..0e759ec5 --- /dev/null +++ b/xero_python/payrollnz/models/earnings_template.py @@ -0,0 +1,219 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EarningsTemplate(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pay_template_earning_id": "str", + "rate_per_unit": "float", + "number_of_units": "float", + "fixed_amount": "float", + "earnings_rate_id": "str", + "name": "str", + } + + attribute_map = { + "pay_template_earning_id": "payTemplateEarningID", + "rate_per_unit": "ratePerUnit", + "number_of_units": "numberOfUnits", + "fixed_amount": "fixedAmount", + "earnings_rate_id": "earningsRateID", + "name": "name", + } + + def __init__( + self, + pay_template_earning_id=None, + rate_per_unit=None, + number_of_units=None, + fixed_amount=None, + earnings_rate_id=None, + name=None, + ): # noqa: E501 + """EarningsTemplate - a model defined in OpenAPI""" # noqa: E501 + + self._pay_template_earning_id = None + self._rate_per_unit = None + self._number_of_units = None + self._fixed_amount = None + self._earnings_rate_id = None + self._name = None + self.discriminator = None + + if pay_template_earning_id is not None: + self.pay_template_earning_id = pay_template_earning_id + if rate_per_unit is not None: + self.rate_per_unit = rate_per_unit + if number_of_units is not None: + self.number_of_units = number_of_units + if fixed_amount is not None: + self.fixed_amount = fixed_amount + if earnings_rate_id is not None: + self.earnings_rate_id = earnings_rate_id + if name is not None: + self.name = name + + @property + def pay_template_earning_id(self): + """Gets the pay_template_earning_id of this EarningsTemplate. # noqa: E501 + + The Xero identifier for the earnings template # noqa: E501 + + :return: The pay_template_earning_id of this EarningsTemplate. # noqa: E501 + :rtype: str + """ + return self._pay_template_earning_id + + @pay_template_earning_id.setter + def pay_template_earning_id(self, pay_template_earning_id): + """Sets the pay_template_earning_id of this EarningsTemplate. + + The Xero identifier for the earnings template # noqa: E501 + + :param pay_template_earning_id: The pay_template_earning_id of this EarningsTemplate. # noqa: E501 + :type: str + """ + + self._pay_template_earning_id = pay_template_earning_id + + @property + def rate_per_unit(self): + """Gets the rate_per_unit of this EarningsTemplate. # noqa: E501 + + The rate per unit # noqa: E501 + + :return: The rate_per_unit of this EarningsTemplate. # noqa: E501 + :rtype: float + """ + return self._rate_per_unit + + @rate_per_unit.setter + def rate_per_unit(self, rate_per_unit): + """Sets the rate_per_unit of this EarningsTemplate. + + The rate per unit # noqa: E501 + + :param rate_per_unit: The rate_per_unit of this EarningsTemplate. # noqa: E501 + :type: float + """ + + self._rate_per_unit = rate_per_unit + + @property + def number_of_units(self): + """Gets the number_of_units of this EarningsTemplate. # noqa: E501 + + The rate per unit # noqa: E501 + + :return: The number_of_units of this EarningsTemplate. # noqa: E501 + :rtype: float + """ + return self._number_of_units + + @number_of_units.setter + def number_of_units(self, number_of_units): + """Sets the number_of_units of this EarningsTemplate. + + The rate per unit # noqa: E501 + + :param number_of_units: The number_of_units of this EarningsTemplate. # noqa: E501 + :type: float + """ + + self._number_of_units = number_of_units + + @property + def fixed_amount(self): + """Gets the fixed_amount of this EarningsTemplate. # noqa: E501 + + The fixed amount per period # noqa: E501 + + :return: The fixed_amount of this EarningsTemplate. # noqa: E501 + :rtype: float + """ + return self._fixed_amount + + @fixed_amount.setter + def fixed_amount(self, fixed_amount): + """Sets the fixed_amount of this EarningsTemplate. + + The fixed amount per period # noqa: E501 + + :param fixed_amount: The fixed_amount of this EarningsTemplate. # noqa: E501 + :type: float + """ + + self._fixed_amount = fixed_amount + + @property + def earnings_rate_id(self): + """Gets the earnings_rate_id of this EarningsTemplate. # noqa: E501 + + The corresponding earnings rate identifier # noqa: E501 + + :return: The earnings_rate_id of this EarningsTemplate. # noqa: E501 + :rtype: str + """ + return self._earnings_rate_id + + @earnings_rate_id.setter + def earnings_rate_id(self, earnings_rate_id): + """Sets the earnings_rate_id of this EarningsTemplate. + + The corresponding earnings rate identifier # noqa: E501 + + :param earnings_rate_id: The earnings_rate_id of this EarningsTemplate. # noqa: E501 + :type: str + """ + + self._earnings_rate_id = earnings_rate_id + + @property + def name(self): + """Gets the name of this EarningsTemplate. # noqa: E501 + + The read-only name of the Earning Template. # noqa: E501 + + :return: The name of this EarningsTemplate. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this EarningsTemplate. + + The read-only name of the Earning Template. # noqa: E501 + + :param name: The name of this EarningsTemplate. # noqa: E501 + :type: str + """ + + self._name = name diff --git a/xero_python/payrollnz/models/earnings_template_object.py b/xero_python/payrollnz/models/earnings_template_object.py new file mode 100644 index 00000000..1e70eb49 --- /dev/null +++ b/xero_python/payrollnz/models/earnings_template_object.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EarningsTemplateObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "earning_template": "EarningsTemplate", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "earning_template": "earningTemplate", + } + + def __init__( + self, pagination=None, problem=None, earning_template=None + ): # noqa: E501 + """EarningsTemplateObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._earning_template = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if earning_template is not None: + self.earning_template = earning_template + + @property + def pagination(self): + """Gets the pagination of this EarningsTemplateObject. # noqa: E501 + + + :return: The pagination of this EarningsTemplateObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EarningsTemplateObject. + + + :param pagination: The pagination of this EarningsTemplateObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EarningsTemplateObject. # noqa: E501 + + + :return: The problem of this EarningsTemplateObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EarningsTemplateObject. + + + :param problem: The problem of this EarningsTemplateObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def earning_template(self): + """Gets the earning_template of this EarningsTemplateObject. # noqa: E501 + + + :return: The earning_template of this EarningsTemplateObject. # noqa: E501 + :rtype: EarningsTemplate + """ + return self._earning_template + + @earning_template.setter + def earning_template(self, earning_template): + """Sets the earning_template of this EarningsTemplateObject. + + + :param earning_template: The earning_template of this EarningsTemplateObject. # noqa: E501 + :type: EarningsTemplate + """ + + self._earning_template = earning_template diff --git a/xero_python/payrollnz/models/employee.py b/xero_python/payrollnz/models/employee.py new file mode 100644 index 00000000..b2076222 --- /dev/null +++ b/xero_python/payrollnz/models/employee.py @@ -0,0 +1,456 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Employee(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "employee_id": "str", + "title": "str", + "first_name": "str", + "last_name": "str", + "date_of_birth": "date", + "address": "Address", + "email": "str", + "gender": "str", + "phone_number": "str", + "start_date": "date", + "end_date": "date", + "payroll_calendar_id": "str", + "updated_date_utc": "datetime", + "created_date_utc": "datetime", + } + + attribute_map = { + "employee_id": "employeeID", + "title": "title", + "first_name": "firstName", + "last_name": "lastName", + "date_of_birth": "dateOfBirth", + "address": "address", + "email": "email", + "gender": "gender", + "phone_number": "phoneNumber", + "start_date": "startDate", + "end_date": "endDate", + "payroll_calendar_id": "payrollCalendarID", + "updated_date_utc": "updatedDateUTC", + "created_date_utc": "createdDateUTC", + } + + def __init__( + self, + employee_id=None, + title=None, + first_name=None, + last_name=None, + date_of_birth=None, + address=None, + email=None, + gender=None, + phone_number=None, + start_date=None, + end_date=None, + payroll_calendar_id=None, + updated_date_utc=None, + created_date_utc=None, + ): # noqa: E501 + """Employee - a model defined in OpenAPI""" # noqa: E501 + + self._employee_id = None + self._title = None + self._first_name = None + self._last_name = None + self._date_of_birth = None + self._address = None + self._email = None + self._gender = None + self._phone_number = None + self._start_date = None + self._end_date = None + self._payroll_calendar_id = None + self._updated_date_utc = None + self._created_date_utc = None + self.discriminator = None + + if employee_id is not None: + self.employee_id = employee_id + if title is not None: + self.title = title + if first_name is not None: + self.first_name = first_name + if last_name is not None: + self.last_name = last_name + if date_of_birth is not None: + self.date_of_birth = date_of_birth + if address is not None: + self.address = address + if email is not None: + self.email = email + if gender is not None: + self.gender = gender + if phone_number is not None: + self.phone_number = phone_number + if start_date is not None: + self.start_date = start_date + if end_date is not None: + self.end_date = end_date + if payroll_calendar_id is not None: + self.payroll_calendar_id = payroll_calendar_id + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + if created_date_utc is not None: + self.created_date_utc = created_date_utc + + @property + def employee_id(self): + """Gets the employee_id of this Employee. # noqa: E501 + + Xero unique identifier for the employee # noqa: E501 + + :return: The employee_id of this Employee. # noqa: E501 + :rtype: str + """ + return self._employee_id + + @employee_id.setter + def employee_id(self, employee_id): + """Sets the employee_id of this Employee. + + Xero unique identifier for the employee # noqa: E501 + + :param employee_id: The employee_id of this Employee. # noqa: E501 + :type: str + """ + + self._employee_id = employee_id + + @property + def title(self): + """Gets the title of this Employee. # noqa: E501 + + Title of the employee # noqa: E501 + + :return: The title of this Employee. # noqa: E501 + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """Sets the title of this Employee. + + Title of the employee # noqa: E501 + + :param title: The title of this Employee. # noqa: E501 + :type: str + """ + + self._title = title + + @property + def first_name(self): + """Gets the first_name of this Employee. # noqa: E501 + + First name of employee # noqa: E501 + + :return: The first_name of this Employee. # noqa: E501 + :rtype: str + """ + return self._first_name + + @first_name.setter + def first_name(self, first_name): + """Sets the first_name of this Employee. + + First name of employee # noqa: E501 + + :param first_name: The first_name of this Employee. # noqa: E501 + :type: str + """ + + self._first_name = first_name + + @property + def last_name(self): + """Gets the last_name of this Employee. # noqa: E501 + + Last name of employee # noqa: E501 + + :return: The last_name of this Employee. # noqa: E501 + :rtype: str + """ + return self._last_name + + @last_name.setter + def last_name(self, last_name): + """Sets the last_name of this Employee. + + Last name of employee # noqa: E501 + + :param last_name: The last_name of this Employee. # noqa: E501 + :type: str + """ + + self._last_name = last_name + + @property + def date_of_birth(self): + """Gets the date_of_birth of this Employee. # noqa: E501 + + Date of birth of the employee (YYYY-MM-DD) # noqa: E501 + + :return: The date_of_birth of this Employee. # noqa: E501 + :rtype: date + """ + return self._date_of_birth + + @date_of_birth.setter + def date_of_birth(self, date_of_birth): + """Sets the date_of_birth of this Employee. + + Date of birth of the employee (YYYY-MM-DD) # noqa: E501 + + :param date_of_birth: The date_of_birth of this Employee. # noqa: E501 + :type: date + """ + + self._date_of_birth = date_of_birth + + @property + def address(self): + """Gets the address of this Employee. # noqa: E501 + + + :return: The address of this Employee. # noqa: E501 + :rtype: Address + """ + return self._address + + @address.setter + def address(self, address): + """Sets the address of this Employee. + + + :param address: The address of this Employee. # noqa: E501 + :type: Address + """ + + self._address = address + + @property + def email(self): + """Gets the email of this Employee. # noqa: E501 + + The email address for the employee # noqa: E501 + + :return: The email of this Employee. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this Employee. + + The email address for the employee # noqa: E501 + + :param email: The email of this Employee. # noqa: E501 + :type: str + """ + + self._email = email + + @property + def gender(self): + """Gets the gender of this Employee. # noqa: E501 + + The employee’s gender # noqa: E501 + + :return: The gender of this Employee. # noqa: E501 + :rtype: str + """ + return self._gender + + @gender.setter + def gender(self, gender): + """Sets the gender of this Employee. + + The employee’s gender # noqa: E501 + + :param gender: The gender of this Employee. # noqa: E501 + :type: str + """ + allowed_values = ["M", "F", "None"] # noqa: E501 + if gender not in allowed_values: + raise ValueError( + "Invalid value for `gender` ({0}), must be one of {1}".format( # noqa: E501 + gender, allowed_values + ) + ) + + self._gender = gender + + @property + def phone_number(self): + """Gets the phone_number of this Employee. # noqa: E501 + + Employee phone number # noqa: E501 + + :return: The phone_number of this Employee. # noqa: E501 + :rtype: str + """ + return self._phone_number + + @phone_number.setter + def phone_number(self, phone_number): + """Sets the phone_number of this Employee. + + Employee phone number # noqa: E501 + + :param phone_number: The phone_number of this Employee. # noqa: E501 + :type: str + """ + + self._phone_number = phone_number + + @property + def start_date(self): + """Gets the start_date of this Employee. # noqa: E501 + + Employment start date of the employee at the time it was requested # noqa: E501 + + :return: The start_date of this Employee. # noqa: E501 + :rtype: date + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this Employee. + + Employment start date of the employee at the time it was requested # noqa: E501 + + :param start_date: The start_date of this Employee. # noqa: E501 + :type: date + """ + + self._start_date = start_date + + @property + def end_date(self): + """Gets the end_date of this Employee. # noqa: E501 + + Employment end date of the employee at the time it was requested # noqa: E501 + + :return: The end_date of this Employee. # noqa: E501 + :rtype: date + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this Employee. + + Employment end date of the employee at the time it was requested # noqa: E501 + + :param end_date: The end_date of this Employee. # noqa: E501 + :type: date + """ + + self._end_date = end_date + + @property + def payroll_calendar_id(self): + """Gets the payroll_calendar_id of this Employee. # noqa: E501 + + Xero unique identifier for the payroll calendar of the employee # noqa: E501 + + :return: The payroll_calendar_id of this Employee. # noqa: E501 + :rtype: str + """ + return self._payroll_calendar_id + + @payroll_calendar_id.setter + def payroll_calendar_id(self, payroll_calendar_id): + """Sets the payroll_calendar_id of this Employee. + + Xero unique identifier for the payroll calendar of the employee # noqa: E501 + + :param payroll_calendar_id: The payroll_calendar_id of this Employee. # noqa: E501 + :type: str + """ + + self._payroll_calendar_id = payroll_calendar_id + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this Employee. # noqa: E501 + + UTC timestamp of last update to the employee # noqa: E501 + + :return: The updated_date_utc of this Employee. # noqa: E501 + :rtype: datetime + """ + return self._updated_date_utc + + @updated_date_utc.setter + def updated_date_utc(self, updated_date_utc): + """Sets the updated_date_utc of this Employee. + + UTC timestamp of last update to the employee # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this Employee. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc + + @property + def created_date_utc(self): + """Gets the created_date_utc of this Employee. # noqa: E501 + + UTC timestamp when the employee was created in Xero # noqa: E501 + + :return: The created_date_utc of this Employee. # noqa: E501 + :rtype: datetime + """ + return self._created_date_utc + + @created_date_utc.setter + def created_date_utc(self, created_date_utc): + """Sets the created_date_utc of this Employee. + + UTC timestamp when the employee was created in Xero # noqa: E501 + + :param created_date_utc: The created_date_utc of this Employee. # noqa: E501 + :type: datetime + """ + + self._created_date_utc = created_date_utc diff --git a/xero_python/payrollnz/models/employee_earnings_templates.py b/xero_python/payrollnz/models/employee_earnings_templates.py new file mode 100644 index 00000000..5709d8da --- /dev/null +++ b/xero_python/payrollnz/models/employee_earnings_templates.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeEarningsTemplates(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "earning_templates": "list[EarningsTemplate]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "earning_templates": "earningTemplates", + } + + def __init__( + self, pagination=None, problem=None, earning_templates=None + ): # noqa: E501 + """EmployeeEarningsTemplates - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._earning_templates = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if earning_templates is not None: + self.earning_templates = earning_templates + + @property + def pagination(self): + """Gets the pagination of this EmployeeEarningsTemplates. # noqa: E501 + + + :return: The pagination of this EmployeeEarningsTemplates. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeEarningsTemplates. + + + :param pagination: The pagination of this EmployeeEarningsTemplates. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeEarningsTemplates. # noqa: E501 + + + :return: The problem of this EmployeeEarningsTemplates. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeEarningsTemplates. + + + :param problem: The problem of this EmployeeEarningsTemplates. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def earning_templates(self): + """Gets the earning_templates of this EmployeeEarningsTemplates. # noqa: E501 + + + :return: The earning_templates of this EmployeeEarningsTemplates. # noqa: E501 + :rtype: list[EarningsTemplate] + """ + return self._earning_templates + + @earning_templates.setter + def earning_templates(self, earning_templates): + """Sets the earning_templates of this EmployeeEarningsTemplates. + + + :param earning_templates: The earning_templates of this EmployeeEarningsTemplates. # noqa: E501 + :type: list[EarningsTemplate] + """ + + self._earning_templates = earning_templates diff --git a/xero_python/payrollnz/models/employee_leave.py b/xero_python/payrollnz/models/employee_leave.py new file mode 100644 index 00000000..af4a4c2d --- /dev/null +++ b/xero_python/payrollnz/models/employee_leave.py @@ -0,0 +1,260 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeLeave(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "leave_id": "str", + "leave_type_id": "str", + "description": "str", + "start_date": "date", + "end_date": "date", + "periods": "list[LeavePeriod]", + "updated_date_utc": "datetime", + } + + attribute_map = { + "leave_id": "leaveID", + "leave_type_id": "leaveTypeID", + "description": "description", + "start_date": "startDate", + "end_date": "endDate", + "periods": "periods", + "updated_date_utc": "updatedDateUTC", + } + + def __init__( + self, + leave_id=None, + leave_type_id=None, + description=None, + start_date=None, + end_date=None, + periods=None, + updated_date_utc=None, + ): # noqa: E501 + """EmployeeLeave - a model defined in OpenAPI""" # noqa: E501 + + self._leave_id = None + self._leave_type_id = None + self._description = None + self._start_date = None + self._end_date = None + self._periods = None + self._updated_date_utc = None + self.discriminator = None + + if leave_id is not None: + self.leave_id = leave_id + self.leave_type_id = leave_type_id + self.description = description + self.start_date = start_date + self.end_date = end_date + if periods is not None: + self.periods = periods + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + + @property + def leave_id(self): + """Gets the leave_id of this EmployeeLeave. # noqa: E501 + + The Xero identifier for LeaveType # noqa: E501 + + :return: The leave_id of this EmployeeLeave. # noqa: E501 + :rtype: str + """ + return self._leave_id + + @leave_id.setter + def leave_id(self, leave_id): + """Sets the leave_id of this EmployeeLeave. + + The Xero identifier for LeaveType # noqa: E501 + + :param leave_id: The leave_id of this EmployeeLeave. # noqa: E501 + :type: str + """ + + self._leave_id = leave_id + + @property + def leave_type_id(self): + """Gets the leave_type_id of this EmployeeLeave. # noqa: E501 + + The Xero identifier for LeaveType # noqa: E501 + + :return: The leave_type_id of this EmployeeLeave. # noqa: E501 + :rtype: str + """ + return self._leave_type_id + + @leave_type_id.setter + def leave_type_id(self, leave_type_id): + """Sets the leave_type_id of this EmployeeLeave. + + The Xero identifier for LeaveType # noqa: E501 + + :param leave_type_id: The leave_type_id of this EmployeeLeave. # noqa: E501 + :type: str + """ + if leave_type_id is None: + raise ValueError( + "Invalid value for `leave_type_id`, must not be `None`" + ) # noqa: E501 + + self._leave_type_id = leave_type_id + + @property + def description(self): + """Gets the description of this EmployeeLeave. # noqa: E501 + + The description of the leave (max length = 50) # noqa: E501 + + :return: The description of this EmployeeLeave. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this EmployeeLeave. + + The description of the leave (max length = 50) # noqa: E501 + + :param description: The description of this EmployeeLeave. # noqa: E501 + :type: str + """ + if description is None: + raise ValueError( + "Invalid value for `description`, must not be `None`" + ) # noqa: E501 + + self._description = description + + @property + def start_date(self): + """Gets the start_date of this EmployeeLeave. # noqa: E501 + + Start date of the leave (YYYY-MM-DD) # noqa: E501 + + :return: The start_date of this EmployeeLeave. # noqa: E501 + :rtype: date + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this EmployeeLeave. + + Start date of the leave (YYYY-MM-DD) # noqa: E501 + + :param start_date: The start_date of this EmployeeLeave. # noqa: E501 + :type: date + """ + if start_date is None: + raise ValueError( + "Invalid value for `start_date`, must not be `None`" + ) # noqa: E501 + + self._start_date = start_date + + @property + def end_date(self): + """Gets the end_date of this EmployeeLeave. # noqa: E501 + + End date of the leave (YYYY-MM-DD) # noqa: E501 + + :return: The end_date of this EmployeeLeave. # noqa: E501 + :rtype: date + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this EmployeeLeave. + + End date of the leave (YYYY-MM-DD) # noqa: E501 + + :param end_date: The end_date of this EmployeeLeave. # noqa: E501 + :type: date + """ + if end_date is None: + raise ValueError( + "Invalid value for `end_date`, must not be `None`" + ) # noqa: E501 + + self._end_date = end_date + + @property + def periods(self): + """Gets the periods of this EmployeeLeave. # noqa: E501 + + The leave period information. The StartDate, EndDate and NumberOfUnits needs to be specified when you do not want to calculate NumberOfUnits automatically. Using incorrect period StartDate and EndDate will result in automatic computation of the NumberOfUnits. # noqa: E501 + + :return: The periods of this EmployeeLeave. # noqa: E501 + :rtype: list[LeavePeriod] + """ + return self._periods + + @periods.setter + def periods(self, periods): + """Sets the periods of this EmployeeLeave. + + The leave period information. The StartDate, EndDate and NumberOfUnits needs to be specified when you do not want to calculate NumberOfUnits automatically. Using incorrect period StartDate and EndDate will result in automatic computation of the NumberOfUnits. # noqa: E501 + + :param periods: The periods of this EmployeeLeave. # noqa: E501 + :type: list[LeavePeriod] + """ + + self._periods = periods + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this EmployeeLeave. # noqa: E501 + + UTC timestamp of last update to the leave type note # noqa: E501 + + :return: The updated_date_utc of this EmployeeLeave. # noqa: E501 + :rtype: datetime + """ + return self._updated_date_utc + + @updated_date_utc.setter + def updated_date_utc(self, updated_date_utc): + """Sets the updated_date_utc of this EmployeeLeave. + + UTC timestamp of last update to the leave type note # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this EmployeeLeave. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc diff --git a/xero_python/payrollnz/models/employee_leave_balance.py b/xero_python/payrollnz/models/employee_leave_balance.py new file mode 100644 index 00000000..94563b18 --- /dev/null +++ b/xero_python/payrollnz/models/employee_leave_balance.py @@ -0,0 +1,157 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeLeaveBalance(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "name": "str", + "leave_type_id": "str", + "balance": "float", + "type_of_units": "str", + } + + attribute_map = { + "name": "name", + "leave_type_id": "leaveTypeID", + "balance": "balance", + "type_of_units": "typeOfUnits", + } + + def __init__( + self, name=None, leave_type_id=None, balance=None, type_of_units=None + ): # noqa: E501 + """EmployeeLeaveBalance - a model defined in OpenAPI""" # noqa: E501 + + self._name = None + self._leave_type_id = None + self._balance = None + self._type_of_units = None + self.discriminator = None + + if name is not None: + self.name = name + if leave_type_id is not None: + self.leave_type_id = leave_type_id + if balance is not None: + self.balance = balance + if type_of_units is not None: + self.type_of_units = type_of_units + + @property + def name(self): + """Gets the name of this EmployeeLeaveBalance. # noqa: E501 + + Name of the leave type. # noqa: E501 + + :return: The name of this EmployeeLeaveBalance. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this EmployeeLeaveBalance. + + Name of the leave type. # noqa: E501 + + :param name: The name of this EmployeeLeaveBalance. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def leave_type_id(self): + """Gets the leave_type_id of this EmployeeLeaveBalance. # noqa: E501 + + The Xero identifier for leave type # noqa: E501 + + :return: The leave_type_id of this EmployeeLeaveBalance. # noqa: E501 + :rtype: str + """ + return self._leave_type_id + + @leave_type_id.setter + def leave_type_id(self, leave_type_id): + """Sets the leave_type_id of this EmployeeLeaveBalance. + + The Xero identifier for leave type # noqa: E501 + + :param leave_type_id: The leave_type_id of this EmployeeLeaveBalance. # noqa: E501 + :type: str + """ + + self._leave_type_id = leave_type_id + + @property + def balance(self): + """Gets the balance of this EmployeeLeaveBalance. # noqa: E501 + + The employees current balance for the corresponding leave type. # noqa: E501 + + :return: The balance of this EmployeeLeaveBalance. # noqa: E501 + :rtype: float + """ + return self._balance + + @balance.setter + def balance(self, balance): + """Sets the balance of this EmployeeLeaveBalance. + + The employees current balance for the corresponding leave type. # noqa: E501 + + :param balance: The balance of this EmployeeLeaveBalance. # noqa: E501 + :type: float + """ + + self._balance = balance + + @property + def type_of_units(self): + """Gets the type_of_units of this EmployeeLeaveBalance. # noqa: E501 + + The type of the units of the leave. # noqa: E501 + + :return: The type_of_units of this EmployeeLeaveBalance. # noqa: E501 + :rtype: str + """ + return self._type_of_units + + @type_of_units.setter + def type_of_units(self, type_of_units): + """Sets the type_of_units of this EmployeeLeaveBalance. + + The type of the units of the leave. # noqa: E501 + + :param type_of_units: The type_of_units of this EmployeeLeaveBalance. # noqa: E501 + :type: str + """ + + self._type_of_units = type_of_units diff --git a/xero_python/payrollnz/models/employee_leave_balances.py b/xero_python/payrollnz/models/employee_leave_balances.py new file mode 100644 index 00000000..a8d7524b --- /dev/null +++ b/xero_python/payrollnz/models/employee_leave_balances.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeLeaveBalances(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "leave_balances": "list[EmployeeLeaveBalance]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "leave_balances": "leaveBalances", + } + + def __init__( + self, pagination=None, problem=None, leave_balances=None + ): # noqa: E501 + """EmployeeLeaveBalances - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._leave_balances = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if leave_balances is not None: + self.leave_balances = leave_balances + + @property + def pagination(self): + """Gets the pagination of this EmployeeLeaveBalances. # noqa: E501 + + + :return: The pagination of this EmployeeLeaveBalances. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeLeaveBalances. + + + :param pagination: The pagination of this EmployeeLeaveBalances. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeLeaveBalances. # noqa: E501 + + + :return: The problem of this EmployeeLeaveBalances. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeLeaveBalances. + + + :param problem: The problem of this EmployeeLeaveBalances. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def leave_balances(self): + """Gets the leave_balances of this EmployeeLeaveBalances. # noqa: E501 + + + :return: The leave_balances of this EmployeeLeaveBalances. # noqa: E501 + :rtype: list[EmployeeLeaveBalance] + """ + return self._leave_balances + + @leave_balances.setter + def leave_balances(self, leave_balances): + """Sets the leave_balances of this EmployeeLeaveBalances. + + + :param leave_balances: The leave_balances of this EmployeeLeaveBalances. # noqa: E501 + :type: list[EmployeeLeaveBalance] + """ + + self._leave_balances = leave_balances diff --git a/xero_python/payrollnz/models/employee_leave_object.py b/xero_python/payrollnz/models/employee_leave_object.py new file mode 100644 index 00000000..e82a1ed5 --- /dev/null +++ b/xero_python/payrollnz/models/employee_leave_object.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeLeaveObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "leave": "EmployeeLeave", + } + + attribute_map = {"pagination": "pagination", "problem": "problem", "leave": "leave"} + + def __init__(self, pagination=None, problem=None, leave=None): # noqa: E501 + """EmployeeLeaveObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._leave = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if leave is not None: + self.leave = leave + + @property + def pagination(self): + """Gets the pagination of this EmployeeLeaveObject. # noqa: E501 + + + :return: The pagination of this EmployeeLeaveObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeLeaveObject. + + + :param pagination: The pagination of this EmployeeLeaveObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeLeaveObject. # noqa: E501 + + + :return: The problem of this EmployeeLeaveObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeLeaveObject. + + + :param problem: The problem of this EmployeeLeaveObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def leave(self): + """Gets the leave of this EmployeeLeaveObject. # noqa: E501 + + + :return: The leave of this EmployeeLeaveObject. # noqa: E501 + :rtype: EmployeeLeave + """ + return self._leave + + @leave.setter + def leave(self, leave): + """Sets the leave of this EmployeeLeaveObject. + + + :param leave: The leave of this EmployeeLeaveObject. # noqa: E501 + :type: EmployeeLeave + """ + + self._leave = leave diff --git a/xero_python/payrollnz/models/employee_leave_setup.py b/xero_python/payrollnz/models/employee_leave_setup.py new file mode 100644 index 00000000..4fa646b7 --- /dev/null +++ b/xero_python/payrollnz/models/employee_leave_setup.py @@ -0,0 +1,256 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeLeaveSetup(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "include_holiday_pay": "bool", + "holiday_pay_opening_balance": "float", + "annual_leave_opening_balance": "float", + "negative_annual_leave_balance_paid_amount": "float", + "sick_leave_hours_to_accrue_annually": "float", + "sick_leave_maximum_hours_to_accrue": "float", + "sick_leave_opening_balance": "float", + } + + attribute_map = { + "include_holiday_pay": "includeHolidayPay", + "holiday_pay_opening_balance": "holidayPayOpeningBalance", + "annual_leave_opening_balance": "annualLeaveOpeningBalance", + "negative_annual_leave_balance_paid_amount": "negativeAnnualLeaveBalancePaidAmount", + "sick_leave_hours_to_accrue_annually": "sickLeaveHoursToAccrueAnnually", + "sick_leave_maximum_hours_to_accrue": "sickLeaveMaximumHoursToAccrue", + "sick_leave_opening_balance": "sickLeaveOpeningBalance", + } + + def __init__( + self, + include_holiday_pay=None, + holiday_pay_opening_balance=None, + annual_leave_opening_balance=None, + negative_annual_leave_balance_paid_amount=None, + sick_leave_hours_to_accrue_annually=None, + sick_leave_maximum_hours_to_accrue=None, + sick_leave_opening_balance=None, + ): # noqa: E501 + """EmployeeLeaveSetup - a model defined in OpenAPI""" # noqa: E501 + + self._include_holiday_pay = None + self._holiday_pay_opening_balance = None + self._annual_leave_opening_balance = None + self._negative_annual_leave_balance_paid_amount = None + self._sick_leave_hours_to_accrue_annually = None + self._sick_leave_maximum_hours_to_accrue = None + self._sick_leave_opening_balance = None + self.discriminator = None + + if include_holiday_pay is not None: + self.include_holiday_pay = include_holiday_pay + if holiday_pay_opening_balance is not None: + self.holiday_pay_opening_balance = holiday_pay_opening_balance + if annual_leave_opening_balance is not None: + self.annual_leave_opening_balance = annual_leave_opening_balance + if negative_annual_leave_balance_paid_amount is not None: + self.negative_annual_leave_balance_paid_amount = ( + negative_annual_leave_balance_paid_amount + ) + if sick_leave_hours_to_accrue_annually is not None: + self.sick_leave_hours_to_accrue_annually = ( + sick_leave_hours_to_accrue_annually + ) + if sick_leave_maximum_hours_to_accrue is not None: + self.sick_leave_maximum_hours_to_accrue = sick_leave_maximum_hours_to_accrue + if sick_leave_opening_balance is not None: + self.sick_leave_opening_balance = sick_leave_opening_balance + + @property + def include_holiday_pay(self): + """Gets the include_holiday_pay of this EmployeeLeaveSetup. # noqa: E501 + + Identifier if holiday pay will be included in each payslip # noqa: E501 + + :return: The include_holiday_pay of this EmployeeLeaveSetup. # noqa: E501 + :rtype: bool + """ + return self._include_holiday_pay + + @include_holiday_pay.setter + def include_holiday_pay(self, include_holiday_pay): + """Sets the include_holiday_pay of this EmployeeLeaveSetup. + + Identifier if holiday pay will be included in each payslip # noqa: E501 + + :param include_holiday_pay: The include_holiday_pay of this EmployeeLeaveSetup. # noqa: E501 + :type: bool + """ + + self._include_holiday_pay = include_holiday_pay + + @property + def holiday_pay_opening_balance(self): + """Gets the holiday_pay_opening_balance of this EmployeeLeaveSetup. # noqa: E501 + + Initial holiday pay balance. A percentage — usually 8% — of gross earnings since their last work anniversary. # noqa: E501 + + :return: The holiday_pay_opening_balance of this EmployeeLeaveSetup. # noqa: E501 + :rtype: float + """ + return self._holiday_pay_opening_balance + + @holiday_pay_opening_balance.setter + def holiday_pay_opening_balance(self, holiday_pay_opening_balance): + """Sets the holiday_pay_opening_balance of this EmployeeLeaveSetup. + + Initial holiday pay balance. A percentage — usually 8% — of gross earnings since their last work anniversary. # noqa: E501 + + :param holiday_pay_opening_balance: The holiday_pay_opening_balance of this EmployeeLeaveSetup. # noqa: E501 + :type: float + """ + + self._holiday_pay_opening_balance = holiday_pay_opening_balance + + @property + def annual_leave_opening_balance(self): + """Gets the annual_leave_opening_balance of this EmployeeLeaveSetup. # noqa: E501 + + Initial annual leave balance. The balance at their last anniversary, less any leave taken since then and excluding accrued annual leave. # noqa: E501 + + :return: The annual_leave_opening_balance of this EmployeeLeaveSetup. # noqa: E501 + :rtype: float + """ + return self._annual_leave_opening_balance + + @annual_leave_opening_balance.setter + def annual_leave_opening_balance(self, annual_leave_opening_balance): + """Sets the annual_leave_opening_balance of this EmployeeLeaveSetup. + + Initial annual leave balance. The balance at their last anniversary, less any leave taken since then and excluding accrued annual leave. # noqa: E501 + + :param annual_leave_opening_balance: The annual_leave_opening_balance of this EmployeeLeaveSetup. # noqa: E501 + :type: float + """ + + self._annual_leave_opening_balance = annual_leave_opening_balance + + @property + def negative_annual_leave_balance_paid_amount(self): + """Gets the negative_annual_leave_balance_paid_amount of this EmployeeLeaveSetup. # noqa: E501 + + The dollar value of annual leave opening balance if negative. # noqa: E501 + + :return: The negative_annual_leave_balance_paid_amount of this EmployeeLeaveSetup. # noqa: E501 + :rtype: float + """ + return self._negative_annual_leave_balance_paid_amount + + @negative_annual_leave_balance_paid_amount.setter + def negative_annual_leave_balance_paid_amount( + self, negative_annual_leave_balance_paid_amount + ): + """Sets the negative_annual_leave_balance_paid_amount of this EmployeeLeaveSetup. + + The dollar value of annual leave opening balance if negative. # noqa: E501 + + :param negative_annual_leave_balance_paid_amount: The negative_annual_leave_balance_paid_amount of this EmployeeLeaveSetup. # noqa: E501 + :type: float + """ + + self._negative_annual_leave_balance_paid_amount = ( + negative_annual_leave_balance_paid_amount + ) + + @property + def sick_leave_hours_to_accrue_annually(self): + """Gets the sick_leave_hours_to_accrue_annually of this EmployeeLeaveSetup. # noqa: E501 + + Number of hours accrued annually for sick leave. Multiply the number of days they're entitled to by the hours worked per day # noqa: E501 + + :return: The sick_leave_hours_to_accrue_annually of this EmployeeLeaveSetup. # noqa: E501 + :rtype: float + """ + return self._sick_leave_hours_to_accrue_annually + + @sick_leave_hours_to_accrue_annually.setter + def sick_leave_hours_to_accrue_annually(self, sick_leave_hours_to_accrue_annually): + """Sets the sick_leave_hours_to_accrue_annually of this EmployeeLeaveSetup. + + Number of hours accrued annually for sick leave. Multiply the number of days they're entitled to by the hours worked per day # noqa: E501 + + :param sick_leave_hours_to_accrue_annually: The sick_leave_hours_to_accrue_annually of this EmployeeLeaveSetup. # noqa: E501 + :type: float + """ + + self._sick_leave_hours_to_accrue_annually = sick_leave_hours_to_accrue_annually + + @property + def sick_leave_maximum_hours_to_accrue(self): + """Gets the sick_leave_maximum_hours_to_accrue of this EmployeeLeaveSetup. # noqa: E501 + + Maximum number of hours accrued annually for sick leave. Multiply the maximum days they can accrue by the hours worked per day # noqa: E501 + + :return: The sick_leave_maximum_hours_to_accrue of this EmployeeLeaveSetup. # noqa: E501 + :rtype: float + """ + return self._sick_leave_maximum_hours_to_accrue + + @sick_leave_maximum_hours_to_accrue.setter + def sick_leave_maximum_hours_to_accrue(self, sick_leave_maximum_hours_to_accrue): + """Sets the sick_leave_maximum_hours_to_accrue of this EmployeeLeaveSetup. + + Maximum number of hours accrued annually for sick leave. Multiply the maximum days they can accrue by the hours worked per day # noqa: E501 + + :param sick_leave_maximum_hours_to_accrue: The sick_leave_maximum_hours_to_accrue of this EmployeeLeaveSetup. # noqa: E501 + :type: float + """ + + self._sick_leave_maximum_hours_to_accrue = sick_leave_maximum_hours_to_accrue + + @property + def sick_leave_opening_balance(self): + """Gets the sick_leave_opening_balance of this EmployeeLeaveSetup. # noqa: E501 + + Initial sick leave balance. This will be positive unless they've taken sick leave in advance # noqa: E501 + + :return: The sick_leave_opening_balance of this EmployeeLeaveSetup. # noqa: E501 + :rtype: float + """ + return self._sick_leave_opening_balance + + @sick_leave_opening_balance.setter + def sick_leave_opening_balance(self, sick_leave_opening_balance): + """Sets the sick_leave_opening_balance of this EmployeeLeaveSetup. + + Initial sick leave balance. This will be positive unless they've taken sick leave in advance # noqa: E501 + + :param sick_leave_opening_balance: The sick_leave_opening_balance of this EmployeeLeaveSetup. # noqa: E501 + :type: float + """ + + self._sick_leave_opening_balance = sick_leave_opening_balance diff --git a/xero_python/payrollnz/models/employee_leave_setup_object.py b/xero_python/payrollnz/models/employee_leave_setup_object.py new file mode 100644 index 00000000..43d17e10 --- /dev/null +++ b/xero_python/payrollnz/models/employee_leave_setup_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeLeaveSetupObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "leave_setup": "EmployeeLeaveSetup", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "leave_setup": "leaveSetup", + } + + def __init__(self, pagination=None, problem=None, leave_setup=None): # noqa: E501 + """EmployeeLeaveSetupObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._leave_setup = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if leave_setup is not None: + self.leave_setup = leave_setup + + @property + def pagination(self): + """Gets the pagination of this EmployeeLeaveSetupObject. # noqa: E501 + + + :return: The pagination of this EmployeeLeaveSetupObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeLeaveSetupObject. + + + :param pagination: The pagination of this EmployeeLeaveSetupObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeLeaveSetupObject. # noqa: E501 + + + :return: The problem of this EmployeeLeaveSetupObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeLeaveSetupObject. + + + :param problem: The problem of this EmployeeLeaveSetupObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def leave_setup(self): + """Gets the leave_setup of this EmployeeLeaveSetupObject. # noqa: E501 + + + :return: The leave_setup of this EmployeeLeaveSetupObject. # noqa: E501 + :rtype: EmployeeLeaveSetup + """ + return self._leave_setup + + @leave_setup.setter + def leave_setup(self, leave_setup): + """Sets the leave_setup of this EmployeeLeaveSetupObject. + + + :param leave_setup: The leave_setup of this EmployeeLeaveSetupObject. # noqa: E501 + :type: EmployeeLeaveSetup + """ + + self._leave_setup = leave_setup diff --git a/xero_python/payrollnz/models/employee_leave_type.py b/xero_python/payrollnz/models/employee_leave_type.py new file mode 100644 index 00000000..0eeafa8f --- /dev/null +++ b/xero_python/payrollnz/models/employee_leave_type.py @@ -0,0 +1,348 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeLeaveType(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "leave_type_id": "str", + "schedule_of_accrual": "str", + "hours_accrued_annually": "float", + "maximum_to_accrue": "float", + "opening_balance": "float", + "rate_accrued_hourly": "float", + "percentage_of_gross_earnings": "float", + "include_holiday_pay_every_pay": "bool", + "show_annual_leave_in_advance": "bool", + "annual_leave_total_amount_paid": "float", + } + + attribute_map = { + "leave_type_id": "leaveTypeID", + "schedule_of_accrual": "scheduleOfAccrual", + "hours_accrued_annually": "hoursAccruedAnnually", + "maximum_to_accrue": "maximumToAccrue", + "opening_balance": "openingBalance", + "rate_accrued_hourly": "rateAccruedHourly", + "percentage_of_gross_earnings": "percentageOfGrossEarnings", + "include_holiday_pay_every_pay": "includeHolidayPayEveryPay", + "show_annual_leave_in_advance": "showAnnualLeaveInAdvance", + "annual_leave_total_amount_paid": "annualLeaveTotalAmountPaid", + } + + def __init__( + self, + leave_type_id=None, + schedule_of_accrual=None, + hours_accrued_annually=None, + maximum_to_accrue=None, + opening_balance=None, + rate_accrued_hourly=None, + percentage_of_gross_earnings=None, + include_holiday_pay_every_pay=None, + show_annual_leave_in_advance=None, + annual_leave_total_amount_paid=None, + ): # noqa: E501 + """EmployeeLeaveType - a model defined in OpenAPI""" # noqa: E501 + + self._leave_type_id = None + self._schedule_of_accrual = None + self._hours_accrued_annually = None + self._maximum_to_accrue = None + self._opening_balance = None + self._rate_accrued_hourly = None + self._percentage_of_gross_earnings = None + self._include_holiday_pay_every_pay = None + self._show_annual_leave_in_advance = None + self._annual_leave_total_amount_paid = None + self.discriminator = None + + if leave_type_id is not None: + self.leave_type_id = leave_type_id + if schedule_of_accrual is not None: + self.schedule_of_accrual = schedule_of_accrual + if hours_accrued_annually is not None: + self.hours_accrued_annually = hours_accrued_annually + if maximum_to_accrue is not None: + self.maximum_to_accrue = maximum_to_accrue + if opening_balance is not None: + self.opening_balance = opening_balance + if rate_accrued_hourly is not None: + self.rate_accrued_hourly = rate_accrued_hourly + if percentage_of_gross_earnings is not None: + self.percentage_of_gross_earnings = percentage_of_gross_earnings + if include_holiday_pay_every_pay is not None: + self.include_holiday_pay_every_pay = include_holiday_pay_every_pay + if show_annual_leave_in_advance is not None: + self.show_annual_leave_in_advance = show_annual_leave_in_advance + if annual_leave_total_amount_paid is not None: + self.annual_leave_total_amount_paid = annual_leave_total_amount_paid + + @property + def leave_type_id(self): + """Gets the leave_type_id of this EmployeeLeaveType. # noqa: E501 + + The Xero identifier for leave type # noqa: E501 + + :return: The leave_type_id of this EmployeeLeaveType. # noqa: E501 + :rtype: str + """ + return self._leave_type_id + + @leave_type_id.setter + def leave_type_id(self, leave_type_id): + """Sets the leave_type_id of this EmployeeLeaveType. + + The Xero identifier for leave type # noqa: E501 + + :param leave_type_id: The leave_type_id of this EmployeeLeaveType. # noqa: E501 + :type: str + """ + + self._leave_type_id = leave_type_id + + @property + def schedule_of_accrual(self): + """Gets the schedule_of_accrual of this EmployeeLeaveType. # noqa: E501 + + The schedule of accrual # noqa: E501 + + :return: The schedule_of_accrual of this EmployeeLeaveType. # noqa: E501 + :rtype: str + """ + return self._schedule_of_accrual + + @schedule_of_accrual.setter + def schedule_of_accrual(self, schedule_of_accrual): + """Sets the schedule_of_accrual of this EmployeeLeaveType. + + The schedule of accrual # noqa: E501 + + :param schedule_of_accrual: The schedule_of_accrual of this EmployeeLeaveType. # noqa: E501 + :type: str + """ + allowed_values = [ + "AnnuallyAfter6Months", + "OnAnniversaryDate", + "PercentageOfGrossEarnings", + "NoAccruals", + "None", + ] # noqa: E501 + if schedule_of_accrual not in allowed_values: + raise ValueError( + "Invalid value for `schedule_of_accrual` ({0}), must be one of {1}".format( # noqa: E501 + schedule_of_accrual, allowed_values + ) + ) + + self._schedule_of_accrual = schedule_of_accrual + + @property + def hours_accrued_annually(self): + """Gets the hours_accrued_annually of this EmployeeLeaveType. # noqa: E501 + + The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is \"OnHourWorked\" # noqa: E501 + + :return: The hours_accrued_annually of this EmployeeLeaveType. # noqa: E501 + :rtype: float + """ + return self._hours_accrued_annually + + @hours_accrued_annually.setter + def hours_accrued_annually(self, hours_accrued_annually): + """Sets the hours_accrued_annually of this EmployeeLeaveType. + + The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is \"OnHourWorked\" # noqa: E501 + + :param hours_accrued_annually: The hours_accrued_annually of this EmployeeLeaveType. # noqa: E501 + :type: float + """ + + self._hours_accrued_annually = hours_accrued_annually + + @property + def maximum_to_accrue(self): + """Gets the maximum_to_accrue of this EmployeeLeaveType. # noqa: E501 + + The maximum number of hours that can be accrued for the leave # noqa: E501 + + :return: The maximum_to_accrue of this EmployeeLeaveType. # noqa: E501 + :rtype: float + """ + return self._maximum_to_accrue + + @maximum_to_accrue.setter + def maximum_to_accrue(self, maximum_to_accrue): + """Sets the maximum_to_accrue of this EmployeeLeaveType. + + The maximum number of hours that can be accrued for the leave # noqa: E501 + + :param maximum_to_accrue: The maximum_to_accrue of this EmployeeLeaveType. # noqa: E501 + :type: float + """ + + self._maximum_to_accrue = maximum_to_accrue + + @property + def opening_balance(self): + """Gets the opening_balance of this EmployeeLeaveType. # noqa: E501 + + The initial number of hours assigned when the leave was added to the employee # noqa: E501 + + :return: The opening_balance of this EmployeeLeaveType. # noqa: E501 + :rtype: float + """ + return self._opening_balance + + @opening_balance.setter + def opening_balance(self, opening_balance): + """Sets the opening_balance of this EmployeeLeaveType. + + The initial number of hours assigned when the leave was added to the employee # noqa: E501 + + :param opening_balance: The opening_balance of this EmployeeLeaveType. # noqa: E501 + :type: float + """ + + self._opening_balance = opening_balance + + @property + def rate_accrued_hourly(self): + """Gets the rate_accrued_hourly of this EmployeeLeaveType. # noqa: E501 + + The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\" # noqa: E501 + + :return: The rate_accrued_hourly of this EmployeeLeaveType. # noqa: E501 + :rtype: float + """ + return self._rate_accrued_hourly + + @rate_accrued_hourly.setter + def rate_accrued_hourly(self, rate_accrued_hourly): + """Sets the rate_accrued_hourly of this EmployeeLeaveType. + + The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\" # noqa: E501 + + :param rate_accrued_hourly: The rate_accrued_hourly of this EmployeeLeaveType. # noqa: E501 + :type: float + """ + + self._rate_accrued_hourly = rate_accrued_hourly + + @property + def percentage_of_gross_earnings(self): + """Gets the percentage_of_gross_earnings of this EmployeeLeaveType. # noqa: E501 + + Specific for scheduleOfAccrual having percentage of gross earnings. Identifies how much percentage of gross earnings is accrued per pay period. # noqa: E501 + + :return: The percentage_of_gross_earnings of this EmployeeLeaveType. # noqa: E501 + :rtype: float + """ + return self._percentage_of_gross_earnings + + @percentage_of_gross_earnings.setter + def percentage_of_gross_earnings(self, percentage_of_gross_earnings): + """Sets the percentage_of_gross_earnings of this EmployeeLeaveType. + + Specific for scheduleOfAccrual having percentage of gross earnings. Identifies how much percentage of gross earnings is accrued per pay period. # noqa: E501 + + :param percentage_of_gross_earnings: The percentage_of_gross_earnings of this EmployeeLeaveType. # noqa: E501 + :type: float + """ + + self._percentage_of_gross_earnings = percentage_of_gross_earnings + + @property + def include_holiday_pay_every_pay(self): + """Gets the include_holiday_pay_every_pay of this EmployeeLeaveType. # noqa: E501 + + Specific to Holiday pay. Flag determining if pay for leave type is added on each pay run. # noqa: E501 + + :return: The include_holiday_pay_every_pay of this EmployeeLeaveType. # noqa: E501 + :rtype: bool + """ + return self._include_holiday_pay_every_pay + + @include_holiday_pay_every_pay.setter + def include_holiday_pay_every_pay(self, include_holiday_pay_every_pay): + """Sets the include_holiday_pay_every_pay of this EmployeeLeaveType. + + Specific to Holiday pay. Flag determining if pay for leave type is added on each pay run. # noqa: E501 + + :param include_holiday_pay_every_pay: The include_holiday_pay_every_pay of this EmployeeLeaveType. # noqa: E501 + :type: bool + """ + + self._include_holiday_pay_every_pay = include_holiday_pay_every_pay + + @property + def show_annual_leave_in_advance(self): + """Gets the show_annual_leave_in_advance of this EmployeeLeaveType. # noqa: E501 + + Specific to Annual Leave. Flag to include leave available to take in advance in the balance in the payslip # noqa: E501 + + :return: The show_annual_leave_in_advance of this EmployeeLeaveType. # noqa: E501 + :rtype: bool + """ + return self._show_annual_leave_in_advance + + @show_annual_leave_in_advance.setter + def show_annual_leave_in_advance(self, show_annual_leave_in_advance): + """Sets the show_annual_leave_in_advance of this EmployeeLeaveType. + + Specific to Annual Leave. Flag to include leave available to take in advance in the balance in the payslip # noqa: E501 + + :param show_annual_leave_in_advance: The show_annual_leave_in_advance of this EmployeeLeaveType. # noqa: E501 + :type: bool + """ + + self._show_annual_leave_in_advance = show_annual_leave_in_advance + + @property + def annual_leave_total_amount_paid(self): + """Gets the annual_leave_total_amount_paid of this EmployeeLeaveType. # noqa: E501 + + Specific to Annual Leave. Annual leave balance in dollars # noqa: E501 + + :return: The annual_leave_total_amount_paid of this EmployeeLeaveType. # noqa: E501 + :rtype: float + """ + return self._annual_leave_total_amount_paid + + @annual_leave_total_amount_paid.setter + def annual_leave_total_amount_paid(self, annual_leave_total_amount_paid): + """Sets the annual_leave_total_amount_paid of this EmployeeLeaveType. + + Specific to Annual Leave. Annual leave balance in dollars # noqa: E501 + + :param annual_leave_total_amount_paid: The annual_leave_total_amount_paid of this EmployeeLeaveType. # noqa: E501 + :type: float + """ + + self._annual_leave_total_amount_paid = annual_leave_total_amount_paid diff --git a/xero_python/payrollnz/models/employee_leave_type_object.py b/xero_python/payrollnz/models/employee_leave_type_object.py new file mode 100644 index 00000000..35f42c25 --- /dev/null +++ b/xero_python/payrollnz/models/employee_leave_type_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeLeaveTypeObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "leave_type": "EmployeeLeaveType", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "leave_type": "leaveType", + } + + def __init__(self, pagination=None, problem=None, leave_type=None): # noqa: E501 + """EmployeeLeaveTypeObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._leave_type = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if leave_type is not None: + self.leave_type = leave_type + + @property + def pagination(self): + """Gets the pagination of this EmployeeLeaveTypeObject. # noqa: E501 + + + :return: The pagination of this EmployeeLeaveTypeObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeLeaveTypeObject. + + + :param pagination: The pagination of this EmployeeLeaveTypeObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeLeaveTypeObject. # noqa: E501 + + + :return: The problem of this EmployeeLeaveTypeObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeLeaveTypeObject. + + + :param problem: The problem of this EmployeeLeaveTypeObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def leave_type(self): + """Gets the leave_type of this EmployeeLeaveTypeObject. # noqa: E501 + + + :return: The leave_type of this EmployeeLeaveTypeObject. # noqa: E501 + :rtype: EmployeeLeaveType + """ + return self._leave_type + + @leave_type.setter + def leave_type(self, leave_type): + """Sets the leave_type of this EmployeeLeaveTypeObject. + + + :param leave_type: The leave_type of this EmployeeLeaveTypeObject. # noqa: E501 + :type: EmployeeLeaveType + """ + + self._leave_type = leave_type diff --git a/xero_python/payrollnz/models/employee_leave_types.py b/xero_python/payrollnz/models/employee_leave_types.py new file mode 100644 index 00000000..5a51bd50 --- /dev/null +++ b/xero_python/payrollnz/models/employee_leave_types.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeLeaveTypes(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "leave_types": "list[EmployeeLeaveType]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "leave_types": "leaveTypes", + } + + def __init__(self, pagination=None, problem=None, leave_types=None): # noqa: E501 + """EmployeeLeaveTypes - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._leave_types = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if leave_types is not None: + self.leave_types = leave_types + + @property + def pagination(self): + """Gets the pagination of this EmployeeLeaveTypes. # noqa: E501 + + + :return: The pagination of this EmployeeLeaveTypes. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeLeaveTypes. + + + :param pagination: The pagination of this EmployeeLeaveTypes. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeLeaveTypes. # noqa: E501 + + + :return: The problem of this EmployeeLeaveTypes. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeLeaveTypes. + + + :param problem: The problem of this EmployeeLeaveTypes. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def leave_types(self): + """Gets the leave_types of this EmployeeLeaveTypes. # noqa: E501 + + + :return: The leave_types of this EmployeeLeaveTypes. # noqa: E501 + :rtype: list[EmployeeLeaveType] + """ + return self._leave_types + + @leave_types.setter + def leave_types(self, leave_types): + """Sets the leave_types of this EmployeeLeaveTypes. + + + :param leave_types: The leave_types of this EmployeeLeaveTypes. # noqa: E501 + :type: list[EmployeeLeaveType] + """ + + self._leave_types = leave_types diff --git a/xero_python/payrollnz/models/employee_leaves.py b/xero_python/payrollnz/models/employee_leaves.py new file mode 100644 index 00000000..d139918e --- /dev/null +++ b/xero_python/payrollnz/models/employee_leaves.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeLeaves(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "leave": "list[EmployeeLeave]", + } + + attribute_map = {"pagination": "pagination", "problem": "problem", "leave": "leave"} + + def __init__(self, pagination=None, problem=None, leave=None): # noqa: E501 + """EmployeeLeaves - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._leave = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if leave is not None: + self.leave = leave + + @property + def pagination(self): + """Gets the pagination of this EmployeeLeaves. # noqa: E501 + + + :return: The pagination of this EmployeeLeaves. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeLeaves. + + + :param pagination: The pagination of this EmployeeLeaves. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeLeaves. # noqa: E501 + + + :return: The problem of this EmployeeLeaves. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeLeaves. + + + :param problem: The problem of this EmployeeLeaves. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def leave(self): + """Gets the leave of this EmployeeLeaves. # noqa: E501 + + + :return: The leave of this EmployeeLeaves. # noqa: E501 + :rtype: list[EmployeeLeave] + """ + return self._leave + + @leave.setter + def leave(self, leave): + """Sets the leave of this EmployeeLeaves. + + + :param leave: The leave of this EmployeeLeaves. # noqa: E501 + :type: list[EmployeeLeave] + """ + + self._leave = leave diff --git a/xero_python/payrollnz/models/employee_object.py b/xero_python/payrollnz/models/employee_object.py new file mode 100644 index 00000000..b8cb68e0 --- /dev/null +++ b/xero_python/payrollnz/models/employee_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "employee": "Employee", + "problem": "Problem", + } + + attribute_map = { + "pagination": "pagination", + "employee": "employee", + "problem": "problem", + } + + def __init__(self, pagination=None, employee=None, problem=None): # noqa: E501 + """EmployeeObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._employee = None + self._problem = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if employee is not None: + self.employee = employee + if problem is not None: + self.problem = problem + + @property + def pagination(self): + """Gets the pagination of this EmployeeObject. # noqa: E501 + + + :return: The pagination of this EmployeeObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeObject. + + + :param pagination: The pagination of this EmployeeObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def employee(self): + """Gets the employee of this EmployeeObject. # noqa: E501 + + + :return: The employee of this EmployeeObject. # noqa: E501 + :rtype: Employee + """ + return self._employee + + @employee.setter + def employee(self, employee): + """Sets the employee of this EmployeeObject. + + + :param employee: The employee of this EmployeeObject. # noqa: E501 + :type: Employee + """ + + self._employee = employee + + @property + def problem(self): + """Gets the problem of this EmployeeObject. # noqa: E501 + + + :return: The problem of this EmployeeObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeObject. + + + :param problem: The problem of this EmployeeObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem diff --git a/xero_python/payrollnz/models/employee_opening_balance.py b/xero_python/payrollnz/models/employee_opening_balance.py new file mode 100644 index 00000000..2839e298 --- /dev/null +++ b/xero_python/payrollnz/models/employee_opening_balance.py @@ -0,0 +1,161 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeOpeningBalance(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "period_end_date": "date", + "days_paid": "int", + "unpaid_weeks": "int", + "gross_earnings": "float", + } + + attribute_map = { + "period_end_date": "periodEndDate", + "days_paid": "daysPaid", + "unpaid_weeks": "unpaidWeeks", + "gross_earnings": "grossEarnings", + } + + def __init__( + self, + period_end_date=None, + days_paid=None, + unpaid_weeks=None, + gross_earnings=None, + ): # noqa: E501 + """EmployeeOpeningBalance - a model defined in OpenAPI""" # noqa: E501 + + self._period_end_date = None + self._days_paid = None + self._unpaid_weeks = None + self._gross_earnings = None + self.discriminator = None + + if period_end_date is not None: + self.period_end_date = period_end_date + if days_paid is not None: + self.days_paid = days_paid + if unpaid_weeks is not None: + self.unpaid_weeks = unpaid_weeks + if gross_earnings is not None: + self.gross_earnings = gross_earnings + + @property + def period_end_date(self): + """Gets the period_end_date of this EmployeeOpeningBalance. # noqa: E501 + + The opening balance period end date. # noqa: E501 + + :return: The period_end_date of this EmployeeOpeningBalance. # noqa: E501 + :rtype: date + """ + return self._period_end_date + + @period_end_date.setter + def period_end_date(self, period_end_date): + """Sets the period_end_date of this EmployeeOpeningBalance. + + The opening balance period end date. # noqa: E501 + + :param period_end_date: The period_end_date of this EmployeeOpeningBalance. # noqa: E501 + :type: date + """ + + self._period_end_date = period_end_date + + @property + def days_paid(self): + """Gets the days_paid of this EmployeeOpeningBalance. # noqa: E501 + + The paid number of days. # noqa: E501 + + :return: The days_paid of this EmployeeOpeningBalance. # noqa: E501 + :rtype: int + """ + return self._days_paid + + @days_paid.setter + def days_paid(self, days_paid): + """Sets the days_paid of this EmployeeOpeningBalance. + + The paid number of days. # noqa: E501 + + :param days_paid: The days_paid of this EmployeeOpeningBalance. # noqa: E501 + :type: int + """ + + self._days_paid = days_paid + + @property + def unpaid_weeks(self): + """Gets the unpaid_weeks of this EmployeeOpeningBalance. # noqa: E501 + + The number of unpaid weeks. # noqa: E501 + + :return: The unpaid_weeks of this EmployeeOpeningBalance. # noqa: E501 + :rtype: int + """ + return self._unpaid_weeks + + @unpaid_weeks.setter + def unpaid_weeks(self, unpaid_weeks): + """Sets the unpaid_weeks of this EmployeeOpeningBalance. + + The number of unpaid weeks. # noqa: E501 + + :param unpaid_weeks: The unpaid_weeks of this EmployeeOpeningBalance. # noqa: E501 + :type: int + """ + + self._unpaid_weeks = unpaid_weeks + + @property + def gross_earnings(self): + """Gets the gross_earnings of this EmployeeOpeningBalance. # noqa: E501 + + The gross earnings during the period. # noqa: E501 + + :return: The gross_earnings of this EmployeeOpeningBalance. # noqa: E501 + :rtype: float + """ + return self._gross_earnings + + @gross_earnings.setter + def gross_earnings(self, gross_earnings): + """Sets the gross_earnings of this EmployeeOpeningBalance. + + The gross earnings during the period. # noqa: E501 + + :param gross_earnings: The gross_earnings of this EmployeeOpeningBalance. # noqa: E501 + :type: float + """ + + self._gross_earnings = gross_earnings diff --git a/xero_python/payrollnz/models/employee_opening_balances_object.py b/xero_python/payrollnz/models/employee_opening_balances_object.py new file mode 100644 index 00000000..439e26b0 --- /dev/null +++ b/xero_python/payrollnz/models/employee_opening_balances_object.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeOpeningBalancesObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "opening_balances": "list[EmployeeOpeningBalance]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "opening_balances": "openingBalances", + } + + def __init__( + self, pagination=None, problem=None, opening_balances=None + ): # noqa: E501 + """EmployeeOpeningBalancesObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._opening_balances = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if opening_balances is not None: + self.opening_balances = opening_balances + + @property + def pagination(self): + """Gets the pagination of this EmployeeOpeningBalancesObject. # noqa: E501 + + + :return: The pagination of this EmployeeOpeningBalancesObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeOpeningBalancesObject. + + + :param pagination: The pagination of this EmployeeOpeningBalancesObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeOpeningBalancesObject. # noqa: E501 + + + :return: The problem of this EmployeeOpeningBalancesObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeOpeningBalancesObject. + + + :param problem: The problem of this EmployeeOpeningBalancesObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def opening_balances(self): + """Gets the opening_balances of this EmployeeOpeningBalancesObject. # noqa: E501 + + + :return: The opening_balances of this EmployeeOpeningBalancesObject. # noqa: E501 + :rtype: list[EmployeeOpeningBalance] + """ + return self._opening_balances + + @opening_balances.setter + def opening_balances(self, opening_balances): + """Sets the opening_balances of this EmployeeOpeningBalancesObject. + + + :param opening_balances: The opening_balances of this EmployeeOpeningBalancesObject. # noqa: E501 + :type: list[EmployeeOpeningBalance] + """ + + self._opening_balances = opening_balances diff --git a/xero_python/payrollnz/models/employee_pay_template.py b/xero_python/payrollnz/models/employee_pay_template.py new file mode 100644 index 00000000..377ec68b --- /dev/null +++ b/xero_python/payrollnz/models/employee_pay_template.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeePayTemplate(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "employee_id": "str", + "earning_templates": "list[EarningsTemplate]", + } + + attribute_map = { + "employee_id": "employeeID", + "earning_templates": "earningTemplates", + } + + def __init__(self, employee_id=None, earning_templates=None): # noqa: E501 + """EmployeePayTemplate - a model defined in OpenAPI""" # noqa: E501 + + self._employee_id = None + self._earning_templates = None + self.discriminator = None + + if employee_id is not None: + self.employee_id = employee_id + if earning_templates is not None: + self.earning_templates = earning_templates + + @property + def employee_id(self): + """Gets the employee_id of this EmployeePayTemplate. # noqa: E501 + + Unique identifier for the employee # noqa: E501 + + :return: The employee_id of this EmployeePayTemplate. # noqa: E501 + :rtype: str + """ + return self._employee_id + + @employee_id.setter + def employee_id(self, employee_id): + """Sets the employee_id of this EmployeePayTemplate. + + Unique identifier for the employee # noqa: E501 + + :param employee_id: The employee_id of this EmployeePayTemplate. # noqa: E501 + :type: str + """ + + self._employee_id = employee_id + + @property + def earning_templates(self): + """Gets the earning_templates of this EmployeePayTemplate. # noqa: E501 + + + :return: The earning_templates of this EmployeePayTemplate. # noqa: E501 + :rtype: list[EarningsTemplate] + """ + return self._earning_templates + + @earning_templates.setter + def earning_templates(self, earning_templates): + """Sets the earning_templates of this EmployeePayTemplate. + + + :param earning_templates: The earning_templates of this EmployeePayTemplate. # noqa: E501 + :type: list[EarningsTemplate] + """ + + self._earning_templates = earning_templates diff --git a/xero_python/payrollnz/models/employee_pay_template_object.py b/xero_python/payrollnz/models/employee_pay_template_object.py new file mode 100644 index 00000000..0c444b5e --- /dev/null +++ b/xero_python/payrollnz/models/employee_pay_template_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeePayTemplateObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "pay_template": "EmployeePayTemplate", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "pay_template": "payTemplate", + } + + def __init__(self, pagination=None, problem=None, pay_template=None): # noqa: E501 + """EmployeePayTemplateObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._pay_template = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if pay_template is not None: + self.pay_template = pay_template + + @property + def pagination(self): + """Gets the pagination of this EmployeePayTemplateObject. # noqa: E501 + + + :return: The pagination of this EmployeePayTemplateObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeePayTemplateObject. + + + :param pagination: The pagination of this EmployeePayTemplateObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeePayTemplateObject. # noqa: E501 + + + :return: The problem of this EmployeePayTemplateObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeePayTemplateObject. + + + :param problem: The problem of this EmployeePayTemplateObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def pay_template(self): + """Gets the pay_template of this EmployeePayTemplateObject. # noqa: E501 + + + :return: The pay_template of this EmployeePayTemplateObject. # noqa: E501 + :rtype: EmployeePayTemplate + """ + return self._pay_template + + @pay_template.setter + def pay_template(self, pay_template): + """Sets the pay_template of this EmployeePayTemplateObject. + + + :param pay_template: The pay_template of this EmployeePayTemplateObject. # noqa: E501 + :type: EmployeePayTemplate + """ + + self._pay_template = pay_template diff --git a/xero_python/payrollnz/models/employee_pay_templates.py b/xero_python/payrollnz/models/employee_pay_templates.py new file mode 100644 index 00000000..650ad3aa --- /dev/null +++ b/xero_python/payrollnz/models/employee_pay_templates.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeePayTemplates(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "pay_template": "EmployeePayTemplate", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "pay_template": "payTemplate", + } + + def __init__(self, pagination=None, problem=None, pay_template=None): # noqa: E501 + """EmployeePayTemplates - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._pay_template = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if pay_template is not None: + self.pay_template = pay_template + + @property + def pagination(self): + """Gets the pagination of this EmployeePayTemplates. # noqa: E501 + + + :return: The pagination of this EmployeePayTemplates. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeePayTemplates. + + + :param pagination: The pagination of this EmployeePayTemplates. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeePayTemplates. # noqa: E501 + + + :return: The problem of this EmployeePayTemplates. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeePayTemplates. + + + :param problem: The problem of this EmployeePayTemplates. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def pay_template(self): + """Gets the pay_template of this EmployeePayTemplates. # noqa: E501 + + + :return: The pay_template of this EmployeePayTemplates. # noqa: E501 + :rtype: EmployeePayTemplate + """ + return self._pay_template + + @pay_template.setter + def pay_template(self, pay_template): + """Sets the pay_template of this EmployeePayTemplates. + + + :param pay_template: The pay_template of this EmployeePayTemplates. # noqa: E501 + :type: EmployeePayTemplate + """ + + self._pay_template = pay_template diff --git a/xero_python/payrollnz/models/employee_statutory_leave_balance.py b/xero_python/payrollnz/models/employee_statutory_leave_balance.py new file mode 100644 index 00000000..f9cc4023 --- /dev/null +++ b/xero_python/payrollnz/models/employee_statutory_leave_balance.py @@ -0,0 +1,146 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeStatutoryLeaveBalance(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"leave_type": "str", "balance_remaining": "float", "units": "str"} + + attribute_map = { + "leave_type": "leaveType", + "balance_remaining": "balanceRemaining", + "units": "units", + } + + def __init__( + self, leave_type=None, balance_remaining=None, units=None + ): # noqa: E501 + """EmployeeStatutoryLeaveBalance - a model defined in OpenAPI""" # noqa: E501 + + self._leave_type = None + self._balance_remaining = None + self._units = None + self.discriminator = None + + if leave_type is not None: + self.leave_type = leave_type + if balance_remaining is not None: + self.balance_remaining = balance_remaining + if units is not None: + self.units = units + + @property + def leave_type(self): + """Gets the leave_type of this EmployeeStatutoryLeaveBalance. # noqa: E501 + + The type of statutory leave # noqa: E501 + + :return: The leave_type of this EmployeeStatutoryLeaveBalance. # noqa: E501 + :rtype: str + """ + return self._leave_type + + @leave_type.setter + def leave_type(self, leave_type): + """Sets the leave_type of this EmployeeStatutoryLeaveBalance. + + The type of statutory leave # noqa: E501 + + :param leave_type: The leave_type of this EmployeeStatutoryLeaveBalance. # noqa: E501 + :type: str + """ + allowed_values = [ + "Sick", + "Adoption", + "Maternity", + "Paternity", + "Sharedparental", + "None", + ] # noqa: E501 + if leave_type not in allowed_values: + raise ValueError( + "Invalid value for `leave_type` ({0}), must be one of {1}".format( # noqa: E501 + leave_type, allowed_values + ) + ) + + self._leave_type = leave_type + + @property + def balance_remaining(self): + """Gets the balance_remaining of this EmployeeStatutoryLeaveBalance. # noqa: E501 + + The balance remaining for the corresponding leave type as of specified date. # noqa: E501 + + :return: The balance_remaining of this EmployeeStatutoryLeaveBalance. # noqa: E501 + :rtype: float + """ + return self._balance_remaining + + @balance_remaining.setter + def balance_remaining(self, balance_remaining): + """Sets the balance_remaining of this EmployeeStatutoryLeaveBalance. + + The balance remaining for the corresponding leave type as of specified date. # noqa: E501 + + :param balance_remaining: The balance_remaining of this EmployeeStatutoryLeaveBalance. # noqa: E501 + :type: float + """ + + self._balance_remaining = balance_remaining + + @property + def units(self): + """Gets the units of this EmployeeStatutoryLeaveBalance. # noqa: E501 + + The units will be \"Hours\" # noqa: E501 + + :return: The units of this EmployeeStatutoryLeaveBalance. # noqa: E501 + :rtype: str + """ + return self._units + + @units.setter + def units(self, units): + """Sets the units of this EmployeeStatutoryLeaveBalance. + + The units will be \"Hours\" # noqa: E501 + + :param units: The units of this EmployeeStatutoryLeaveBalance. # noqa: E501 + :type: str + """ + allowed_values = ["Hours", "None"] # noqa: E501 + if units not in allowed_values: + raise ValueError( + "Invalid value for `units` ({0}), must be one of {1}".format( # noqa: E501 + units, allowed_values + ) + ) + + self._units = units diff --git a/xero_python/payrollnz/models/employee_statutory_leave_balance_object.py b/xero_python/payrollnz/models/employee_statutory_leave_balance_object.py new file mode 100644 index 00000000..bfd8466b --- /dev/null +++ b/xero_python/payrollnz/models/employee_statutory_leave_balance_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeStatutoryLeaveBalanceObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "leave_balance": "EmployeeStatutoryLeaveBalance", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "leave_balance": "leaveBalance", + } + + def __init__(self, pagination=None, problem=None, leave_balance=None): # noqa: E501 + """EmployeeStatutoryLeaveBalanceObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._leave_balance = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if leave_balance is not None: + self.leave_balance = leave_balance + + @property + def pagination(self): + """Gets the pagination of this EmployeeStatutoryLeaveBalanceObject. # noqa: E501 + + + :return: The pagination of this EmployeeStatutoryLeaveBalanceObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeStatutoryLeaveBalanceObject. + + + :param pagination: The pagination of this EmployeeStatutoryLeaveBalanceObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeStatutoryLeaveBalanceObject. # noqa: E501 + + + :return: The problem of this EmployeeStatutoryLeaveBalanceObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeStatutoryLeaveBalanceObject. + + + :param problem: The problem of this EmployeeStatutoryLeaveBalanceObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def leave_balance(self): + """Gets the leave_balance of this EmployeeStatutoryLeaveBalanceObject. # noqa: E501 + + + :return: The leave_balance of this EmployeeStatutoryLeaveBalanceObject. # noqa: E501 + :rtype: EmployeeStatutoryLeaveBalance + """ + return self._leave_balance + + @leave_balance.setter + def leave_balance(self, leave_balance): + """Sets the leave_balance of this EmployeeStatutoryLeaveBalanceObject. + + + :param leave_balance: The leave_balance of this EmployeeStatutoryLeaveBalanceObject. # noqa: E501 + :type: EmployeeStatutoryLeaveBalance + """ + + self._leave_balance = leave_balance diff --git a/xero_python/payrollnz/models/employee_statutory_leave_summary.py b/xero_python/payrollnz/models/employee_statutory_leave_summary.py new file mode 100644 index 00000000..69ec30f6 --- /dev/null +++ b/xero_python/payrollnz/models/employee_statutory_leave_summary.py @@ -0,0 +1,269 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeStatutoryLeaveSummary(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "statutory_leave_id": "str", + "employee_id": "str", + "type": "str", + "start_date": "date", + "end_date": "date", + "is_entitled": "bool", + "status": "str", + } + + attribute_map = { + "statutory_leave_id": "statutoryLeaveID", + "employee_id": "employeeID", + "type": "type", + "start_date": "startDate", + "end_date": "endDate", + "is_entitled": "isEntitled", + "status": "status", + } + + def __init__( + self, + statutory_leave_id=None, + employee_id=None, + type=None, + start_date=None, + end_date=None, + is_entitled=None, + status=None, + ): # noqa: E501 + """EmployeeStatutoryLeaveSummary - a model defined in OpenAPI""" # noqa: E501 + + self._statutory_leave_id = None + self._employee_id = None + self._type = None + self._start_date = None + self._end_date = None + self._is_entitled = None + self._status = None + self.discriminator = None + + if statutory_leave_id is not None: + self.statutory_leave_id = statutory_leave_id + if employee_id is not None: + self.employee_id = employee_id + if type is not None: + self.type = type + if start_date is not None: + self.start_date = start_date + if end_date is not None: + self.end_date = end_date + if is_entitled is not None: + self.is_entitled = is_entitled + if status is not None: + self.status = status + + @property + def statutory_leave_id(self): + """Gets the statutory_leave_id of this EmployeeStatutoryLeaveSummary. # noqa: E501 + + The unique identifier (guid) of a statutory leave. # noqa: E501 + + :return: The statutory_leave_id of this EmployeeStatutoryLeaveSummary. # noqa: E501 + :rtype: str + """ + return self._statutory_leave_id + + @statutory_leave_id.setter + def statutory_leave_id(self, statutory_leave_id): + """Sets the statutory_leave_id of this EmployeeStatutoryLeaveSummary. + + The unique identifier (guid) of a statutory leave. # noqa: E501 + + :param statutory_leave_id: The statutory_leave_id of this EmployeeStatutoryLeaveSummary. # noqa: E501 + :type: str + """ + + self._statutory_leave_id = statutory_leave_id + + @property + def employee_id(self): + """Gets the employee_id of this EmployeeStatutoryLeaveSummary. # noqa: E501 + + The unique identifier (guid) of the employee # noqa: E501 + + :return: The employee_id of this EmployeeStatutoryLeaveSummary. # noqa: E501 + :rtype: str + """ + return self._employee_id + + @employee_id.setter + def employee_id(self, employee_id): + """Sets the employee_id of this EmployeeStatutoryLeaveSummary. + + The unique identifier (guid) of the employee # noqa: E501 + + :param employee_id: The employee_id of this EmployeeStatutoryLeaveSummary. # noqa: E501 + :type: str + """ + + self._employee_id = employee_id + + @property + def type(self): + """Gets the type of this EmployeeStatutoryLeaveSummary. # noqa: E501 + + The category of statutory leave # noqa: E501 + + :return: The type of this EmployeeStatutoryLeaveSummary. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this EmployeeStatutoryLeaveSummary. + + The category of statutory leave # noqa: E501 + + :param type: The type of this EmployeeStatutoryLeaveSummary. # noqa: E501 + :type: str + """ + allowed_values = [ + "Sick", + "Adoption", + "Maternity", + "Paternity", + "Sharedparental", + "None", + ] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}".format( # noqa: E501 + type, allowed_values + ) + ) + + self._type = type + + @property + def start_date(self): + """Gets the start_date of this EmployeeStatutoryLeaveSummary. # noqa: E501 + + The date when the leave starts # noqa: E501 + + :return: The start_date of this EmployeeStatutoryLeaveSummary. # noqa: E501 + :rtype: date + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this EmployeeStatutoryLeaveSummary. + + The date when the leave starts # noqa: E501 + + :param start_date: The start_date of this EmployeeStatutoryLeaveSummary. # noqa: E501 + :type: date + """ + + self._start_date = start_date + + @property + def end_date(self): + """Gets the end_date of this EmployeeStatutoryLeaveSummary. # noqa: E501 + + The date when the leave ends # noqa: E501 + + :return: The end_date of this EmployeeStatutoryLeaveSummary. # noqa: E501 + :rtype: date + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this EmployeeStatutoryLeaveSummary. + + The date when the leave ends # noqa: E501 + + :param end_date: The end_date of this EmployeeStatutoryLeaveSummary. # noqa: E501 + :type: date + """ + + self._end_date = end_date + + @property + def is_entitled(self): + """Gets the is_entitled of this EmployeeStatutoryLeaveSummary. # noqa: E501 + + Whether the leave was entitled to receive payment # noqa: E501 + + :return: The is_entitled of this EmployeeStatutoryLeaveSummary. # noqa: E501 + :rtype: bool + """ + return self._is_entitled + + @is_entitled.setter + def is_entitled(self, is_entitled): + """Sets the is_entitled of this EmployeeStatutoryLeaveSummary. + + Whether the leave was entitled to receive payment # noqa: E501 + + :param is_entitled: The is_entitled of this EmployeeStatutoryLeaveSummary. # noqa: E501 + :type: bool + """ + + self._is_entitled = is_entitled + + @property + def status(self): + """Gets the status of this EmployeeStatutoryLeaveSummary. # noqa: E501 + + The status of the leave # noqa: E501 + + :return: The status of this EmployeeStatutoryLeaveSummary. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this EmployeeStatutoryLeaveSummary. + + The status of the leave # noqa: E501 + + :param status: The status of this EmployeeStatutoryLeaveSummary. # noqa: E501 + :type: str + """ + allowed_values = ["Pending", "In-Progress", "Completed", "None"] # noqa: E501 + if status not in allowed_values: + raise ValueError( + "Invalid value for `status` ({0}), must be one of {1}".format( # noqa: E501 + status, allowed_values + ) + ) + + self._status = status diff --git a/xero_python/payrollnz/models/employee_statutory_leaves_summaries.py b/xero_python/payrollnz/models/employee_statutory_leaves_summaries.py new file mode 100644 index 00000000..a8cf9f82 --- /dev/null +++ b/xero_python/payrollnz/models/employee_statutory_leaves_summaries.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeStatutoryLeavesSummaries(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "statutory_leaves": "list[EmployeeStatutoryLeaveSummary]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "statutory_leaves": "statutoryLeaves", + } + + def __init__( + self, pagination=None, problem=None, statutory_leaves=None + ): # noqa: E501 + """EmployeeStatutoryLeavesSummaries - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._statutory_leaves = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if statutory_leaves is not None: + self.statutory_leaves = statutory_leaves + + @property + def pagination(self): + """Gets the pagination of this EmployeeStatutoryLeavesSummaries. # noqa: E501 + + + :return: The pagination of this EmployeeStatutoryLeavesSummaries. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeStatutoryLeavesSummaries. + + + :param pagination: The pagination of this EmployeeStatutoryLeavesSummaries. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeStatutoryLeavesSummaries. # noqa: E501 + + + :return: The problem of this EmployeeStatutoryLeavesSummaries. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeStatutoryLeavesSummaries. + + + :param problem: The problem of this EmployeeStatutoryLeavesSummaries. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def statutory_leaves(self): + """Gets the statutory_leaves of this EmployeeStatutoryLeavesSummaries. # noqa: E501 + + + :return: The statutory_leaves of this EmployeeStatutoryLeavesSummaries. # noqa: E501 + :rtype: list[EmployeeStatutoryLeaveSummary] + """ + return self._statutory_leaves + + @statutory_leaves.setter + def statutory_leaves(self, statutory_leaves): + """Sets the statutory_leaves of this EmployeeStatutoryLeavesSummaries. + + + :param statutory_leaves: The statutory_leaves of this EmployeeStatutoryLeavesSummaries. # noqa: E501 + :type: list[EmployeeStatutoryLeaveSummary] + """ + + self._statutory_leaves = statutory_leaves diff --git a/xero_python/payrollnz/models/employee_statutory_sick_leave.py b/xero_python/payrollnz/models/employee_statutory_sick_leave.py new file mode 100644 index 00000000..c138adc3 --- /dev/null +++ b/xero_python/payrollnz/models/employee_statutory_sick_leave.py @@ -0,0 +1,548 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeStatutorySickLeave(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "statutory_leave_id": "str", + "employee_id": "str", + "leave_type_id": "str", + "start_date": "date", + "end_date": "date", + "type": "str", + "status": "str", + "work_pattern": "list[str]", + "is_pregnancy_related": "bool", + "sufficient_notice": "bool", + "is_entitled": "bool", + "entitlement_weeks_requested": "float", + "entitlement_weeks_qualified": "float", + "entitlement_weeks_remaining": "float", + "overlaps_with_other_leave": "bool", + "entitlement_failure_reasons": "list[str]", + } + + attribute_map = { + "statutory_leave_id": "statutoryLeaveID", + "employee_id": "employeeID", + "leave_type_id": "leaveTypeID", + "start_date": "startDate", + "end_date": "endDate", + "type": "type", + "status": "status", + "work_pattern": "workPattern", + "is_pregnancy_related": "isPregnancyRelated", + "sufficient_notice": "sufficientNotice", + "is_entitled": "isEntitled", + "entitlement_weeks_requested": "entitlementWeeksRequested", + "entitlement_weeks_qualified": "entitlementWeeksQualified", + "entitlement_weeks_remaining": "entitlementWeeksRemaining", + "overlaps_with_other_leave": "overlapsWithOtherLeave", + "entitlement_failure_reasons": "entitlementFailureReasons", + } + + def __init__( + self, + statutory_leave_id=None, + employee_id=None, + leave_type_id=None, + start_date=None, + end_date=None, + type=None, + status=None, + work_pattern=None, + is_pregnancy_related=None, + sufficient_notice=None, + is_entitled=None, + entitlement_weeks_requested=None, + entitlement_weeks_qualified=None, + entitlement_weeks_remaining=None, + overlaps_with_other_leave=None, + entitlement_failure_reasons=None, + ): # noqa: E501 + """EmployeeStatutorySickLeave - a model defined in OpenAPI""" # noqa: E501 + + self._statutory_leave_id = None + self._employee_id = None + self._leave_type_id = None + self._start_date = None + self._end_date = None + self._type = None + self._status = None + self._work_pattern = None + self._is_pregnancy_related = None + self._sufficient_notice = None + self._is_entitled = None + self._entitlement_weeks_requested = None + self._entitlement_weeks_qualified = None + self._entitlement_weeks_remaining = None + self._overlaps_with_other_leave = None + self._entitlement_failure_reasons = None + self.discriminator = None + + if statutory_leave_id is not None: + self.statutory_leave_id = statutory_leave_id + self.employee_id = employee_id + self.leave_type_id = leave_type_id + self.start_date = start_date + self.end_date = end_date + if type is not None: + self.type = type + if status is not None: + self.status = status + self.work_pattern = work_pattern + self.is_pregnancy_related = is_pregnancy_related + self.sufficient_notice = sufficient_notice + if is_entitled is not None: + self.is_entitled = is_entitled + if entitlement_weeks_requested is not None: + self.entitlement_weeks_requested = entitlement_weeks_requested + if entitlement_weeks_qualified is not None: + self.entitlement_weeks_qualified = entitlement_weeks_qualified + if entitlement_weeks_remaining is not None: + self.entitlement_weeks_remaining = entitlement_weeks_remaining + if overlaps_with_other_leave is not None: + self.overlaps_with_other_leave = overlaps_with_other_leave + if entitlement_failure_reasons is not None: + self.entitlement_failure_reasons = entitlement_failure_reasons + + @property + def statutory_leave_id(self): + """Gets the statutory_leave_id of this EmployeeStatutorySickLeave. # noqa: E501 + + The unique identifier (guid) of a statutory leave # noqa: E501 + + :return: The statutory_leave_id of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: str + """ + return self._statutory_leave_id + + @statutory_leave_id.setter + def statutory_leave_id(self, statutory_leave_id): + """Sets the statutory_leave_id of this EmployeeStatutorySickLeave. + + The unique identifier (guid) of a statutory leave # noqa: E501 + + :param statutory_leave_id: The statutory_leave_id of this EmployeeStatutorySickLeave. # noqa: E501 + :type: str + """ + + self._statutory_leave_id = statutory_leave_id + + @property + def employee_id(self): + """Gets the employee_id of this EmployeeStatutorySickLeave. # noqa: E501 + + The unique identifier (guid) of the employee # noqa: E501 + + :return: The employee_id of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: str + """ + return self._employee_id + + @employee_id.setter + def employee_id(self, employee_id): + """Sets the employee_id of this EmployeeStatutorySickLeave. + + The unique identifier (guid) of the employee # noqa: E501 + + :param employee_id: The employee_id of this EmployeeStatutorySickLeave. # noqa: E501 + :type: str + """ + if employee_id is None: + raise ValueError( + "Invalid value for `employee_id`, must not be `None`" + ) # noqa: E501 + + self._employee_id = employee_id + + @property + def leave_type_id(self): + """Gets the leave_type_id of this EmployeeStatutorySickLeave. # noqa: E501 + + The unique identifier (guid) of the \"Statutory Sick Leave (non-pensionable)\" pay item # noqa: E501 + + :return: The leave_type_id of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: str + """ + return self._leave_type_id + + @leave_type_id.setter + def leave_type_id(self, leave_type_id): + """Sets the leave_type_id of this EmployeeStatutorySickLeave. + + The unique identifier (guid) of the \"Statutory Sick Leave (non-pensionable)\" pay item # noqa: E501 + + :param leave_type_id: The leave_type_id of this EmployeeStatutorySickLeave. # noqa: E501 + :type: str + """ + if leave_type_id is None: + raise ValueError( + "Invalid value for `leave_type_id`, must not be `None`" + ) # noqa: E501 + + self._leave_type_id = leave_type_id + + @property + def start_date(self): + """Gets the start_date of this EmployeeStatutorySickLeave. # noqa: E501 + + The date when the leave starts # noqa: E501 + + :return: The start_date of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: date + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this EmployeeStatutorySickLeave. + + The date when the leave starts # noqa: E501 + + :param start_date: The start_date of this EmployeeStatutorySickLeave. # noqa: E501 + :type: date + """ + if start_date is None: + raise ValueError( + "Invalid value for `start_date`, must not be `None`" + ) # noqa: E501 + + self._start_date = start_date + + @property + def end_date(self): + """Gets the end_date of this EmployeeStatutorySickLeave. # noqa: E501 + + The date when the leave ends # noqa: E501 + + :return: The end_date of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: date + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this EmployeeStatutorySickLeave. + + The date when the leave ends # noqa: E501 + + :param end_date: The end_date of this EmployeeStatutorySickLeave. # noqa: E501 + :type: date + """ + if end_date is None: + raise ValueError( + "Invalid value for `end_date`, must not be `None`" + ) # noqa: E501 + + self._end_date = end_date + + @property + def type(self): + """Gets the type of this EmployeeStatutorySickLeave. # noqa: E501 + + the type of statutory leave # noqa: E501 + + :return: The type of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this EmployeeStatutorySickLeave. + + the type of statutory leave # noqa: E501 + + :param type: The type of this EmployeeStatutorySickLeave. # noqa: E501 + :type: str + """ + + self._type = type + + @property + def status(self): + """Gets the status of this EmployeeStatutorySickLeave. # noqa: E501 + + the type of statutory leave # noqa: E501 + + :return: The status of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this EmployeeStatutorySickLeave. + + the type of statutory leave # noqa: E501 + + :param status: The status of this EmployeeStatutorySickLeave. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def work_pattern(self): + """Gets the work_pattern of this EmployeeStatutorySickLeave. # noqa: E501 + + The days of the work week the employee is scheduled to work at the time the leave is taken # noqa: E501 + + :return: The work_pattern of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: list[str] + """ + return self._work_pattern + + @work_pattern.setter + def work_pattern(self, work_pattern): + """Sets the work_pattern of this EmployeeStatutorySickLeave. + + The days of the work week the employee is scheduled to work at the time the leave is taken # noqa: E501 + + :param work_pattern: The work_pattern of this EmployeeStatutorySickLeave. # noqa: E501 + :type: list[str] + """ + if work_pattern is None: + raise ValueError( + "Invalid value for `work_pattern`, must not be `None`" + ) # noqa: E501 + + self._work_pattern = work_pattern + + @property + def is_pregnancy_related(self): + """Gets the is_pregnancy_related of this EmployeeStatutorySickLeave. # noqa: E501 + + Whether the sick leave was pregnancy related # noqa: E501 + + :return: The is_pregnancy_related of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: bool + """ + return self._is_pregnancy_related + + @is_pregnancy_related.setter + def is_pregnancy_related(self, is_pregnancy_related): + """Sets the is_pregnancy_related of this EmployeeStatutorySickLeave. + + Whether the sick leave was pregnancy related # noqa: E501 + + :param is_pregnancy_related: The is_pregnancy_related of this EmployeeStatutorySickLeave. # noqa: E501 + :type: bool + """ + if is_pregnancy_related is None: + raise ValueError( + "Invalid value for `is_pregnancy_related`, must not be `None`" + ) # noqa: E501 + + self._is_pregnancy_related = is_pregnancy_related + + @property + def sufficient_notice(self): + """Gets the sufficient_notice of this EmployeeStatutorySickLeave. # noqa: E501 + + Whether the employee provided sufficent notice and documentation as required by the employer supporting the sick leave request # noqa: E501 + + :return: The sufficient_notice of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: bool + """ + return self._sufficient_notice + + @sufficient_notice.setter + def sufficient_notice(self, sufficient_notice): + """Sets the sufficient_notice of this EmployeeStatutorySickLeave. + + Whether the employee provided sufficent notice and documentation as required by the employer supporting the sick leave request # noqa: E501 + + :param sufficient_notice: The sufficient_notice of this EmployeeStatutorySickLeave. # noqa: E501 + :type: bool + """ + if sufficient_notice is None: + raise ValueError( + "Invalid value for `sufficient_notice`, must not be `None`" + ) # noqa: E501 + + self._sufficient_notice = sufficient_notice + + @property + def is_entitled(self): + """Gets the is_entitled of this EmployeeStatutorySickLeave. # noqa: E501 + + Whether the leave was entitled to receive payment # noqa: E501 + + :return: The is_entitled of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: bool + """ + return self._is_entitled + + @is_entitled.setter + def is_entitled(self, is_entitled): + """Sets the is_entitled of this EmployeeStatutorySickLeave. + + Whether the leave was entitled to receive payment # noqa: E501 + + :param is_entitled: The is_entitled of this EmployeeStatutorySickLeave. # noqa: E501 + :type: bool + """ + + self._is_entitled = is_entitled + + @property + def entitlement_weeks_requested(self): + """Gets the entitlement_weeks_requested of this EmployeeStatutorySickLeave. # noqa: E501 + + The amount of requested time (in weeks) # noqa: E501 + + :return: The entitlement_weeks_requested of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: float + """ + return self._entitlement_weeks_requested + + @entitlement_weeks_requested.setter + def entitlement_weeks_requested(self, entitlement_weeks_requested): + """Sets the entitlement_weeks_requested of this EmployeeStatutorySickLeave. + + The amount of requested time (in weeks) # noqa: E501 + + :param entitlement_weeks_requested: The entitlement_weeks_requested of this EmployeeStatutorySickLeave. # noqa: E501 + :type: float + """ + + self._entitlement_weeks_requested = entitlement_weeks_requested + + @property + def entitlement_weeks_qualified(self): + """Gets the entitlement_weeks_qualified of this EmployeeStatutorySickLeave. # noqa: E501 + + The amount of statutory sick leave time off (in weeks) that is available to take at the time the leave was requested # noqa: E501 + + :return: The entitlement_weeks_qualified of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: float + """ + return self._entitlement_weeks_qualified + + @entitlement_weeks_qualified.setter + def entitlement_weeks_qualified(self, entitlement_weeks_qualified): + """Sets the entitlement_weeks_qualified of this EmployeeStatutorySickLeave. + + The amount of statutory sick leave time off (in weeks) that is available to take at the time the leave was requested # noqa: E501 + + :param entitlement_weeks_qualified: The entitlement_weeks_qualified of this EmployeeStatutorySickLeave. # noqa: E501 + :type: float + """ + + self._entitlement_weeks_qualified = entitlement_weeks_qualified + + @property + def entitlement_weeks_remaining(self): + """Gets the entitlement_weeks_remaining of this EmployeeStatutorySickLeave. # noqa: E501 + + A calculated amount of time (in weeks) that remains for the statutory sick leave period # noqa: E501 + + :return: The entitlement_weeks_remaining of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: float + """ + return self._entitlement_weeks_remaining + + @entitlement_weeks_remaining.setter + def entitlement_weeks_remaining(self, entitlement_weeks_remaining): + """Sets the entitlement_weeks_remaining of this EmployeeStatutorySickLeave. + + A calculated amount of time (in weeks) that remains for the statutory sick leave period # noqa: E501 + + :param entitlement_weeks_remaining: The entitlement_weeks_remaining of this EmployeeStatutorySickLeave. # noqa: E501 + :type: float + """ + + self._entitlement_weeks_remaining = entitlement_weeks_remaining + + @property + def overlaps_with_other_leave(self): + """Gets the overlaps_with_other_leave of this EmployeeStatutorySickLeave. # noqa: E501 + + Whether another leave (Paternity, Shared Parental specifically) occurs during the requested leave's period. While this is allowed it could affect payment amounts # noqa: E501 + + :return: The overlaps_with_other_leave of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: bool + """ + return self._overlaps_with_other_leave + + @overlaps_with_other_leave.setter + def overlaps_with_other_leave(self, overlaps_with_other_leave): + """Sets the overlaps_with_other_leave of this EmployeeStatutorySickLeave. + + Whether another leave (Paternity, Shared Parental specifically) occurs during the requested leave's period. While this is allowed it could affect payment amounts # noqa: E501 + + :param overlaps_with_other_leave: The overlaps_with_other_leave of this EmployeeStatutorySickLeave. # noqa: E501 + :type: bool + """ + + self._overlaps_with_other_leave = overlaps_with_other_leave + + @property + def entitlement_failure_reasons(self): + """Gets the entitlement_failure_reasons of this EmployeeStatutorySickLeave. # noqa: E501 + + If the leave requested was considered \"not entitled\", the reasons why are listed here. # noqa: E501 + + :return: The entitlement_failure_reasons of this EmployeeStatutorySickLeave. # noqa: E501 + :rtype: list[str] + """ + return self._entitlement_failure_reasons + + @entitlement_failure_reasons.setter + def entitlement_failure_reasons(self, entitlement_failure_reasons): + """Sets the entitlement_failure_reasons of this EmployeeStatutorySickLeave. + + If the leave requested was considered \"not entitled\", the reasons why are listed here. # noqa: E501 + + :param entitlement_failure_reasons: The entitlement_failure_reasons of this EmployeeStatutorySickLeave. # noqa: E501 + :type: list[str] + """ + allowed_values = [ + "UnableToCalculateAwe", + "AweLowerThanLel", + "NotQualifiedInPreviousPiw", + "ExceededMaximumEntitlementWeeksOfSsp", + "ExceededMaximumDurationOfPiw", + "SufficientNoticeNotGiven", + "None", + ] # noqa: E501 + if not set(entitlement_failure_reasons).issubset(set(allowed_values)): + raise ValueError( + "Invalid values for `entitlement_failure_reasons` [{0}], must be a subset of [{1}]".format( # noqa: E501 + ", ".join( + map(str, set(entitlement_failure_reasons) - set(allowed_values)) + ), # noqa: E501 + ", ".join(map(str, allowed_values)), + ) + ) + + self._entitlement_failure_reasons = entitlement_failure_reasons diff --git a/xero_python/payrollnz/models/employee_statutory_sick_leave_object.py b/xero_python/payrollnz/models/employee_statutory_sick_leave_object.py new file mode 100644 index 00000000..1d6884e2 --- /dev/null +++ b/xero_python/payrollnz/models/employee_statutory_sick_leave_object.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeStatutorySickLeaveObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "statutory_sick_leave": "EmployeeStatutorySickLeave", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "statutory_sick_leave": "statutorySickLeave", + } + + def __init__( + self, pagination=None, problem=None, statutory_sick_leave=None + ): # noqa: E501 + """EmployeeStatutorySickLeaveObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._statutory_sick_leave = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if statutory_sick_leave is not None: + self.statutory_sick_leave = statutory_sick_leave + + @property + def pagination(self): + """Gets the pagination of this EmployeeStatutorySickLeaveObject. # noqa: E501 + + + :return: The pagination of this EmployeeStatutorySickLeaveObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeStatutorySickLeaveObject. + + + :param pagination: The pagination of this EmployeeStatutorySickLeaveObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeStatutorySickLeaveObject. # noqa: E501 + + + :return: The problem of this EmployeeStatutorySickLeaveObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeStatutorySickLeaveObject. + + + :param problem: The problem of this EmployeeStatutorySickLeaveObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def statutory_sick_leave(self): + """Gets the statutory_sick_leave of this EmployeeStatutorySickLeaveObject. # noqa: E501 + + + :return: The statutory_sick_leave of this EmployeeStatutorySickLeaveObject. # noqa: E501 + :rtype: EmployeeStatutorySickLeave + """ + return self._statutory_sick_leave + + @statutory_sick_leave.setter + def statutory_sick_leave(self, statutory_sick_leave): + """Sets the statutory_sick_leave of this EmployeeStatutorySickLeaveObject. + + + :param statutory_sick_leave: The statutory_sick_leave of this EmployeeStatutorySickLeaveObject. # noqa: E501 + :type: EmployeeStatutorySickLeave + """ + + self._statutory_sick_leave = statutory_sick_leave diff --git a/xero_python/payrollnz/models/employee_statutory_sick_leaves.py b/xero_python/payrollnz/models/employee_statutory_sick_leaves.py new file mode 100644 index 00000000..31db7e83 --- /dev/null +++ b/xero_python/payrollnz/models/employee_statutory_sick_leaves.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeStatutorySickLeaves(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "statutory_sick_leave": "list[EmployeeStatutorySickLeave]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "statutory_sick_leave": "statutorySickLeave", + } + + def __init__( + self, pagination=None, problem=None, statutory_sick_leave=None + ): # noqa: E501 + """EmployeeStatutorySickLeaves - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._statutory_sick_leave = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if statutory_sick_leave is not None: + self.statutory_sick_leave = statutory_sick_leave + + @property + def pagination(self): + """Gets the pagination of this EmployeeStatutorySickLeaves. # noqa: E501 + + + :return: The pagination of this EmployeeStatutorySickLeaves. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeStatutorySickLeaves. + + + :param pagination: The pagination of this EmployeeStatutorySickLeaves. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeStatutorySickLeaves. # noqa: E501 + + + :return: The problem of this EmployeeStatutorySickLeaves. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeStatutorySickLeaves. + + + :param problem: The problem of this EmployeeStatutorySickLeaves. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def statutory_sick_leave(self): + """Gets the statutory_sick_leave of this EmployeeStatutorySickLeaves. # noqa: E501 + + + :return: The statutory_sick_leave of this EmployeeStatutorySickLeaves. # noqa: E501 + :rtype: list[EmployeeStatutorySickLeave] + """ + return self._statutory_sick_leave + + @statutory_sick_leave.setter + def statutory_sick_leave(self, statutory_sick_leave): + """Sets the statutory_sick_leave of this EmployeeStatutorySickLeaves. + + + :param statutory_sick_leave: The statutory_sick_leave of this EmployeeStatutorySickLeaves. # noqa: E501 + :type: list[EmployeeStatutorySickLeave] + """ + + self._statutory_sick_leave = statutory_sick_leave diff --git a/xero_python/payrollnz/models/employee_tax.py b/xero_python/payrollnz/models/employee_tax.py new file mode 100644 index 00000000..687f5414 --- /dev/null +++ b/xero_python/payrollnz/models/employee_tax.py @@ -0,0 +1,554 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeTax(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "ird_number": "str", + "tax_code": "TaxCode", + "special_tax_rate_percentage": "float", + "has_special_student_loan_rate": "bool", + "special_student_loan_rate_percentage": "float", + "is_eligible_for_kiwi_saver": "bool", + "esct_rate_percentage": "float", + "kiwi_saver_contributions": "str", + "kiwi_saver_employee_contribution_rate_percentage": "float", + "kiwi_saver_employer_contribution_rate_percentage": "float", + "kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage": "float", + "kiwi_saver_opt_out_date": "date", + "kiwi_saver_contribution_holiday_end_date": "date", + "has_student_loan_balance": "bool", + "student_loan_balance": "float", + "student_loan_as_at": "date", + } + + attribute_map = { + "ird_number": "irdNumber", + "tax_code": "taxCode", + "special_tax_rate_percentage": "specialTaxRatePercentage", + "has_special_student_loan_rate": "hasSpecialStudentLoanRate", + "special_student_loan_rate_percentage": "specialStudentLoanRatePercentage", + "is_eligible_for_kiwi_saver": "isEligibleForKiwiSaver", + "esct_rate_percentage": "esctRatePercentage", + "kiwi_saver_contributions": "kiwiSaverContributions", + "kiwi_saver_employee_contribution_rate_percentage": "kiwiSaverEmployeeContributionRatePercentage", + "kiwi_saver_employer_contribution_rate_percentage": "kiwiSaverEmployerContributionRatePercentage", + "kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage": "kiwiSaverEmployerSalarySacrificeContributionRatePercentage", + "kiwi_saver_opt_out_date": "kiwiSaverOptOutDate", + "kiwi_saver_contribution_holiday_end_date": "kiwiSaverContributionHolidayEndDate", + "has_student_loan_balance": "hasStudentLoanBalance", + "student_loan_balance": "studentLoanBalance", + "student_loan_as_at": "studentLoanAsAt", + } + + def __init__( + self, + ird_number=None, + tax_code=None, + special_tax_rate_percentage=None, + has_special_student_loan_rate=None, + special_student_loan_rate_percentage=None, + is_eligible_for_kiwi_saver=None, + esct_rate_percentage=None, + kiwi_saver_contributions=None, + kiwi_saver_employee_contribution_rate_percentage=None, + kiwi_saver_employer_contribution_rate_percentage=None, + kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage=None, + kiwi_saver_opt_out_date=None, + kiwi_saver_contribution_holiday_end_date=None, + has_student_loan_balance=None, + student_loan_balance=None, + student_loan_as_at=None, + ): # noqa: E501 + """EmployeeTax - a model defined in OpenAPI""" # noqa: E501 + + self._ird_number = None + self._tax_code = None + self._special_tax_rate_percentage = None + self._has_special_student_loan_rate = None + self._special_student_loan_rate_percentage = None + self._is_eligible_for_kiwi_saver = None + self._esct_rate_percentage = None + self._kiwi_saver_contributions = None + self._kiwi_saver_employee_contribution_rate_percentage = None + self._kiwi_saver_employer_contribution_rate_percentage = None + self._kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage = None + self._kiwi_saver_opt_out_date = None + self._kiwi_saver_contribution_holiday_end_date = None + self._has_student_loan_balance = None + self._student_loan_balance = None + self._student_loan_as_at = None + self.discriminator = None + + if ird_number is not None: + self.ird_number = ird_number + if tax_code is not None: + self.tax_code = tax_code + if special_tax_rate_percentage is not None: + self.special_tax_rate_percentage = special_tax_rate_percentage + if has_special_student_loan_rate is not None: + self.has_special_student_loan_rate = has_special_student_loan_rate + if special_student_loan_rate_percentage is not None: + self.special_student_loan_rate_percentage = ( + special_student_loan_rate_percentage + ) + if is_eligible_for_kiwi_saver is not None: + self.is_eligible_for_kiwi_saver = is_eligible_for_kiwi_saver + if esct_rate_percentage is not None: + self.esct_rate_percentage = esct_rate_percentage + if kiwi_saver_contributions is not None: + self.kiwi_saver_contributions = kiwi_saver_contributions + if kiwi_saver_employee_contribution_rate_percentage is not None: + self.kiwi_saver_employee_contribution_rate_percentage = ( + kiwi_saver_employee_contribution_rate_percentage + ) + if kiwi_saver_employer_contribution_rate_percentage is not None: + self.kiwi_saver_employer_contribution_rate_percentage = ( + kiwi_saver_employer_contribution_rate_percentage + ) + if ( + kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage + is not None + ): + self.kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage = ( + kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage + ) + if kiwi_saver_opt_out_date is not None: + self.kiwi_saver_opt_out_date = kiwi_saver_opt_out_date + if kiwi_saver_contribution_holiday_end_date is not None: + self.kiwi_saver_contribution_holiday_end_date = ( + kiwi_saver_contribution_holiday_end_date + ) + if has_student_loan_balance is not None: + self.has_student_loan_balance = has_student_loan_balance + if student_loan_balance is not None: + self.student_loan_balance = student_loan_balance + if student_loan_as_at is not None: + self.student_loan_as_at = student_loan_as_at + + @property + def ird_number(self): + """Gets the ird_number of this EmployeeTax. # noqa: E501 + + The IRD Number. # noqa: E501 + + :return: The ird_number of this EmployeeTax. # noqa: E501 + :rtype: str + """ + return self._ird_number + + @ird_number.setter + def ird_number(self, ird_number): + """Sets the ird_number of this EmployeeTax. + + The IRD Number. # noqa: E501 + + :param ird_number: The ird_number of this EmployeeTax. # noqa: E501 + :type: str + """ + + self._ird_number = ird_number + + @property + def tax_code(self): + """Gets the tax_code of this EmployeeTax. # noqa: E501 + + + :return: The tax_code of this EmployeeTax. # noqa: E501 + :rtype: TaxCode + """ + return self._tax_code + + @tax_code.setter + def tax_code(self, tax_code): + """Sets the tax_code of this EmployeeTax. + + + :param tax_code: The tax_code of this EmployeeTax. # noqa: E501 + :type: TaxCode + """ + + self._tax_code = tax_code + + @property + def special_tax_rate_percentage(self): + """Gets the special_tax_rate_percentage of this EmployeeTax. # noqa: E501 + + Special tax rate percentage. # noqa: E501 + + :return: The special_tax_rate_percentage of this EmployeeTax. # noqa: E501 + :rtype: float + """ + return self._special_tax_rate_percentage + + @special_tax_rate_percentage.setter + def special_tax_rate_percentage(self, special_tax_rate_percentage): + """Sets the special_tax_rate_percentage of this EmployeeTax. + + Special tax rate percentage. # noqa: E501 + + :param special_tax_rate_percentage: The special_tax_rate_percentage of this EmployeeTax. # noqa: E501 + :type: float + """ + + self._special_tax_rate_percentage = special_tax_rate_percentage + + @property + def has_special_student_loan_rate(self): + """Gets the has_special_student_loan_rate of this EmployeeTax. # noqa: E501 + + Does the employee has a special student loan rate? # noqa: E501 + + :return: The has_special_student_loan_rate of this EmployeeTax. # noqa: E501 + :rtype: bool + """ + return self._has_special_student_loan_rate + + @has_special_student_loan_rate.setter + def has_special_student_loan_rate(self, has_special_student_loan_rate): + """Sets the has_special_student_loan_rate of this EmployeeTax. + + Does the employee has a special student loan rate? # noqa: E501 + + :param has_special_student_loan_rate: The has_special_student_loan_rate of this EmployeeTax. # noqa: E501 + :type: bool + """ + + self._has_special_student_loan_rate = has_special_student_loan_rate + + @property + def special_student_loan_rate_percentage(self): + """Gets the special_student_loan_rate_percentage of this EmployeeTax. # noqa: E501 + + The employee student loan rate percentage. # noqa: E501 + + :return: The special_student_loan_rate_percentage of this EmployeeTax. # noqa: E501 + :rtype: float + """ + return self._special_student_loan_rate_percentage + + @special_student_loan_rate_percentage.setter + def special_student_loan_rate_percentage( + self, special_student_loan_rate_percentage + ): + """Sets the special_student_loan_rate_percentage of this EmployeeTax. + + The employee student loan rate percentage. # noqa: E501 + + :param special_student_loan_rate_percentage: The special_student_loan_rate_percentage of this EmployeeTax. # noqa: E501 + :type: float + """ + + self._special_student_loan_rate_percentage = ( + special_student_loan_rate_percentage + ) + + @property + def is_eligible_for_kiwi_saver(self): + """Gets the is_eligible_for_kiwi_saver of this EmployeeTax. # noqa: E501 + + The employee eligibility for KiwiSaver. # noqa: E501 + + :return: The is_eligible_for_kiwi_saver of this EmployeeTax. # noqa: E501 + :rtype: bool + """ + return self._is_eligible_for_kiwi_saver + + @is_eligible_for_kiwi_saver.setter + def is_eligible_for_kiwi_saver(self, is_eligible_for_kiwi_saver): + """Sets the is_eligible_for_kiwi_saver of this EmployeeTax. + + The employee eligibility for KiwiSaver. # noqa: E501 + + :param is_eligible_for_kiwi_saver: The is_eligible_for_kiwi_saver of this EmployeeTax. # noqa: E501 + :type: bool + """ + + self._is_eligible_for_kiwi_saver = is_eligible_for_kiwi_saver + + @property + def esct_rate_percentage(self): + """Gets the esct_rate_percentage of this EmployeeTax. # noqa: E501 + + Employer superannuation contribution tax rate. # noqa: E501 + + :return: The esct_rate_percentage of this EmployeeTax. # noqa: E501 + :rtype: float + """ + return self._esct_rate_percentage + + @esct_rate_percentage.setter + def esct_rate_percentage(self, esct_rate_percentage): + """Sets the esct_rate_percentage of this EmployeeTax. + + Employer superannuation contribution tax rate. # noqa: E501 + + :param esct_rate_percentage: The esct_rate_percentage of this EmployeeTax. # noqa: E501 + :type: float + """ + + self._esct_rate_percentage = esct_rate_percentage + + @property + def kiwi_saver_contributions(self): + """Gets the kiwi_saver_contributions of this EmployeeTax. # noqa: E501 + + Contribution Option which can be 'MakeContributions' 'OptOut', 'OnAContributionsHoliday', 'OnASavingsSuspension', 'NotCurrentlyAKiwiSaverMember' for employees without a KiwiSaver membership # noqa: E501 + + :return: The kiwi_saver_contributions of this EmployeeTax. # noqa: E501 + :rtype: str + """ + return self._kiwi_saver_contributions + + @kiwi_saver_contributions.setter + def kiwi_saver_contributions(self, kiwi_saver_contributions): + """Sets the kiwi_saver_contributions of this EmployeeTax. + + Contribution Option which can be 'MakeContributions' 'OptOut', 'OnAContributionsHoliday', 'OnASavingsSuspension', 'NotCurrentlyAKiwiSaverMember' for employees without a KiwiSaver membership # noqa: E501 + + :param kiwi_saver_contributions: The kiwi_saver_contributions of this EmployeeTax. # noqa: E501 + :type: str + """ + allowed_values = [ + "MakeContributions", + "OptOut", + "OnAContributionsHoliday", + "OnASavingsSuspension", + "NotCurrentlyAKiwiSaverMember", + "None", + ] # noqa: E501 + if kiwi_saver_contributions not in allowed_values: + raise ValueError( + "Invalid value for `kiwi_saver_contributions` ({0}), must be one of {1}".format( # noqa: E501 + kiwi_saver_contributions, allowed_values + ) + ) + + self._kiwi_saver_contributions = kiwi_saver_contributions + + @property + def kiwi_saver_employee_contribution_rate_percentage(self): + """Gets the kiwi_saver_employee_contribution_rate_percentage of this EmployeeTax. # noqa: E501 + + Employee Contribution percentage. # noqa: E501 + + :return: The kiwi_saver_employee_contribution_rate_percentage of this EmployeeTax. # noqa: E501 + :rtype: float + """ + return self._kiwi_saver_employee_contribution_rate_percentage + + @kiwi_saver_employee_contribution_rate_percentage.setter + def kiwi_saver_employee_contribution_rate_percentage( + self, kiwi_saver_employee_contribution_rate_percentage + ): + """Sets the kiwi_saver_employee_contribution_rate_percentage of this EmployeeTax. + + Employee Contribution percentage. # noqa: E501 + + :param kiwi_saver_employee_contribution_rate_percentage: The kiwi_saver_employee_contribution_rate_percentage of this EmployeeTax. # noqa: E501 + :type: float + """ + + self._kiwi_saver_employee_contribution_rate_percentage = ( + kiwi_saver_employee_contribution_rate_percentage + ) + + @property + def kiwi_saver_employer_contribution_rate_percentage(self): + """Gets the kiwi_saver_employer_contribution_rate_percentage of this EmployeeTax. # noqa: E501 + + Employer Contribution percentage. # noqa: E501 + + :return: The kiwi_saver_employer_contribution_rate_percentage of this EmployeeTax. # noqa: E501 + :rtype: float + """ + return self._kiwi_saver_employer_contribution_rate_percentage + + @kiwi_saver_employer_contribution_rate_percentage.setter + def kiwi_saver_employer_contribution_rate_percentage( + self, kiwi_saver_employer_contribution_rate_percentage + ): + """Sets the kiwi_saver_employer_contribution_rate_percentage of this EmployeeTax. + + Employer Contribution percentage. # noqa: E501 + + :param kiwi_saver_employer_contribution_rate_percentage: The kiwi_saver_employer_contribution_rate_percentage of this EmployeeTax. # noqa: E501 + :type: float + """ + + self._kiwi_saver_employer_contribution_rate_percentage = ( + kiwi_saver_employer_contribution_rate_percentage + ) + + @property + def kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage(self): + """Gets the kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage of this EmployeeTax. # noqa: E501 + + Employer Contribution through Salary Sacrifice percentage. # noqa: E501 + + :return: The kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage of this EmployeeTax. # noqa: E501 + :rtype: float + """ + return self._kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage + + @kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage.setter + def kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage( + self, kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage + ): + """Sets the kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage of this EmployeeTax. + + Employer Contribution through Salary Sacrifice percentage. # noqa: E501 + + :param kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage: The kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage of this EmployeeTax. # noqa: E501 + :type: float + """ + + self._kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage = ( + kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage + ) + + @property + def kiwi_saver_opt_out_date(self): + """Gets the kiwi_saver_opt_out_date of this EmployeeTax. # noqa: E501 + + Opt Out Date. # noqa: E501 + + :return: The kiwi_saver_opt_out_date of this EmployeeTax. # noqa: E501 + :rtype: date + """ + return self._kiwi_saver_opt_out_date + + @kiwi_saver_opt_out_date.setter + def kiwi_saver_opt_out_date(self, kiwi_saver_opt_out_date): + """Sets the kiwi_saver_opt_out_date of this EmployeeTax. + + Opt Out Date. # noqa: E501 + + :param kiwi_saver_opt_out_date: The kiwi_saver_opt_out_date of this EmployeeTax. # noqa: E501 + :type: date + """ + + self._kiwi_saver_opt_out_date = kiwi_saver_opt_out_date + + @property + def kiwi_saver_contribution_holiday_end_date(self): + """Gets the kiwi_saver_contribution_holiday_end_date of this EmployeeTax. # noqa: E501 + + Contribution holiday expiry date or end date. # noqa: E501 + + :return: The kiwi_saver_contribution_holiday_end_date of this EmployeeTax. # noqa: E501 + :rtype: date + """ + return self._kiwi_saver_contribution_holiday_end_date + + @kiwi_saver_contribution_holiday_end_date.setter + def kiwi_saver_contribution_holiday_end_date( + self, kiwi_saver_contribution_holiday_end_date + ): + """Sets the kiwi_saver_contribution_holiday_end_date of this EmployeeTax. + + Contribution holiday expiry date or end date. # noqa: E501 + + :param kiwi_saver_contribution_holiday_end_date: The kiwi_saver_contribution_holiday_end_date of this EmployeeTax. # noqa: E501 + :type: date + """ + + self._kiwi_saver_contribution_holiday_end_date = ( + kiwi_saver_contribution_holiday_end_date + ) + + @property + def has_student_loan_balance(self): + """Gets the has_student_loan_balance of this EmployeeTax. # noqa: E501 + + Does the employee have a remaining student loan balance? Set a remaining balance if you have received a letter from IR. # noqa: E501 + + :return: The has_student_loan_balance of this EmployeeTax. # noqa: E501 + :rtype: bool + """ + return self._has_student_loan_balance + + @has_student_loan_balance.setter + def has_student_loan_balance(self, has_student_loan_balance): + """Sets the has_student_loan_balance of this EmployeeTax. + + Does the employee have a remaining student loan balance? Set a remaining balance if you have received a letter from IR. # noqa: E501 + + :param has_student_loan_balance: The has_student_loan_balance of this EmployeeTax. # noqa: E501 + :type: bool + """ + + self._has_student_loan_balance = has_student_loan_balance + + @property + def student_loan_balance(self): + """Gets the student_loan_balance of this EmployeeTax. # noqa: E501 + + The employee's student loan balance shown on the letter from IR. # noqa: E501 + + :return: The student_loan_balance of this EmployeeTax. # noqa: E501 + :rtype: float + """ + return self._student_loan_balance + + @student_loan_balance.setter + def student_loan_balance(self, student_loan_balance): + """Sets the student_loan_balance of this EmployeeTax. + + The employee's student loan balance shown on the letter from IR. # noqa: E501 + + :param student_loan_balance: The student_loan_balance of this EmployeeTax. # noqa: E501 + :type: float + """ + + self._student_loan_balance = student_loan_balance + + @property + def student_loan_as_at(self): + """Gets the student_loan_as_at of this EmployeeTax. # noqa: E501 + + The date of the letter from IR. # noqa: E501 + + :return: The student_loan_as_at of this EmployeeTax. # noqa: E501 + :rtype: date + """ + return self._student_loan_as_at + + @student_loan_as_at.setter + def student_loan_as_at(self, student_loan_as_at): + """Sets the student_loan_as_at of this EmployeeTax. + + The date of the letter from IR. # noqa: E501 + + :param student_loan_as_at: The student_loan_as_at of this EmployeeTax. # noqa: E501 + :type: date + """ + + self._student_loan_as_at = student_loan_as_at diff --git a/xero_python/payrollnz/models/employee_tax_object.py b/xero_python/payrollnz/models/employee_tax_object.py new file mode 100644 index 00000000..281b6396 --- /dev/null +++ b/xero_python/payrollnz/models/employee_tax_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeTaxObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "employee_tax": "EmployeeTax", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "employee_tax": "employeeTax", + } + + def __init__(self, pagination=None, problem=None, employee_tax=None): # noqa: E501 + """EmployeeTaxObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._employee_tax = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if employee_tax is not None: + self.employee_tax = employee_tax + + @property + def pagination(self): + """Gets the pagination of this EmployeeTaxObject. # noqa: E501 + + + :return: The pagination of this EmployeeTaxObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeTaxObject. + + + :param pagination: The pagination of this EmployeeTaxObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeTaxObject. # noqa: E501 + + + :return: The problem of this EmployeeTaxObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeTaxObject. + + + :param problem: The problem of this EmployeeTaxObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def employee_tax(self): + """Gets the employee_tax of this EmployeeTaxObject. # noqa: E501 + + + :return: The employee_tax of this EmployeeTaxObject. # noqa: E501 + :rtype: EmployeeTax + """ + return self._employee_tax + + @employee_tax.setter + def employee_tax(self, employee_tax): + """Sets the employee_tax of this EmployeeTaxObject. + + + :param employee_tax: The employee_tax of this EmployeeTaxObject. # noqa: E501 + :type: EmployeeTax + """ + + self._employee_tax = employee_tax diff --git a/xero_python/payrollnz/models/employees.py b/xero_python/payrollnz/models/employees.py new file mode 100644 index 00000000..86a3e54f --- /dev/null +++ b/xero_python/payrollnz/models/employees.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Employees(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "employees": "list[Employee]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "employees": "employees", + } + + def __init__(self, pagination=None, problem=None, employees=None): # noqa: E501 + """Employees - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._employees = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if employees is not None: + self.employees = employees + + @property + def pagination(self): + """Gets the pagination of this Employees. # noqa: E501 + + + :return: The pagination of this Employees. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this Employees. + + + :param pagination: The pagination of this Employees. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this Employees. # noqa: E501 + + + :return: The problem of this Employees. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this Employees. + + + :param problem: The problem of this Employees. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def employees(self): + """Gets the employees of this Employees. # noqa: E501 + + + :return: The employees of this Employees. # noqa: E501 + :rtype: list[Employee] + """ + return self._employees + + @employees.setter + def employees(self, employees): + """Sets the employees of this Employees. + + + :param employees: The employees of this Employees. # noqa: E501 + :type: list[Employee] + """ + + self._employees = employees diff --git a/xero_python/payrollnz/models/employment.py b/xero_python/payrollnz/models/employment.py new file mode 100644 index 00000000..e37aba49 --- /dev/null +++ b/xero_python/payrollnz/models/employment.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Employment(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "payroll_calendar_id": "str", + "pay_run_calendar_id": "str", + "start_date": "date", + } + + attribute_map = { + "payroll_calendar_id": "payrollCalendarID", + "pay_run_calendar_id": "payRunCalendarID", + "start_date": "startDate", + } + + def __init__( + self, payroll_calendar_id=None, pay_run_calendar_id=None, start_date=None + ): # noqa: E501 + """Employment - a model defined in OpenAPI""" # noqa: E501 + + self._payroll_calendar_id = None + self._pay_run_calendar_id = None + self._start_date = None + self.discriminator = None + + if payroll_calendar_id is not None: + self.payroll_calendar_id = payroll_calendar_id + if pay_run_calendar_id is not None: + self.pay_run_calendar_id = pay_run_calendar_id + if start_date is not None: + self.start_date = start_date + + @property + def payroll_calendar_id(self): + """Gets the payroll_calendar_id of this Employment. # noqa: E501 + + Xero unique identifier for the payroll calendar of the employee # noqa: E501 + + :return: The payroll_calendar_id of this Employment. # noqa: E501 + :rtype: str + """ + return self._payroll_calendar_id + + @payroll_calendar_id.setter + def payroll_calendar_id(self, payroll_calendar_id): + """Sets the payroll_calendar_id of this Employment. + + Xero unique identifier for the payroll calendar of the employee # noqa: E501 + + :param payroll_calendar_id: The payroll_calendar_id of this Employment. # noqa: E501 + :type: str + """ + + self._payroll_calendar_id = payroll_calendar_id + + @property + def pay_run_calendar_id(self): + """Gets the pay_run_calendar_id of this Employment. # noqa: E501 + + Xero unique identifier for the payrun calendar for the employee (Deprecated in version 1.1.6) # noqa: E501 + + :return: The pay_run_calendar_id of this Employment. # noqa: E501 + :rtype: str + """ + return self._pay_run_calendar_id + + @pay_run_calendar_id.setter + def pay_run_calendar_id(self, pay_run_calendar_id): + """Sets the pay_run_calendar_id of this Employment. + + Xero unique identifier for the payrun calendar for the employee (Deprecated in version 1.1.6) # noqa: E501 + + :param pay_run_calendar_id: The pay_run_calendar_id of this Employment. # noqa: E501 + :type: str + """ + + self._pay_run_calendar_id = pay_run_calendar_id + + @property + def start_date(self): + """Gets the start_date of this Employment. # noqa: E501 + + Start date of the employment (YYYY-MM-DD) # noqa: E501 + + :return: The start_date of this Employment. # noqa: E501 + :rtype: date + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this Employment. + + Start date of the employment (YYYY-MM-DD) # noqa: E501 + + :param start_date: The start_date of this Employment. # noqa: E501 + :type: date + """ + + self._start_date = start_date diff --git a/xero_python/payrollnz/models/employment_object.py b/xero_python/payrollnz/models/employment_object.py new file mode 100644 index 00000000..148da0d9 --- /dev/null +++ b/xero_python/payrollnz/models/employment_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmploymentObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "employment": "Employment", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "employment": "employment", + } + + def __init__(self, pagination=None, problem=None, employment=None): # noqa: E501 + """EmploymentObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._employment = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if employment is not None: + self.employment = employment + + @property + def pagination(self): + """Gets the pagination of this EmploymentObject. # noqa: E501 + + + :return: The pagination of this EmploymentObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmploymentObject. + + + :param pagination: The pagination of this EmploymentObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmploymentObject. # noqa: E501 + + + :return: The problem of this EmploymentObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmploymentObject. + + + :param problem: The problem of this EmploymentObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def employment(self): + """Gets the employment of this EmploymentObject. # noqa: E501 + + + :return: The employment of this EmploymentObject. # noqa: E501 + :rtype: Employment + """ + return self._employment + + @employment.setter + def employment(self, employment): + """Sets the employment of this EmploymentObject. + + + :param employment: The employment of this EmploymentObject. # noqa: E501 + :type: Employment + """ + + self._employment = employment diff --git a/xero_python/payrollnz/models/gross_earnings_history.py b/xero_python/payrollnz/models/gross_earnings_history.py new file mode 100644 index 00000000..9aae146a --- /dev/null +++ b/xero_python/payrollnz/models/gross_earnings_history.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class GrossEarningsHistory(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"days_paid": "int", "unpaid_weeks": "int"} + + attribute_map = {"days_paid": "daysPaid", "unpaid_weeks": "unpaidWeeks"} + + def __init__(self, days_paid=None, unpaid_weeks=None): # noqa: E501 + """GrossEarningsHistory - a model defined in OpenAPI""" # noqa: E501 + + self._days_paid = None + self._unpaid_weeks = None + self.discriminator = None + + if days_paid is not None: + self.days_paid = days_paid + if unpaid_weeks is not None: + self.unpaid_weeks = unpaid_weeks + + @property + def days_paid(self): + """Gets the days_paid of this GrossEarningsHistory. # noqa: E501 + + Number of days the employee worked in the pay period (0 - 365) # noqa: E501 + + :return: The days_paid of this GrossEarningsHistory. # noqa: E501 + :rtype: int + """ + return self._days_paid + + @days_paid.setter + def days_paid(self, days_paid): + """Sets the days_paid of this GrossEarningsHistory. + + Number of days the employee worked in the pay period (0 - 365) # noqa: E501 + + :param days_paid: The days_paid of this GrossEarningsHistory. # noqa: E501 + :type: int + """ + + self._days_paid = days_paid + + @property + def unpaid_weeks(self): + """Gets the unpaid_weeks of this GrossEarningsHistory. # noqa: E501 + + Number of full weeks the employee didn't work in the pay period (0 - 52) # noqa: E501 + + :return: The unpaid_weeks of this GrossEarningsHistory. # noqa: E501 + :rtype: int + """ + return self._unpaid_weeks + + @unpaid_weeks.setter + def unpaid_weeks(self, unpaid_weeks): + """Sets the unpaid_weeks of this GrossEarningsHistory. + + Number of full weeks the employee didn't work in the pay period (0 - 52) # noqa: E501 + + :param unpaid_weeks: The unpaid_weeks of this GrossEarningsHistory. # noqa: E501 + :type: int + """ + + self._unpaid_weeks = unpaid_weeks diff --git a/xero_python/payrollnz/models/invalid_field.py b/xero_python/payrollnz/models/invalid_field.py new file mode 100644 index 00000000..61954d09 --- /dev/null +++ b/xero_python/payrollnz/models/invalid_field.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class InvalidField(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"name": "str", "reason": "str"} + + attribute_map = {"name": "name", "reason": "reason"} + + def __init__(self, name=None, reason=None): # noqa: E501 + """InvalidField - a model defined in OpenAPI""" # noqa: E501 + + self._name = None + self._reason = None + self.discriminator = None + + if name is not None: + self.name = name + if reason is not None: + self.reason = reason + + @property + def name(self): + """Gets the name of this InvalidField. # noqa: E501 + + The name of the field that caused the error # noqa: E501 + + :return: The name of this InvalidField. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this InvalidField. + + The name of the field that caused the error # noqa: E501 + + :param name: The name of this InvalidField. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def reason(self): + """Gets the reason of this InvalidField. # noqa: E501 + + The reason the error occurred # noqa: E501 + + :return: The reason of this InvalidField. # noqa: E501 + :rtype: str + """ + return self._reason + + @reason.setter + def reason(self, reason): + """Sets the reason of this InvalidField. + + The reason the error occurred # noqa: E501 + + :param reason: The reason of this InvalidField. # noqa: E501 + :type: str + """ + + self._reason = reason diff --git a/xero_python/payrollnz/models/leave_accrual_line.py b/xero_python/payrollnz/models/leave_accrual_line.py new file mode 100644 index 00000000..84b8cb56 --- /dev/null +++ b/xero_python/payrollnz/models/leave_accrual_line.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class LeaveAccrualLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"leave_type_id": "str", "number_of_units": "float"} + + attribute_map = {"leave_type_id": "leaveTypeID", "number_of_units": "numberOfUnits"} + + def __init__(self, leave_type_id=None, number_of_units=None): # noqa: E501 + """LeaveAccrualLine - a model defined in OpenAPI""" # noqa: E501 + + self._leave_type_id = None + self._number_of_units = None + self.discriminator = None + + if leave_type_id is not None: + self.leave_type_id = leave_type_id + if number_of_units is not None: + self.number_of_units = number_of_units + + @property + def leave_type_id(self): + """Gets the leave_type_id of this LeaveAccrualLine. # noqa: E501 + + Xero identifier for the Leave type # noqa: E501 + + :return: The leave_type_id of this LeaveAccrualLine. # noqa: E501 + :rtype: str + """ + return self._leave_type_id + + @leave_type_id.setter + def leave_type_id(self, leave_type_id): + """Sets the leave_type_id of this LeaveAccrualLine. + + Xero identifier for the Leave type # noqa: E501 + + :param leave_type_id: The leave_type_id of this LeaveAccrualLine. # noqa: E501 + :type: str + """ + + self._leave_type_id = leave_type_id + + @property + def number_of_units(self): + """Gets the number_of_units of this LeaveAccrualLine. # noqa: E501 + + Leave accrual number of units # noqa: E501 + + :return: The number_of_units of this LeaveAccrualLine. # noqa: E501 + :rtype: float + """ + return self._number_of_units + + @number_of_units.setter + def number_of_units(self, number_of_units): + """Sets the number_of_units of this LeaveAccrualLine. + + Leave accrual number of units # noqa: E501 + + :param number_of_units: The number_of_units of this LeaveAccrualLine. # noqa: E501 + :type: float + """ + + self._number_of_units = number_of_units diff --git a/xero_python/payrollnz/models/leave_earnings_line.py b/xero_python/payrollnz/models/leave_earnings_line.py new file mode 100644 index 00000000..ae87f1d4 --- /dev/null +++ b/xero_python/payrollnz/models/leave_earnings_line.py @@ -0,0 +1,335 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class LeaveEarningsLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "earnings_line_id": "str", + "earnings_rate_id": "str", + "display_name": "str", + "rate_per_unit": "float", + "number_of_units": "float", + "fixed_amount": "float", + "amount": "float", + "is_linked_to_timesheet": "bool", + "is_average_daily_pay_rate": "bool", + "is_system_generated": "bool", + } + + attribute_map = { + "earnings_line_id": "earningsLineID", + "earnings_rate_id": "earningsRateID", + "display_name": "displayName", + "rate_per_unit": "ratePerUnit", + "number_of_units": "numberOfUnits", + "fixed_amount": "fixedAmount", + "amount": "amount", + "is_linked_to_timesheet": "isLinkedToTimesheet", + "is_average_daily_pay_rate": "isAverageDailyPayRate", + "is_system_generated": "isSystemGenerated", + } + + def __init__( + self, + earnings_line_id=None, + earnings_rate_id=None, + display_name=None, + rate_per_unit=None, + number_of_units=None, + fixed_amount=None, + amount=None, + is_linked_to_timesheet=None, + is_average_daily_pay_rate=None, + is_system_generated=None, + ): # noqa: E501 + """LeaveEarningsLine - a model defined in OpenAPI""" # noqa: E501 + + self._earnings_line_id = None + self._earnings_rate_id = None + self._display_name = None + self._rate_per_unit = None + self._number_of_units = None + self._fixed_amount = None + self._amount = None + self._is_linked_to_timesheet = None + self._is_average_daily_pay_rate = None + self._is_system_generated = None + self.discriminator = None + + if earnings_line_id is not None: + self.earnings_line_id = earnings_line_id + if earnings_rate_id is not None: + self.earnings_rate_id = earnings_rate_id + if display_name is not None: + self.display_name = display_name + if rate_per_unit is not None: + self.rate_per_unit = rate_per_unit + if number_of_units is not None: + self.number_of_units = number_of_units + if fixed_amount is not None: + self.fixed_amount = fixed_amount + if amount is not None: + self.amount = amount + if is_linked_to_timesheet is not None: + self.is_linked_to_timesheet = is_linked_to_timesheet + if is_average_daily_pay_rate is not None: + self.is_average_daily_pay_rate = is_average_daily_pay_rate + if is_system_generated is not None: + self.is_system_generated = is_system_generated + + @property + def earnings_line_id(self): + """Gets the earnings_line_id of this LeaveEarningsLine. # noqa: E501 + + Xero identifier for payroll earnings line # noqa: E501 + + :return: The earnings_line_id of this LeaveEarningsLine. # noqa: E501 + :rtype: str + """ + return self._earnings_line_id + + @earnings_line_id.setter + def earnings_line_id(self, earnings_line_id): + """Sets the earnings_line_id of this LeaveEarningsLine. + + Xero identifier for payroll earnings line # noqa: E501 + + :param earnings_line_id: The earnings_line_id of this LeaveEarningsLine. # noqa: E501 + :type: str + """ + + self._earnings_line_id = earnings_line_id + + @property + def earnings_rate_id(self): + """Gets the earnings_rate_id of this LeaveEarningsLine. # noqa: E501 + + Xero identifier for payroll leave earnings rate # noqa: E501 + + :return: The earnings_rate_id of this LeaveEarningsLine. # noqa: E501 + :rtype: str + """ + return self._earnings_rate_id + + @earnings_rate_id.setter + def earnings_rate_id(self, earnings_rate_id): + """Sets the earnings_rate_id of this LeaveEarningsLine. + + Xero identifier for payroll leave earnings rate # noqa: E501 + + :param earnings_rate_id: The earnings_rate_id of this LeaveEarningsLine. # noqa: E501 + :type: str + """ + + self._earnings_rate_id = earnings_rate_id + + @property + def display_name(self): + """Gets the display_name of this LeaveEarningsLine. # noqa: E501 + + name of earnings rate for display in UI # noqa: E501 + + :return: The display_name of this LeaveEarningsLine. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this LeaveEarningsLine. + + name of earnings rate for display in UI # noqa: E501 + + :param display_name: The display_name of this LeaveEarningsLine. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def rate_per_unit(self): + """Gets the rate_per_unit of this LeaveEarningsLine. # noqa: E501 + + Rate per unit for leave earnings line # noqa: E501 + + :return: The rate_per_unit of this LeaveEarningsLine. # noqa: E501 + :rtype: float + """ + return self._rate_per_unit + + @rate_per_unit.setter + def rate_per_unit(self, rate_per_unit): + """Sets the rate_per_unit of this LeaveEarningsLine. + + Rate per unit for leave earnings line # noqa: E501 + + :param rate_per_unit: The rate_per_unit of this LeaveEarningsLine. # noqa: E501 + :type: float + """ + + self._rate_per_unit = rate_per_unit + + @property + def number_of_units(self): + """Gets the number_of_units of this LeaveEarningsLine. # noqa: E501 + + Leave earnings number of units # noqa: E501 + + :return: The number_of_units of this LeaveEarningsLine. # noqa: E501 + :rtype: float + """ + return self._number_of_units + + @number_of_units.setter + def number_of_units(self, number_of_units): + """Sets the number_of_units of this LeaveEarningsLine. + + Leave earnings number of units # noqa: E501 + + :param number_of_units: The number_of_units of this LeaveEarningsLine. # noqa: E501 + :type: float + """ + + self._number_of_units = number_of_units + + @property + def fixed_amount(self): + """Gets the fixed_amount of this LeaveEarningsLine. # noqa: E501 + + Leave earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed # noqa: E501 + + :return: The fixed_amount of this LeaveEarningsLine. # noqa: E501 + :rtype: float + """ + return self._fixed_amount + + @fixed_amount.setter + def fixed_amount(self, fixed_amount): + """Sets the fixed_amount of this LeaveEarningsLine. + + Leave earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed # noqa: E501 + + :param fixed_amount: The fixed_amount of this LeaveEarningsLine. # noqa: E501 + :type: float + """ + + self._fixed_amount = fixed_amount + + @property + def amount(self): + """Gets the amount of this LeaveEarningsLine. # noqa: E501 + + The amount of the earnings line. # noqa: E501 + + :return: The amount of this LeaveEarningsLine. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this LeaveEarningsLine. + + The amount of the earnings line. # noqa: E501 + + :param amount: The amount of this LeaveEarningsLine. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def is_linked_to_timesheet(self): + """Gets the is_linked_to_timesheet of this LeaveEarningsLine. # noqa: E501 + + Identifies if the leave earnings is taken from the timesheet. False for leave earnings line # noqa: E501 + + :return: The is_linked_to_timesheet of this LeaveEarningsLine. # noqa: E501 + :rtype: bool + """ + return self._is_linked_to_timesheet + + @is_linked_to_timesheet.setter + def is_linked_to_timesheet(self, is_linked_to_timesheet): + """Sets the is_linked_to_timesheet of this LeaveEarningsLine. + + Identifies if the leave earnings is taken from the timesheet. False for leave earnings line # noqa: E501 + + :param is_linked_to_timesheet: The is_linked_to_timesheet of this LeaveEarningsLine. # noqa: E501 + :type: bool + """ + + self._is_linked_to_timesheet = is_linked_to_timesheet + + @property + def is_average_daily_pay_rate(self): + """Gets the is_average_daily_pay_rate of this LeaveEarningsLine. # noqa: E501 + + Identifies if the earnings is using an average daily pay rate # noqa: E501 + + :return: The is_average_daily_pay_rate of this LeaveEarningsLine. # noqa: E501 + :rtype: bool + """ + return self._is_average_daily_pay_rate + + @is_average_daily_pay_rate.setter + def is_average_daily_pay_rate(self, is_average_daily_pay_rate): + """Sets the is_average_daily_pay_rate of this LeaveEarningsLine. + + Identifies if the earnings is using an average daily pay rate # noqa: E501 + + :param is_average_daily_pay_rate: The is_average_daily_pay_rate of this LeaveEarningsLine. # noqa: E501 + :type: bool + """ + + self._is_average_daily_pay_rate = is_average_daily_pay_rate + + @property + def is_system_generated(self): + """Gets the is_system_generated of this LeaveEarningsLine. # noqa: E501 + + Flag to indentify whether the earnings line is system generated or not. # noqa: E501 + + :return: The is_system_generated of this LeaveEarningsLine. # noqa: E501 + :rtype: bool + """ + return self._is_system_generated + + @is_system_generated.setter + def is_system_generated(self, is_system_generated): + """Sets the is_system_generated of this LeaveEarningsLine. + + Flag to indentify whether the earnings line is system generated or not. # noqa: E501 + + :param is_system_generated: The is_system_generated of this LeaveEarningsLine. # noqa: E501 + :type: bool + """ + + self._is_system_generated = is_system_generated diff --git a/xero_python/payrollnz/models/leave_period.py b/xero_python/payrollnz/models/leave_period.py new file mode 100644 index 00000000..038d6bbf --- /dev/null +++ b/xero_python/payrollnz/models/leave_period.py @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class LeavePeriod(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "period_start_date": "date", + "period_end_date": "date", + "number_of_units": "float", + "period_status": "str", + } + + attribute_map = { + "period_start_date": "periodStartDate", + "period_end_date": "periodEndDate", + "number_of_units": "numberOfUnits", + "period_status": "periodStatus", + } + + def __init__( + self, + period_start_date=None, + period_end_date=None, + number_of_units=None, + period_status=None, + ): # noqa: E501 + """LeavePeriod - a model defined in OpenAPI""" # noqa: E501 + + self._period_start_date = None + self._period_end_date = None + self._number_of_units = None + self._period_status = None + self.discriminator = None + + if period_start_date is not None: + self.period_start_date = period_start_date + if period_end_date is not None: + self.period_end_date = period_end_date + if number_of_units is not None: + self.number_of_units = number_of_units + if period_status is not None: + self.period_status = period_status + + @property + def period_start_date(self): + """Gets the period_start_date of this LeavePeriod. # noqa: E501 + + The Pay Period Start Date (YYYY-MM-DD) # noqa: E501 + + :return: The period_start_date of this LeavePeriod. # noqa: E501 + :rtype: date + """ + return self._period_start_date + + @period_start_date.setter + def period_start_date(self, period_start_date): + """Sets the period_start_date of this LeavePeriod. + + The Pay Period Start Date (YYYY-MM-DD) # noqa: E501 + + :param period_start_date: The period_start_date of this LeavePeriod. # noqa: E501 + :type: date + """ + + self._period_start_date = period_start_date + + @property + def period_end_date(self): + """Gets the period_end_date of this LeavePeriod. # noqa: E501 + + The Pay Period End Date (YYYY-MM-DD) # noqa: E501 + + :return: The period_end_date of this LeavePeriod. # noqa: E501 + :rtype: date + """ + return self._period_end_date + + @period_end_date.setter + def period_end_date(self, period_end_date): + """Sets the period_end_date of this LeavePeriod. + + The Pay Period End Date (YYYY-MM-DD) # noqa: E501 + + :param period_end_date: The period_end_date of this LeavePeriod. # noqa: E501 + :type: date + """ + + self._period_end_date = period_end_date + + @property + def number_of_units(self): + """Gets the number_of_units of this LeavePeriod. # noqa: E501 + + The Number of Units for the leave # noqa: E501 + + :return: The number_of_units of this LeavePeriod. # noqa: E501 + :rtype: float + """ + return self._number_of_units + + @number_of_units.setter + def number_of_units(self, number_of_units): + """Sets the number_of_units of this LeavePeriod. + + The Number of Units for the leave # noqa: E501 + + :param number_of_units: The number_of_units of this LeavePeriod. # noqa: E501 + :type: float + """ + + self._number_of_units = number_of_units + + @property + def period_status(self): + """Gets the period_status of this LeavePeriod. # noqa: E501 + + Period Status # noqa: E501 + + :return: The period_status of this LeavePeriod. # noqa: E501 + :rtype: str + """ + return self._period_status + + @period_status.setter + def period_status(self, period_status): + """Sets the period_status of this LeavePeriod. + + Period Status # noqa: E501 + + :param period_status: The period_status of this LeavePeriod. # noqa: E501 + :type: str + """ + allowed_values = ["Approved", "Completed", "None"] # noqa: E501 + if period_status not in allowed_values: + raise ValueError( + "Invalid value for `period_status` ({0}), must be one of {1}".format( # noqa: E501 + period_status, allowed_values + ) + ) + + self._period_status = period_status diff --git a/xero_python/payrollnz/models/leave_periods.py b/xero_python/payrollnz/models/leave_periods.py new file mode 100644 index 00000000..4d6c7170 --- /dev/null +++ b/xero_python/payrollnz/models/leave_periods.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class LeavePeriods(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "periods": "list[LeavePeriod]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "periods": "periods", + } + + def __init__(self, pagination=None, problem=None, periods=None): # noqa: E501 + """LeavePeriods - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._periods = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if periods is not None: + self.periods = periods + + @property + def pagination(self): + """Gets the pagination of this LeavePeriods. # noqa: E501 + + + :return: The pagination of this LeavePeriods. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this LeavePeriods. + + + :param pagination: The pagination of this LeavePeriods. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this LeavePeriods. # noqa: E501 + + + :return: The problem of this LeavePeriods. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this LeavePeriods. + + + :param problem: The problem of this LeavePeriods. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def periods(self): + """Gets the periods of this LeavePeriods. # noqa: E501 + + + :return: The periods of this LeavePeriods. # noqa: E501 + :rtype: list[LeavePeriod] + """ + return self._periods + + @periods.setter + def periods(self, periods): + """Sets the periods of this LeavePeriods. + + + :param periods: The periods of this LeavePeriods. # noqa: E501 + :type: list[LeavePeriod] + """ + + self._periods = periods diff --git a/xero_python/payrollnz/models/leave_type.py b/xero_python/payrollnz/models/leave_type.py new file mode 100644 index 00000000..c79dede4 --- /dev/null +++ b/xero_python/payrollnz/models/leave_type.py @@ -0,0 +1,228 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class LeaveType(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "leave_type_id": "str", + "name": "str", + "is_paid_leave": "bool", + "show_on_payslip": "bool", + "updated_date_utc": "datetime", + "is_active": "bool", + } + + attribute_map = { + "leave_type_id": "leaveTypeID", + "name": "name", + "is_paid_leave": "isPaidLeave", + "show_on_payslip": "showOnPayslip", + "updated_date_utc": "updatedDateUTC", + "is_active": "isActive", + } + + def __init__( + self, + leave_type_id=None, + name=None, + is_paid_leave=None, + show_on_payslip=None, + updated_date_utc=None, + is_active=None, + ): # noqa: E501 + """LeaveType - a model defined in OpenAPI""" # noqa: E501 + + self._leave_type_id = None + self._name = None + self._is_paid_leave = None + self._show_on_payslip = None + self._updated_date_utc = None + self._is_active = None + self.discriminator = None + + if leave_type_id is not None: + self.leave_type_id = leave_type_id + self.name = name + self.is_paid_leave = is_paid_leave + self.show_on_payslip = show_on_payslip + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + if is_active is not None: + self.is_active = is_active + + @property + def leave_type_id(self): + """Gets the leave_type_id of this LeaveType. # noqa: E501 + + Xero unique identifier for the leave type # noqa: E501 + + :return: The leave_type_id of this LeaveType. # noqa: E501 + :rtype: str + """ + return self._leave_type_id + + @leave_type_id.setter + def leave_type_id(self, leave_type_id): + """Sets the leave_type_id of this LeaveType. + + Xero unique identifier for the leave type # noqa: E501 + + :param leave_type_id: The leave_type_id of this LeaveType. # noqa: E501 + :type: str + """ + + self._leave_type_id = leave_type_id + + @property + def name(self): + """Gets the name of this LeaveType. # noqa: E501 + + Name of the leave type # noqa: E501 + + :return: The name of this LeaveType. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this LeaveType. + + Name of the leave type # noqa: E501 + + :param name: The name of this LeaveType. # noqa: E501 + :type: str + """ + if name is None: + raise ValueError( + "Invalid value for `name`, must not be `None`" + ) # noqa: E501 + + self._name = name + + @property + def is_paid_leave(self): + """Gets the is_paid_leave of this LeaveType. # noqa: E501 + + Indicate that an employee will be paid when taking this type of leave # noqa: E501 + + :return: The is_paid_leave of this LeaveType. # noqa: E501 + :rtype: bool + """ + return self._is_paid_leave + + @is_paid_leave.setter + def is_paid_leave(self, is_paid_leave): + """Sets the is_paid_leave of this LeaveType. + + Indicate that an employee will be paid when taking this type of leave # noqa: E501 + + :param is_paid_leave: The is_paid_leave of this LeaveType. # noqa: E501 + :type: bool + """ + if is_paid_leave is None: + raise ValueError( + "Invalid value for `is_paid_leave`, must not be `None`" + ) # noqa: E501 + + self._is_paid_leave = is_paid_leave + + @property + def show_on_payslip(self): + """Gets the show_on_payslip of this LeaveType. # noqa: E501 + + Indicate that a balance for this leave type to be shown on the employee’s payslips # noqa: E501 + + :return: The show_on_payslip of this LeaveType. # noqa: E501 + :rtype: bool + """ + return self._show_on_payslip + + @show_on_payslip.setter + def show_on_payslip(self, show_on_payslip): + """Sets the show_on_payslip of this LeaveType. + + Indicate that a balance for this leave type to be shown on the employee’s payslips # noqa: E501 + + :param show_on_payslip: The show_on_payslip of this LeaveType. # noqa: E501 + :type: bool + """ + if show_on_payslip is None: + raise ValueError( + "Invalid value for `show_on_payslip`, must not be `None`" + ) # noqa: E501 + + self._show_on_payslip = show_on_payslip + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this LeaveType. # noqa: E501 + + UTC timestamp of last update to the leave type note # noqa: E501 + + :return: The updated_date_utc of this LeaveType. # noqa: E501 + :rtype: datetime + """ + return self._updated_date_utc + + @updated_date_utc.setter + def updated_date_utc(self, updated_date_utc): + """Sets the updated_date_utc of this LeaveType. + + UTC timestamp of last update to the leave type note # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this LeaveType. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc + + @property + def is_active(self): + """Gets the is_active of this LeaveType. # noqa: E501 + + Shows whether the leave type is active or not # noqa: E501 + + :return: The is_active of this LeaveType. # noqa: E501 + :rtype: bool + """ + return self._is_active + + @is_active.setter + def is_active(self, is_active): + """Sets the is_active of this LeaveType. + + Shows whether the leave type is active or not # noqa: E501 + + :param is_active: The is_active of this LeaveType. # noqa: E501 + :type: bool + """ + + self._is_active = is_active diff --git a/xero_python/payrollnz/models/leave_type_object.py b/xero_python/payrollnz/models/leave_type_object.py new file mode 100644 index 00000000..d048899c --- /dev/null +++ b/xero_python/payrollnz/models/leave_type_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class LeaveTypeObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "leave_type": "LeaveType", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "leave_type": "leaveType", + } + + def __init__(self, pagination=None, problem=None, leave_type=None): # noqa: E501 + """LeaveTypeObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._leave_type = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if leave_type is not None: + self.leave_type = leave_type + + @property + def pagination(self): + """Gets the pagination of this LeaveTypeObject. # noqa: E501 + + + :return: The pagination of this LeaveTypeObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this LeaveTypeObject. + + + :param pagination: The pagination of this LeaveTypeObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this LeaveTypeObject. # noqa: E501 + + + :return: The problem of this LeaveTypeObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this LeaveTypeObject. + + + :param problem: The problem of this LeaveTypeObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def leave_type(self): + """Gets the leave_type of this LeaveTypeObject. # noqa: E501 + + + :return: The leave_type of this LeaveTypeObject. # noqa: E501 + :rtype: LeaveType + """ + return self._leave_type + + @leave_type.setter + def leave_type(self, leave_type): + """Sets the leave_type of this LeaveTypeObject. + + + :param leave_type: The leave_type of this LeaveTypeObject. # noqa: E501 + :type: LeaveType + """ + + self._leave_type = leave_type diff --git a/xero_python/payrollnz/models/leave_types.py b/xero_python/payrollnz/models/leave_types.py new file mode 100644 index 00000000..bb90ebe1 --- /dev/null +++ b/xero_python/payrollnz/models/leave_types.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class LeaveTypes(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "leave_types": "list[LeaveType]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "leave_types": "leaveTypes", + } + + def __init__(self, pagination=None, problem=None, leave_types=None): # noqa: E501 + """LeaveTypes - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._leave_types = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if leave_types is not None: + self.leave_types = leave_types + + @property + def pagination(self): + """Gets the pagination of this LeaveTypes. # noqa: E501 + + + :return: The pagination of this LeaveTypes. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this LeaveTypes. + + + :param pagination: The pagination of this LeaveTypes. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this LeaveTypes. # noqa: E501 + + + :return: The problem of this LeaveTypes. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this LeaveTypes. + + + :param problem: The problem of this LeaveTypes. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def leave_types(self): + """Gets the leave_types of this LeaveTypes. # noqa: E501 + + + :return: The leave_types of this LeaveTypes. # noqa: E501 + :rtype: list[LeaveType] + """ + return self._leave_types + + @leave_types.setter + def leave_types(self, leave_types): + """Sets the leave_types of this LeaveTypes. + + + :param leave_types: The leave_types of this LeaveTypes. # noqa: E501 + :type: list[LeaveType] + """ + + self._leave_types = leave_types diff --git a/xero_python/payrollnz/models/pagination.py b/xero_python/payrollnz/models/pagination.py new file mode 100644 index 00000000..25a2e2fd --- /dev/null +++ b/xero_python/payrollnz/models/pagination.py @@ -0,0 +1,149 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Pagination(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "page": "int", + "page_size": "int", + "page_count": "int", + "item_count": "int", + } + + attribute_map = { + "page": "page", + "page_size": "pageSize", + "page_count": "pageCount", + "item_count": "itemCount", + } + + def __init__( + self, page=None, page_size=None, page_count=None, item_count=None + ): # noqa: E501 + """Pagination - a model defined in OpenAPI""" # noqa: E501 + + self._page = None + self._page_size = None + self._page_count = None + self._item_count = None + self.discriminator = None + + if page is not None: + self.page = page + if page_size is not None: + self.page_size = page_size + if page_count is not None: + self.page_count = page_count + if item_count is not None: + self.item_count = item_count + + @property + def page(self): + """Gets the page of this Pagination. # noqa: E501 + + + :return: The page of this Pagination. # noqa: E501 + :rtype: int + """ + return self._page + + @page.setter + def page(self, page): + """Sets the page of this Pagination. + + + :param page: The page of this Pagination. # noqa: E501 + :type: int + """ + + self._page = page + + @property + def page_size(self): + """Gets the page_size of this Pagination. # noqa: E501 + + + :return: The page_size of this Pagination. # noqa: E501 + :rtype: int + """ + return self._page_size + + @page_size.setter + def page_size(self, page_size): + """Sets the page_size of this Pagination. + + + :param page_size: The page_size of this Pagination. # noqa: E501 + :type: int + """ + + self._page_size = page_size + + @property + def page_count(self): + """Gets the page_count of this Pagination. # noqa: E501 + + + :return: The page_count of this Pagination. # noqa: E501 + :rtype: int + """ + return self._page_count + + @page_count.setter + def page_count(self, page_count): + """Sets the page_count of this Pagination. + + + :param page_count: The page_count of this Pagination. # noqa: E501 + :type: int + """ + + self._page_count = page_count + + @property + def item_count(self): + """Gets the item_count of this Pagination. # noqa: E501 + + + :return: The item_count of this Pagination. # noqa: E501 + :rtype: int + """ + return self._item_count + + @item_count.setter + def item_count(self, item_count): + """Sets the item_count of this Pagination. + + + :param item_count: The item_count of this Pagination. # noqa: E501 + :type: int + """ + + self._item_count = item_count diff --git a/xero_python/payrollnz/models/pay_run.py b/xero_python/payrollnz/models/pay_run.py new file mode 100644 index 00000000..c46ecc29 --- /dev/null +++ b/xero_python/payrollnz/models/pay_run.py @@ -0,0 +1,425 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PayRun(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pay_run_id": "str", + "payroll_calendar_id": "str", + "period_start_date": "date", + "period_end_date": "date", + "payment_date": "date", + "total_cost": "float", + "total_pay": "float", + "pay_run_status": "str", + "pay_run_type": "str", + "calendar_type": "str", + "posted_date_time": "date", + "pay_slips": "list[PaySlip]", + } + + attribute_map = { + "pay_run_id": "payRunID", + "payroll_calendar_id": "payrollCalendarID", + "period_start_date": "periodStartDate", + "period_end_date": "periodEndDate", + "payment_date": "paymentDate", + "total_cost": "totalCost", + "total_pay": "totalPay", + "pay_run_status": "payRunStatus", + "pay_run_type": "payRunType", + "calendar_type": "calendarType", + "posted_date_time": "postedDateTime", + "pay_slips": "paySlips", + } + + def __init__( + self, + pay_run_id=None, + payroll_calendar_id=None, + period_start_date=None, + period_end_date=None, + payment_date=None, + total_cost=None, + total_pay=None, + pay_run_status=None, + pay_run_type=None, + calendar_type=None, + posted_date_time=None, + pay_slips=None, + ): # noqa: E501 + """PayRun - a model defined in OpenAPI""" # noqa: E501 + + self._pay_run_id = None + self._payroll_calendar_id = None + self._period_start_date = None + self._period_end_date = None + self._payment_date = None + self._total_cost = None + self._total_pay = None + self._pay_run_status = None + self._pay_run_type = None + self._calendar_type = None + self._posted_date_time = None + self._pay_slips = None + self.discriminator = None + + if pay_run_id is not None: + self.pay_run_id = pay_run_id + if payroll_calendar_id is not None: + self.payroll_calendar_id = payroll_calendar_id + if period_start_date is not None: + self.period_start_date = period_start_date + if period_end_date is not None: + self.period_end_date = period_end_date + if payment_date is not None: + self.payment_date = payment_date + if total_cost is not None: + self.total_cost = total_cost + if total_pay is not None: + self.total_pay = total_pay + if pay_run_status is not None: + self.pay_run_status = pay_run_status + if pay_run_type is not None: + self.pay_run_type = pay_run_type + if calendar_type is not None: + self.calendar_type = calendar_type + if posted_date_time is not None: + self.posted_date_time = posted_date_time + if pay_slips is not None: + self.pay_slips = pay_slips + + @property + def pay_run_id(self): + """Gets the pay_run_id of this PayRun. # noqa: E501 + + Xero unique identifier for the pay run # noqa: E501 + + :return: The pay_run_id of this PayRun. # noqa: E501 + :rtype: str + """ + return self._pay_run_id + + @pay_run_id.setter + def pay_run_id(self, pay_run_id): + """Sets the pay_run_id of this PayRun. + + Xero unique identifier for the pay run # noqa: E501 + + :param pay_run_id: The pay_run_id of this PayRun. # noqa: E501 + :type: str + """ + + self._pay_run_id = pay_run_id + + @property + def payroll_calendar_id(self): + """Gets the payroll_calendar_id of this PayRun. # noqa: E501 + + Xero unique identifier for the payroll calendar # noqa: E501 + + :return: The payroll_calendar_id of this PayRun. # noqa: E501 + :rtype: str + """ + return self._payroll_calendar_id + + @payroll_calendar_id.setter + def payroll_calendar_id(self, payroll_calendar_id): + """Sets the payroll_calendar_id of this PayRun. + + Xero unique identifier for the payroll calendar # noqa: E501 + + :param payroll_calendar_id: The payroll_calendar_id of this PayRun. # noqa: E501 + :type: str + """ + + self._payroll_calendar_id = payroll_calendar_id + + @property + def period_start_date(self): + """Gets the period_start_date of this PayRun. # noqa: E501 + + Period start date of the payroll calendar # noqa: E501 + + :return: The period_start_date of this PayRun. # noqa: E501 + :rtype: date + """ + return self._period_start_date + + @period_start_date.setter + def period_start_date(self, period_start_date): + """Sets the period_start_date of this PayRun. + + Period start date of the payroll calendar # noqa: E501 + + :param period_start_date: The period_start_date of this PayRun. # noqa: E501 + :type: date + """ + + self._period_start_date = period_start_date + + @property + def period_end_date(self): + """Gets the period_end_date of this PayRun. # noqa: E501 + + Period end date of the payroll calendar # noqa: E501 + + :return: The period_end_date of this PayRun. # noqa: E501 + :rtype: date + """ + return self._period_end_date + + @period_end_date.setter + def period_end_date(self, period_end_date): + """Sets the period_end_date of this PayRun. + + Period end date of the payroll calendar # noqa: E501 + + :param period_end_date: The period_end_date of this PayRun. # noqa: E501 + :type: date + """ + + self._period_end_date = period_end_date + + @property + def payment_date(self): + """Gets the payment_date of this PayRun. # noqa: E501 + + Payment date of the pay run # noqa: E501 + + :return: The payment_date of this PayRun. # noqa: E501 + :rtype: date + """ + return self._payment_date + + @payment_date.setter + def payment_date(self, payment_date): + """Sets the payment_date of this PayRun. + + Payment date of the pay run # noqa: E501 + + :param payment_date: The payment_date of this PayRun. # noqa: E501 + :type: date + """ + + self._payment_date = payment_date + + @property + def total_cost(self): + """Gets the total_cost of this PayRun. # noqa: E501 + + Total cost of the pay run # noqa: E501 + + :return: The total_cost of this PayRun. # noqa: E501 + :rtype: float + """ + return self._total_cost + + @total_cost.setter + def total_cost(self, total_cost): + """Sets the total_cost of this PayRun. + + Total cost of the pay run # noqa: E501 + + :param total_cost: The total_cost of this PayRun. # noqa: E501 + :type: float + """ + + self._total_cost = total_cost + + @property + def total_pay(self): + """Gets the total_pay of this PayRun. # noqa: E501 + + Total pay of the pay run # noqa: E501 + + :return: The total_pay of this PayRun. # noqa: E501 + :rtype: float + """ + return self._total_pay + + @total_pay.setter + def total_pay(self, total_pay): + """Sets the total_pay of this PayRun. + + Total pay of the pay run # noqa: E501 + + :param total_pay: The total_pay of this PayRun. # noqa: E501 + :type: float + """ + + self._total_pay = total_pay + + @property + def pay_run_status(self): + """Gets the pay_run_status of this PayRun. # noqa: E501 + + Pay run status # noqa: E501 + + :return: The pay_run_status of this PayRun. # noqa: E501 + :rtype: str + """ + return self._pay_run_status + + @pay_run_status.setter + def pay_run_status(self, pay_run_status): + """Sets the pay_run_status of this PayRun. + + Pay run status # noqa: E501 + + :param pay_run_status: The pay_run_status of this PayRun. # noqa: E501 + :type: str + """ + allowed_values = ["Draft", "Posted", "None"] # noqa: E501 + if pay_run_status not in allowed_values: + raise ValueError( + "Invalid value for `pay_run_status` ({0}), must be one of {1}".format( # noqa: E501 + pay_run_status, allowed_values + ) + ) + + self._pay_run_status = pay_run_status + + @property + def pay_run_type(self): + """Gets the pay_run_type of this PayRun. # noqa: E501 + + Pay run type # noqa: E501 + + :return: The pay_run_type of this PayRun. # noqa: E501 + :rtype: str + """ + return self._pay_run_type + + @pay_run_type.setter + def pay_run_type(self, pay_run_type): + """Sets the pay_run_type of this PayRun. + + Pay run type # noqa: E501 + + :param pay_run_type: The pay_run_type of this PayRun. # noqa: E501 + :type: str + """ + allowed_values = [ + "Scheduled", + "Unscheduled", + "EarlierYearUpdate", + "None", + ] # noqa: E501 + if pay_run_type not in allowed_values: + raise ValueError( + "Invalid value for `pay_run_type` ({0}), must be one of {1}".format( # noqa: E501 + pay_run_type, allowed_values + ) + ) + + self._pay_run_type = pay_run_type + + @property + def calendar_type(self): + """Gets the calendar_type of this PayRun. # noqa: E501 + + Calendar type of the pay run # noqa: E501 + + :return: The calendar_type of this PayRun. # noqa: E501 + :rtype: str + """ + return self._calendar_type + + @calendar_type.setter + def calendar_type(self, calendar_type): + """Sets the calendar_type of this PayRun. + + Calendar type of the pay run # noqa: E501 + + :param calendar_type: The calendar_type of this PayRun. # noqa: E501 + :type: str + """ + allowed_values = [ + "Weekly", + "Fortnightly", + "FourWeekly", + "Monthly", + "Annual", + "Quarterly", + "None", + ] # noqa: E501 + if calendar_type not in allowed_values: + raise ValueError( + "Invalid value for `calendar_type` ({0}), must be one of {1}".format( # noqa: E501 + calendar_type, allowed_values + ) + ) + + self._calendar_type = calendar_type + + @property + def posted_date_time(self): + """Gets the posted_date_time of this PayRun. # noqa: E501 + + Posted date time of the pay run # noqa: E501 + + :return: The posted_date_time of this PayRun. # noqa: E501 + :rtype: date + """ + return self._posted_date_time + + @posted_date_time.setter + def posted_date_time(self, posted_date_time): + """Sets the posted_date_time of this PayRun. + + Posted date time of the pay run # noqa: E501 + + :param posted_date_time: The posted_date_time of this PayRun. # noqa: E501 + :type: date + """ + + self._posted_date_time = posted_date_time + + @property + def pay_slips(self): + """Gets the pay_slips of this PayRun. # noqa: E501 + + + :return: The pay_slips of this PayRun. # noqa: E501 + :rtype: list[PaySlip] + """ + return self._pay_slips + + @pay_slips.setter + def pay_slips(self, pay_slips): + """Sets the pay_slips of this PayRun. + + + :param pay_slips: The pay_slips of this PayRun. # noqa: E501 + :type: list[PaySlip] + """ + + self._pay_slips = pay_slips diff --git a/xero_python/payrollnz/models/pay_run_calendar.py b/xero_python/payrollnz/models/pay_run_calendar.py new file mode 100644 index 00000000..82d0cd35 --- /dev/null +++ b/xero_python/payrollnz/models/pay_run_calendar.py @@ -0,0 +1,275 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PayRunCalendar(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "payroll_calendar_id": "str", + "name": "str", + "calendar_type": "str", + "period_start_date": "date", + "period_end_date": "date", + "payment_date": "date", + "updated_date_utc": "datetime", + } + + attribute_map = { + "payroll_calendar_id": "payrollCalendarID", + "name": "name", + "calendar_type": "calendarType", + "period_start_date": "periodStartDate", + "period_end_date": "periodEndDate", + "payment_date": "paymentDate", + "updated_date_utc": "updatedDateUTC", + } + + def __init__( + self, + payroll_calendar_id=None, + name=None, + calendar_type=None, + period_start_date=None, + period_end_date=None, + payment_date=None, + updated_date_utc=None, + ): # noqa: E501 + """PayRunCalendar - a model defined in OpenAPI""" # noqa: E501 + + self._payroll_calendar_id = None + self._name = None + self._calendar_type = None + self._period_start_date = None + self._period_end_date = None + self._payment_date = None + self._updated_date_utc = None + self.discriminator = None + + if payroll_calendar_id is not None: + self.payroll_calendar_id = payroll_calendar_id + self.name = name + self.calendar_type = calendar_type + self.period_start_date = period_start_date + if period_end_date is not None: + self.period_end_date = period_end_date + self.payment_date = payment_date + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + + @property + def payroll_calendar_id(self): + """Gets the payroll_calendar_id of this PayRunCalendar. # noqa: E501 + + Xero unique identifier for the payroll calendar # noqa: E501 + + :return: The payroll_calendar_id of this PayRunCalendar. # noqa: E501 + :rtype: str + """ + return self._payroll_calendar_id + + @payroll_calendar_id.setter + def payroll_calendar_id(self, payroll_calendar_id): + """Sets the payroll_calendar_id of this PayRunCalendar. + + Xero unique identifier for the payroll calendar # noqa: E501 + + :param payroll_calendar_id: The payroll_calendar_id of this PayRunCalendar. # noqa: E501 + :type: str + """ + + self._payroll_calendar_id = payroll_calendar_id + + @property + def name(self): + """Gets the name of this PayRunCalendar. # noqa: E501 + + Name of the calendar # noqa: E501 + + :return: The name of this PayRunCalendar. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this PayRunCalendar. + + Name of the calendar # noqa: E501 + + :param name: The name of this PayRunCalendar. # noqa: E501 + :type: str + """ + if name is None: + raise ValueError( + "Invalid value for `name`, must not be `None`" + ) # noqa: E501 + + self._name = name + + @property + def calendar_type(self): + """Gets the calendar_type of this PayRunCalendar. # noqa: E501 + + Type of the calendar # noqa: E501 + + :return: The calendar_type of this PayRunCalendar. # noqa: E501 + :rtype: str + """ + return self._calendar_type + + @calendar_type.setter + def calendar_type(self, calendar_type): + """Sets the calendar_type of this PayRunCalendar. + + Type of the calendar # noqa: E501 + + :param calendar_type: The calendar_type of this PayRunCalendar. # noqa: E501 + :type: str + """ + if calendar_type is None: + raise ValueError( + "Invalid value for `calendar_type`, must not be `None`" + ) # noqa: E501 + allowed_values = [ + "Weekly", + "Fortnightly", + "FourWeekly", + "Monthly", + "Annual", + "Quarterly", + "None", + ] # noqa: E501 + if calendar_type not in allowed_values: + raise ValueError( + "Invalid value for `calendar_type` ({0}), must be one of {1}".format( # noqa: E501 + calendar_type, allowed_values + ) + ) + + self._calendar_type = calendar_type + + @property + def period_start_date(self): + """Gets the period_start_date of this PayRunCalendar. # noqa: E501 + + Period start date of the calendar # noqa: E501 + + :return: The period_start_date of this PayRunCalendar. # noqa: E501 + :rtype: date + """ + return self._period_start_date + + @period_start_date.setter + def period_start_date(self, period_start_date): + """Sets the period_start_date of this PayRunCalendar. + + Period start date of the calendar # noqa: E501 + + :param period_start_date: The period_start_date of this PayRunCalendar. # noqa: E501 + :type: date + """ + if period_start_date is None: + raise ValueError( + "Invalid value for `period_start_date`, must not be `None`" + ) # noqa: E501 + + self._period_start_date = period_start_date + + @property + def period_end_date(self): + """Gets the period_end_date of this PayRunCalendar. # noqa: E501 + + Period end date of the calendar # noqa: E501 + + :return: The period_end_date of this PayRunCalendar. # noqa: E501 + :rtype: date + """ + return self._period_end_date + + @period_end_date.setter + def period_end_date(self, period_end_date): + """Sets the period_end_date of this PayRunCalendar. + + Period end date of the calendar # noqa: E501 + + :param period_end_date: The period_end_date of this PayRunCalendar. # noqa: E501 + :type: date + """ + + self._period_end_date = period_end_date + + @property + def payment_date(self): + """Gets the payment_date of this PayRunCalendar. # noqa: E501 + + Payment date of the calendar # noqa: E501 + + :return: The payment_date of this PayRunCalendar. # noqa: E501 + :rtype: date + """ + return self._payment_date + + @payment_date.setter + def payment_date(self, payment_date): + """Sets the payment_date of this PayRunCalendar. + + Payment date of the calendar # noqa: E501 + + :param payment_date: The payment_date of this PayRunCalendar. # noqa: E501 + :type: date + """ + if payment_date is None: + raise ValueError( + "Invalid value for `payment_date`, must not be `None`" + ) # noqa: E501 + + self._payment_date = payment_date + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this PayRunCalendar. # noqa: E501 + + UTC timestamp of the last update to the pay run calendar # noqa: E501 + + :return: The updated_date_utc of this PayRunCalendar. # noqa: E501 + :rtype: datetime + """ + return self._updated_date_utc + + @updated_date_utc.setter + def updated_date_utc(self, updated_date_utc): + """Sets the updated_date_utc of this PayRunCalendar. + + UTC timestamp of the last update to the pay run calendar # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this PayRunCalendar. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc diff --git a/xero_python/payrollnz/models/pay_run_calendar_object.py b/xero_python/payrollnz/models/pay_run_calendar_object.py new file mode 100644 index 00000000..7afbc1f9 --- /dev/null +++ b/xero_python/payrollnz/models/pay_run_calendar_object.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PayRunCalendarObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "pay_run_calendar": "PayRunCalendar", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "pay_run_calendar": "payRunCalendar", + } + + def __init__( + self, pagination=None, problem=None, pay_run_calendar=None + ): # noqa: E501 + """PayRunCalendarObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._pay_run_calendar = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if pay_run_calendar is not None: + self.pay_run_calendar = pay_run_calendar + + @property + def pagination(self): + """Gets the pagination of this PayRunCalendarObject. # noqa: E501 + + + :return: The pagination of this PayRunCalendarObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this PayRunCalendarObject. + + + :param pagination: The pagination of this PayRunCalendarObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this PayRunCalendarObject. # noqa: E501 + + + :return: The problem of this PayRunCalendarObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this PayRunCalendarObject. + + + :param problem: The problem of this PayRunCalendarObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def pay_run_calendar(self): + """Gets the pay_run_calendar of this PayRunCalendarObject. # noqa: E501 + + + :return: The pay_run_calendar of this PayRunCalendarObject. # noqa: E501 + :rtype: PayRunCalendar + """ + return self._pay_run_calendar + + @pay_run_calendar.setter + def pay_run_calendar(self, pay_run_calendar): + """Sets the pay_run_calendar of this PayRunCalendarObject. + + + :param pay_run_calendar: The pay_run_calendar of this PayRunCalendarObject. # noqa: E501 + :type: PayRunCalendar + """ + + self._pay_run_calendar = pay_run_calendar diff --git a/xero_python/payrollnz/models/pay_run_calendars.py b/xero_python/payrollnz/models/pay_run_calendars.py new file mode 100644 index 00000000..86bb8fcf --- /dev/null +++ b/xero_python/payrollnz/models/pay_run_calendars.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PayRunCalendars(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "pay_run_calendars": "list[PayRunCalendar]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "pay_run_calendars": "payRunCalendars", + } + + def __init__( + self, pagination=None, problem=None, pay_run_calendars=None + ): # noqa: E501 + """PayRunCalendars - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._pay_run_calendars = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if pay_run_calendars is not None: + self.pay_run_calendars = pay_run_calendars + + @property + def pagination(self): + """Gets the pagination of this PayRunCalendars. # noqa: E501 + + + :return: The pagination of this PayRunCalendars. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this PayRunCalendars. + + + :param pagination: The pagination of this PayRunCalendars. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this PayRunCalendars. # noqa: E501 + + + :return: The problem of this PayRunCalendars. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this PayRunCalendars. + + + :param problem: The problem of this PayRunCalendars. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def pay_run_calendars(self): + """Gets the pay_run_calendars of this PayRunCalendars. # noqa: E501 + + + :return: The pay_run_calendars of this PayRunCalendars. # noqa: E501 + :rtype: list[PayRunCalendar] + """ + return self._pay_run_calendars + + @pay_run_calendars.setter + def pay_run_calendars(self, pay_run_calendars): + """Sets the pay_run_calendars of this PayRunCalendars. + + + :param pay_run_calendars: The pay_run_calendars of this PayRunCalendars. # noqa: E501 + :type: list[PayRunCalendar] + """ + + self._pay_run_calendars = pay_run_calendars diff --git a/xero_python/payrollnz/models/pay_run_object.py b/xero_python/payrollnz/models/pay_run_object.py new file mode 100644 index 00000000..6c8ee69c --- /dev/null +++ b/xero_python/payrollnz/models/pay_run_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PayRunObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "pay_run": "PayRun", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "pay_run": "payRun", + } + + def __init__(self, pagination=None, problem=None, pay_run=None): # noqa: E501 + """PayRunObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._pay_run = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if pay_run is not None: + self.pay_run = pay_run + + @property + def pagination(self): + """Gets the pagination of this PayRunObject. # noqa: E501 + + + :return: The pagination of this PayRunObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this PayRunObject. + + + :param pagination: The pagination of this PayRunObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this PayRunObject. # noqa: E501 + + + :return: The problem of this PayRunObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this PayRunObject. + + + :param problem: The problem of this PayRunObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def pay_run(self): + """Gets the pay_run of this PayRunObject. # noqa: E501 + + + :return: The pay_run of this PayRunObject. # noqa: E501 + :rtype: PayRun + """ + return self._pay_run + + @pay_run.setter + def pay_run(self, pay_run): + """Sets the pay_run of this PayRunObject. + + + :param pay_run: The pay_run of this PayRunObject. # noqa: E501 + :type: PayRun + """ + + self._pay_run = pay_run diff --git a/xero_python/payrollnz/models/pay_runs.py b/xero_python/payrollnz/models/pay_runs.py new file mode 100644 index 00000000..cac38740 --- /dev/null +++ b/xero_python/payrollnz/models/pay_runs.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PayRuns(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "pay_runs": "list[PayRun]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "pay_runs": "payRuns", + } + + def __init__(self, pagination=None, problem=None, pay_runs=None): # noqa: E501 + """PayRuns - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._pay_runs = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if pay_runs is not None: + self.pay_runs = pay_runs + + @property + def pagination(self): + """Gets the pagination of this PayRuns. # noqa: E501 + + + :return: The pagination of this PayRuns. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this PayRuns. + + + :param pagination: The pagination of this PayRuns. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this PayRuns. # noqa: E501 + + + :return: The problem of this PayRuns. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this PayRuns. + + + :param problem: The problem of this PayRuns. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def pay_runs(self): + """Gets the pay_runs of this PayRuns. # noqa: E501 + + + :return: The pay_runs of this PayRuns. # noqa: E501 + :rtype: list[PayRun] + """ + return self._pay_runs + + @pay_runs.setter + def pay_runs(self, pay_runs): + """Sets the pay_runs of this PayRuns. + + + :param pay_runs: The pay_runs of this PayRuns. # noqa: E501 + :type: list[PayRun] + """ + + self._pay_runs = pay_runs diff --git a/xero_python/payrollnz/models/pay_slip.py b/xero_python/payrollnz/models/pay_slip.py new file mode 100644 index 00000000..e353e85a --- /dev/null +++ b/xero_python/payrollnz/models/pay_slip.py @@ -0,0 +1,896 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PaySlip(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pay_slip_id": "str", + "employee_id": "str", + "pay_run_id": "str", + "last_edited": "date", + "first_name": "str", + "last_name": "str", + "total_earnings": "float", + "gross_earnings": "float", + "total_pay": "float", + "total_employer_taxes": "float", + "total_employee_taxes": "float", + "total_deductions": "float", + "total_reimbursements": "float", + "total_statutory_deductions": "float", + "total_superannuation": "float", + "bacs_hash": "str", + "payment_method": "str", + "earnings_lines": "list[EarningsLine]", + "leave_earnings_lines": "list[LeaveEarningsLine]", + "timesheet_earnings_lines": "list[TimesheetEarningsLine]", + "deduction_lines": "list[DeductionLine]", + "reimbursement_lines": "list[ReimbursementLine]", + "leave_accrual_lines": "list[LeaveAccrualLine]", + "superannuation_lines": "list[SuperannuationLine]", + "payment_lines": "list[PaymentLine]", + "employee_tax_lines": "list[TaxLine]", + "employer_tax_lines": "list[TaxLine]", + "statutory_deduction_lines": "list[StatutoryDeductionLine]", + "tax_settings": "TaxSettings", + "gross_earnings_history": "GrossEarningsHistory", + } + + attribute_map = { + "pay_slip_id": "paySlipID", + "employee_id": "employeeID", + "pay_run_id": "payRunID", + "last_edited": "lastEdited", + "first_name": "firstName", + "last_name": "lastName", + "total_earnings": "totalEarnings", + "gross_earnings": "grossEarnings", + "total_pay": "totalPay", + "total_employer_taxes": "totalEmployerTaxes", + "total_employee_taxes": "totalEmployeeTaxes", + "total_deductions": "totalDeductions", + "total_reimbursements": "totalReimbursements", + "total_statutory_deductions": "totalStatutoryDeductions", + "total_superannuation": "totalSuperannuation", + "bacs_hash": "bacsHash", + "payment_method": "paymentMethod", + "earnings_lines": "earningsLines", + "leave_earnings_lines": "leaveEarningsLines", + "timesheet_earnings_lines": "timesheetEarningsLines", + "deduction_lines": "deductionLines", + "reimbursement_lines": "reimbursementLines", + "leave_accrual_lines": "leaveAccrualLines", + "superannuation_lines": "superannuationLines", + "payment_lines": "paymentLines", + "employee_tax_lines": "employeeTaxLines", + "employer_tax_lines": "employerTaxLines", + "statutory_deduction_lines": "statutoryDeductionLines", + "tax_settings": "taxSettings", + "gross_earnings_history": "grossEarningsHistory", + } + + def __init__( + self, + pay_slip_id=None, + employee_id=None, + pay_run_id=None, + last_edited=None, + first_name=None, + last_name=None, + total_earnings=None, + gross_earnings=None, + total_pay=None, + total_employer_taxes=None, + total_employee_taxes=None, + total_deductions=None, + total_reimbursements=None, + total_statutory_deductions=None, + total_superannuation=None, + bacs_hash=None, + payment_method=None, + earnings_lines=None, + leave_earnings_lines=None, + timesheet_earnings_lines=None, + deduction_lines=None, + reimbursement_lines=None, + leave_accrual_lines=None, + superannuation_lines=None, + payment_lines=None, + employee_tax_lines=None, + employer_tax_lines=None, + statutory_deduction_lines=None, + tax_settings=None, + gross_earnings_history=None, + ): # noqa: E501 + """PaySlip - a model defined in OpenAPI""" # noqa: E501 + + self._pay_slip_id = None + self._employee_id = None + self._pay_run_id = None + self._last_edited = None + self._first_name = None + self._last_name = None + self._total_earnings = None + self._gross_earnings = None + self._total_pay = None + self._total_employer_taxes = None + self._total_employee_taxes = None + self._total_deductions = None + self._total_reimbursements = None + self._total_statutory_deductions = None + self._total_superannuation = None + self._bacs_hash = None + self._payment_method = None + self._earnings_lines = None + self._leave_earnings_lines = None + self._timesheet_earnings_lines = None + self._deduction_lines = None + self._reimbursement_lines = None + self._leave_accrual_lines = None + self._superannuation_lines = None + self._payment_lines = None + self._employee_tax_lines = None + self._employer_tax_lines = None + self._statutory_deduction_lines = None + self._tax_settings = None + self._gross_earnings_history = None + self.discriminator = None + + if pay_slip_id is not None: + self.pay_slip_id = pay_slip_id + if employee_id is not None: + self.employee_id = employee_id + if pay_run_id is not None: + self.pay_run_id = pay_run_id + if last_edited is not None: + self.last_edited = last_edited + if first_name is not None: + self.first_name = first_name + if last_name is not None: + self.last_name = last_name + if total_earnings is not None: + self.total_earnings = total_earnings + if gross_earnings is not None: + self.gross_earnings = gross_earnings + if total_pay is not None: + self.total_pay = total_pay + if total_employer_taxes is not None: + self.total_employer_taxes = total_employer_taxes + if total_employee_taxes is not None: + self.total_employee_taxes = total_employee_taxes + if total_deductions is not None: + self.total_deductions = total_deductions + if total_reimbursements is not None: + self.total_reimbursements = total_reimbursements + if total_statutory_deductions is not None: + self.total_statutory_deductions = total_statutory_deductions + if total_superannuation is not None: + self.total_superannuation = total_superannuation + if bacs_hash is not None: + self.bacs_hash = bacs_hash + if payment_method is not None: + self.payment_method = payment_method + if earnings_lines is not None: + self.earnings_lines = earnings_lines + if leave_earnings_lines is not None: + self.leave_earnings_lines = leave_earnings_lines + if timesheet_earnings_lines is not None: + self.timesheet_earnings_lines = timesheet_earnings_lines + if deduction_lines is not None: + self.deduction_lines = deduction_lines + if reimbursement_lines is not None: + self.reimbursement_lines = reimbursement_lines + if leave_accrual_lines is not None: + self.leave_accrual_lines = leave_accrual_lines + if superannuation_lines is not None: + self.superannuation_lines = superannuation_lines + if payment_lines is not None: + self.payment_lines = payment_lines + if employee_tax_lines is not None: + self.employee_tax_lines = employee_tax_lines + if employer_tax_lines is not None: + self.employer_tax_lines = employer_tax_lines + if statutory_deduction_lines is not None: + self.statutory_deduction_lines = statutory_deduction_lines + if tax_settings is not None: + self.tax_settings = tax_settings + if gross_earnings_history is not None: + self.gross_earnings_history = gross_earnings_history + + @property + def pay_slip_id(self): + """Gets the pay_slip_id of this PaySlip. # noqa: E501 + + The Xero identifier for a PaySlip # noqa: E501 + + :return: The pay_slip_id of this PaySlip. # noqa: E501 + :rtype: str + """ + return self._pay_slip_id + + @pay_slip_id.setter + def pay_slip_id(self, pay_slip_id): + """Sets the pay_slip_id of this PaySlip. + + The Xero identifier for a PaySlip # noqa: E501 + + :param pay_slip_id: The pay_slip_id of this PaySlip. # noqa: E501 + :type: str + """ + + self._pay_slip_id = pay_slip_id + + @property + def employee_id(self): + """Gets the employee_id of this PaySlip. # noqa: E501 + + The Xero identifier for payroll employee # noqa: E501 + + :return: The employee_id of this PaySlip. # noqa: E501 + :rtype: str + """ + return self._employee_id + + @employee_id.setter + def employee_id(self, employee_id): + """Sets the employee_id of this PaySlip. + + The Xero identifier for payroll employee # noqa: E501 + + :param employee_id: The employee_id of this PaySlip. # noqa: E501 + :type: str + """ + + self._employee_id = employee_id + + @property + def pay_run_id(self): + """Gets the pay_run_id of this PaySlip. # noqa: E501 + + The Xero identifier for the associated payrun # noqa: E501 + + :return: The pay_run_id of this PaySlip. # noqa: E501 + :rtype: str + """ + return self._pay_run_id + + @pay_run_id.setter + def pay_run_id(self, pay_run_id): + """Sets the pay_run_id of this PaySlip. + + The Xero identifier for the associated payrun # noqa: E501 + + :param pay_run_id: The pay_run_id of this PaySlip. # noqa: E501 + :type: str + """ + + self._pay_run_id = pay_run_id + + @property + def last_edited(self): + """Gets the last_edited of this PaySlip. # noqa: E501 + + The date payslip was last updated # noqa: E501 + + :return: The last_edited of this PaySlip. # noqa: E501 + :rtype: date + """ + return self._last_edited + + @last_edited.setter + def last_edited(self, last_edited): + """Sets the last_edited of this PaySlip. + + The date payslip was last updated # noqa: E501 + + :param last_edited: The last_edited of this PaySlip. # noqa: E501 + :type: date + """ + + self._last_edited = last_edited + + @property + def first_name(self): + """Gets the first_name of this PaySlip. # noqa: E501 + + Employee first name # noqa: E501 + + :return: The first_name of this PaySlip. # noqa: E501 + :rtype: str + """ + return self._first_name + + @first_name.setter + def first_name(self, first_name): + """Sets the first_name of this PaySlip. + + Employee first name # noqa: E501 + + :param first_name: The first_name of this PaySlip. # noqa: E501 + :type: str + """ + + self._first_name = first_name + + @property + def last_name(self): + """Gets the last_name of this PaySlip. # noqa: E501 + + Employee last name # noqa: E501 + + :return: The last_name of this PaySlip. # noqa: E501 + :rtype: str + """ + return self._last_name + + @last_name.setter + def last_name(self, last_name): + """Sets the last_name of this PaySlip. + + Employee last name # noqa: E501 + + :param last_name: The last_name of this PaySlip. # noqa: E501 + :type: str + """ + + self._last_name = last_name + + @property + def total_earnings(self): + """Gets the total_earnings of this PaySlip. # noqa: E501 + + Total earnings before any deductions. Same as gross earnings for NZ. # noqa: E501 + + :return: The total_earnings of this PaySlip. # noqa: E501 + :rtype: float + """ + return self._total_earnings + + @total_earnings.setter + def total_earnings(self, total_earnings): + """Sets the total_earnings of this PaySlip. + + Total earnings before any deductions. Same as gross earnings for NZ. # noqa: E501 + + :param total_earnings: The total_earnings of this PaySlip. # noqa: E501 + :type: float + """ + + self._total_earnings = total_earnings + + @property + def gross_earnings(self): + """Gets the gross_earnings of this PaySlip. # noqa: E501 + + Total earnings before any deductions. Same as total earnings for NZ. # noqa: E501 + + :return: The gross_earnings of this PaySlip. # noqa: E501 + :rtype: float + """ + return self._gross_earnings + + @gross_earnings.setter + def gross_earnings(self, gross_earnings): + """Sets the gross_earnings of this PaySlip. + + Total earnings before any deductions. Same as total earnings for NZ. # noqa: E501 + + :param gross_earnings: The gross_earnings of this PaySlip. # noqa: E501 + :type: float + """ + + self._gross_earnings = gross_earnings + + @property + def total_pay(self): + """Gets the total_pay of this PaySlip. # noqa: E501 + + The employee net pay # noqa: E501 + + :return: The total_pay of this PaySlip. # noqa: E501 + :rtype: float + """ + return self._total_pay + + @total_pay.setter + def total_pay(self, total_pay): + """Sets the total_pay of this PaySlip. + + The employee net pay # noqa: E501 + + :param total_pay: The total_pay of this PaySlip. # noqa: E501 + :type: float + """ + + self._total_pay = total_pay + + @property + def total_employer_taxes(self): + """Gets the total_employer_taxes of this PaySlip. # noqa: E501 + + The employer's tax obligation # noqa: E501 + + :return: The total_employer_taxes of this PaySlip. # noqa: E501 + :rtype: float + """ + return self._total_employer_taxes + + @total_employer_taxes.setter + def total_employer_taxes(self, total_employer_taxes): + """Sets the total_employer_taxes of this PaySlip. + + The employer's tax obligation # noqa: E501 + + :param total_employer_taxes: The total_employer_taxes of this PaySlip. # noqa: E501 + :type: float + """ + + self._total_employer_taxes = total_employer_taxes + + @property + def total_employee_taxes(self): + """Gets the total_employee_taxes of this PaySlip. # noqa: E501 + + The part of an employee's earnings that is deducted for tax purposes # noqa: E501 + + :return: The total_employee_taxes of this PaySlip. # noqa: E501 + :rtype: float + """ + return self._total_employee_taxes + + @total_employee_taxes.setter + def total_employee_taxes(self, total_employee_taxes): + """Sets the total_employee_taxes of this PaySlip. + + The part of an employee's earnings that is deducted for tax purposes # noqa: E501 + + :param total_employee_taxes: The total_employee_taxes of this PaySlip. # noqa: E501 + :type: float + """ + + self._total_employee_taxes = total_employee_taxes + + @property + def total_deductions(self): + """Gets the total_deductions of this PaySlip. # noqa: E501 + + Total amount subtracted from an employee's earnings to reach total pay # noqa: E501 + + :return: The total_deductions of this PaySlip. # noqa: E501 + :rtype: float + """ + return self._total_deductions + + @total_deductions.setter + def total_deductions(self, total_deductions): + """Sets the total_deductions of this PaySlip. + + Total amount subtracted from an employee's earnings to reach total pay # noqa: E501 + + :param total_deductions: The total_deductions of this PaySlip. # noqa: E501 + :type: float + """ + + self._total_deductions = total_deductions + + @property + def total_reimbursements(self): + """Gets the total_reimbursements of this PaySlip. # noqa: E501 + + Total reimbursements are nontaxable payments to an employee used to repay out-of-pocket expenses when the person incurs those expenses through employment # noqa: E501 + + :return: The total_reimbursements of this PaySlip. # noqa: E501 + :rtype: float + """ + return self._total_reimbursements + + @total_reimbursements.setter + def total_reimbursements(self, total_reimbursements): + """Sets the total_reimbursements of this PaySlip. + + Total reimbursements are nontaxable payments to an employee used to repay out-of-pocket expenses when the person incurs those expenses through employment # noqa: E501 + + :param total_reimbursements: The total_reimbursements of this PaySlip. # noqa: E501 + :type: float + """ + + self._total_reimbursements = total_reimbursements + + @property + def total_statutory_deductions(self): + """Gets the total_statutory_deductions of this PaySlip. # noqa: E501 + + Total amounts required by law to subtract from the employee's earnings # noqa: E501 + + :return: The total_statutory_deductions of this PaySlip. # noqa: E501 + :rtype: float + """ + return self._total_statutory_deductions + + @total_statutory_deductions.setter + def total_statutory_deductions(self, total_statutory_deductions): + """Sets the total_statutory_deductions of this PaySlip. + + Total amounts required by law to subtract from the employee's earnings # noqa: E501 + + :param total_statutory_deductions: The total_statutory_deductions of this PaySlip. # noqa: E501 + :type: float + """ + + self._total_statutory_deductions = total_statutory_deductions + + @property + def total_superannuation(self): + """Gets the total_superannuation of this PaySlip. # noqa: E501 + + Benefits (also called fringe benefits, perquisites or perks) are various non-earnings compensations provided to employees in addition to their normal earnings or salaries # noqa: E501 + + :return: The total_superannuation of this PaySlip. # noqa: E501 + :rtype: float + """ + return self._total_superannuation + + @total_superannuation.setter + def total_superannuation(self, total_superannuation): + """Sets the total_superannuation of this PaySlip. + + Benefits (also called fringe benefits, perquisites or perks) are various non-earnings compensations provided to employees in addition to their normal earnings or salaries # noqa: E501 + + :param total_superannuation: The total_superannuation of this PaySlip. # noqa: E501 + :type: float + """ + + self._total_superannuation = total_superannuation + + @property + def bacs_hash(self): + """Gets the bacs_hash of this PaySlip. # noqa: E501 + + BACS Service User Number # noqa: E501 + + :return: The bacs_hash of this PaySlip. # noqa: E501 + :rtype: str + """ + return self._bacs_hash + + @bacs_hash.setter + def bacs_hash(self, bacs_hash): + """Sets the bacs_hash of this PaySlip. + + BACS Service User Number # noqa: E501 + + :param bacs_hash: The bacs_hash of this PaySlip. # noqa: E501 + :type: str + """ + + self._bacs_hash = bacs_hash + + @property + def payment_method(self): + """Gets the payment_method of this PaySlip. # noqa: E501 + + The payment method code # noqa: E501 + + :return: The payment_method of this PaySlip. # noqa: E501 + :rtype: str + """ + return self._payment_method + + @payment_method.setter + def payment_method(self, payment_method): + """Sets the payment_method of this PaySlip. + + The payment method code # noqa: E501 + + :param payment_method: The payment_method of this PaySlip. # noqa: E501 + :type: str + """ + allowed_values = ["Cheque", "Electronically", "Manual", "None"] # noqa: E501 + if payment_method not in allowed_values: + raise ValueError( + "Invalid value for `payment_method` ({0}), must be one of {1}".format( # noqa: E501 + payment_method, allowed_values + ) + ) + + self._payment_method = payment_method + + @property + def earnings_lines(self): + """Gets the earnings_lines of this PaySlip. # noqa: E501 + + + :return: The earnings_lines of this PaySlip. # noqa: E501 + :rtype: list[EarningsLine] + """ + return self._earnings_lines + + @earnings_lines.setter + def earnings_lines(self, earnings_lines): + """Sets the earnings_lines of this PaySlip. + + + :param earnings_lines: The earnings_lines of this PaySlip. # noqa: E501 + :type: list[EarningsLine] + """ + + self._earnings_lines = earnings_lines + + @property + def leave_earnings_lines(self): + """Gets the leave_earnings_lines of this PaySlip. # noqa: E501 + + + :return: The leave_earnings_lines of this PaySlip. # noqa: E501 + :rtype: list[LeaveEarningsLine] + """ + return self._leave_earnings_lines + + @leave_earnings_lines.setter + def leave_earnings_lines(self, leave_earnings_lines): + """Sets the leave_earnings_lines of this PaySlip. + + + :param leave_earnings_lines: The leave_earnings_lines of this PaySlip. # noqa: E501 + :type: list[LeaveEarningsLine] + """ + + self._leave_earnings_lines = leave_earnings_lines + + @property + def timesheet_earnings_lines(self): + """Gets the timesheet_earnings_lines of this PaySlip. # noqa: E501 + + + :return: The timesheet_earnings_lines of this PaySlip. # noqa: E501 + :rtype: list[TimesheetEarningsLine] + """ + return self._timesheet_earnings_lines + + @timesheet_earnings_lines.setter + def timesheet_earnings_lines(self, timesheet_earnings_lines): + """Sets the timesheet_earnings_lines of this PaySlip. + + + :param timesheet_earnings_lines: The timesheet_earnings_lines of this PaySlip. # noqa: E501 + :type: list[TimesheetEarningsLine] + """ + + self._timesheet_earnings_lines = timesheet_earnings_lines + + @property + def deduction_lines(self): + """Gets the deduction_lines of this PaySlip. # noqa: E501 + + + :return: The deduction_lines of this PaySlip. # noqa: E501 + :rtype: list[DeductionLine] + """ + return self._deduction_lines + + @deduction_lines.setter + def deduction_lines(self, deduction_lines): + """Sets the deduction_lines of this PaySlip. + + + :param deduction_lines: The deduction_lines of this PaySlip. # noqa: E501 + :type: list[DeductionLine] + """ + + self._deduction_lines = deduction_lines + + @property + def reimbursement_lines(self): + """Gets the reimbursement_lines of this PaySlip. # noqa: E501 + + + :return: The reimbursement_lines of this PaySlip. # noqa: E501 + :rtype: list[ReimbursementLine] + """ + return self._reimbursement_lines + + @reimbursement_lines.setter + def reimbursement_lines(self, reimbursement_lines): + """Sets the reimbursement_lines of this PaySlip. + + + :param reimbursement_lines: The reimbursement_lines of this PaySlip. # noqa: E501 + :type: list[ReimbursementLine] + """ + + self._reimbursement_lines = reimbursement_lines + + @property + def leave_accrual_lines(self): + """Gets the leave_accrual_lines of this PaySlip. # noqa: E501 + + + :return: The leave_accrual_lines of this PaySlip. # noqa: E501 + :rtype: list[LeaveAccrualLine] + """ + return self._leave_accrual_lines + + @leave_accrual_lines.setter + def leave_accrual_lines(self, leave_accrual_lines): + """Sets the leave_accrual_lines of this PaySlip. + + + :param leave_accrual_lines: The leave_accrual_lines of this PaySlip. # noqa: E501 + :type: list[LeaveAccrualLine] + """ + + self._leave_accrual_lines = leave_accrual_lines + + @property + def superannuation_lines(self): + """Gets the superannuation_lines of this PaySlip. # noqa: E501 + + + :return: The superannuation_lines of this PaySlip. # noqa: E501 + :rtype: list[SuperannuationLine] + """ + return self._superannuation_lines + + @superannuation_lines.setter + def superannuation_lines(self, superannuation_lines): + """Sets the superannuation_lines of this PaySlip. + + + :param superannuation_lines: The superannuation_lines of this PaySlip. # noqa: E501 + :type: list[SuperannuationLine] + """ + + self._superannuation_lines = superannuation_lines + + @property + def payment_lines(self): + """Gets the payment_lines of this PaySlip. # noqa: E501 + + + :return: The payment_lines of this PaySlip. # noqa: E501 + :rtype: list[PaymentLine] + """ + return self._payment_lines + + @payment_lines.setter + def payment_lines(self, payment_lines): + """Sets the payment_lines of this PaySlip. + + + :param payment_lines: The payment_lines of this PaySlip. # noqa: E501 + :type: list[PaymentLine] + """ + + self._payment_lines = payment_lines + + @property + def employee_tax_lines(self): + """Gets the employee_tax_lines of this PaySlip. # noqa: E501 + + + :return: The employee_tax_lines of this PaySlip. # noqa: E501 + :rtype: list[TaxLine] + """ + return self._employee_tax_lines + + @employee_tax_lines.setter + def employee_tax_lines(self, employee_tax_lines): + """Sets the employee_tax_lines of this PaySlip. + + + :param employee_tax_lines: The employee_tax_lines of this PaySlip. # noqa: E501 + :type: list[TaxLine] + """ + + self._employee_tax_lines = employee_tax_lines + + @property + def employer_tax_lines(self): + """Gets the employer_tax_lines of this PaySlip. # noqa: E501 + + + :return: The employer_tax_lines of this PaySlip. # noqa: E501 + :rtype: list[TaxLine] + """ + return self._employer_tax_lines + + @employer_tax_lines.setter + def employer_tax_lines(self, employer_tax_lines): + """Sets the employer_tax_lines of this PaySlip. + + + :param employer_tax_lines: The employer_tax_lines of this PaySlip. # noqa: E501 + :type: list[TaxLine] + """ + + self._employer_tax_lines = employer_tax_lines + + @property + def statutory_deduction_lines(self): + """Gets the statutory_deduction_lines of this PaySlip. # noqa: E501 + + + :return: The statutory_deduction_lines of this PaySlip. # noqa: E501 + :rtype: list[StatutoryDeductionLine] + """ + return self._statutory_deduction_lines + + @statutory_deduction_lines.setter + def statutory_deduction_lines(self, statutory_deduction_lines): + """Sets the statutory_deduction_lines of this PaySlip. + + + :param statutory_deduction_lines: The statutory_deduction_lines of this PaySlip. # noqa: E501 + :type: list[StatutoryDeductionLine] + """ + + self._statutory_deduction_lines = statutory_deduction_lines + + @property + def tax_settings(self): + """Gets the tax_settings of this PaySlip. # noqa: E501 + + + :return: The tax_settings of this PaySlip. # noqa: E501 + :rtype: TaxSettings + """ + return self._tax_settings + + @tax_settings.setter + def tax_settings(self, tax_settings): + """Sets the tax_settings of this PaySlip. + + + :param tax_settings: The tax_settings of this PaySlip. # noqa: E501 + :type: TaxSettings + """ + + self._tax_settings = tax_settings + + @property + def gross_earnings_history(self): + """Gets the gross_earnings_history of this PaySlip. # noqa: E501 + + + :return: The gross_earnings_history of this PaySlip. # noqa: E501 + :rtype: GrossEarningsHistory + """ + return self._gross_earnings_history + + @gross_earnings_history.setter + def gross_earnings_history(self, gross_earnings_history): + """Sets the gross_earnings_history of this PaySlip. + + + :param gross_earnings_history: The gross_earnings_history of this PaySlip. # noqa: E501 + :type: GrossEarningsHistory + """ + + self._gross_earnings_history = gross_earnings_history diff --git a/xero_python/payrollnz/models/pay_slip_object.py b/xero_python/payrollnz/models/pay_slip_object.py new file mode 100644 index 00000000..0a4155b6 --- /dev/null +++ b/xero_python/payrollnz/models/pay_slip_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PaySlipObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "pay_slip": "PaySlip", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "pay_slip": "paySlip", + } + + def __init__(self, pagination=None, problem=None, pay_slip=None): # noqa: E501 + """PaySlipObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._pay_slip = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if pay_slip is not None: + self.pay_slip = pay_slip + + @property + def pagination(self): + """Gets the pagination of this PaySlipObject. # noqa: E501 + + + :return: The pagination of this PaySlipObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this PaySlipObject. + + + :param pagination: The pagination of this PaySlipObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this PaySlipObject. # noqa: E501 + + + :return: The problem of this PaySlipObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this PaySlipObject. + + + :param problem: The problem of this PaySlipObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def pay_slip(self): + """Gets the pay_slip of this PaySlipObject. # noqa: E501 + + + :return: The pay_slip of this PaySlipObject. # noqa: E501 + :rtype: PaySlip + """ + return self._pay_slip + + @pay_slip.setter + def pay_slip(self, pay_slip): + """Sets the pay_slip of this PaySlipObject. + + + :param pay_slip: The pay_slip of this PaySlipObject. # noqa: E501 + :type: PaySlip + """ + + self._pay_slip = pay_slip diff --git a/xero_python/payrollnz/models/pay_slips.py b/xero_python/payrollnz/models/pay_slips.py new file mode 100644 index 00000000..98e6ad3c --- /dev/null +++ b/xero_python/payrollnz/models/pay_slips.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PaySlips(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "pay_slips": "list[PaySlip]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "pay_slips": "paySlips", + } + + def __init__(self, pagination=None, problem=None, pay_slips=None): # noqa: E501 + """PaySlips - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._pay_slips = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if pay_slips is not None: + self.pay_slips = pay_slips + + @property + def pagination(self): + """Gets the pagination of this PaySlips. # noqa: E501 + + + :return: The pagination of this PaySlips. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this PaySlips. + + + :param pagination: The pagination of this PaySlips. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this PaySlips. # noqa: E501 + + + :return: The problem of this PaySlips. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this PaySlips. + + + :param problem: The problem of this PaySlips. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def pay_slips(self): + """Gets the pay_slips of this PaySlips. # noqa: E501 + + + :return: The pay_slips of this PaySlips. # noqa: E501 + :rtype: list[PaySlip] + """ + return self._pay_slips + + @pay_slips.setter + def pay_slips(self, pay_slips): + """Sets the pay_slips of this PaySlips. + + + :param pay_slips: The pay_slips of this PaySlips. # noqa: E501 + :type: list[PaySlip] + """ + + self._pay_slips = pay_slips diff --git a/xero_python/payrollnz/models/payment_line.py b/xero_python/payrollnz/models/payment_line.py new file mode 100644 index 00000000..70585b12 --- /dev/null +++ b/xero_python/payrollnz/models/payment_line.py @@ -0,0 +1,190 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PaymentLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "payment_line_id": "str", + "amount": "float", + "account_number": "str", + "sort_code": "str", + "account_name": "str", + } + + attribute_map = { + "payment_line_id": "paymentLineID", + "amount": "amount", + "account_number": "accountNumber", + "sort_code": "sortCode", + "account_name": "accountName", + } + + def __init__( + self, + payment_line_id=None, + amount=None, + account_number=None, + sort_code=None, + account_name=None, + ): # noqa: E501 + """PaymentLine - a model defined in OpenAPI""" # noqa: E501 + + self._payment_line_id = None + self._amount = None + self._account_number = None + self._sort_code = None + self._account_name = None + self.discriminator = None + + if payment_line_id is not None: + self.payment_line_id = payment_line_id + if amount is not None: + self.amount = amount + if account_number is not None: + self.account_number = account_number + if sort_code is not None: + self.sort_code = sort_code + if account_name is not None: + self.account_name = account_name + + @property + def payment_line_id(self): + """Gets the payment_line_id of this PaymentLine. # noqa: E501 + + Xero identifier for payroll payment line # noqa: E501 + + :return: The payment_line_id of this PaymentLine. # noqa: E501 + :rtype: str + """ + return self._payment_line_id + + @payment_line_id.setter + def payment_line_id(self, payment_line_id): + """Sets the payment_line_id of this PaymentLine. + + Xero identifier for payroll payment line # noqa: E501 + + :param payment_line_id: The payment_line_id of this PaymentLine. # noqa: E501 + :type: str + """ + + self._payment_line_id = payment_line_id + + @property + def amount(self): + """Gets the amount of this PaymentLine. # noqa: E501 + + The amount of the payment line # noqa: E501 + + :return: The amount of this PaymentLine. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this PaymentLine. + + The amount of the payment line # noqa: E501 + + :param amount: The amount of this PaymentLine. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def account_number(self): + """Gets the account_number of this PaymentLine. # noqa: E501 + + The account number # noqa: E501 + + :return: The account_number of this PaymentLine. # noqa: E501 + :rtype: str + """ + return self._account_number + + @account_number.setter + def account_number(self, account_number): + """Sets the account_number of this PaymentLine. + + The account number # noqa: E501 + + :param account_number: The account_number of this PaymentLine. # noqa: E501 + :type: str + """ + + self._account_number = account_number + + @property + def sort_code(self): + """Gets the sort_code of this PaymentLine. # noqa: E501 + + The account sort code # noqa: E501 + + :return: The sort_code of this PaymentLine. # noqa: E501 + :rtype: str + """ + return self._sort_code + + @sort_code.setter + def sort_code(self, sort_code): + """Sets the sort_code of this PaymentLine. + + The account sort code # noqa: E501 + + :param sort_code: The sort_code of this PaymentLine. # noqa: E501 + :type: str + """ + + self._sort_code = sort_code + + @property + def account_name(self): + """Gets the account_name of this PaymentLine. # noqa: E501 + + The account name # noqa: E501 + + :return: The account_name of this PaymentLine. # noqa: E501 + :rtype: str + """ + return self._account_name + + @account_name.setter + def account_name(self, account_name): + """Sets the account_name of this PaymentLine. + + The account name # noqa: E501 + + :param account_name: The account_name of this PaymentLine. # noqa: E501 + :type: str + """ + + self._account_name = account_name diff --git a/xero_python/payrollnz/models/payment_method.py b/xero_python/payrollnz/models/payment_method.py new file mode 100644 index 00000000..c1115fd1 --- /dev/null +++ b/xero_python/payrollnz/models/payment_method.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PaymentMethod(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"payment_method": "str", "bank_accounts": "list[BankAccount]"} + + attribute_map = {"payment_method": "paymentMethod", "bank_accounts": "bankAccounts"} + + def __init__(self, payment_method=None, bank_accounts=None): # noqa: E501 + """PaymentMethod - a model defined in OpenAPI""" # noqa: E501 + + self._payment_method = None + self._bank_accounts = None + self.discriminator = None + + if payment_method is not None: + self.payment_method = payment_method + if bank_accounts is not None: + self.bank_accounts = bank_accounts + + @property + def payment_method(self): + """Gets the payment_method of this PaymentMethod. # noqa: E501 + + The payment method code # noqa: E501 + + :return: The payment_method of this PaymentMethod. # noqa: E501 + :rtype: str + """ + return self._payment_method + + @payment_method.setter + def payment_method(self, payment_method): + """Sets the payment_method of this PaymentMethod. + + The payment method code # noqa: E501 + + :param payment_method: The payment_method of this PaymentMethod. # noqa: E501 + :type: str + """ + allowed_values = ["Cheque", "Electronically", "Manual", "None"] # noqa: E501 + if payment_method not in allowed_values: + raise ValueError( + "Invalid value for `payment_method` ({0}), must be one of {1}".format( # noqa: E501 + payment_method, allowed_values + ) + ) + + self._payment_method = payment_method + + @property + def bank_accounts(self): + """Gets the bank_accounts of this PaymentMethod. # noqa: E501 + + + :return: The bank_accounts of this PaymentMethod. # noqa: E501 + :rtype: list[BankAccount] + """ + return self._bank_accounts + + @bank_accounts.setter + def bank_accounts(self, bank_accounts): + """Sets the bank_accounts of this PaymentMethod. + + + :param bank_accounts: The bank_accounts of this PaymentMethod. # noqa: E501 + :type: list[BankAccount] + """ + + self._bank_accounts = bank_accounts diff --git a/xero_python/payrollnz/models/payment_method_object.py b/xero_python/payrollnz/models/payment_method_object.py new file mode 100644 index 00000000..e7f95ebb --- /dev/null +++ b/xero_python/payrollnz/models/payment_method_object.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PaymentMethodObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "payment_method": "PaymentMethod", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "payment_method": "paymentMethod", + } + + def __init__( + self, pagination=None, problem=None, payment_method=None + ): # noqa: E501 + """PaymentMethodObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._payment_method = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if payment_method is not None: + self.payment_method = payment_method + + @property + def pagination(self): + """Gets the pagination of this PaymentMethodObject. # noqa: E501 + + + :return: The pagination of this PaymentMethodObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this PaymentMethodObject. + + + :param pagination: The pagination of this PaymentMethodObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this PaymentMethodObject. # noqa: E501 + + + :return: The problem of this PaymentMethodObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this PaymentMethodObject. + + + :param problem: The problem of this PaymentMethodObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def payment_method(self): + """Gets the payment_method of this PaymentMethodObject. # noqa: E501 + + + :return: The payment_method of this PaymentMethodObject. # noqa: E501 + :rtype: PaymentMethod + """ + return self._payment_method + + @payment_method.setter + def payment_method(self, payment_method): + """Sets the payment_method of this PaymentMethodObject. + + + :param payment_method: The payment_method of this PaymentMethodObject. # noqa: E501 + :type: PaymentMethod + """ + + self._payment_method = payment_method diff --git a/xero_python/payrollnz/models/problem.py b/xero_python/payrollnz/models/problem.py new file mode 100644 index 00000000..5e94b28f --- /dev/null +++ b/xero_python/payrollnz/models/problem.py @@ -0,0 +1,215 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Problem(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "type": "str", + "title": "str", + "status": "str", + "detail": "str", + "instance": "str", + "invalid_fields": "list[InvalidField]", + } + + attribute_map = { + "type": "type", + "title": "title", + "status": "status", + "detail": "detail", + "instance": "instance", + "invalid_fields": "invalidFields", + } + + def __init__( + self, + type=None, + title=None, + status=None, + detail=None, + instance=None, + invalid_fields=None, + ): # noqa: E501 + """Problem - a model defined in OpenAPI""" # noqa: E501 + + self._type = None + self._title = None + self._status = None + self._detail = None + self._instance = None + self._invalid_fields = None + self.discriminator = None + + if type is not None: + self.type = type + if title is not None: + self.title = title + if status is not None: + self.status = status + if detail is not None: + self.detail = detail + if instance is not None: + self.instance = instance + if invalid_fields is not None: + self.invalid_fields = invalid_fields + + @property + def type(self): + """Gets the type of this Problem. # noqa: E501 + + The type of error format # noqa: E501 + + :return: The type of this Problem. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this Problem. + + The type of error format # noqa: E501 + + :param type: The type of this Problem. # noqa: E501 + :type: str + """ + + self._type = type + + @property + def title(self): + """Gets the title of this Problem. # noqa: E501 + + The type of the error # noqa: E501 + + :return: The title of this Problem. # noqa: E501 + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """Sets the title of this Problem. + + The type of the error # noqa: E501 + + :param title: The title of this Problem. # noqa: E501 + :type: str + """ + + self._title = title + + @property + def status(self): + """Gets the status of this Problem. # noqa: E501 + + The error status code # noqa: E501 + + :return: The status of this Problem. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this Problem. + + The error status code # noqa: E501 + + :param status: The status of this Problem. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def detail(self): + """Gets the detail of this Problem. # noqa: E501 + + A description of the error # noqa: E501 + + :return: The detail of this Problem. # noqa: E501 + :rtype: str + """ + return self._detail + + @detail.setter + def detail(self, detail): + """Sets the detail of this Problem. + + A description of the error # noqa: E501 + + :param detail: The detail of this Problem. # noqa: E501 + :type: str + """ + + self._detail = detail + + @property + def instance(self): + """Gets the instance of this Problem. # noqa: E501 + + + :return: The instance of this Problem. # noqa: E501 + :rtype: str + """ + return self._instance + + @instance.setter + def instance(self, instance): + """Sets the instance of this Problem. + + + :param instance: The instance of this Problem. # noqa: E501 + :type: str + """ + + self._instance = instance + + @property + def invalid_fields(self): + """Gets the invalid_fields of this Problem. # noqa: E501 + + + :return: The invalid_fields of this Problem. # noqa: E501 + :rtype: list[InvalidField] + """ + return self._invalid_fields + + @invalid_fields.setter + def invalid_fields(self, invalid_fields): + """Sets the invalid_fields of this Problem. + + + :param invalid_fields: The invalid_fields of this Problem. # noqa: E501 + :type: list[InvalidField] + """ + + self._invalid_fields = invalid_fields diff --git a/xero_python/payrollnz/models/reimbursement.py b/xero_python/payrollnz/models/reimbursement.py new file mode 100644 index 00000000..da6130df --- /dev/null +++ b/xero_python/payrollnz/models/reimbursement.py @@ -0,0 +1,333 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Reimbursement(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "reimbursement_id": "str", + "name": "str", + "account_id": "str", + "current_record": "bool", + "reimbursement_category": "str", + "calculation_type": "str", + "standard_amount": "str", + "standard_type_of_units": "str", + "standard_rate_per_unit": "float", + } + + attribute_map = { + "reimbursement_id": "reimbursementID", + "name": "name", + "account_id": "accountID", + "current_record": "currentRecord", + "reimbursement_category": "reimbursementCategory", + "calculation_type": "calculationType", + "standard_amount": "standardAmount", + "standard_type_of_units": "standardTypeOfUnits", + "standard_rate_per_unit": "standardRatePerUnit", + } + + def __init__( + self, + reimbursement_id=None, + name=None, + account_id=None, + current_record=None, + reimbursement_category=None, + calculation_type=None, + standard_amount=None, + standard_type_of_units=None, + standard_rate_per_unit=None, + ): # noqa: E501 + """Reimbursement - a model defined in OpenAPI""" # noqa: E501 + + self._reimbursement_id = None + self._name = None + self._account_id = None + self._current_record = None + self._reimbursement_category = None + self._calculation_type = None + self._standard_amount = None + self._standard_type_of_units = None + self._standard_rate_per_unit = None + self.discriminator = None + + if reimbursement_id is not None: + self.reimbursement_id = reimbursement_id + self.name = name + self.account_id = account_id + if current_record is not None: + self.current_record = current_record + if reimbursement_category is not None: + self.reimbursement_category = reimbursement_category + if calculation_type is not None: + self.calculation_type = calculation_type + if standard_amount is not None: + self.standard_amount = standard_amount + if standard_type_of_units is not None: + self.standard_type_of_units = standard_type_of_units + if standard_rate_per_unit is not None: + self.standard_rate_per_unit = standard_rate_per_unit + + @property + def reimbursement_id(self): + """Gets the reimbursement_id of this Reimbursement. # noqa: E501 + + Xero unique identifier for a reimbursement # noqa: E501 + + :return: The reimbursement_id of this Reimbursement. # noqa: E501 + :rtype: str + """ + return self._reimbursement_id + + @reimbursement_id.setter + def reimbursement_id(self, reimbursement_id): + """Sets the reimbursement_id of this Reimbursement. + + Xero unique identifier for a reimbursement # noqa: E501 + + :param reimbursement_id: The reimbursement_id of this Reimbursement. # noqa: E501 + :type: str + """ + + self._reimbursement_id = reimbursement_id + + @property + def name(self): + """Gets the name of this Reimbursement. # noqa: E501 + + Name of the reimbursement # noqa: E501 + + :return: The name of this Reimbursement. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this Reimbursement. + + Name of the reimbursement # noqa: E501 + + :param name: The name of this Reimbursement. # noqa: E501 + :type: str + """ + if name is None: + raise ValueError( + "Invalid value for `name`, must not be `None`" + ) # noqa: E501 + + self._name = name + + @property + def account_id(self): + """Gets the account_id of this Reimbursement. # noqa: E501 + + Xero unique identifier for the account used for the reimbursement # noqa: E501 + + :return: The account_id of this Reimbursement. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this Reimbursement. + + Xero unique identifier for the account used for the reimbursement # noqa: E501 + + :param account_id: The account_id of this Reimbursement. # noqa: E501 + :type: str + """ + if account_id is None: + raise ValueError( + "Invalid value for `account_id`, must not be `None`" + ) # noqa: E501 + + self._account_id = account_id + + @property + def current_record(self): + """Gets the current_record of this Reimbursement. # noqa: E501 + + Indicates that whether the reimbursement is active # noqa: E501 + + :return: The current_record of this Reimbursement. # noqa: E501 + :rtype: bool + """ + return self._current_record + + @current_record.setter + def current_record(self, current_record): + """Sets the current_record of this Reimbursement. + + Indicates that whether the reimbursement is active # noqa: E501 + + :param current_record: The current_record of this Reimbursement. # noqa: E501 + :type: bool + """ + + self._current_record = current_record + + @property + def reimbursement_category(self): + """Gets the reimbursement_category of this Reimbursement. # noqa: E501 + + See Reimbursement Categories # noqa: E501 + + :return: The reimbursement_category of this Reimbursement. # noqa: E501 + :rtype: str + """ + return self._reimbursement_category + + @reimbursement_category.setter + def reimbursement_category(self, reimbursement_category): + """Sets the reimbursement_category of this Reimbursement. + + See Reimbursement Categories # noqa: E501 + + :param reimbursement_category: The reimbursement_category of this Reimbursement. # noqa: E501 + :type: str + """ + allowed_values = ["GST", "NoGST", "GSTInclusive", "None"] # noqa: E501 + if reimbursement_category not in allowed_values: + raise ValueError( + "Invalid value for `reimbursement_category` ({0}), must be one of {1}".format( # noqa: E501 + reimbursement_category, allowed_values + ) + ) + + self._reimbursement_category = reimbursement_category + + @property + def calculation_type(self): + """Gets the calculation_type of this Reimbursement. # noqa: E501 + + See Calculation Types # noqa: E501 + + :return: The calculation_type of this Reimbursement. # noqa: E501 + :rtype: str + """ + return self._calculation_type + + @calculation_type.setter + def calculation_type(self, calculation_type): + """Sets the calculation_type of this Reimbursement. + + See Calculation Types # noqa: E501 + + :param calculation_type: The calculation_type of this Reimbursement. # noqa: E501 + :type: str + """ + allowed_values = ["Unknown", "FixedAmount", "RatePerUnit", "None"] # noqa: E501 + if calculation_type not in allowed_values: + raise ValueError( + "Invalid value for `calculation_type` ({0}), must be one of {1}".format( # noqa: E501 + calculation_type, allowed_values + ) + ) + + self._calculation_type = calculation_type + + @property + def standard_amount(self): + """Gets the standard_amount of this Reimbursement. # noqa: E501 + + Optional Fixed Rate Amount. Applicable when calculation type is Fixed Amount # noqa: E501 + + :return: The standard_amount of this Reimbursement. # noqa: E501 + :rtype: str + """ + return self._standard_amount + + @standard_amount.setter + def standard_amount(self, standard_amount): + """Sets the standard_amount of this Reimbursement. + + Optional Fixed Rate Amount. Applicable when calculation type is Fixed Amount # noqa: E501 + + :param standard_amount: The standard_amount of this Reimbursement. # noqa: E501 + :type: str + """ + + self._standard_amount = standard_amount + + @property + def standard_type_of_units(self): + """Gets the standard_type_of_units of this Reimbursement. # noqa: E501 + + Optional Type Of Units. Applicable when calculation type is Rate Per Unit # noqa: E501 + + :return: The standard_type_of_units of this Reimbursement. # noqa: E501 + :rtype: str + """ + return self._standard_type_of_units + + @standard_type_of_units.setter + def standard_type_of_units(self, standard_type_of_units): + """Sets the standard_type_of_units of this Reimbursement. + + Optional Type Of Units. Applicable when calculation type is Rate Per Unit # noqa: E501 + + :param standard_type_of_units: The standard_type_of_units of this Reimbursement. # noqa: E501 + :type: str + """ + allowed_values = ["Hours", "km", "None"] # noqa: E501 + if standard_type_of_units not in allowed_values: + raise ValueError( + "Invalid value for `standard_type_of_units` ({0}), must be one of {1}".format( # noqa: E501 + standard_type_of_units, allowed_values + ) + ) + + self._standard_type_of_units = standard_type_of_units + + @property + def standard_rate_per_unit(self): + """Gets the standard_rate_per_unit of this Reimbursement. # noqa: E501 + + Optional Rate Per Unit. Applicable when calculation type is Rate Per Unit # noqa: E501 + + :return: The standard_rate_per_unit of this Reimbursement. # noqa: E501 + :rtype: float + """ + return self._standard_rate_per_unit + + @standard_rate_per_unit.setter + def standard_rate_per_unit(self, standard_rate_per_unit): + """Sets the standard_rate_per_unit of this Reimbursement. + + Optional Rate Per Unit. Applicable when calculation type is Rate Per Unit # noqa: E501 + + :param standard_rate_per_unit: The standard_rate_per_unit of this Reimbursement. # noqa: E501 + :type: float + """ + + self._standard_rate_per_unit = standard_rate_per_unit diff --git a/xero_python/payrollnz/models/reimbursement_line.py b/xero_python/payrollnz/models/reimbursement_line.py new file mode 100644 index 00000000..07b72e55 --- /dev/null +++ b/xero_python/payrollnz/models/reimbursement_line.py @@ -0,0 +1,190 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class ReimbursementLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "reimbursement_type_id": "str", + "description": "str", + "amount": "float", + "rate_per_unit": "float", + "number_of_units": "float", + } + + attribute_map = { + "reimbursement_type_id": "reimbursementTypeID", + "description": "description", + "amount": "amount", + "rate_per_unit": "ratePerUnit", + "number_of_units": "numberOfUnits", + } + + def __init__( + self, + reimbursement_type_id=None, + description=None, + amount=None, + rate_per_unit=None, + number_of_units=None, + ): # noqa: E501 + """ReimbursementLine - a model defined in OpenAPI""" # noqa: E501 + + self._reimbursement_type_id = None + self._description = None + self._amount = None + self._rate_per_unit = None + self._number_of_units = None + self.discriminator = None + + if reimbursement_type_id is not None: + self.reimbursement_type_id = reimbursement_type_id + if description is not None: + self.description = description + if amount is not None: + self.amount = amount + if rate_per_unit is not None: + self.rate_per_unit = rate_per_unit + if number_of_units is not None: + self.number_of_units = number_of_units + + @property + def reimbursement_type_id(self): + """Gets the reimbursement_type_id of this ReimbursementLine. # noqa: E501 + + Xero identifier for payroll reimbursement # noqa: E501 + + :return: The reimbursement_type_id of this ReimbursementLine. # noqa: E501 + :rtype: str + """ + return self._reimbursement_type_id + + @reimbursement_type_id.setter + def reimbursement_type_id(self, reimbursement_type_id): + """Sets the reimbursement_type_id of this ReimbursementLine. + + Xero identifier for payroll reimbursement # noqa: E501 + + :param reimbursement_type_id: The reimbursement_type_id of this ReimbursementLine. # noqa: E501 + :type: str + """ + + self._reimbursement_type_id = reimbursement_type_id + + @property + def description(self): + """Gets the description of this ReimbursementLine. # noqa: E501 + + Reimbursement line description # noqa: E501 + + :return: The description of this ReimbursementLine. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this ReimbursementLine. + + Reimbursement line description # noqa: E501 + + :param description: The description of this ReimbursementLine. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def amount(self): + """Gets the amount of this ReimbursementLine. # noqa: E501 + + Reimbursement amount # noqa: E501 + + :return: The amount of this ReimbursementLine. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this ReimbursementLine. + + Reimbursement amount # noqa: E501 + + :param amount: The amount of this ReimbursementLine. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def rate_per_unit(self): + """Gets the rate_per_unit of this ReimbursementLine. # noqa: E501 + + Rate per unit for leave earnings line # noqa: E501 + + :return: The rate_per_unit of this ReimbursementLine. # noqa: E501 + :rtype: float + """ + return self._rate_per_unit + + @rate_per_unit.setter + def rate_per_unit(self, rate_per_unit): + """Sets the rate_per_unit of this ReimbursementLine. + + Rate per unit for leave earnings line # noqa: E501 + + :param rate_per_unit: The rate_per_unit of this ReimbursementLine. # noqa: E501 + :type: float + """ + + self._rate_per_unit = rate_per_unit + + @property + def number_of_units(self): + """Gets the number_of_units of this ReimbursementLine. # noqa: E501 + + Leave earnings number of units # noqa: E501 + + :return: The number_of_units of this ReimbursementLine. # noqa: E501 + :rtype: float + """ + return self._number_of_units + + @number_of_units.setter + def number_of_units(self, number_of_units): + """Sets the number_of_units of this ReimbursementLine. + + Leave earnings number of units # noqa: E501 + + :param number_of_units: The number_of_units of this ReimbursementLine. # noqa: E501 + :type: float + """ + + self._number_of_units = number_of_units diff --git a/xero_python/payrollnz/models/reimbursement_object.py b/xero_python/payrollnz/models/reimbursement_object.py new file mode 100644 index 00000000..2a21cbda --- /dev/null +++ b/xero_python/payrollnz/models/reimbursement_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class ReimbursementObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "reimbursement": "Reimbursement", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "reimbursement": "reimbursement", + } + + def __init__(self, pagination=None, problem=None, reimbursement=None): # noqa: E501 + """ReimbursementObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._reimbursement = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if reimbursement is not None: + self.reimbursement = reimbursement + + @property + def pagination(self): + """Gets the pagination of this ReimbursementObject. # noqa: E501 + + + :return: The pagination of this ReimbursementObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this ReimbursementObject. + + + :param pagination: The pagination of this ReimbursementObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this ReimbursementObject. # noqa: E501 + + + :return: The problem of this ReimbursementObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this ReimbursementObject. + + + :param problem: The problem of this ReimbursementObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def reimbursement(self): + """Gets the reimbursement of this ReimbursementObject. # noqa: E501 + + + :return: The reimbursement of this ReimbursementObject. # noqa: E501 + :rtype: Reimbursement + """ + return self._reimbursement + + @reimbursement.setter + def reimbursement(self, reimbursement): + """Sets the reimbursement of this ReimbursementObject. + + + :param reimbursement: The reimbursement of this ReimbursementObject. # noqa: E501 + :type: Reimbursement + """ + + self._reimbursement = reimbursement diff --git a/xero_python/payrollnz/models/reimbursements.py b/xero_python/payrollnz/models/reimbursements.py new file mode 100644 index 00000000..f0d78715 --- /dev/null +++ b/xero_python/payrollnz/models/reimbursements.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Reimbursements(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "reimbursements": "list[Reimbursement]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "reimbursements": "reimbursements", + } + + def __init__( + self, pagination=None, problem=None, reimbursements=None + ): # noqa: E501 + """Reimbursements - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._reimbursements = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if reimbursements is not None: + self.reimbursements = reimbursements + + @property + def pagination(self): + """Gets the pagination of this Reimbursements. # noqa: E501 + + + :return: The pagination of this Reimbursements. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this Reimbursements. + + + :param pagination: The pagination of this Reimbursements. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this Reimbursements. # noqa: E501 + + + :return: The problem of this Reimbursements. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this Reimbursements. + + + :param problem: The problem of this Reimbursements. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def reimbursements(self): + """Gets the reimbursements of this Reimbursements. # noqa: E501 + + + :return: The reimbursements of this Reimbursements. # noqa: E501 + :rtype: list[Reimbursement] + """ + return self._reimbursements + + @reimbursements.setter + def reimbursements(self, reimbursements): + """Sets the reimbursements of this Reimbursements. + + + :param reimbursements: The reimbursements of this Reimbursements. # noqa: E501 + :type: list[Reimbursement] + """ + + self._reimbursements = reimbursements diff --git a/xero_python/payrollnz/models/salary_and_wage.py b/xero_python/payrollnz/models/salary_and_wage.py new file mode 100644 index 00000000..362bce5a --- /dev/null +++ b/xero_python/payrollnz/models/salary_and_wage.py @@ -0,0 +1,370 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SalaryAndWage(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "salary_and_wages_id": "str", + "earnings_rate_id": "str", + "number_of_units_per_week": "float", + "rate_per_unit": "float", + "number_of_units_per_day": "float", + "days_per_week": "int", + "effective_from": "date", + "annual_salary": "float", + "status": "str", + "payment_type": "str", + } + + attribute_map = { + "salary_and_wages_id": "salaryAndWagesID", + "earnings_rate_id": "earningsRateID", + "number_of_units_per_week": "numberOfUnitsPerWeek", + "rate_per_unit": "ratePerUnit", + "number_of_units_per_day": "numberOfUnitsPerDay", + "days_per_week": "daysPerWeek", + "effective_from": "effectiveFrom", + "annual_salary": "annualSalary", + "status": "status", + "payment_type": "paymentType", + } + + def __init__( + self, + salary_and_wages_id=None, + earnings_rate_id=None, + number_of_units_per_week=None, + rate_per_unit=None, + number_of_units_per_day=None, + days_per_week=None, + effective_from=None, + annual_salary=None, + status=None, + payment_type=None, + ): # noqa: E501 + """SalaryAndWage - a model defined in OpenAPI""" # noqa: E501 + + self._salary_and_wages_id = None + self._earnings_rate_id = None + self._number_of_units_per_week = None + self._rate_per_unit = None + self._number_of_units_per_day = None + self._days_per_week = None + self._effective_from = None + self._annual_salary = None + self._status = None + self._payment_type = None + self.discriminator = None + + if salary_and_wages_id is not None: + self.salary_and_wages_id = salary_and_wages_id + self.earnings_rate_id = earnings_rate_id + self.number_of_units_per_week = number_of_units_per_week + if rate_per_unit is not None: + self.rate_per_unit = rate_per_unit + self.number_of_units_per_day = number_of_units_per_day + if days_per_week is not None: + self.days_per_week = days_per_week + self.effective_from = effective_from + self.annual_salary = annual_salary + self.status = status + self.payment_type = payment_type + + @property + def salary_and_wages_id(self): + """Gets the salary_and_wages_id of this SalaryAndWage. # noqa: E501 + + Xero unique identifier for a salary and wages record # noqa: E501 + + :return: The salary_and_wages_id of this SalaryAndWage. # noqa: E501 + :rtype: str + """ + return self._salary_and_wages_id + + @salary_and_wages_id.setter + def salary_and_wages_id(self, salary_and_wages_id): + """Sets the salary_and_wages_id of this SalaryAndWage. + + Xero unique identifier for a salary and wages record # noqa: E501 + + :param salary_and_wages_id: The salary_and_wages_id of this SalaryAndWage. # noqa: E501 + :type: str + """ + + self._salary_and_wages_id = salary_and_wages_id + + @property + def earnings_rate_id(self): + """Gets the earnings_rate_id of this SalaryAndWage. # noqa: E501 + + Xero unique identifier for an earnings rate # noqa: E501 + + :return: The earnings_rate_id of this SalaryAndWage. # noqa: E501 + :rtype: str + """ + return self._earnings_rate_id + + @earnings_rate_id.setter + def earnings_rate_id(self, earnings_rate_id): + """Sets the earnings_rate_id of this SalaryAndWage. + + Xero unique identifier for an earnings rate # noqa: E501 + + :param earnings_rate_id: The earnings_rate_id of this SalaryAndWage. # noqa: E501 + :type: str + """ + if earnings_rate_id is None: + raise ValueError( + "Invalid value for `earnings_rate_id`, must not be `None`" + ) # noqa: E501 + + self._earnings_rate_id = earnings_rate_id + + @property + def number_of_units_per_week(self): + """Gets the number_of_units_per_week of this SalaryAndWage. # noqa: E501 + + The Number of Units per week for the corresponding salary and wages # noqa: E501 + + :return: The number_of_units_per_week of this SalaryAndWage. # noqa: E501 + :rtype: float + """ + return self._number_of_units_per_week + + @number_of_units_per_week.setter + def number_of_units_per_week(self, number_of_units_per_week): + """Sets the number_of_units_per_week of this SalaryAndWage. + + The Number of Units per week for the corresponding salary and wages # noqa: E501 + + :param number_of_units_per_week: The number_of_units_per_week of this SalaryAndWage. # noqa: E501 + :type: float + """ + if number_of_units_per_week is None: + raise ValueError( + "Invalid value for `number_of_units_per_week`, must not be `None`" + ) # noqa: E501 + + self._number_of_units_per_week = number_of_units_per_week + + @property + def rate_per_unit(self): + """Gets the rate_per_unit of this SalaryAndWage. # noqa: E501 + + The rate of each unit for the corresponding salary and wages # noqa: E501 + + :return: The rate_per_unit of this SalaryAndWage. # noqa: E501 + :rtype: float + """ + return self._rate_per_unit + + @rate_per_unit.setter + def rate_per_unit(self, rate_per_unit): + """Sets the rate_per_unit of this SalaryAndWage. + + The rate of each unit for the corresponding salary and wages # noqa: E501 + + :param rate_per_unit: The rate_per_unit of this SalaryAndWage. # noqa: E501 + :type: float + """ + + self._rate_per_unit = rate_per_unit + + @property + def number_of_units_per_day(self): + """Gets the number_of_units_per_day of this SalaryAndWage. # noqa: E501 + + The Number of Units per day for the corresponding salary and wages # noqa: E501 + + :return: The number_of_units_per_day of this SalaryAndWage. # noqa: E501 + :rtype: float + """ + return self._number_of_units_per_day + + @number_of_units_per_day.setter + def number_of_units_per_day(self, number_of_units_per_day): + """Sets the number_of_units_per_day of this SalaryAndWage. + + The Number of Units per day for the corresponding salary and wages # noqa: E501 + + :param number_of_units_per_day: The number_of_units_per_day of this SalaryAndWage. # noqa: E501 + :type: float + """ + if number_of_units_per_day is None: + raise ValueError( + "Invalid value for `number_of_units_per_day`, must not be `None`" + ) # noqa: E501 + + self._number_of_units_per_day = number_of_units_per_day + + @property + def days_per_week(self): + """Gets the days_per_week of this SalaryAndWage. # noqa: E501 + + The days per week for the salary. # noqa: E501 + + :return: The days_per_week of this SalaryAndWage. # noqa: E501 + :rtype: int + """ + return self._days_per_week + + @days_per_week.setter + def days_per_week(self, days_per_week): + """Sets the days_per_week of this SalaryAndWage. + + The days per week for the salary. # noqa: E501 + + :param days_per_week: The days_per_week of this SalaryAndWage. # noqa: E501 + :type: int + """ + + self._days_per_week = days_per_week + + @property + def effective_from(self): + """Gets the effective_from of this SalaryAndWage. # noqa: E501 + + The effective date of the corresponding salary and wages # noqa: E501 + + :return: The effective_from of this SalaryAndWage. # noqa: E501 + :rtype: date + """ + return self._effective_from + + @effective_from.setter + def effective_from(self, effective_from): + """Sets the effective_from of this SalaryAndWage. + + The effective date of the corresponding salary and wages # noqa: E501 + + :param effective_from: The effective_from of this SalaryAndWage. # noqa: E501 + :type: date + """ + if effective_from is None: + raise ValueError( + "Invalid value for `effective_from`, must not be `None`" + ) # noqa: E501 + + self._effective_from = effective_from + + @property + def annual_salary(self): + """Gets the annual_salary of this SalaryAndWage. # noqa: E501 + + The annual salary # noqa: E501 + + :return: The annual_salary of this SalaryAndWage. # noqa: E501 + :rtype: float + """ + return self._annual_salary + + @annual_salary.setter + def annual_salary(self, annual_salary): + """Sets the annual_salary of this SalaryAndWage. + + The annual salary # noqa: E501 + + :param annual_salary: The annual_salary of this SalaryAndWage. # noqa: E501 + :type: float + """ + if annual_salary is None: + raise ValueError( + "Invalid value for `annual_salary`, must not be `None`" + ) # noqa: E501 + + self._annual_salary = annual_salary + + @property + def status(self): + """Gets the status of this SalaryAndWage. # noqa: E501 + + The current status of the corresponding salary and wages # noqa: E501 + + :return: The status of this SalaryAndWage. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this SalaryAndWage. + + The current status of the corresponding salary and wages # noqa: E501 + + :param status: The status of this SalaryAndWage. # noqa: E501 + :type: str + """ + if status is None: + raise ValueError( + "Invalid value for `status`, must not be `None`" + ) # noqa: E501 + allowed_values = ["Active", "Pending", "None"] # noqa: E501 + if status not in allowed_values: + raise ValueError( + "Invalid value for `status` ({0}), must be one of {1}".format( # noqa: E501 + status, allowed_values + ) + ) + + self._status = status + + @property + def payment_type(self): + """Gets the payment_type of this SalaryAndWage. # noqa: E501 + + The type of the payment of the corresponding salary and wages # noqa: E501 + + :return: The payment_type of this SalaryAndWage. # noqa: E501 + :rtype: str + """ + return self._payment_type + + @payment_type.setter + def payment_type(self, payment_type): + """Sets the payment_type of this SalaryAndWage. + + The type of the payment of the corresponding salary and wages # noqa: E501 + + :param payment_type: The payment_type of this SalaryAndWage. # noqa: E501 + :type: str + """ + if payment_type is None: + raise ValueError( + "Invalid value for `payment_type`, must not be `None`" + ) # noqa: E501 + allowed_values = ["Salary", "Hourly", "None"] # noqa: E501 + if payment_type not in allowed_values: + raise ValueError( + "Invalid value for `payment_type` ({0}), must be one of {1}".format( # noqa: E501 + payment_type, allowed_values + ) + ) + + self._payment_type = payment_type diff --git a/xero_python/payrollnz/models/salary_and_wage_object.py b/xero_python/payrollnz/models/salary_and_wage_object.py new file mode 100644 index 00000000..45ef1ae7 --- /dev/null +++ b/xero_python/payrollnz/models/salary_and_wage_object.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SalaryAndWageObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "salary_and_wages": "SalaryAndWage", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "salary_and_wages": "salaryAndWages", + } + + def __init__( + self, pagination=None, problem=None, salary_and_wages=None + ): # noqa: E501 + """SalaryAndWageObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._salary_and_wages = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if salary_and_wages is not None: + self.salary_and_wages = salary_and_wages + + @property + def pagination(self): + """Gets the pagination of this SalaryAndWageObject. # noqa: E501 + + + :return: The pagination of this SalaryAndWageObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this SalaryAndWageObject. + + + :param pagination: The pagination of this SalaryAndWageObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this SalaryAndWageObject. # noqa: E501 + + + :return: The problem of this SalaryAndWageObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this SalaryAndWageObject. + + + :param problem: The problem of this SalaryAndWageObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def salary_and_wages(self): + """Gets the salary_and_wages of this SalaryAndWageObject. # noqa: E501 + + + :return: The salary_and_wages of this SalaryAndWageObject. # noqa: E501 + :rtype: SalaryAndWage + """ + return self._salary_and_wages + + @salary_and_wages.setter + def salary_and_wages(self, salary_and_wages): + """Sets the salary_and_wages of this SalaryAndWageObject. + + + :param salary_and_wages: The salary_and_wages of this SalaryAndWageObject. # noqa: E501 + :type: SalaryAndWage + """ + + self._salary_and_wages = salary_and_wages diff --git a/xero_python/payrollnz/models/salary_and_wages.py b/xero_python/payrollnz/models/salary_and_wages.py new file mode 100644 index 00000000..0fdfee66 --- /dev/null +++ b/xero_python/payrollnz/models/salary_and_wages.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SalaryAndWages(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "salary_and_wages": "list[SalaryAndWage]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "salary_and_wages": "salaryAndWages", + } + + def __init__( + self, pagination=None, problem=None, salary_and_wages=None + ): # noqa: E501 + """SalaryAndWages - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._salary_and_wages = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if salary_and_wages is not None: + self.salary_and_wages = salary_and_wages + + @property + def pagination(self): + """Gets the pagination of this SalaryAndWages. # noqa: E501 + + + :return: The pagination of this SalaryAndWages. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this SalaryAndWages. + + + :param pagination: The pagination of this SalaryAndWages. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this SalaryAndWages. # noqa: E501 + + + :return: The problem of this SalaryAndWages. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this SalaryAndWages. + + + :param problem: The problem of this SalaryAndWages. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def salary_and_wages(self): + """Gets the salary_and_wages of this SalaryAndWages. # noqa: E501 + + + :return: The salary_and_wages of this SalaryAndWages. # noqa: E501 + :rtype: list[SalaryAndWage] + """ + return self._salary_and_wages + + @salary_and_wages.setter + def salary_and_wages(self, salary_and_wages): + """Sets the salary_and_wages of this SalaryAndWages. + + + :param salary_and_wages: The salary_and_wages of this SalaryAndWages. # noqa: E501 + :type: list[SalaryAndWage] + """ + + self._salary_and_wages = salary_and_wages diff --git a/xero_python/payrollnz/models/settings.py b/xero_python/payrollnz/models/settings.py new file mode 100644 index 00000000..0a0c0027 --- /dev/null +++ b/xero_python/payrollnz/models/settings.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Settings(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "settings": "Accounts", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "settings": "settings", + } + + def __init__(self, pagination=None, problem=None, settings=None): # noqa: E501 + """Settings - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._settings = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if settings is not None: + self.settings = settings + + @property + def pagination(self): + """Gets the pagination of this Settings. # noqa: E501 + + + :return: The pagination of this Settings. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this Settings. + + + :param pagination: The pagination of this Settings. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this Settings. # noqa: E501 + + + :return: The problem of this Settings. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this Settings. + + + :param problem: The problem of this Settings. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def settings(self): + """Gets the settings of this Settings. # noqa: E501 + + + :return: The settings of this Settings. # noqa: E501 + :rtype: Accounts + """ + return self._settings + + @settings.setter + def settings(self, settings): + """Sets the settings of this Settings. + + + :param settings: The settings of this Settings. # noqa: E501 + :type: Accounts + """ + + self._settings = settings diff --git a/xero_python/payrollnz/models/statutory_deduction.py b/xero_python/payrollnz/models/statutory_deduction.py new file mode 100644 index 00000000..71f5ef81 --- /dev/null +++ b/xero_python/payrollnz/models/statutory_deduction.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class StatutoryDeduction(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "id": "str", + "name": "str", + "statutory_deduction_category": "StatutoryDeductionCategory", + "liability_account_id": "str", + "current_record": "bool", + } + + attribute_map = { + "id": "id", + "name": "name", + "statutory_deduction_category": "statutoryDeductionCategory", + "liability_account_id": "liabilityAccountId", + "current_record": "currentRecord", + } + + def __init__( + self, + id=None, + name=None, + statutory_deduction_category=None, + liability_account_id=None, + current_record=None, + ): # noqa: E501 + """StatutoryDeduction - a model defined in OpenAPI""" # noqa: E501 + + self._id = None + self._name = None + self._statutory_deduction_category = None + self._liability_account_id = None + self._current_record = None + self.discriminator = None + + if id is not None: + self.id = id + if name is not None: + self.name = name + if statutory_deduction_category is not None: + self.statutory_deduction_category = statutory_deduction_category + if liability_account_id is not None: + self.liability_account_id = liability_account_id + if current_record is not None: + self.current_record = current_record + + @property + def id(self): + """Gets the id of this StatutoryDeduction. # noqa: E501 + + The Xero identifier for earnings order # noqa: E501 + + :return: The id of this StatutoryDeduction. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this StatutoryDeduction. + + The Xero identifier for earnings order # noqa: E501 + + :param id: The id of this StatutoryDeduction. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def name(self): + """Gets the name of this StatutoryDeduction. # noqa: E501 + + Name of the earnings order # noqa: E501 + + :return: The name of this StatutoryDeduction. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this StatutoryDeduction. + + Name of the earnings order # noqa: E501 + + :param name: The name of this StatutoryDeduction. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def statutory_deduction_category(self): + """Gets the statutory_deduction_category of this StatutoryDeduction. # noqa: E501 + + + :return: The statutory_deduction_category of this StatutoryDeduction. # noqa: E501 + :rtype: StatutoryDeductionCategory + """ + return self._statutory_deduction_category + + @statutory_deduction_category.setter + def statutory_deduction_category(self, statutory_deduction_category): + """Sets the statutory_deduction_category of this StatutoryDeduction. + + + :param statutory_deduction_category: The statutory_deduction_category of this StatutoryDeduction. # noqa: E501 + :type: StatutoryDeductionCategory + """ + + self._statutory_deduction_category = statutory_deduction_category + + @property + def liability_account_id(self): + """Gets the liability_account_id of this StatutoryDeduction. # noqa: E501 + + Xero identifier for Liability Account # noqa: E501 + + :return: The liability_account_id of this StatutoryDeduction. # noqa: E501 + :rtype: str + """ + return self._liability_account_id + + @liability_account_id.setter + def liability_account_id(self, liability_account_id): + """Sets the liability_account_id of this StatutoryDeduction. + + Xero identifier for Liability Account # noqa: E501 + + :param liability_account_id: The liability_account_id of this StatutoryDeduction. # noqa: E501 + :type: str + """ + + self._liability_account_id = liability_account_id + + @property + def current_record(self): + """Gets the current_record of this StatutoryDeduction. # noqa: E501 + + Identifier of a record is active or not. # noqa: E501 + + :return: The current_record of this StatutoryDeduction. # noqa: E501 + :rtype: bool + """ + return self._current_record + + @current_record.setter + def current_record(self, current_record): + """Sets the current_record of this StatutoryDeduction. + + Identifier of a record is active or not. # noqa: E501 + + :param current_record: The current_record of this StatutoryDeduction. # noqa: E501 + :type: bool + """ + + self._current_record = current_record diff --git a/xero_python/payrollnz/models/statutory_deduction_category.py b/xero_python/payrollnz/models/statutory_deduction_category.py new file mode 100644 index 00000000..ebf96e5a --- /dev/null +++ b/xero_python/payrollnz/models/statutory_deduction_category.py @@ -0,0 +1,38 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class StatutoryDeductionCategory(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + PRIORITYORDER = "PriorityOrder" + NONPRIORITYORDER = "NonPriorityOrder" + TABLEBASED = "TableBased" + CHILDSUPPORT = "ChildSupport" + COURTFINES = "CourtFines" + INLANDREVENUEARREARS = "InlandRevenueArrears" + MSDREPAYMENTS = "MsdRepayments" + STUDENTLOAN = "StudentLoan" + ADDITIONALSTUDENTLOAN = "AdditionalStudentLoan" + VOLUNTARYSTUDENTLOAN = "VoluntaryStudentLoan" + KIWISAVER = "KiwiSaver" diff --git a/xero_python/payrollnz/models/statutory_deduction_line.py b/xero_python/payrollnz/models/statutory_deduction_line.py new file mode 100644 index 00000000..e5eceabd --- /dev/null +++ b/xero_python/payrollnz/models/statutory_deduction_line.py @@ -0,0 +1,161 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class StatutoryDeductionLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "statutory_deduction_type_id": "str", + "amount": "float", + "fixed_amount": "float", + "manual_adjustment": "bool", + } + + attribute_map = { + "statutory_deduction_type_id": "statutoryDeductionTypeID", + "amount": "amount", + "fixed_amount": "fixedAmount", + "manual_adjustment": "manualAdjustment", + } + + def __init__( + self, + statutory_deduction_type_id=None, + amount=None, + fixed_amount=None, + manual_adjustment=None, + ): # noqa: E501 + """StatutoryDeductionLine - a model defined in OpenAPI""" # noqa: E501 + + self._statutory_deduction_type_id = None + self._amount = None + self._fixed_amount = None + self._manual_adjustment = None + self.discriminator = None + + if statutory_deduction_type_id is not None: + self.statutory_deduction_type_id = statutory_deduction_type_id + if amount is not None: + self.amount = amount + if fixed_amount is not None: + self.fixed_amount = fixed_amount + if manual_adjustment is not None: + self.manual_adjustment = manual_adjustment + + @property + def statutory_deduction_type_id(self): + """Gets the statutory_deduction_type_id of this StatutoryDeductionLine. # noqa: E501 + + Xero identifier for payroll statutory deduction type # noqa: E501 + + :return: The statutory_deduction_type_id of this StatutoryDeductionLine. # noqa: E501 + :rtype: str + """ + return self._statutory_deduction_type_id + + @statutory_deduction_type_id.setter + def statutory_deduction_type_id(self, statutory_deduction_type_id): + """Sets the statutory_deduction_type_id of this StatutoryDeductionLine. + + Xero identifier for payroll statutory deduction type # noqa: E501 + + :param statutory_deduction_type_id: The statutory_deduction_type_id of this StatutoryDeductionLine. # noqa: E501 + :type: str + """ + + self._statutory_deduction_type_id = statutory_deduction_type_id + + @property + def amount(self): + """Gets the amount of this StatutoryDeductionLine. # noqa: E501 + + The amount of the statutory deduction line # noqa: E501 + + :return: The amount of this StatutoryDeductionLine. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this StatutoryDeductionLine. + + The amount of the statutory deduction line # noqa: E501 + + :param amount: The amount of this StatutoryDeductionLine. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def fixed_amount(self): + """Gets the fixed_amount of this StatutoryDeductionLine. # noqa: E501 + + Fixed Amount # noqa: E501 + + :return: The fixed_amount of this StatutoryDeductionLine. # noqa: E501 + :rtype: float + """ + return self._fixed_amount + + @fixed_amount.setter + def fixed_amount(self, fixed_amount): + """Sets the fixed_amount of this StatutoryDeductionLine. + + Fixed Amount # noqa: E501 + + :param fixed_amount: The fixed_amount of this StatutoryDeductionLine. # noqa: E501 + :type: float + """ + + self._fixed_amount = fixed_amount + + @property + def manual_adjustment(self): + """Gets the manual_adjustment of this StatutoryDeductionLine. # noqa: E501 + + Identifies if the tax line is a manual adjustment # noqa: E501 + + :return: The manual_adjustment of this StatutoryDeductionLine. # noqa: E501 + :rtype: bool + """ + return self._manual_adjustment + + @manual_adjustment.setter + def manual_adjustment(self, manual_adjustment): + """Sets the manual_adjustment of this StatutoryDeductionLine. + + Identifies if the tax line is a manual adjustment # noqa: E501 + + :param manual_adjustment: The manual_adjustment of this StatutoryDeductionLine. # noqa: E501 + :type: bool + """ + + self._manual_adjustment = manual_adjustment diff --git a/xero_python/payrollnz/models/statutory_deduction_object.py b/xero_python/payrollnz/models/statutory_deduction_object.py new file mode 100644 index 00000000..cddf48c2 --- /dev/null +++ b/xero_python/payrollnz/models/statutory_deduction_object.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class StatutoryDeductionObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "statutory_deduction": "StatutoryDeduction", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "statutory_deduction": "statutoryDeduction", + } + + def __init__( + self, pagination=None, problem=None, statutory_deduction=None + ): # noqa: E501 + """StatutoryDeductionObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._statutory_deduction = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if statutory_deduction is not None: + self.statutory_deduction = statutory_deduction + + @property + def pagination(self): + """Gets the pagination of this StatutoryDeductionObject. # noqa: E501 + + + :return: The pagination of this StatutoryDeductionObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this StatutoryDeductionObject. + + + :param pagination: The pagination of this StatutoryDeductionObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this StatutoryDeductionObject. # noqa: E501 + + + :return: The problem of this StatutoryDeductionObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this StatutoryDeductionObject. + + + :param problem: The problem of this StatutoryDeductionObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def statutory_deduction(self): + """Gets the statutory_deduction of this StatutoryDeductionObject. # noqa: E501 + + + :return: The statutory_deduction of this StatutoryDeductionObject. # noqa: E501 + :rtype: StatutoryDeduction + """ + return self._statutory_deduction + + @statutory_deduction.setter + def statutory_deduction(self, statutory_deduction): + """Sets the statutory_deduction of this StatutoryDeductionObject. + + + :param statutory_deduction: The statutory_deduction of this StatutoryDeductionObject. # noqa: E501 + :type: StatutoryDeduction + """ + + self._statutory_deduction = statutory_deduction diff --git a/xero_python/payrollnz/models/statutory_deductions.py b/xero_python/payrollnz/models/statutory_deductions.py new file mode 100644 index 00000000..06eee3e6 --- /dev/null +++ b/xero_python/payrollnz/models/statutory_deductions.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class StatutoryDeductions(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "statutory_deductions": "list[StatutoryDeduction]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "statutory_deductions": "statutoryDeductions", + } + + def __init__( + self, pagination=None, problem=None, statutory_deductions=None + ): # noqa: E501 + """StatutoryDeductions - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._statutory_deductions = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if statutory_deductions is not None: + self.statutory_deductions = statutory_deductions + + @property + def pagination(self): + """Gets the pagination of this StatutoryDeductions. # noqa: E501 + + + :return: The pagination of this StatutoryDeductions. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this StatutoryDeductions. + + + :param pagination: The pagination of this StatutoryDeductions. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this StatutoryDeductions. # noqa: E501 + + + :return: The problem of this StatutoryDeductions. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this StatutoryDeductions. + + + :param problem: The problem of this StatutoryDeductions. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def statutory_deductions(self): + """Gets the statutory_deductions of this StatutoryDeductions. # noqa: E501 + + + :return: The statutory_deductions of this StatutoryDeductions. # noqa: E501 + :rtype: list[StatutoryDeduction] + """ + return self._statutory_deductions + + @statutory_deductions.setter + def statutory_deductions(self, statutory_deductions): + """Sets the statutory_deductions of this StatutoryDeductions. + + + :param statutory_deductions: The statutory_deductions of this StatutoryDeductions. # noqa: E501 + :type: list[StatutoryDeduction] + """ + + self._statutory_deductions = statutory_deductions diff --git a/xero_python/payrollnz/models/superannuation_line.py b/xero_python/payrollnz/models/superannuation_line.py new file mode 100644 index 00000000..5a2909a1 --- /dev/null +++ b/xero_python/payrollnz/models/superannuation_line.py @@ -0,0 +1,219 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SuperannuationLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "superannuation_type_id": "str", + "display_name": "str", + "amount": "float", + "fixed_amount": "float", + "percentage": "float", + "manual_adjustment": "bool", + } + + attribute_map = { + "superannuation_type_id": "superannuationTypeID", + "display_name": "displayName", + "amount": "amount", + "fixed_amount": "fixedAmount", + "percentage": "percentage", + "manual_adjustment": "manualAdjustment", + } + + def __init__( + self, + superannuation_type_id=None, + display_name=None, + amount=None, + fixed_amount=None, + percentage=None, + manual_adjustment=None, + ): # noqa: E501 + """SuperannuationLine - a model defined in OpenAPI""" # noqa: E501 + + self._superannuation_type_id = None + self._display_name = None + self._amount = None + self._fixed_amount = None + self._percentage = None + self._manual_adjustment = None + self.discriminator = None + + if superannuation_type_id is not None: + self.superannuation_type_id = superannuation_type_id + if display_name is not None: + self.display_name = display_name + if amount is not None: + self.amount = amount + if fixed_amount is not None: + self.fixed_amount = fixed_amount + if percentage is not None: + self.percentage = percentage + if manual_adjustment is not None: + self.manual_adjustment = manual_adjustment + + @property + def superannuation_type_id(self): + """Gets the superannuation_type_id of this SuperannuationLine. # noqa: E501 + + Xero identifier for payroll superannucation type # noqa: E501 + + :return: The superannuation_type_id of this SuperannuationLine. # noqa: E501 + :rtype: str + """ + return self._superannuation_type_id + + @superannuation_type_id.setter + def superannuation_type_id(self, superannuation_type_id): + """Sets the superannuation_type_id of this SuperannuationLine. + + Xero identifier for payroll superannucation type # noqa: E501 + + :param superannuation_type_id: The superannuation_type_id of this SuperannuationLine. # noqa: E501 + :type: str + """ + + self._superannuation_type_id = superannuation_type_id + + @property + def display_name(self): + """Gets the display_name of this SuperannuationLine. # noqa: E501 + + Benefit display name # noqa: E501 + + :return: The display_name of this SuperannuationLine. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this SuperannuationLine. + + Benefit display name # noqa: E501 + + :param display_name: The display_name of this SuperannuationLine. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def amount(self): + """Gets the amount of this SuperannuationLine. # noqa: E501 + + The amount of the superannuation line # noqa: E501 + + :return: The amount of this SuperannuationLine. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this SuperannuationLine. + + The amount of the superannuation line # noqa: E501 + + :param amount: The amount of this SuperannuationLine. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def fixed_amount(self): + """Gets the fixed_amount of this SuperannuationLine. # noqa: E501 + + Superannuation fixed amount # noqa: E501 + + :return: The fixed_amount of this SuperannuationLine. # noqa: E501 + :rtype: float + """ + return self._fixed_amount + + @fixed_amount.setter + def fixed_amount(self, fixed_amount): + """Sets the fixed_amount of this SuperannuationLine. + + Superannuation fixed amount # noqa: E501 + + :param fixed_amount: The fixed_amount of this SuperannuationLine. # noqa: E501 + :type: float + """ + + self._fixed_amount = fixed_amount + + @property + def percentage(self): + """Gets the percentage of this SuperannuationLine. # noqa: E501 + + Superannuation rate percentage # noqa: E501 + + :return: The percentage of this SuperannuationLine. # noqa: E501 + :rtype: float + """ + return self._percentage + + @percentage.setter + def percentage(self, percentage): + """Sets the percentage of this SuperannuationLine. + + Superannuation rate percentage # noqa: E501 + + :param percentage: The percentage of this SuperannuationLine. # noqa: E501 + :type: float + """ + + self._percentage = percentage + + @property + def manual_adjustment(self): + """Gets the manual_adjustment of this SuperannuationLine. # noqa: E501 + + manual adjustment made # noqa: E501 + + :return: The manual_adjustment of this SuperannuationLine. # noqa: E501 + :rtype: bool + """ + return self._manual_adjustment + + @manual_adjustment.setter + def manual_adjustment(self, manual_adjustment): + """Sets the manual_adjustment of this SuperannuationLine. + + manual adjustment made # noqa: E501 + + :param manual_adjustment: The manual_adjustment of this SuperannuationLine. # noqa: E501 + :type: bool + """ + + self._manual_adjustment = manual_adjustment diff --git a/xero_python/payrollnz/models/superannuation_object.py b/xero_python/payrollnz/models/superannuation_object.py new file mode 100644 index 00000000..0f011a12 --- /dev/null +++ b/xero_python/payrollnz/models/superannuation_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SuperannuationObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "benefit": "Benefit", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "benefit": "benefit", + } + + def __init__(self, pagination=None, problem=None, benefit=None): # noqa: E501 + """SuperannuationObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._benefit = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if benefit is not None: + self.benefit = benefit + + @property + def pagination(self): + """Gets the pagination of this SuperannuationObject. # noqa: E501 + + + :return: The pagination of this SuperannuationObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this SuperannuationObject. + + + :param pagination: The pagination of this SuperannuationObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this SuperannuationObject. # noqa: E501 + + + :return: The problem of this SuperannuationObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this SuperannuationObject. + + + :param problem: The problem of this SuperannuationObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def benefit(self): + """Gets the benefit of this SuperannuationObject. # noqa: E501 + + + :return: The benefit of this SuperannuationObject. # noqa: E501 + :rtype: Benefit + """ + return self._benefit + + @benefit.setter + def benefit(self, benefit): + """Sets the benefit of this SuperannuationObject. + + + :param benefit: The benefit of this SuperannuationObject. # noqa: E501 + :type: Benefit + """ + + self._benefit = benefit diff --git a/xero_python/payrollnz/models/superannuations.py b/xero_python/payrollnz/models/superannuations.py new file mode 100644 index 00000000..68ed60f2 --- /dev/null +++ b/xero_python/payrollnz/models/superannuations.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Superannuations(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "benefits": "list[Benefit]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "benefits": "benefits", + } + + def __init__(self, pagination=None, problem=None, benefits=None): # noqa: E501 + """Superannuations - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._benefits = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if benefits is not None: + self.benefits = benefits + + @property + def pagination(self): + """Gets the pagination of this Superannuations. # noqa: E501 + + + :return: The pagination of this Superannuations. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this Superannuations. + + + :param pagination: The pagination of this Superannuations. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this Superannuations. # noqa: E501 + + + :return: The problem of this Superannuations. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this Superannuations. + + + :param problem: The problem of this Superannuations. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def benefits(self): + """Gets the benefits of this Superannuations. # noqa: E501 + + + :return: The benefits of this Superannuations. # noqa: E501 + :rtype: list[Benefit] + """ + return self._benefits + + @benefits.setter + def benefits(self, benefits): + """Sets the benefits of this Superannuations. + + + :param benefits: The benefits of this Superannuations. # noqa: E501 + :type: list[Benefit] + """ + + self._benefits = benefits diff --git a/xero_python/payrollnz/models/tax_code.py b/xero_python/payrollnz/models/tax_code.py new file mode 100644 index 00000000..5473f895 --- /dev/null +++ b/xero_python/payrollnz/models/tax_code.py @@ -0,0 +1,46 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class TaxCode(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + ND = "ND" + M = "M" + ME = "ME" + MSL = "MSL" + MESL = "MESL" + SB = "SB" + S = "S" + SH = "SH" + ST = "ST" + SBSL = "SBSL" + SSL = "SSL" + SHSL = "SHSL" + STSL = "STSL" + WT = "WT" + CAE = "CAE" + EDW = "EDW" + NSW = "NSW" + STC = "STC" + STCSL = "STCSL" diff --git a/xero_python/payrollnz/models/tax_line.py b/xero_python/payrollnz/models/tax_line.py new file mode 100644 index 00000000..646f2a93 --- /dev/null +++ b/xero_python/payrollnz/models/tax_line.py @@ -0,0 +1,190 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TaxLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "tax_line_id": "str", + "description": "str", + "amount": "float", + "global_tax_type_id": "str", + "manual_adjustment": "bool", + } + + attribute_map = { + "tax_line_id": "taxLineID", + "description": "description", + "amount": "amount", + "global_tax_type_id": "globalTaxTypeID", + "manual_adjustment": "manualAdjustment", + } + + def __init__( + self, + tax_line_id=None, + description=None, + amount=None, + global_tax_type_id=None, + manual_adjustment=None, + ): # noqa: E501 + """TaxLine - a model defined in OpenAPI""" # noqa: E501 + + self._tax_line_id = None + self._description = None + self._amount = None + self._global_tax_type_id = None + self._manual_adjustment = None + self.discriminator = None + + if tax_line_id is not None: + self.tax_line_id = tax_line_id + if description is not None: + self.description = description + if amount is not None: + self.amount = amount + if global_tax_type_id is not None: + self.global_tax_type_id = global_tax_type_id + if manual_adjustment is not None: + self.manual_adjustment = manual_adjustment + + @property + def tax_line_id(self): + """Gets the tax_line_id of this TaxLine. # noqa: E501 + + Xero identifier for payroll tax line # noqa: E501 + + :return: The tax_line_id of this TaxLine. # noqa: E501 + :rtype: str + """ + return self._tax_line_id + + @tax_line_id.setter + def tax_line_id(self, tax_line_id): + """Sets the tax_line_id of this TaxLine. + + Xero identifier for payroll tax line # noqa: E501 + + :param tax_line_id: The tax_line_id of this TaxLine. # noqa: E501 + :type: str + """ + + self._tax_line_id = tax_line_id + + @property + def description(self): + """Gets the description of this TaxLine. # noqa: E501 + + Tax line description # noqa: E501 + + :return: The description of this TaxLine. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this TaxLine. + + Tax line description # noqa: E501 + + :param description: The description of this TaxLine. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def amount(self): + """Gets the amount of this TaxLine. # noqa: E501 + + The amount of the tax line # noqa: E501 + + :return: The amount of this TaxLine. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this TaxLine. + + The amount of the tax line # noqa: E501 + + :param amount: The amount of this TaxLine. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def global_tax_type_id(self): + """Gets the global_tax_type_id of this TaxLine. # noqa: E501 + + Tax type ID # noqa: E501 + + :return: The global_tax_type_id of this TaxLine. # noqa: E501 + :rtype: str + """ + return self._global_tax_type_id + + @global_tax_type_id.setter + def global_tax_type_id(self, global_tax_type_id): + """Sets the global_tax_type_id of this TaxLine. + + Tax type ID # noqa: E501 + + :param global_tax_type_id: The global_tax_type_id of this TaxLine. # noqa: E501 + :type: str + """ + + self._global_tax_type_id = global_tax_type_id + + @property + def manual_adjustment(self): + """Gets the manual_adjustment of this TaxLine. # noqa: E501 + + Identifies if the tax line is a manual adjustment # noqa: E501 + + :return: The manual_adjustment of this TaxLine. # noqa: E501 + :rtype: bool + """ + return self._manual_adjustment + + @manual_adjustment.setter + def manual_adjustment(self, manual_adjustment): + """Sets the manual_adjustment of this TaxLine. + + Identifies if the tax line is a manual adjustment # noqa: E501 + + :param manual_adjustment: The manual_adjustment of this TaxLine. # noqa: E501 + :type: bool + """ + + self._manual_adjustment = manual_adjustment diff --git a/xero_python/payrollnz/models/tax_settings.py b/xero_python/payrollnz/models/tax_settings.py new file mode 100644 index 00000000..ca4d1b70 --- /dev/null +++ b/xero_python/payrollnz/models/tax_settings.py @@ -0,0 +1,224 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TaxSettings(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "period_units": "int", + "period_type": "str", + "tax_code": "TaxCode", + "special_tax_rate": "str", + "lump_sum_tax_code": "str", + "lump_sum_amount": "str", + } + + attribute_map = { + "period_units": "periodUnits", + "period_type": "periodType", + "tax_code": "taxCode", + "special_tax_rate": "specialTaxRate", + "lump_sum_tax_code": "lumpSumTaxCode", + "lump_sum_amount": "lumpSumAmount", + } + + def __init__( + self, + period_units=None, + period_type=None, + tax_code=None, + special_tax_rate=None, + lump_sum_tax_code=None, + lump_sum_amount=None, + ): # noqa: E501 + """TaxSettings - a model defined in OpenAPI""" # noqa: E501 + + self._period_units = None + self._period_type = None + self._tax_code = None + self._special_tax_rate = None + self._lump_sum_tax_code = None + self._lump_sum_amount = None + self.discriminator = None + + if period_units is not None: + self.period_units = period_units + if period_type is not None: + self.period_type = period_type + if tax_code is not None: + self.tax_code = tax_code + if special_tax_rate is not None: + self.special_tax_rate = special_tax_rate + if lump_sum_tax_code is not None: + self.lump_sum_tax_code = lump_sum_tax_code + if lump_sum_amount is not None: + self.lump_sum_amount = lump_sum_amount + + @property + def period_units(self): + """Gets the period_units of this TaxSettings. # noqa: E501 + + The number of units for the period type # noqa: E501 + + :return: The period_units of this TaxSettings. # noqa: E501 + :rtype: int + """ + return self._period_units + + @period_units.setter + def period_units(self, period_units): + """Sets the period_units of this TaxSettings. + + The number of units for the period type # noqa: E501 + + :param period_units: The period_units of this TaxSettings. # noqa: E501 + :type: int + """ + + self._period_units = period_units + + @property + def period_type(self): + """Gets the period_type of this TaxSettings. # noqa: E501 + + The type of period (\"weeks\" or \"months\") # noqa: E501 + + :return: The period_type of this TaxSettings. # noqa: E501 + :rtype: str + """ + return self._period_type + + @period_type.setter + def period_type(self, period_type): + """Sets the period_type of this TaxSettings. + + The type of period (\"weeks\" or \"months\") # noqa: E501 + + :param period_type: The period_type of this TaxSettings. # noqa: E501 + :type: str + """ + allowed_values = ["weeks", "months", "None"] # noqa: E501 + if period_type not in allowed_values: + raise ValueError( + "Invalid value for `period_type` ({0}), must be one of {1}".format( # noqa: E501 + period_type, allowed_values + ) + ) + + self._period_type = period_type + + @property + def tax_code(self): + """Gets the tax_code of this TaxSettings. # noqa: E501 + + + :return: The tax_code of this TaxSettings. # noqa: E501 + :rtype: TaxCode + """ + return self._tax_code + + @tax_code.setter + def tax_code(self, tax_code): + """Sets the tax_code of this TaxSettings. + + + :param tax_code: The tax_code of this TaxSettings. # noqa: E501 + :type: TaxCode + """ + + self._tax_code = tax_code + + @property + def special_tax_rate(self): + """Gets the special_tax_rate of this TaxSettings. # noqa: E501 + + Tax rate for STC and WT # noqa: E501 + + :return: The special_tax_rate of this TaxSettings. # noqa: E501 + :rtype: str + """ + return self._special_tax_rate + + @special_tax_rate.setter + def special_tax_rate(self, special_tax_rate): + """Sets the special_tax_rate of this TaxSettings. + + Tax rate for STC and WT # noqa: E501 + + :param special_tax_rate: The special_tax_rate of this TaxSettings. # noqa: E501 + :type: str + """ + + self._special_tax_rate = special_tax_rate + + @property + def lump_sum_tax_code(self): + """Gets the lump_sum_tax_code of this TaxSettings. # noqa: E501 + + Tax code for a lump sum amount # noqa: E501 + + :return: The lump_sum_tax_code of this TaxSettings. # noqa: E501 + :rtype: str + """ + return self._lump_sum_tax_code + + @lump_sum_tax_code.setter + def lump_sum_tax_code(self, lump_sum_tax_code): + """Sets the lump_sum_tax_code of this TaxSettings. + + Tax code for a lump sum amount # noqa: E501 + + :param lump_sum_tax_code: The lump_sum_tax_code of this TaxSettings. # noqa: E501 + :type: str + """ + + self._lump_sum_tax_code = lump_sum_tax_code + + @property + def lump_sum_amount(self): + """Gets the lump_sum_amount of this TaxSettings. # noqa: E501 + + The total of the lump sum amount # noqa: E501 + + :return: The lump_sum_amount of this TaxSettings. # noqa: E501 + :rtype: str + """ + return self._lump_sum_amount + + @lump_sum_amount.setter + def lump_sum_amount(self, lump_sum_amount): + """Sets the lump_sum_amount of this TaxSettings. + + The total of the lump sum amount # noqa: E501 + + :param lump_sum_amount: The lump_sum_amount of this TaxSettings. # noqa: E501 + :type: str + """ + + self._lump_sum_amount = lump_sum_amount diff --git a/xero_python/payrollnz/models/timesheet.py b/xero_python/payrollnz/models/timesheet.py new file mode 100644 index 00000000..87390095 --- /dev/null +++ b/xero_python/payrollnz/models/timesheet.py @@ -0,0 +1,323 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Timesheet(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "timesheet_id": "str", + "payroll_calendar_id": "str", + "employee_id": "str", + "start_date": "date", + "end_date": "date", + "status": "str", + "total_hours": "float", + "updated_date_utc": "datetime", + "timesheet_lines": "list[TimesheetLine]", + } + + attribute_map = { + "timesheet_id": "timesheetID", + "payroll_calendar_id": "payrollCalendarID", + "employee_id": "employeeID", + "start_date": "startDate", + "end_date": "endDate", + "status": "status", + "total_hours": "totalHours", + "updated_date_utc": "updatedDateUTC", + "timesheet_lines": "timesheetLines", + } + + def __init__( + self, + timesheet_id=None, + payroll_calendar_id=None, + employee_id=None, + start_date=None, + end_date=None, + status=None, + total_hours=None, + updated_date_utc=None, + timesheet_lines=None, + ): # noqa: E501 + """Timesheet - a model defined in OpenAPI""" # noqa: E501 + + self._timesheet_id = None + self._payroll_calendar_id = None + self._employee_id = None + self._start_date = None + self._end_date = None + self._status = None + self._total_hours = None + self._updated_date_utc = None + self._timesheet_lines = None + self.discriminator = None + + if timesheet_id is not None: + self.timesheet_id = timesheet_id + self.payroll_calendar_id = payroll_calendar_id + self.employee_id = employee_id + self.start_date = start_date + self.end_date = end_date + if status is not None: + self.status = status + if total_hours is not None: + self.total_hours = total_hours + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + if timesheet_lines is not None: + self.timesheet_lines = timesheet_lines + + @property + def timesheet_id(self): + """Gets the timesheet_id of this Timesheet. # noqa: E501 + + The Xero identifier for a Timesheet # noqa: E501 + + :return: The timesheet_id of this Timesheet. # noqa: E501 + :rtype: str + """ + return self._timesheet_id + + @timesheet_id.setter + def timesheet_id(self, timesheet_id): + """Sets the timesheet_id of this Timesheet. + + The Xero identifier for a Timesheet # noqa: E501 + + :param timesheet_id: The timesheet_id of this Timesheet. # noqa: E501 + :type: str + """ + + self._timesheet_id = timesheet_id + + @property + def payroll_calendar_id(self): + """Gets the payroll_calendar_id of this Timesheet. # noqa: E501 + + The Xero identifier for the Payroll Calandar that the Timesheet applies to # noqa: E501 + + :return: The payroll_calendar_id of this Timesheet. # noqa: E501 + :rtype: str + """ + return self._payroll_calendar_id + + @payroll_calendar_id.setter + def payroll_calendar_id(self, payroll_calendar_id): + """Sets the payroll_calendar_id of this Timesheet. + + The Xero identifier for the Payroll Calandar that the Timesheet applies to # noqa: E501 + + :param payroll_calendar_id: The payroll_calendar_id of this Timesheet. # noqa: E501 + :type: str + """ + if payroll_calendar_id is None: + raise ValueError( + "Invalid value for `payroll_calendar_id`, must not be `None`" + ) # noqa: E501 + + self._payroll_calendar_id = payroll_calendar_id + + @property + def employee_id(self): + """Gets the employee_id of this Timesheet. # noqa: E501 + + The Xero identifier for the Employee that the Timesheet is for # noqa: E501 + + :return: The employee_id of this Timesheet. # noqa: E501 + :rtype: str + """ + return self._employee_id + + @employee_id.setter + def employee_id(self, employee_id): + """Sets the employee_id of this Timesheet. + + The Xero identifier for the Employee that the Timesheet is for # noqa: E501 + + :param employee_id: The employee_id of this Timesheet. # noqa: E501 + :type: str + """ + if employee_id is None: + raise ValueError( + "Invalid value for `employee_id`, must not be `None`" + ) # noqa: E501 + + self._employee_id = employee_id + + @property + def start_date(self): + """Gets the start_date of this Timesheet. # noqa: E501 + + The Start Date of the Timesheet period (YYYY-MM-DD) # noqa: E501 + + :return: The start_date of this Timesheet. # noqa: E501 + :rtype: date + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this Timesheet. + + The Start Date of the Timesheet period (YYYY-MM-DD) # noqa: E501 + + :param start_date: The start_date of this Timesheet. # noqa: E501 + :type: date + """ + if start_date is None: + raise ValueError( + "Invalid value for `start_date`, must not be `None`" + ) # noqa: E501 + + self._start_date = start_date + + @property + def end_date(self): + """Gets the end_date of this Timesheet. # noqa: E501 + + The End Date of the Timesheet period (YYYY-MM-DD) # noqa: E501 + + :return: The end_date of this Timesheet. # noqa: E501 + :rtype: date + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this Timesheet. + + The End Date of the Timesheet period (YYYY-MM-DD) # noqa: E501 + + :param end_date: The end_date of this Timesheet. # noqa: E501 + :type: date + """ + if end_date is None: + raise ValueError( + "Invalid value for `end_date`, must not be `None`" + ) # noqa: E501 + + self._end_date = end_date + + @property + def status(self): + """Gets the status of this Timesheet. # noqa: E501 + + Status of the timesheet # noqa: E501 + + :return: The status of this Timesheet. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this Timesheet. + + Status of the timesheet # noqa: E501 + + :param status: The status of this Timesheet. # noqa: E501 + :type: str + """ + allowed_values = ["Draft", "Approved", "Completed", "None"] # noqa: E501 + if status not in allowed_values: + raise ValueError( + "Invalid value for `status` ({0}), must be one of {1}".format( # noqa: E501 + status, allowed_values + ) + ) + + self._status = status + + @property + def total_hours(self): + """Gets the total_hours of this Timesheet. # noqa: E501 + + The Total Hours of the Timesheet # noqa: E501 + + :return: The total_hours of this Timesheet. # noqa: E501 + :rtype: float + """ + return self._total_hours + + @total_hours.setter + def total_hours(self, total_hours): + """Sets the total_hours of this Timesheet. + + The Total Hours of the Timesheet # noqa: E501 + + :param total_hours: The total_hours of this Timesheet. # noqa: E501 + :type: float + """ + + self._total_hours = total_hours + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this Timesheet. # noqa: E501 + + The UTC date time that the Timesheet was last updated # noqa: E501 + + :return: The updated_date_utc of this Timesheet. # noqa: E501 + :rtype: datetime + """ + return self._updated_date_utc + + @updated_date_utc.setter + def updated_date_utc(self, updated_date_utc): + """Sets the updated_date_utc of this Timesheet. + + The UTC date time that the Timesheet was last updated # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this Timesheet. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc + + @property + def timesheet_lines(self): + """Gets the timesheet_lines of this Timesheet. # noqa: E501 + + + :return: The timesheet_lines of this Timesheet. # noqa: E501 + :rtype: list[TimesheetLine] + """ + return self._timesheet_lines + + @timesheet_lines.setter + def timesheet_lines(self, timesheet_lines): + """Sets the timesheet_lines of this Timesheet. + + + :param timesheet_lines: The timesheet_lines of this Timesheet. # noqa: E501 + :type: list[TimesheetLine] + """ + + self._timesheet_lines = timesheet_lines diff --git a/xero_python/payrollnz/models/timesheet_earnings_line.py b/xero_python/payrollnz/models/timesheet_earnings_line.py new file mode 100644 index 00000000..71a42688 --- /dev/null +++ b/xero_python/payrollnz/models/timesheet_earnings_line.py @@ -0,0 +1,335 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TimesheetEarningsLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "earnings_line_id": "str", + "earnings_rate_id": "str", + "display_name": "str", + "rate_per_unit": "float", + "number_of_units": "float", + "fixed_amount": "float", + "amount": "float", + "is_linked_to_timesheet": "bool", + "is_average_daily_pay_rate": "bool", + "is_system_generated": "bool", + } + + attribute_map = { + "earnings_line_id": "earningsLineID", + "earnings_rate_id": "earningsRateID", + "display_name": "displayName", + "rate_per_unit": "ratePerUnit", + "number_of_units": "numberOfUnits", + "fixed_amount": "fixedAmount", + "amount": "amount", + "is_linked_to_timesheet": "isLinkedToTimesheet", + "is_average_daily_pay_rate": "isAverageDailyPayRate", + "is_system_generated": "isSystemGenerated", + } + + def __init__( + self, + earnings_line_id=None, + earnings_rate_id=None, + display_name=None, + rate_per_unit=None, + number_of_units=None, + fixed_amount=None, + amount=None, + is_linked_to_timesheet=None, + is_average_daily_pay_rate=None, + is_system_generated=None, + ): # noqa: E501 + """TimesheetEarningsLine - a model defined in OpenAPI""" # noqa: E501 + + self._earnings_line_id = None + self._earnings_rate_id = None + self._display_name = None + self._rate_per_unit = None + self._number_of_units = None + self._fixed_amount = None + self._amount = None + self._is_linked_to_timesheet = None + self._is_average_daily_pay_rate = None + self._is_system_generated = None + self.discriminator = None + + if earnings_line_id is not None: + self.earnings_line_id = earnings_line_id + if earnings_rate_id is not None: + self.earnings_rate_id = earnings_rate_id + if display_name is not None: + self.display_name = display_name + if rate_per_unit is not None: + self.rate_per_unit = rate_per_unit + if number_of_units is not None: + self.number_of_units = number_of_units + if fixed_amount is not None: + self.fixed_amount = fixed_amount + if amount is not None: + self.amount = amount + if is_linked_to_timesheet is not None: + self.is_linked_to_timesheet = is_linked_to_timesheet + if is_average_daily_pay_rate is not None: + self.is_average_daily_pay_rate = is_average_daily_pay_rate + if is_system_generated is not None: + self.is_system_generated = is_system_generated + + @property + def earnings_line_id(self): + """Gets the earnings_line_id of this TimesheetEarningsLine. # noqa: E501 + + Xero identifier for payroll earnings line # noqa: E501 + + :return: The earnings_line_id of this TimesheetEarningsLine. # noqa: E501 + :rtype: str + """ + return self._earnings_line_id + + @earnings_line_id.setter + def earnings_line_id(self, earnings_line_id): + """Sets the earnings_line_id of this TimesheetEarningsLine. + + Xero identifier for payroll earnings line # noqa: E501 + + :param earnings_line_id: The earnings_line_id of this TimesheetEarningsLine. # noqa: E501 + :type: str + """ + + self._earnings_line_id = earnings_line_id + + @property + def earnings_rate_id(self): + """Gets the earnings_rate_id of this TimesheetEarningsLine. # noqa: E501 + + Xero identifier for payroll leave earnings rate # noqa: E501 + + :return: The earnings_rate_id of this TimesheetEarningsLine. # noqa: E501 + :rtype: str + """ + return self._earnings_rate_id + + @earnings_rate_id.setter + def earnings_rate_id(self, earnings_rate_id): + """Sets the earnings_rate_id of this TimesheetEarningsLine. + + Xero identifier for payroll leave earnings rate # noqa: E501 + + :param earnings_rate_id: The earnings_rate_id of this TimesheetEarningsLine. # noqa: E501 + :type: str + """ + + self._earnings_rate_id = earnings_rate_id + + @property + def display_name(self): + """Gets the display_name of this TimesheetEarningsLine. # noqa: E501 + + name of earnings rate for display in UI # noqa: E501 + + :return: The display_name of this TimesheetEarningsLine. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this TimesheetEarningsLine. + + name of earnings rate for display in UI # noqa: E501 + + :param display_name: The display_name of this TimesheetEarningsLine. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def rate_per_unit(self): + """Gets the rate_per_unit of this TimesheetEarningsLine. # noqa: E501 + + Rate per unit for leave earnings line # noqa: E501 + + :return: The rate_per_unit of this TimesheetEarningsLine. # noqa: E501 + :rtype: float + """ + return self._rate_per_unit + + @rate_per_unit.setter + def rate_per_unit(self, rate_per_unit): + """Sets the rate_per_unit of this TimesheetEarningsLine. + + Rate per unit for leave earnings line # noqa: E501 + + :param rate_per_unit: The rate_per_unit of this TimesheetEarningsLine. # noqa: E501 + :type: float + """ + + self._rate_per_unit = rate_per_unit + + @property + def number_of_units(self): + """Gets the number_of_units of this TimesheetEarningsLine. # noqa: E501 + + Leave earnings number of units # noqa: E501 + + :return: The number_of_units of this TimesheetEarningsLine. # noqa: E501 + :rtype: float + """ + return self._number_of_units + + @number_of_units.setter + def number_of_units(self, number_of_units): + """Sets the number_of_units of this TimesheetEarningsLine. + + Leave earnings number of units # noqa: E501 + + :param number_of_units: The number_of_units of this TimesheetEarningsLine. # noqa: E501 + :type: float + """ + + self._number_of_units = number_of_units + + @property + def fixed_amount(self): + """Gets the fixed_amount of this TimesheetEarningsLine. # noqa: E501 + + Leave earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed # noqa: E501 + + :return: The fixed_amount of this TimesheetEarningsLine. # noqa: E501 + :rtype: float + """ + return self._fixed_amount + + @fixed_amount.setter + def fixed_amount(self, fixed_amount): + """Sets the fixed_amount of this TimesheetEarningsLine. + + Leave earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed # noqa: E501 + + :param fixed_amount: The fixed_amount of this TimesheetEarningsLine. # noqa: E501 + :type: float + """ + + self._fixed_amount = fixed_amount + + @property + def amount(self): + """Gets the amount of this TimesheetEarningsLine. # noqa: E501 + + The amount of the earnings line. # noqa: E501 + + :return: The amount of this TimesheetEarningsLine. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this TimesheetEarningsLine. + + The amount of the earnings line. # noqa: E501 + + :param amount: The amount of this TimesheetEarningsLine. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def is_linked_to_timesheet(self): + """Gets the is_linked_to_timesheet of this TimesheetEarningsLine. # noqa: E501 + + Identifies if the leave earnings is taken from the timesheet. False for leave earnings line # noqa: E501 + + :return: The is_linked_to_timesheet of this TimesheetEarningsLine. # noqa: E501 + :rtype: bool + """ + return self._is_linked_to_timesheet + + @is_linked_to_timesheet.setter + def is_linked_to_timesheet(self, is_linked_to_timesheet): + """Sets the is_linked_to_timesheet of this TimesheetEarningsLine. + + Identifies if the leave earnings is taken from the timesheet. False for leave earnings line # noqa: E501 + + :param is_linked_to_timesheet: The is_linked_to_timesheet of this TimesheetEarningsLine. # noqa: E501 + :type: bool + """ + + self._is_linked_to_timesheet = is_linked_to_timesheet + + @property + def is_average_daily_pay_rate(self): + """Gets the is_average_daily_pay_rate of this TimesheetEarningsLine. # noqa: E501 + + Identifies if the earnings is using an average daily pay rate # noqa: E501 + + :return: The is_average_daily_pay_rate of this TimesheetEarningsLine. # noqa: E501 + :rtype: bool + """ + return self._is_average_daily_pay_rate + + @is_average_daily_pay_rate.setter + def is_average_daily_pay_rate(self, is_average_daily_pay_rate): + """Sets the is_average_daily_pay_rate of this TimesheetEarningsLine. + + Identifies if the earnings is using an average daily pay rate # noqa: E501 + + :param is_average_daily_pay_rate: The is_average_daily_pay_rate of this TimesheetEarningsLine. # noqa: E501 + :type: bool + """ + + self._is_average_daily_pay_rate = is_average_daily_pay_rate + + @property + def is_system_generated(self): + """Gets the is_system_generated of this TimesheetEarningsLine. # noqa: E501 + + Flag to indentify whether the earnings line is system generated or not. # noqa: E501 + + :return: The is_system_generated of this TimesheetEarningsLine. # noqa: E501 + :rtype: bool + """ + return self._is_system_generated + + @is_system_generated.setter + def is_system_generated(self, is_system_generated): + """Sets the is_system_generated of this TimesheetEarningsLine. + + Flag to indentify whether the earnings line is system generated or not. # noqa: E501 + + :param is_system_generated: The is_system_generated of this TimesheetEarningsLine. # noqa: E501 + :type: bool + """ + + self._is_system_generated = is_system_generated diff --git a/xero_python/payrollnz/models/timesheet_line.py b/xero_python/payrollnz/models/timesheet_line.py new file mode 100644 index 00000000..fd16fce4 --- /dev/null +++ b/xero_python/payrollnz/models/timesheet_line.py @@ -0,0 +1,199 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TimesheetLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "timesheet_line_id": "str", + "date": "date", + "earnings_rate_id": "str", + "tracking_item_id": "str", + "number_of_units": "float", + } + + attribute_map = { + "timesheet_line_id": "timesheetLineID", + "date": "date", + "earnings_rate_id": "earningsRateID", + "tracking_item_id": "trackingItemID", + "number_of_units": "numberOfUnits", + } + + def __init__( + self, + timesheet_line_id=None, + date=None, + earnings_rate_id=None, + tracking_item_id=None, + number_of_units=None, + ): # noqa: E501 + """TimesheetLine - a model defined in OpenAPI""" # noqa: E501 + + self._timesheet_line_id = None + self._date = None + self._earnings_rate_id = None + self._tracking_item_id = None + self._number_of_units = None + self.discriminator = None + + if timesheet_line_id is not None: + self.timesheet_line_id = timesheet_line_id + self.date = date + self.earnings_rate_id = earnings_rate_id + if tracking_item_id is not None: + self.tracking_item_id = tracking_item_id + self.number_of_units = number_of_units + + @property + def timesheet_line_id(self): + """Gets the timesheet_line_id of this TimesheetLine. # noqa: E501 + + The Xero identifier for a Timesheet Line # noqa: E501 + + :return: The timesheet_line_id of this TimesheetLine. # noqa: E501 + :rtype: str + """ + return self._timesheet_line_id + + @timesheet_line_id.setter + def timesheet_line_id(self, timesheet_line_id): + """Sets the timesheet_line_id of this TimesheetLine. + + The Xero identifier for a Timesheet Line # noqa: E501 + + :param timesheet_line_id: The timesheet_line_id of this TimesheetLine. # noqa: E501 + :type: str + """ + + self._timesheet_line_id = timesheet_line_id + + @property + def date(self): + """Gets the date of this TimesheetLine. # noqa: E501 + + The Date that this Timesheet Line is for (YYYY-MM-DD) # noqa: E501 + + :return: The date of this TimesheetLine. # noqa: E501 + :rtype: date + """ + return self._date + + @date.setter + def date(self, date): + """Sets the date of this TimesheetLine. + + The Date that this Timesheet Line is for (YYYY-MM-DD) # noqa: E501 + + :param date: The date of this TimesheetLine. # noqa: E501 + :type: date + """ + if date is None: + raise ValueError( + "Invalid value for `date`, must not be `None`" + ) # noqa: E501 + + self._date = date + + @property + def earnings_rate_id(self): + """Gets the earnings_rate_id of this TimesheetLine. # noqa: E501 + + The Xero identifier for the Earnings Rate that the Timesheet is for # noqa: E501 + + :return: The earnings_rate_id of this TimesheetLine. # noqa: E501 + :rtype: str + """ + return self._earnings_rate_id + + @earnings_rate_id.setter + def earnings_rate_id(self, earnings_rate_id): + """Sets the earnings_rate_id of this TimesheetLine. + + The Xero identifier for the Earnings Rate that the Timesheet is for # noqa: E501 + + :param earnings_rate_id: The earnings_rate_id of this TimesheetLine. # noqa: E501 + :type: str + """ + if earnings_rate_id is None: + raise ValueError( + "Invalid value for `earnings_rate_id`, must not be `None`" + ) # noqa: E501 + + self._earnings_rate_id = earnings_rate_id + + @property + def tracking_item_id(self): + """Gets the tracking_item_id of this TimesheetLine. # noqa: E501 + + The Xero identifier for the Tracking Item that the Timesheet is for # noqa: E501 + + :return: The tracking_item_id of this TimesheetLine. # noqa: E501 + :rtype: str + """ + return self._tracking_item_id + + @tracking_item_id.setter + def tracking_item_id(self, tracking_item_id): + """Sets the tracking_item_id of this TimesheetLine. + + The Xero identifier for the Tracking Item that the Timesheet is for # noqa: E501 + + :param tracking_item_id: The tracking_item_id of this TimesheetLine. # noqa: E501 + :type: str + """ + + self._tracking_item_id = tracking_item_id + + @property + def number_of_units(self): + """Gets the number_of_units of this TimesheetLine. # noqa: E501 + + The Number of Units of the Timesheet Line # noqa: E501 + + :return: The number_of_units of this TimesheetLine. # noqa: E501 + :rtype: float + """ + return self._number_of_units + + @number_of_units.setter + def number_of_units(self, number_of_units): + """Sets the number_of_units of this TimesheetLine. + + The Number of Units of the Timesheet Line # noqa: E501 + + :param number_of_units: The number_of_units of this TimesheetLine. # noqa: E501 + :type: float + """ + if number_of_units is None: + raise ValueError( + "Invalid value for `number_of_units`, must not be `None`" + ) # noqa: E501 + + self._number_of_units = number_of_units diff --git a/xero_python/payrollnz/models/timesheet_line_object.py b/xero_python/payrollnz/models/timesheet_line_object.py new file mode 100644 index 00000000..616b0196 --- /dev/null +++ b/xero_python/payrollnz/models/timesheet_line_object.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TimesheetLineObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "timesheet_line": "TimesheetLine", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "timesheet_line": "timesheetLine", + } + + def __init__( + self, pagination=None, problem=None, timesheet_line=None + ): # noqa: E501 + """TimesheetLineObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._timesheet_line = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if timesheet_line is not None: + self.timesheet_line = timesheet_line + + @property + def pagination(self): + """Gets the pagination of this TimesheetLineObject. # noqa: E501 + + + :return: The pagination of this TimesheetLineObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this TimesheetLineObject. + + + :param pagination: The pagination of this TimesheetLineObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this TimesheetLineObject. # noqa: E501 + + + :return: The problem of this TimesheetLineObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this TimesheetLineObject. + + + :param problem: The problem of this TimesheetLineObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def timesheet_line(self): + """Gets the timesheet_line of this TimesheetLineObject. # noqa: E501 + + + :return: The timesheet_line of this TimesheetLineObject. # noqa: E501 + :rtype: TimesheetLine + """ + return self._timesheet_line + + @timesheet_line.setter + def timesheet_line(self, timesheet_line): + """Sets the timesheet_line of this TimesheetLineObject. + + + :param timesheet_line: The timesheet_line of this TimesheetLineObject. # noqa: E501 + :type: TimesheetLine + """ + + self._timesheet_line = timesheet_line diff --git a/xero_python/payrollnz/models/timesheet_object.py b/xero_python/payrollnz/models/timesheet_object.py new file mode 100644 index 00000000..3fd598a0 --- /dev/null +++ b/xero_python/payrollnz/models/timesheet_object.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TimesheetObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "timesheet": "Timesheet", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "timesheet": "timesheet", + } + + def __init__(self, pagination=None, problem=None, timesheet=None): # noqa: E501 + """TimesheetObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._timesheet = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if timesheet is not None: + self.timesheet = timesheet + + @property + def pagination(self): + """Gets the pagination of this TimesheetObject. # noqa: E501 + + + :return: The pagination of this TimesheetObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this TimesheetObject. + + + :param pagination: The pagination of this TimesheetObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this TimesheetObject. # noqa: E501 + + + :return: The problem of this TimesheetObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this TimesheetObject. + + + :param problem: The problem of this TimesheetObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def timesheet(self): + """Gets the timesheet of this TimesheetObject. # noqa: E501 + + + :return: The timesheet of this TimesheetObject. # noqa: E501 + :rtype: Timesheet + """ + return self._timesheet + + @timesheet.setter + def timesheet(self, timesheet): + """Sets the timesheet of this TimesheetObject. + + + :param timesheet: The timesheet of this TimesheetObject. # noqa: E501 + :type: Timesheet + """ + + self._timesheet = timesheet diff --git a/xero_python/payrollnz/models/timesheets.py b/xero_python/payrollnz/models/timesheets.py new file mode 100644 index 00000000..2a100613 --- /dev/null +++ b/xero_python/payrollnz/models/timesheets.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Timesheets(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "timesheets": "list[Timesheet]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "timesheets": "timesheets", + } + + def __init__(self, pagination=None, problem=None, timesheets=None): # noqa: E501 + """Timesheets - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._timesheets = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if timesheets is not None: + self.timesheets = timesheets + + @property + def pagination(self): + """Gets the pagination of this Timesheets. # noqa: E501 + + + :return: The pagination of this Timesheets. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this Timesheets. + + + :param pagination: The pagination of this Timesheets. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this Timesheets. # noqa: E501 + + + :return: The problem of this Timesheets. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this Timesheets. + + + :param problem: The problem of this Timesheets. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def timesheets(self): + """Gets the timesheets of this Timesheets. # noqa: E501 + + + :return: The timesheets of this Timesheets. # noqa: E501 + :rtype: list[Timesheet] + """ + return self._timesheets + + @timesheets.setter + def timesheets(self, timesheets): + """Sets the timesheets of this Timesheets. + + + :param timesheets: The timesheets of this Timesheets. # noqa: E501 + :type: list[Timesheet] + """ + + self._timesheets = timesheets diff --git a/xero_python/payrollnz/models/tracking_categories.py b/xero_python/payrollnz/models/tracking_categories.py new file mode 100644 index 00000000..9a709b2b --- /dev/null +++ b/xero_python/payrollnz/models/tracking_categories.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TrackingCategories(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "tracking_categories": "TrackingCategory", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "tracking_categories": "trackingCategories", + } + + def __init__( + self, pagination=None, problem=None, tracking_categories=None + ): # noqa: E501 + """TrackingCategories - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._tracking_categories = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if tracking_categories is not None: + self.tracking_categories = tracking_categories + + @property + def pagination(self): + """Gets the pagination of this TrackingCategories. # noqa: E501 + + + :return: The pagination of this TrackingCategories. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this TrackingCategories. + + + :param pagination: The pagination of this TrackingCategories. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this TrackingCategories. # noqa: E501 + + + :return: The problem of this TrackingCategories. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this TrackingCategories. + + + :param problem: The problem of this TrackingCategories. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def tracking_categories(self): + """Gets the tracking_categories of this TrackingCategories. # noqa: E501 + + + :return: The tracking_categories of this TrackingCategories. # noqa: E501 + :rtype: TrackingCategory + """ + return self._tracking_categories + + @tracking_categories.setter + def tracking_categories(self, tracking_categories): + """Sets the tracking_categories of this TrackingCategories. + + + :param tracking_categories: The tracking_categories of this TrackingCategories. # noqa: E501 + :type: TrackingCategory + """ + + self._tracking_categories = tracking_categories diff --git a/xero_python/payrollnz/models/tracking_category.py b/xero_python/payrollnz/models/tracking_category.py new file mode 100644 index 00000000..bd6e3bfd --- /dev/null +++ b/xero_python/payrollnz/models/tracking_category.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + OpenAPI spec version: 2.4.4 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TrackingCategory(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "employee_groups_tracking_category_id": "str", + "timesheet_tracking_category_id": "str", + } + + attribute_map = { + "employee_groups_tracking_category_id": "employeeGroupsTrackingCategoryID", + "timesheet_tracking_category_id": "timesheetTrackingCategoryID", + } + + def __init__( + self, + employee_groups_tracking_category_id=None, + timesheet_tracking_category_id=None, + ): # noqa: E501 + """TrackingCategory - a model defined in OpenAPI""" # noqa: E501 + + self._employee_groups_tracking_category_id = None + self._timesheet_tracking_category_id = None + self.discriminator = None + + if employee_groups_tracking_category_id is not None: + self.employee_groups_tracking_category_id = ( + employee_groups_tracking_category_id + ) + if timesheet_tracking_category_id is not None: + self.timesheet_tracking_category_id = timesheet_tracking_category_id + + @property + def employee_groups_tracking_category_id(self): + """Gets the employee_groups_tracking_category_id of this TrackingCategory. # noqa: E501 + + The Xero identifier for Employee groups tracking category. # noqa: E501 + + :return: The employee_groups_tracking_category_id of this TrackingCategory. # noqa: E501 + :rtype: str + """ + return self._employee_groups_tracking_category_id + + @employee_groups_tracking_category_id.setter + def employee_groups_tracking_category_id( + self, employee_groups_tracking_category_id + ): + """Sets the employee_groups_tracking_category_id of this TrackingCategory. + + The Xero identifier for Employee groups tracking category. # noqa: E501 + + :param employee_groups_tracking_category_id: The employee_groups_tracking_category_id of this TrackingCategory. # noqa: E501 + :type: str + """ + + self._employee_groups_tracking_category_id = ( + employee_groups_tracking_category_id + ) + + @property + def timesheet_tracking_category_id(self): + """Gets the timesheet_tracking_category_id of this TrackingCategory. # noqa: E501 + + The Xero identifier for Timesheet tracking category. # noqa: E501 + + :return: The timesheet_tracking_category_id of this TrackingCategory. # noqa: E501 + :rtype: str + """ + return self._timesheet_tracking_category_id + + @timesheet_tracking_category_id.setter + def timesheet_tracking_category_id(self, timesheet_tracking_category_id): + """Sets the timesheet_tracking_category_id of this TrackingCategory. + + The Xero identifier for Timesheet tracking category. # noqa: E501 + + :param timesheet_tracking_category_id: The timesheet_tracking_category_id of this TrackingCategory. # noqa: E501 + :type: str + """ + + self._timesheet_tracking_category_id = timesheet_tracking_category_id diff --git a/xero_python/payrolluk/__init__.py b/xero_python/payrolluk/__init__.py index 97eafd61..2e63df91 100644 --- a/xero_python/payrolluk/__init__.py +++ b/xero_python/payrolluk/__init__.py @@ -7,7 +7,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/api/payroll_uk_api.py b/xero_python/payrolluk/api/payroll_uk_api.py index 8ebc162e..0c5d083e 100644 --- a/xero_python/payrolluk/api/payroll_uk_api.py +++ b/xero_python/payrolluk/api/payroll_uk_api.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/docs/Payslip.md b/xero_python/payrolluk/docs/Payslip.md index 6bde046f..4187aae0 100644 --- a/xero_python/payrolluk/docs/Payslip.md +++ b/xero_python/payrolluk/docs/Payslip.md @@ -29,6 +29,7 @@ Name | Type | Description | Notes **benefit_lines** | [**list[BenefitLine]**](BenefitLine.md) | | [optional] **payment_lines** | [**list[PaymentLine]**](PaymentLine.md) | | [optional] **employee_tax_lines** | [**list[TaxLine]**](TaxLine.md) | | [optional] +**employer_tax_lines** | [**list[TaxLine]**](TaxLine.md) | | [optional] **court_order_lines** | [**list[CourtOrderLine]**](CourtOrderLine.md) | | [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) diff --git a/xero_python/payrolluk/models/__init__.py b/xero_python/payrolluk/models/__init__.py index 8bb43080..9820b00a 100644 --- a/xero_python/payrolluk/models/__init__.py +++ b/xero_python/payrolluk/models/__init__.py @@ -6,7 +6,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/account.py b/xero_python/payrolluk/models/account.py index e754c20c..32a46a2e 100644 --- a/xero_python/payrolluk/models/account.py +++ b/xero_python/payrolluk/models/account.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/accounts.py b/xero_python/payrolluk/models/accounts.py index 1539d2aa..e2b5a788 100644 --- a/xero_python/payrolluk/models/accounts.py +++ b/xero_python/payrolluk/models/accounts.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/address.py b/xero_python/payrolluk/models/address.py index 29bada53..201c31c2 100644 --- a/xero_python/payrolluk/models/address.py +++ b/xero_python/payrolluk/models/address.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/bank_account.py b/xero_python/payrolluk/models/bank_account.py index 9ae59eac..fba10c74 100644 --- a/xero_python/payrolluk/models/bank_account.py +++ b/xero_python/payrolluk/models/bank_account.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/benefit.py b/xero_python/payrolluk/models/benefit.py index b96f6721..36da9845 100644 --- a/xero_python/payrolluk/models/benefit.py +++ b/xero_python/payrolluk/models/benefit.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/benefit_line.py b/xero_python/payrolluk/models/benefit_line.py index 2f389ba7..73b923d8 100644 --- a/xero_python/payrolluk/models/benefit_line.py +++ b/xero_python/payrolluk/models/benefit_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/benefit_object.py b/xero_python/payrolluk/models/benefit_object.py index 3faf1c23..4f3a9bf3 100644 --- a/xero_python/payrolluk/models/benefit_object.py +++ b/xero_python/payrolluk/models/benefit_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/benefits.py b/xero_python/payrolluk/models/benefits.py index 639f2d1a..e967518c 100644 --- a/xero_python/payrolluk/models/benefits.py +++ b/xero_python/payrolluk/models/benefits.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/court_order_line.py b/xero_python/payrolluk/models/court_order_line.py index a85ea4d8..d17f618b 100644 --- a/xero_python/payrolluk/models/court_order_line.py +++ b/xero_python/payrolluk/models/court_order_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/deduction.py b/xero_python/payrolluk/models/deduction.py index 7452e848..9c683fc1 100644 --- a/xero_python/payrolluk/models/deduction.py +++ b/xero_python/payrolluk/models/deduction.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/deduction_line.py b/xero_python/payrolluk/models/deduction_line.py index e7e24231..a5b09df6 100644 --- a/xero_python/payrolluk/models/deduction_line.py +++ b/xero_python/payrolluk/models/deduction_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/deduction_object.py b/xero_python/payrolluk/models/deduction_object.py index 1b4f08c4..b124a714 100644 --- a/xero_python/payrolluk/models/deduction_object.py +++ b/xero_python/payrolluk/models/deduction_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/deductions.py b/xero_python/payrolluk/models/deductions.py index 16c0863e..d4451d0f 100644 --- a/xero_python/payrolluk/models/deductions.py +++ b/xero_python/payrolluk/models/deductions.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_line.py b/xero_python/payrolluk/models/earnings_line.py index 900bc452..01de81c2 100644 --- a/xero_python/payrolluk/models/earnings_line.py +++ b/xero_python/payrolluk/models/earnings_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_order.py b/xero_python/payrolluk/models/earnings_order.py index 65a2ee08..69da6877 100644 --- a/xero_python/payrolluk/models/earnings_order.py +++ b/xero_python/payrolluk/models/earnings_order.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_order_object.py b/xero_python/payrolluk/models/earnings_order_object.py index fd1fad3f..d0cc2657 100644 --- a/xero_python/payrolluk/models/earnings_order_object.py +++ b/xero_python/payrolluk/models/earnings_order_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_orders.py b/xero_python/payrolluk/models/earnings_orders.py index 556f9067..44327184 100644 --- a/xero_python/payrolluk/models/earnings_orders.py +++ b/xero_python/payrolluk/models/earnings_orders.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_rate.py b/xero_python/payrolluk/models/earnings_rate.py index e0e01ee2..96f7ff6b 100644 --- a/xero_python/payrolluk/models/earnings_rate.py +++ b/xero_python/payrolluk/models/earnings_rate.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_rate_object.py b/xero_python/payrolluk/models/earnings_rate_object.py index d5d3975f..a002f38f 100644 --- a/xero_python/payrolluk/models/earnings_rate_object.py +++ b/xero_python/payrolluk/models/earnings_rate_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_rates.py b/xero_python/payrolluk/models/earnings_rates.py index 88e4826c..ea78a0e0 100644 --- a/xero_python/payrolluk/models/earnings_rates.py +++ b/xero_python/payrolluk/models/earnings_rates.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_template.py b/xero_python/payrolluk/models/earnings_template.py index b9e7449e..51a97212 100644 --- a/xero_python/payrolluk/models/earnings_template.py +++ b/xero_python/payrolluk/models/earnings_template.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/earnings_template_object.py b/xero_python/payrolluk/models/earnings_template_object.py index d6a12296..d42ba21c 100644 --- a/xero_python/payrolluk/models/earnings_template_object.py +++ b/xero_python/payrolluk/models/earnings_template_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee.py b/xero_python/payrolluk/models/employee.py index 95f22468..a2cc3631 100644 --- a/xero_python/payrolluk/models/employee.py +++ b/xero_python/payrolluk/models/employee.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_leave.py b/xero_python/payrolluk/models/employee_leave.py index 475ba21a..1c081bec 100644 --- a/xero_python/payrolluk/models/employee_leave.py +++ b/xero_python/payrolluk/models/employee_leave.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_leave_balance.py b/xero_python/payrolluk/models/employee_leave_balance.py index 6b481d7e..b387bcfb 100644 --- a/xero_python/payrolluk/models/employee_leave_balance.py +++ b/xero_python/payrolluk/models/employee_leave_balance.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_leave_balances.py b/xero_python/payrolluk/models/employee_leave_balances.py index 1c11fa58..cbfe7144 100644 --- a/xero_python/payrolluk/models/employee_leave_balances.py +++ b/xero_python/payrolluk/models/employee_leave_balances.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_leave_object.py b/xero_python/payrolluk/models/employee_leave_object.py index 447bbd3f..16a2291f 100644 --- a/xero_python/payrolluk/models/employee_leave_object.py +++ b/xero_python/payrolluk/models/employee_leave_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_leave_type.py b/xero_python/payrolluk/models/employee_leave_type.py index e9232b97..ef3641ce 100644 --- a/xero_python/payrolluk/models/employee_leave_type.py +++ b/xero_python/payrolluk/models/employee_leave_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_leave_type_object.py b/xero_python/payrolluk/models/employee_leave_type_object.py index 45d56fc5..d11d0ada 100644 --- a/xero_python/payrolluk/models/employee_leave_type_object.py +++ b/xero_python/payrolluk/models/employee_leave_type_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_leave_types.py b/xero_python/payrolluk/models/employee_leave_types.py index de9e37cf..0424f790 100644 --- a/xero_python/payrolluk/models/employee_leave_types.py +++ b/xero_python/payrolluk/models/employee_leave_types.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_leaves.py b/xero_python/payrolluk/models/employee_leaves.py index 8b63dea5..9a9b7a3b 100644 --- a/xero_python/payrolluk/models/employee_leaves.py +++ b/xero_python/payrolluk/models/employee_leaves.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_object.py b/xero_python/payrolluk/models/employee_object.py index 21ea1c4a..b4fe29b5 100644 --- a/xero_python/payrolluk/models/employee_object.py +++ b/xero_python/payrolluk/models/employee_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_opening_balances.py b/xero_python/payrolluk/models/employee_opening_balances.py index 63322c5f..bb16769b 100644 --- a/xero_python/payrolluk/models/employee_opening_balances.py +++ b/xero_python/payrolluk/models/employee_opening_balances.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_opening_balances_object.py b/xero_python/payrolluk/models/employee_opening_balances_object.py index 14c3f743..76719e0a 100644 --- a/xero_python/payrolluk/models/employee_opening_balances_object.py +++ b/xero_python/payrolluk/models/employee_opening_balances_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_pay_template.py b/xero_python/payrolluk/models/employee_pay_template.py index 8e587f53..487ee2ed 100644 --- a/xero_python/payrolluk/models/employee_pay_template.py +++ b/xero_python/payrolluk/models/employee_pay_template.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_pay_template_object.py b/xero_python/payrolluk/models/employee_pay_template_object.py index 59bad571..93ec1156 100644 --- a/xero_python/payrolluk/models/employee_pay_template_object.py +++ b/xero_python/payrolluk/models/employee_pay_template_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_pay_templates.py b/xero_python/payrolluk/models/employee_pay_templates.py index d7e95e5b..cd82da7d 100644 --- a/xero_python/payrolluk/models/employee_pay_templates.py +++ b/xero_python/payrolluk/models/employee_pay_templates.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_statutory_leave_balance.py b/xero_python/payrolluk/models/employee_statutory_leave_balance.py index eb5f95e2..d09a0280 100644 --- a/xero_python/payrolluk/models/employee_statutory_leave_balance.py +++ b/xero_python/payrolluk/models/employee_statutory_leave_balance.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_statutory_leave_balance_object.py b/xero_python/payrolluk/models/employee_statutory_leave_balance_object.py index 2b96d062..603eec7d 100644 --- a/xero_python/payrolluk/models/employee_statutory_leave_balance_object.py +++ b/xero_python/payrolluk/models/employee_statutory_leave_balance_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_statutory_leave_summary.py b/xero_python/payrolluk/models/employee_statutory_leave_summary.py index 91cef5b1..08c0c8ab 100644 --- a/xero_python/payrolluk/models/employee_statutory_leave_summary.py +++ b/xero_python/payrolluk/models/employee_statutory_leave_summary.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_statutory_leaves_summaries.py b/xero_python/payrolluk/models/employee_statutory_leaves_summaries.py index 5c2fccc3..56d4b071 100644 --- a/xero_python/payrolluk/models/employee_statutory_leaves_summaries.py +++ b/xero_python/payrolluk/models/employee_statutory_leaves_summaries.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_statutory_sick_leave.py b/xero_python/payrolluk/models/employee_statutory_sick_leave.py index 5128fc9c..0517c13e 100644 --- a/xero_python/payrolluk/models/employee_statutory_sick_leave.py +++ b/xero_python/payrolluk/models/employee_statutory_sick_leave.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_statutory_sick_leave_object.py b/xero_python/payrolluk/models/employee_statutory_sick_leave_object.py index 11e106ed..78811fe8 100644 --- a/xero_python/payrolluk/models/employee_statutory_sick_leave_object.py +++ b/xero_python/payrolluk/models/employee_statutory_sick_leave_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_statutory_sick_leaves.py b/xero_python/payrolluk/models/employee_statutory_sick_leaves.py index ac670d7b..fd42d247 100644 --- a/xero_python/payrolluk/models/employee_statutory_sick_leaves.py +++ b/xero_python/payrolluk/models/employee_statutory_sick_leaves.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_tax.py b/xero_python/payrolluk/models/employee_tax.py index 31df04c5..3fdeb494 100644 --- a/xero_python/payrolluk/models/employee_tax.py +++ b/xero_python/payrolluk/models/employee_tax.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employee_tax_object.py b/xero_python/payrolluk/models/employee_tax_object.py index 91ee3514..2529de02 100644 --- a/xero_python/payrolluk/models/employee_tax_object.py +++ b/xero_python/payrolluk/models/employee_tax_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employees.py b/xero_python/payrolluk/models/employees.py index a9c192f0..39b65281 100644 --- a/xero_python/payrolluk/models/employees.py +++ b/xero_python/payrolluk/models/employees.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employment.py b/xero_python/payrolluk/models/employment.py index aeaaff8b..456dec43 100644 --- a/xero_python/payrolluk/models/employment.py +++ b/xero_python/payrolluk/models/employment.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/employment_object.py b/xero_python/payrolluk/models/employment_object.py index 7105a202..cf2f0933 100644 --- a/xero_python/payrolluk/models/employment_object.py +++ b/xero_python/payrolluk/models/employment_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/invalid_field.py b/xero_python/payrolluk/models/invalid_field.py index 9132eb54..ad80d0a0 100644 --- a/xero_python/payrolluk/models/invalid_field.py +++ b/xero_python/payrolluk/models/invalid_field.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/leave_accrual_line.py b/xero_python/payrolluk/models/leave_accrual_line.py index 662698b4..e140122a 100644 --- a/xero_python/payrolluk/models/leave_accrual_line.py +++ b/xero_python/payrolluk/models/leave_accrual_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/leave_earnings_line.py b/xero_python/payrolluk/models/leave_earnings_line.py index dba2ff0f..4fcc1866 100644 --- a/xero_python/payrolluk/models/leave_earnings_line.py +++ b/xero_python/payrolluk/models/leave_earnings_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/leave_period.py b/xero_python/payrolluk/models/leave_period.py index 6ae0672d..6320c62a 100644 --- a/xero_python/payrolluk/models/leave_period.py +++ b/xero_python/payrolluk/models/leave_period.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/leave_periods.py b/xero_python/payrolluk/models/leave_periods.py index 1a09fecb..dfb0def2 100644 --- a/xero_python/payrolluk/models/leave_periods.py +++ b/xero_python/payrolluk/models/leave_periods.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/leave_type.py b/xero_python/payrolluk/models/leave_type.py index 505ae703..88818aa7 100644 --- a/xero_python/payrolluk/models/leave_type.py +++ b/xero_python/payrolluk/models/leave_type.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/leave_type_object.py b/xero_python/payrolluk/models/leave_type_object.py index dd420633..48c448df 100644 --- a/xero_python/payrolluk/models/leave_type_object.py +++ b/xero_python/payrolluk/models/leave_type_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/leave_types.py b/xero_python/payrolluk/models/leave_types.py index 8d132b98..282fdb22 100644 --- a/xero_python/payrolluk/models/leave_types.py +++ b/xero_python/payrolluk/models/leave_types.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/pagination.py b/xero_python/payrolluk/models/pagination.py index 84aab4b5..3c485d76 100644 --- a/xero_python/payrolluk/models/pagination.py +++ b/xero_python/payrolluk/models/pagination.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/pay_run.py b/xero_python/payrolluk/models/pay_run.py index f5ea9cf4..2236e129 100644 --- a/xero_python/payrolluk/models/pay_run.py +++ b/xero_python/payrolluk/models/pay_run.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/pay_run_calendar.py b/xero_python/payrolluk/models/pay_run_calendar.py index 6a59f1a7..82e9f973 100644 --- a/xero_python/payrolluk/models/pay_run_calendar.py +++ b/xero_python/payrolluk/models/pay_run_calendar.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/pay_run_calendar_object.py b/xero_python/payrolluk/models/pay_run_calendar_object.py index b6a72524..32979ca3 100644 --- a/xero_python/payrolluk/models/pay_run_calendar_object.py +++ b/xero_python/payrolluk/models/pay_run_calendar_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/pay_run_calendars.py b/xero_python/payrolluk/models/pay_run_calendars.py index b57e34cb..4e6ac7df 100644 --- a/xero_python/payrolluk/models/pay_run_calendars.py +++ b/xero_python/payrolluk/models/pay_run_calendars.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/pay_run_object.py b/xero_python/payrolluk/models/pay_run_object.py index 25a4f1e0..21a21183 100644 --- a/xero_python/payrolluk/models/pay_run_object.py +++ b/xero_python/payrolluk/models/pay_run_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/pay_runs.py b/xero_python/payrolluk/models/pay_runs.py index 6dfa8767..d03cd6c0 100644 --- a/xero_python/payrolluk/models/pay_runs.py +++ b/xero_python/payrolluk/models/pay_runs.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/payment_line.py b/xero_python/payrolluk/models/payment_line.py index 4a1b32b6..9453e7dc 100644 --- a/xero_python/payrolluk/models/payment_line.py +++ b/xero_python/payrolluk/models/payment_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/payment_method.py b/xero_python/payrolluk/models/payment_method.py index fefe41ab..72f6c000 100644 --- a/xero_python/payrolluk/models/payment_method.py +++ b/xero_python/payrolluk/models/payment_method.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/payment_method_object.py b/xero_python/payrolluk/models/payment_method_object.py index d8cfcb1f..076979b7 100644 --- a/xero_python/payrolluk/models/payment_method_object.py +++ b/xero_python/payrolluk/models/payment_method_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/payslip.py b/xero_python/payrolluk/models/payslip.py index ae1b4c8c..3e7b950e 100644 --- a/xero_python/payrolluk/models/payslip.py +++ b/xero_python/payrolluk/models/payslip.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ @@ -57,6 +57,7 @@ class Payslip(BaseModel): "benefit_lines": "list[BenefitLine]", "payment_lines": "list[PaymentLine]", "employee_tax_lines": "list[TaxLine]", + "employer_tax_lines": "list[TaxLine]", "court_order_lines": "list[CourtOrderLine]", } @@ -87,6 +88,7 @@ class Payslip(BaseModel): "benefit_lines": "benefitLines", "payment_lines": "paymentLines", "employee_tax_lines": "employeeTaxLines", + "employer_tax_lines": "employerTaxLines", "court_order_lines": "courtOrderLines", } @@ -118,6 +120,7 @@ def __init__( benefit_lines=None, payment_lines=None, employee_tax_lines=None, + employer_tax_lines=None, court_order_lines=None, ): # noqa: E501 """Payslip - a model defined in OpenAPI""" # noqa: E501 @@ -148,6 +151,7 @@ def __init__( self._benefit_lines = None self._payment_lines = None self._employee_tax_lines = None + self._employer_tax_lines = None self._court_order_lines = None self.discriminator = None @@ -203,6 +207,8 @@ def __init__( self.payment_lines = payment_lines if employee_tax_lines is not None: self.employee_tax_lines = employee_tax_lines + if employer_tax_lines is not None: + self.employer_tax_lines = employer_tax_lines if court_order_lines is not None: self.court_order_lines = court_order_lines @@ -793,6 +799,27 @@ def employee_tax_lines(self, employee_tax_lines): self._employee_tax_lines = employee_tax_lines + @property + def employer_tax_lines(self): + """Gets the employer_tax_lines of this Payslip. # noqa: E501 + + + :return: The employer_tax_lines of this Payslip. # noqa: E501 + :rtype: list[TaxLine] + """ + return self._employer_tax_lines + + @employer_tax_lines.setter + def employer_tax_lines(self, employer_tax_lines): + """Sets the employer_tax_lines of this Payslip. + + + :param employer_tax_lines: The employer_tax_lines of this Payslip. # noqa: E501 + :type: list[TaxLine] + """ + + self._employer_tax_lines = employer_tax_lines + @property def court_order_lines(self): """Gets the court_order_lines of this Payslip. # noqa: E501 diff --git a/xero_python/payrolluk/models/payslip_object.py b/xero_python/payrolluk/models/payslip_object.py index dffcc742..f7f97ace 100644 --- a/xero_python/payrolluk/models/payslip_object.py +++ b/xero_python/payrolluk/models/payslip_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/payslips.py b/xero_python/payrolluk/models/payslips.py index 65c518a9..80c67d18 100644 --- a/xero_python/payrolluk/models/payslips.py +++ b/xero_python/payrolluk/models/payslips.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/problem.py b/xero_python/payrolluk/models/problem.py index 300aee3a..0b23f220 100644 --- a/xero_python/payrolluk/models/problem.py +++ b/xero_python/payrolluk/models/problem.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/reimbursement.py b/xero_python/payrolluk/models/reimbursement.py index 8b2e4f3e..de472084 100644 --- a/xero_python/payrolluk/models/reimbursement.py +++ b/xero_python/payrolluk/models/reimbursement.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/reimbursement_line.py b/xero_python/payrolluk/models/reimbursement_line.py index 09b0d4b3..787704a8 100644 --- a/xero_python/payrolluk/models/reimbursement_line.py +++ b/xero_python/payrolluk/models/reimbursement_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/reimbursement_object.py b/xero_python/payrolluk/models/reimbursement_object.py index 6e358764..1bf11735 100644 --- a/xero_python/payrolluk/models/reimbursement_object.py +++ b/xero_python/payrolluk/models/reimbursement_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/reimbursements.py b/xero_python/payrolluk/models/reimbursements.py index c3ffb43b..5cc5a06f 100644 --- a/xero_python/payrolluk/models/reimbursements.py +++ b/xero_python/payrolluk/models/reimbursements.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/salary_and_wage.py b/xero_python/payrolluk/models/salary_and_wage.py index cfb6ff84..bce5a6c6 100644 --- a/xero_python/payrolluk/models/salary_and_wage.py +++ b/xero_python/payrolluk/models/salary_and_wage.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/salary_and_wage_object.py b/xero_python/payrolluk/models/salary_and_wage_object.py index 3edb7bf0..ab2d6747 100644 --- a/xero_python/payrolluk/models/salary_and_wage_object.py +++ b/xero_python/payrolluk/models/salary_and_wage_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/salary_and_wages.py b/xero_python/payrolluk/models/salary_and_wages.py index c69676de..589c9cb0 100644 --- a/xero_python/payrolluk/models/salary_and_wages.py +++ b/xero_python/payrolluk/models/salary_and_wages.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/settings.py b/xero_python/payrolluk/models/settings.py index 2876870e..e3275cc7 100644 --- a/xero_python/payrolluk/models/settings.py +++ b/xero_python/payrolluk/models/settings.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/statutory_deduction.py b/xero_python/payrolluk/models/statutory_deduction.py index 7d08d74a..76716ccc 100644 --- a/xero_python/payrolluk/models/statutory_deduction.py +++ b/xero_python/payrolluk/models/statutory_deduction.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/statutory_deduction_category.py b/xero_python/payrolluk/models/statutory_deduction_category.py index bf62cbca..fdcbee28 100644 --- a/xero_python/payrolluk/models/statutory_deduction_category.py +++ b/xero_python/payrolluk/models/statutory_deduction_category.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/tax_line.py b/xero_python/payrolluk/models/tax_line.py index 80acb655..4f2c032b 100644 --- a/xero_python/payrolluk/models/tax_line.py +++ b/xero_python/payrolluk/models/tax_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/timesheet.py b/xero_python/payrolluk/models/timesheet.py index f5418b0c..ab22413a 100644 --- a/xero_python/payrolluk/models/timesheet.py +++ b/xero_python/payrolluk/models/timesheet.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/timesheet_earnings_line.py b/xero_python/payrolluk/models/timesheet_earnings_line.py index d3deff44..579e3324 100644 --- a/xero_python/payrolluk/models/timesheet_earnings_line.py +++ b/xero_python/payrolluk/models/timesheet_earnings_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/timesheet_line.py b/xero_python/payrolluk/models/timesheet_line.py index 522da190..76f582e5 100644 --- a/xero_python/payrolluk/models/timesheet_line.py +++ b/xero_python/payrolluk/models/timesheet_line.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/timesheet_line_object.py b/xero_python/payrolluk/models/timesheet_line_object.py index 4ea71772..a749ab5b 100644 --- a/xero_python/payrolluk/models/timesheet_line_object.py +++ b/xero_python/payrolluk/models/timesheet_line_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/timesheet_object.py b/xero_python/payrolluk/models/timesheet_object.py index e2cfb984..7c20bbf7 100644 --- a/xero_python/payrolluk/models/timesheet_object.py +++ b/xero_python/payrolluk/models/timesheet_object.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/timesheets.py b/xero_python/payrolluk/models/timesheets.py index 1e825c70..d567573d 100644 --- a/xero_python/payrolluk/models/timesheets.py +++ b/xero_python/payrolluk/models/timesheets.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/tracking_categories.py b/xero_python/payrolluk/models/tracking_categories.py index cc886bf9..47059f90 100644 --- a/xero_python/payrolluk/models/tracking_categories.py +++ b/xero_python/payrolluk/models/tracking_categories.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrolluk/models/tracking_category.py b/xero_python/payrolluk/models/tracking_category.py index 552fe193..19cd0fef 100644 --- a/xero_python/payrolluk/models/tracking_category.py +++ b/xero_python/payrolluk/models/tracking_category.py @@ -5,7 +5,7 @@ This is the Xero Payroll API for orgs in the UK region. # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/__init__.py b/xero_python/project/__init__.py index ac457de7..0dc896ec 100644 --- a/xero_python/project/__init__.py +++ b/xero_python/project/__init__.py @@ -7,7 +7,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/api/project_api.py b/xero_python/project/api/project_api.py index deab0ecb..7cb30225 100644 --- a/xero_python/project/api/project_api.py +++ b/xero_python/project/api/project_api.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ @@ -671,6 +671,7 @@ def get_tasks( page=empty, page_size=empty, task_ids=empty, + charge_type=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -683,6 +684,7 @@ def get_tasks( :param int page: Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. :param int page_size: Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. :param str task_ids: taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskId},{taskId} + :param ChargeType charge_type: :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -718,6 +720,9 @@ def get_tasks( if task_ids is not empty: query_params.append(("taskIds", task_ids)) + if charge_type is not empty: + query_params.append(("chargeType", charge_type)) + header_params = { "Xero-Tenant-Id": xero_tenant_id, } diff --git a/xero_python/project/docs/ProjectApi.md b/xero_python/project/docs/ProjectApi.md index c2a1cd99..336d4b64 100644 --- a/xero_python/project/docs/ProjectApi.md +++ b/xero_python/project/docs/ProjectApi.md @@ -488,7 +488,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_tasks** -> Tasks get_tasks(xero_tenant_id, project_id, page=page, page_size=page_size, task_ids=task_ids) +> Tasks get_tasks(xero_tenant_id, project_id, page=page, page_size=page_size, task_ids=task_ids, charge_type=charge_type) Allows you to retrieve a single project @@ -525,9 +525,10 @@ project_id = 'project_id_example' # str | You can specify an individual project page = 1 # int | Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. (optional) page_size = 10 # int | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. (optional) task_ids = 'task_ids_example' # str | taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskId},{taskId} (optional) +charge_type = xero_python.project.ChargeType() # ChargeType | (optional) try: # Allows you to retrieve a single project - api_response = api_instance.get_tasks(xero_tenant_id, project_id, page=page, page_size=page_size, task_ids=task_ids) + api_response = api_instance.get_tasks(xero_tenant_id, project_id, page=page, page_size=page_size, task_ids=task_ids, charge_type=charge_type) pprint(api_response) except ApiException as e: print("Exception when calling ProjectApi->get_tasks: %s\n" % e) @@ -542,6 +543,7 @@ Name | Type | Description | Notes **page** | **int**| Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional] **page_size** | **int**| Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. | [optional] **task_ids** | **str**| taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskId},{taskId} | [optional] + **charge_type** | [**ChargeType**](.md)| | [optional] ### Return type diff --git a/xero_python/project/models/__init__.py b/xero_python/project/models/__init__.py index b9495421..a542fab1 100644 --- a/xero_python/project/models/__init__.py +++ b/xero_python/project/models/__init__.py @@ -6,7 +6,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/amount.py b/xero_python/project/models/amount.py index d6b4214f..c2570f00 100644 --- a/xero_python/project/models/amount.py +++ b/xero_python/project/models/amount.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/charge_type.py b/xero_python/project/models/charge_type.py index 585076a9..56db827a 100644 --- a/xero_python/project/models/charge_type.py +++ b/xero_python/project/models/charge_type.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/currency_code.py b/xero_python/project/models/currency_code.py index 1f9c0990..7395251e 100644 --- a/xero_python/project/models/currency_code.py +++ b/xero_python/project/models/currency_code.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/error.py b/xero_python/project/models/error.py index ddfbc66e..59244ce1 100644 --- a/xero_python/project/models/error.py +++ b/xero_python/project/models/error.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/pagination.py b/xero_python/project/models/pagination.py index 87e0cc11..7c80faaa 100644 --- a/xero_python/project/models/pagination.py +++ b/xero_python/project/models/pagination.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/project.py b/xero_python/project/models/project.py index 2c26565a..105b3bb5 100644 --- a/xero_python/project/models/project.py +++ b/xero_python/project/models/project.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/project_create_or_update.py b/xero_python/project/models/project_create_or_update.py index dba989d6..35b34b90 100644 --- a/xero_python/project/models/project_create_or_update.py +++ b/xero_python/project/models/project_create_or_update.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/project_patch.py b/xero_python/project/models/project_patch.py index 00b05808..fbc481b6 100644 --- a/xero_python/project/models/project_patch.py +++ b/xero_python/project/models/project_patch.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/project_status.py b/xero_python/project/models/project_status.py index a13cdc66..bbd85e3d 100644 --- a/xero_python/project/models/project_status.py +++ b/xero_python/project/models/project_status.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/project_user.py b/xero_python/project/models/project_user.py index 79fba0ce..03ca4e58 100644 --- a/xero_python/project/models/project_user.py +++ b/xero_python/project/models/project_user.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/project_users.py b/xero_python/project/models/project_users.py index 2887c6b4..b9c4c5b6 100644 --- a/xero_python/project/models/project_users.py +++ b/xero_python/project/models/project_users.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/projects.py b/xero_python/project/models/projects.py index 82e5f024..dd2c4366 100644 --- a/xero_python/project/models/projects.py +++ b/xero_python/project/models/projects.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/task.py b/xero_python/project/models/task.py index 134f4bb3..3b2a9d04 100644 --- a/xero_python/project/models/task.py +++ b/xero_python/project/models/task.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/task_create_or_update.py b/xero_python/project/models/task_create_or_update.py index ff440a06..c8c1ac40 100644 --- a/xero_python/project/models/task_create_or_update.py +++ b/xero_python/project/models/task_create_or_update.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/tasks.py b/xero_python/project/models/tasks.py index bd3bd1ff..ca910da2 100644 --- a/xero_python/project/models/tasks.py +++ b/xero_python/project/models/tasks.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/time_entries.py b/xero_python/project/models/time_entries.py index 33b6a6c0..15654881 100644 --- a/xero_python/project/models/time_entries.py +++ b/xero_python/project/models/time_entries.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/time_entry.py b/xero_python/project/models/time_entry.py index bbcd6af9..8913f7e0 100644 --- a/xero_python/project/models/time_entry.py +++ b/xero_python/project/models/time_entry.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/time_entry_create_or_update.py b/xero_python/project/models/time_entry_create_or_update.py index 88490d7e..333878ef 100644 --- a/xero_python/project/models/time_entry_create_or_update.py +++ b/xero_python/project/models/time_entry_create_or_update.py @@ -5,7 +5,7 @@ This is the Xero Projects API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/rest.py b/xero_python/rest.py index 9102b498..47f8f8df 100644 --- a/xero_python/rest.py +++ b/xero_python/rest.py @@ -5,7 +5,7 @@ This specifing endpoints related to managing authentication tokens and identity for Xero API # noqa: E501 - OpenAPI spec version: 2.4.0 + OpenAPI spec version: 2.4.4 Contact: api@xero.com Generated by: https://openapi-generator.tech """