diff --git a/README.md b/README.md index 508caa7f..f5354f9a 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ Official python SDK for Xero API generated by OpenAPI spec for oAuth 2 * [Accounting API](https://developer.xero.com/documentation/api/api-overview) * [Assets API](https://developer.xero.com/documentation/assets-api/overview) * [Projects API](https://developer.xero.com/documentation/projects/overview-projects) + * [AU Payroll API](https://developer.xero.com/documentation/payroll-api/overview) * Error handling for ease of use. ## Starter Project diff --git a/setup.py b/setup.py index bbc70de5..c5b63fd1 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="0.4.1", + version="0.5.1", ) diff --git a/xero_python/__init__.py b/xero_python/__init__.py index 7a8b0b84..155f4ae1 100644 --- a/xero_python/__init__.py +++ b/xero_python/__init__.py @@ -2,4 +2,4 @@ __author__ = """Xero Developer API""" __email__ = "api@xero.com" -__version__ = "0.4.1" +__version__ = "0.5.1" diff --git a/xero_python/accounting/__init__.py b/xero_python/accounting/__init__.py index b08c11fe..be49d66d 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.2.6 + OpenAPI spec version: 2.2.7 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/api/accounting_api.py b/xero_python/accounting/api/accounting_api.py index b6717a3d..6a27145d 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.2.6 + OpenAPI spec version: 2.2.7 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/__init__.py b/xero_python/accounting/models/__init__.py index 8278bde2..b51f9340 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.2.6 + OpenAPI spec version: 2.2.7 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/account.py b/xero_python/accounting/models/account.py index a933e48e..26c08f9d 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.2.6 + OpenAPI spec version: 2.2.7 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 3b664f98..d953f0c1 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.2.6 + OpenAPI spec version: 2.2.7 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 aceeaf89..b71ccd59 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.2.6 + OpenAPI spec version: 2.2.7 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 7ae6ecee..288b640c 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.2.6 + OpenAPI spec version: 2.2.7 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 f5d7aeb0..ddb815bc 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.2.6 + OpenAPI spec version: 2.2.7 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 a19e6197..4b430d80 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.2.6 + OpenAPI spec version: 2.2.7 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 7f98e61b..8387879c 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.2.6 + OpenAPI spec version: 2.2.7 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 6a75be2d..8db41958 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.2.6 + OpenAPI spec version: 2.2.7 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 3947bd49..c24a2701 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.2.6 + OpenAPI spec version: 2.2.7 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 bfd8fc69..28df5364 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.2.6 + OpenAPI spec version: 2.2.7 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/balances.py b/xero_python/accounting/models/balances.py index f2e64e03..0d7848a7 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.2.6 + OpenAPI spec version: 2.2.7 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 16d5579c..a2f7bd42 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.2.6 + OpenAPI spec version: 2.2.7 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 6c5fa8a6..30235306 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.2.6 + OpenAPI spec version: 2.2.7 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 b26191d0..f9cba4c2 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.2.6 + OpenAPI spec version: 2.2.7 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 bc544ab4..88a9239a 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.2.6 + OpenAPI spec version: 2.2.7 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 2d1b6492..37e6e8fe 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.2.6 + OpenAPI spec version: 2.2.7 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 b4f71cec..5ee0f9b6 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.2.6 + OpenAPI spec version: 2.2.7 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 7d31a88a..bd0925ee 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.2.6 + OpenAPI spec version: 2.2.7 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 60dd8ece..992cbe16 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.2.6 + OpenAPI spec version: 2.2.7 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 ad38de7c..4ca38b54 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.2.6 + OpenAPI spec version: 2.2.7 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 c7f62d2e..9a04ffc8 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.2.6 + OpenAPI spec version: 2.2.7 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 3895fd60..7460236d 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.2.6 + OpenAPI spec version: 2.2.7 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 4f45315d..d75d3007 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.2.6 + OpenAPI spec version: 2.2.7 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 9838ac3f..314a57f4 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.2.6 + OpenAPI spec version: 2.2.7 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 a893b405..bec63e67 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.2.6 + OpenAPI spec version: 2.2.7 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 1c19c7db..05e272e4 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.2.6 + OpenAPI spec version: 2.2.7 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 79b447f8..fa5756eb 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.2.6 + OpenAPI spec version: 2.2.7 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 378ef702..eaefdfe7 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.2.6 + OpenAPI spec version: 2.2.7 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 56c30bb1..bfddbf7a 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.2.6 + OpenAPI spec version: 2.2.7 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/country_code.py b/xero_python/accounting/models/country_code.py index 22beef01..a87a4e35 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.2.6 + OpenAPI spec version: 2.2.7 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 32e584b1..f2574d27 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.2.6 + OpenAPI spec version: 2.2.7 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 8c317f75..a5f78ce9 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.2.6 + OpenAPI spec version: 2.2.7 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 fc1d2ee3..d55cf409 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.2.6 + OpenAPI spec version: 2.2.7 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 5f277b66..c302bb84 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.2.6 + OpenAPI spec version: 2.2.7 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 2e1d933d..362a668d 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.2.6 + OpenAPI spec version: 2.2.7 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 73d4e99f..fcaff5af 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.2.6 + OpenAPI spec version: 2.2.7 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 41592282..2535df1f 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.2.6 + OpenAPI spec version: 2.2.7 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 b4396367..e2e13ec3 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.2.6 + OpenAPI spec version: 2.2.7 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 c5cf775d..a3231b45 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.2.6 + OpenAPI spec version: 2.2.7 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 8826eed9..a3d0a330 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.2.6 + OpenAPI spec version: 2.2.7 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 b5f406df..f789f73d 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.2.6 + OpenAPI spec version: 2.2.7 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 d5ed46ca..d964c6f5 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.2.6 + OpenAPI spec version: 2.2.7 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 4ddfe36c..cc0c81fc 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.2.6 + OpenAPI spec version: 2.2.7 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 ae404f7e..2e8a0b30 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.2.6 + OpenAPI spec version: 2.2.7 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/invoice.py b/xero_python/accounting/models/invoice.py index df764b70..cd062c81 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.2.6 + OpenAPI spec version: 2.2.7 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 8ee85c50..0fbed22f 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.2.6 + OpenAPI spec version: 2.2.7 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 075be7f5..55011aeb 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.2.6 + OpenAPI spec version: 2.2.7 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 47b28368..e272c931 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.2.6 + OpenAPI spec version: 2.2.7 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 41b2e2a8..edbee69c 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.2.6 + OpenAPI spec version: 2.2.7 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 af282770..64f62ef7 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.2.6 + OpenAPI spec version: 2.2.7 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 2011e97f..1e18b580 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.2.6 + OpenAPI spec version: 2.2.7 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 d63ac832..97f2638d 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.2.6 + OpenAPI spec version: 2.2.7 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 6ebe84db..cc89e375 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.2.6 + OpenAPI spec version: 2.2.7 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 af2e572f..c455ea08 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.2.6 + OpenAPI spec version: 2.2.7 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 0e148c4c..903f97d2 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.2.6 + OpenAPI spec version: 2.2.7 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 32b61fb7..989c8bcc 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.2.6 + OpenAPI spec version: 2.2.7 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 0c9615fe..7e199898 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.2.6 + OpenAPI spec version: 2.2.7 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 b945546c..5082dcfd 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.2.6 + OpenAPI spec version: 2.2.7 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 3fd16547..d23557ef 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.2.6 + OpenAPI spec version: 2.2.7 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 cf5ec80d..b991c573 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.2.6 + OpenAPI spec version: 2.2.7 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 36d43f86..5563ab50 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.2.6 + OpenAPI spec version: 2.2.7 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 4ba11c35..478247e2 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.2.6 + OpenAPI spec version: 2.2.7 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 fdf1668f..e1502740 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.2.6 + OpenAPI spec version: 2.2.7 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 5e46d215..e8fd5fec 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.2.6 + OpenAPI spec version: 2.2.7 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 d7210567..5dcd18c6 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.2.6 + OpenAPI spec version: 2.2.7 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 45e7965c..d6591cfc 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.2.6 + OpenAPI spec version: 2.2.7 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 628fe74d..f27ae24d 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.2.6 + OpenAPI spec version: 2.2.7 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 8992d939..bbeb8e7a 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.2.6 + OpenAPI spec version: 2.2.7 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 109c754a..437800a2 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.2.6 + OpenAPI spec version: 2.2.7 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 5be904a5..4b630208 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.2.6 + OpenAPI spec version: 2.2.7 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 bfc49d67..ca2e7c5d 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.2.6 + OpenAPI spec version: 2.2.7 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 57282fcd..2577f5b8 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.2.6 + OpenAPI spec version: 2.2.7 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 cedbfa22..a3fa625e 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.2.6 + OpenAPI spec version: 2.2.7 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 e3d2de73..bc0ccda6 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.2.6 + OpenAPI spec version: 2.2.7 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 ce167d5b..9cb13f73 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.2.6 + OpenAPI spec version: 2.2.7 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 6572d4b4..578cafa0 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.2.6 + OpenAPI spec version: 2.2.7 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 5e6205e0..3b60d7b0 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.2.6 + OpenAPI spec version: 2.2.7 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 634d75cf..34ea1731 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.2.6 + OpenAPI spec version: 2.2.7 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 d6739739..b45d44df 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.2.6 + OpenAPI spec version: 2.2.7 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 0d5c219a..84641705 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.2.6 + OpenAPI spec version: 2.2.7 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 5dcd46ed..2c361279 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.2.6 + OpenAPI spec version: 2.2.7 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 ed8a7e70..f72bdd3a 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.2.6 + OpenAPI spec version: 2.2.7 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 418f4c62..e3579cae 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.2.6 + OpenAPI spec version: 2.2.7 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 09850acd..940ee7b9 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.2.6 + OpenAPI spec version: 2.2.7 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 e75013f5..22b3f95b 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.2.6 + OpenAPI spec version: 2.2.7 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 0032f98b..90ed9e1f 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.2.6 + OpenAPI spec version: 2.2.7 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 ae41dea1..c79f617b 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.2.6 + OpenAPI spec version: 2.2.7 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 fcd62f5d..616c04c7 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.2.6 + OpenAPI spec version: 2.2.7 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 c6f41ce2..c7548ff8 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.2.6 + OpenAPI spec version: 2.2.7 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 4f73cff8..89d0b37d 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.2.6 + OpenAPI spec version: 2.2.7 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 0f426b9b..d12680e3 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.2.6 + OpenAPI spec version: 2.2.7 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 9af0af95..2ff6b028 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.2.6 + OpenAPI spec version: 2.2.7 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 3a204a3e..3eb2f59f 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.2.6 + OpenAPI spec version: 2.2.7 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 2df4b47f..9b61013e 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.2.6 + OpenAPI spec version: 2.2.7 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 286eb563..41c5440d 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.2.6 + OpenAPI spec version: 2.2.7 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 fb0db2cc..b659372b 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.2.6 + OpenAPI spec version: 2.2.7 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 b4bb1868..b4370d4b 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.2.6 + OpenAPI spec version: 2.2.7 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 1bbd9d75..14482988 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.2.6 + OpenAPI spec version: 2.2.7 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 870ed0ad..5aa58a30 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.2.6 + OpenAPI spec version: 2.2.7 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 9e5af997..87b01cdd 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.2.6 + OpenAPI spec version: 2.2.7 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 eb0a53dc..abcce860 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.2.6 + OpenAPI spec version: 2.2.7 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/tax_component.py b/xero_python/accounting/models/tax_component.py index b2eff2fa..225b2dc4 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.2.6 + OpenAPI spec version: 2.2.7 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 67bbb8b7..1604181d 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.2.6 + OpenAPI spec version: 2.2.7 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 7be871e2..be6b38f3 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.2.6 + OpenAPI spec version: 2.2.7 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 9f630a3c..9991b852 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.2.6 + OpenAPI spec version: 2.2.7 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/accounting/models/ten_nintey_nine_contact.py b/xero_python/accounting/models/ten_nintey_nine_contact.py index 22bf9cd0..acc632a3 100644 --- a/xero_python/accounting/models/ten_nintey_nine_contact.py +++ b/xero_python/accounting/models/ten_nintey_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.2.6 + OpenAPI spec version: 2.2.7 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 2dab1f63..0615ffe4 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.2.6 + OpenAPI spec version: 2.2.7 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 615e1775..e9120647 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.2.6 + OpenAPI spec version: 2.2.7 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 7ae7461f..8683810b 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.2.6 + OpenAPI spec version: 2.2.7 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 446a9f77..c6cde942 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.2.6 + OpenAPI spec version: 2.2.7 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 7181caf9..3760292f 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.2.6 + OpenAPI spec version: 2.2.7 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 81b703ed..be59841d 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.2.6 + OpenAPI spec version: 2.2.7 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 84d4a7c7..1a6b99dc 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.2.6 + OpenAPI spec version: 2.2.7 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 630b693d..8f1ebbd3 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.2.6 + OpenAPI spec version: 2.2.7 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 9c227234..79073606 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.2.6 + OpenAPI spec version: 2.2.7 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 54358adc..d1a4390a 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.2.6 + OpenAPI spec version: 2.2.7 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 60a55fc1..c0d8f629 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.2.6 + OpenAPI spec version: 2.2.7 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 883776cf..7f250705 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.2.6 + OpenAPI spec version: 2.2.7 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 271e75c0..3750f09b 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.2.6 + OpenAPI spec version: 2.2.7 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 4cb9ada9..4ef883f6 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.2.6 + OpenAPI spec version: 2.2.7 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 0811aef0..d5213262 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.2.6 + OpenAPI spec version: 2.2.7 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 8fd7fa5a..d247f1b1 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.2.6 + OpenAPI spec version: 2.2.7 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 b6d68d41..7ab4e834 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.2.6 + OpenAPI spec version: 2.2.7 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 97933217..e2d24883 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.2.6 + OpenAPI spec version: 2.2.7 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 410d0211..4e557b1d 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.2.6 + OpenAPI spec version: 2.2.7 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 19e99b83..c57e5482 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.2.6 + OpenAPI spec version: 2.2.7 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 bf78b785..d6a04df4 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.2.6 + OpenAPI spec version: 2.2.7 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 dd2065d7..9e9e0b87 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.2.6 + OpenAPI spec version: 2.2.7 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 59b04ad7..7bf4034f 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.2.6 + OpenAPI spec version: 2.2.7 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 e969c223..9369dd19 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.2.6 -- Package version: 0.4.1 +- API version: 2.2.7 +- Package version: 0.5.1 - 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 0411f416..cfcf7aa1 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.2.6 + OpenAPI spec version: 2.2.7 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 a03362ce..65684f9c 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.2.6 + OpenAPI spec version: 2.2.7 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 094f0b2b..7e5f7542 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.2.6 + OpenAPI spec version: 2.2.7 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 82dcd2eb..f75a18ed 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.2.6 + OpenAPI spec version: 2.2.7 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 bb69a405..e6a85c07 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.2.6 + OpenAPI spec version: 2.2.7 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 1ecc4e30..3e5ce0d4 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.2.6 + OpenAPI spec version: 2.2.7 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/payrollau/__init__.py b/xero_python/payrollau/__init__.py new file mode 100644 index 00000000..ad21d163 --- /dev/null +++ b/xero_python/payrollau/__init__.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +# flake8: noqa + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +# import apis into sdk package +from xero_python.payrollau.api.payroll_au_api import PayrollAuApi + + +# import models into sdk package +from xero_python.payrollau.models.api_exception import APIException +from xero_python.payrollau.models.account import Account +from xero_python.payrollau.models.account_type import AccountType +from xero_python.payrollau.models.allowance_type import AllowanceType +from xero_python.payrollau.models.bank_account import BankAccount +from xero_python.payrollau.models.calendar_type import CalendarType +from xero_python.payrollau.models.deduction_line import DeductionLine +from xero_python.payrollau.models.deduction_type import DeductionType +from xero_python.payrollau.models.deduction_type_calculation_type import ( + DeductionTypeCalculationType, +) +from xero_python.payrollau.models.earnings_line import EarningsLine +from xero_python.payrollau.models.earnings_rate import EarningsRate +from xero_python.payrollau.models.earnings_rate_calculation_type import ( + EarningsRateCalculationType, +) +from xero_python.payrollau.models.earnings_type import EarningsType +from xero_python.payrollau.models.employee import Employee +from xero_python.payrollau.models.employee_status import EmployeeStatus +from xero_python.payrollau.models.employees import Employees +from xero_python.payrollau.models.employment_basis import EmploymentBasis +from xero_python.payrollau.models.employment_termination_payment_type import ( + EmploymentTerminationPaymentType, +) +from xero_python.payrollau.models.entitlement_final_pay_payout_type import ( + EntitlementFinalPayPayoutType, +) +from xero_python.payrollau.models.home_address import HomeAddress +from xero_python.payrollau.models.leave_accrual_line import LeaveAccrualLine +from xero_python.payrollau.models.leave_application import LeaveApplication +from xero_python.payrollau.models.leave_applications import LeaveApplications +from xero_python.payrollau.models.leave_balance import LeaveBalance +from xero_python.payrollau.models.leave_earnings_line import LeaveEarningsLine +from xero_python.payrollau.models.leave_line import LeaveLine +from xero_python.payrollau.models.leave_line_calculation_type import ( + LeaveLineCalculationType, +) +from xero_python.payrollau.models.leave_lines import LeaveLines +from xero_python.payrollau.models.leave_period import LeavePeriod +from xero_python.payrollau.models.leave_period_status import LeavePeriodStatus +from xero_python.payrollau.models.leave_type import LeaveType +from xero_python.payrollau.models.leave_type_contribution_type import ( + LeaveTypeContributionType, +) +from xero_python.payrollau.models.manual_tax_type import ManualTaxType +from xero_python.payrollau.models.opening_balances import OpeningBalances +from xero_python.payrollau.models.pay_item import PayItem +from xero_python.payrollau.models.pay_items import PayItems +from xero_python.payrollau.models.pay_run import PayRun +from xero_python.payrollau.models.pay_run_status import PayRunStatus +from xero_python.payrollau.models.pay_runs import PayRuns +from xero_python.payrollau.models.pay_template import PayTemplate +from xero_python.payrollau.models.payment_frequency_type import PaymentFrequencyType +from xero_python.payrollau.models.payroll_calendar import PayrollCalendar +from xero_python.payrollau.models.payroll_calendars import PayrollCalendars +from xero_python.payrollau.models.payslip import Payslip +from xero_python.payrollau.models.payslip_lines import PayslipLines +from xero_python.payrollau.models.payslip_object import PayslipObject +from xero_python.payrollau.models.payslip_summary import PayslipSummary +from xero_python.payrollau.models.payslips import Payslips +from xero_python.payrollau.models.rate_type import RateType +from xero_python.payrollau.models.reimbursement_line import ReimbursementLine +from xero_python.payrollau.models.reimbursement_lines import ReimbursementLines +from xero_python.payrollau.models.reimbursement_type import ReimbursementType +from xero_python.payrollau.models.residency_status import ResidencyStatus +from xero_python.payrollau.models.settings import Settings +from xero_python.payrollau.models.settings_object import SettingsObject +from xero_python.payrollau.models.settings_tracking_categories import ( + SettingsTrackingCategories, +) +from xero_python.payrollau.models.settings_tracking_categories_employee_groups import ( + SettingsTrackingCategoriesEmployeeGroups, +) +from xero_python.payrollau.models.settings_tracking_categories_timesheet_categories import ( + SettingsTrackingCategoriesTimesheetCategories, +) +from xero_python.payrollau.models.state import State +from xero_python.payrollau.models.super_fund import SuperFund +from xero_python.payrollau.models.super_fund_product import SuperFundProduct +from xero_python.payrollau.models.super_fund_products import SuperFundProducts +from xero_python.payrollau.models.super_fund_type import SuperFundType +from xero_python.payrollau.models.super_funds import SuperFunds +from xero_python.payrollau.models.super_line import SuperLine +from xero_python.payrollau.models.super_membership import SuperMembership +from xero_python.payrollau.models.superannuation_calculation_type import ( + SuperannuationCalculationType, +) +from xero_python.payrollau.models.superannuation_contribution_type import ( + SuperannuationContributionType, +) +from xero_python.payrollau.models.superannuation_line import SuperannuationLine +from xero_python.payrollau.models.tfn_exemption_type import TFNExemptionType +from xero_python.payrollau.models.tax_declaration import TaxDeclaration +from xero_python.payrollau.models.tax_line import TaxLine +from xero_python.payrollau.models.timesheet import Timesheet +from xero_python.payrollau.models.timesheet_line import TimesheetLine +from xero_python.payrollau.models.timesheet_object import TimesheetObject +from xero_python.payrollau.models.timesheet_status import TimesheetStatus +from xero_python.payrollau.models.timesheets import Timesheets +from xero_python.payrollau.models.validation_error import ValidationError diff --git a/xero_python/payrollau/api/__init__.py b/xero_python/payrollau/api/__init__.py new file mode 100644 index 00000000..55dffc29 --- /dev/null +++ b/xero_python/payrollau/api/__init__.py @@ -0,0 +1,4 @@ +# flake8: noqa + +# import apis into api package +from xero_python.payrollau.api.payroll_au_api import PayrollAuApi diff --git a/xero_python/payrollau/api/payroll_au_api.py b/xero_python/payrollau/api/payroll_au_api.py new file mode 100644 index 00000000..f0ea63c2 --- /dev/null +++ b/xero_python/payrollau/api/payroll_au_api.py @@ -0,0 +1,2393 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 PayrollAuApi(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/1.0" + models_module = importlib.import_module("xero_python.payrollau.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 create_employee( + self, + xero_tenant_id, + employee, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Use this method to create a payroll employee # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param list[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: 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 `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="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, "create_employee") + + def create_leave_application( + self, + xero_tenant_id, + leave_application, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Use this method to create a Leave Application # noqa: E501 + OAuth2 scope: payroll.leaveapplications + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param list[LeaveApplication] leave_application: (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: LeaveApplications + """ + + # 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_application`" + ) + # verify the required parameter 'leave_application' is set + if leave_application is None: + raise ValueError( + "Missing the required parameter `leave_application` " + "when calling `create_leave_application`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = leave_application + # 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("/LeaveApplications") + + 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="LeaveApplications", + 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_application") + + def create_pay_item( + self, + xero_tenant_id, + pay_item, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Use this method to create a Pay Item # noqa: E501 + OAuth2 scope: payroll.payitems + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param PayItem pay_item: (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: PayItems + """ + + # 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_item`" + ) + # verify the required parameter 'pay_item' is set + if pay_item is None: + raise ValueError( + "Missing the required parameter `pay_item` " + "when calling `create_pay_item`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = pay_item + # 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("/PayItems") + + 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="PayItems", + 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_item") + + def create_pay_run( + self, + xero_tenant_id, + pay_run, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Use this method to create a PayRun # noqa: E501 + OAuth2 scope: payroll.payruns + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param list[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: 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 `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="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, "create_pay_run") + + def create_payroll_calendar( + self, + xero_tenant_id, + payroll_calendar, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Use this method to create a Payroll Calendars # noqa: E501 + OAuth2 scope: payroll.payrollcalendars + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param list[PayrollCalendar] payroll_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: PayrollCalendars + """ + + # 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_payroll_calendar`" + ) + # verify the required parameter 'payroll_calendar' is set + if payroll_calendar is None: + raise ValueError( + "Missing the required parameter `payroll_calendar` " + "when calling `create_payroll_calendar`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = payroll_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("/PayrollCalendars") + + 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="PayrollCalendars", + 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_payroll_calendar") + + def create_superfund( + self, + xero_tenant_id, + super_fund, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Use this method to create a super fund # noqa: E501 + OAuth2 scope: payroll.superfunds + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param list[SuperFund] super_fund: (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: SuperFunds + """ + + # 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_superfund`" + ) + # verify the required parameter 'super_fund' is set + if super_fund is None: + raise ValueError( + "Missing the required parameter `super_fund` " + "when calling `create_superfund`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = super_fund + # 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("/Superfunds") + + 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="SuperFunds", + 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_superfund") + + def create_timesheet( + self, + xero_tenant_id, + timesheet, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Use this method to create a timesheet # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param list[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: 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 `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="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, "create_timesheet") + + def get_employee( + self, + xero_tenant_id, + employee_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches for an employee by unique id # noqa: E501 + OAuth2 scope: payroll.employees.read + :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: 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_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="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_employee") + + def get_employees( + self, + xero_tenant_id, + if_modified_since=empty, + where=empty, + order=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 if_modified_since: Only records created or modified since this timestamp will be returned + :param str where: Filter by an any element + :param str order: Order by an any element + :param int page: e.g. page=1 – Up to 100 employees will be returned in a single API call + :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 where is not empty: + query_params.append(("where", where)) + + if order is not empty: + query_params.append(("order", order)) + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if if_modified_since is not empty: + header_params["If-Modified-Since"] = if_modified_since + + 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_application( + self, + xero_tenant_id, + leave_application_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches for an Leave Application by unique id # noqa: E501 + OAuth2 scope: payroll.leaveapplications.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str leave_application_id: Leave Application 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: LeaveApplications + """ + + # 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_application`" + ) + # verify the required parameter 'leave_application_id' is set + if leave_application_id is None: + raise ValueError( + "Missing the required parameter `leave_application_id` " + "when calling `get_leave_application`" + ) + + collection_formats = {} + path_params = { + "LeaveApplicationId": leave_application_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("/LeaveApplications/{LeaveApplicationId}") + + 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="LeaveApplications", + 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_application") + + def get_leave_applications( + self, + xero_tenant_id, + if_modified_since=empty, + where=empty, + order=empty, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches Leave Applications # noqa: E501 + OAuth2 scope: payroll.leaveapplications.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str if_modified_since: Only records created or modified since this timestamp will be returned + :param str where: Filter by an any element + :param str order: Order by an any element + :param int page: e.g. page=1 – Up to 100 objects will be returned in a single API call + :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: LeaveApplications + """ + + # 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_applications`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if where is not empty: + query_params.append(("where", where)) + + if order is not empty: + query_params.append(("order", order)) + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if if_modified_since is not empty: + header_params["If-Modified-Since"] = if_modified_since + + 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("/LeaveApplications") + + 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="LeaveApplications", + 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_applications") + + def get_pay_items( + self, + xero_tenant_id, + if_modified_since=empty, + where=empty, + order=empty, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches Pay Items # noqa: E501 + OAuth2 scope: payroll.payitems.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str if_modified_since: Only records created or modified since this timestamp will be returned + :param str where: Filter by an any element + :param str order: Order by an any element + :param int page: e.g. page=1 – Up to 100 objects will be returned in a single API call + :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: PayItems + """ + + # 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_items`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if where is not empty: + query_params.append(("where", where)) + + if order is not empty: + query_params.append(("order", order)) + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if if_modified_since is not empty: + header_params["If-Modified-Since"] = if_modified_since + + 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("/PayItems") + + 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="PayItems", + 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_items") + + def get_pay_run( + self, + xero_tenant_id, + pay_run_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches for an payrun by unique id # noqa: E501 + OAuth2 scope: payroll.payruns.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str pay_run_id: PayRun 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: 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_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="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_run") + + def get_pay_runs( + self, + xero_tenant_id, + if_modified_since=empty, + where=empty, + order=empty, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches PayRuns # noqa: E501 + OAuth2 scope: payroll.payruns.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str if_modified_since: Only records created or modified since this timestamp will be returned + :param str where: Filter by an any element + :param str order: Order by an any element + :param int page: e.g. page=1 – Up to 100 PayRuns will be returned in a single API call + :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 where is not empty: + query_params.append(("where", where)) + + if order is not empty: + query_params.append(("order", order)) + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if if_modified_since is not empty: + header_params["If-Modified-Since"] = if_modified_since + + 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_payroll_calendar( + self, + xero_tenant_id, + payroll_calendar_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches Payroll Calendars # noqa: E501 + OAuth2 scope: payroll.payrollcalendars.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str payroll_calendar_id: Payroll Calendar 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: PayrollCalendars + """ + + # 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_payroll_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_payroll_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("/PayrollCalendars/{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="PayrollCalendars", + 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_payroll_calendar") + + def get_payroll_calendars( + self, + xero_tenant_id, + if_modified_since=empty, + where=empty, + order=empty, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches Payroll Calendars # noqa: E501 + OAuth2 scope: payroll.payrollcalendars.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str if_modified_since: Only records created or modified since this timestamp will be returned + :param str where: Filter by an any element + :param str order: Order by an any element + :param int page: e.g. page=1 – Up to 100 objects will be returned in a single API call + :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: PayrollCalendars + """ + + # 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_payroll_calendars`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if where is not empty: + query_params.append(("where", where)) + + if order is not empty: + query_params.append(("order", order)) + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if if_modified_since is not empty: + header_params["If-Modified-Since"] = if_modified_since + + 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("/PayrollCalendars") + + 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="PayrollCalendars", + 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_payroll_calendars") + + def get_payslip( + self, + xero_tenant_id, + payslip_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches for an payslip by unique id # noqa: E501 + OAuth2 scope: payroll.payslip.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str payslip_id: Payslip 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: 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_payslip`" + ) + # verify the required parameter 'payslip_id' is set + if payslip_id is None: + raise ValueError( + "Missing the required parameter `payslip_id` " + "when calling `get_payslip`" + ) + + collection_formats = {} + path_params = { + "PayslipID": payslip_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("/Payslip/{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_payslip") + + def get_settings( + self, + xero_tenant_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """retrieve settings # noqa: E501 + OAuth2 scope: payroll.settings.read + :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: SettingsObject + """ + + # 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="SettingsObject", + 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_superfund( + self, + xero_tenant_id, + super_fund_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches for an Superfund by unique id # noqa: E501 + OAuth2 scope: payroll.superfunds.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str super_fund_id: Superfund 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: SuperFunds + """ + + # 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_superfund`" + ) + # verify the required parameter 'super_fund_id' is set + if super_fund_id is None: + raise ValueError( + "Missing the required parameter `super_fund_id` " + "when calling `get_superfund`" + ) + + collection_formats = {} + path_params = { + "SuperFundID": super_fund_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("/Superfunds/{SuperFundID}") + + 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="SuperFunds", + 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_superfund") + + def get_superfund_products( + self, + xero_tenant_id, + abn=empty, + usi=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches SuperfundProducts # noqa: E501 + OAuth2 scope: payroll.superfundproducts.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str abn: The ABN of the Regulated SuperFund + :param str usi: The USI of the Regulated SuperFund + :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: SuperFundProducts + """ + + # 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_superfund_products`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if abn is not empty: + query_params.append(("ABN", abn)) + + if usi is not empty: + query_params.append(("USI", usi)) + + 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("/SuperfundProducts") + + 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="SuperFundProducts", + 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_superfund_products") + + def get_superfunds( + self, + xero_tenant_id, + if_modified_since=empty, + where=empty, + order=empty, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches SuperFunds # noqa: E501 + OAuth2 scope: payroll.superfunds.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str if_modified_since: Only records created or modified since this timestamp will be returned + :param str where: Filter by an any element + :param str order: Order by an any element + :param int page: e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call + :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: SuperFunds + """ + + # 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_superfunds`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if where is not empty: + query_params.append(("where", where)) + + if order is not empty: + query_params.append(("order", order)) + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if if_modified_since is not empty: + header_params["If-Modified-Since"] = if_modified_since + + 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("/Superfunds") + + 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="SuperFunds", + 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_superfunds") + + def get_timesheet( + self, + xero_tenant_id, + timesheet_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches for an timesheet by unique id # noqa: E501 + OAuth2 scope: payroll.timesheets.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Timesheet 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: 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, + if_modified_since=empty, + where=empty, + order=empty, + page=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """searches timesheets # noqa: E501 + OAuth2 scope: payroll.timesheets.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str if_modified_since: Only records created or modified since this timestamp will be returned + :param str where: Filter by an any element + :param str order: Order by an any element + :param int page: e.g. page=1 – Up to 100 timesheets will be returned in a single API call + :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 where is not empty: + query_params.append(("where", where)) + + if order is not empty: + query_params.append(("order", order)) + + if page is not empty: + query_params.append(("page", page)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if if_modified_since is not empty: + header_params["If-Modified-Since"] = if_modified_since + + 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 update_employee( + self, + xero_tenant_id, + employee_id, + employee=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Update an Employee # noqa: E501 + OAuth2 scope: payroll.employees + Update properties on a single employee # noqa: E501 + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param list[Employee] employee: + :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 `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`" + ) + + 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, + "POST", + 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, "update_employee") + + def update_leave_application( + self, + xero_tenant_id, + leave_application_id, + leave_application, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Use this method to update a Leave Application # noqa: E501 + OAuth2 scope: payroll.leaveapplications + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str leave_application_id: Leave Application id for single object (required) + :param list[LeaveApplication] leave_application: (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: LeaveApplications + """ + + # 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_leave_application`" + ) + # verify the required parameter 'leave_application_id' is set + if leave_application_id is None: + raise ValueError( + "Missing the required parameter `leave_application_id` " + "when calling `update_leave_application`" + ) + # verify the required parameter 'leave_application' is set + if leave_application is None: + raise ValueError( + "Missing the required parameter `leave_application` " + "when calling `update_leave_application`" + ) + + collection_formats = {} + path_params = { + "LeaveApplicationId": leave_application_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = leave_application + # 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("/LeaveApplications/{LeaveApplicationId}") + + 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="LeaveApplications", + 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_leave_application") + + def update_pay_run( + self, + xero_tenant_id, + pay_run_id, + pay_run=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Update a PayRun # noqa: E501 + OAuth2 scope: payroll.payruns + Update properties on a single PayRun # noqa: E501 + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str pay_run_id: PayRun id for single object (required) + :param list[PayRun] pay_run: + :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 `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`" + ) + + 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, + "POST", + 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, "update_pay_run") + + def update_payslip( + self, + xero_tenant_id, + payslip_id, + payslip_lines=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Update a Payslip # noqa: E501 + OAuth2 scope: payroll.payslip + Update lines on a single payslips # noqa: E501 + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str payslip_id: Payslip id for single object (required) + :param list[PayslipLines] payslip_lines: + :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 `update_payslip`" + ) + # verify the required parameter 'payslip_id' is set + if payslip_id is None: + raise ValueError( + "Missing the required parameter `payslip_id` " + "when calling `update_payslip`" + ) + + collection_formats = {} + path_params = { + "PayslipID": payslip_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = payslip_lines + # 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("/Payslip/{PayslipID}") + + 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="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, "update_payslip") + + def update_superfund( + self, + xero_tenant_id, + super_fund_id, + super_fund=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Update a Superfund # noqa: E501 + OAuth2 scope: payroll.superfunds + Update properties on a single Superfund # noqa: E501 + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str super_fund_id: Superfund id for single object (required) + :param list[SuperFund] super_fund: + :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: SuperFunds + """ + + # 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_superfund`" + ) + # verify the required parameter 'super_fund_id' is set + if super_fund_id is None: + raise ValueError( + "Missing the required parameter `super_fund_id` " + "when calling `update_superfund`" + ) + + collection_formats = {} + path_params = { + "SuperFundID": super_fund_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = super_fund + # 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("/Superfunds/{SuperFundID}") + + 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="SuperFunds", + 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_superfund") + + def update_timesheet( + self, + xero_tenant_id, + timesheet_id, + timesheet=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Update a Timesheet # noqa: E501 + OAuth2 scope: payroll.timesheets + Update properties on a single timesheet # noqa: E501 + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Timesheet id for single object (required) + :param list[Timesheet] timesheet: + :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 `update_timesheet`" + ) + # 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`" + ) + + 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 + # 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}") + + 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="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, "update_timesheet") diff --git a/xero_python/payrollau/docs/APIException.md b/xero_python/payrollau/docs/APIException.md new file mode 100644 index 00000000..3f524653 --- /dev/null +++ b/xero_python/payrollau/docs/APIException.md @@ -0,0 +1,12 @@ +# APIException + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error_number** | **float** | The error number | [optional] +**type** | **str** | The type of error | [optional] +**message** | **str** | The message describing the error | [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/payrollau/docs/Account.md b/xero_python/payrollau/docs/Account.md new file mode 100644 index 00000000..376dc397 --- /dev/null +++ b/xero_python/payrollau/docs/Account.md @@ -0,0 +1,13 @@ +# Account + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | Xero identifier for accounts | [optional] +**type** | [**AccountType**](AccountType.md) | | [optional] +**code** | **str** | Customer defined account code | [optional] +**name** | **str** | Name of 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/payrollau/docs/AccountType.md b/xero_python/payrollau/docs/AccountType.md new file mode 100644 index 00000000..edae02eb --- /dev/null +++ b/xero_python/payrollau/docs/AccountType.md @@ -0,0 +1,9 @@ +# AccountType + +## 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/payrollau/docs/AllowanceType.md b/xero_python/payrollau/docs/AllowanceType.md new file mode 100644 index 00000000..adc63cac --- /dev/null +++ b/xero_python/payrollau/docs/AllowanceType.md @@ -0,0 +1,9 @@ +# AllowanceType + +## 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/payrollau/docs/BankAccount.md b/xero_python/payrollau/docs/BankAccount.md new file mode 100644 index 00000000..065333d9 --- /dev/null +++ b/xero_python/payrollau/docs/BankAccount.md @@ -0,0 +1,15 @@ +# BankAccount + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**statement_text** | **str** | The text that will appear on your employee's bank statement when they receive payment | [optional] +**account_name** | **str** | The name of the account | [optional] +**bsb** | **str** | The BSB number of the account | [optional] +**account_number** | **str** | The account number | [optional] +**remainder** | **bool** | If this account is the Remaining bank account | [optional] +**amount** | **float** | Fixed amounts (for example, if an employee wants to have $100 of their salary transferred to one account, and the remaining amount to another) | [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/payrollau/docs/CalendarType.md b/xero_python/payrollau/docs/CalendarType.md new file mode 100644 index 00000000..93387ad9 --- /dev/null +++ b/xero_python/payrollau/docs/CalendarType.md @@ -0,0 +1,9 @@ +# CalendarType + +## 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/payrollau/docs/DeductionLine.md b/xero_python/payrollau/docs/DeductionLine.md new file mode 100644 index 00000000..3df6f2f4 --- /dev/null +++ b/xero_python/payrollau/docs/DeductionLine.md @@ -0,0 +1,14 @@ +# DeductionLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**deduction_type_id** | **str** | Xero deduction type identifier | +**calculation_type** | [**DeductionTypeCalculationType**](DeductionTypeCalculationType.md) | | +**amount** | **float** | Deduction type amount | [optional] +**percentage** | **float** | The Percentage of the Deduction | [optional] +**number_of_units** | **float** | Deduction 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/payrollau/docs/DeductionType.md b/xero_python/payrollau/docs/DeductionType.md new file mode 100644 index 00000000..cdf93319 --- /dev/null +++ b/xero_python/payrollau/docs/DeductionType.md @@ -0,0 +1,18 @@ +# DeductionType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the earnings rate (max length = 100) | [optional] +**account_code** | **str** | See Accounts | [optional] +**reduces_tax** | **bool** | Indicates that this is a pre-tax deduction that will reduce the amount of tax you withhold from an employee. | [optional] +**reduces_super** | **bool** | Most deductions don’t reduce your superannuation guarantee contribution liability, so typically you will not set any value for this. | [optional] +**is_exempt_from_w1** | **bool** | Boolean to determine if the deduction type is reportable or exempt from W1 | [optional] +**deduction_type_id** | **str** | Xero identifier | [optional] +**updated_date_utc** | **datetime** | Last modified timestamp | [optional] +**deduction_category** | **str** | | [optional] +**current_record** | **bool** | Is the current record | [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/payrollau/docs/DeductionTypeCalculationType.md b/xero_python/payrollau/docs/DeductionTypeCalculationType.md new file mode 100644 index 00000000..3f4904b6 --- /dev/null +++ b/xero_python/payrollau/docs/DeductionTypeCalculationType.md @@ -0,0 +1,9 @@ +# DeductionTypeCalculationType + +## 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/payrollau/docs/EarningsLine.md b/xero_python/payrollau/docs/EarningsLine.md new file mode 100644 index 00000000..ca5fa325 --- /dev/null +++ b/xero_python/payrollau/docs/EarningsLine.md @@ -0,0 +1,18 @@ +# EarningsLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**earnings_rate_id** | **str** | Xero unique id for earnings rate | +**calculation_type** | [**EarningsRateCalculationType**](EarningsRateCalculationType.md) | | +**annual_salary** | **float** | Annual salary for earnings line | [optional] +**number_of_units_per_week** | **float** | number of units for earning line | [optional] +**rate_per_unit** | **float** | Rate per unit of the EarningsLine. | [optional] +**normal_number_of_units** | **float** | Normal number of units for EarningsLine. Applicable when RateType is \"MULTIPLE\" | [optional] +**amount** | **float** | Earnings rate amount | [optional] +**number_of_units** | **float** | Earnings rate number of units. | [optional] +**fixed_amount** | **float** | Earnings rate amount. Only applicable if the EarningsRate RateType is Fixed | [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/payrollau/docs/EarningsRate.md b/xero_python/payrollau/docs/EarningsRate.md new file mode 100644 index 00000000..522d772f --- /dev/null +++ b/xero_python/payrollau/docs/EarningsRate.md @@ -0,0 +1,26 @@ +# EarningsRate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the earnings rate (max length = 100) | [optional] +**account_code** | **str** | See Accounts | [optional] +**type_of_units** | **str** | Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT | [optional] +**is_exempt_from_tax** | **bool** | Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholding | [optional] +**is_exempt_from_super** | **bool** | See the ATO website for details of which payments are exempt from SGC | [optional] +**is_reportable_as_w1** | **bool** | Boolean to determine if the earnings rate is reportable or exempt from W1 | [optional] +**earnings_type** | [**EarningsType**](EarningsType.md) | | [optional] +**earnings_rate_id** | **str** | Xero identifier | [optional] +**rate_type** | [**RateType**](RateType.md) | | [optional] +**rate_per_unit** | **str** | Default rate per unit (optional). Only applicable if RateType is RATEPERUNIT. | [optional] +**multiplier** | **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 MULTIPLE | [optional] +**accrue_leave** | **bool** | Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE | [optional] +**amount** | **float** | Optional Amount for FIXEDAMOUNT RateType EarningsRate | [optional] +**employment_termination_payment_type** | [**EmploymentTerminationPaymentType**](EmploymentTerminationPaymentType.md) | | [optional] +**updated_date_utc** | **datetime** | Last modified timestamp | [optional] +**current_record** | **bool** | Is the current record | [optional] +**allowance_type** | [**AllowanceType**](AllowanceType.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/payrollau/docs/EarningsRateCalculationType.md b/xero_python/payrollau/docs/EarningsRateCalculationType.md new file mode 100644 index 00000000..bdfeca0b --- /dev/null +++ b/xero_python/payrollau/docs/EarningsRateCalculationType.md @@ -0,0 +1,9 @@ +# EarningsRateCalculationType + +## 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/payrollau/docs/EarningsType.md b/xero_python/payrollau/docs/EarningsType.md new file mode 100644 index 00000000..79a778cf --- /dev/null +++ b/xero_python/payrollau/docs/EarningsType.md @@ -0,0 +1,9 @@ +# EarningsType + +## 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/payrollau/docs/Employee.md b/xero_python/payrollau/docs/Employee.md new file mode 100644 index 00000000..cfa35f41 --- /dev/null +++ b/xero_python/payrollau/docs/Employee.md @@ -0,0 +1,40 @@ +# Employee + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**first_name** | **str** | First name of employee | +**last_name** | **str** | Last name of employee | +**date_of_birth** | **date** | Date of birth of the employee (YYYY-MM-DD) | +**home_address** | [**HomeAddress**](HomeAddress.md) | | [optional] +**start_date** | **date** | Start date for an employee (YYYY-MM-DD) | [optional] +**title** | **str** | Title of the employee | [optional] +**middle_names** | **str** | Middle name(s) of the employee | [optional] +**email** | **str** | The email address for the employee | [optional] +**gender** | **str** | The employee’s gender. See Employee Gender | [optional] +**phone** | **str** | Employee phone number | [optional] +**mobile** | **str** | Employee mobile number | [optional] +**twitter_user_name** | **str** | Employee’s twitter name | [optional] +**is_authorised_to_approve_leave** | **bool** | Authorised to approve other employees' leave requests | [optional] +**is_authorised_to_approve_timesheets** | **bool** | Authorised to approve timesheets | [optional] +**job_title** | **str** | JobTitle of the employee | [optional] +**classification** | **str** | Employees classification | [optional] +**ordinary_earnings_rate_id** | **str** | Xero unique identifier for earnings rate | [optional] +**payroll_calendar_id** | **str** | Xero unique identifier for payroll calendar for the employee | [optional] +**employee_group_name** | **str** | The Employee Group allows you to report on payroll expenses and liabilities for each group of employees | [optional] +**employee_id** | **str** | Xero unique identifier for an Employee | [optional] +**termination_date** | **date** | Employee Termination Date (YYYY-MM-DD) | [optional] +**bank_accounts** | [**list[BankAccount]**](BankAccount.md) | | [optional] +**pay_template** | [**PayTemplate**](PayTemplate.md) | | [optional] +**opening_balances** | [**OpeningBalances**](OpeningBalances.md) | | [optional] +**tax_declaration** | [**TaxDeclaration**](TaxDeclaration.md) | | [optional] +**leave_balances** | [**list[LeaveBalance]**](LeaveBalance.md) | | [optional] +**leave_lines** | [**list[LeaveLine]**](LeaveLine.md) | | [optional] +**super_memberships** | [**list[SuperMembership]**](SuperMembership.md) | | [optional] +**status** | [**EmployeeStatus**](EmployeeStatus.md) | | [optional] +**updated_date_utc** | **datetime** | Last modified timestamp | [optional] +**validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [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/payrollau/docs/EmployeeStatus.md b/xero_python/payrollau/docs/EmployeeStatus.md new file mode 100644 index 00000000..adbbbd38 --- /dev/null +++ b/xero_python/payrollau/docs/EmployeeStatus.md @@ -0,0 +1,9 @@ +# EmployeeStatus + +## 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/payrollau/docs/Employees.md b/xero_python/payrollau/docs/Employees.md new file mode 100644 index 00000000..b58aa3a3 --- /dev/null +++ b/xero_python/payrollau/docs/Employees.md @@ -0,0 +1,10 @@ +# Employees + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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/payrollau/docs/EmploymentBasis.md b/xero_python/payrollau/docs/EmploymentBasis.md new file mode 100644 index 00000000..0bc35934 --- /dev/null +++ b/xero_python/payrollau/docs/EmploymentBasis.md @@ -0,0 +1,9 @@ +# EmploymentBasis + +## 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/payrollau/docs/EmploymentTerminationPaymentType.md b/xero_python/payrollau/docs/EmploymentTerminationPaymentType.md new file mode 100644 index 00000000..b544a452 --- /dev/null +++ b/xero_python/payrollau/docs/EmploymentTerminationPaymentType.md @@ -0,0 +1,9 @@ +# EmploymentTerminationPaymentType + +## 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/payrollau/docs/EntitlementFinalPayPayoutType.md b/xero_python/payrollau/docs/EntitlementFinalPayPayoutType.md new file mode 100644 index 00000000..a84b2b88 --- /dev/null +++ b/xero_python/payrollau/docs/EntitlementFinalPayPayoutType.md @@ -0,0 +1,9 @@ +# EntitlementFinalPayPayoutType + +## 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/payrollau/docs/HomeAddress.md b/xero_python/payrollau/docs/HomeAddress.md new file mode 100644 index 00000000..71a52471 --- /dev/null +++ b/xero_python/payrollau/docs/HomeAddress.md @@ -0,0 +1,15 @@ +# HomeAddress + +## 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 | [optional] +**region** | [**State**](State.md) | | [optional] +**postal_code** | **str** | PostCode for employee home address | [optional] +**country** | **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/payrollau/docs/LeaveAccrualLine.md b/xero_python/payrollau/docs/LeaveAccrualLine.md new file mode 100644 index 00000000..62a4fc29 --- /dev/null +++ b/xero_python/payrollau/docs/LeaveAccrualLine.md @@ -0,0 +1,12 @@ +# 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] +**auto_calculate** | **bool** | If you want to auto calculate 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/payrollau/docs/LeaveApplication.md b/xero_python/payrollau/docs/LeaveApplication.md new file mode 100644 index 00000000..ef054467 --- /dev/null +++ b/xero_python/payrollau/docs/LeaveApplication.md @@ -0,0 +1,19 @@ +# LeaveApplication + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leave_application_id** | **str** | The Xero identifier for Payroll Employee | [optional] +**employee_id** | **str** | The Xero identifier for Payroll Employee | [optional] +**leave_type_id** | **str** | The Xero identifier for Leave Type | [optional] +**title** | **str** | The title of the leave | [optional] +**start_date** | **date** | Start date of the leave (YYYY-MM-DD) | [optional] +**end_date** | **date** | End date of the leave (YYYY-MM-DD) | [optional] +**description** | **str** | The Description of the Leave | [optional] +**leave_periods** | [**list[LeavePeriod]**](LeavePeriod.md) | | [optional] +**updated_date_utc** | **datetime** | Last modified timestamp | [optional] +**validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [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/payrollau/docs/LeaveApplications.md b/xero_python/payrollau/docs/LeaveApplications.md new file mode 100644 index 00000000..10b760c3 --- /dev/null +++ b/xero_python/payrollau/docs/LeaveApplications.md @@ -0,0 +1,10 @@ +# LeaveApplications + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leave_applications** | [**list[LeaveApplication]**](LeaveApplication.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/payrollau/docs/LeaveBalance.md b/xero_python/payrollau/docs/LeaveBalance.md new file mode 100644 index 00000000..62ff9317 --- /dev/null +++ b/xero_python/payrollau/docs/LeaveBalance.md @@ -0,0 +1,13 @@ +# LeaveBalance + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leave_name** | **str** | The name of the leave type | [optional] +**leave_type_id** | **str** | Identifier of the leave type (see PayItems) | [optional] +**number_of_units** | **float** | The balance of the leave available | [optional] +**type_of_units** | **str** | The type of units as specified by the LeaveType (see PayItems) | [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/payrollau/docs/LeaveEarningsLine.md b/xero_python/payrollau/docs/LeaveEarningsLine.md new file mode 100644 index 00000000..234da08c --- /dev/null +++ b/xero_python/payrollau/docs/LeaveEarningsLine.md @@ -0,0 +1,12 @@ +# LeaveEarningsLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**earnings_rate_id** | **str** | Xero identifier | [optional] +**rate_per_unit** | **float** | Rate per unit of the EarningsLine. | [optional] +**number_of_units** | **float** | Earnings rate 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/payrollau/docs/LeaveLine.md b/xero_python/payrollau/docs/LeaveLine.md new file mode 100644 index 00000000..cf773132 --- /dev/null +++ b/xero_python/payrollau/docs/LeaveLine.md @@ -0,0 +1,15 @@ +# LeaveLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leave_type_id** | **str** | Xero leave type identifier | [optional] +**calculation_type** | [**LeaveLineCalculationType**](LeaveLineCalculationType.md) | | [optional] +**entitlement_final_pay_payout_type** | [**EntitlementFinalPayPayoutType**](EntitlementFinalPayPayoutType.md) | | [optional] +**employment_termination_payment_type** | [**EmploymentTerminationPaymentType**](EmploymentTerminationPaymentType.md) | | [optional] +**include_superannuation_guarantee_contribution** | **bool** | amount of leave line | [optional] +**number_of_units** | **float** | Leave 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/payrollau/docs/LeaveLineCalculationType.md b/xero_python/payrollau/docs/LeaveLineCalculationType.md new file mode 100644 index 00000000..e73fb266 --- /dev/null +++ b/xero_python/payrollau/docs/LeaveLineCalculationType.md @@ -0,0 +1,9 @@ +# LeaveLineCalculationType + +## 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/payrollau/docs/LeaveLines.md b/xero_python/payrollau/docs/LeaveLines.md new file mode 100644 index 00000000..bfd3e738 --- /dev/null +++ b/xero_python/payrollau/docs/LeaveLines.md @@ -0,0 +1,10 @@ +# LeaveLines + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee** | [**list[LeaveLine]**](LeaveLine.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/payrollau/docs/LeavePeriod.md b/xero_python/payrollau/docs/LeavePeriod.md new file mode 100644 index 00000000..7d5019a8 --- /dev/null +++ b/xero_python/payrollau/docs/LeavePeriod.md @@ -0,0 +1,13 @@ +# LeavePeriod + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number_of_units** | **float** | The Number of Units for the leave | [optional] +**pay_period_end_date** | **date** | The Pay Period End Date (YYYY-MM-DD) | [optional] +**pay_period_start_date** | **date** | The Pay Period Start Date (YYYY-MM-DD) | [optional] +**leave_period_status** | [**LeavePeriodStatus**](LeavePeriodStatus.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/payrollau/docs/LeavePeriodStatus.md b/xero_python/payrollau/docs/LeavePeriodStatus.md new file mode 100644 index 00000000..d1def006 --- /dev/null +++ b/xero_python/payrollau/docs/LeavePeriodStatus.md @@ -0,0 +1,9 @@ +# LeavePeriodStatus + +## 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/payrollau/docs/LeaveType.md b/xero_python/payrollau/docs/LeaveType.md new file mode 100644 index 00000000..1ae0be4b --- /dev/null +++ b/xero_python/payrollau/docs/LeaveType.md @@ -0,0 +1,18 @@ +# LeaveType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the earnings rate (max length = 100) | [optional] +**type_of_units** | **str** | The type of units by which leave entitlements are normally tracked. These are typically the same as the type of units used for the employee’s ordinary earnings rate | [optional] +**leave_type_id** | **str** | Xero identifier | [optional] +**normal_entitlement** | **float** | The number of units the employee is entitled to each year | [optional] +**leave_loading_rate** | **int** | Enter an amount here if your organisation pays an additional percentage on top of ordinary earnings when your employees take leave (typically 17.5%) | [optional] +**updated_date_utc** | **datetime** | Last modified timestamp | [optional] +**is_paid_leave** | **bool** | Set this to indicate that an employee will be paid when taking this type of leave | [optional] +**show_on_payslip** | **bool** | Set this if you want a balance for this leave type to be shown on your employee’s payslips | [optional] +**current_record** | **bool** | Is the current record | [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/payrollau/docs/LeaveTypeContributionType.md b/xero_python/payrollau/docs/LeaveTypeContributionType.md new file mode 100644 index 00000000..abcfd96d --- /dev/null +++ b/xero_python/payrollau/docs/LeaveTypeContributionType.md @@ -0,0 +1,9 @@ +# LeaveTypeContributionType + +## 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/payrollau/docs/ManualTaxType.md b/xero_python/payrollau/docs/ManualTaxType.md new file mode 100644 index 00000000..ccece4f1 --- /dev/null +++ b/xero_python/payrollau/docs/ManualTaxType.md @@ -0,0 +1,9 @@ +# ManualTaxType + +## 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/payrollau/docs/OpeningBalances.md b/xero_python/payrollau/docs/OpeningBalances.md new file mode 100644 index 00000000..05101eb6 --- /dev/null +++ b/xero_python/payrollau/docs/OpeningBalances.md @@ -0,0 +1,16 @@ +# OpeningBalances + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**opening_balance_date** | **date** | Opening Balance Date. (YYYY-MM-DD) | [optional] +**tax** | **str** | Opening Balance tax | [optional] +**earnings_lines** | [**list[EarningsLine]**](EarningsLine.md) | | [optional] +**deduction_lines** | [**list[DeductionLine]**](DeductionLine.md) | | [optional] +**super_lines** | [**list[SuperLine]**](SuperLine.md) | | [optional] +**reimbursement_lines** | [**list[ReimbursementLine]**](ReimbursementLine.md) | | [optional] +**leave_lines** | [**list[LeaveLine]**](LeaveLine.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/payrollau/docs/PayItem.md b/xero_python/payrollau/docs/PayItem.md new file mode 100644 index 00000000..479909ff --- /dev/null +++ b/xero_python/payrollau/docs/PayItem.md @@ -0,0 +1,13 @@ +# PayItem + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**earnings_rates** | [**list[EarningsRate]**](EarningsRate.md) | | [optional] +**deduction_types** | [**list[DeductionType]**](DeductionType.md) | | [optional] +**leave_types** | [**list[LeaveType]**](LeaveType.md) | | [optional] +**reimbursement_types** | [**list[ReimbursementType]**](ReimbursementType.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/payrollau/docs/PayItems.md b/xero_python/payrollau/docs/PayItems.md new file mode 100644 index 00000000..f08d5e47 --- /dev/null +++ b/xero_python/payrollau/docs/PayItems.md @@ -0,0 +1,10 @@ +# PayItems + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pay_items** | [**PayItem**](PayItem.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/payrollau/docs/PayRun.md b/xero_python/payrollau/docs/PayRun.md new file mode 100644 index 00000000..4cb60978 --- /dev/null +++ b/xero_python/payrollau/docs/PayRun.md @@ -0,0 +1,25 @@ +# PayRun + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payroll_calendar_id** | **str** | Xero identifier for pay run | +**pay_run_id** | **str** | Xero identifier for pay run | [optional] +**pay_run_period_start_date** | **date** | Period Start Date for the PayRun (YYYY-MM-DD) | [optional] +**pay_run_period_end_date** | **date** | Period End Date for the PayRun (YYYY-MM-DD) | [optional] +**pay_run_status** | [**PayRunStatus**](PayRunStatus.md) | | [optional] +**payment_date** | **date** | Payment Date for the PayRun (YYYY-MM-DD) | [optional] +**payslip_message** | **str** | Payslip message for the PayRun | [optional] +**updated_date_utc** | **datetime** | Last modified timestamp | [optional] +**payslips** | [**list[PayslipSummary]**](PayslipSummary.md) | The payslips in the payrun | [optional] +**wages** | **float** | The total Wages for the Payrun | [optional] +**deductions** | **float** | The total Deductions for the Payrun | [optional] +**tax** | **float** | The total Tax for the Payrun | [optional] +**super** | **float** | The total Super for the Payrun | [optional] +**reimbursement** | **float** | The total Reimbursements for the Payrun | [optional] +**net_pay** | **float** | The total NetPay for the Payrun | [optional] +**validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [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/payrollau/docs/PayRunStatus.md b/xero_python/payrollau/docs/PayRunStatus.md new file mode 100644 index 00000000..965b4f69 --- /dev/null +++ b/xero_python/payrollau/docs/PayRunStatus.md @@ -0,0 +1,9 @@ +# PayRunStatus + +## 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/payrollau/docs/PayRuns.md b/xero_python/payrollau/docs/PayRuns.md new file mode 100644 index 00000000..618e5b44 --- /dev/null +++ b/xero_python/payrollau/docs/PayRuns.md @@ -0,0 +1,10 @@ +# PayRuns + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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/payrollau/docs/PayTemplate.md b/xero_python/payrollau/docs/PayTemplate.md new file mode 100644 index 00000000..d9015091 --- /dev/null +++ b/xero_python/payrollau/docs/PayTemplate.md @@ -0,0 +1,14 @@ +# PayTemplate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**earnings_lines** | [**list[EarningsLine]**](EarningsLine.md) | | [optional] +**deduction_lines** | [**list[DeductionLine]**](DeductionLine.md) | | [optional] +**super_lines** | [**list[SuperLine]**](SuperLine.md) | | [optional] +**reimbursement_lines** | [**list[ReimbursementLine]**](ReimbursementLine.md) | | [optional] +**leave_lines** | [**list[LeaveLine]**](LeaveLine.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/payrollau/docs/PaymentFrequencyType.md b/xero_python/payrollau/docs/PaymentFrequencyType.md new file mode 100644 index 00000000..fd0d5443 --- /dev/null +++ b/xero_python/payrollau/docs/PaymentFrequencyType.md @@ -0,0 +1,9 @@ +# PaymentFrequencyType + +## 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/payrollau/docs/PayrollAuApi.md b/xero_python/payrollau/docs/PayrollAuApi.md new file mode 100644 index 00000000..fc613e22 --- /dev/null +++ b/xero_python/payrollau/docs/PayrollAuApi.md @@ -0,0 +1,1928 @@ +# xero_python.payrollau.PayrollAuApi + +All URIs are relative to *https://api.xero.com/payroll.xro/1.0* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_employee**](PayrollAuApi.md#create_employee) | **POST** /Employees | Use this method to create a payroll employee +[**create_leave_application**](PayrollAuApi.md#create_leave_application) | **POST** /LeaveApplications | Use this method to create a Leave Application +[**create_pay_item**](PayrollAuApi.md#create_pay_item) | **POST** /PayItems | Use this method to create a Pay Item +[**create_pay_run**](PayrollAuApi.md#create_pay_run) | **POST** /PayRuns | Use this method to create a PayRun +[**create_payroll_calendar**](PayrollAuApi.md#create_payroll_calendar) | **POST** /PayrollCalendars | Use this method to create a Payroll Calendars +[**create_superfund**](PayrollAuApi.md#create_superfund) | **POST** /Superfunds | Use this method to create a super fund +[**create_timesheet**](PayrollAuApi.md#create_timesheet) | **POST** /Timesheets | Use this method to create a timesheet +[**get_employee**](PayrollAuApi.md#get_employee) | **GET** /Employees/{EmployeeId} | searches for an employee by unique id +[**get_employees**](PayrollAuApi.md#get_employees) | **GET** /Employees | searches employees +[**get_leave_application**](PayrollAuApi.md#get_leave_application) | **GET** /LeaveApplications/{LeaveApplicationId} | searches for an Leave Application by unique id +[**get_leave_applications**](PayrollAuApi.md#get_leave_applications) | **GET** /LeaveApplications | searches Leave Applications +[**get_pay_items**](PayrollAuApi.md#get_pay_items) | **GET** /PayItems | searches Pay Items +[**get_pay_run**](PayrollAuApi.md#get_pay_run) | **GET** /PayRuns/{PayRunID} | searches for an payrun by unique id +[**get_pay_runs**](PayrollAuApi.md#get_pay_runs) | **GET** /PayRuns | searches PayRuns +[**get_payroll_calendar**](PayrollAuApi.md#get_payroll_calendar) | **GET** /PayrollCalendars/{PayrollCalendarID} | searches Payroll Calendars +[**get_payroll_calendars**](PayrollAuApi.md#get_payroll_calendars) | **GET** /PayrollCalendars | searches Payroll Calendars +[**get_payslip**](PayrollAuApi.md#get_payslip) | **GET** /Payslip/{PayslipID} | searches for an payslip by unique id +[**get_settings**](PayrollAuApi.md#get_settings) | **GET** /Settings | retrieve settings +[**get_superfund**](PayrollAuApi.md#get_superfund) | **GET** /Superfunds/{SuperFundID} | searches for an Superfund by unique id +[**get_superfund_products**](PayrollAuApi.md#get_superfund_products) | **GET** /SuperfundProducts | searches SuperfundProducts +[**get_superfunds**](PayrollAuApi.md#get_superfunds) | **GET** /Superfunds | searches SuperFunds +[**get_timesheet**](PayrollAuApi.md#get_timesheet) | **GET** /Timesheets/{TimesheetID} | searches for an timesheet by unique id +[**get_timesheets**](PayrollAuApi.md#get_timesheets) | **GET** /Timesheets | searches timesheets +[**update_employee**](PayrollAuApi.md#update_employee) | **POST** /Employees/{EmployeeId} | Update an Employee +[**update_leave_application**](PayrollAuApi.md#update_leave_application) | **POST** /LeaveApplications/{LeaveApplicationId} | Use this method to update a Leave Application +[**update_pay_run**](PayrollAuApi.md#update_pay_run) | **POST** /PayRuns/{PayRunID} | Update a PayRun +[**update_payslip**](PayrollAuApi.md#update_payslip) | **POST** /Payslip/{PayslipID} | Update a Payslip +[**update_superfund**](PayrollAuApi.md#update_superfund) | **POST** /Superfunds/{SuperFundID} | Update a Superfund +[**update_timesheet**](PayrollAuApi.md#update_timesheet) | **POST** /Timesheets/{TimesheetID} | Update a Timesheet + + +# **create_employee** +> Employees create_employee(xero_tenant_id, employee) + +Use this method to create a payroll 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee = [ { "FirstName": "Albus", "LastName": "Dumbledore", "DateOfBirth": "/Date(321523200000+0000)/", "HomeAddress": { "AddressLine1": "101 Green St", "City": "Island Bay", "Region": "NSW", "PostalCode": "6023", "Country": "AUSTRALIA" }, "StartDate": "/Date(321523200000+0000)/", "MiddleNames": "Percival", "Email": "albus39608@hogwarts.edu", "Gender": "M", "Phone": "444-2323", "Mobile": "555-1212", "IsAuthorisedToApproveLeave": true, "IsAuthorisedToApproveTimesheets": true, "JobTitle": "Regional Manager", "Classification": "corporate", "OrdinaryEarningsRateID": "ab874dfb-ab09-4c91-954e-43acf6fc23b4", "Status": "ACTIVE" } ] # list[Employee] | +try: + # Use this method to create a payroll employee + api_response = api_instance.create_employee(xero_tenant_id, employee) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->create_employee: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee** | [**list[Employee]**](Employee.md)| | + +### Return type + +[**Employees**](Employees.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_application** +> LeaveApplications create_leave_application(xero_tenant_id, leave_application) + +Use this method to create a Leave Application + +### 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +leave_application = [ { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "LeaveTypeID": "184ea8f7-d143-46dd-bef3-0c60e1aa6fca", "Title": "Hello World", "StartDate": "/Date(1572559200000+0000)/", "EndDate": "/Date(1572645600000+0000)/" } ] # list[LeaveApplication] | +try: + # Use this method to create a Leave Application + api_response = api_instance.create_leave_application(xero_tenant_id, leave_application) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->create_leave_application: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **leave_application** | [**list[LeaveApplication]**](LeaveApplication.md)| | + +### Return type + +[**LeaveApplications**](LeaveApplications.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_item** +> PayItems create_pay_item(xero_tenant_id, pay_item) + +Use this method to create a Pay Item + +### 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +pay_item = { "EarningsRates": [ { "Name": "MyRate", "AccountCode": "400", "TypeOfUnits": "4.00", "IsExemptFromTax": true, "IsExemptFromSuper": true, "IsReportableAsW1": false, "EarningsType": "ORDINARYTIMEEARNINGS", "EarningsRateID": "1fa4e226-b711-46ba-a8a7-4344c9c5fb87", "RateType": "MULTIPLE", "RatePerUnit": "10.0", "Multiplier": 1.5, "Amount": 5, "EmploymentTerminationPaymentType": "O" } ] } # PayItem | +try: + # Use this method to create a Pay Item + api_response = api_instance.create_pay_item(xero_tenant_id, pay_item) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->create_pay_item: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **pay_item** | [**PayItem**](PayItem.md)| | + +### Return type + +[**PayItems**](PayItems.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** +> PayRuns create_pay_run(xero_tenant_id, pay_run) + +Use this method to create a PayRun + +### 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +pay_run = [ { "PayrollCalendarID": "78bb86b9-e1ea-47ac-b75d-f087a81931de", "PayRunPeriodStartDate": "/Date(1572566400000+0000)/", "PayRunPeriodEndDate": "/Date(1573084800000+0000)/", "PayRunStatus": "DRAFT", "PaymentDate": "/Date(1573171200000+0000)/" } ] # list[PayRun] | +try: + # Use this method to create a PayRun + api_response = api_instance.create_pay_run(xero_tenant_id, pay_run) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->create_pay_run: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **pay_run** | [**list[PayRun]**](PayRun.md)| | + +### Return type + +[**PayRuns**](PayRuns.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_payroll_calendar** +> PayrollCalendars create_payroll_calendar(xero_tenant_id, payroll_calendar) + +Use this method to create a Payroll 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +payroll_calendar = [ { "PayrollCalendarID":"78bb86b9-e1ea-47ac-b75d-f087a81931de", "PayRunPeriodStartDate":"/Date(1572566400000+0000)/", "PayRunPeriodEndDate":"/Date(1573084800000+0000)/", "PayRunStatus":"DRAFT", "PaymentDate":"/Date(1573171200000+0000)/" } ] # list[PayrollCalendar] | +try: + # Use this method to create a Payroll Calendars + api_response = api_instance.create_payroll_calendar(xero_tenant_id, payroll_calendar) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->create_payroll_calendar: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **payroll_calendar** | [**list[PayrollCalendar]**](PayrollCalendar.md)| | + +### Return type + +[**PayrollCalendars**](PayrollCalendars.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_superfund** +> SuperFunds create_superfund(xero_tenant_id, super_fund) + +Use this method to create a super fund + +### 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +super_fund = [ { "usi":"PTC0133AU", "Type":"REGULATED", "Name":"Bar99359", "AccountNumber":"FB36350", "AccountName":"Foo38428", "USI":"PTC0133AU" } ] # list[SuperFund] | +try: + # Use this method to create a super fund + api_response = api_instance.create_superfund(xero_tenant_id, super_fund) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->create_superfund: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **super_fund** | [**list[SuperFund]**](SuperFund.md)| | + +### Return type + +[**SuperFunds**](SuperFunds.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** +> Timesheets create_timesheet(xero_tenant_id, timesheet) + +Use this method to create 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet = [ { "EmployeeID":"b34e89ff-770d-4099-b7e5-f968767118bc", "StartDate":"/Date(1573171200000+0000)/", "EndDate":"/Date(1573689600000+0000)/", "Status":"DRAFT", "TimesheetLines":[ { "EarningsRateID":"ab874dfb-ab09-4c91-954e-43acf6fc23b4", "TrackingItemID":"af5e9ce2-2349-4136-be99-3561b189f473", "NumberOfUnits":[ 2.0, 10.0, 0.0, 0.0, 5.0, 0.0, 5.0 ] } ] } ] # list[Timesheet] | +try: + # Use this method to create a timesheet + api_response = api_instance.create_timesheet(xero_tenant_id, timesheet) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->create_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet** | [**list[Timesheet]**](Timesheet.md)| | + +### Return type + +[**Timesheets**](Timesheets.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) + +# **get_employee** +> Employees get_employee(xero_tenant_id, employee_id) + +searches for an employee by unique 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.payrollau import PayrollAuApi +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 = PayrollAuApi(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 for an employee by unique id + api_response = api_instance.get_employee(xero_tenant_id, employee_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->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 + +[**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_employees** +> Employees get_employees(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +if_modified_since = 'if_modified_since_example' # str | Only records created or modified since this timestamp will be returned (optional) +where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) +order = 'EmailAddress%20DESC' # str | Order by an any element (optional) +page = 56 # int | e.g. page=1 – Up to 100 employees will be returned in a single API call (optional) +try: + # searches employees + api_response = api_instance.get_employees(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_employees: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **if_modified_since** | **str**| Only records created or modified since this timestamp will be returned | [optional] + **where** | **str**| Filter by an any element | [optional] + **order** | **str**| Order by an any element | [optional] + **page** | **int**| e.g. page=1 – Up to 100 employees will be returned in a single API call | [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_application** +> LeaveApplications get_leave_application(xero_tenant_id, leave_application_id) + +searches for an Leave Application by unique 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Leave Application id for single object +try: + # searches for an Leave Application by unique id + api_response = api_instance.get_leave_application(xero_tenant_id, leave_application_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_leave_application: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **leave_application_id** | [**str**](.md)| Leave Application id for single object | + +### Return type + +[**LeaveApplications**](LeaveApplications.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_applications** +> LeaveApplications get_leave_applications(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + +searches Leave Applications + +### 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +if_modified_since = 'if_modified_since_example' # str | Only records created or modified since this timestamp will be returned (optional) +where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) +order = 'EmailAddress%20DESC' # str | Order by an any element (optional) +page = 56 # int | e.g. page=1 – Up to 100 objects will be returned in a single API call (optional) +try: + # searches Leave Applications + api_response = api_instance.get_leave_applications(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_leave_applications: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **if_modified_since** | **str**| Only records created or modified since this timestamp will be returned | [optional] + **where** | **str**| Filter by an any element | [optional] + **order** | **str**| Order by an any element | [optional] + **page** | **int**| e.g. page=1 – Up to 100 objects will be returned in a single API call | [optional] + +### Return type + +[**LeaveApplications**](LeaveApplications.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_items** +> PayItems get_pay_items(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + +searches Pay Items + +### 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +if_modified_since = 'if_modified_since_example' # str | Only records created or modified since this timestamp will be returned (optional) +where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) +order = 'EmailAddress%20DESC' # str | Order by an any element (optional) +page = 56 # int | e.g. page=1 – Up to 100 objects will be returned in a single API call (optional) +try: + # searches Pay Items + api_response = api_instance.get_pay_items(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_pay_items: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **if_modified_since** | **str**| Only records created or modified since this timestamp will be returned | [optional] + **where** | **str**| Filter by an any element | [optional] + **order** | **str**| Order by an any element | [optional] + **page** | **int**| e.g. page=1 – Up to 100 objects will be returned in a single API call | [optional] + +### Return type + +[**PayItems**](PayItems.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** +> PayRuns get_pay_run(xero_tenant_id, pay_run_id) + +searches for an payrun by unique 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +pay_run_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | PayRun id for single object +try: + # searches for an payrun by unique 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 PayrollAuApi->get_pay_run: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **pay_run_id** | [**str**](.md)| PayRun id for single object | + +### 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_runs** +> PayRuns get_pay_runs(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + +searches PayRuns + +### 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +if_modified_since = 'if_modified_since_example' # str | Only records created or modified since this timestamp will be returned (optional) +where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) +order = 'EmailAddress%20DESC' # str | Order by an any element (optional) +page = 56 # int | e.g. page=1 – Up to 100 PayRuns will be returned in a single API call (optional) +try: + # searches PayRuns + api_response = api_instance.get_pay_runs(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_pay_runs: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **if_modified_since** | **str**| Only records created or modified since this timestamp will be returned | [optional] + **where** | **str**| Filter by an any element | [optional] + **order** | **str**| Order by an any element | [optional] + **page** | **int**| e.g. page=1 – Up to 100 PayRuns will be returned in a single API call | [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_payroll_calendar** +> PayrollCalendars get_payroll_calendar(xero_tenant_id, payroll_calendar_id) + +searches Payroll 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +payroll_calendar_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Payroll Calendar id for single object +try: + # searches Payroll Calendars + api_response = api_instance.get_payroll_calendar(xero_tenant_id, payroll_calendar_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_payroll_calendar: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **payroll_calendar_id** | [**str**](.md)| Payroll Calendar id for single object | + +### Return type + +[**PayrollCalendars**](PayrollCalendars.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_payroll_calendars** +> PayrollCalendars get_payroll_calendars(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + +searches Payroll 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +if_modified_since = 'if_modified_since_example' # str | Only records created or modified since this timestamp will be returned (optional) +where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) +order = 'EmailAddress%20DESC' # str | Order by an any element (optional) +page = 56 # int | e.g. page=1 – Up to 100 objects will be returned in a single API call (optional) +try: + # searches Payroll Calendars + api_response = api_instance.get_payroll_calendars(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_payroll_calendars: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **if_modified_since** | **str**| Only records created or modified since this timestamp will be returned | [optional] + **where** | **str**| Filter by an any element | [optional] + **order** | **str**| Order by an any element | [optional] + **page** | **int**| e.g. page=1 – Up to 100 objects will be returned in a single API call | [optional] + +### Return type + +[**PayrollCalendars**](PayrollCalendars.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_payslip** +> PayslipObject get_payslip(xero_tenant_id, payslip_id) + +searches for an payslip by unique 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +payslip_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Payslip id for single object +try: + # searches for an payslip by unique id + api_response = api_instance.get_payslip(xero_tenant_id, payslip_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_payslip: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **payslip_id** | [**str**](.md)| Payslip id for single object | + +### 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_settings** +> SettingsObject get_settings(xero_tenant_id) + +retrieve 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +try: + # retrieve settings + api_response = api_instance.get_settings(xero_tenant_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_settings: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + +### Return type + +[**SettingsObject**](SettingsObject.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_superfund** +> SuperFunds get_superfund(xero_tenant_id, super_fund_id) + +searches for an Superfund by unique 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +super_fund_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Superfund id for single object +try: + # searches for an Superfund by unique id + api_response = api_instance.get_superfund(xero_tenant_id, super_fund_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_superfund: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **super_fund_id** | [**str**](.md)| Superfund id for single object | + +### Return type + +[**SuperFunds**](SuperFunds.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_superfund_products** +> SuperFundProducts get_superfund_products(xero_tenant_id, abn=abn, usi=usi) + +searches SuperfundProducts + +### 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +abn = '40022701955' # str | The ABN of the Regulated SuperFund (optional) +usi = 'OSF0001AU' # str | The USI of the Regulated SuperFund (optional) +try: + # searches SuperfundProducts + api_response = api_instance.get_superfund_products(xero_tenant_id, abn=abn, usi=usi) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_superfund_products: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **abn** | **str**| The ABN of the Regulated SuperFund | [optional] + **usi** | **str**| The USI of the Regulated SuperFund | [optional] + +### Return type + +[**SuperFundProducts**](SuperFundProducts.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_superfunds** +> SuperFunds get_superfunds(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + +searches SuperFunds + +### 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +if_modified_since = 'if_modified_since_example' # str | Only records created or modified since this timestamp will be returned (optional) +where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) +order = 'EmailAddress%20DESC' # str | Order by an any element (optional) +page = 56 # int | e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call (optional) +try: + # searches SuperFunds + api_response = api_instance.get_superfunds(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_superfunds: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **if_modified_since** | **str**| Only records created or modified since this timestamp will be returned | [optional] + **where** | **str**| Filter by an any element | [optional] + **order** | **str**| Order by an any element | [optional] + **page** | **int**| e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call | [optional] + +### Return type + +[**SuperFunds**](SuperFunds.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) + +searches for an timesheet by unique 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Timesheet id for single object +try: + # searches for an timesheet by unique id + api_response = api_instance.get_timesheet(xero_tenant_id, timesheet_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Timesheet id for single object | + +### 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, if_modified_since=if_modified_since, where=where, order=order, page=page) + +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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +if_modified_since = 'if_modified_since_example' # str | Only records created or modified since this timestamp will be returned (optional) +where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) +order = 'EmailAddress%20DESC' # str | Order by an any element (optional) +page = 56 # int | e.g. page=1 – Up to 100 timesheets will be returned in a single API call (optional) +try: + # searches timesheets + api_response = api_instance.get_timesheets(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->get_timesheets: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **if_modified_since** | **str**| Only records created or modified since this timestamp will be returned | [optional] + **where** | **str**| Filter by an any element | [optional] + **order** | **str**| Order by an any element | [optional] + **page** | **int**| e.g. page=1 – Up to 100 timesheets will be returned in a single API call | [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) + +# **update_employee** +> Employees update_employee(xero_tenant_id, employee_id, employee=employee) + +Update an Employee + +Update properties on a single 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.payrollau import PayrollAuApi +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 = PayrollAuApi(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 = [ { "MiddleNames": "Frank" } ] # list[Employee] | (optional) +try: + # Update an Employee + api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee=employee) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->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** | [**list[Employee]**](Employee.md)| | [optional] + +### Return type + +[**Employees**](Employees.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_leave_application** +> LeaveApplications update_leave_application(xero_tenant_id, leave_application_id, leave_application) + +Use this method to update a Leave Application + +### 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Leave Application id for single object +leave_application = [ { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "LeaveTypeID": "184ea8f7-d143-46dd-bef3-0c60e1aa6fca", "StartDate": "/Date(1572559200000+0000)/", "EndDate": "/Date(1572645600000+0000)/", "Description": "My updated Description" } ] # list[LeaveApplication] | +try: + # Use this method to update a Leave Application + api_response = api_instance.update_leave_application(xero_tenant_id, leave_application_id, leave_application) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->update_leave_application: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **leave_application_id** | [**str**](.md)| Leave Application id for single object | + **leave_application** | [**list[LeaveApplication]**](LeaveApplication.md)| | + +### Return type + +[**LeaveApplications**](LeaveApplications.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** +> PayRuns update_pay_run(xero_tenant_id, pay_run_id, pay_run=pay_run) + +Update a PayRun + +Update properties on a single PayRun + +### 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +pay_run_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | PayRun id for single object +pay_run = [xero_python.payrollau.PayRun()] # list[PayRun] | (optional) +try: + # Update a PayRun + api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run=pay_run) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->update_pay_run: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **pay_run_id** | [**str**](.md)| PayRun id for single object | + **pay_run** | [**list[PayRun]**](PayRun.md)| | [optional] + +### Return type + +[**PayRuns**](PayRuns.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_payslip** +> Payslips update_payslip(xero_tenant_id, payslip_id, payslip_lines=payslip_lines) + +Update a Payslip + +Update lines on a single 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +payslip_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Payslip id for single object +payslip_lines = { "Payslip": { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "DeductionLines": [ { "DeductionTypeID": "727af5e8-b347-4ae7-85fc-9b82266d0aec", "CalculationType": "FIXEDAMOUNT", "NumberOfUnits": 10 } ] } } # list[PayslipLines] | (optional) +try: + # Update a Payslip + api_response = api_instance.update_payslip(xero_tenant_id, payslip_id, payslip_lines=payslip_lines) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->update_payslip: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **payslip_id** | [**str**](.md)| Payslip id for single object | + **payslip_lines** | [**list[PayslipLines]**](PayslipLines.md)| | [optional] + +### Return type + +[**Payslips**](Payslips.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_superfund** +> SuperFunds update_superfund(xero_tenant_id, super_fund_id, super_fund=super_fund) + +Update a Superfund + +Update properties on a single Superfund + +### 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +super_fund_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Superfund id for single object +super_fund = [ { "Type":"REGULATED", "Name":"Nice23534" } ] # list[SuperFund] | (optional) +try: + # Update a Superfund + api_response = api_instance.update_superfund(xero_tenant_id, super_fund_id, super_fund=super_fund) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->update_superfund: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **super_fund_id** | [**str**](.md)| Superfund id for single object | + **super_fund** | [**list[SuperFund]**](SuperFund.md)| | [optional] + +### Return type + +[**SuperFunds**](SuperFunds.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** +> Timesheets update_timesheet(xero_tenant_id, timesheet_id, timesheet=timesheet) + +Update a Timesheet + +Update properties on a single 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.payrollau import PayrollAuApi +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 = PayrollAuApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Timesheet id for single object +timesheet = [ { "EmployeeID":"b34e89ff-770d-4099-b7e5-f968767118bc", "StartDate":"/Date(1573171200000+0000)/", "EndDate":"/Date(1573689600000+0000)/", "Status":"APPROVED", "Hours":22.0, "TimesheetID":"a7eb0a79-8511-4ee7-b473-3a25f28abcb9", "TimesheetLines":[ { "EarningsRateID":"ab874dfb-ab09-4c91-954e-43acf6fc23b4", "TrackingItemID":"af5e9ce2-2349-4136-be99-3561b189f473", "NumberOfUnits":[ 2.0, 10.0, 0.0, 0.0, 5.0, 0.0, 5.0 ], "UpdatedDateUTC":"/Date(1573516185127+0000)/" } ] } ] # list[Timesheet] | (optional) +try: + # Update a Timesheet + api_response = api_instance.update_timesheet(xero_tenant_id, timesheet_id, timesheet=timesheet) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuApi->update_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Timesheet id for single object | + **timesheet** | [**list[Timesheet]**](Timesheet.md)| | [optional] + +### Return type + +[**Timesheets**](Timesheets.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/payrollau/docs/PayrollCalendar.md b/xero_python/payrollau/docs/PayrollCalendar.md new file mode 100644 index 00000000..1cfb0ed1 --- /dev/null +++ b/xero_python/payrollau/docs/PayrollCalendar.md @@ -0,0 +1,16 @@ +# PayrollCalendar + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the Payroll Calendar | [optional] +**calendar_type** | [**CalendarType**](CalendarType.md) | | [optional] +**start_date** | **date** | The start date of the upcoming pay period. The end date will be calculated based upon this date, and the calendar type selected (YYYY-MM-DD) | [optional] +**payment_date** | **date** | The date on which employees will be paid for the upcoming pay period (YYYY-MM-DD) | [optional] +**payroll_calendar_id** | **str** | Xero identifier | [optional] +**updated_date_utc** | **datetime** | Last modified timestamp | [optional] +**validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [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/payrollau/docs/PayrollCalendars.md b/xero_python/payrollau/docs/PayrollCalendars.md new file mode 100644 index 00000000..9da1dca3 --- /dev/null +++ b/xero_python/payrollau/docs/PayrollCalendars.md @@ -0,0 +1,10 @@ +# PayrollCalendars + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payroll_calendars** | [**list[PayrollCalendar]**](PayrollCalendar.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/payrollau/docs/Payslip.md b/xero_python/payrollau/docs/Payslip.md new file mode 100644 index 00000000..5032d36e --- /dev/null +++ b/xero_python/payrollau/docs/Payslip.md @@ -0,0 +1,28 @@ +# Payslip + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee_id** | **str** | The Xero identifier for an employee | [optional] +**payslip_id** | **str** | Xero identifier for the payslip | [optional] +**first_name** | **str** | First name of employee | [optional] +**last_name** | **str** | Last name of employee | [optional] +**wages** | **float** | The Wages for the Payslip | [optional] +**deductions** | **float** | The Deductions for the Payslip | [optional] +**tax** | **float** | The Tax for the Payslip | [optional] +**super** | **float** | The Super for the Payslip | [optional] +**reimbursements** | **float** | The Reimbursements for the Payslip | [optional] +**net_pay** | **float** | The NetPay for the Payslip | [optional] +**earnings_lines** | [**list[EarningsLine]**](EarningsLine.md) | | [optional] +**leave_earnings_lines** | [**list[LeaveEarningsLine]**](LeaveEarningsLine.md) | | [optional] +**timesheet_earnings_lines** | [**list[EarningsLine]**](EarningsLine.md) | | [optional] +**deduction_lines** | [**list[DeductionLine]**](DeductionLine.md) | | [optional] +**leave_accrual_lines** | [**list[LeaveAccrualLine]**](LeaveAccrualLine.md) | | [optional] +**reimbursement_lines** | [**list[ReimbursementLine]**](ReimbursementLine.md) | | [optional] +**superannuation_lines** | [**list[SuperannuationLine]**](SuperannuationLine.md) | | [optional] +**tax_lines** | [**list[TaxLine]**](TaxLine.md) | | [optional] +**updated_date_utc** | **datetime** | Last modified timestamp | [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/payrollau/docs/PayslipLines.md b/xero_python/payrollau/docs/PayslipLines.md new file mode 100644 index 00000000..d1be1245 --- /dev/null +++ b/xero_python/payrollau/docs/PayslipLines.md @@ -0,0 +1,17 @@ +# PayslipLines + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**earnings_lines** | [**list[EarningsLine]**](EarningsLine.md) | | [optional] +**leave_earnings_lines** | [**list[LeaveEarningsLine]**](LeaveEarningsLine.md) | | [optional] +**timesheet_earnings_lines** | [**list[EarningsLine]**](EarningsLine.md) | | [optional] +**deduction_lines** | [**list[DeductionLine]**](DeductionLine.md) | | [optional] +**leave_accrual_lines** | [**list[LeaveAccrualLine]**](LeaveAccrualLine.md) | | [optional] +**reimbursement_lines** | [**list[ReimbursementLine]**](ReimbursementLine.md) | | [optional] +**superannuation_lines** | [**list[SuperannuationLine]**](SuperannuationLine.md) | | [optional] +**tax_lines** | [**list[TaxLine]**](TaxLine.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/payrollau/docs/PayslipObject.md b/xero_python/payrollau/docs/PayslipObject.md new file mode 100644 index 00000000..403c1154 --- /dev/null +++ b/xero_python/payrollau/docs/PayslipObject.md @@ -0,0 +1,10 @@ +# PayslipObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payslip** | [**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/payrollau/docs/PayslipSummary.md b/xero_python/payrollau/docs/PayslipSummary.md new file mode 100644 index 00000000..6f5dcae9 --- /dev/null +++ b/xero_python/payrollau/docs/PayslipSummary.md @@ -0,0 +1,21 @@ +# PayslipSummary + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee_id** | **str** | The Xero identifier for an employee | [optional] +**payslip_id** | **str** | Xero identifier for the payslip | [optional] +**first_name** | **str** | First name of employee | [optional] +**last_name** | **str** | Last name of employee | [optional] +**employee_group** | **str** | Employee group name | [optional] +**wages** | **float** | The Wages for the Payslip | [optional] +**deductions** | **float** | The Deductions for the Payslip | [optional] +**tax** | **float** | The Tax for the Payslip | [optional] +**super** | **float** | The Super for the Payslip | [optional] +**reimbursements** | **float** | The Reimbursements for the Payslip | [optional] +**net_pay** | **float** | The NetPay for the Payslip | [optional] +**updated_date_utc** | **datetime** | Last modified timestamp | [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/payrollau/docs/Payslips.md b/xero_python/payrollau/docs/Payslips.md new file mode 100644 index 00000000..7d473f8a --- /dev/null +++ b/xero_python/payrollau/docs/Payslips.md @@ -0,0 +1,10 @@ +# Payslips + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payslips** | [**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/payrollau/docs/RateType.md b/xero_python/payrollau/docs/RateType.md new file mode 100644 index 00000000..8e647f3b --- /dev/null +++ b/xero_python/payrollau/docs/RateType.md @@ -0,0 +1,9 @@ +# RateType + +## 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/payrollau/docs/ReimbursementLine.md b/xero_python/payrollau/docs/ReimbursementLine.md new file mode 100644 index 00000000..22cb7d4d --- /dev/null +++ b/xero_python/payrollau/docs/ReimbursementLine.md @@ -0,0 +1,13 @@ +# ReimbursementLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reimbursement_type_id** | **str** | Xero reimbursement type identifier | [optional] +**amount** | **float** | Reimbursement type amount | [optional] +**description** | **str** | Reimbursement lines description (max length 50) | [optional] +**expense_account** | **str** | Reimbursement expense account. For posted pay run you should be able to see expense account code. | [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/payrollau/docs/ReimbursementLines.md b/xero_python/payrollau/docs/ReimbursementLines.md new file mode 100644 index 00000000..cbeaf6ed --- /dev/null +++ b/xero_python/payrollau/docs/ReimbursementLines.md @@ -0,0 +1,10 @@ +# ReimbursementLines + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reimbursement_lines** | [**list[ReimbursementLine]**](ReimbursementLine.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/payrollau/docs/ReimbursementType.md b/xero_python/payrollau/docs/ReimbursementType.md new file mode 100644 index 00000000..cf09a187 --- /dev/null +++ b/xero_python/payrollau/docs/ReimbursementType.md @@ -0,0 +1,14 @@ +# ReimbursementType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the earnings rate (max length = 100) | [optional] +**account_code** | **str** | See Accounts | [optional] +**reimbursement_type_id** | **str** | Xero identifier | [optional] +**updated_date_utc** | **datetime** | Last modified timestamp | [optional] +**current_record** | **bool** | Is the current record | [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/payrollau/docs/ResidencyStatus.md b/xero_python/payrollau/docs/ResidencyStatus.md new file mode 100644 index 00000000..e6282750 --- /dev/null +++ b/xero_python/payrollau/docs/ResidencyStatus.md @@ -0,0 +1,9 @@ +# ResidencyStatus + +## 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/payrollau/docs/Settings.md b/xero_python/payrollau/docs/Settings.md new file mode 100644 index 00000000..7753cf43 --- /dev/null +++ b/xero_python/payrollau/docs/Settings.md @@ -0,0 +1,12 @@ +# Settings + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accounts** | [**list[Account]**](Account.md) | Payroll Account details for SuperExpense, SuperLiabilty, WagesExpense, PAYGLiability & WagesPayable. | [optional] +**tracking_categories** | [**SettingsTrackingCategories**](SettingsTrackingCategories.md) | | [optional] +**days_in_payroll_year** | **int** | Number of days in the Payroll year | [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/payrollau/docs/SettingsObject.md b/xero_python/payrollau/docs/SettingsObject.md new file mode 100644 index 00000000..fa08a9b3 --- /dev/null +++ b/xero_python/payrollau/docs/SettingsObject.md @@ -0,0 +1,10 @@ +# SettingsObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**settings** | [**Settings**](Settings.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/payrollau/docs/SettingsTrackingCategories.md b/xero_python/payrollau/docs/SettingsTrackingCategories.md new file mode 100644 index 00000000..ab17c278 --- /dev/null +++ b/xero_python/payrollau/docs/SettingsTrackingCategories.md @@ -0,0 +1,11 @@ +# SettingsTrackingCategories + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee_groups** | [**SettingsTrackingCategoriesEmployeeGroups**](SettingsTrackingCategoriesEmployeeGroups.md) | | [optional] +**timesheet_categories** | [**SettingsTrackingCategoriesTimesheetCategories**](SettingsTrackingCategoriesTimesheetCategories.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/payrollau/docs/SettingsTrackingCategoriesEmployeeGroups.md b/xero_python/payrollau/docs/SettingsTrackingCategoriesEmployeeGroups.md new file mode 100644 index 00000000..c3a1ded3 --- /dev/null +++ b/xero_python/payrollau/docs/SettingsTrackingCategoriesEmployeeGroups.md @@ -0,0 +1,11 @@ +# SettingsTrackingCategoriesEmployeeGroups + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tracking_category_id** | **str** | The identifier for the tracking category | [optional] +**tracking_category_name** | **str** | Name of the 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/payrollau/docs/SettingsTrackingCategoriesTimesheetCategories.md b/xero_python/payrollau/docs/SettingsTrackingCategoriesTimesheetCategories.md new file mode 100644 index 00000000..72bd90ab --- /dev/null +++ b/xero_python/payrollau/docs/SettingsTrackingCategoriesTimesheetCategories.md @@ -0,0 +1,11 @@ +# SettingsTrackingCategoriesTimesheetCategories + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tracking_category_id** | **str** | The identifier for the tracking category | [optional] +**tracking_category_name** | **str** | Name of the 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/payrollau/docs/State.md b/xero_python/payrollau/docs/State.md new file mode 100644 index 00000000..9aa446eb --- /dev/null +++ b/xero_python/payrollau/docs/State.md @@ -0,0 +1,9 @@ +# State + +## 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/payrollau/docs/SuperFund.md b/xero_python/payrollau/docs/SuperFund.md new file mode 100644 index 00000000..4cd1ebee --- /dev/null +++ b/xero_python/payrollau/docs/SuperFund.md @@ -0,0 +1,22 @@ +# SuperFund + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**super_fund_id** | **str** | Xero identifier for a super fund | [optional] +**type** | [**SuperFundType**](SuperFundType.md) | | +**name** | **str** | Name of the super fund | [optional] +**abn** | **str** | ABN of the self managed super fund | [optional] +**bsb** | **str** | BSB of the self managed super fund | [optional] +**account_number** | **str** | The account number for the self managed super fund. | [optional] +**account_name** | **str** | The account name for the self managed super fund. | [optional] +**electronic_service_address** | **str** | The electronic service address for the self managed super fund. | [optional] +**employer_number** | **str** | Some funds assign a unique number to each employer | [optional] +**spin** | **str** | The SPIN of the Regulated SuperFund. This field has been deprecated. It will only be present for legacy superfunds. New superfunds will not have a SPIN value. The USI field should be used instead of SPIN. | [optional] +**usi** | **str** | The USI of the Regulated SuperFund | [optional] +**updated_date_utc** | **datetime** | Last modified timestamp | [optional] +**validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [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/payrollau/docs/SuperFundProduct.md b/xero_python/payrollau/docs/SuperFundProduct.md new file mode 100644 index 00000000..795600ba --- /dev/null +++ b/xero_python/payrollau/docs/SuperFundProduct.md @@ -0,0 +1,13 @@ +# SuperFundProduct + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**abn** | **str** | The ABN of the Regulated SuperFund | [optional] +**usi** | **str** | The USI of the Regulated SuperFund | [optional] +**spin** | **str** | The SPIN of the Regulated SuperFund. This field has been deprecated. New superfunds will not have a SPIN value. The USI field should be used instead of SPIN | [optional] +**product_name** | **str** | The name of the Regulated SuperFund | [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/payrollau/docs/SuperFundProducts.md b/xero_python/payrollau/docs/SuperFundProducts.md new file mode 100644 index 00000000..c825d3a9 --- /dev/null +++ b/xero_python/payrollau/docs/SuperFundProducts.md @@ -0,0 +1,10 @@ +# SuperFundProducts + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**super_fund_products** | [**list[SuperFundProduct]**](SuperFundProduct.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/payrollau/docs/SuperFundType.md b/xero_python/payrollau/docs/SuperFundType.md new file mode 100644 index 00000000..3d141a74 --- /dev/null +++ b/xero_python/payrollau/docs/SuperFundType.md @@ -0,0 +1,9 @@ +# SuperFundType + +## 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/payrollau/docs/SuperFunds.md b/xero_python/payrollau/docs/SuperFunds.md new file mode 100644 index 00000000..a0051b29 --- /dev/null +++ b/xero_python/payrollau/docs/SuperFunds.md @@ -0,0 +1,10 @@ +# SuperFunds + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**super_funds** | [**list[SuperFund]**](SuperFund.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/payrollau/docs/SuperLine.md b/xero_python/payrollau/docs/SuperLine.md new file mode 100644 index 00000000..b8901ad1 --- /dev/null +++ b/xero_python/payrollau/docs/SuperLine.md @@ -0,0 +1,17 @@ +# SuperLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**super_membership_id** | **str** | Xero super membership ID | [optional] +**contribution_type** | [**SuperannuationContributionType**](SuperannuationContributionType.md) | | [optional] +**calculation_type** | [**SuperannuationCalculationType**](SuperannuationCalculationType.md) | | [optional] +**minimum_monthly_earnings** | **float** | amount of mimimum earnings | [optional] +**expense_account_code** | **str** | expense account code | [optional] +**liability_account_code** | **str** | liabilty account code | [optional] +**percentage** | **float** | percentage for super line | [optional] +**amount** | **float** | Super membership 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/payrollau/docs/SuperMembership.md b/xero_python/payrollau/docs/SuperMembership.md new file mode 100644 index 00000000..faa4bdf3 --- /dev/null +++ b/xero_python/payrollau/docs/SuperMembership.md @@ -0,0 +1,12 @@ +# SuperMembership + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**super_membership_id** | **str** | Xero unique identifier for Super membership | [optional] +**super_fund_id** | **str** | Xero identifier for super fund | +**employee_number** | **float** | The memberhsip number assigned to the employee by the super fund. | + +[[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/payrollau/docs/SuperannuationCalculationType.md b/xero_python/payrollau/docs/SuperannuationCalculationType.md new file mode 100644 index 00000000..44f1dd3a --- /dev/null +++ b/xero_python/payrollau/docs/SuperannuationCalculationType.md @@ -0,0 +1,9 @@ +# SuperannuationCalculationType + +## 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/payrollau/docs/SuperannuationContributionType.md b/xero_python/payrollau/docs/SuperannuationContributionType.md new file mode 100644 index 00000000..9811d702 --- /dev/null +++ b/xero_python/payrollau/docs/SuperannuationContributionType.md @@ -0,0 +1,9 @@ +# SuperannuationContributionType + +## 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/payrollau/docs/SuperannuationLine.md b/xero_python/payrollau/docs/SuperannuationLine.md new file mode 100644 index 00000000..e802a9bb --- /dev/null +++ b/xero_python/payrollau/docs/SuperannuationLine.md @@ -0,0 +1,18 @@ +# SuperannuationLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**super_membership_id** | **str** | Xero identifier for payroll super fund membership ID. | [optional] +**contribution_type** | [**SuperannuationContributionType**](SuperannuationContributionType.md) | | [optional] +**calculation_type** | [**SuperannuationCalculationType**](SuperannuationCalculationType.md) | | [optional] +**minimum_monthly_earnings** | **float** | Superannuation minimum monthly earnings. | [optional] +**expense_account_code** | **str** | Superannuation expense account code. | [optional] +**liability_account_code** | **str** | Superannuation liability account code | [optional] +**payment_date_for_this_period** | **date** | Superannuation payment date for the current period (YYYY-MM-DD) | [optional] +**percentage** | **float** | Superannuation percentage | [optional] +**amount** | **float** | Superannuation 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/payrollau/docs/TFNExemptionType.md b/xero_python/payrollau/docs/TFNExemptionType.md new file mode 100644 index 00000000..c617d4a9 --- /dev/null +++ b/xero_python/payrollau/docs/TFNExemptionType.md @@ -0,0 +1,9 @@ +# TFNExemptionType + +## 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/payrollau/docs/TaxDeclaration.md b/xero_python/payrollau/docs/TaxDeclaration.md new file mode 100644 index 00000000..fa32278d --- /dev/null +++ b/xero_python/payrollau/docs/TaxDeclaration.md @@ -0,0 +1,25 @@ +# TaxDeclaration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee_id** | **str** | Address line 1 for employee home address | +**employment_basis** | [**EmploymentBasis**](EmploymentBasis.md) | | +**tfn_exemption_type** | [**TFNExemptionType**](TFNExemptionType.md) | | [optional] +**tax_file_number** | **str** | The tax file number e.g 123123123. | [optional] +**australian_resident_for_tax_purposes** | **bool** | If the employee is Australian resident for tax purposes. e.g true or false | [optional] +**residency_status** | [**ResidencyStatus**](ResidencyStatus.md) | | [optional] +**tax_free_threshold_claimed** | **bool** | If tax free threshold claimed. e.g true or false | [optional] +**tax_offset_estimated_amount** | **float** | If has tax offset estimated then the tax offset estimated amount. e.g 100 | [optional] +**has_help_debt** | **bool** | If employee has HECS or HELP debt. e.g true or false | [optional] +**has_sfss_debt** | **bool** | If employee has financial supplement debt. e.g true or false | [optional] +**has_trade_support_loan_debt** | **bool** | If employee has trade support loan. e.g true or false | [optional] +**upward_variation_tax_withholding_amount** | **float** | If the employee has requested that additional tax be withheld each pay run. e.g 50 | [optional] +**eligible_to_receive_leave_loading** | **bool** | If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%). e.g true or false | [optional] +**approved_withholding_variation_percentage** | **float** | If the employee has approved withholding variation. e.g (0 - 100) | [optional] +**has_student_startup_loan** | **bool** | If the employee is eligible for student startup loan rules | [optional] +**updated_date_utc** | **datetime** | Last modified timestamp | [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/payrollau/docs/TaxLine.md b/xero_python/payrollau/docs/TaxLine.md new file mode 100644 index 00000000..93cc7642 --- /dev/null +++ b/xero_python/payrollau/docs/TaxLine.md @@ -0,0 +1,15 @@ +# TaxLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payslip_tax_line_id** | **str** | Xero identifier for payslip tax line ID. | [optional] +**amount** | **float** | The tax line amount | [optional] +**tax_type_name** | **str** | Name of the tax type. | [optional] +**description** | **str** | Description of the tax line. | [optional] +**manual_tax_type** | [**ManualTaxType**](ManualTaxType.md) | | [optional] +**liability_account** | **str** | The tax line liability account code. For posted pay run you should be able to see liability account code | [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/payrollau/docs/Timesheet.md b/xero_python/payrollau/docs/Timesheet.md new file mode 100644 index 00000000..bd37f26b --- /dev/null +++ b/xero_python/payrollau/docs/Timesheet.md @@ -0,0 +1,18 @@ +# Timesheet + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee_id** | **str** | The Xero identifier for an employee | +**start_date** | **date** | Period start date (YYYY-MM-DD) | +**end_date** | **date** | Period end date (YYYY-MM-DD) | +**status** | [**TimesheetStatus**](TimesheetStatus.md) | | [optional] +**hours** | **float** | Timesheet total hours | [optional] +**timesheet_id** | **str** | The Xero identifier for a Payroll Timesheet | [optional] +**timesheet_lines** | [**list[TimesheetLine]**](TimesheetLine.md) | | [optional] +**updated_date_utc** | **datetime** | Last modified timestamp | [optional] +**validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [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/payrollau/docs/TimesheetLine.md b/xero_python/payrollau/docs/TimesheetLine.md new file mode 100644 index 00000000..edc87377 --- /dev/null +++ b/xero_python/payrollau/docs/TimesheetLine.md @@ -0,0 +1,13 @@ +# TimesheetLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**earnings_rate_id** | **str** | The Xero identifier for an Earnings Rate | [optional] +**tracking_item_id** | **str** | The Xero identifier for a Tracking Category. The TrackingOptionID must belong to the TrackingCategory selected as TimesheetCategories under Payroll Settings. | [optional] +**number_of_units** | **list[float]** | The number of units on a timesheet line | [optional] +**updated_date_utc** | **datetime** | Last modified timestamp | [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/payrollau/docs/TimesheetObject.md b/xero_python/payrollau/docs/TimesheetObject.md new file mode 100644 index 00000000..50c816e6 --- /dev/null +++ b/xero_python/payrollau/docs/TimesheetObject.md @@ -0,0 +1,10 @@ +# TimesheetObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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/payrollau/docs/TimesheetStatus.md b/xero_python/payrollau/docs/TimesheetStatus.md new file mode 100644 index 00000000..212b96ff --- /dev/null +++ b/xero_python/payrollau/docs/TimesheetStatus.md @@ -0,0 +1,9 @@ +# TimesheetStatus + +## 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/payrollau/docs/Timesheets.md b/xero_python/payrollau/docs/Timesheets.md new file mode 100644 index 00000000..cc7a7133 --- /dev/null +++ b/xero_python/payrollau/docs/Timesheets.md @@ -0,0 +1,10 @@ +# Timesheets + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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/payrollau/docs/ValidationError.md b/xero_python/payrollau/docs/ValidationError.md new file mode 100644 index 00000000..1e41b99d --- /dev/null +++ b/xero_python/payrollau/docs/ValidationError.md @@ -0,0 +1,10 @@ +# ValidationError + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | Validation error message | [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/payrollau/models/__init__.py b/xero_python/payrollau/models/__init__.py new file mode 100644 index 00000000..595f99a4 --- /dev/null +++ b/xero_python/payrollau/models/__init__.py @@ -0,0 +1,115 @@ +# coding: utf-8 + +# flake8: noqa +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +# import models into model package +from xero_python.payrollau.models.api_exception import APIException +from xero_python.payrollau.models.account import Account +from xero_python.payrollau.models.account_type import AccountType +from xero_python.payrollau.models.allowance_type import AllowanceType +from xero_python.payrollau.models.bank_account import BankAccount +from xero_python.payrollau.models.calendar_type import CalendarType +from xero_python.payrollau.models.deduction_line import DeductionLine +from xero_python.payrollau.models.deduction_type import DeductionType +from xero_python.payrollau.models.deduction_type_calculation_type import ( + DeductionTypeCalculationType, +) +from xero_python.payrollau.models.earnings_line import EarningsLine +from xero_python.payrollau.models.earnings_rate import EarningsRate +from xero_python.payrollau.models.earnings_rate_calculation_type import ( + EarningsRateCalculationType, +) +from xero_python.payrollau.models.earnings_type import EarningsType +from xero_python.payrollau.models.employee import Employee +from xero_python.payrollau.models.employee_status import EmployeeStatus +from xero_python.payrollau.models.employees import Employees +from xero_python.payrollau.models.employment_basis import EmploymentBasis +from xero_python.payrollau.models.employment_termination_payment_type import ( + EmploymentTerminationPaymentType, +) +from xero_python.payrollau.models.entitlement_final_pay_payout_type import ( + EntitlementFinalPayPayoutType, +) +from xero_python.payrollau.models.home_address import HomeAddress +from xero_python.payrollau.models.leave_accrual_line import LeaveAccrualLine +from xero_python.payrollau.models.leave_application import LeaveApplication +from xero_python.payrollau.models.leave_applications import LeaveApplications +from xero_python.payrollau.models.leave_balance import LeaveBalance +from xero_python.payrollau.models.leave_earnings_line import LeaveEarningsLine +from xero_python.payrollau.models.leave_line import LeaveLine +from xero_python.payrollau.models.leave_line_calculation_type import ( + LeaveLineCalculationType, +) +from xero_python.payrollau.models.leave_lines import LeaveLines +from xero_python.payrollau.models.leave_period import LeavePeriod +from xero_python.payrollau.models.leave_period_status import LeavePeriodStatus +from xero_python.payrollau.models.leave_type import LeaveType +from xero_python.payrollau.models.leave_type_contribution_type import ( + LeaveTypeContributionType, +) +from xero_python.payrollau.models.manual_tax_type import ManualTaxType +from xero_python.payrollau.models.opening_balances import OpeningBalances +from xero_python.payrollau.models.pay_item import PayItem +from xero_python.payrollau.models.pay_items import PayItems +from xero_python.payrollau.models.pay_run import PayRun +from xero_python.payrollau.models.pay_run_status import PayRunStatus +from xero_python.payrollau.models.pay_runs import PayRuns +from xero_python.payrollau.models.pay_template import PayTemplate +from xero_python.payrollau.models.payment_frequency_type import PaymentFrequencyType +from xero_python.payrollau.models.payroll_calendar import PayrollCalendar +from xero_python.payrollau.models.payroll_calendars import PayrollCalendars +from xero_python.payrollau.models.payslip import Payslip +from xero_python.payrollau.models.payslip_lines import PayslipLines +from xero_python.payrollau.models.payslip_object import PayslipObject +from xero_python.payrollau.models.payslip_summary import PayslipSummary +from xero_python.payrollau.models.payslips import Payslips +from xero_python.payrollau.models.rate_type import RateType +from xero_python.payrollau.models.reimbursement_line import ReimbursementLine +from xero_python.payrollau.models.reimbursement_lines import ReimbursementLines +from xero_python.payrollau.models.reimbursement_type import ReimbursementType +from xero_python.payrollau.models.residency_status import ResidencyStatus +from xero_python.payrollau.models.settings import Settings +from xero_python.payrollau.models.settings_object import SettingsObject +from xero_python.payrollau.models.settings_tracking_categories import ( + SettingsTrackingCategories, +) +from xero_python.payrollau.models.settings_tracking_categories_employee_groups import ( + SettingsTrackingCategoriesEmployeeGroups, +) +from xero_python.payrollau.models.settings_tracking_categories_timesheet_categories import ( + SettingsTrackingCategoriesTimesheetCategories, +) +from xero_python.payrollau.models.state import State +from xero_python.payrollau.models.super_fund import SuperFund +from xero_python.payrollau.models.super_fund_product import SuperFundProduct +from xero_python.payrollau.models.super_fund_products import SuperFundProducts +from xero_python.payrollau.models.super_fund_type import SuperFundType +from xero_python.payrollau.models.super_funds import SuperFunds +from xero_python.payrollau.models.super_line import SuperLine +from xero_python.payrollau.models.super_membership import SuperMembership +from xero_python.payrollau.models.superannuation_calculation_type import ( + SuperannuationCalculationType, +) +from xero_python.payrollau.models.superannuation_contribution_type import ( + SuperannuationContributionType, +) +from xero_python.payrollau.models.superannuation_line import SuperannuationLine +from xero_python.payrollau.models.tfn_exemption_type import TFNExemptionType +from xero_python.payrollau.models.tax_declaration import TaxDeclaration +from xero_python.payrollau.models.tax_line import TaxLine +from xero_python.payrollau.models.timesheet import Timesheet +from xero_python.payrollau.models.timesheet_line import TimesheetLine +from xero_python.payrollau.models.timesheet_object import TimesheetObject +from xero_python.payrollau.models.timesheet_status import TimesheetStatus +from xero_python.payrollau.models.timesheets import Timesheets +from xero_python.payrollau.models.validation_error import ValidationError diff --git a/xero_python/payrollau/models/account.py b/xero_python/payrollau/models/account.py new file mode 100644 index 00000000..70680dfd --- /dev/null +++ b/xero_python/payrollau/models/account.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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": "AccountType", + "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 + + Xero identifier for accounts # 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. + + Xero identifier for accounts # 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 + + + :return: The type of this Account. # noqa: E501 + :rtype: AccountType + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this Account. + + + :param type: The type of this Account. # noqa: E501 + :type: AccountType + """ + + self._type = type + + @property + def code(self): + """Gets the code of this Account. # noqa: E501 + + Customer defined account code # 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. + + Customer defined account code # 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 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 account # noqa: E501 + + :param name: The name of this Account. # noqa: E501 + :type: str + """ + + self._name = name diff --git a/xero_python/payrollau/models/account_type.py b/xero_python/payrollau/models/account_type.py new file mode 100644 index 00000000..e307d5dc --- /dev/null +++ b/xero_python/payrollau/models/account_type.py @@ -0,0 +1,50 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class AccountType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + BANK = "BANK" + CURRENT = "CURRENT" + CURRLIAB = "CURRLIAB" + DEPRECIATN = "DEPRECIATN" + DIRECTCOSTS = "DIRECTCOSTS" + EQUITY = "EQUITY" + EXPENSE = "EXPENSE" + FIXED = "FIXED" + INVENTORY = "INVENTORY" + LIABILITY = "LIABILITY" + NONCURRENT = "NONCURRENT" + OTHERINCOME = "OTHERINCOME" + OVERHEADS = "OVERHEADS" + PREPAYMENT = "PREPAYMENT" + REVENUE = "REVENUE" + SALES = "SALES" + TERMLIAB = "TERMLIAB" + PAYGLIABILITY = "PAYGLIABILITY" + PAYG = "PAYG" + SUPERANNUATIONEXPENSE = "SUPERANNUATIONEXPENSE" + SUPERANNUATIONLIABILITY = "SUPERANNUATIONLIABILITY" + WAGESEXPENSE = "WAGESEXPENSE" + WAGESPAYABLELIABILITY = "WAGESPAYABLELIABILITY" diff --git a/xero_python/payrollau/models/allowance_type.py b/xero_python/payrollau/models/allowance_type.py new file mode 100644 index 00000000..3701903a --- /dev/null +++ b/xero_python/payrollau/models/allowance_type.py @@ -0,0 +1,34 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class AllowanceType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + CAR = "CAR" + TRANSPORT = "TRANSPORT" + TRAVEL = "TRAVEL" + LAUNDRY = "LAUNDRY" + MEALS = "MEALS" + JOBKEEPER = "JOBKEEPER" + OTHER = "OTHER" diff --git a/xero_python/payrollau/models/api_exception.py b/xero_python/payrollau/models/api_exception.py new file mode 100644 index 00000000..2714e22f --- /dev/null +++ b/xero_python/payrollau/models/api_exception.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class APIException(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 = {"error_number": "float", "type": "str", "message": "str"} + + attribute_map = { + "error_number": "ErrorNumber", + "type": "Type", + "message": "Message", + } + + def __init__(self, error_number=None, type=None, message=None): # noqa: E501 + """APIException - a model defined in OpenAPI""" # noqa: E501 + + self._error_number = None + self._type = None + self._message = None + self.discriminator = None + + if error_number is not None: + self.error_number = error_number + if type is not None: + self.type = type + if message is not None: + self.message = message + + @property + def error_number(self): + """Gets the error_number of this APIException. # noqa: E501 + + The error number # noqa: E501 + + :return: The error_number of this APIException. # noqa: E501 + :rtype: float + """ + return self._error_number + + @error_number.setter + def error_number(self, error_number): + """Sets the error_number of this APIException. + + The error number # noqa: E501 + + :param error_number: The error_number of this APIException. # noqa: E501 + :type: float + """ + + self._error_number = error_number + + @property + def type(self): + """Gets the type of this APIException. # noqa: E501 + + The type of error # noqa: E501 + + :return: The type of this APIException. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this APIException. + + The type of error # noqa: E501 + + :param type: The type of this APIException. # noqa: E501 + :type: str + """ + + self._type = type + + @property + def message(self): + """Gets the message of this APIException. # noqa: E501 + + The message describing the error # noqa: E501 + + :return: The message of this APIException. # noqa: E501 + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """Sets the message of this APIException. + + The message describing the error # noqa: E501 + + :param message: The message of this APIException. # noqa: E501 + :type: str + """ + + self._message = message diff --git a/xero_python/payrollau/models/bank_account.py b/xero_python/payrollau/models/bank_account.py new file mode 100644 index 00000000..e623a1c7 --- /dev/null +++ b/xero_python/payrollau/models/bank_account.py @@ -0,0 +1,219 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = { + "statement_text": "str", + "account_name": "str", + "bsb": "str", + "account_number": "str", + "remainder": "bool", + "amount": "float", + } + + attribute_map = { + "statement_text": "StatementText", + "account_name": "AccountName", + "bsb": "BSB", + "account_number": "AccountNumber", + "remainder": "Remainder", + "amount": "Amount", + } + + def __init__( + self, + statement_text=None, + account_name=None, + bsb=None, + account_number=None, + remainder=None, + amount=None, + ): # noqa: E501 + """BankAccount - a model defined in OpenAPI""" # noqa: E501 + + self._statement_text = None + self._account_name = None + self._bsb = None + self._account_number = None + self._remainder = None + self._amount = None + self.discriminator = None + + if statement_text is not None: + self.statement_text = statement_text + if account_name is not None: + self.account_name = account_name + if bsb is not None: + self.bsb = bsb + if account_number is not None: + self.account_number = account_number + if remainder is not None: + self.remainder = remainder + if amount is not None: + self.amount = amount + + @property + def statement_text(self): + """Gets the statement_text of this BankAccount. # noqa: E501 + + The text that will appear on your employee's bank statement when they receive payment # noqa: E501 + + :return: The statement_text of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._statement_text + + @statement_text.setter + def statement_text(self, statement_text): + """Sets the statement_text of this BankAccount. + + The text that will appear on your employee's bank statement when they receive payment # noqa: E501 + + :param statement_text: The statement_text of this BankAccount. # noqa: E501 + :type: str + """ + + self._statement_text = statement_text + + @property + def account_name(self): + """Gets the account_name of this BankAccount. # noqa: E501 + + The name of the account # 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. + + The name of the account # noqa: E501 + + :param account_name: The account_name of this BankAccount. # noqa: E501 + :type: str + """ + + self._account_name = account_name + + @property + def bsb(self): + """Gets the bsb of this BankAccount. # noqa: E501 + + The BSB number of the account # noqa: E501 + + :return: The bsb of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._bsb + + @bsb.setter + def bsb(self, bsb): + """Sets the bsb of this BankAccount. + + The BSB number of the account # noqa: E501 + + :param bsb: The bsb of this BankAccount. # noqa: E501 + :type: str + """ + + self._bsb = bsb + + @property + def account_number(self): + """Gets the account_number of this BankAccount. # noqa: E501 + + The account number # 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. + + The account number # noqa: E501 + + :param account_number: The account_number of this BankAccount. # noqa: E501 + :type: str + """ + + self._account_number = account_number + + @property + def remainder(self): + """Gets the remainder of this BankAccount. # noqa: E501 + + If this account is the Remaining bank account # noqa: E501 + + :return: The remainder of this BankAccount. # noqa: E501 + :rtype: bool + """ + return self._remainder + + @remainder.setter + def remainder(self, remainder): + """Sets the remainder of this BankAccount. + + If this account is the Remaining bank account # noqa: E501 + + :param remainder: The remainder of this BankAccount. # noqa: E501 + :type: bool + """ + + self._remainder = remainder + + @property + def amount(self): + """Gets the amount of this BankAccount. # noqa: E501 + + Fixed amounts (for example, if an employee wants to have $100 of their salary transferred to one account, and the remaining amount to another) # noqa: E501 + + :return: The amount of this BankAccount. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this BankAccount. + + Fixed amounts (for example, if an employee wants to have $100 of their salary transferred to one account, and the remaining amount to another) # noqa: E501 + + :param amount: The amount of this BankAccount. # noqa: E501 + :type: float + """ + + self._amount = amount diff --git a/xero_python/payrollau/models/calendar_type.py b/xero_python/payrollau/models/calendar_type.py new file mode 100644 index 00000000..8c5ea1e1 --- /dev/null +++ b/xero_python/payrollau/models/calendar_type.py @@ -0,0 +1,33 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class CalendarType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + WEEKLY = "WEEKLY" + FORTNIGHTLY = "FORTNIGHTLY" + FOURWEEKLY = "FOURWEEKLY" + MONTHLY = "MONTHLY" + TWICEMONTHLY = "TWICEMONTHLY" + QUARTERLY = "QUARTERLY" diff --git a/xero_python/payrollau/models/deduction_line.py b/xero_python/payrollau/models/deduction_line.py new file mode 100644 index 00000000..93a4d3d5 --- /dev/null +++ b/xero_python/payrollau/models/deduction_line.py @@ -0,0 +1,194 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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", + "calculation_type": "DeductionTypeCalculationType", + "amount": "float", + "percentage": "float", + "number_of_units": "float", + } + + attribute_map = { + "deduction_type_id": "DeductionTypeID", + "calculation_type": "CalculationType", + "amount": "Amount", + "percentage": "Percentage", + "number_of_units": "NumberOfUnits", + } + + def __init__( + self, + deduction_type_id=None, + calculation_type=None, + amount=None, + percentage=None, + number_of_units=None, + ): # noqa: E501 + """DeductionLine - a model defined in OpenAPI""" # noqa: E501 + + self._deduction_type_id = None + self._calculation_type = None + self._amount = None + self._percentage = None + self._number_of_units = None + self.discriminator = None + + self.deduction_type_id = deduction_type_id + self.calculation_type = calculation_type + if amount is not None: + self.amount = amount + if percentage is not None: + self.percentage = percentage + if number_of_units is not None: + self.number_of_units = number_of_units + + @property + def deduction_type_id(self): + """Gets the deduction_type_id of this DeductionLine. # noqa: E501 + + Xero deduction type identifier # 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 deduction type identifier # noqa: E501 + + :param deduction_type_id: The deduction_type_id of this DeductionLine. # noqa: E501 + :type: str + """ + if deduction_type_id is None: + raise ValueError( + "Invalid value for `deduction_type_id`, must not be `None`" + ) # noqa: E501 + + self._deduction_type_id = deduction_type_id + + @property + def calculation_type(self): + """Gets the calculation_type of this DeductionLine. # noqa: E501 + + + :return: The calculation_type of this DeductionLine. # noqa: E501 + :rtype: DeductionTypeCalculationType + """ + return self._calculation_type + + @calculation_type.setter + def calculation_type(self, calculation_type): + """Sets the calculation_type of this DeductionLine. + + + :param calculation_type: The calculation_type of this DeductionLine. # noqa: E501 + :type: DeductionTypeCalculationType + """ + if calculation_type is None: + raise ValueError( + "Invalid value for `calculation_type`, must not be `None`" + ) # noqa: E501 + + self._calculation_type = calculation_type + + @property + def amount(self): + """Gets the amount of this DeductionLine. # noqa: E501 + + Deduction type amount # 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. + + Deduction type amount # noqa: E501 + + :param amount: The amount of this DeductionLine. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def percentage(self): + """Gets the percentage of this DeductionLine. # noqa: E501 + + The Percentage of the Deduction # 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. + + The Percentage of the Deduction # noqa: E501 + + :param percentage: The percentage of this DeductionLine. # noqa: E501 + :type: float + """ + + self._percentage = percentage + + @property + def number_of_units(self): + """Gets the number_of_units of this DeductionLine. # noqa: E501 + + Deduction number of units # noqa: E501 + + :return: The number_of_units of this DeductionLine. # 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 DeductionLine. + + Deduction number of units # noqa: E501 + + :param number_of_units: The number_of_units of this DeductionLine. # noqa: E501 + :type: float + """ + + self._number_of_units = number_of_units diff --git a/xero_python/payrollau/models/deduction_type.py b/xero_python/payrollau/models/deduction_type.py new file mode 100644 index 00000000..83337e8c --- /dev/null +++ b/xero_python/payrollau/models/deduction_type.py @@ -0,0 +1,316 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class DeductionType(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", + "account_code": "str", + "reduces_tax": "bool", + "reduces_super": "bool", + "is_exempt_from_w1": "bool", + "deduction_type_id": "str", + "updated_date_utc": "datetime[ms-format]", + "deduction_category": "str", + "current_record": "bool", + } + + attribute_map = { + "name": "Name", + "account_code": "AccountCode", + "reduces_tax": "ReducesTax", + "reduces_super": "ReducesSuper", + "is_exempt_from_w1": "IsExemptFromW1", + "deduction_type_id": "DeductionTypeID", + "updated_date_utc": "UpdatedDateUTC", + "deduction_category": "DeductionCategory", + "current_record": "CurrentRecord", + } + + def __init__( + self, + name=None, + account_code=None, + reduces_tax=None, + reduces_super=None, + is_exempt_from_w1=None, + deduction_type_id=None, + updated_date_utc=None, + deduction_category=None, + current_record=None, + ): # noqa: E501 + """DeductionType - a model defined in OpenAPI""" # noqa: E501 + + self._name = None + self._account_code = None + self._reduces_tax = None + self._reduces_super = None + self._is_exempt_from_w1 = None + self._deduction_type_id = None + self._updated_date_utc = None + self._deduction_category = None + self._current_record = None + self.discriminator = None + + if name is not None: + self.name = name + if account_code is not None: + self.account_code = account_code + if reduces_tax is not None: + self.reduces_tax = reduces_tax + if reduces_super is not None: + self.reduces_super = reduces_super + if is_exempt_from_w1 is not None: + self.is_exempt_from_w1 = is_exempt_from_w1 + if deduction_type_id is not None: + self.deduction_type_id = deduction_type_id + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + if deduction_category is not None: + self.deduction_category = deduction_category + if current_record is not None: + self.current_record = current_record + + @property + def name(self): + """Gets the name of this DeductionType. # noqa: E501 + + Name of the earnings rate (max length = 100) # noqa: E501 + + :return: The name of this DeductionType. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this DeductionType. + + Name of the earnings rate (max length = 100) # noqa: E501 + + :param name: The name of this DeductionType. # noqa: E501 + :type: str + """ + if name is not None and len(name) > 100: + raise ValueError( + "Invalid value for `name`, " + "length must be less than or equal to `100`" + ) # noqa: E501 + + self._name = name + + @property + def account_code(self): + """Gets the account_code of this DeductionType. # noqa: E501 + + See Accounts # noqa: E501 + + :return: The account_code of this DeductionType. # noqa: E501 + :rtype: str + """ + return self._account_code + + @account_code.setter + def account_code(self, account_code): + """Sets the account_code of this DeductionType. + + See Accounts # noqa: E501 + + :param account_code: The account_code of this DeductionType. # noqa: E501 + :type: str + """ + + self._account_code = account_code + + @property + def reduces_tax(self): + """Gets the reduces_tax of this DeductionType. # noqa: E501 + + Indicates that this is a pre-tax deduction that will reduce the amount of tax you withhold from an employee. # noqa: E501 + + :return: The reduces_tax of this DeductionType. # noqa: E501 + :rtype: bool + """ + return self._reduces_tax + + @reduces_tax.setter + def reduces_tax(self, reduces_tax): + """Sets the reduces_tax of this DeductionType. + + Indicates that this is a pre-tax deduction that will reduce the amount of tax you withhold from an employee. # noqa: E501 + + :param reduces_tax: The reduces_tax of this DeductionType. # noqa: E501 + :type: bool + """ + + self._reduces_tax = reduces_tax + + @property + def reduces_super(self): + """Gets the reduces_super of this DeductionType. # noqa: E501 + + Most deductions don’t reduce your superannuation guarantee contribution liability, so typically you will not set any value for this. # noqa: E501 + + :return: The reduces_super of this DeductionType. # noqa: E501 + :rtype: bool + """ + return self._reduces_super + + @reduces_super.setter + def reduces_super(self, reduces_super): + """Sets the reduces_super of this DeductionType. + + Most deductions don’t reduce your superannuation guarantee contribution liability, so typically you will not set any value for this. # noqa: E501 + + :param reduces_super: The reduces_super of this DeductionType. # noqa: E501 + :type: bool + """ + + self._reduces_super = reduces_super + + @property + def is_exempt_from_w1(self): + """Gets the is_exempt_from_w1 of this DeductionType. # noqa: E501 + + Boolean to determine if the deduction type is reportable or exempt from W1 # noqa: E501 + + :return: The is_exempt_from_w1 of this DeductionType. # noqa: E501 + :rtype: bool + """ + return self._is_exempt_from_w1 + + @is_exempt_from_w1.setter + def is_exempt_from_w1(self, is_exempt_from_w1): + """Sets the is_exempt_from_w1 of this DeductionType. + + Boolean to determine if the deduction type is reportable or exempt from W1 # noqa: E501 + + :param is_exempt_from_w1: The is_exempt_from_w1 of this DeductionType. # noqa: E501 + :type: bool + """ + + self._is_exempt_from_w1 = is_exempt_from_w1 + + @property + def deduction_type_id(self): + """Gets the deduction_type_id of this DeductionType. # noqa: E501 + + Xero identifier # noqa: E501 + + :return: The deduction_type_id of this DeductionType. # 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 DeductionType. + + Xero identifier # noqa: E501 + + :param deduction_type_id: The deduction_type_id of this DeductionType. # noqa: E501 + :type: str + """ + + self._deduction_type_id = deduction_type_id + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this DeductionType. # noqa: E501 + + Last modified timestamp # noqa: E501 + + :return: The updated_date_utc of this DeductionType. # 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 DeductionType. + + Last modified timestamp # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this DeductionType. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc + + @property + def deduction_category(self): + """Gets the deduction_category of this DeductionType. # noqa: E501 + + + :return: The deduction_category of this DeductionType. # noqa: E501 + :rtype: str + """ + return self._deduction_category + + @deduction_category.setter + def deduction_category(self, deduction_category): + """Sets the deduction_category of this DeductionType. + + + :param deduction_category: The deduction_category of this DeductionType. # noqa: E501 + :type: str + """ + allowed_values = ["NONE", "UNIONFEES", "WORKPLACEGIVING"] # 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 current_record(self): + """Gets the current_record of this DeductionType. # noqa: E501 + + Is the current record # noqa: E501 + + :return: The current_record of this DeductionType. # noqa: E501 + :rtype: bool + """ + return self._current_record + + @current_record.setter + def current_record(self, current_record): + """Sets the current_record of this DeductionType. + + Is the current record # noqa: E501 + + :param current_record: The current_record of this DeductionType. # noqa: E501 + :type: bool + """ + + self._current_record = current_record diff --git a/xero_python/payrollau/models/deduction_type_calculation_type.py b/xero_python/payrollau/models/deduction_type_calculation_type.py new file mode 100644 index 00000000..60a0451f --- /dev/null +++ b/xero_python/payrollau/models/deduction_type_calculation_type.py @@ -0,0 +1,30 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class DeductionTypeCalculationType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + FIXEDAMOUNT = "FIXEDAMOUNT" + PRETAX = "PRETAX" + POSTTAX = "POSTTAX" diff --git a/xero_python/payrollau/models/earnings_line.py b/xero_python/payrollau/models/earnings_line.py new file mode 100644 index 00000000..61f937ae --- /dev/null +++ b/xero_python/payrollau/models/earnings_line.py @@ -0,0 +1,310 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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_rate_id": "str", + "calculation_type": "EarningsRateCalculationType", + "annual_salary": "float", + "number_of_units_per_week": "float", + "rate_per_unit": "float", + "normal_number_of_units": "float", + "amount": "float", + "number_of_units": "float", + "fixed_amount": "float", + } + + attribute_map = { + "earnings_rate_id": "EarningsRateID", + "calculation_type": "CalculationType", + "annual_salary": "AnnualSalary", + "number_of_units_per_week": "NumberOfUnitsPerWeek", + "rate_per_unit": "RatePerUnit", + "normal_number_of_units": "NormalNumberOfUnits", + "amount": "Amount", + "number_of_units": "NumberOfUnits", + "fixed_amount": "FixedAmount", + } + + def __init__( + self, + earnings_rate_id=None, + calculation_type=None, + annual_salary=None, + number_of_units_per_week=None, + rate_per_unit=None, + normal_number_of_units=None, + amount=None, + number_of_units=None, + fixed_amount=None, + ): # noqa: E501 + """EarningsLine - a model defined in OpenAPI""" # noqa: E501 + + self._earnings_rate_id = None + self._calculation_type = None + self._annual_salary = None + self._number_of_units_per_week = None + self._rate_per_unit = None + self._normal_number_of_units = None + self._amount = None + self._number_of_units = None + self._fixed_amount = None + self.discriminator = None + + self.earnings_rate_id = earnings_rate_id + self.calculation_type = calculation_type + if annual_salary is not None: + self.annual_salary = annual_salary + if number_of_units_per_week is not None: + 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 + if normal_number_of_units is not None: + self.normal_number_of_units = normal_number_of_units + if amount is not None: + self.amount = amount + 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 + + @property + def earnings_rate_id(self): + """Gets the earnings_rate_id of this EarningsLine. # noqa: E501 + + Xero unique id for 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 unique id for earnings rate # noqa: E501 + + :param earnings_rate_id: The earnings_rate_id of this EarningsLine. # 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 calculation_type(self): + """Gets the calculation_type of this EarningsLine. # noqa: E501 + + + :return: The calculation_type of this EarningsLine. # noqa: E501 + :rtype: EarningsRateCalculationType + """ + return self._calculation_type + + @calculation_type.setter + def calculation_type(self, calculation_type): + """Sets the calculation_type of this EarningsLine. + + + :param calculation_type: The calculation_type of this EarningsLine. # noqa: E501 + :type: EarningsRateCalculationType + """ + if calculation_type is None: + raise ValueError( + "Invalid value for `calculation_type`, must not be `None`" + ) # noqa: E501 + + self._calculation_type = calculation_type + + @property + def annual_salary(self): + """Gets the annual_salary of this EarningsLine. # noqa: E501 + + Annual salary for earnings line # noqa: E501 + + :return: The annual_salary of this EarningsLine. # noqa: E501 + :rtype: float + """ + return self._annual_salary + + @annual_salary.setter + def annual_salary(self, annual_salary): + """Sets the annual_salary of this EarningsLine. + + Annual salary for earnings line # noqa: E501 + + :param annual_salary: The annual_salary of this EarningsLine. # noqa: E501 + :type: float + """ + + self._annual_salary = annual_salary + + @property + def number_of_units_per_week(self): + """Gets the number_of_units_per_week of this EarningsLine. # noqa: E501 + + number of units for earning line # noqa: E501 + + :return: The number_of_units_per_week of this EarningsLine. # 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 EarningsLine. + + number of units for earning line # noqa: E501 + + :param number_of_units_per_week: The number_of_units_per_week of this EarningsLine. # noqa: E501 + :type: float + """ + + self._number_of_units_per_week = number_of_units_per_week + + @property + def rate_per_unit(self): + """Gets the rate_per_unit of this EarningsLine. # noqa: E501 + + Rate per unit of the EarningsLine. # 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 of the EarningsLine. # 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 normal_number_of_units(self): + """Gets the normal_number_of_units of this EarningsLine. # noqa: E501 + + Normal number of units for EarningsLine. Applicable when RateType is \"MULTIPLE\" # noqa: E501 + + :return: The normal_number_of_units of this EarningsLine. # noqa: E501 + :rtype: float + """ + return self._normal_number_of_units + + @normal_number_of_units.setter + def normal_number_of_units(self, normal_number_of_units): + """Sets the normal_number_of_units of this EarningsLine. + + Normal number of units for EarningsLine. Applicable when RateType is \"MULTIPLE\" # noqa: E501 + + :param normal_number_of_units: The normal_number_of_units of this EarningsLine. # noqa: E501 + :type: float + """ + + self._normal_number_of_units = normal_number_of_units + + @property + def amount(self): + """Gets the amount of this EarningsLine. # noqa: E501 + + Earnings rate amount # 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. + + Earnings rate amount # noqa: E501 + + :param amount: The amount of this EarningsLine. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def number_of_units(self): + """Gets the number_of_units of this EarningsLine. # noqa: E501 + + Earnings rate 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 rate 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 rate 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 rate 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 diff --git a/xero_python/payrollau/models/earnings_rate.py b/xero_python/payrollau/models/earnings_rate.py new file mode 100644 index 00000000..b12f6e4b --- /dev/null +++ b/xero_python/payrollau/models/earnings_rate.py @@ -0,0 +1,542 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = { + "name": "str", + "account_code": "str", + "type_of_units": "str", + "is_exempt_from_tax": "bool", + "is_exempt_from_super": "bool", + "is_reportable_as_w1": "bool", + "earnings_type": "EarningsType", + "earnings_rate_id": "str", + "rate_type": "RateType", + "rate_per_unit": "str", + "multiplier": "float", + "accrue_leave": "bool", + "amount": "float", + "employment_termination_payment_type": "EmploymentTerminationPaymentType", + "updated_date_utc": "datetime[ms-format]", + "current_record": "bool", + "allowance_type": "AllowanceType", + } + + attribute_map = { + "name": "Name", + "account_code": "AccountCode", + "type_of_units": "TypeOfUnits", + "is_exempt_from_tax": "IsExemptFromTax", + "is_exempt_from_super": "IsExemptFromSuper", + "is_reportable_as_w1": "IsReportableAsW1", + "earnings_type": "EarningsType", + "earnings_rate_id": "EarningsRateID", + "rate_type": "RateType", + "rate_per_unit": "RatePerUnit", + "multiplier": "Multiplier", + "accrue_leave": "AccrueLeave", + "amount": "Amount", + "employment_termination_payment_type": "EmploymentTerminationPaymentType", + "updated_date_utc": "UpdatedDateUTC", + "current_record": "CurrentRecord", + "allowance_type": "AllowanceType", + } + + def __init__( + self, + name=None, + account_code=None, + type_of_units=None, + is_exempt_from_tax=None, + is_exempt_from_super=None, + is_reportable_as_w1=None, + earnings_type=None, + earnings_rate_id=None, + rate_type=None, + rate_per_unit=None, + multiplier=None, + accrue_leave=None, + amount=None, + employment_termination_payment_type=None, + updated_date_utc=None, + current_record=None, + allowance_type=None, + ): # noqa: E501 + """EarningsRate - a model defined in OpenAPI""" # noqa: E501 + + self._name = None + self._account_code = None + self._type_of_units = None + self._is_exempt_from_tax = None + self._is_exempt_from_super = None + self._is_reportable_as_w1 = None + self._earnings_type = None + self._earnings_rate_id = None + self._rate_type = None + self._rate_per_unit = None + self._multiplier = None + self._accrue_leave = None + self._amount = None + self._employment_termination_payment_type = None + self._updated_date_utc = None + self._current_record = None + self._allowance_type = None + self.discriminator = None + + if name is not None: + self.name = name + if account_code is not None: + self.account_code = account_code + if type_of_units is not None: + self.type_of_units = type_of_units + if is_exempt_from_tax is not None: + self.is_exempt_from_tax = is_exempt_from_tax + if is_exempt_from_super is not None: + self.is_exempt_from_super = is_exempt_from_super + if is_reportable_as_w1 is not None: + self.is_reportable_as_w1 = is_reportable_as_w1 + if earnings_type is not None: + self.earnings_type = earnings_type + if earnings_rate_id is not None: + self.earnings_rate_id = earnings_rate_id + if rate_type is not None: + self.rate_type = rate_type + if rate_per_unit is not None: + self.rate_per_unit = rate_per_unit + if multiplier is not None: + self.multiplier = multiplier + if accrue_leave is not None: + self.accrue_leave = accrue_leave + if amount is not None: + self.amount = amount + if employment_termination_payment_type is not None: + self.employment_termination_payment_type = ( + employment_termination_payment_type + ) + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + if current_record is not None: + self.current_record = current_record + if allowance_type is not None: + self.allowance_type = allowance_type + + @property + def name(self): + """Gets the name of this EarningsRate. # noqa: E501 + + Name of the earnings rate (max length = 100) # 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 earnings rate (max length = 100) # noqa: E501 + + :param name: The name of this EarningsRate. # noqa: E501 + :type: str + """ + if name is not None and len(name) > 100: + raise ValueError( + "Invalid value for `name`, " + "length must be less than or equal to `100`" + ) # noqa: E501 + + self._name = name + + @property + def account_code(self): + """Gets the account_code of this EarningsRate. # noqa: E501 + + See Accounts # noqa: E501 + + :return: The account_code of this EarningsRate. # noqa: E501 + :rtype: str + """ + return self._account_code + + @account_code.setter + def account_code(self, account_code): + """Sets the account_code of this EarningsRate. + + See Accounts # noqa: E501 + + :param account_code: The account_code of this EarningsRate. # noqa: E501 + :type: str + """ + + self._account_code = account_code + + @property + def type_of_units(self): + """Gets the type_of_units of this EarningsRate. # noqa: E501 + + Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT # 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. + + Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT # noqa: E501 + + :param type_of_units: The type_of_units of this EarningsRate. # noqa: E501 + :type: str + """ + if type_of_units is not None and len(type_of_units) > 50: + raise ValueError( + "Invalid value for `type_of_units`, " + "length must be less than or equal to `50`" + ) # noqa: E501 + + self._type_of_units = type_of_units + + @property + def is_exempt_from_tax(self): + """Gets the is_exempt_from_tax of this EarningsRate. # noqa: E501 + + Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholding # noqa: E501 + + :return: The is_exempt_from_tax of this EarningsRate. # noqa: E501 + :rtype: bool + """ + return self._is_exempt_from_tax + + @is_exempt_from_tax.setter + def is_exempt_from_tax(self, is_exempt_from_tax): + """Sets the is_exempt_from_tax of this EarningsRate. + + Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholding # noqa: E501 + + :param is_exempt_from_tax: The is_exempt_from_tax of this EarningsRate. # noqa: E501 + :type: bool + """ + + self._is_exempt_from_tax = is_exempt_from_tax + + @property + def is_exempt_from_super(self): + """Gets the is_exempt_from_super of this EarningsRate. # noqa: E501 + + See the ATO website for details of which payments are exempt from SGC # noqa: E501 + + :return: The is_exempt_from_super of this EarningsRate. # noqa: E501 + :rtype: bool + """ + return self._is_exempt_from_super + + @is_exempt_from_super.setter + def is_exempt_from_super(self, is_exempt_from_super): + """Sets the is_exempt_from_super of this EarningsRate. + + See the ATO website for details of which payments are exempt from SGC # noqa: E501 + + :param is_exempt_from_super: The is_exempt_from_super of this EarningsRate. # noqa: E501 + :type: bool + """ + + self._is_exempt_from_super = is_exempt_from_super + + @property + def is_reportable_as_w1(self): + """Gets the is_reportable_as_w1 of this EarningsRate. # noqa: E501 + + Boolean to determine if the earnings rate is reportable or exempt from W1 # noqa: E501 + + :return: The is_reportable_as_w1 of this EarningsRate. # noqa: E501 + :rtype: bool + """ + return self._is_reportable_as_w1 + + @is_reportable_as_w1.setter + def is_reportable_as_w1(self, is_reportable_as_w1): + """Sets the is_reportable_as_w1 of this EarningsRate. + + Boolean to determine if the earnings rate is reportable or exempt from W1 # noqa: E501 + + :param is_reportable_as_w1: The is_reportable_as_w1 of this EarningsRate. # noqa: E501 + :type: bool + """ + + self._is_reportable_as_w1 = is_reportable_as_w1 + + @property + def earnings_type(self): + """Gets the earnings_type of this EarningsRate. # noqa: E501 + + + :return: The earnings_type of this EarningsRate. # noqa: E501 + :rtype: EarningsType + """ + return self._earnings_type + + @earnings_type.setter + def earnings_type(self, earnings_type): + """Sets the earnings_type of this EarningsRate. + + + :param earnings_type: The earnings_type of this EarningsRate. # noqa: E501 + :type: EarningsType + """ + + self._earnings_type = earnings_type + + @property + def earnings_rate_id(self): + """Gets the earnings_rate_id of this EarningsRate. # noqa: E501 + + Xero identifier # 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 identifier # 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 rate_type(self): + """Gets the rate_type of this EarningsRate. # noqa: E501 + + + :return: The rate_type of this EarningsRate. # noqa: E501 + :rtype: RateType + """ + return self._rate_type + + @rate_type.setter + def rate_type(self, rate_type): + """Sets the rate_type of this EarningsRate. + + + :param rate_type: The rate_type of this EarningsRate. # noqa: E501 + :type: RateType + """ + + self._rate_type = rate_type + + @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: str + """ + 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: str + """ + + self._rate_per_unit = rate_per_unit + + @property + def multiplier(self): + """Gets the multiplier 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 MULTIPLE # noqa: E501 + + :return: The multiplier of this EarningsRate. # noqa: E501 + :rtype: float + """ + return self._multiplier + + @multiplier.setter + def multiplier(self, multiplier): + """Sets the multiplier 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 MULTIPLE # noqa: E501 + + :param multiplier: The multiplier of this EarningsRate. # noqa: E501 + :type: float + """ + + self._multiplier = multiplier + + @property + def accrue_leave(self): + """Gets the accrue_leave of this EarningsRate. # noqa: E501 + + Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE # noqa: E501 + + :return: The accrue_leave of this EarningsRate. # noqa: E501 + :rtype: bool + """ + return self._accrue_leave + + @accrue_leave.setter + def accrue_leave(self, accrue_leave): + """Sets the accrue_leave of this EarningsRate. + + Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE # noqa: E501 + + :param accrue_leave: The accrue_leave of this EarningsRate. # noqa: E501 + :type: bool + """ + + self._accrue_leave = accrue_leave + + @property + def amount(self): + """Gets the amount of this EarningsRate. # noqa: E501 + + Optional Amount for FIXEDAMOUNT RateType EarningsRate # noqa: E501 + + :return: The amount of this EarningsRate. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this EarningsRate. + + Optional Amount for FIXEDAMOUNT RateType EarningsRate # noqa: E501 + + :param amount: The amount of this EarningsRate. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def employment_termination_payment_type(self): + """Gets the employment_termination_payment_type of this EarningsRate. # noqa: E501 + + + :return: The employment_termination_payment_type of this EarningsRate. # noqa: E501 + :rtype: EmploymentTerminationPaymentType + """ + return self._employment_termination_payment_type + + @employment_termination_payment_type.setter + def employment_termination_payment_type(self, employment_termination_payment_type): + """Sets the employment_termination_payment_type of this EarningsRate. + + + :param employment_termination_payment_type: The employment_termination_payment_type of this EarningsRate. # noqa: E501 + :type: EmploymentTerminationPaymentType + """ + + self._employment_termination_payment_type = employment_termination_payment_type + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this EarningsRate. # noqa: E501 + + Last modified timestamp # noqa: E501 + + :return: The updated_date_utc of this EarningsRate. # 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 EarningsRate. + + Last modified timestamp # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this EarningsRate. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc + + @property + def current_record(self): + """Gets the current_record of this EarningsRate. # noqa: E501 + + Is the current record # 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. + + Is the current record # noqa: E501 + + :param current_record: The current_record of this EarningsRate. # noqa: E501 + :type: bool + """ + + self._current_record = current_record + + @property + def allowance_type(self): + """Gets the allowance_type of this EarningsRate. # noqa: E501 + + + :return: The allowance_type of this EarningsRate. # noqa: E501 + :rtype: AllowanceType + """ + return self._allowance_type + + @allowance_type.setter + def allowance_type(self, allowance_type): + """Sets the allowance_type of this EarningsRate. + + + :param allowance_type: The allowance_type of this EarningsRate. # noqa: E501 + :type: AllowanceType + """ + + self._allowance_type = allowance_type diff --git a/xero_python/payrollau/models/earnings_rate_calculation_type.py b/xero_python/payrollau/models/earnings_rate_calculation_type.py new file mode 100644 index 00000000..c919e9da --- /dev/null +++ b/xero_python/payrollau/models/earnings_rate_calculation_type.py @@ -0,0 +1,30 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class EarningsRateCalculationType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + USEEARNINGSRATE = "USEEARNINGSRATE" + ENTEREARNINGSRATE = "ENTEREARNINGSRATE" + ANNUALSALARY = "ANNUALSALARY" diff --git a/xero_python/payrollau/models/earnings_type.py b/xero_python/payrollau/models/earnings_type.py new file mode 100644 index 00000000..35efeabc --- /dev/null +++ b/xero_python/payrollau/models/earnings_type.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class EarningsType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + FIXED = "FIXED" + ORDINARYTIMEEARNINGS = "ORDINARYTIMEEARNINGS" + OVERTIMEEARNINGS = "OVERTIMEEARNINGS" + ALLOWANCE = "ALLOWANCE" + LUMPSUMD = "LUMPSUMD" + EMPLOYMENTTERMINATIONPAYMENT = "EMPLOYMENTTERMINATIONPAYMENT" + LUMPSUMA = "LUMPSUMA" + LUMPSUMB = "LUMPSUMB" diff --git a/xero_python/payrollau/models/employee.py b/xero_python/payrollau/models/employee.py new file mode 100644 index 00000000..58e6c7a1 --- /dev/null +++ b/xero_python/payrollau/models/employee.py @@ -0,0 +1,944 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = { + "first_name": "str", + "last_name": "str", + "date_of_birth": "date[ms-format]", + "home_address": "HomeAddress", + "start_date": "date[ms-format]", + "title": "str", + "middle_names": "str", + "email": "str", + "gender": "str", + "phone": "str", + "mobile": "str", + "twitter_user_name": "str", + "is_authorised_to_approve_leave": "bool", + "is_authorised_to_approve_timesheets": "bool", + "job_title": "str", + "classification": "str", + "ordinary_earnings_rate_id": "str", + "payroll_calendar_id": "str", + "employee_group_name": "str", + "employee_id": "str", + "termination_date": "date[ms-format]", + "bank_accounts": "list[BankAccount]", + "pay_template": "PayTemplate", + "opening_balances": "OpeningBalances", + "tax_declaration": "TaxDeclaration", + "leave_balances": "list[LeaveBalance]", + "leave_lines": "list[LeaveLine]", + "super_memberships": "list[SuperMembership]", + "status": "EmployeeStatus", + "updated_date_utc": "datetime[ms-format]", + "validation_errors": "list[ValidationError]", + } + + attribute_map = { + "first_name": "FirstName", + "last_name": "LastName", + "date_of_birth": "DateOfBirth", + "home_address": "HomeAddress", + "start_date": "StartDate", + "title": "Title", + "middle_names": "MiddleNames", + "email": "Email", + "gender": "Gender", + "phone": "Phone", + "mobile": "Mobile", + "twitter_user_name": "TwitterUserName", + "is_authorised_to_approve_leave": "IsAuthorisedToApproveLeave", + "is_authorised_to_approve_timesheets": "IsAuthorisedToApproveTimesheets", + "job_title": "JobTitle", + "classification": "Classification", + "ordinary_earnings_rate_id": "OrdinaryEarningsRateID", + "payroll_calendar_id": "PayrollCalendarID", + "employee_group_name": "EmployeeGroupName", + "employee_id": "EmployeeID", + "termination_date": "TerminationDate", + "bank_accounts": "BankAccounts", + "pay_template": "PayTemplate", + "opening_balances": "OpeningBalances", + "tax_declaration": "TaxDeclaration", + "leave_balances": "LeaveBalances", + "leave_lines": "LeaveLines", + "super_memberships": "SuperMemberships", + "status": "Status", + "updated_date_utc": "UpdatedDateUTC", + "validation_errors": "ValidationErrors", + } + + def __init__( + self, + first_name=None, + last_name=None, + date_of_birth=None, + home_address=None, + start_date=None, + title=None, + middle_names=None, + email=None, + gender=None, + phone=None, + mobile=None, + twitter_user_name=None, + is_authorised_to_approve_leave=None, + is_authorised_to_approve_timesheets=None, + job_title=None, + classification=None, + ordinary_earnings_rate_id=None, + payroll_calendar_id=None, + employee_group_name=None, + employee_id=None, + termination_date=None, + bank_accounts=None, + pay_template=None, + opening_balances=None, + tax_declaration=None, + leave_balances=None, + leave_lines=None, + super_memberships=None, + status=None, + updated_date_utc=None, + validation_errors=None, + ): # noqa: E501 + """Employee - a model defined in OpenAPI""" # noqa: E501 + + self._first_name = None + self._last_name = None + self._date_of_birth = None + self._home_address = None + self._start_date = None + self._title = None + self._middle_names = None + self._email = None + self._gender = None + self._phone = None + self._mobile = None + self._twitter_user_name = None + self._is_authorised_to_approve_leave = None + self._is_authorised_to_approve_timesheets = None + self._job_title = None + self._classification = None + self._ordinary_earnings_rate_id = None + self._payroll_calendar_id = None + self._employee_group_name = None + self._employee_id = None + self._termination_date = None + self._bank_accounts = None + self._pay_template = None + self._opening_balances = None + self._tax_declaration = None + self._leave_balances = None + self._leave_lines = None + self._super_memberships = None + self._status = None + self._updated_date_utc = None + self._validation_errors = None + self.discriminator = None + + self.first_name = first_name + self.last_name = last_name + self.date_of_birth = date_of_birth + if home_address is not None: + self.home_address = home_address + if start_date is not None: + self.start_date = start_date + if title is not None: + self.title = title + if middle_names is not None: + self.middle_names = middle_names + if email is not None: + self.email = email + if gender is not None: + self.gender = gender + if phone is not None: + self.phone = phone + if mobile is not None: + self.mobile = mobile + if twitter_user_name is not None: + self.twitter_user_name = twitter_user_name + if is_authorised_to_approve_leave is not None: + self.is_authorised_to_approve_leave = is_authorised_to_approve_leave + if is_authorised_to_approve_timesheets is not None: + self.is_authorised_to_approve_timesheets = ( + is_authorised_to_approve_timesheets + ) + if job_title is not None: + self.job_title = job_title + if classification is not None: + self.classification = classification + if ordinary_earnings_rate_id is not None: + self.ordinary_earnings_rate_id = ordinary_earnings_rate_id + if payroll_calendar_id is not None: + self.payroll_calendar_id = payroll_calendar_id + if employee_group_name is not None: + self.employee_group_name = employee_group_name + if employee_id is not None: + self.employee_id = employee_id + if termination_date is not None: + self.termination_date = termination_date + if bank_accounts is not None: + self.bank_accounts = bank_accounts + if pay_template is not None: + self.pay_template = pay_template + if opening_balances is not None: + self.opening_balances = opening_balances + if tax_declaration is not None: + self.tax_declaration = tax_declaration + if leave_balances is not None: + self.leave_balances = leave_balances + if leave_lines is not None: + self.leave_lines = leave_lines + if super_memberships is not None: + self.super_memberships = super_memberships + if status is not None: + self.status = status + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + if validation_errors is not None: + self.validation_errors = validation_errors + + @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 + """ + if first_name is None: + raise ValueError( + "Invalid value for `first_name`, must not be `None`" + ) # noqa: E501 + + 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 + """ + if last_name is None: + raise ValueError( + "Invalid value for `last_name`, must not be `None`" + ) # noqa: E501 + + 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 + """ + if date_of_birth is None: + raise ValueError( + "Invalid value for `date_of_birth`, must not be `None`" + ) # noqa: E501 + + self._date_of_birth = date_of_birth + + @property + def home_address(self): + """Gets the home_address of this Employee. # noqa: E501 + + + :return: The home_address of this Employee. # noqa: E501 + :rtype: HomeAddress + """ + return self._home_address + + @home_address.setter + def home_address(self, home_address): + """Sets the home_address of this Employee. + + + :param home_address: The home_address of this Employee. # noqa: E501 + :type: HomeAddress + """ + + self._home_address = home_address + + @property + def start_date(self): + """Gets the start_date of this Employee. # noqa: E501 + + Start date for an employee (YYYY-MM-DD) # 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. + + Start date for an employee (YYYY-MM-DD) # noqa: E501 + + :param start_date: The start_date of this Employee. # noqa: E501 + :type: date + """ + + self._start_date = start_date + + @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 middle_names(self): + """Gets the middle_names of this Employee. # noqa: E501 + + Middle name(s) of the employee # noqa: E501 + + :return: The middle_names of this Employee. # noqa: E501 + :rtype: str + """ + return self._middle_names + + @middle_names.setter + def middle_names(self, middle_names): + """Sets the middle_names of this Employee. + + Middle name(s) of the employee # noqa: E501 + + :param middle_names: The middle_names of this Employee. # noqa: E501 + :type: str + """ + + self._middle_names = middle_names + + @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. See Employee 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. See Employee Gender # noqa: E501 + + :param gender: The gender of this Employee. # noqa: E501 + :type: str + """ + allowed_values = ["N", "M", "F", "I"] # 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(self): + """Gets the phone of this Employee. # noqa: E501 + + Employee phone number # noqa: E501 + + :return: The phone of this Employee. # noqa: E501 + :rtype: str + """ + return self._phone + + @phone.setter + def phone(self, phone): + """Sets the phone of this Employee. + + Employee phone number # noqa: E501 + + :param phone: The phone of this Employee. # noqa: E501 + :type: str + """ + + self._phone = phone + + @property + def mobile(self): + """Gets the mobile of this Employee. # noqa: E501 + + Employee mobile number # noqa: E501 + + :return: The mobile of this Employee. # noqa: E501 + :rtype: str + """ + return self._mobile + + @mobile.setter + def mobile(self, mobile): + """Sets the mobile of this Employee. + + Employee mobile number # noqa: E501 + + :param mobile: The mobile of this Employee. # noqa: E501 + :type: str + """ + + self._mobile = mobile + + @property + def twitter_user_name(self): + """Gets the twitter_user_name of this Employee. # noqa: E501 + + Employee’s twitter name # noqa: E501 + + :return: The twitter_user_name of this Employee. # noqa: E501 + :rtype: str + """ + return self._twitter_user_name + + @twitter_user_name.setter + def twitter_user_name(self, twitter_user_name): + """Sets the twitter_user_name of this Employee. + + Employee’s twitter name # noqa: E501 + + :param twitter_user_name: The twitter_user_name of this Employee. # noqa: E501 + :type: str + """ + + self._twitter_user_name = twitter_user_name + + @property + def is_authorised_to_approve_leave(self): + """Gets the is_authorised_to_approve_leave of this Employee. # noqa: E501 + + Authorised to approve other employees' leave requests # noqa: E501 + + :return: The is_authorised_to_approve_leave of this Employee. # noqa: E501 + :rtype: bool + """ + return self._is_authorised_to_approve_leave + + @is_authorised_to_approve_leave.setter + def is_authorised_to_approve_leave(self, is_authorised_to_approve_leave): + """Sets the is_authorised_to_approve_leave of this Employee. + + Authorised to approve other employees' leave requests # noqa: E501 + + :param is_authorised_to_approve_leave: The is_authorised_to_approve_leave of this Employee. # noqa: E501 + :type: bool + """ + + self._is_authorised_to_approve_leave = is_authorised_to_approve_leave + + @property + def is_authorised_to_approve_timesheets(self): + """Gets the is_authorised_to_approve_timesheets of this Employee. # noqa: E501 + + Authorised to approve timesheets # noqa: E501 + + :return: The is_authorised_to_approve_timesheets of this Employee. # noqa: E501 + :rtype: bool + """ + return self._is_authorised_to_approve_timesheets + + @is_authorised_to_approve_timesheets.setter + def is_authorised_to_approve_timesheets(self, is_authorised_to_approve_timesheets): + """Sets the is_authorised_to_approve_timesheets of this Employee. + + Authorised to approve timesheets # noqa: E501 + + :param is_authorised_to_approve_timesheets: The is_authorised_to_approve_timesheets of this Employee. # noqa: E501 + :type: bool + """ + + self._is_authorised_to_approve_timesheets = is_authorised_to_approve_timesheets + + @property + def job_title(self): + """Gets the job_title of this Employee. # noqa: E501 + + JobTitle of the employee # noqa: E501 + + :return: The job_title of this Employee. # noqa: E501 + :rtype: str + """ + return self._job_title + + @job_title.setter + def job_title(self, job_title): + """Sets the job_title of this Employee. + + JobTitle of the employee # noqa: E501 + + :param job_title: The job_title of this Employee. # noqa: E501 + :type: str + """ + + self._job_title = job_title + + @property + def classification(self): + """Gets the classification of this Employee. # noqa: E501 + + Employees classification # noqa: E501 + + :return: The classification of this Employee. # noqa: E501 + :rtype: str + """ + return self._classification + + @classification.setter + def classification(self, classification): + """Sets the classification of this Employee. + + Employees classification # noqa: E501 + + :param classification: The classification of this Employee. # noqa: E501 + :type: str + """ + + self._classification = classification + + @property + def ordinary_earnings_rate_id(self): + """Gets the ordinary_earnings_rate_id of this Employee. # noqa: E501 + + Xero unique identifier for earnings rate # noqa: E501 + + :return: The ordinary_earnings_rate_id of this Employee. # noqa: E501 + :rtype: str + """ + return self._ordinary_earnings_rate_id + + @ordinary_earnings_rate_id.setter + def ordinary_earnings_rate_id(self, ordinary_earnings_rate_id): + """Sets the ordinary_earnings_rate_id of this Employee. + + Xero unique identifier for earnings rate # noqa: E501 + + :param ordinary_earnings_rate_id: The ordinary_earnings_rate_id of this Employee. # noqa: E501 + :type: str + """ + + self._ordinary_earnings_rate_id = ordinary_earnings_rate_id + + @property + def payroll_calendar_id(self): + """Gets the payroll_calendar_id of this Employee. # noqa: E501 + + Xero unique identifier for payroll calendar for 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 payroll calendar for 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 employee_group_name(self): + """Gets the employee_group_name of this Employee. # noqa: E501 + + The Employee Group allows you to report on payroll expenses and liabilities for each group of employees # noqa: E501 + + :return: The employee_group_name of this Employee. # noqa: E501 + :rtype: str + """ + return self._employee_group_name + + @employee_group_name.setter + def employee_group_name(self, employee_group_name): + """Sets the employee_group_name of this Employee. + + The Employee Group allows you to report on payroll expenses and liabilities for each group of employees # noqa: E501 + + :param employee_group_name: The employee_group_name of this Employee. # noqa: E501 + :type: str + """ + + self._employee_group_name = employee_group_name + + @property + def employee_id(self): + """Gets the employee_id of this Employee. # noqa: E501 + + Xero unique identifier for an 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 an Employee # noqa: E501 + + :param employee_id: The employee_id of this Employee. # noqa: E501 + :type: str + """ + + self._employee_id = employee_id + + @property + def termination_date(self): + """Gets the termination_date of this Employee. # noqa: E501 + + Employee Termination Date (YYYY-MM-DD) # noqa: E501 + + :return: The termination_date of this Employee. # noqa: E501 + :rtype: date + """ + return self._termination_date + + @termination_date.setter + def termination_date(self, termination_date): + """Sets the termination_date of this Employee. + + Employee Termination Date (YYYY-MM-DD) # noqa: E501 + + :param termination_date: The termination_date of this Employee. # noqa: E501 + :type: date + """ + + self._termination_date = termination_date + + @property + def bank_accounts(self): + """Gets the bank_accounts of this Employee. # noqa: E501 + + + :return: The bank_accounts of this Employee. # noqa: E501 + :rtype: list[BankAccount] + """ + return self._bank_accounts + + @bank_accounts.setter + def bank_accounts(self, bank_accounts): + """Sets the bank_accounts of this Employee. + + + :param bank_accounts: The bank_accounts of this Employee. # noqa: E501 + :type: list[BankAccount] + """ + + self._bank_accounts = bank_accounts + + @property + def pay_template(self): + """Gets the pay_template of this Employee. # noqa: E501 + + + :return: The pay_template of this Employee. # noqa: E501 + :rtype: PayTemplate + """ + return self._pay_template + + @pay_template.setter + def pay_template(self, pay_template): + """Sets the pay_template of this Employee. + + + :param pay_template: The pay_template of this Employee. # noqa: E501 + :type: PayTemplate + """ + + self._pay_template = pay_template + + @property + def opening_balances(self): + """Gets the opening_balances of this Employee. # noqa: E501 + + + :return: The opening_balances of this Employee. # noqa: E501 + :rtype: OpeningBalances + """ + return self._opening_balances + + @opening_balances.setter + def opening_balances(self, opening_balances): + """Sets the opening_balances of this Employee. + + + :param opening_balances: The opening_balances of this Employee. # noqa: E501 + :type: OpeningBalances + """ + + self._opening_balances = opening_balances + + @property + def tax_declaration(self): + """Gets the tax_declaration of this Employee. # noqa: E501 + + + :return: The tax_declaration of this Employee. # noqa: E501 + :rtype: TaxDeclaration + """ + return self._tax_declaration + + @tax_declaration.setter + def tax_declaration(self, tax_declaration): + """Sets the tax_declaration of this Employee. + + + :param tax_declaration: The tax_declaration of this Employee. # noqa: E501 + :type: TaxDeclaration + """ + + self._tax_declaration = tax_declaration + + @property + def leave_balances(self): + """Gets the leave_balances of this Employee. # noqa: E501 + + + :return: The leave_balances of this Employee. # noqa: E501 + :rtype: list[LeaveBalance] + """ + return self._leave_balances + + @leave_balances.setter + def leave_balances(self, leave_balances): + """Sets the leave_balances of this Employee. + + + :param leave_balances: The leave_balances of this Employee. # noqa: E501 + :type: list[LeaveBalance] + """ + + self._leave_balances = leave_balances + + @property + def leave_lines(self): + """Gets the leave_lines of this Employee. # noqa: E501 + + + :return: The leave_lines of this Employee. # noqa: E501 + :rtype: list[LeaveLine] + """ + return self._leave_lines + + @leave_lines.setter + def leave_lines(self, leave_lines): + """Sets the leave_lines of this Employee. + + + :param leave_lines: The leave_lines of this Employee. # noqa: E501 + :type: list[LeaveLine] + """ + + self._leave_lines = leave_lines + + @property + def super_memberships(self): + """Gets the super_memberships of this Employee. # noqa: E501 + + + :return: The super_memberships of this Employee. # noqa: E501 + :rtype: list[SuperMembership] + """ + return self._super_memberships + + @super_memberships.setter + def super_memberships(self, super_memberships): + """Sets the super_memberships of this Employee. + + + :param super_memberships: The super_memberships of this Employee. # noqa: E501 + :type: list[SuperMembership] + """ + + self._super_memberships = super_memberships + + @property + def status(self): + """Gets the status of this Employee. # noqa: E501 + + + :return: The status of this Employee. # noqa: E501 + :rtype: EmployeeStatus + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this Employee. + + + :param status: The status of this Employee. # noqa: E501 + :type: EmployeeStatus + """ + + self._status = status + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this Employee. # noqa: E501 + + Last modified timestamp # 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. + + Last modified timestamp # 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 validation_errors(self): + """Gets the validation_errors of this Employee. # noqa: E501 + + Displays array of validation error messages from the API # noqa: E501 + + :return: The validation_errors of this Employee. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._validation_errors + + @validation_errors.setter + def validation_errors(self, validation_errors): + """Sets the validation_errors of this Employee. + + Displays array of validation error messages from the API # noqa: E501 + + :param validation_errors: The validation_errors of this Employee. # noqa: E501 + :type: list[ValidationError] + """ + + self._validation_errors = validation_errors diff --git a/xero_python/payrollau/models/employee_status.py b/xero_python/payrollau/models/employee_status.py new file mode 100644 index 00000000..71b4c30f --- /dev/null +++ b/xero_python/payrollau/models/employee_status.py @@ -0,0 +1,29 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class EmployeeStatus(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + ACTIVE = "ACTIVE" + TERMINATED = "TERMINATED" diff --git a/xero_python/payrollau/models/employees.py b/xero_python/payrollau/models/employees.py new file mode 100644 index 00000000..e874af2f --- /dev/null +++ b/xero_python/payrollau/models/employees.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = {"employees": "list[Employee]"} + + attribute_map = {"employees": "Employees"} + + def __init__(self, employees=None): # noqa: E501 + """Employees - a model defined in OpenAPI""" # noqa: E501 + + self._employees = None + self.discriminator = None + + if employees is not None: + self.employees = employees + + @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/payrollau/models/employment_basis.py b/xero_python/payrollau/models/employment_basis.py new file mode 100644 index 00000000..9a9b4825 --- /dev/null +++ b/xero_python/payrollau/models/employment_basis.py @@ -0,0 +1,32 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class EmploymentBasis(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + FULLTIME = "FULLTIME" + PARTTIME = "PARTTIME" + CASUAL = "CASUAL" + LABOURHIRE = "LABOURHIRE" + SUPERINCOMESTREAM = "SUPERINCOMESTREAM" diff --git a/xero_python/payrollau/models/employment_termination_payment_type.py b/xero_python/payrollau/models/employment_termination_payment_type.py new file mode 100644 index 00000000..7f9f6ed4 --- /dev/null +++ b/xero_python/payrollau/models/employment_termination_payment_type.py @@ -0,0 +1,29 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class EmploymentTerminationPaymentType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + O = "O" + R = "R" diff --git a/xero_python/payrollau/models/entitlement_final_pay_payout_type.py b/xero_python/payrollau/models/entitlement_final_pay_payout_type.py new file mode 100644 index 00000000..862448bc --- /dev/null +++ b/xero_python/payrollau/models/entitlement_final_pay_payout_type.py @@ -0,0 +1,29 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class EntitlementFinalPayPayoutType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + NOTPAIDOUT = "NOTPAIDOUT" + PAIDOUT = "PAIDOUT" diff --git a/xero_python/payrollau/models/home_address.py b/xero_python/payrollau/models/home_address.py new file mode 100644 index 00000000..a0c99f0a --- /dev/null +++ b/xero_python/payrollau/models/home_address.py @@ -0,0 +1,220 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class HomeAddress(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", + "region": "State", + "postal_code": "str", + "country": "str", + } + + attribute_map = { + "address_line1": "AddressLine1", + "address_line2": "AddressLine2", + "city": "City", + "region": "Region", + "postal_code": "PostalCode", + "country": "Country", + } + + def __init__( + self, + address_line1=None, + address_line2=None, + city=None, + region=None, + postal_code=None, + country=None, + ): # noqa: E501 + """HomeAddress - a model defined in OpenAPI""" # noqa: E501 + + self._address_line1 = None + self._address_line2 = None + self._city = None + self._region = None + self._postal_code = None + self._country = None + self.discriminator = None + + self.address_line1 = address_line1 + if address_line2 is not None: + self.address_line2 = address_line2 + if city is not None: + self.city = city + if region is not None: + self.region = region + if postal_code is not None: + self.postal_code = postal_code + if country is not None: + self.country = country + + @property + def address_line1(self): + """Gets the address_line1 of this HomeAddress. # noqa: E501 + + Address line 1 for employee home address # noqa: E501 + + :return: The address_line1 of this HomeAddress. # noqa: E501 + :rtype: str + """ + return self._address_line1 + + @address_line1.setter + def address_line1(self, address_line1): + """Sets the address_line1 of this HomeAddress. + + Address line 1 for employee home address # noqa: E501 + + :param address_line1: The address_line1 of this HomeAddress. # 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 HomeAddress. # noqa: E501 + + Address line 2 for employee home address # noqa: E501 + + :return: The address_line2 of this HomeAddress. # noqa: E501 + :rtype: str + """ + return self._address_line2 + + @address_line2.setter + def address_line2(self, address_line2): + """Sets the address_line2 of this HomeAddress. + + Address line 2 for employee home address # noqa: E501 + + :param address_line2: The address_line2 of this HomeAddress. # noqa: E501 + :type: str + """ + + self._address_line2 = address_line2 + + @property + def city(self): + """Gets the city of this HomeAddress. # noqa: E501 + + Suburb for employee home address # noqa: E501 + + :return: The city of this HomeAddress. # noqa: E501 + :rtype: str + """ + return self._city + + @city.setter + def city(self, city): + """Sets the city of this HomeAddress. + + Suburb for employee home address # noqa: E501 + + :param city: The city of this HomeAddress. # noqa: E501 + :type: str + """ + + self._city = city + + @property + def region(self): + """Gets the region of this HomeAddress. # noqa: E501 + + + :return: The region of this HomeAddress. # noqa: E501 + :rtype: State + """ + return self._region + + @region.setter + def region(self, region): + """Sets the region of this HomeAddress. + + + :param region: The region of this HomeAddress. # noqa: E501 + :type: State + """ + + self._region = region + + @property + def postal_code(self): + """Gets the postal_code of this HomeAddress. # noqa: E501 + + PostCode for employee home address # noqa: E501 + + :return: The postal_code of this HomeAddress. # noqa: E501 + :rtype: str + """ + return self._postal_code + + @postal_code.setter + def postal_code(self, postal_code): + """Sets the postal_code of this HomeAddress. + + PostCode for employee home address # noqa: E501 + + :param postal_code: The postal_code of this HomeAddress. # noqa: E501 + :type: str + """ + + self._postal_code = postal_code + + @property + def country(self): + """Gets the country of this HomeAddress. # noqa: E501 + + Country of HomeAddress # noqa: E501 + + :return: The country of this HomeAddress. # noqa: E501 + :rtype: str + """ + return self._country + + @country.setter + def country(self, country): + """Sets the country of this HomeAddress. + + Country of HomeAddress # noqa: E501 + + :param country: The country of this HomeAddress. # noqa: E501 + :type: str + """ + + self._country = country diff --git a/xero_python/payrollau/models/leave_accrual_line.py b/xero_python/payrollau/models/leave_accrual_line.py new file mode 100644 index 00000000..ffb936e3 --- /dev/null +++ b/xero_python/payrollau/models/leave_accrual_line.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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", + "auto_calculate": "bool", + } + + attribute_map = { + "leave_type_id": "LeaveTypeID", + "number_of_units": "NumberOfUnits", + "auto_calculate": "AutoCalculate", + } + + def __init__( + self, leave_type_id=None, number_of_units=None, auto_calculate=None + ): # noqa: E501 + """LeaveAccrualLine - a model defined in OpenAPI""" # noqa: E501 + + self._leave_type_id = None + self._number_of_units = None + self._auto_calculate = 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 + if auto_calculate is not None: + self.auto_calculate = auto_calculate + + @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 + + @property + def auto_calculate(self): + """Gets the auto_calculate of this LeaveAccrualLine. # noqa: E501 + + If you want to auto calculate leave. # noqa: E501 + + :return: The auto_calculate of this LeaveAccrualLine. # noqa: E501 + :rtype: bool + """ + return self._auto_calculate + + @auto_calculate.setter + def auto_calculate(self, auto_calculate): + """Sets the auto_calculate of this LeaveAccrualLine. + + If you want to auto calculate leave. # noqa: E501 + + :param auto_calculate: The auto_calculate of this LeaveAccrualLine. # noqa: E501 + :type: bool + """ + + self._auto_calculate = auto_calculate diff --git a/xero_python/payrollau/models/leave_application.py b/xero_python/payrollau/models/leave_application.py new file mode 100644 index 00000000..dab08ec2 --- /dev/null +++ b/xero_python/payrollau/models/leave_application.py @@ -0,0 +1,333 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class LeaveApplication(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_application_id": "str", + "employee_id": "str", + "leave_type_id": "str", + "title": "str", + "start_date": "date[ms-format]", + "end_date": "date[ms-format]", + "description": "str", + "leave_periods": "list[LeavePeriod]", + "updated_date_utc": "datetime[ms-format]", + "validation_errors": "list[ValidationError]", + } + + attribute_map = { + "leave_application_id": "LeaveApplicationID", + "employee_id": "EmployeeID", + "leave_type_id": "LeaveTypeID", + "title": "Title", + "start_date": "StartDate", + "end_date": "EndDate", + "description": "Description", + "leave_periods": "LeavePeriods", + "updated_date_utc": "UpdatedDateUTC", + "validation_errors": "ValidationErrors", + } + + def __init__( + self, + leave_application_id=None, + employee_id=None, + leave_type_id=None, + title=None, + start_date=None, + end_date=None, + description=None, + leave_periods=None, + updated_date_utc=None, + validation_errors=None, + ): # noqa: E501 + """LeaveApplication - a model defined in OpenAPI""" # noqa: E501 + + self._leave_application_id = None + self._employee_id = None + self._leave_type_id = None + self._title = None + self._start_date = None + self._end_date = None + self._description = None + self._leave_periods = None + self._updated_date_utc = None + self._validation_errors = None + self.discriminator = None + + if leave_application_id is not None: + self.leave_application_id = leave_application_id + if employee_id is not None: + self.employee_id = employee_id + if leave_type_id is not None: + self.leave_type_id = leave_type_id + if title is not None: + self.title = title + if start_date is not None: + self.start_date = start_date + if end_date is not None: + self.end_date = end_date + if description is not None: + self.description = description + if leave_periods is not None: + self.leave_periods = leave_periods + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + if validation_errors is not None: + self.validation_errors = validation_errors + + @property + def leave_application_id(self): + """Gets the leave_application_id of this LeaveApplication. # noqa: E501 + + The Xero identifier for Payroll Employee # noqa: E501 + + :return: The leave_application_id of this LeaveApplication. # noqa: E501 + :rtype: str + """ + return self._leave_application_id + + @leave_application_id.setter + def leave_application_id(self, leave_application_id): + """Sets the leave_application_id of this LeaveApplication. + + The Xero identifier for Payroll Employee # noqa: E501 + + :param leave_application_id: The leave_application_id of this LeaveApplication. # noqa: E501 + :type: str + """ + + self._leave_application_id = leave_application_id + + @property + def employee_id(self): + """Gets the employee_id of this LeaveApplication. # noqa: E501 + + The Xero identifier for Payroll Employee # noqa: E501 + + :return: The employee_id of this LeaveApplication. # noqa: E501 + :rtype: str + """ + return self._employee_id + + @employee_id.setter + def employee_id(self, employee_id): + """Sets the employee_id of this LeaveApplication. + + The Xero identifier for Payroll Employee # noqa: E501 + + :param employee_id: The employee_id of this LeaveApplication. # noqa: E501 + :type: str + """ + + self._employee_id = employee_id + + @property + def leave_type_id(self): + """Gets the leave_type_id of this LeaveApplication. # noqa: E501 + + The Xero identifier for Leave Type # noqa: E501 + + :return: The leave_type_id of this LeaveApplication. # 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 LeaveApplication. + + The Xero identifier for Leave Type # noqa: E501 + + :param leave_type_id: The leave_type_id of this LeaveApplication. # noqa: E501 + :type: str + """ + + self._leave_type_id = leave_type_id + + @property + def title(self): + """Gets the title of this LeaveApplication. # noqa: E501 + + The title of the leave # noqa: E501 + + :return: The title of this LeaveApplication. # noqa: E501 + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """Sets the title of this LeaveApplication. + + The title of the leave # noqa: E501 + + :param title: The title of this LeaveApplication. # noqa: E501 + :type: str + """ + + self._title = title + + @property + def start_date(self): + """Gets the start_date of this LeaveApplication. # noqa: E501 + + Start date of the leave (YYYY-MM-DD) # noqa: E501 + + :return: The start_date of this LeaveApplication. # noqa: E501 + :rtype: date + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this LeaveApplication. + + Start date of the leave (YYYY-MM-DD) # noqa: E501 + + :param start_date: The start_date of this LeaveApplication. # noqa: E501 + :type: date + """ + + self._start_date = start_date + + @property + def end_date(self): + """Gets the end_date of this LeaveApplication. # noqa: E501 + + End date of the leave (YYYY-MM-DD) # noqa: E501 + + :return: The end_date of this LeaveApplication. # noqa: E501 + :rtype: date + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this LeaveApplication. + + End date of the leave (YYYY-MM-DD) # noqa: E501 + + :param end_date: The end_date of this LeaveApplication. # noqa: E501 + :type: date + """ + + self._end_date = end_date + + @property + def description(self): + """Gets the description of this LeaveApplication. # noqa: E501 + + The Description of the Leave # noqa: E501 + + :return: The description of this LeaveApplication. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this LeaveApplication. + + The Description of the Leave # noqa: E501 + + :param description: The description of this LeaveApplication. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def leave_periods(self): + """Gets the leave_periods of this LeaveApplication. # noqa: E501 + + + :return: The leave_periods of this LeaveApplication. # noqa: E501 + :rtype: list[LeavePeriod] + """ + return self._leave_periods + + @leave_periods.setter + def leave_periods(self, leave_periods): + """Sets the leave_periods of this LeaveApplication. + + + :param leave_periods: The leave_periods of this LeaveApplication. # noqa: E501 + :type: list[LeavePeriod] + """ + + self._leave_periods = leave_periods + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this LeaveApplication. # noqa: E501 + + Last modified timestamp # noqa: E501 + + :return: The updated_date_utc of this LeaveApplication. # 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 LeaveApplication. + + Last modified timestamp # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this LeaveApplication. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc + + @property + def validation_errors(self): + """Gets the validation_errors of this LeaveApplication. # noqa: E501 + + Displays array of validation error messages from the API # noqa: E501 + + :return: The validation_errors of this LeaveApplication. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._validation_errors + + @validation_errors.setter + def validation_errors(self, validation_errors): + """Sets the validation_errors of this LeaveApplication. + + Displays array of validation error messages from the API # noqa: E501 + + :param validation_errors: The validation_errors of this LeaveApplication. # noqa: E501 + :type: list[ValidationError] + """ + + self._validation_errors = validation_errors diff --git a/xero_python/payrollau/models/leave_applications.py b/xero_python/payrollau/models/leave_applications.py new file mode 100644 index 00000000..89f63f5d --- /dev/null +++ b/xero_python/payrollau/models/leave_applications.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class LeaveApplications(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_applications": "list[LeaveApplication]"} + + attribute_map = {"leave_applications": "LeaveApplications"} + + def __init__(self, leave_applications=None): # noqa: E501 + """LeaveApplications - a model defined in OpenAPI""" # noqa: E501 + + self._leave_applications = None + self.discriminator = None + + if leave_applications is not None: + self.leave_applications = leave_applications + + @property + def leave_applications(self): + """Gets the leave_applications of this LeaveApplications. # noqa: E501 + + + :return: The leave_applications of this LeaveApplications. # noqa: E501 + :rtype: list[LeaveApplication] + """ + return self._leave_applications + + @leave_applications.setter + def leave_applications(self, leave_applications): + """Sets the leave_applications of this LeaveApplications. + + + :param leave_applications: The leave_applications of this LeaveApplications. # noqa: E501 + :type: list[LeaveApplication] + """ + + self._leave_applications = leave_applications diff --git a/xero_python/payrollau/models/leave_balance.py b/xero_python/payrollau/models/leave_balance.py new file mode 100644 index 00000000..840e9b9f --- /dev/null +++ b/xero_python/payrollau/models/leave_balance.py @@ -0,0 +1,161 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class LeaveBalance(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_name": "str", + "leave_type_id": "str", + "number_of_units": "float", + "type_of_units": "str", + } + + attribute_map = { + "leave_name": "LeaveName", + "leave_type_id": "LeaveTypeID", + "number_of_units": "NumberOfUnits", + "type_of_units": "TypeOfUnits", + } + + def __init__( + self, + leave_name=None, + leave_type_id=None, + number_of_units=None, + type_of_units=None, + ): # noqa: E501 + """LeaveBalance - a model defined in OpenAPI""" # noqa: E501 + + self._leave_name = None + self._leave_type_id = None + self._number_of_units = None + self._type_of_units = None + self.discriminator = None + + if leave_name is not None: + self.leave_name = leave_name + 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 + if type_of_units is not None: + self.type_of_units = type_of_units + + @property + def leave_name(self): + """Gets the leave_name of this LeaveBalance. # noqa: E501 + + The name of the leave type # noqa: E501 + + :return: The leave_name of this LeaveBalance. # noqa: E501 + :rtype: str + """ + return self._leave_name + + @leave_name.setter + def leave_name(self, leave_name): + """Sets the leave_name of this LeaveBalance. + + The name of the leave type # noqa: E501 + + :param leave_name: The leave_name of this LeaveBalance. # noqa: E501 + :type: str + """ + + self._leave_name = leave_name + + @property + def leave_type_id(self): + """Gets the leave_type_id of this LeaveBalance. # noqa: E501 + + Identifier of the leave type (see PayItems) # noqa: E501 + + :return: The leave_type_id of this LeaveBalance. # 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 LeaveBalance. + + Identifier of the leave type (see PayItems) # noqa: E501 + + :param leave_type_id: The leave_type_id of this LeaveBalance. # noqa: E501 + :type: str + """ + + self._leave_type_id = leave_type_id + + @property + def number_of_units(self): + """Gets the number_of_units of this LeaveBalance. # noqa: E501 + + The balance of the leave available # noqa: E501 + + :return: The number_of_units of this LeaveBalance. # 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 LeaveBalance. + + The balance of the leave available # noqa: E501 + + :param number_of_units: The number_of_units of this LeaveBalance. # noqa: E501 + :type: float + """ + + self._number_of_units = number_of_units + + @property + def type_of_units(self): + """Gets the type_of_units of this LeaveBalance. # noqa: E501 + + The type of units as specified by the LeaveType (see PayItems) # noqa: E501 + + :return: The type_of_units of this LeaveBalance. # 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 LeaveBalance. + + The type of units as specified by the LeaveType (see PayItems) # noqa: E501 + + :param type_of_units: The type_of_units of this LeaveBalance. # noqa: E501 + :type: str + """ + + self._type_of_units = type_of_units diff --git a/xero_python/payrollau/models/leave_earnings_line.py b/xero_python/payrollau/models/leave_earnings_line.py new file mode 100644 index 00000000..13724318 --- /dev/null +++ b/xero_python/payrollau/models/leave_earnings_line.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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_rate_id": "str", + "rate_per_unit": "float", + "number_of_units": "float", + } + + attribute_map = { + "earnings_rate_id": "EarningsRateID", + "rate_per_unit": "RatePerUnit", + "number_of_units": "NumberOfUnits", + } + + def __init__( + self, earnings_rate_id=None, rate_per_unit=None, number_of_units=None + ): # noqa: E501 + """LeaveEarningsLine - a model defined in OpenAPI""" # noqa: E501 + + self._earnings_rate_id = None + self._rate_per_unit = None + self._number_of_units = None + self.discriminator = None + + if earnings_rate_id is not None: + self.earnings_rate_id = earnings_rate_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 + + @property + def earnings_rate_id(self): + """Gets the earnings_rate_id of this LeaveEarningsLine. # noqa: E501 + + Xero identifier # 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 # 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 rate_per_unit(self): + """Gets the rate_per_unit of this LeaveEarningsLine. # noqa: E501 + + Rate per unit of the EarningsLine. # 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 of the EarningsLine. # 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 + + Earnings rate 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. + + Earnings rate 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 diff --git a/xero_python/payrollau/models/leave_line.py b/xero_python/payrollau/models/leave_line.py new file mode 100644 index 00000000..d65b8c4e --- /dev/null +++ b/xero_python/payrollau/models/leave_line.py @@ -0,0 +1,221 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class LeaveLine(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", + "calculation_type": "LeaveLineCalculationType", + "entitlement_final_pay_payout_type": "EntitlementFinalPayPayoutType", + "employment_termination_payment_type": "EmploymentTerminationPaymentType", + "include_superannuation_guarantee_contribution": "bool", + "number_of_units": "float", + } + + attribute_map = { + "leave_type_id": "LeaveTypeID", + "calculation_type": "CalculationType", + "entitlement_final_pay_payout_type": "EntitlementFinalPayPayoutType", + "employment_termination_payment_type": "EmploymentTerminationPaymentType", + "include_superannuation_guarantee_contribution": "IncludeSuperannuationGuaranteeContribution", + "number_of_units": "NumberOfUnits", + } + + def __init__( + self, + leave_type_id=None, + calculation_type=None, + entitlement_final_pay_payout_type=None, + employment_termination_payment_type=None, + include_superannuation_guarantee_contribution=None, + number_of_units=None, + ): # noqa: E501 + """LeaveLine - a model defined in OpenAPI""" # noqa: E501 + + self._leave_type_id = None + self._calculation_type = None + self._entitlement_final_pay_payout_type = None + self._employment_termination_payment_type = None + self._include_superannuation_guarantee_contribution = None + self._number_of_units = None + self.discriminator = None + + if leave_type_id is not None: + self.leave_type_id = leave_type_id + if calculation_type is not None: + self.calculation_type = calculation_type + if entitlement_final_pay_payout_type is not None: + self.entitlement_final_pay_payout_type = entitlement_final_pay_payout_type + if employment_termination_payment_type is not None: + self.employment_termination_payment_type = ( + employment_termination_payment_type + ) + if include_superannuation_guarantee_contribution is not None: + self.include_superannuation_guarantee_contribution = ( + include_superannuation_guarantee_contribution + ) + 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 LeaveLine. # noqa: E501 + + Xero leave type identifier # noqa: E501 + + :return: The leave_type_id of this LeaveLine. # 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 LeaveLine. + + Xero leave type identifier # noqa: E501 + + :param leave_type_id: The leave_type_id of this LeaveLine. # noqa: E501 + :type: str + """ + + self._leave_type_id = leave_type_id + + @property + def calculation_type(self): + """Gets the calculation_type of this LeaveLine. # noqa: E501 + + + :return: The calculation_type of this LeaveLine. # noqa: E501 + :rtype: LeaveLineCalculationType + """ + return self._calculation_type + + @calculation_type.setter + def calculation_type(self, calculation_type): + """Sets the calculation_type of this LeaveLine. + + + :param calculation_type: The calculation_type of this LeaveLine. # noqa: E501 + :type: LeaveLineCalculationType + """ + + self._calculation_type = calculation_type + + @property + def entitlement_final_pay_payout_type(self): + """Gets the entitlement_final_pay_payout_type of this LeaveLine. # noqa: E501 + + + :return: The entitlement_final_pay_payout_type of this LeaveLine. # noqa: E501 + :rtype: EntitlementFinalPayPayoutType + """ + return self._entitlement_final_pay_payout_type + + @entitlement_final_pay_payout_type.setter + def entitlement_final_pay_payout_type(self, entitlement_final_pay_payout_type): + """Sets the entitlement_final_pay_payout_type of this LeaveLine. + + + :param entitlement_final_pay_payout_type: The entitlement_final_pay_payout_type of this LeaveLine. # noqa: E501 + :type: EntitlementFinalPayPayoutType + """ + + self._entitlement_final_pay_payout_type = entitlement_final_pay_payout_type + + @property + def employment_termination_payment_type(self): + """Gets the employment_termination_payment_type of this LeaveLine. # noqa: E501 + + + :return: The employment_termination_payment_type of this LeaveLine. # noqa: E501 + :rtype: EmploymentTerminationPaymentType + """ + return self._employment_termination_payment_type + + @employment_termination_payment_type.setter + def employment_termination_payment_type(self, employment_termination_payment_type): + """Sets the employment_termination_payment_type of this LeaveLine. + + + :param employment_termination_payment_type: The employment_termination_payment_type of this LeaveLine. # noqa: E501 + :type: EmploymentTerminationPaymentType + """ + + self._employment_termination_payment_type = employment_termination_payment_type + + @property + def include_superannuation_guarantee_contribution(self): + """Gets the include_superannuation_guarantee_contribution of this LeaveLine. # noqa: E501 + + amount of leave line # noqa: E501 + + :return: The include_superannuation_guarantee_contribution of this LeaveLine. # noqa: E501 + :rtype: bool + """ + return self._include_superannuation_guarantee_contribution + + @include_superannuation_guarantee_contribution.setter + def include_superannuation_guarantee_contribution( + self, include_superannuation_guarantee_contribution + ): + """Sets the include_superannuation_guarantee_contribution of this LeaveLine. + + amount of leave line # noqa: E501 + + :param include_superannuation_guarantee_contribution: The include_superannuation_guarantee_contribution of this LeaveLine. # noqa: E501 + :type: bool + """ + + self._include_superannuation_guarantee_contribution = ( + include_superannuation_guarantee_contribution + ) + + @property + def number_of_units(self): + """Gets the number_of_units of this LeaveLine. # noqa: E501 + + Leave number of units # noqa: E501 + + :return: The number_of_units of this LeaveLine. # 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 LeaveLine. + + Leave number of units # noqa: E501 + + :param number_of_units: The number_of_units of this LeaveLine. # noqa: E501 + :type: float + """ + + self._number_of_units = number_of_units diff --git a/xero_python/payrollau/models/leave_line_calculation_type.py b/xero_python/payrollau/models/leave_line_calculation_type.py new file mode 100644 index 00000000..354fa9ae --- /dev/null +++ b/xero_python/payrollau/models/leave_line_calculation_type.py @@ -0,0 +1,32 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class LeaveLineCalculationType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + NOCALCULATIONREQUIRED = "NOCALCULATIONREQUIRED" + FIXEDAMOUNTEACHPERIOD = "FIXEDAMOUNTEACHPERIOD" + ENTERRATEINPAYTEMPLATE = "ENTERRATEINPAYTEMPLATE" + BASEDONORDINARYEARNINGS = "BASEDONORDINARYEARNINGS" + EMPTY = "" diff --git a/xero_python/payrollau/models/leave_lines.py b/xero_python/payrollau/models/leave_lines.py new file mode 100644 index 00000000..6b52ab99 --- /dev/null +++ b/xero_python/payrollau/models/leave_lines.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class LeaveLines(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": "list[LeaveLine]"} + + attribute_map = {"employee": "Employee"} + + def __init__(self, employee=None): # noqa: E501 + """LeaveLines - a model defined in OpenAPI""" # noqa: E501 + + self._employee = None + self.discriminator = None + + if employee is not None: + self.employee = employee + + @property + def employee(self): + """Gets the employee of this LeaveLines. # noqa: E501 + + + :return: The employee of this LeaveLines. # noqa: E501 + :rtype: list[LeaveLine] + """ + return self._employee + + @employee.setter + def employee(self, employee): + """Sets the employee of this LeaveLines. + + + :param employee: The employee of this LeaveLines. # noqa: E501 + :type: list[LeaveLine] + """ + + self._employee = employee diff --git a/xero_python/payrollau/models/leave_period.py b/xero_python/payrollau/models/leave_period.py new file mode 100644 index 00000000..8dea9499 --- /dev/null +++ b/xero_python/payrollau/models/leave_period.py @@ -0,0 +1,159 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = { + "number_of_units": "float", + "pay_period_end_date": "date[ms-format]", + "pay_period_start_date": "date[ms-format]", + "leave_period_status": "LeavePeriodStatus", + } + + attribute_map = { + "number_of_units": "NumberOfUnits", + "pay_period_end_date": "PayPeriodEndDate", + "pay_period_start_date": "PayPeriodStartDate", + "leave_period_status": "LeavePeriodStatus", + } + + def __init__( + self, + number_of_units=None, + pay_period_end_date=None, + pay_period_start_date=None, + leave_period_status=None, + ): # noqa: E501 + """LeavePeriod - a model defined in OpenAPI""" # noqa: E501 + + self._number_of_units = None + self._pay_period_end_date = None + self._pay_period_start_date = None + self._leave_period_status = None + self.discriminator = None + + if number_of_units is not None: + self.number_of_units = number_of_units + if pay_period_end_date is not None: + self.pay_period_end_date = pay_period_end_date + if pay_period_start_date is not None: + self.pay_period_start_date = pay_period_start_date + if leave_period_status is not None: + self.leave_period_status = leave_period_status + + @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 pay_period_end_date(self): + """Gets the pay_period_end_date of this LeavePeriod. # noqa: E501 + + The Pay Period End Date (YYYY-MM-DD) # noqa: E501 + + :return: The pay_period_end_date of this LeavePeriod. # noqa: E501 + :rtype: date + """ + return self._pay_period_end_date + + @pay_period_end_date.setter + def pay_period_end_date(self, pay_period_end_date): + """Sets the pay_period_end_date of this LeavePeriod. + + The Pay Period End Date (YYYY-MM-DD) # noqa: E501 + + :param pay_period_end_date: The pay_period_end_date of this LeavePeriod. # noqa: E501 + :type: date + """ + + self._pay_period_end_date = pay_period_end_date + + @property + def pay_period_start_date(self): + """Gets the pay_period_start_date of this LeavePeriod. # noqa: E501 + + The Pay Period Start Date (YYYY-MM-DD) # noqa: E501 + + :return: The pay_period_start_date of this LeavePeriod. # noqa: E501 + :rtype: date + """ + return self._pay_period_start_date + + @pay_period_start_date.setter + def pay_period_start_date(self, pay_period_start_date): + """Sets the pay_period_start_date of this LeavePeriod. + + The Pay Period Start Date (YYYY-MM-DD) # noqa: E501 + + :param pay_period_start_date: The pay_period_start_date of this LeavePeriod. # noqa: E501 + :type: date + """ + + self._pay_period_start_date = pay_period_start_date + + @property + def leave_period_status(self): + """Gets the leave_period_status of this LeavePeriod. # noqa: E501 + + + :return: The leave_period_status of this LeavePeriod. # noqa: E501 + :rtype: LeavePeriodStatus + """ + return self._leave_period_status + + @leave_period_status.setter + def leave_period_status(self, leave_period_status): + """Sets the leave_period_status of this LeavePeriod. + + + :param leave_period_status: The leave_period_status of this LeavePeriod. # noqa: E501 + :type: LeavePeriodStatus + """ + + self._leave_period_status = leave_period_status diff --git a/xero_python/payrollau/models/leave_period_status.py b/xero_python/payrollau/models/leave_period_status.py new file mode 100644 index 00000000..c810e9ca --- /dev/null +++ b/xero_python/payrollau/models/leave_period_status.py @@ -0,0 +1,29 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class LeavePeriodStatus(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + SCHEDULED = "SCHEDULED" + PROCESSED = "PROCESSED" diff --git a/xero_python/payrollau/models/leave_type.py b/xero_python/payrollau/models/leave_type.py new file mode 100644 index 00000000..998d9871 --- /dev/null +++ b/xero_python/payrollau/models/leave_type.py @@ -0,0 +1,311 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = { + "name": "str", + "type_of_units": "str", + "leave_type_id": "str", + "normal_entitlement": "float", + "leave_loading_rate": "int", + "updated_date_utc": "datetime[ms-format]", + "is_paid_leave": "bool", + "show_on_payslip": "bool", + "current_record": "bool", + } + + attribute_map = { + "name": "Name", + "type_of_units": "TypeOfUnits", + "leave_type_id": "LeaveTypeID", + "normal_entitlement": "NormalEntitlement", + "leave_loading_rate": "LeaveLoadingRate", + "updated_date_utc": "UpdatedDateUTC", + "is_paid_leave": "IsPaidLeave", + "show_on_payslip": "ShowOnPayslip", + "current_record": "CurrentRecord", + } + + def __init__( + self, + name=None, + type_of_units=None, + leave_type_id=None, + normal_entitlement=None, + leave_loading_rate=None, + updated_date_utc=None, + is_paid_leave=None, + show_on_payslip=None, + current_record=None, + ): # noqa: E501 + """LeaveType - a model defined in OpenAPI""" # noqa: E501 + + self._name = None + self._type_of_units = None + self._leave_type_id = None + self._normal_entitlement = None + self._leave_loading_rate = None + self._updated_date_utc = None + self._is_paid_leave = None + self._show_on_payslip = None + self._current_record = None + self.discriminator = None + + if name is not None: + self.name = name + if type_of_units is not None: + self.type_of_units = type_of_units + if leave_type_id is not None: + self.leave_type_id = leave_type_id + if normal_entitlement is not None: + self.normal_entitlement = normal_entitlement + if leave_loading_rate is not None: + self.leave_loading_rate = leave_loading_rate + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + if is_paid_leave is not None: + self.is_paid_leave = is_paid_leave + if show_on_payslip is not None: + self.show_on_payslip = show_on_payslip + if current_record is not None: + self.current_record = current_record + + @property + def name(self): + """Gets the name of this LeaveType. # noqa: E501 + + Name of the earnings rate (max length = 100) # 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 earnings rate (max length = 100) # noqa: E501 + + :param name: The name of this LeaveType. # noqa: E501 + :type: str + """ + if name is not None and len(name) > 100: + raise ValueError( + "Invalid value for `name`, " + "length must be less than or equal to `100`" + ) # noqa: E501 + + self._name = name + + @property + def type_of_units(self): + """Gets the type_of_units of this LeaveType. # noqa: E501 + + The type of units by which leave entitlements are normally tracked. These are typically the same as the type of units used for the employee’s ordinary earnings rate # noqa: E501 + + :return: The type_of_units of this LeaveType. # 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 LeaveType. + + The type of units by which leave entitlements are normally tracked. These are typically the same as the type of units used for the employee’s ordinary earnings rate # noqa: E501 + + :param type_of_units: The type_of_units of this LeaveType. # noqa: E501 + :type: str + """ + + self._type_of_units = type_of_units + + @property + def leave_type_id(self): + """Gets the leave_type_id of this LeaveType. # noqa: E501 + + Xero identifier # 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 identifier # 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 normal_entitlement(self): + """Gets the normal_entitlement of this LeaveType. # noqa: E501 + + The number of units the employee is entitled to each year # noqa: E501 + + :return: The normal_entitlement of this LeaveType. # noqa: E501 + :rtype: float + """ + return self._normal_entitlement + + @normal_entitlement.setter + def normal_entitlement(self, normal_entitlement): + """Sets the normal_entitlement of this LeaveType. + + The number of units the employee is entitled to each year # noqa: E501 + + :param normal_entitlement: The normal_entitlement of this LeaveType. # noqa: E501 + :type: float + """ + + self._normal_entitlement = normal_entitlement + + @property + def leave_loading_rate(self): + """Gets the leave_loading_rate of this LeaveType. # noqa: E501 + + Enter an amount here if your organisation pays an additional percentage on top of ordinary earnings when your employees take leave (typically 17.5%) # noqa: E501 + + :return: The leave_loading_rate of this LeaveType. # noqa: E501 + :rtype: int + """ + return self._leave_loading_rate + + @leave_loading_rate.setter + def leave_loading_rate(self, leave_loading_rate): + """Sets the leave_loading_rate of this LeaveType. + + Enter an amount here if your organisation pays an additional percentage on top of ordinary earnings when your employees take leave (typically 17.5%) # noqa: E501 + + :param leave_loading_rate: The leave_loading_rate of this LeaveType. # noqa: E501 + :type: int + """ + + self._leave_loading_rate = leave_loading_rate + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this LeaveType. # noqa: E501 + + Last modified timestamp # 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. + + Last modified timestamp # 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_paid_leave(self): + """Gets the is_paid_leave of this LeaveType. # noqa: E501 + + Set this to 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. + + Set this to 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 + """ + + self._is_paid_leave = is_paid_leave + + @property + def show_on_payslip(self): + """Gets the show_on_payslip of this LeaveType. # noqa: E501 + + Set this if you want a balance for this leave type to be shown on your 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. + + Set this if you want a balance for this leave type to be shown on your employee’s payslips # noqa: E501 + + :param show_on_payslip: The show_on_payslip of this LeaveType. # noqa: E501 + :type: bool + """ + + self._show_on_payslip = show_on_payslip + + @property + def current_record(self): + """Gets the current_record of this LeaveType. # noqa: E501 + + Is the current record # noqa: E501 + + :return: The current_record of this LeaveType. # noqa: E501 + :rtype: bool + """ + return self._current_record + + @current_record.setter + def current_record(self, current_record): + """Sets the current_record of this LeaveType. + + Is the current record # noqa: E501 + + :param current_record: The current_record of this LeaveType. # noqa: E501 + :type: bool + """ + + self._current_record = current_record diff --git a/xero_python/payrollau/models/leave_type_contribution_type.py b/xero_python/payrollau/models/leave_type_contribution_type.py new file mode 100644 index 00000000..614f85e6 --- /dev/null +++ b/xero_python/payrollau/models/leave_type_contribution_type.py @@ -0,0 +1,31 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class LeaveTypeContributionType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + SGC = "SGC" + SALARYSACRIFICE = "SALARYSACRIFICE" + EMPLOYERADDITIONAL = "EMPLOYERADDITIONAL" + EMPLOYEE = "EMPLOYEE" diff --git a/xero_python/payrollau/models/manual_tax_type.py b/xero_python/payrollau/models/manual_tax_type.py new file mode 100644 index 00000000..99be4cf0 --- /dev/null +++ b/xero_python/payrollau/models/manual_tax_type.py @@ -0,0 +1,30 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class ManualTaxType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + PAYGMANUAL = "PAYGMANUAL" + ETPOMANUAL = "ETPOMANUAL" + ETPRMANUAL = "ETPRMANUAL" diff --git a/xero_python/payrollau/models/opening_balances.py b/xero_python/payrollau/models/opening_balances.py new file mode 100644 index 00000000..ab98e4c5 --- /dev/null +++ b/xero_python/payrollau/models/opening_balances.py @@ -0,0 +1,238 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class OpeningBalances(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 = { + "opening_balance_date": "date[ms-format]", + "tax": "str", + "earnings_lines": "list[EarningsLine]", + "deduction_lines": "list[DeductionLine]", + "super_lines": "list[SuperLine]", + "reimbursement_lines": "list[ReimbursementLine]", + "leave_lines": "list[LeaveLine]", + } + + attribute_map = { + "opening_balance_date": "OpeningBalanceDate", + "tax": "Tax", + "earnings_lines": "EarningsLines", + "deduction_lines": "DeductionLines", + "super_lines": "SuperLines", + "reimbursement_lines": "ReimbursementLines", + "leave_lines": "LeaveLines", + } + + def __init__( + self, + opening_balance_date=None, + tax=None, + earnings_lines=None, + deduction_lines=None, + super_lines=None, + reimbursement_lines=None, + leave_lines=None, + ): # noqa: E501 + """OpeningBalances - a model defined in OpenAPI""" # noqa: E501 + + self._opening_balance_date = None + self._tax = None + self._earnings_lines = None + self._deduction_lines = None + self._super_lines = None + self._reimbursement_lines = None + self._leave_lines = None + self.discriminator = None + + if opening_balance_date is not None: + self.opening_balance_date = opening_balance_date + if tax is not None: + self.tax = tax + if earnings_lines is not None: + self.earnings_lines = earnings_lines + if deduction_lines is not None: + self.deduction_lines = deduction_lines + if super_lines is not None: + self.super_lines = super_lines + if reimbursement_lines is not None: + self.reimbursement_lines = reimbursement_lines + if leave_lines is not None: + self.leave_lines = leave_lines + + @property + def opening_balance_date(self): + """Gets the opening_balance_date of this OpeningBalances. # noqa: E501 + + Opening Balance Date. (YYYY-MM-DD) # noqa: E501 + + :return: The opening_balance_date of this OpeningBalances. # noqa: E501 + :rtype: date + """ + return self._opening_balance_date + + @opening_balance_date.setter + def opening_balance_date(self, opening_balance_date): + """Sets the opening_balance_date of this OpeningBalances. + + Opening Balance Date. (YYYY-MM-DD) # noqa: E501 + + :param opening_balance_date: The opening_balance_date of this OpeningBalances. # noqa: E501 + :type: date + """ + + self._opening_balance_date = opening_balance_date + + @property + def tax(self): + """Gets the tax of this OpeningBalances. # noqa: E501 + + Opening Balance tax # noqa: E501 + + :return: The tax of this OpeningBalances. # noqa: E501 + :rtype: str + """ + return self._tax + + @tax.setter + def tax(self, tax): + """Sets the tax of this OpeningBalances. + + Opening Balance tax # noqa: E501 + + :param tax: The tax of this OpeningBalances. # noqa: E501 + :type: str + """ + + self._tax = tax + + @property + def earnings_lines(self): + """Gets the earnings_lines of this OpeningBalances. # noqa: E501 + + + :return: The earnings_lines of this OpeningBalances. # noqa: E501 + :rtype: list[EarningsLine] + """ + return self._earnings_lines + + @earnings_lines.setter + def earnings_lines(self, earnings_lines): + """Sets the earnings_lines of this OpeningBalances. + + + :param earnings_lines: The earnings_lines of this OpeningBalances. # noqa: E501 + :type: list[EarningsLine] + """ + + self._earnings_lines = earnings_lines + + @property + def deduction_lines(self): + """Gets the deduction_lines of this OpeningBalances. # noqa: E501 + + + :return: The deduction_lines of this OpeningBalances. # noqa: E501 + :rtype: list[DeductionLine] + """ + return self._deduction_lines + + @deduction_lines.setter + def deduction_lines(self, deduction_lines): + """Sets the deduction_lines of this OpeningBalances. + + + :param deduction_lines: The deduction_lines of this OpeningBalances. # noqa: E501 + :type: list[DeductionLine] + """ + + self._deduction_lines = deduction_lines + + @property + def super_lines(self): + """Gets the super_lines of this OpeningBalances. # noqa: E501 + + + :return: The super_lines of this OpeningBalances. # noqa: E501 + :rtype: list[SuperLine] + """ + return self._super_lines + + @super_lines.setter + def super_lines(self, super_lines): + """Sets the super_lines of this OpeningBalances. + + + :param super_lines: The super_lines of this OpeningBalances. # noqa: E501 + :type: list[SuperLine] + """ + + self._super_lines = super_lines + + @property + def reimbursement_lines(self): + """Gets the reimbursement_lines of this OpeningBalances. # noqa: E501 + + + :return: The reimbursement_lines of this OpeningBalances. # noqa: E501 + :rtype: list[ReimbursementLine] + """ + return self._reimbursement_lines + + @reimbursement_lines.setter + def reimbursement_lines(self, reimbursement_lines): + """Sets the reimbursement_lines of this OpeningBalances. + + + :param reimbursement_lines: The reimbursement_lines of this OpeningBalances. # noqa: E501 + :type: list[ReimbursementLine] + """ + + self._reimbursement_lines = reimbursement_lines + + @property + def leave_lines(self): + """Gets the leave_lines of this OpeningBalances. # noqa: E501 + + + :return: The leave_lines of this OpeningBalances. # noqa: E501 + :rtype: list[LeaveLine] + """ + return self._leave_lines + + @leave_lines.setter + def leave_lines(self, leave_lines): + """Sets the leave_lines of this OpeningBalances. + + + :param leave_lines: The leave_lines of this OpeningBalances. # noqa: E501 + :type: list[LeaveLine] + """ + + self._leave_lines = leave_lines diff --git a/xero_python/payrollau/models/pay_item.py b/xero_python/payrollau/models/pay_item.py new file mode 100644 index 00000000..cd02031a --- /dev/null +++ b/xero_python/payrollau/models/pay_item.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PayItem(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_rates": "list[EarningsRate]", + "deduction_types": "list[DeductionType]", + "leave_types": "list[LeaveType]", + "reimbursement_types": "list[ReimbursementType]", + } + + attribute_map = { + "earnings_rates": "EarningsRates", + "deduction_types": "DeductionTypes", + "leave_types": "LeaveTypes", + "reimbursement_types": "ReimbursementTypes", + } + + def __init__( + self, + earnings_rates=None, + deduction_types=None, + leave_types=None, + reimbursement_types=None, + ): # noqa: E501 + """PayItem - a model defined in OpenAPI""" # noqa: E501 + + self._earnings_rates = None + self._deduction_types = None + self._leave_types = None + self._reimbursement_types = None + self.discriminator = None + + if earnings_rates is not None: + self.earnings_rates = earnings_rates + if deduction_types is not None: + self.deduction_types = deduction_types + if leave_types is not None: + self.leave_types = leave_types + if reimbursement_types is not None: + self.reimbursement_types = reimbursement_types + + @property + def earnings_rates(self): + """Gets the earnings_rates of this PayItem. # noqa: E501 + + + :return: The earnings_rates of this PayItem. # noqa: E501 + :rtype: list[EarningsRate] + """ + return self._earnings_rates + + @earnings_rates.setter + def earnings_rates(self, earnings_rates): + """Sets the earnings_rates of this PayItem. + + + :param earnings_rates: The earnings_rates of this PayItem. # noqa: E501 + :type: list[EarningsRate] + """ + + self._earnings_rates = earnings_rates + + @property + def deduction_types(self): + """Gets the deduction_types of this PayItem. # noqa: E501 + + + :return: The deduction_types of this PayItem. # noqa: E501 + :rtype: list[DeductionType] + """ + return self._deduction_types + + @deduction_types.setter + def deduction_types(self, deduction_types): + """Sets the deduction_types of this PayItem. + + + :param deduction_types: The deduction_types of this PayItem. # noqa: E501 + :type: list[DeductionType] + """ + + self._deduction_types = deduction_types + + @property + def leave_types(self): + """Gets the leave_types of this PayItem. # noqa: E501 + + + :return: The leave_types of this PayItem. # noqa: E501 + :rtype: list[LeaveType] + """ + return self._leave_types + + @leave_types.setter + def leave_types(self, leave_types): + """Sets the leave_types of this PayItem. + + + :param leave_types: The leave_types of this PayItem. # noqa: E501 + :type: list[LeaveType] + """ + + self._leave_types = leave_types + + @property + def reimbursement_types(self): + """Gets the reimbursement_types of this PayItem. # noqa: E501 + + + :return: The reimbursement_types of this PayItem. # noqa: E501 + :rtype: list[ReimbursementType] + """ + return self._reimbursement_types + + @reimbursement_types.setter + def reimbursement_types(self, reimbursement_types): + """Sets the reimbursement_types of this PayItem. + + + :param reimbursement_types: The reimbursement_types of this PayItem. # noqa: E501 + :type: list[ReimbursementType] + """ + + self._reimbursement_types = reimbursement_types diff --git a/xero_python/payrollau/models/pay_items.py b/xero_python/payrollau/models/pay_items.py new file mode 100644 index 00000000..6c34c383 --- /dev/null +++ b/xero_python/payrollau/models/pay_items.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PayItems(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_items": "PayItem"} + + attribute_map = {"pay_items": "PayItems"} + + def __init__(self, pay_items=None): # noqa: E501 + """PayItems - a model defined in OpenAPI""" # noqa: E501 + + self._pay_items = None + self.discriminator = None + + if pay_items is not None: + self.pay_items = pay_items + + @property + def pay_items(self): + """Gets the pay_items of this PayItems. # noqa: E501 + + + :return: The pay_items of this PayItems. # noqa: E501 + :rtype: PayItem + """ + return self._pay_items + + @pay_items.setter + def pay_items(self, pay_items): + """Sets the pay_items of this PayItems. + + + :param pay_items: The pay_items of this PayItems. # noqa: E501 + :type: PayItem + """ + + self._pay_items = pay_items diff --git a/xero_python/payrollau/models/pay_run.py b/xero_python/payrollau/models/pay_run.py new file mode 100644 index 00000000..e094782d --- /dev/null +++ b/xero_python/payrollau/models/pay_run.py @@ -0,0 +1,510 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = { + "payroll_calendar_id": "str", + "pay_run_id": "str", + "pay_run_period_start_date": "date[ms-format]", + "pay_run_period_end_date": "date[ms-format]", + "pay_run_status": "PayRunStatus", + "payment_date": "date[ms-format]", + "payslip_message": "str", + "updated_date_utc": "datetime[ms-format]", + "payslips": "list[PayslipSummary]", + "wages": "float", + "deductions": "float", + "tax": "float", + "super": "float", + "reimbursement": "float", + "net_pay": "float", + "validation_errors": "list[ValidationError]", + } + + attribute_map = { + "payroll_calendar_id": "PayrollCalendarID", + "pay_run_id": "PayRunID", + "pay_run_period_start_date": "PayRunPeriodStartDate", + "pay_run_period_end_date": "PayRunPeriodEndDate", + "pay_run_status": "PayRunStatus", + "payment_date": "PaymentDate", + "payslip_message": "PayslipMessage", + "updated_date_utc": "UpdatedDateUTC", + "payslips": "Payslips", + "wages": "Wages", + "deductions": "Deductions", + "tax": "Tax", + "super": "Super", + "reimbursement": "Reimbursement", + "net_pay": "NetPay", + "validation_errors": "ValidationErrors", + } + + def __init__( + self, + payroll_calendar_id=None, + pay_run_id=None, + pay_run_period_start_date=None, + pay_run_period_end_date=None, + pay_run_status=None, + payment_date=None, + payslip_message=None, + updated_date_utc=None, + payslips=None, + wages=None, + deductions=None, + tax=None, + super=None, + reimbursement=None, + net_pay=None, + validation_errors=None, + ): # noqa: E501 + """PayRun - a model defined in OpenAPI""" # noqa: E501 + + self._payroll_calendar_id = None + self._pay_run_id = None + self._pay_run_period_start_date = None + self._pay_run_period_end_date = None + self._pay_run_status = None + self._payment_date = None + self._payslip_message = None + self._updated_date_utc = None + self._payslips = None + self._wages = None + self._deductions = None + self._tax = None + self._super = None + self._reimbursement = None + self._net_pay = None + self._validation_errors = None + self.discriminator = None + + self.payroll_calendar_id = payroll_calendar_id + if pay_run_id is not None: + self.pay_run_id = pay_run_id + if pay_run_period_start_date is not None: + self.pay_run_period_start_date = pay_run_period_start_date + if pay_run_period_end_date is not None: + self.pay_run_period_end_date = pay_run_period_end_date + if pay_run_status is not None: + self.pay_run_status = pay_run_status + if payment_date is not None: + self.payment_date = payment_date + if payslip_message is not None: + self.payslip_message = payslip_message + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + if payslips is not None: + self.payslips = payslips + if wages is not None: + self.wages = wages + if deductions is not None: + self.deductions = deductions + if tax is not None: + self.tax = tax + if super is not None: + self.super = super + if reimbursement is not None: + self.reimbursement = reimbursement + if net_pay is not None: + self.net_pay = net_pay + if validation_errors is not None: + self.validation_errors = validation_errors + + @property + def payroll_calendar_id(self): + """Gets the payroll_calendar_id of this PayRun. # noqa: E501 + + Xero identifier for pay run # 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 identifier for pay run # noqa: E501 + + :param payroll_calendar_id: The payroll_calendar_id of this PayRun. # 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 pay_run_id(self): + """Gets the pay_run_id of this PayRun. # noqa: E501 + + Xero identifier for 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 identifier for 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 pay_run_period_start_date(self): + """Gets the pay_run_period_start_date of this PayRun. # noqa: E501 + + Period Start Date for the PayRun (YYYY-MM-DD) # noqa: E501 + + :return: The pay_run_period_start_date of this PayRun. # noqa: E501 + :rtype: date + """ + return self._pay_run_period_start_date + + @pay_run_period_start_date.setter + def pay_run_period_start_date(self, pay_run_period_start_date): + """Sets the pay_run_period_start_date of this PayRun. + + Period Start Date for the PayRun (YYYY-MM-DD) # noqa: E501 + + :param pay_run_period_start_date: The pay_run_period_start_date of this PayRun. # noqa: E501 + :type: date + """ + + self._pay_run_period_start_date = pay_run_period_start_date + + @property + def pay_run_period_end_date(self): + """Gets the pay_run_period_end_date of this PayRun. # noqa: E501 + + Period End Date for the PayRun (YYYY-MM-DD) # noqa: E501 + + :return: The pay_run_period_end_date of this PayRun. # noqa: E501 + :rtype: date + """ + return self._pay_run_period_end_date + + @pay_run_period_end_date.setter + def pay_run_period_end_date(self, pay_run_period_end_date): + """Sets the pay_run_period_end_date of this PayRun. + + Period End Date for the PayRun (YYYY-MM-DD) # noqa: E501 + + :param pay_run_period_end_date: The pay_run_period_end_date of this PayRun. # noqa: E501 + :type: date + """ + + self._pay_run_period_end_date = pay_run_period_end_date + + @property + def pay_run_status(self): + """Gets the pay_run_status of this PayRun. # noqa: E501 + + + :return: The pay_run_status of this PayRun. # noqa: E501 + :rtype: PayRunStatus + """ + 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. + + + :param pay_run_status: The pay_run_status of this PayRun. # noqa: E501 + :type: PayRunStatus + """ + + self._pay_run_status = pay_run_status + + @property + def payment_date(self): + """Gets the payment_date of this PayRun. # noqa: E501 + + Payment Date for the PayRun (YYYY-MM-DD) # 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 for the PayRun (YYYY-MM-DD) # noqa: E501 + + :param payment_date: The payment_date of this PayRun. # noqa: E501 + :type: date + """ + + self._payment_date = payment_date + + @property + def payslip_message(self): + """Gets the payslip_message of this PayRun. # noqa: E501 + + Payslip message for the PayRun # noqa: E501 + + :return: The payslip_message of this PayRun. # noqa: E501 + :rtype: str + """ + return self._payslip_message + + @payslip_message.setter + def payslip_message(self, payslip_message): + """Sets the payslip_message of this PayRun. + + Payslip message for the PayRun # noqa: E501 + + :param payslip_message: The payslip_message of this PayRun. # noqa: E501 + :type: str + """ + + self._payslip_message = payslip_message + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this PayRun. # noqa: E501 + + Last modified timestamp # noqa: E501 + + :return: The updated_date_utc of this PayRun. # 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 PayRun. + + Last modified timestamp # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this PayRun. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc + + @property + def payslips(self): + """Gets the payslips of this PayRun. # noqa: E501 + + The payslips in the payrun # noqa: E501 + + :return: The payslips of this PayRun. # noqa: E501 + :rtype: list[PayslipSummary] + """ + return self._payslips + + @payslips.setter + def payslips(self, payslips): + """Sets the payslips of this PayRun. + + The payslips in the payrun # noqa: E501 + + :param payslips: The payslips of this PayRun. # noqa: E501 + :type: list[PayslipSummary] + """ + + self._payslips = payslips + + @property + def wages(self): + """Gets the wages of this PayRun. # noqa: E501 + + The total Wages for the Payrun # noqa: E501 + + :return: The wages of this PayRun. # noqa: E501 + :rtype: float + """ + return self._wages + + @wages.setter + def wages(self, wages): + """Sets the wages of this PayRun. + + The total Wages for the Payrun # noqa: E501 + + :param wages: The wages of this PayRun. # noqa: E501 + :type: float + """ + + self._wages = wages + + @property + def deductions(self): + """Gets the deductions of this PayRun. # noqa: E501 + + The total Deductions for the Payrun # noqa: E501 + + :return: The deductions of this PayRun. # noqa: E501 + :rtype: float + """ + return self._deductions + + @deductions.setter + def deductions(self, deductions): + """Sets the deductions of this PayRun. + + The total Deductions for the Payrun # noqa: E501 + + :param deductions: The deductions of this PayRun. # noqa: E501 + :type: float + """ + + self._deductions = deductions + + @property + def tax(self): + """Gets the tax of this PayRun. # noqa: E501 + + The total Tax for the Payrun # noqa: E501 + + :return: The tax of this PayRun. # noqa: E501 + :rtype: float + """ + return self._tax + + @tax.setter + def tax(self, tax): + """Sets the tax of this PayRun. + + The total Tax for the Payrun # noqa: E501 + + :param tax: The tax of this PayRun. # noqa: E501 + :type: float + """ + + self._tax = tax + + @property + def super(self): + """Gets the super of this PayRun. # noqa: E501 + + The total Super for the Payrun # noqa: E501 + + :return: The super of this PayRun. # noqa: E501 + :rtype: float + """ + return self._super + + @super.setter + def super(self, super): + """Sets the super of this PayRun. + + The total Super for the Payrun # noqa: E501 + + :param super: The super of this PayRun. # noqa: E501 + :type: float + """ + + self._super = super + + @property + def reimbursement(self): + """Gets the reimbursement of this PayRun. # noqa: E501 + + The total Reimbursements for the Payrun # noqa: E501 + + :return: The reimbursement of this PayRun. # noqa: E501 + :rtype: float + """ + return self._reimbursement + + @reimbursement.setter + def reimbursement(self, reimbursement): + """Sets the reimbursement of this PayRun. + + The total Reimbursements for the Payrun # noqa: E501 + + :param reimbursement: The reimbursement of this PayRun. # noqa: E501 + :type: float + """ + + self._reimbursement = reimbursement + + @property + def net_pay(self): + """Gets the net_pay of this PayRun. # noqa: E501 + + The total NetPay for the Payrun # noqa: E501 + + :return: The net_pay of this PayRun. # noqa: E501 + :rtype: float + """ + return self._net_pay + + @net_pay.setter + def net_pay(self, net_pay): + """Sets the net_pay of this PayRun. + + The total NetPay for the Payrun # noqa: E501 + + :param net_pay: The net_pay of this PayRun. # noqa: E501 + :type: float + """ + + self._net_pay = net_pay + + @property + def validation_errors(self): + """Gets the validation_errors of this PayRun. # noqa: E501 + + Displays array of validation error messages from the API # noqa: E501 + + :return: The validation_errors of this PayRun. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._validation_errors + + @validation_errors.setter + def validation_errors(self, validation_errors): + """Sets the validation_errors of this PayRun. + + Displays array of validation error messages from the API # noqa: E501 + + :param validation_errors: The validation_errors of this PayRun. # noqa: E501 + :type: list[ValidationError] + """ + + self._validation_errors = validation_errors diff --git a/xero_python/payrollau/models/pay_run_status.py b/xero_python/payrollau/models/pay_run_status.py new file mode 100644 index 00000000..6a12d54a --- /dev/null +++ b/xero_python/payrollau/models/pay_run_status.py @@ -0,0 +1,29 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class PayRunStatus(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + DRAFT = "DRAFT" + POSTED = "POSTED" diff --git a/xero_python/payrollau/models/pay_runs.py b/xero_python/payrollau/models/pay_runs.py new file mode 100644 index 00000000..e38cc789 --- /dev/null +++ b/xero_python/payrollau/models/pay_runs.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = {"pay_runs": "list[PayRun]"} + + attribute_map = {"pay_runs": "PayRuns"} + + def __init__(self, pay_runs=None): # noqa: E501 + """PayRuns - a model defined in OpenAPI""" # noqa: E501 + + self._pay_runs = None + self.discriminator = None + + if pay_runs is not None: + self.pay_runs = pay_runs + + @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/payrollau/models/pay_template.py b/xero_python/payrollau/models/pay_template.py new file mode 100644 index 00000000..ba046dfb --- /dev/null +++ b/xero_python/payrollau/models/pay_template.py @@ -0,0 +1,180 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PayTemplate(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_lines": "list[EarningsLine]", + "deduction_lines": "list[DeductionLine]", + "super_lines": "list[SuperLine]", + "reimbursement_lines": "list[ReimbursementLine]", + "leave_lines": "list[LeaveLine]", + } + + attribute_map = { + "earnings_lines": "EarningsLines", + "deduction_lines": "DeductionLines", + "super_lines": "SuperLines", + "reimbursement_lines": "ReimbursementLines", + "leave_lines": "LeaveLines", + } + + def __init__( + self, + earnings_lines=None, + deduction_lines=None, + super_lines=None, + reimbursement_lines=None, + leave_lines=None, + ): # noqa: E501 + """PayTemplate - a model defined in OpenAPI""" # noqa: E501 + + self._earnings_lines = None + self._deduction_lines = None + self._super_lines = None + self._reimbursement_lines = None + self._leave_lines = None + self.discriminator = None + + if earnings_lines is not None: + self.earnings_lines = earnings_lines + if deduction_lines is not None: + self.deduction_lines = deduction_lines + if super_lines is not None: + self.super_lines = super_lines + if reimbursement_lines is not None: + self.reimbursement_lines = reimbursement_lines + if leave_lines is not None: + self.leave_lines = leave_lines + + @property + def earnings_lines(self): + """Gets the earnings_lines of this PayTemplate. # noqa: E501 + + + :return: The earnings_lines of this PayTemplate. # noqa: E501 + :rtype: list[EarningsLine] + """ + return self._earnings_lines + + @earnings_lines.setter + def earnings_lines(self, earnings_lines): + """Sets the earnings_lines of this PayTemplate. + + + :param earnings_lines: The earnings_lines of this PayTemplate. # noqa: E501 + :type: list[EarningsLine] + """ + + self._earnings_lines = earnings_lines + + @property + def deduction_lines(self): + """Gets the deduction_lines of this PayTemplate. # noqa: E501 + + + :return: The deduction_lines of this PayTemplate. # noqa: E501 + :rtype: list[DeductionLine] + """ + return self._deduction_lines + + @deduction_lines.setter + def deduction_lines(self, deduction_lines): + """Sets the deduction_lines of this PayTemplate. + + + :param deduction_lines: The deduction_lines of this PayTemplate. # noqa: E501 + :type: list[DeductionLine] + """ + + self._deduction_lines = deduction_lines + + @property + def super_lines(self): + """Gets the super_lines of this PayTemplate. # noqa: E501 + + + :return: The super_lines of this PayTemplate. # noqa: E501 + :rtype: list[SuperLine] + """ + return self._super_lines + + @super_lines.setter + def super_lines(self, super_lines): + """Sets the super_lines of this PayTemplate. + + + :param super_lines: The super_lines of this PayTemplate. # noqa: E501 + :type: list[SuperLine] + """ + + self._super_lines = super_lines + + @property + def reimbursement_lines(self): + """Gets the reimbursement_lines of this PayTemplate. # noqa: E501 + + + :return: The reimbursement_lines of this PayTemplate. # noqa: E501 + :rtype: list[ReimbursementLine] + """ + return self._reimbursement_lines + + @reimbursement_lines.setter + def reimbursement_lines(self, reimbursement_lines): + """Sets the reimbursement_lines of this PayTemplate. + + + :param reimbursement_lines: The reimbursement_lines of this PayTemplate. # noqa: E501 + :type: list[ReimbursementLine] + """ + + self._reimbursement_lines = reimbursement_lines + + @property + def leave_lines(self): + """Gets the leave_lines of this PayTemplate. # noqa: E501 + + + :return: The leave_lines of this PayTemplate. # noqa: E501 + :rtype: list[LeaveLine] + """ + return self._leave_lines + + @leave_lines.setter + def leave_lines(self, leave_lines): + """Sets the leave_lines of this PayTemplate. + + + :param leave_lines: The leave_lines of this PayTemplate. # noqa: E501 + :type: list[LeaveLine] + """ + + self._leave_lines = leave_lines diff --git a/xero_python/payrollau/models/payment_frequency_type.py b/xero_python/payrollau/models/payment_frequency_type.py new file mode 100644 index 00000000..ed40636c --- /dev/null +++ b/xero_python/payrollau/models/payment_frequency_type.py @@ -0,0 +1,34 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class PaymentFrequencyType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + WEEKLY = "WEEKLY" + MONTHLY = "MONTHLY" + FORTNIGHTLY = "FORTNIGHTLY" + QUARTERLY = "QUARTERLY" + TWICEMONTHLY = "TWICEMONTHLY" + FOURWEEKLY = "FOURWEEKLY" + YEARLY = "YEARLY" diff --git a/xero_python/payrollau/models/payroll_calendar.py b/xero_python/payrollau/models/payroll_calendar.py new file mode 100644 index 00000000..aed0d3fe --- /dev/null +++ b/xero_python/payrollau/models/payroll_calendar.py @@ -0,0 +1,246 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PayrollCalendar(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", + "calendar_type": "CalendarType", + "start_date": "date[ms-format]", + "payment_date": "date[ms-format]", + "payroll_calendar_id": "str", + "updated_date_utc": "datetime[ms-format]", + "validation_errors": "list[ValidationError]", + } + + attribute_map = { + "name": "Name", + "calendar_type": "CalendarType", + "start_date": "StartDate", + "payment_date": "PaymentDate", + "payroll_calendar_id": "PayrollCalendarID", + "updated_date_utc": "UpdatedDateUTC", + "validation_errors": "ValidationErrors", + } + + def __init__( + self, + name=None, + calendar_type=None, + start_date=None, + payment_date=None, + payroll_calendar_id=None, + updated_date_utc=None, + validation_errors=None, + ): # noqa: E501 + """PayrollCalendar - a model defined in OpenAPI""" # noqa: E501 + + self._name = None + self._calendar_type = None + self._start_date = None + self._payment_date = None + self._payroll_calendar_id = None + self._updated_date_utc = None + self._validation_errors = None + self.discriminator = None + + if name is not None: + self.name = name + if calendar_type is not None: + self.calendar_type = calendar_type + if start_date is not None: + self.start_date = start_date + if payment_date is not None: + self.payment_date = payment_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 validation_errors is not None: + self.validation_errors = validation_errors + + @property + def name(self): + """Gets the name of this PayrollCalendar. # noqa: E501 + + Name of the Payroll Calendar # noqa: E501 + + :return: The name of this PayrollCalendar. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this PayrollCalendar. + + Name of the Payroll Calendar # noqa: E501 + + :param name: The name of this PayrollCalendar. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def calendar_type(self): + """Gets the calendar_type of this PayrollCalendar. # noqa: E501 + + + :return: The calendar_type of this PayrollCalendar. # noqa: E501 + :rtype: CalendarType + """ + return self._calendar_type + + @calendar_type.setter + def calendar_type(self, calendar_type): + """Sets the calendar_type of this PayrollCalendar. + + + :param calendar_type: The calendar_type of this PayrollCalendar. # noqa: E501 + :type: CalendarType + """ + + self._calendar_type = calendar_type + + @property + def start_date(self): + """Gets the start_date of this PayrollCalendar. # noqa: E501 + + The start date of the upcoming pay period. The end date will be calculated based upon this date, and the calendar type selected (YYYY-MM-DD) # noqa: E501 + + :return: The start_date of this PayrollCalendar. # noqa: E501 + :rtype: date + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this PayrollCalendar. + + The start date of the upcoming pay period. The end date will be calculated based upon this date, and the calendar type selected (YYYY-MM-DD) # noqa: E501 + + :param start_date: The start_date of this PayrollCalendar. # noqa: E501 + :type: date + """ + + self._start_date = start_date + + @property + def payment_date(self): + """Gets the payment_date of this PayrollCalendar. # noqa: E501 + + The date on which employees will be paid for the upcoming pay period (YYYY-MM-DD) # noqa: E501 + + :return: The payment_date of this PayrollCalendar. # noqa: E501 + :rtype: date + """ + return self._payment_date + + @payment_date.setter + def payment_date(self, payment_date): + """Sets the payment_date of this PayrollCalendar. + + The date on which employees will be paid for the upcoming pay period (YYYY-MM-DD) # noqa: E501 + + :param payment_date: The payment_date of this PayrollCalendar. # noqa: E501 + :type: date + """ + + self._payment_date = payment_date + + @property + def payroll_calendar_id(self): + """Gets the payroll_calendar_id of this PayrollCalendar. # noqa: E501 + + Xero identifier # noqa: E501 + + :return: The payroll_calendar_id of this PayrollCalendar. # 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 PayrollCalendar. + + Xero identifier # noqa: E501 + + :param payroll_calendar_id: The payroll_calendar_id of this PayrollCalendar. # noqa: E501 + :type: str + """ + + self._payroll_calendar_id = payroll_calendar_id + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this PayrollCalendar. # noqa: E501 + + Last modified timestamp # noqa: E501 + + :return: The updated_date_utc of this PayrollCalendar. # 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 PayrollCalendar. + + Last modified timestamp # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this PayrollCalendar. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc + + @property + def validation_errors(self): + """Gets the validation_errors of this PayrollCalendar. # noqa: E501 + + Displays array of validation error messages from the API # noqa: E501 + + :return: The validation_errors of this PayrollCalendar. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._validation_errors + + @validation_errors.setter + def validation_errors(self, validation_errors): + """Sets the validation_errors of this PayrollCalendar. + + Displays array of validation error messages from the API # noqa: E501 + + :param validation_errors: The validation_errors of this PayrollCalendar. # noqa: E501 + :type: list[ValidationError] + """ + + self._validation_errors = validation_errors diff --git a/xero_python/payrollau/models/payroll_calendars.py b/xero_python/payrollau/models/payroll_calendars.py new file mode 100644 index 00000000..11d4ec97 --- /dev/null +++ b/xero_python/payrollau/models/payroll_calendars.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PayrollCalendars(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_calendars": "list[PayrollCalendar]"} + + attribute_map = {"payroll_calendars": "PayrollCalendars"} + + def __init__(self, payroll_calendars=None): # noqa: E501 + """PayrollCalendars - a model defined in OpenAPI""" # noqa: E501 + + self._payroll_calendars = None + self.discriminator = None + + if payroll_calendars is not None: + self.payroll_calendars = payroll_calendars + + @property + def payroll_calendars(self): + """Gets the payroll_calendars of this PayrollCalendars. # noqa: E501 + + + :return: The payroll_calendars of this PayrollCalendars. # noqa: E501 + :rtype: list[PayrollCalendar] + """ + return self._payroll_calendars + + @payroll_calendars.setter + def payroll_calendars(self, payroll_calendars): + """Sets the payroll_calendars of this PayrollCalendars. + + + :param payroll_calendars: The payroll_calendars of this PayrollCalendars. # noqa: E501 + :type: list[PayrollCalendar] + """ + + self._payroll_calendars = payroll_calendars diff --git a/xero_python/payrollau/models/payslip.py b/xero_python/payrollau/models/payslip.py new file mode 100644 index 00000000..9ac64c4e --- /dev/null +++ b/xero_python/payrollau/models/payslip.py @@ -0,0 +1,580 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = { + "employee_id": "str", + "payslip_id": "str", + "first_name": "str", + "last_name": "str", + "wages": "float", + "deductions": "float", + "tax": "float", + "super": "float", + "reimbursements": "float", + "net_pay": "float", + "earnings_lines": "list[EarningsLine]", + "leave_earnings_lines": "list[LeaveEarningsLine]", + "timesheet_earnings_lines": "list[EarningsLine]", + "deduction_lines": "list[DeductionLine]", + "leave_accrual_lines": "list[LeaveAccrualLine]", + "reimbursement_lines": "list[ReimbursementLine]", + "superannuation_lines": "list[SuperannuationLine]", + "tax_lines": "list[TaxLine]", + "updated_date_utc": "datetime[ms-format]", + } + + attribute_map = { + "employee_id": "EmployeeID", + "payslip_id": "PayslipID", + "first_name": "FirstName", + "last_name": "LastName", + "wages": "Wages", + "deductions": "Deductions", + "tax": "Tax", + "super": "Super", + "reimbursements": "Reimbursements", + "net_pay": "NetPay", + "earnings_lines": "EarningsLines", + "leave_earnings_lines": "LeaveEarningsLines", + "timesheet_earnings_lines": "TimesheetEarningsLines", + "deduction_lines": "DeductionLines", + "leave_accrual_lines": "LeaveAccrualLines", + "reimbursement_lines": "ReimbursementLines", + "superannuation_lines": "SuperannuationLines", + "tax_lines": "TaxLines", + "updated_date_utc": "UpdatedDateUTC", + } + + def __init__( + self, + employee_id=None, + payslip_id=None, + first_name=None, + last_name=None, + wages=None, + deductions=None, + tax=None, + super=None, + reimbursements=None, + net_pay=None, + earnings_lines=None, + leave_earnings_lines=None, + timesheet_earnings_lines=None, + deduction_lines=None, + leave_accrual_lines=None, + reimbursement_lines=None, + superannuation_lines=None, + tax_lines=None, + updated_date_utc=None, + ): # noqa: E501 + """Payslip - a model defined in OpenAPI""" # noqa: E501 + + self._employee_id = None + self._payslip_id = None + self._first_name = None + self._last_name = None + self._wages = None + self._deductions = None + self._tax = None + self._super = None + self._reimbursements = None + self._net_pay = None + self._earnings_lines = None + self._leave_earnings_lines = None + self._timesheet_earnings_lines = None + self._deduction_lines = None + self._leave_accrual_lines = None + self._reimbursement_lines = None + self._superannuation_lines = None + self._tax_lines = None + self._updated_date_utc = None + self.discriminator = None + + if employee_id is not None: + self.employee_id = employee_id + if payslip_id is not None: + self.payslip_id = payslip_id + if first_name is not None: + self.first_name = first_name + if last_name is not None: + self.last_name = last_name + if wages is not None: + self.wages = wages + if deductions is not None: + self.deductions = deductions + if tax is not None: + self.tax = tax + if super is not None: + self.super = super + if reimbursements is not None: + self.reimbursements = reimbursements + if net_pay is not None: + self.net_pay = net_pay + 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 leave_accrual_lines is not None: + self.leave_accrual_lines = leave_accrual_lines + if reimbursement_lines is not None: + self.reimbursement_lines = reimbursement_lines + if superannuation_lines is not None: + self.superannuation_lines = superannuation_lines + if tax_lines is not None: + self.tax_lines = tax_lines + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + + @property + def employee_id(self): + """Gets the employee_id of this Payslip. # noqa: E501 + + The Xero identifier for an 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 an employee # noqa: E501 + + :param employee_id: The employee_id of this Payslip. # noqa: E501 + :type: str + """ + + self._employee_id = employee_id + + @property + def payslip_id(self): + """Gets the payslip_id of this Payslip. # noqa: E501 + + Xero identifier for the payslip # noqa: E501 + + :return: The payslip_id of this Payslip. # noqa: E501 + :rtype: str + """ + return self._payslip_id + + @payslip_id.setter + def payslip_id(self, payslip_id): + """Sets the payslip_id of this Payslip. + + Xero identifier for the payslip # noqa: E501 + + :param payslip_id: The payslip_id of this Payslip. # noqa: E501 + :type: str + """ + + self._payslip_id = payslip_id + + @property + def first_name(self): + """Gets the first_name of this Payslip. # noqa: E501 + + First name of employee # 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. + + First name of employee # 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 + + Last name of employee # 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. + + Last name of employee # noqa: E501 + + :param last_name: The last_name of this Payslip. # noqa: E501 + :type: str + """ + + self._last_name = last_name + + @property + def wages(self): + """Gets the wages of this Payslip. # noqa: E501 + + The Wages for the Payslip # noqa: E501 + + :return: The wages of this Payslip. # noqa: E501 + :rtype: float + """ + return self._wages + + @wages.setter + def wages(self, wages): + """Sets the wages of this Payslip. + + The Wages for the Payslip # noqa: E501 + + :param wages: The wages of this Payslip. # noqa: E501 + :type: float + """ + + self._wages = wages + + @property + def deductions(self): + """Gets the deductions of this Payslip. # noqa: E501 + + The Deductions for the Payslip # noqa: E501 + + :return: The deductions of this Payslip. # noqa: E501 + :rtype: float + """ + return self._deductions + + @deductions.setter + def deductions(self, deductions): + """Sets the deductions of this Payslip. + + The Deductions for the Payslip # noqa: E501 + + :param deductions: The deductions of this Payslip. # noqa: E501 + :type: float + """ + + self._deductions = deductions + + @property + def tax(self): + """Gets the tax of this Payslip. # noqa: E501 + + The Tax for the Payslip # noqa: E501 + + :return: The tax of this Payslip. # noqa: E501 + :rtype: float + """ + return self._tax + + @tax.setter + def tax(self, tax): + """Sets the tax of this Payslip. + + The Tax for the Payslip # noqa: E501 + + :param tax: The tax of this Payslip. # noqa: E501 + :type: float + """ + + self._tax = tax + + @property + def super(self): + """Gets the super of this Payslip. # noqa: E501 + + The Super for the Payslip # noqa: E501 + + :return: The super of this Payslip. # noqa: E501 + :rtype: float + """ + return self._super + + @super.setter + def super(self, super): + """Sets the super of this Payslip. + + The Super for the Payslip # noqa: E501 + + :param super: The super of this Payslip. # noqa: E501 + :type: float + """ + + self._super = super + + @property + def reimbursements(self): + """Gets the reimbursements of this Payslip. # noqa: E501 + + The Reimbursements for the Payslip # noqa: E501 + + :return: The reimbursements of this Payslip. # noqa: E501 + :rtype: float + """ + return self._reimbursements + + @reimbursements.setter + def reimbursements(self, reimbursements): + """Sets the reimbursements of this Payslip. + + The Reimbursements for the Payslip # noqa: E501 + + :param reimbursements: The reimbursements of this Payslip. # noqa: E501 + :type: float + """ + + self._reimbursements = reimbursements + + @property + def net_pay(self): + """Gets the net_pay of this Payslip. # noqa: E501 + + The NetPay for the Payslip # noqa: E501 + + :return: The net_pay of this Payslip. # noqa: E501 + :rtype: float + """ + return self._net_pay + + @net_pay.setter + def net_pay(self, net_pay): + """Sets the net_pay of this Payslip. + + The NetPay for the Payslip # noqa: E501 + + :param net_pay: The net_pay of this Payslip. # noqa: E501 + :type: float + """ + + self._net_pay = net_pay + + @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[EarningsLine] + """ + 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[EarningsLine] + """ + + 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 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 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 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 tax_lines(self): + """Gets the tax_lines of this Payslip. # noqa: E501 + + + :return: The tax_lines of this Payslip. # noqa: E501 + :rtype: list[TaxLine] + """ + return self._tax_lines + + @tax_lines.setter + def tax_lines(self, tax_lines): + """Sets the tax_lines of this Payslip. + + + :param tax_lines: The tax_lines of this Payslip. # noqa: E501 + :type: list[TaxLine] + """ + + self._tax_lines = tax_lines + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this Payslip. # noqa: E501 + + Last modified timestamp # noqa: E501 + + :return: The updated_date_utc of this Payslip. # 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 Payslip. + + Last modified timestamp # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this Payslip. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc diff --git a/xero_python/payrollau/models/payslip_lines.py b/xero_python/payrollau/models/payslip_lines.py new file mode 100644 index 00000000..76c6b642 --- /dev/null +++ b/xero_python/payrollau/models/payslip_lines.py @@ -0,0 +1,261 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PayslipLines(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_lines": "list[EarningsLine]", + "leave_earnings_lines": "list[LeaveEarningsLine]", + "timesheet_earnings_lines": "list[EarningsLine]", + "deduction_lines": "list[DeductionLine]", + "leave_accrual_lines": "list[LeaveAccrualLine]", + "reimbursement_lines": "list[ReimbursementLine]", + "superannuation_lines": "list[SuperannuationLine]", + "tax_lines": "list[TaxLine]", + } + + attribute_map = { + "earnings_lines": "EarningsLines", + "leave_earnings_lines": "LeaveEarningsLines", + "timesheet_earnings_lines": "TimesheetEarningsLines", + "deduction_lines": "DeductionLines", + "leave_accrual_lines": "LeaveAccrualLines", + "reimbursement_lines": "ReimbursementLines", + "superannuation_lines": "SuperannuationLines", + "tax_lines": "TaxLines", + } + + def __init__( + self, + earnings_lines=None, + leave_earnings_lines=None, + timesheet_earnings_lines=None, + deduction_lines=None, + leave_accrual_lines=None, + reimbursement_lines=None, + superannuation_lines=None, + tax_lines=None, + ): # noqa: E501 + """PayslipLines - a model defined in OpenAPI""" # noqa: E501 + + self._earnings_lines = None + self._leave_earnings_lines = None + self._timesheet_earnings_lines = None + self._deduction_lines = None + self._leave_accrual_lines = None + self._reimbursement_lines = None + self._superannuation_lines = None + self._tax_lines = None + self.discriminator = None + + 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 leave_accrual_lines is not None: + self.leave_accrual_lines = leave_accrual_lines + if reimbursement_lines is not None: + self.reimbursement_lines = reimbursement_lines + if superannuation_lines is not None: + self.superannuation_lines = superannuation_lines + if tax_lines is not None: + self.tax_lines = tax_lines + + @property + def earnings_lines(self): + """Gets the earnings_lines of this PayslipLines. # noqa: E501 + + + :return: The earnings_lines of this PayslipLines. # noqa: E501 + :rtype: list[EarningsLine] + """ + return self._earnings_lines + + @earnings_lines.setter + def earnings_lines(self, earnings_lines): + """Sets the earnings_lines of this PayslipLines. + + + :param earnings_lines: The earnings_lines of this PayslipLines. # noqa: E501 + :type: list[EarningsLine] + """ + + self._earnings_lines = earnings_lines + + @property + def leave_earnings_lines(self): + """Gets the leave_earnings_lines of this PayslipLines. # noqa: E501 + + + :return: The leave_earnings_lines of this PayslipLines. # 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 PayslipLines. + + + :param leave_earnings_lines: The leave_earnings_lines of this PayslipLines. # 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 PayslipLines. # noqa: E501 + + + :return: The timesheet_earnings_lines of this PayslipLines. # noqa: E501 + :rtype: list[EarningsLine] + """ + return self._timesheet_earnings_lines + + @timesheet_earnings_lines.setter + def timesheet_earnings_lines(self, timesheet_earnings_lines): + """Sets the timesheet_earnings_lines of this PayslipLines. + + + :param timesheet_earnings_lines: The timesheet_earnings_lines of this PayslipLines. # noqa: E501 + :type: list[EarningsLine] + """ + + self._timesheet_earnings_lines = timesheet_earnings_lines + + @property + def deduction_lines(self): + """Gets the deduction_lines of this PayslipLines. # noqa: E501 + + + :return: The deduction_lines of this PayslipLines. # noqa: E501 + :rtype: list[DeductionLine] + """ + return self._deduction_lines + + @deduction_lines.setter + def deduction_lines(self, deduction_lines): + """Sets the deduction_lines of this PayslipLines. + + + :param deduction_lines: The deduction_lines of this PayslipLines. # noqa: E501 + :type: list[DeductionLine] + """ + + self._deduction_lines = deduction_lines + + @property + def leave_accrual_lines(self): + """Gets the leave_accrual_lines of this PayslipLines. # noqa: E501 + + + :return: The leave_accrual_lines of this PayslipLines. # 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 PayslipLines. + + + :param leave_accrual_lines: The leave_accrual_lines of this PayslipLines. # noqa: E501 + :type: list[LeaveAccrualLine] + """ + + self._leave_accrual_lines = leave_accrual_lines + + @property + def reimbursement_lines(self): + """Gets the reimbursement_lines of this PayslipLines. # noqa: E501 + + + :return: The reimbursement_lines of this PayslipLines. # noqa: E501 + :rtype: list[ReimbursementLine] + """ + return self._reimbursement_lines + + @reimbursement_lines.setter + def reimbursement_lines(self, reimbursement_lines): + """Sets the reimbursement_lines of this PayslipLines. + + + :param reimbursement_lines: The reimbursement_lines of this PayslipLines. # noqa: E501 + :type: list[ReimbursementLine] + """ + + self._reimbursement_lines = reimbursement_lines + + @property + def superannuation_lines(self): + """Gets the superannuation_lines of this PayslipLines. # noqa: E501 + + + :return: The superannuation_lines of this PayslipLines. # noqa: E501 + :rtype: list[SuperannuationLine] + """ + return self._superannuation_lines + + @superannuation_lines.setter + def superannuation_lines(self, superannuation_lines): + """Sets the superannuation_lines of this PayslipLines. + + + :param superannuation_lines: The superannuation_lines of this PayslipLines. # noqa: E501 + :type: list[SuperannuationLine] + """ + + self._superannuation_lines = superannuation_lines + + @property + def tax_lines(self): + """Gets the tax_lines of this PayslipLines. # noqa: E501 + + + :return: The tax_lines of this PayslipLines. # noqa: E501 + :rtype: list[TaxLine] + """ + return self._tax_lines + + @tax_lines.setter + def tax_lines(self, tax_lines): + """Sets the tax_lines of this PayslipLines. + + + :param tax_lines: The tax_lines of this PayslipLines. # noqa: E501 + :type: list[TaxLine] + """ + + self._tax_lines = tax_lines diff --git a/xero_python/payrollau/models/payslip_object.py b/xero_python/payrollau/models/payslip_object.py new file mode 100644 index 00000000..b462e275 --- /dev/null +++ b/xero_python/payrollau/models/payslip_object.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = {"payslip": "Payslip"} + + attribute_map = {"payslip": "Payslip"} + + def __init__(self, payslip=None): # noqa: E501 + """PayslipObject - a model defined in OpenAPI""" # noqa: E501 + + self._payslip = None + self.discriminator = None + + if payslip is not None: + self.payslip = payslip + + @property + def payslip(self): + """Gets the payslip of this PayslipObject. # noqa: E501 + + + :return: The payslip of this PayslipObject. # noqa: E501 + :rtype: Payslip + """ + return self._payslip + + @payslip.setter + def payslip(self, payslip): + """Sets the payslip of this PayslipObject. + + + :param payslip: The payslip of this PayslipObject. # noqa: E501 + :type: Payslip + """ + + self._payslip = payslip diff --git a/xero_python/payrollau/models/payslip_summary.py b/xero_python/payrollau/models/payslip_summary.py new file mode 100644 index 00000000..e02254b0 --- /dev/null +++ b/xero_python/payrollau/models/payslip_summary.py @@ -0,0 +1,393 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PayslipSummary(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", + "payslip_id": "str", + "first_name": "str", + "last_name": "str", + "employee_group": "str", + "wages": "float", + "deductions": "float", + "tax": "float", + "super": "float", + "reimbursements": "float", + "net_pay": "float", + "updated_date_utc": "datetime[ms-format]", + } + + attribute_map = { + "employee_id": "EmployeeID", + "payslip_id": "PayslipID", + "first_name": "FirstName", + "last_name": "LastName", + "employee_group": "EmployeeGroup", + "wages": "Wages", + "deductions": "Deductions", + "tax": "Tax", + "super": "Super", + "reimbursements": "Reimbursements", + "net_pay": "NetPay", + "updated_date_utc": "UpdatedDateUTC", + } + + def __init__( + self, + employee_id=None, + payslip_id=None, + first_name=None, + last_name=None, + employee_group=None, + wages=None, + deductions=None, + tax=None, + super=None, + reimbursements=None, + net_pay=None, + updated_date_utc=None, + ): # noqa: E501 + """PayslipSummary - a model defined in OpenAPI""" # noqa: E501 + + self._employee_id = None + self._payslip_id = None + self._first_name = None + self._last_name = None + self._employee_group = None + self._wages = None + self._deductions = None + self._tax = None + self._super = None + self._reimbursements = None + self._net_pay = None + self._updated_date_utc = None + self.discriminator = None + + if employee_id is not None: + self.employee_id = employee_id + if payslip_id is not None: + self.payslip_id = payslip_id + if first_name is not None: + self.first_name = first_name + if last_name is not None: + self.last_name = last_name + if employee_group is not None: + self.employee_group = employee_group + if wages is not None: + self.wages = wages + if deductions is not None: + self.deductions = deductions + if tax is not None: + self.tax = tax + if super is not None: + self.super = super + if reimbursements is not None: + self.reimbursements = reimbursements + if net_pay is not None: + self.net_pay = net_pay + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + + @property + def employee_id(self): + """Gets the employee_id of this PayslipSummary. # noqa: E501 + + The Xero identifier for an employee # noqa: E501 + + :return: The employee_id of this PayslipSummary. # noqa: E501 + :rtype: str + """ + return self._employee_id + + @employee_id.setter + def employee_id(self, employee_id): + """Sets the employee_id of this PayslipSummary. + + The Xero identifier for an employee # noqa: E501 + + :param employee_id: The employee_id of this PayslipSummary. # noqa: E501 + :type: str + """ + + self._employee_id = employee_id + + @property + def payslip_id(self): + """Gets the payslip_id of this PayslipSummary. # noqa: E501 + + Xero identifier for the payslip # noqa: E501 + + :return: The payslip_id of this PayslipSummary. # noqa: E501 + :rtype: str + """ + return self._payslip_id + + @payslip_id.setter + def payslip_id(self, payslip_id): + """Sets the payslip_id of this PayslipSummary. + + Xero identifier for the payslip # noqa: E501 + + :param payslip_id: The payslip_id of this PayslipSummary. # noqa: E501 + :type: str + """ + + self._payslip_id = payslip_id + + @property + def first_name(self): + """Gets the first_name of this PayslipSummary. # noqa: E501 + + First name of employee # noqa: E501 + + :return: The first_name of this PayslipSummary. # noqa: E501 + :rtype: str + """ + return self._first_name + + @first_name.setter + def first_name(self, first_name): + """Sets the first_name of this PayslipSummary. + + First name of employee # noqa: E501 + + :param first_name: The first_name of this PayslipSummary. # noqa: E501 + :type: str + """ + + self._first_name = first_name + + @property + def last_name(self): + """Gets the last_name of this PayslipSummary. # noqa: E501 + + Last name of employee # noqa: E501 + + :return: The last_name of this PayslipSummary. # noqa: E501 + :rtype: str + """ + return self._last_name + + @last_name.setter + def last_name(self, last_name): + """Sets the last_name of this PayslipSummary. + + Last name of employee # noqa: E501 + + :param last_name: The last_name of this PayslipSummary. # noqa: E501 + :type: str + """ + + self._last_name = last_name + + @property + def employee_group(self): + """Gets the employee_group of this PayslipSummary. # noqa: E501 + + Employee group name # noqa: E501 + + :return: The employee_group of this PayslipSummary. # noqa: E501 + :rtype: str + """ + return self._employee_group + + @employee_group.setter + def employee_group(self, employee_group): + """Sets the employee_group of this PayslipSummary. + + Employee group name # noqa: E501 + + :param employee_group: The employee_group of this PayslipSummary. # noqa: E501 + :type: str + """ + + self._employee_group = employee_group + + @property + def wages(self): + """Gets the wages of this PayslipSummary. # noqa: E501 + + The Wages for the Payslip # noqa: E501 + + :return: The wages of this PayslipSummary. # noqa: E501 + :rtype: float + """ + return self._wages + + @wages.setter + def wages(self, wages): + """Sets the wages of this PayslipSummary. + + The Wages for the Payslip # noqa: E501 + + :param wages: The wages of this PayslipSummary. # noqa: E501 + :type: float + """ + + self._wages = wages + + @property + def deductions(self): + """Gets the deductions of this PayslipSummary. # noqa: E501 + + The Deductions for the Payslip # noqa: E501 + + :return: The deductions of this PayslipSummary. # noqa: E501 + :rtype: float + """ + return self._deductions + + @deductions.setter + def deductions(self, deductions): + """Sets the deductions of this PayslipSummary. + + The Deductions for the Payslip # noqa: E501 + + :param deductions: The deductions of this PayslipSummary. # noqa: E501 + :type: float + """ + + self._deductions = deductions + + @property + def tax(self): + """Gets the tax of this PayslipSummary. # noqa: E501 + + The Tax for the Payslip # noqa: E501 + + :return: The tax of this PayslipSummary. # noqa: E501 + :rtype: float + """ + return self._tax + + @tax.setter + def tax(self, tax): + """Sets the tax of this PayslipSummary. + + The Tax for the Payslip # noqa: E501 + + :param tax: The tax of this PayslipSummary. # noqa: E501 + :type: float + """ + + self._tax = tax + + @property + def super(self): + """Gets the super of this PayslipSummary. # noqa: E501 + + The Super for the Payslip # noqa: E501 + + :return: The super of this PayslipSummary. # noqa: E501 + :rtype: float + """ + return self._super + + @super.setter + def super(self, super): + """Sets the super of this PayslipSummary. + + The Super for the Payslip # noqa: E501 + + :param super: The super of this PayslipSummary. # noqa: E501 + :type: float + """ + + self._super = super + + @property + def reimbursements(self): + """Gets the reimbursements of this PayslipSummary. # noqa: E501 + + The Reimbursements for the Payslip # noqa: E501 + + :return: The reimbursements of this PayslipSummary. # noqa: E501 + :rtype: float + """ + return self._reimbursements + + @reimbursements.setter + def reimbursements(self, reimbursements): + """Sets the reimbursements of this PayslipSummary. + + The Reimbursements for the Payslip # noqa: E501 + + :param reimbursements: The reimbursements of this PayslipSummary. # noqa: E501 + :type: float + """ + + self._reimbursements = reimbursements + + @property + def net_pay(self): + """Gets the net_pay of this PayslipSummary. # noqa: E501 + + The NetPay for the Payslip # noqa: E501 + + :return: The net_pay of this PayslipSummary. # noqa: E501 + :rtype: float + """ + return self._net_pay + + @net_pay.setter + def net_pay(self, net_pay): + """Sets the net_pay of this PayslipSummary. + + The NetPay for the Payslip # noqa: E501 + + :param net_pay: The net_pay of this PayslipSummary. # noqa: E501 + :type: float + """ + + self._net_pay = net_pay + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this PayslipSummary. # noqa: E501 + + Last modified timestamp # noqa: E501 + + :return: The updated_date_utc of this PayslipSummary. # 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 PayslipSummary. + + Last modified timestamp # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this PayslipSummary. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc diff --git a/xero_python/payrollau/models/payslips.py b/xero_python/payrollau/models/payslips.py new file mode 100644 index 00000000..3281f7ce --- /dev/null +++ b/xero_python/payrollau/models/payslips.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = {"payslips": "list[Payslip]"} + + attribute_map = {"payslips": "Payslips"} + + def __init__(self, payslips=None): # noqa: E501 + """Payslips - a model defined in OpenAPI""" # noqa: E501 + + self._payslips = None + self.discriminator = None + + if payslips is not None: + self.payslips = payslips + + @property + def payslips(self): + """Gets the payslips of this Payslips. # noqa: E501 + + + :return: The payslips of this Payslips. # noqa: E501 + :rtype: list[Payslip] + """ + return self._payslips + + @payslips.setter + def payslips(self, payslips): + """Sets the payslips of this Payslips. + + + :param payslips: The payslips of this Payslips. # noqa: E501 + :type: list[Payslip] + """ + + self._payslips = payslips diff --git a/xero_python/payrollau/models/rate_type.py b/xero_python/payrollau/models/rate_type.py new file mode 100644 index 00000000..c455b62e --- /dev/null +++ b/xero_python/payrollau/models/rate_type.py @@ -0,0 +1,30 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class RateType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + FIXEDAMOUNT = "FIXEDAMOUNT" + MULTIPLE = "MULTIPLE" + RATEPERUNIT = "RATEPERUNIT" diff --git a/xero_python/payrollau/models/reimbursement_line.py b/xero_python/payrollau/models/reimbursement_line.py new file mode 100644 index 00000000..fa1dfe41 --- /dev/null +++ b/xero_python/payrollau/models/reimbursement_line.py @@ -0,0 +1,166 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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", + "amount": "float", + "description": "str", + "expense_account": "str", + } + + attribute_map = { + "reimbursement_type_id": "ReimbursementTypeID", + "amount": "Amount", + "description": "Description", + "expense_account": "ExpenseAccount", + } + + def __init__( + self, + reimbursement_type_id=None, + amount=None, + description=None, + expense_account=None, + ): # noqa: E501 + """ReimbursementLine - a model defined in OpenAPI""" # noqa: E501 + + self._reimbursement_type_id = None + self._amount = None + self._description = None + self._expense_account = None + self.discriminator = None + + if reimbursement_type_id is not None: + self.reimbursement_type_id = reimbursement_type_id + if amount is not None: + self.amount = amount + if description is not None: + self.description = description + if expense_account is not None: + self.expense_account = expense_account + + @property + def reimbursement_type_id(self): + """Gets the reimbursement_type_id of this ReimbursementLine. # noqa: E501 + + Xero reimbursement type identifier # 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 reimbursement type identifier # 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 amount(self): + """Gets the amount of this ReimbursementLine. # noqa: E501 + + Reimbursement type 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 type amount # noqa: E501 + + :param amount: The amount of this ReimbursementLine. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def description(self): + """Gets the description of this ReimbursementLine. # noqa: E501 + + Reimbursement lines description (max length 50) # 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 lines description (max length 50) # noqa: E501 + + :param description: The description of this ReimbursementLine. # noqa: E501 + :type: str + """ + if description is not None and len(description) > 50: + raise ValueError( + "Invalid value for `description`, " + "length must be less than or equal to `50`" + ) # noqa: E501 + + self._description = description + + @property + def expense_account(self): + """Gets the expense_account of this ReimbursementLine. # noqa: E501 + + Reimbursement expense account. For posted pay run you should be able to see expense account code. # noqa: E501 + + :return: The expense_account of this ReimbursementLine. # noqa: E501 + :rtype: str + """ + return self._expense_account + + @expense_account.setter + def expense_account(self, expense_account): + """Sets the expense_account of this ReimbursementLine. + + Reimbursement expense account. For posted pay run you should be able to see expense account code. # noqa: E501 + + :param expense_account: The expense_account of this ReimbursementLine. # noqa: E501 + :type: str + """ + + self._expense_account = expense_account diff --git a/xero_python/payrollau/models/reimbursement_lines.py b/xero_python/payrollau/models/reimbursement_lines.py new file mode 100644 index 00000000..e151b375 --- /dev/null +++ b/xero_python/payrollau/models/reimbursement_lines.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class ReimbursementLines(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_lines": "list[ReimbursementLine]"} + + attribute_map = {"reimbursement_lines": "ReimbursementLines"} + + def __init__(self, reimbursement_lines=None): # noqa: E501 + """ReimbursementLines - a model defined in OpenAPI""" # noqa: E501 + + self._reimbursement_lines = None + self.discriminator = None + + if reimbursement_lines is not None: + self.reimbursement_lines = reimbursement_lines + + @property + def reimbursement_lines(self): + """Gets the reimbursement_lines of this ReimbursementLines. # noqa: E501 + + + :return: The reimbursement_lines of this ReimbursementLines. # noqa: E501 + :rtype: list[ReimbursementLine] + """ + return self._reimbursement_lines + + @reimbursement_lines.setter + def reimbursement_lines(self, reimbursement_lines): + """Sets the reimbursement_lines of this ReimbursementLines. + + + :param reimbursement_lines: The reimbursement_lines of this ReimbursementLines. # noqa: E501 + :type: list[ReimbursementLine] + """ + + self._reimbursement_lines = reimbursement_lines diff --git a/xero_python/payrollau/models/reimbursement_type.py b/xero_python/payrollau/models/reimbursement_type.py new file mode 100644 index 00000000..78e507ae --- /dev/null +++ b/xero_python/payrollau/models/reimbursement_type.py @@ -0,0 +1,195 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class ReimbursementType(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", + "account_code": "str", + "reimbursement_type_id": "str", + "updated_date_utc": "datetime[ms-format]", + "current_record": "bool", + } + + attribute_map = { + "name": "Name", + "account_code": "AccountCode", + "reimbursement_type_id": "ReimbursementTypeID", + "updated_date_utc": "UpdatedDateUTC", + "current_record": "CurrentRecord", + } + + def __init__( + self, + name=None, + account_code=None, + reimbursement_type_id=None, + updated_date_utc=None, + current_record=None, + ): # noqa: E501 + """ReimbursementType - a model defined in OpenAPI""" # noqa: E501 + + self._name = None + self._account_code = None + self._reimbursement_type_id = None + self._updated_date_utc = None + self._current_record = None + self.discriminator = None + + if name is not None: + self.name = name + if account_code is not None: + self.account_code = account_code + if reimbursement_type_id is not None: + self.reimbursement_type_id = reimbursement_type_id + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + if current_record is not None: + self.current_record = current_record + + @property + def name(self): + """Gets the name of this ReimbursementType. # noqa: E501 + + Name of the earnings rate (max length = 100) # noqa: E501 + + :return: The name of this ReimbursementType. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this ReimbursementType. + + Name of the earnings rate (max length = 100) # noqa: E501 + + :param name: The name of this ReimbursementType. # noqa: E501 + :type: str + """ + if name is not None and len(name) > 100: + raise ValueError( + "Invalid value for `name`, " + "length must be less than or equal to `100`" + ) # noqa: E501 + + self._name = name + + @property + def account_code(self): + """Gets the account_code of this ReimbursementType. # noqa: E501 + + See Accounts # noqa: E501 + + :return: The account_code of this ReimbursementType. # noqa: E501 + :rtype: str + """ + return self._account_code + + @account_code.setter + def account_code(self, account_code): + """Sets the account_code of this ReimbursementType. + + See Accounts # noqa: E501 + + :param account_code: The account_code of this ReimbursementType. # noqa: E501 + :type: str + """ + + self._account_code = account_code + + @property + def reimbursement_type_id(self): + """Gets the reimbursement_type_id of this ReimbursementType. # noqa: E501 + + Xero identifier # noqa: E501 + + :return: The reimbursement_type_id of this ReimbursementType. # 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 ReimbursementType. + + Xero identifier # noqa: E501 + + :param reimbursement_type_id: The reimbursement_type_id of this ReimbursementType. # noqa: E501 + :type: str + """ + + self._reimbursement_type_id = reimbursement_type_id + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this ReimbursementType. # noqa: E501 + + Last modified timestamp # noqa: E501 + + :return: The updated_date_utc of this ReimbursementType. # 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 ReimbursementType. + + Last modified timestamp # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this ReimbursementType. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc + + @property + def current_record(self): + """Gets the current_record of this ReimbursementType. # noqa: E501 + + Is the current record # noqa: E501 + + :return: The current_record of this ReimbursementType. # noqa: E501 + :rtype: bool + """ + return self._current_record + + @current_record.setter + def current_record(self, current_record): + """Sets the current_record of this ReimbursementType. + + Is the current record # noqa: E501 + + :param current_record: The current_record of this ReimbursementType. # noqa: E501 + :type: bool + """ + + self._current_record = current_record diff --git a/xero_python/payrollau/models/residency_status.py b/xero_python/payrollau/models/residency_status.py new file mode 100644 index 00000000..dd785836 --- /dev/null +++ b/xero_python/payrollau/models/residency_status.py @@ -0,0 +1,30 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class ResidencyStatus(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + AUSTRALIANRESIDENT = "AUSTRALIANRESIDENT" + FOREIGNRESIDENT = "FOREIGNRESIDENT" + WORKINGHOLIDAYMAKER = "WORKINGHOLIDAYMAKER" diff --git a/xero_python/payrollau/models/settings.py b/xero_python/payrollau/models/settings.py new file mode 100644 index 00000000..bc228ccf --- /dev/null +++ b/xero_python/payrollau/models/settings.py @@ -0,0 +1,127 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = { + "accounts": "list[Account]", + "tracking_categories": "SettingsTrackingCategories", + "days_in_payroll_year": "int", + } + + attribute_map = { + "accounts": "Accounts", + "tracking_categories": "TrackingCategories", + "days_in_payroll_year": "DaysInPayrollYear", + } + + def __init__( + self, accounts=None, tracking_categories=None, days_in_payroll_year=None + ): # noqa: E501 + """Settings - a model defined in OpenAPI""" # noqa: E501 + + self._accounts = None + self._tracking_categories = None + self._days_in_payroll_year = None + self.discriminator = None + + if accounts is not None: + self.accounts = accounts + if tracking_categories is not None: + self.tracking_categories = tracking_categories + if days_in_payroll_year is not None: + self.days_in_payroll_year = days_in_payroll_year + + @property + def accounts(self): + """Gets the accounts of this Settings. # noqa: E501 + + Payroll Account details for SuperExpense, SuperLiabilty, WagesExpense, PAYGLiability & WagesPayable. # noqa: E501 + + :return: The accounts of this Settings. # noqa: E501 + :rtype: list[Account] + """ + return self._accounts + + @accounts.setter + def accounts(self, accounts): + """Sets the accounts of this Settings. + + Payroll Account details for SuperExpense, SuperLiabilty, WagesExpense, PAYGLiability & WagesPayable. # noqa: E501 + + :param accounts: The accounts of this Settings. # noqa: E501 + :type: list[Account] + """ + + self._accounts = accounts + + @property + def tracking_categories(self): + """Gets the tracking_categories of this Settings. # noqa: E501 + + + :return: The tracking_categories of this Settings. # noqa: E501 + :rtype: SettingsTrackingCategories + """ + return self._tracking_categories + + @tracking_categories.setter + def tracking_categories(self, tracking_categories): + """Sets the tracking_categories of this Settings. + + + :param tracking_categories: The tracking_categories of this Settings. # noqa: E501 + :type: SettingsTrackingCategories + """ + + self._tracking_categories = tracking_categories + + @property + def days_in_payroll_year(self): + """Gets the days_in_payroll_year of this Settings. # noqa: E501 + + Number of days in the Payroll year # noqa: E501 + + :return: The days_in_payroll_year of this Settings. # noqa: E501 + :rtype: int + """ + return self._days_in_payroll_year + + @days_in_payroll_year.setter + def days_in_payroll_year(self, days_in_payroll_year): + """Sets the days_in_payroll_year of this Settings. + + Number of days in the Payroll year # noqa: E501 + + :param days_in_payroll_year: The days_in_payroll_year of this Settings. # noqa: E501 + :type: int + """ + + self._days_in_payroll_year = days_in_payroll_year diff --git a/xero_python/payrollau/models/settings_object.py b/xero_python/payrollau/models/settings_object.py new file mode 100644 index 00000000..ad390edb --- /dev/null +++ b/xero_python/payrollau/models/settings_object.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SettingsObject(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 = {"settings": "Settings"} + + attribute_map = {"settings": "Settings"} + + def __init__(self, settings=None): # noqa: E501 + """SettingsObject - a model defined in OpenAPI""" # noqa: E501 + + self._settings = None + self.discriminator = None + + if settings is not None: + self.settings = settings + + @property + def settings(self): + """Gets the settings of this SettingsObject. # noqa: E501 + + + :return: The settings of this SettingsObject. # noqa: E501 + :rtype: Settings + """ + return self._settings + + @settings.setter + def settings(self, settings): + """Sets the settings of this SettingsObject. + + + :param settings: The settings of this SettingsObject. # noqa: E501 + :type: Settings + """ + + self._settings = settings diff --git a/xero_python/payrollau/models/settings_tracking_categories.py b/xero_python/payrollau/models/settings_tracking_categories.py new file mode 100644 index 00000000..ebd55aaf --- /dev/null +++ b/xero_python/payrollau/models/settings_tracking_categories.py @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SettingsTrackingCategories(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": "SettingsTrackingCategoriesEmployeeGroups", + "timesheet_categories": "SettingsTrackingCategoriesTimesheetCategories", + } + + attribute_map = { + "employee_groups": "EmployeeGroups", + "timesheet_categories": "TimesheetCategories", + } + + def __init__(self, employee_groups=None, timesheet_categories=None): # noqa: E501 + """SettingsTrackingCategories - a model defined in OpenAPI""" # noqa: E501 + + self._employee_groups = None + self._timesheet_categories = None + self.discriminator = None + + if employee_groups is not None: + self.employee_groups = employee_groups + if timesheet_categories is not None: + self.timesheet_categories = timesheet_categories + + @property + def employee_groups(self): + """Gets the employee_groups of this SettingsTrackingCategories. # noqa: E501 + + + :return: The employee_groups of this SettingsTrackingCategories. # noqa: E501 + :rtype: SettingsTrackingCategoriesEmployeeGroups + """ + return self._employee_groups + + @employee_groups.setter + def employee_groups(self, employee_groups): + """Sets the employee_groups of this SettingsTrackingCategories. + + + :param employee_groups: The employee_groups of this SettingsTrackingCategories. # noqa: E501 + :type: SettingsTrackingCategoriesEmployeeGroups + """ + + self._employee_groups = employee_groups + + @property + def timesheet_categories(self): + """Gets the timesheet_categories of this SettingsTrackingCategories. # noqa: E501 + + + :return: The timesheet_categories of this SettingsTrackingCategories. # noqa: E501 + :rtype: SettingsTrackingCategoriesTimesheetCategories + """ + return self._timesheet_categories + + @timesheet_categories.setter + def timesheet_categories(self, timesheet_categories): + """Sets the timesheet_categories of this SettingsTrackingCategories. + + + :param timesheet_categories: The timesheet_categories of this SettingsTrackingCategories. # noqa: E501 + :type: SettingsTrackingCategoriesTimesheetCategories + """ + + self._timesheet_categories = timesheet_categories diff --git a/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py b/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py new file mode 100644 index 00000000..97b906d5 --- /dev/null +++ b/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SettingsTrackingCategoriesEmployeeGroups(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 = {"tracking_category_id": "str", "tracking_category_name": "str"} + + attribute_map = { + "tracking_category_id": "TrackingCategoryID", + "tracking_category_name": "TrackingCategoryName", + } + + def __init__( + self, tracking_category_id=None, tracking_category_name=None + ): # noqa: E501 + """SettingsTrackingCategoriesEmployeeGroups - a model defined in OpenAPI""" # noqa: E501 + + self._tracking_category_id = None + self._tracking_category_name = None + self.discriminator = None + + if tracking_category_id is not None: + self.tracking_category_id = tracking_category_id + if tracking_category_name is not None: + self.tracking_category_name = tracking_category_name + + @property + def tracking_category_id(self): + """Gets the tracking_category_id of this SettingsTrackingCategoriesEmployeeGroups. # noqa: E501 + + The identifier for the tracking category # noqa: E501 + + :return: The tracking_category_id of this SettingsTrackingCategoriesEmployeeGroups. # noqa: E501 + :rtype: str + """ + return self._tracking_category_id + + @tracking_category_id.setter + def tracking_category_id(self, tracking_category_id): + """Sets the tracking_category_id of this SettingsTrackingCategoriesEmployeeGroups. + + The identifier for the tracking category # noqa: E501 + + :param tracking_category_id: The tracking_category_id of this SettingsTrackingCategoriesEmployeeGroups. # noqa: E501 + :type: str + """ + + self._tracking_category_id = tracking_category_id + + @property + def tracking_category_name(self): + """Gets the tracking_category_name of this SettingsTrackingCategoriesEmployeeGroups. # noqa: E501 + + Name of the tracking category # noqa: E501 + + :return: The tracking_category_name of this SettingsTrackingCategoriesEmployeeGroups. # noqa: E501 + :rtype: str + """ + return self._tracking_category_name + + @tracking_category_name.setter + def tracking_category_name(self, tracking_category_name): + """Sets the tracking_category_name of this SettingsTrackingCategoriesEmployeeGroups. + + Name of the tracking category # noqa: E501 + + :param tracking_category_name: The tracking_category_name of this SettingsTrackingCategoriesEmployeeGroups. # noqa: E501 + :type: str + """ + + self._tracking_category_name = tracking_category_name diff --git a/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py b/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py new file mode 100644 index 00000000..baf33b20 --- /dev/null +++ b/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SettingsTrackingCategoriesTimesheetCategories(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 = {"tracking_category_id": "str", "tracking_category_name": "str"} + + attribute_map = { + "tracking_category_id": "TrackingCategoryID", + "tracking_category_name": "TrackingCategoryName", + } + + def __init__( + self, tracking_category_id=None, tracking_category_name=None + ): # noqa: E501 + """SettingsTrackingCategoriesTimesheetCategories - a model defined in OpenAPI""" # noqa: E501 + + self._tracking_category_id = None + self._tracking_category_name = None + self.discriminator = None + + if tracking_category_id is not None: + self.tracking_category_id = tracking_category_id + if tracking_category_name is not None: + self.tracking_category_name = tracking_category_name + + @property + def tracking_category_id(self): + """Gets the tracking_category_id of this SettingsTrackingCategoriesTimesheetCategories. # noqa: E501 + + The identifier for the tracking category # noqa: E501 + + :return: The tracking_category_id of this SettingsTrackingCategoriesTimesheetCategories. # noqa: E501 + :rtype: str + """ + return self._tracking_category_id + + @tracking_category_id.setter + def tracking_category_id(self, tracking_category_id): + """Sets the tracking_category_id of this SettingsTrackingCategoriesTimesheetCategories. + + The identifier for the tracking category # noqa: E501 + + :param tracking_category_id: The tracking_category_id of this SettingsTrackingCategoriesTimesheetCategories. # noqa: E501 + :type: str + """ + + self._tracking_category_id = tracking_category_id + + @property + def tracking_category_name(self): + """Gets the tracking_category_name of this SettingsTrackingCategoriesTimesheetCategories. # noqa: E501 + + Name of the tracking category # noqa: E501 + + :return: The tracking_category_name of this SettingsTrackingCategoriesTimesheetCategories. # noqa: E501 + :rtype: str + """ + return self._tracking_category_name + + @tracking_category_name.setter + def tracking_category_name(self, tracking_category_name): + """Sets the tracking_category_name of this SettingsTrackingCategoriesTimesheetCategories. + + Name of the tracking category # noqa: E501 + + :param tracking_category_name: The tracking_category_name of this SettingsTrackingCategoriesTimesheetCategories. # noqa: E501 + :type: str + """ + + self._tracking_category_name = tracking_category_name diff --git a/xero_python/payrollau/models/state.py b/xero_python/payrollau/models/state.py new file mode 100644 index 00000000..dcf79817 --- /dev/null +++ b/xero_python/payrollau/models/state.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class State(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + ACT = "ACT" + NSW = "NSW" + NT = "NT" + QLD = "QLD" + SA = "SA" + TAS = "TAS" + VIC = "VIC" + WA = "WA" diff --git a/xero_python/payrollau/models/super_fund.py b/xero_python/payrollau/models/super_fund.py new file mode 100644 index 00000000..0289ec37 --- /dev/null +++ b/xero_python/payrollau/models/super_fund.py @@ -0,0 +1,423 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SuperFund(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 = { + "super_fund_id": "str", + "type": "SuperFundType", + "name": "str", + "abn": "str", + "bsb": "str", + "account_number": "str", + "account_name": "str", + "electronic_service_address": "str", + "employer_number": "str", + "spin": "str", + "usi": "str", + "updated_date_utc": "datetime[ms-format]", + "validation_errors": "list[ValidationError]", + } + + attribute_map = { + "super_fund_id": "SuperFundID", + "type": "Type", + "name": "Name", + "abn": "ABN", + "bsb": "BSB", + "account_number": "AccountNumber", + "account_name": "AccountName", + "electronic_service_address": "ElectronicServiceAddress", + "employer_number": "EmployerNumber", + "spin": "SPIN", + "usi": "USI", + "updated_date_utc": "UpdatedDateUTC", + "validation_errors": "ValidationErrors", + } + + def __init__( + self, + super_fund_id=None, + type=None, + name=None, + abn=None, + bsb=None, + account_number=None, + account_name=None, + electronic_service_address=None, + employer_number=None, + spin=None, + usi=None, + updated_date_utc=None, + validation_errors=None, + ): # noqa: E501 + """SuperFund - a model defined in OpenAPI""" # noqa: E501 + + self._super_fund_id = None + self._type = None + self._name = None + self._abn = None + self._bsb = None + self._account_number = None + self._account_name = None + self._electronic_service_address = None + self._employer_number = None + self._spin = None + self._usi = None + self._updated_date_utc = None + self._validation_errors = None + self.discriminator = None + + if super_fund_id is not None: + self.super_fund_id = super_fund_id + self.type = type + if name is not None: + self.name = name + if abn is not None: + self.abn = abn + if bsb is not None: + self.bsb = bsb + if account_number is not None: + self.account_number = account_number + if account_name is not None: + self.account_name = account_name + if electronic_service_address is not None: + self.electronic_service_address = electronic_service_address + if employer_number is not None: + self.employer_number = employer_number + if spin is not None: + self.spin = spin + if usi is not None: + self.usi = usi + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + if validation_errors is not None: + self.validation_errors = validation_errors + + @property + def super_fund_id(self): + """Gets the super_fund_id of this SuperFund. # noqa: E501 + + Xero identifier for a super fund # noqa: E501 + + :return: The super_fund_id of this SuperFund. # noqa: E501 + :rtype: str + """ + return self._super_fund_id + + @super_fund_id.setter + def super_fund_id(self, super_fund_id): + """Sets the super_fund_id of this SuperFund. + + Xero identifier for a super fund # noqa: E501 + + :param super_fund_id: The super_fund_id of this SuperFund. # noqa: E501 + :type: str + """ + + self._super_fund_id = super_fund_id + + @property + def type(self): + """Gets the type of this SuperFund. # noqa: E501 + + + :return: The type of this SuperFund. # noqa: E501 + :rtype: SuperFundType + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this SuperFund. + + + :param type: The type of this SuperFund. # noqa: E501 + :type: SuperFundType + """ + if type is None: + raise ValueError( + "Invalid value for `type`, must not be `None`" + ) # noqa: E501 + + self._type = type + + @property + def name(self): + """Gets the name of this SuperFund. # noqa: E501 + + Name of the super fund # noqa: E501 + + :return: The name of this SuperFund. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this SuperFund. + + Name of the super fund # noqa: E501 + + :param name: The name of this SuperFund. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def abn(self): + """Gets the abn of this SuperFund. # noqa: E501 + + ABN of the self managed super fund # noqa: E501 + + :return: The abn of this SuperFund. # noqa: E501 + :rtype: str + """ + return self._abn + + @abn.setter + def abn(self, abn): + """Sets the abn of this SuperFund. + + ABN of the self managed super fund # noqa: E501 + + :param abn: The abn of this SuperFund. # noqa: E501 + :type: str + """ + + self._abn = abn + + @property + def bsb(self): + """Gets the bsb of this SuperFund. # noqa: E501 + + BSB of the self managed super fund # noqa: E501 + + :return: The bsb of this SuperFund. # noqa: E501 + :rtype: str + """ + return self._bsb + + @bsb.setter + def bsb(self, bsb): + """Sets the bsb of this SuperFund. + + BSB of the self managed super fund # noqa: E501 + + :param bsb: The bsb of this SuperFund. # noqa: E501 + :type: str + """ + + self._bsb = bsb + + @property + def account_number(self): + """Gets the account_number of this SuperFund. # noqa: E501 + + The account number for the self managed super fund. # noqa: E501 + + :return: The account_number of this SuperFund. # noqa: E501 + :rtype: str + """ + return self._account_number + + @account_number.setter + def account_number(self, account_number): + """Sets the account_number of this SuperFund. + + The account number for the self managed super fund. # noqa: E501 + + :param account_number: The account_number of this SuperFund. # noqa: E501 + :type: str + """ + + self._account_number = account_number + + @property + def account_name(self): + """Gets the account_name of this SuperFund. # noqa: E501 + + The account name for the self managed super fund. # noqa: E501 + + :return: The account_name of this SuperFund. # noqa: E501 + :rtype: str + """ + return self._account_name + + @account_name.setter + def account_name(self, account_name): + """Sets the account_name of this SuperFund. + + The account name for the self managed super fund. # noqa: E501 + + :param account_name: The account_name of this SuperFund. # noqa: E501 + :type: str + """ + + self._account_name = account_name + + @property + def electronic_service_address(self): + """Gets the electronic_service_address of this SuperFund. # noqa: E501 + + The electronic service address for the self managed super fund. # noqa: E501 + + :return: The electronic_service_address of this SuperFund. # noqa: E501 + :rtype: str + """ + return self._electronic_service_address + + @electronic_service_address.setter + def electronic_service_address(self, electronic_service_address): + """Sets the electronic_service_address of this SuperFund. + + The electronic service address for the self managed super fund. # noqa: E501 + + :param electronic_service_address: The electronic_service_address of this SuperFund. # noqa: E501 + :type: str + """ + + self._electronic_service_address = electronic_service_address + + @property + def employer_number(self): + """Gets the employer_number of this SuperFund. # noqa: E501 + + Some funds assign a unique number to each employer # noqa: E501 + + :return: The employer_number of this SuperFund. # noqa: E501 + :rtype: str + """ + return self._employer_number + + @employer_number.setter + def employer_number(self, employer_number): + """Sets the employer_number of this SuperFund. + + Some funds assign a unique number to each employer # noqa: E501 + + :param employer_number: The employer_number of this SuperFund. # noqa: E501 + :type: str + """ + + self._employer_number = employer_number + + @property + def spin(self): + """Gets the spin of this SuperFund. # noqa: E501 + + The SPIN of the Regulated SuperFund. This field has been deprecated. It will only be present for legacy superfunds. New superfunds will not have a SPIN value. The USI field should be used instead of SPIN. # noqa: E501 + + :return: The spin of this SuperFund. # noqa: E501 + :rtype: str + """ + return self._spin + + @spin.setter + def spin(self, spin): + """Sets the spin of this SuperFund. + + The SPIN of the Regulated SuperFund. This field has been deprecated. It will only be present for legacy superfunds. New superfunds will not have a SPIN value. The USI field should be used instead of SPIN. # noqa: E501 + + :param spin: The spin of this SuperFund. # noqa: E501 + :type: str + """ + + self._spin = spin + + @property + def usi(self): + """Gets the usi of this SuperFund. # noqa: E501 + + The USI of the Regulated SuperFund # noqa: E501 + + :return: The usi of this SuperFund. # noqa: E501 + :rtype: str + """ + return self._usi + + @usi.setter + def usi(self, usi): + """Sets the usi of this SuperFund. + + The USI of the Regulated SuperFund # noqa: E501 + + :param usi: The usi of this SuperFund. # noqa: E501 + :type: str + """ + + self._usi = usi + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this SuperFund. # noqa: E501 + + Last modified timestamp # noqa: E501 + + :return: The updated_date_utc of this SuperFund. # 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 SuperFund. + + Last modified timestamp # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this SuperFund. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc + + @property + def validation_errors(self): + """Gets the validation_errors of this SuperFund. # noqa: E501 + + Displays array of validation error messages from the API # noqa: E501 + + :return: The validation_errors of this SuperFund. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._validation_errors + + @validation_errors.setter + def validation_errors(self, validation_errors): + """Sets the validation_errors of this SuperFund. + + Displays array of validation error messages from the API # noqa: E501 + + :param validation_errors: The validation_errors of this SuperFund. # noqa: E501 + :type: list[ValidationError] + """ + + self._validation_errors = validation_errors diff --git a/xero_python/payrollau/models/super_fund_product.py b/xero_python/payrollau/models/super_fund_product.py new file mode 100644 index 00000000..c295dbc3 --- /dev/null +++ b/xero_python/payrollau/models/super_fund_product.py @@ -0,0 +1,150 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SuperFundProduct(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 = {"abn": "str", "usi": "str", "spin": "str", "product_name": "str"} + + attribute_map = { + "abn": "ABN", + "usi": "USI", + "spin": "SPIN", + "product_name": "ProductName", + } + + def __init__(self, abn=None, usi=None, spin=None, product_name=None): # noqa: E501 + """SuperFundProduct - a model defined in OpenAPI""" # noqa: E501 + + self._abn = None + self._usi = None + self._spin = None + self._product_name = None + self.discriminator = None + + if abn is not None: + self.abn = abn + if usi is not None: + self.usi = usi + if spin is not None: + self.spin = spin + if product_name is not None: + self.product_name = product_name + + @property + def abn(self): + """Gets the abn of this SuperFundProduct. # noqa: E501 + + The ABN of the Regulated SuperFund # noqa: E501 + + :return: The abn of this SuperFundProduct. # noqa: E501 + :rtype: str + """ + return self._abn + + @abn.setter + def abn(self, abn): + """Sets the abn of this SuperFundProduct. + + The ABN of the Regulated SuperFund # noqa: E501 + + :param abn: The abn of this SuperFundProduct. # noqa: E501 + :type: str + """ + + self._abn = abn + + @property + def usi(self): + """Gets the usi of this SuperFundProduct. # noqa: E501 + + The USI of the Regulated SuperFund # noqa: E501 + + :return: The usi of this SuperFundProduct. # noqa: E501 + :rtype: str + """ + return self._usi + + @usi.setter + def usi(self, usi): + """Sets the usi of this SuperFundProduct. + + The USI of the Regulated SuperFund # noqa: E501 + + :param usi: The usi of this SuperFundProduct. # noqa: E501 + :type: str + """ + + self._usi = usi + + @property + def spin(self): + """Gets the spin of this SuperFundProduct. # noqa: E501 + + The SPIN of the Regulated SuperFund. This field has been deprecated. New superfunds will not have a SPIN value. The USI field should be used instead of SPIN # noqa: E501 + + :return: The spin of this SuperFundProduct. # noqa: E501 + :rtype: str + """ + return self._spin + + @spin.setter + def spin(self, spin): + """Sets the spin of this SuperFundProduct. + + The SPIN of the Regulated SuperFund. This field has been deprecated. New superfunds will not have a SPIN value. The USI field should be used instead of SPIN # noqa: E501 + + :param spin: The spin of this SuperFundProduct. # noqa: E501 + :type: str + """ + + self._spin = spin + + @property + def product_name(self): + """Gets the product_name of this SuperFundProduct. # noqa: E501 + + The name of the Regulated SuperFund # noqa: E501 + + :return: The product_name of this SuperFundProduct. # noqa: E501 + :rtype: str + """ + return self._product_name + + @product_name.setter + def product_name(self, product_name): + """Sets the product_name of this SuperFundProduct. + + The name of the Regulated SuperFund # noqa: E501 + + :param product_name: The product_name of this SuperFundProduct. # noqa: E501 + :type: str + """ + + self._product_name = product_name diff --git a/xero_python/payrollau/models/super_fund_products.py b/xero_python/payrollau/models/super_fund_products.py new file mode 100644 index 00000000..ecd28862 --- /dev/null +++ b/xero_python/payrollau/models/super_fund_products.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SuperFundProducts(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 = {"super_fund_products": "list[SuperFundProduct]"} + + attribute_map = {"super_fund_products": "SuperFundProducts"} + + def __init__(self, super_fund_products=None): # noqa: E501 + """SuperFundProducts - a model defined in OpenAPI""" # noqa: E501 + + self._super_fund_products = None + self.discriminator = None + + if super_fund_products is not None: + self.super_fund_products = super_fund_products + + @property + def super_fund_products(self): + """Gets the super_fund_products of this SuperFundProducts. # noqa: E501 + + + :return: The super_fund_products of this SuperFundProducts. # noqa: E501 + :rtype: list[SuperFundProduct] + """ + return self._super_fund_products + + @super_fund_products.setter + def super_fund_products(self, super_fund_products): + """Sets the super_fund_products of this SuperFundProducts. + + + :param super_fund_products: The super_fund_products of this SuperFundProducts. # noqa: E501 + :type: list[SuperFundProduct] + """ + + self._super_fund_products = super_fund_products diff --git a/xero_python/payrollau/models/super_fund_type.py b/xero_python/payrollau/models/super_fund_type.py new file mode 100644 index 00000000..ecf61488 --- /dev/null +++ b/xero_python/payrollau/models/super_fund_type.py @@ -0,0 +1,29 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class SuperFundType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + REGULATED = "REGULATED" + SMSF = "SMSF" diff --git a/xero_python/payrollau/models/super_funds.py b/xero_python/payrollau/models/super_funds.py new file mode 100644 index 00000000..0f7d6a38 --- /dev/null +++ b/xero_python/payrollau/models/super_funds.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SuperFunds(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 = {"super_funds": "list[SuperFund]"} + + attribute_map = {"super_funds": "SuperFunds"} + + def __init__(self, super_funds=None): # noqa: E501 + """SuperFunds - a model defined in OpenAPI""" # noqa: E501 + + self._super_funds = None + self.discriminator = None + + if super_funds is not None: + self.super_funds = super_funds + + @property + def super_funds(self): + """Gets the super_funds of this SuperFunds. # noqa: E501 + + + :return: The super_funds of this SuperFunds. # noqa: E501 + :rtype: list[SuperFund] + """ + return self._super_funds + + @super_funds.setter + def super_funds(self, super_funds): + """Sets the super_funds of this SuperFunds. + + + :param super_funds: The super_funds of this SuperFunds. # noqa: E501 + :type: list[SuperFund] + """ + + self._super_funds = super_funds diff --git a/xero_python/payrollau/models/super_line.py b/xero_python/payrollau/models/super_line.py new file mode 100644 index 00000000..a8a002ef --- /dev/null +++ b/xero_python/payrollau/models/super_line.py @@ -0,0 +1,273 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SuperLine(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 = { + "super_membership_id": "str", + "contribution_type": "SuperannuationContributionType", + "calculation_type": "SuperannuationCalculationType", + "minimum_monthly_earnings": "float", + "expense_account_code": "str", + "liability_account_code": "str", + "percentage": "float", + "amount": "float", + } + + attribute_map = { + "super_membership_id": "SuperMembershipID", + "contribution_type": "ContributionType", + "calculation_type": "CalculationType", + "minimum_monthly_earnings": "MinimumMonthlyEarnings", + "expense_account_code": "ExpenseAccountCode", + "liability_account_code": "LiabilityAccountCode", + "percentage": "Percentage", + "amount": "Amount", + } + + def __init__( + self, + super_membership_id=None, + contribution_type=None, + calculation_type=None, + minimum_monthly_earnings=None, + expense_account_code=None, + liability_account_code=None, + percentage=None, + amount=None, + ): # noqa: E501 + """SuperLine - a model defined in OpenAPI""" # noqa: E501 + + self._super_membership_id = None + self._contribution_type = None + self._calculation_type = None + self._minimum_monthly_earnings = None + self._expense_account_code = None + self._liability_account_code = None + self._percentage = None + self._amount = None + self.discriminator = None + + if super_membership_id is not None: + self.super_membership_id = super_membership_id + if contribution_type is not None: + self.contribution_type = contribution_type + if calculation_type is not None: + self.calculation_type = calculation_type + if minimum_monthly_earnings is not None: + self.minimum_monthly_earnings = minimum_monthly_earnings + if expense_account_code is not None: + self.expense_account_code = expense_account_code + if liability_account_code is not None: + self.liability_account_code = liability_account_code + if percentage is not None: + self.percentage = percentage + if amount is not None: + self.amount = amount + + @property + def super_membership_id(self): + """Gets the super_membership_id of this SuperLine. # noqa: E501 + + Xero super membership ID # noqa: E501 + + :return: The super_membership_id of this SuperLine. # noqa: E501 + :rtype: str + """ + return self._super_membership_id + + @super_membership_id.setter + def super_membership_id(self, super_membership_id): + """Sets the super_membership_id of this SuperLine. + + Xero super membership ID # noqa: E501 + + :param super_membership_id: The super_membership_id of this SuperLine. # noqa: E501 + :type: str + """ + + self._super_membership_id = super_membership_id + + @property + def contribution_type(self): + """Gets the contribution_type of this SuperLine. # noqa: E501 + + + :return: The contribution_type of this SuperLine. # noqa: E501 + :rtype: SuperannuationContributionType + """ + return self._contribution_type + + @contribution_type.setter + def contribution_type(self, contribution_type): + """Sets the contribution_type of this SuperLine. + + + :param contribution_type: The contribution_type of this SuperLine. # noqa: E501 + :type: SuperannuationContributionType + """ + + self._contribution_type = contribution_type + + @property + def calculation_type(self): + """Gets the calculation_type of this SuperLine. # noqa: E501 + + + :return: The calculation_type of this SuperLine. # noqa: E501 + :rtype: SuperannuationCalculationType + """ + return self._calculation_type + + @calculation_type.setter + def calculation_type(self, calculation_type): + """Sets the calculation_type of this SuperLine. + + + :param calculation_type: The calculation_type of this SuperLine. # noqa: E501 + :type: SuperannuationCalculationType + """ + + self._calculation_type = calculation_type + + @property + def minimum_monthly_earnings(self): + """Gets the minimum_monthly_earnings of this SuperLine. # noqa: E501 + + amount of mimimum earnings # noqa: E501 + + :return: The minimum_monthly_earnings of this SuperLine. # noqa: E501 + :rtype: float + """ + return self._minimum_monthly_earnings + + @minimum_monthly_earnings.setter + def minimum_monthly_earnings(self, minimum_monthly_earnings): + """Sets the minimum_monthly_earnings of this SuperLine. + + amount of mimimum earnings # noqa: E501 + + :param minimum_monthly_earnings: The minimum_monthly_earnings of this SuperLine. # noqa: E501 + :type: float + """ + + self._minimum_monthly_earnings = minimum_monthly_earnings + + @property + def expense_account_code(self): + """Gets the expense_account_code of this SuperLine. # noqa: E501 + + expense account code # noqa: E501 + + :return: The expense_account_code of this SuperLine. # noqa: E501 + :rtype: str + """ + return self._expense_account_code + + @expense_account_code.setter + def expense_account_code(self, expense_account_code): + """Sets the expense_account_code of this SuperLine. + + expense account code # noqa: E501 + + :param expense_account_code: The expense_account_code of this SuperLine. # noqa: E501 + :type: str + """ + + self._expense_account_code = expense_account_code + + @property + def liability_account_code(self): + """Gets the liability_account_code of this SuperLine. # noqa: E501 + + liabilty account code # noqa: E501 + + :return: The liability_account_code of this SuperLine. # noqa: E501 + :rtype: str + """ + return self._liability_account_code + + @liability_account_code.setter + def liability_account_code(self, liability_account_code): + """Sets the liability_account_code of this SuperLine. + + liabilty account code # noqa: E501 + + :param liability_account_code: The liability_account_code of this SuperLine. # noqa: E501 + :type: str + """ + + self._liability_account_code = liability_account_code + + @property + def percentage(self): + """Gets the percentage of this SuperLine. # noqa: E501 + + percentage for super line # noqa: E501 + + :return: The percentage of this SuperLine. # noqa: E501 + :rtype: float + """ + return self._percentage + + @percentage.setter + def percentage(self, percentage): + """Sets the percentage of this SuperLine. + + percentage for super line # noqa: E501 + + :param percentage: The percentage of this SuperLine. # noqa: E501 + :type: float + """ + + self._percentage = percentage + + @property + def amount(self): + """Gets the amount of this SuperLine. # noqa: E501 + + Super membership amount # noqa: E501 + + :return: The amount of this SuperLine. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this SuperLine. + + Super membership amount # noqa: E501 + + :param amount: The amount of this SuperLine. # noqa: E501 + :type: float + """ + + self._amount = amount diff --git a/xero_python/payrollau/models/super_membership.py b/xero_python/payrollau/models/super_membership.py new file mode 100644 index 00000000..2450dd89 --- /dev/null +++ b/xero_python/payrollau/models/super_membership.py @@ -0,0 +1,135 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class SuperMembership(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 = { + "super_membership_id": "str", + "super_fund_id": "str", + "employee_number": "float", + } + + attribute_map = { + "super_membership_id": "SuperMembershipID", + "super_fund_id": "SuperFundID", + "employee_number": "EmployeeNumber", + } + + def __init__( + self, super_membership_id=None, super_fund_id=None, employee_number=None + ): # noqa: E501 + """SuperMembership - a model defined in OpenAPI""" # noqa: E501 + + self._super_membership_id = None + self._super_fund_id = None + self._employee_number = None + self.discriminator = None + + if super_membership_id is not None: + self.super_membership_id = super_membership_id + self.super_fund_id = super_fund_id + self.employee_number = employee_number + + @property + def super_membership_id(self): + """Gets the super_membership_id of this SuperMembership. # noqa: E501 + + Xero unique identifier for Super membership # noqa: E501 + + :return: The super_membership_id of this SuperMembership. # noqa: E501 + :rtype: str + """ + return self._super_membership_id + + @super_membership_id.setter + def super_membership_id(self, super_membership_id): + """Sets the super_membership_id of this SuperMembership. + + Xero unique identifier for Super membership # noqa: E501 + + :param super_membership_id: The super_membership_id of this SuperMembership. # noqa: E501 + :type: str + """ + + self._super_membership_id = super_membership_id + + @property + def super_fund_id(self): + """Gets the super_fund_id of this SuperMembership. # noqa: E501 + + Xero identifier for super fund # noqa: E501 + + :return: The super_fund_id of this SuperMembership. # noqa: E501 + :rtype: str + """ + return self._super_fund_id + + @super_fund_id.setter + def super_fund_id(self, super_fund_id): + """Sets the super_fund_id of this SuperMembership. + + Xero identifier for super fund # noqa: E501 + + :param super_fund_id: The super_fund_id of this SuperMembership. # noqa: E501 + :type: str + """ + if super_fund_id is None: + raise ValueError( + "Invalid value for `super_fund_id`, must not be `None`" + ) # noqa: E501 + + self._super_fund_id = super_fund_id + + @property + def employee_number(self): + """Gets the employee_number of this SuperMembership. # noqa: E501 + + The memberhsip number assigned to the employee by the super fund. # noqa: E501 + + :return: The employee_number of this SuperMembership. # noqa: E501 + :rtype: float + """ + return self._employee_number + + @employee_number.setter + def employee_number(self, employee_number): + """Sets the employee_number of this SuperMembership. + + The memberhsip number assigned to the employee by the super fund. # noqa: E501 + + :param employee_number: The employee_number of this SuperMembership. # noqa: E501 + :type: float + """ + if employee_number is None: + raise ValueError( + "Invalid value for `employee_number`, must not be `None`" + ) # noqa: E501 + + self._employee_number = employee_number diff --git a/xero_python/payrollau/models/superannuation_calculation_type.py b/xero_python/payrollau/models/superannuation_calculation_type.py new file mode 100644 index 00000000..30ed99c2 --- /dev/null +++ b/xero_python/payrollau/models/superannuation_calculation_type.py @@ -0,0 +1,30 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class SuperannuationCalculationType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + FIXEDAMOUNT = "FIXEDAMOUNT" + PERCENTAGEOFEARNINGS = "PERCENTAGEOFEARNINGS" + STATUTORY = "STATUTORY" diff --git a/xero_python/payrollau/models/superannuation_contribution_type.py b/xero_python/payrollau/models/superannuation_contribution_type.py new file mode 100644 index 00000000..8722c0f2 --- /dev/null +++ b/xero_python/payrollau/models/superannuation_contribution_type.py @@ -0,0 +1,31 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class SuperannuationContributionType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + SGC = "SGC" + SALARYSACRIFICE = "SALARYSACRIFICE" + EMPLOYERADDITIONAL = "EMPLOYERADDITIONAL" + EMPLOYEE = "EMPLOYEE" diff --git a/xero_python/payrollau/models/superannuation_line.py b/xero_python/payrollau/models/superannuation_line.py new file mode 100644 index 00000000..a6dd4448 --- /dev/null +++ b/xero_python/payrollau/models/superannuation_line.py @@ -0,0 +1,302 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = { + "super_membership_id": "str", + "contribution_type": "SuperannuationContributionType", + "calculation_type": "SuperannuationCalculationType", + "minimum_monthly_earnings": "float", + "expense_account_code": "str", + "liability_account_code": "str", + "payment_date_for_this_period": "date[ms-format]", + "percentage": "float", + "amount": "float", + } + + attribute_map = { + "super_membership_id": "SuperMembershipID", + "contribution_type": "ContributionType", + "calculation_type": "CalculationType", + "minimum_monthly_earnings": "MinimumMonthlyEarnings", + "expense_account_code": "ExpenseAccountCode", + "liability_account_code": "LiabilityAccountCode", + "payment_date_for_this_period": "PaymentDateForThisPeriod", + "percentage": "Percentage", + "amount": "Amount", + } + + def __init__( + self, + super_membership_id=None, + contribution_type=None, + calculation_type=None, + minimum_monthly_earnings=None, + expense_account_code=None, + liability_account_code=None, + payment_date_for_this_period=None, + percentage=None, + amount=None, + ): # noqa: E501 + """SuperannuationLine - a model defined in OpenAPI""" # noqa: E501 + + self._super_membership_id = None + self._contribution_type = None + self._calculation_type = None + self._minimum_monthly_earnings = None + self._expense_account_code = None + self._liability_account_code = None + self._payment_date_for_this_period = None + self._percentage = None + self._amount = None + self.discriminator = None + + if super_membership_id is not None: + self.super_membership_id = super_membership_id + if contribution_type is not None: + self.contribution_type = contribution_type + if calculation_type is not None: + self.calculation_type = calculation_type + if minimum_monthly_earnings is not None: + self.minimum_monthly_earnings = minimum_monthly_earnings + if expense_account_code is not None: + self.expense_account_code = expense_account_code + if liability_account_code is not None: + self.liability_account_code = liability_account_code + if payment_date_for_this_period is not None: + self.payment_date_for_this_period = payment_date_for_this_period + if percentage is not None: + self.percentage = percentage + if amount is not None: + self.amount = amount + + @property + def super_membership_id(self): + """Gets the super_membership_id of this SuperannuationLine. # noqa: E501 + + Xero identifier for payroll super fund membership ID. # noqa: E501 + + :return: The super_membership_id of this SuperannuationLine. # noqa: E501 + :rtype: str + """ + return self._super_membership_id + + @super_membership_id.setter + def super_membership_id(self, super_membership_id): + """Sets the super_membership_id of this SuperannuationLine. + + Xero identifier for payroll super fund membership ID. # noqa: E501 + + :param super_membership_id: The super_membership_id of this SuperannuationLine. # noqa: E501 + :type: str + """ + + self._super_membership_id = super_membership_id + + @property + def contribution_type(self): + """Gets the contribution_type of this SuperannuationLine. # noqa: E501 + + + :return: The contribution_type of this SuperannuationLine. # noqa: E501 + :rtype: SuperannuationContributionType + """ + return self._contribution_type + + @contribution_type.setter + def contribution_type(self, contribution_type): + """Sets the contribution_type of this SuperannuationLine. + + + :param contribution_type: The contribution_type of this SuperannuationLine. # noqa: E501 + :type: SuperannuationContributionType + """ + + self._contribution_type = contribution_type + + @property + def calculation_type(self): + """Gets the calculation_type of this SuperannuationLine. # noqa: E501 + + + :return: The calculation_type of this SuperannuationLine. # noqa: E501 + :rtype: SuperannuationCalculationType + """ + return self._calculation_type + + @calculation_type.setter + def calculation_type(self, calculation_type): + """Sets the calculation_type of this SuperannuationLine. + + + :param calculation_type: The calculation_type of this SuperannuationLine. # noqa: E501 + :type: SuperannuationCalculationType + """ + + self._calculation_type = calculation_type + + @property + def minimum_monthly_earnings(self): + """Gets the minimum_monthly_earnings of this SuperannuationLine. # noqa: E501 + + Superannuation minimum monthly earnings. # noqa: E501 + + :return: The minimum_monthly_earnings of this SuperannuationLine. # noqa: E501 + :rtype: float + """ + return self._minimum_monthly_earnings + + @minimum_monthly_earnings.setter + def minimum_monthly_earnings(self, minimum_monthly_earnings): + """Sets the minimum_monthly_earnings of this SuperannuationLine. + + Superannuation minimum monthly earnings. # noqa: E501 + + :param minimum_monthly_earnings: The minimum_monthly_earnings of this SuperannuationLine. # noqa: E501 + :type: float + """ + + self._minimum_monthly_earnings = minimum_monthly_earnings + + @property + def expense_account_code(self): + """Gets the expense_account_code of this SuperannuationLine. # noqa: E501 + + Superannuation expense account code. # noqa: E501 + + :return: The expense_account_code of this SuperannuationLine. # noqa: E501 + :rtype: str + """ + return self._expense_account_code + + @expense_account_code.setter + def expense_account_code(self, expense_account_code): + """Sets the expense_account_code of this SuperannuationLine. + + Superannuation expense account code. # noqa: E501 + + :param expense_account_code: The expense_account_code of this SuperannuationLine. # noqa: E501 + :type: str + """ + + self._expense_account_code = expense_account_code + + @property + def liability_account_code(self): + """Gets the liability_account_code of this SuperannuationLine. # noqa: E501 + + Superannuation liability account code # noqa: E501 + + :return: The liability_account_code of this SuperannuationLine. # noqa: E501 + :rtype: str + """ + return self._liability_account_code + + @liability_account_code.setter + def liability_account_code(self, liability_account_code): + """Sets the liability_account_code of this SuperannuationLine. + + Superannuation liability account code # noqa: E501 + + :param liability_account_code: The liability_account_code of this SuperannuationLine. # noqa: E501 + :type: str + """ + + self._liability_account_code = liability_account_code + + @property + def payment_date_for_this_period(self): + """Gets the payment_date_for_this_period of this SuperannuationLine. # noqa: E501 + + Superannuation payment date for the current period (YYYY-MM-DD) # noqa: E501 + + :return: The payment_date_for_this_period of this SuperannuationLine. # noqa: E501 + :rtype: date + """ + return self._payment_date_for_this_period + + @payment_date_for_this_period.setter + def payment_date_for_this_period(self, payment_date_for_this_period): + """Sets the payment_date_for_this_period of this SuperannuationLine. + + Superannuation payment date for the current period (YYYY-MM-DD) # noqa: E501 + + :param payment_date_for_this_period: The payment_date_for_this_period of this SuperannuationLine. # noqa: E501 + :type: date + """ + + self._payment_date_for_this_period = payment_date_for_this_period + + @property + def percentage(self): + """Gets the percentage of this SuperannuationLine. # noqa: E501 + + Superannuation 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 percentage # noqa: E501 + + :param percentage: The percentage of this SuperannuationLine. # noqa: E501 + :type: float + """ + + self._percentage = percentage + + @property + def amount(self): + """Gets the amount of this SuperannuationLine. # noqa: E501 + + Superannuation amount # 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. + + Superannuation amount # noqa: E501 + + :param amount: The amount of this SuperannuationLine. # noqa: E501 + :type: float + """ + + self._amount = amount diff --git a/xero_python/payrollau/models/tax_declaration.py b/xero_python/payrollau/models/tax_declaration.py new file mode 100644 index 00000000..2ecb9918 --- /dev/null +++ b/xero_python/payrollau/models/tax_declaration.py @@ -0,0 +1,527 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TaxDeclaration(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", + "employment_basis": "EmploymentBasis", + "tfn_exemption_type": "TFNExemptionType", + "tax_file_number": "str", + "australian_resident_for_tax_purposes": "bool", + "residency_status": "ResidencyStatus", + "tax_free_threshold_claimed": "bool", + "tax_offset_estimated_amount": "float", + "has_help_debt": "bool", + "has_sfss_debt": "bool", + "has_trade_support_loan_debt": "bool", + "upward_variation_tax_withholding_amount": "float", + "eligible_to_receive_leave_loading": "bool", + "approved_withholding_variation_percentage": "float", + "has_student_startup_loan": "bool", + "updated_date_utc": "datetime[ms-format]", + } + + attribute_map = { + "employee_id": "EmployeeID", + "employment_basis": "EmploymentBasis", + "tfn_exemption_type": "TFNExemptionType", + "tax_file_number": "TaxFileNumber", + "australian_resident_for_tax_purposes": "AustralianResidentForTaxPurposes", + "residency_status": "ResidencyStatus", + "tax_free_threshold_claimed": "TaxFreeThresholdClaimed", + "tax_offset_estimated_amount": "TaxOffsetEstimatedAmount", + "has_help_debt": "HasHELPDebt", + "has_sfss_debt": "HasSFSSDebt", + "has_trade_support_loan_debt": "HasTradeSupportLoanDebt", + "upward_variation_tax_withholding_amount": "UpwardVariationTaxWithholdingAmount", + "eligible_to_receive_leave_loading": "EligibleToReceiveLeaveLoading", + "approved_withholding_variation_percentage": "ApprovedWithholdingVariationPercentage", + "has_student_startup_loan": "HasStudentStartupLoan", + "updated_date_utc": "UpdatedDateUTC", + } + + def __init__( + self, + employee_id=None, + employment_basis=None, + tfn_exemption_type=None, + tax_file_number=None, + australian_resident_for_tax_purposes=None, + residency_status=None, + tax_free_threshold_claimed=None, + tax_offset_estimated_amount=None, + has_help_debt=None, + has_sfss_debt=None, + has_trade_support_loan_debt=None, + upward_variation_tax_withholding_amount=None, + eligible_to_receive_leave_loading=None, + approved_withholding_variation_percentage=None, + has_student_startup_loan=None, + updated_date_utc=None, + ): # noqa: E501 + """TaxDeclaration - a model defined in OpenAPI""" # noqa: E501 + + self._employee_id = None + self._employment_basis = None + self._tfn_exemption_type = None + self._tax_file_number = None + self._australian_resident_for_tax_purposes = None + self._residency_status = None + self._tax_free_threshold_claimed = None + self._tax_offset_estimated_amount = None + self._has_help_debt = None + self._has_sfss_debt = None + self._has_trade_support_loan_debt = None + self._upward_variation_tax_withholding_amount = None + self._eligible_to_receive_leave_loading = None + self._approved_withholding_variation_percentage = None + self._has_student_startup_loan = None + self._updated_date_utc = None + self.discriminator = None + + self.employee_id = employee_id + self.employment_basis = employment_basis + if tfn_exemption_type is not None: + self.tfn_exemption_type = tfn_exemption_type + if tax_file_number is not None: + self.tax_file_number = tax_file_number + if australian_resident_for_tax_purposes is not None: + self.australian_resident_for_tax_purposes = ( + australian_resident_for_tax_purposes + ) + if residency_status is not None: + self.residency_status = residency_status + if tax_free_threshold_claimed is not None: + self.tax_free_threshold_claimed = tax_free_threshold_claimed + if tax_offset_estimated_amount is not None: + self.tax_offset_estimated_amount = tax_offset_estimated_amount + if has_help_debt is not None: + self.has_help_debt = has_help_debt + if has_sfss_debt is not None: + self.has_sfss_debt = has_sfss_debt + if has_trade_support_loan_debt is not None: + self.has_trade_support_loan_debt = has_trade_support_loan_debt + if upward_variation_tax_withholding_amount is not None: + self.upward_variation_tax_withholding_amount = ( + upward_variation_tax_withholding_amount + ) + if eligible_to_receive_leave_loading is not None: + self.eligible_to_receive_leave_loading = eligible_to_receive_leave_loading + if approved_withholding_variation_percentage is not None: + self.approved_withholding_variation_percentage = ( + approved_withholding_variation_percentage + ) + if has_student_startup_loan is not None: + self.has_student_startup_loan = has_student_startup_loan + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + + @property + def employee_id(self): + """Gets the employee_id of this TaxDeclaration. # noqa: E501 + + Address line 1 for employee home address # noqa: E501 + + :return: The employee_id of this TaxDeclaration. # noqa: E501 + :rtype: str + """ + return self._employee_id + + @employee_id.setter + def employee_id(self, employee_id): + """Sets the employee_id of this TaxDeclaration. + + Address line 1 for employee home address # noqa: E501 + + :param employee_id: The employee_id of this TaxDeclaration. # 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 employment_basis(self): + """Gets the employment_basis of this TaxDeclaration. # noqa: E501 + + + :return: The employment_basis of this TaxDeclaration. # noqa: E501 + :rtype: EmploymentBasis + """ + return self._employment_basis + + @employment_basis.setter + def employment_basis(self, employment_basis): + """Sets the employment_basis of this TaxDeclaration. + + + :param employment_basis: The employment_basis of this TaxDeclaration. # noqa: E501 + :type: EmploymentBasis + """ + if employment_basis is None: + raise ValueError( + "Invalid value for `employment_basis`, must not be `None`" + ) # noqa: E501 + + self._employment_basis = employment_basis + + @property + def tfn_exemption_type(self): + """Gets the tfn_exemption_type of this TaxDeclaration. # noqa: E501 + + + :return: The tfn_exemption_type of this TaxDeclaration. # noqa: E501 + :rtype: TFNExemptionType + """ + return self._tfn_exemption_type + + @tfn_exemption_type.setter + def tfn_exemption_type(self, tfn_exemption_type): + """Sets the tfn_exemption_type of this TaxDeclaration. + + + :param tfn_exemption_type: The tfn_exemption_type of this TaxDeclaration. # noqa: E501 + :type: TFNExemptionType + """ + + self._tfn_exemption_type = tfn_exemption_type + + @property + def tax_file_number(self): + """Gets the tax_file_number of this TaxDeclaration. # noqa: E501 + + The tax file number e.g 123123123. # noqa: E501 + + :return: The tax_file_number of this TaxDeclaration. # noqa: E501 + :rtype: str + """ + return self._tax_file_number + + @tax_file_number.setter + def tax_file_number(self, tax_file_number): + """Sets the tax_file_number of this TaxDeclaration. + + The tax file number e.g 123123123. # noqa: E501 + + :param tax_file_number: The tax_file_number of this TaxDeclaration. # noqa: E501 + :type: str + """ + + self._tax_file_number = tax_file_number + + @property + def australian_resident_for_tax_purposes(self): + """Gets the australian_resident_for_tax_purposes of this TaxDeclaration. # noqa: E501 + + If the employee is Australian resident for tax purposes. e.g true or false # noqa: E501 + + :return: The australian_resident_for_tax_purposes of this TaxDeclaration. # noqa: E501 + :rtype: bool + """ + return self._australian_resident_for_tax_purposes + + @australian_resident_for_tax_purposes.setter + def australian_resident_for_tax_purposes( + self, australian_resident_for_tax_purposes + ): + """Sets the australian_resident_for_tax_purposes of this TaxDeclaration. + + If the employee is Australian resident for tax purposes. e.g true or false # noqa: E501 + + :param australian_resident_for_tax_purposes: The australian_resident_for_tax_purposes of this TaxDeclaration. # noqa: E501 + :type: bool + """ + + self._australian_resident_for_tax_purposes = ( + australian_resident_for_tax_purposes + ) + + @property + def residency_status(self): + """Gets the residency_status of this TaxDeclaration. # noqa: E501 + + + :return: The residency_status of this TaxDeclaration. # noqa: E501 + :rtype: ResidencyStatus + """ + return self._residency_status + + @residency_status.setter + def residency_status(self, residency_status): + """Sets the residency_status of this TaxDeclaration. + + + :param residency_status: The residency_status of this TaxDeclaration. # noqa: E501 + :type: ResidencyStatus + """ + + self._residency_status = residency_status + + @property + def tax_free_threshold_claimed(self): + """Gets the tax_free_threshold_claimed of this TaxDeclaration. # noqa: E501 + + If tax free threshold claimed. e.g true or false # noqa: E501 + + :return: The tax_free_threshold_claimed of this TaxDeclaration. # noqa: E501 + :rtype: bool + """ + return self._tax_free_threshold_claimed + + @tax_free_threshold_claimed.setter + def tax_free_threshold_claimed(self, tax_free_threshold_claimed): + """Sets the tax_free_threshold_claimed of this TaxDeclaration. + + If tax free threshold claimed. e.g true or false # noqa: E501 + + :param tax_free_threshold_claimed: The tax_free_threshold_claimed of this TaxDeclaration. # noqa: E501 + :type: bool + """ + + self._tax_free_threshold_claimed = tax_free_threshold_claimed + + @property + def tax_offset_estimated_amount(self): + """Gets the tax_offset_estimated_amount of this TaxDeclaration. # noqa: E501 + + If has tax offset estimated then the tax offset estimated amount. e.g 100 # noqa: E501 + + :return: The tax_offset_estimated_amount of this TaxDeclaration. # noqa: E501 + :rtype: float + """ + return self._tax_offset_estimated_amount + + @tax_offset_estimated_amount.setter + def tax_offset_estimated_amount(self, tax_offset_estimated_amount): + """Sets the tax_offset_estimated_amount of this TaxDeclaration. + + If has tax offset estimated then the tax offset estimated amount. e.g 100 # noqa: E501 + + :param tax_offset_estimated_amount: The tax_offset_estimated_amount of this TaxDeclaration. # noqa: E501 + :type: float + """ + + self._tax_offset_estimated_amount = tax_offset_estimated_amount + + @property + def has_help_debt(self): + """Gets the has_help_debt of this TaxDeclaration. # noqa: E501 + + If employee has HECS or HELP debt. e.g true or false # noqa: E501 + + :return: The has_help_debt of this TaxDeclaration. # noqa: E501 + :rtype: bool + """ + return self._has_help_debt + + @has_help_debt.setter + def has_help_debt(self, has_help_debt): + """Sets the has_help_debt of this TaxDeclaration. + + If employee has HECS or HELP debt. e.g true or false # noqa: E501 + + :param has_help_debt: The has_help_debt of this TaxDeclaration. # noqa: E501 + :type: bool + """ + + self._has_help_debt = has_help_debt + + @property + def has_sfss_debt(self): + """Gets the has_sfss_debt of this TaxDeclaration. # noqa: E501 + + If employee has financial supplement debt. e.g true or false # noqa: E501 + + :return: The has_sfss_debt of this TaxDeclaration. # noqa: E501 + :rtype: bool + """ + return self._has_sfss_debt + + @has_sfss_debt.setter + def has_sfss_debt(self, has_sfss_debt): + """Sets the has_sfss_debt of this TaxDeclaration. + + If employee has financial supplement debt. e.g true or false # noqa: E501 + + :param has_sfss_debt: The has_sfss_debt of this TaxDeclaration. # noqa: E501 + :type: bool + """ + + self._has_sfss_debt = has_sfss_debt + + @property + def has_trade_support_loan_debt(self): + """Gets the has_trade_support_loan_debt of this TaxDeclaration. # noqa: E501 + + If employee has trade support loan. e.g true or false # noqa: E501 + + :return: The has_trade_support_loan_debt of this TaxDeclaration. # noqa: E501 + :rtype: bool + """ + return self._has_trade_support_loan_debt + + @has_trade_support_loan_debt.setter + def has_trade_support_loan_debt(self, has_trade_support_loan_debt): + """Sets the has_trade_support_loan_debt of this TaxDeclaration. + + If employee has trade support loan. e.g true or false # noqa: E501 + + :param has_trade_support_loan_debt: The has_trade_support_loan_debt of this TaxDeclaration. # noqa: E501 + :type: bool + """ + + self._has_trade_support_loan_debt = has_trade_support_loan_debt + + @property + def upward_variation_tax_withholding_amount(self): + """Gets the upward_variation_tax_withholding_amount of this TaxDeclaration. # noqa: E501 + + If the employee has requested that additional tax be withheld each pay run. e.g 50 # noqa: E501 + + :return: The upward_variation_tax_withholding_amount of this TaxDeclaration. # noqa: E501 + :rtype: float + """ + return self._upward_variation_tax_withholding_amount + + @upward_variation_tax_withholding_amount.setter + def upward_variation_tax_withholding_amount( + self, upward_variation_tax_withholding_amount + ): + """Sets the upward_variation_tax_withholding_amount of this TaxDeclaration. + + If the employee has requested that additional tax be withheld each pay run. e.g 50 # noqa: E501 + + :param upward_variation_tax_withholding_amount: The upward_variation_tax_withholding_amount of this TaxDeclaration. # noqa: E501 + :type: float + """ + + self._upward_variation_tax_withholding_amount = ( + upward_variation_tax_withholding_amount + ) + + @property + def eligible_to_receive_leave_loading(self): + """Gets the eligible_to_receive_leave_loading of this TaxDeclaration. # noqa: E501 + + If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%). e.g true or false # noqa: E501 + + :return: The eligible_to_receive_leave_loading of this TaxDeclaration. # noqa: E501 + :rtype: bool + """ + return self._eligible_to_receive_leave_loading + + @eligible_to_receive_leave_loading.setter + def eligible_to_receive_leave_loading(self, eligible_to_receive_leave_loading): + """Sets the eligible_to_receive_leave_loading of this TaxDeclaration. + + If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%). e.g true or false # noqa: E501 + + :param eligible_to_receive_leave_loading: The eligible_to_receive_leave_loading of this TaxDeclaration. # noqa: E501 + :type: bool + """ + + self._eligible_to_receive_leave_loading = eligible_to_receive_leave_loading + + @property + def approved_withholding_variation_percentage(self): + """Gets the approved_withholding_variation_percentage of this TaxDeclaration. # noqa: E501 + + If the employee has approved withholding variation. e.g (0 - 100) # noqa: E501 + + :return: The approved_withholding_variation_percentage of this TaxDeclaration. # noqa: E501 + :rtype: float + """ + return self._approved_withholding_variation_percentage + + @approved_withholding_variation_percentage.setter + def approved_withholding_variation_percentage( + self, approved_withholding_variation_percentage + ): + """Sets the approved_withholding_variation_percentage of this TaxDeclaration. + + If the employee has approved withholding variation. e.g (0 - 100) # noqa: E501 + + :param approved_withholding_variation_percentage: The approved_withholding_variation_percentage of this TaxDeclaration. # noqa: E501 + :type: float + """ + + self._approved_withholding_variation_percentage = ( + approved_withholding_variation_percentage + ) + + @property + def has_student_startup_loan(self): + """Gets the has_student_startup_loan of this TaxDeclaration. # noqa: E501 + + If the employee is eligible for student startup loan rules # noqa: E501 + + :return: The has_student_startup_loan of this TaxDeclaration. # noqa: E501 + :rtype: bool + """ + return self._has_student_startup_loan + + @has_student_startup_loan.setter + def has_student_startup_loan(self, has_student_startup_loan): + """Sets the has_student_startup_loan of this TaxDeclaration. + + If the employee is eligible for student startup loan rules # noqa: E501 + + :param has_student_startup_loan: The has_student_startup_loan of this TaxDeclaration. # noqa: E501 + :type: bool + """ + + self._has_student_startup_loan = has_student_startup_loan + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this TaxDeclaration. # noqa: E501 + + Last modified timestamp # noqa: E501 + + :return: The updated_date_utc of this TaxDeclaration. # 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 TaxDeclaration. + + Last modified timestamp # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this TaxDeclaration. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc diff --git a/xero_python/payrollau/models/tax_line.py b/xero_python/payrollau/models/tax_line.py new file mode 100644 index 00000000..aac8697b --- /dev/null +++ b/xero_python/payrollau/models/tax_line.py @@ -0,0 +1,217 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = { + "payslip_tax_line_id": "str", + "amount": "float", + "tax_type_name": "str", + "description": "str", + "manual_tax_type": "ManualTaxType", + "liability_account": "str", + } + + attribute_map = { + "payslip_tax_line_id": "PayslipTaxLineID", + "amount": "Amount", + "tax_type_name": "TaxTypeName", + "description": "Description", + "manual_tax_type": "ManualTaxType", + "liability_account": "LiabilityAccount", + } + + def __init__( + self, + payslip_tax_line_id=None, + amount=None, + tax_type_name=None, + description=None, + manual_tax_type=None, + liability_account=None, + ): # noqa: E501 + """TaxLine - a model defined in OpenAPI""" # noqa: E501 + + self._payslip_tax_line_id = None + self._amount = None + self._tax_type_name = None + self._description = None + self._manual_tax_type = None + self._liability_account = None + self.discriminator = None + + if payslip_tax_line_id is not None: + self.payslip_tax_line_id = payslip_tax_line_id + if amount is not None: + self.amount = amount + if tax_type_name is not None: + self.tax_type_name = tax_type_name + if description is not None: + self.description = description + if manual_tax_type is not None: + self.manual_tax_type = manual_tax_type + if liability_account is not None: + self.liability_account = liability_account + + @property + def payslip_tax_line_id(self): + """Gets the payslip_tax_line_id of this TaxLine. # noqa: E501 + + Xero identifier for payslip tax line ID. # noqa: E501 + + :return: The payslip_tax_line_id of this TaxLine. # noqa: E501 + :rtype: str + """ + return self._payslip_tax_line_id + + @payslip_tax_line_id.setter + def payslip_tax_line_id(self, payslip_tax_line_id): + """Sets the payslip_tax_line_id of this TaxLine. + + Xero identifier for payslip tax line ID. # noqa: E501 + + :param payslip_tax_line_id: The payslip_tax_line_id of this TaxLine. # noqa: E501 + :type: str + """ + + self._payslip_tax_line_id = payslip_tax_line_id + + @property + def amount(self): + """Gets the amount of this TaxLine. # noqa: E501 + + The tax line amount # 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 tax line amount # noqa: E501 + + :param amount: The amount of this TaxLine. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def tax_type_name(self): + """Gets the tax_type_name of this TaxLine. # noqa: E501 + + Name of the tax type. # noqa: E501 + + :return: The tax_type_name of this TaxLine. # noqa: E501 + :rtype: str + """ + return self._tax_type_name + + @tax_type_name.setter + def tax_type_name(self, tax_type_name): + """Sets the tax_type_name of this TaxLine. + + Name of the tax type. # noqa: E501 + + :param tax_type_name: The tax_type_name of this TaxLine. # noqa: E501 + :type: str + """ + + self._tax_type_name = tax_type_name + + @property + def description(self): + """Gets the description of this TaxLine. # noqa: E501 + + Description of the tax line. # 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. + + Description of the tax line. # noqa: E501 + + :param description: The description of this TaxLine. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def manual_tax_type(self): + """Gets the manual_tax_type of this TaxLine. # noqa: E501 + + + :return: The manual_tax_type of this TaxLine. # noqa: E501 + :rtype: ManualTaxType + """ + return self._manual_tax_type + + @manual_tax_type.setter + def manual_tax_type(self, manual_tax_type): + """Sets the manual_tax_type of this TaxLine. + + + :param manual_tax_type: The manual_tax_type of this TaxLine. # noqa: E501 + :type: ManualTaxType + """ + + self._manual_tax_type = manual_tax_type + + @property + def liability_account(self): + """Gets the liability_account of this TaxLine. # noqa: E501 + + The tax line liability account code. For posted pay run you should be able to see liability account code # noqa: E501 + + :return: The liability_account of this TaxLine. # noqa: E501 + :rtype: str + """ + return self._liability_account + + @liability_account.setter + def liability_account(self, liability_account): + """Sets the liability_account of this TaxLine. + + The tax line liability account code. For posted pay run you should be able to see liability account code # noqa: E501 + + :param liability_account: The liability_account of this TaxLine. # noqa: E501 + :type: str + """ + + self._liability_account = liability_account diff --git a/xero_python/payrollau/models/tfn_exemption_type.py b/xero_python/payrollau/models/tfn_exemption_type.py new file mode 100644 index 00000000..72149117 --- /dev/null +++ b/xero_python/payrollau/models/tfn_exemption_type.py @@ -0,0 +1,31 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class TFNExemptionType(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + NOTQUOTED = "NOTQUOTED" + PENDING = "PENDING" + PENSIONER = "PENSIONER" + UNDER18 = "UNDER18" diff --git a/xero_python/payrollau/models/timesheet.py b/xero_python/payrollau/models/timesheet.py new file mode 100644 index 00000000..4ad5bc38 --- /dev/null +++ b/xero_python/payrollau/models/timesheet.py @@ -0,0 +1,311 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = { + "employee_id": "str", + "start_date": "date[ms-format]", + "end_date": "date[ms-format]", + "status": "TimesheetStatus", + "hours": "float", + "timesheet_id": "str", + "timesheet_lines": "list[TimesheetLine]", + "updated_date_utc": "datetime[ms-format]", + "validation_errors": "list[ValidationError]", + } + + attribute_map = { + "employee_id": "EmployeeID", + "start_date": "StartDate", + "end_date": "EndDate", + "status": "Status", + "hours": "Hours", + "timesheet_id": "TimesheetID", + "timesheet_lines": "TimesheetLines", + "updated_date_utc": "UpdatedDateUTC", + "validation_errors": "ValidationErrors", + } + + def __init__( + self, + employee_id=None, + start_date=None, + end_date=None, + status=None, + hours=None, + timesheet_id=None, + timesheet_lines=None, + updated_date_utc=None, + validation_errors=None, + ): # noqa: E501 + """Timesheet - a model defined in OpenAPI""" # noqa: E501 + + self._employee_id = None + self._start_date = None + self._end_date = None + self._status = None + self._hours = None + self._timesheet_id = None + self._timesheet_lines = None + self._updated_date_utc = None + self._validation_errors = None + self.discriminator = None + + self.employee_id = employee_id + self.start_date = start_date + self.end_date = end_date + if status is not None: + self.status = status + if hours is not None: + self.hours = hours + if timesheet_id is not None: + self.timesheet_id = timesheet_id + if timesheet_lines is not None: + self.timesheet_lines = timesheet_lines + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + if validation_errors is not None: + self.validation_errors = validation_errors + + @property + def employee_id(self): + """Gets the employee_id of this Timesheet. # noqa: E501 + + The Xero identifier for an employee # 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 an employee # 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 + + Period start date (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. + + Period start date (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 + + Period end date (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. + + Period end date (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 + + + :return: The status of this Timesheet. # noqa: E501 + :rtype: TimesheetStatus + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this Timesheet. + + + :param status: The status of this Timesheet. # noqa: E501 + :type: TimesheetStatus + """ + + self._status = status + + @property + def hours(self): + """Gets the hours of this Timesheet. # noqa: E501 + + Timesheet total hours # noqa: E501 + + :return: The hours of this Timesheet. # noqa: E501 + :rtype: float + """ + return self._hours + + @hours.setter + def hours(self, hours): + """Sets the hours of this Timesheet. + + Timesheet total hours # noqa: E501 + + :param hours: The hours of this Timesheet. # noqa: E501 + :type: float + """ + + self._hours = hours + + @property + def timesheet_id(self): + """Gets the timesheet_id of this Timesheet. # noqa: E501 + + The Xero identifier for a Payroll 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 Payroll Timesheet # noqa: E501 + + :param timesheet_id: The timesheet_id of this Timesheet. # noqa: E501 + :type: str + """ + + self._timesheet_id = timesheet_id + + @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 + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this Timesheet. # noqa: E501 + + Last modified timestamp # 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. + + Last modified timestamp # 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 validation_errors(self): + """Gets the validation_errors of this Timesheet. # noqa: E501 + + Displays array of validation error messages from the API # noqa: E501 + + :return: The validation_errors of this Timesheet. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._validation_errors + + @validation_errors.setter + def validation_errors(self, validation_errors): + """Sets the validation_errors of this Timesheet. + + Displays array of validation error messages from the API # noqa: E501 + + :param validation_errors: The validation_errors of this Timesheet. # noqa: E501 + :type: list[ValidationError] + """ + + self._validation_errors = validation_errors diff --git a/xero_python/payrollau/models/timesheet_line.py b/xero_python/payrollau/models/timesheet_line.py new file mode 100644 index 00000000..e0800de1 --- /dev/null +++ b/xero_python/payrollau/models/timesheet_line.py @@ -0,0 +1,161 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = { + "earnings_rate_id": "str", + "tracking_item_id": "str", + "number_of_units": "list[float]", + "updated_date_utc": "datetime[ms-format]", + } + + attribute_map = { + "earnings_rate_id": "EarningsRateID", + "tracking_item_id": "TrackingItemID", + "number_of_units": "NumberOfUnits", + "updated_date_utc": "UpdatedDateUTC", + } + + def __init__( + self, + earnings_rate_id=None, + tracking_item_id=None, + number_of_units=None, + updated_date_utc=None, + ): # noqa: E501 + """TimesheetLine - a model defined in OpenAPI""" # noqa: E501 + + self._earnings_rate_id = None + self._tracking_item_id = None + self._number_of_units = None + self._updated_date_utc = None + self.discriminator = None + + if earnings_rate_id is not None: + self.earnings_rate_id = earnings_rate_id + if tracking_item_id is not None: + self.tracking_item_id = tracking_item_id + if number_of_units is not None: + self.number_of_units = number_of_units + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + + @property + def earnings_rate_id(self): + """Gets the earnings_rate_id of this TimesheetLine. # noqa: E501 + + The Xero identifier for an Earnings Rate # 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 an Earnings Rate # noqa: E501 + + :param earnings_rate_id: The earnings_rate_id of this TimesheetLine. # noqa: E501 + :type: str + """ + + 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 a Tracking Category. The TrackingOptionID must belong to the TrackingCategory selected as TimesheetCategories under Payroll Settings. # 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 a Tracking Category. The TrackingOptionID must belong to the TrackingCategory selected as TimesheetCategories under Payroll Settings. # 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 on a timesheet line # noqa: E501 + + :return: The number_of_units of this TimesheetLine. # noqa: E501 + :rtype: list[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 on a timesheet line # noqa: E501 + + :param number_of_units: The number_of_units of this TimesheetLine. # noqa: E501 + :type: list[float] + """ + + self._number_of_units = number_of_units + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this TimesheetLine. # noqa: E501 + + Last modified timestamp # noqa: E501 + + :return: The updated_date_utc of this TimesheetLine. # 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 TimesheetLine. + + Last modified timestamp # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this TimesheetLine. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc diff --git a/xero_python/payrollau/models/timesheet_object.py b/xero_python/payrollau/models/timesheet_object.py new file mode 100644 index 00000000..5da83a0e --- /dev/null +++ b/xero_python/payrollau/models/timesheet_object.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = {"timesheet": "Timesheet"} + + attribute_map = {"timesheet": "Timesheet"} + + def __init__(self, timesheet=None): # noqa: E501 + """TimesheetObject - a model defined in OpenAPI""" # noqa: E501 + + self._timesheet = None + self.discriminator = None + + if timesheet is not None: + self.timesheet = timesheet + + @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/payrollau/models/timesheet_status.py b/xero_python/payrollau/models/timesheet_status.py new file mode 100644 index 00000000..d5f42b50 --- /dev/null +++ b/xero_python/payrollau/models/timesheet_status.py @@ -0,0 +1,30 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from enum import Enum + + +class TimesheetStatus(Enum): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + allowed enum values + """ + + DRAFT = "DRAFT" + PROCESSED = "PROCESSED" + APPROVED = "APPROVED" diff --git a/xero_python/payrollau/models/timesheets.py b/xero_python/payrollau/models/timesheets.py new file mode 100644 index 00000000..4154cab1 --- /dev/null +++ b/xero_python/payrollau/models/timesheets.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + 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 = {"timesheets": "list[Timesheet]"} + + attribute_map = {"timesheets": "Timesheets"} + + def __init__(self, timesheets=None): # noqa: E501 + """Timesheets - a model defined in OpenAPI""" # noqa: E501 + + self._timesheets = None + self.discriminator = None + + if timesheets is not None: + self.timesheets = timesheets + + @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/payrollau/models/validation_error.py b/xero_python/payrollau/models/validation_error.py new file mode 100644 index 00000000..28c57ee3 --- /dev/null +++ b/xero_python/payrollau/models/validation_error.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + Xero Payroll AU + + This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + + OpenAPI spec version: 2.2.7 + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class ValidationError(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 = {"message": "str"} + + attribute_map = {"message": "Message"} + + def __init__(self, message=None): # noqa: E501 + """ValidationError - a model defined in OpenAPI""" # noqa: E501 + + self._message = None + self.discriminator = None + + if message is not None: + self.message = message + + @property + def message(self): + """Gets the message of this ValidationError. # noqa: E501 + + Validation error message # noqa: E501 + + :return: The message of this ValidationError. # noqa: E501 + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """Sets the message of this ValidationError. + + Validation error message # noqa: E501 + + :param message: The message of this ValidationError. # noqa: E501 + :type: str + """ + + self._message = message diff --git a/xero_python/project/__init__.py b/xero_python/project/__init__.py index 8015b1b9..4ec7b746 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.2.6 + OpenAPI spec version: 2.2.7 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 c7b76b42..704a3b1e 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.2.6 + OpenAPI spec version: 2.2.7 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/project/models/__init__.py b/xero_python/project/models/__init__.py index 016fe787..72137110 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.2.6 + OpenAPI spec version: 2.2.7 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 43458988..cad1cf03 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.2.6 + OpenAPI spec version: 2.2.7 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 723767a8..59897a21 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.2.6 + OpenAPI spec version: 2.2.7 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 37359996..d6fef444 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.2.6 + OpenAPI spec version: 2.2.7 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 0d85a651..35a96bc4 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.2.6 + OpenAPI spec version: 2.2.7 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 3be890aa..343a0dfb 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.2.6 + OpenAPI spec version: 2.2.7 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 b485bbeb..84ba4b9c 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.2.6 + OpenAPI spec version: 2.2.7 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 070661e7..23bd23b7 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.2.6 + OpenAPI spec version: 2.2.7 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 0de36518..25155011 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.2.6 + OpenAPI spec version: 2.2.7 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 525653ca..e15b9267 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.2.6 + OpenAPI spec version: 2.2.7 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 867556fc..23e6b8c3 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.2.6 + OpenAPI spec version: 2.2.7 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 bc1297b1..676a51c7 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.2.6 + OpenAPI spec version: 2.2.7 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 659551d0..10a54503 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.2.6 + OpenAPI spec version: 2.2.7 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 35a255e6..18a860b1 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.2.6 + OpenAPI spec version: 2.2.7 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 4a7edac2..ba007ea0 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.2.6 + OpenAPI spec version: 2.2.7 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 2f49d677..b61f54d3 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.2.6 + OpenAPI spec version: 2.2.7 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 bcfc605c..900d276c 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.2.6 + OpenAPI spec version: 2.2.7 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 b642d124..a131f871 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.2.6 + OpenAPI spec version: 2.2.7 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 ae13c588..3dfb2904 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.2.6 + OpenAPI spec version: 2.2.7 Contact: api@xero.com Generated by: https://openapi-generator.tech """ diff --git a/xero_python/rest.py b/xero_python/rest.py index 5402cf98..cba10334 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.2.6 + OpenAPI spec version: 2.2.7 Contact: api@xero.com Generated by: https://openapi-generator.tech """