From 7ed345c0874c4429255d4f28a7e84a4272e56270 Mon Sep 17 00:00:00 2001 From: Sidney Maestre Date: Fri, 12 Feb 2021 13:59:05 -0800 Subject: [PATCH] Build from OAS 2.9.3 --- setup.py | 2 +- xero_python/__init__.py | 2 +- xero_python/accounting/__init__.py | 3 +- xero_python/accounting/api/accounting_api.py | 450 ++--- xero_python/accounting/docs/AccountingApi.md | 1722 ++++++++--------- xero_python/accounting/docs/CISOrgSettings.md | 10 + xero_python/accounting/docs/CreditNote.md | 1 + xero_python/accounting/docs/Payment.md | 1 + xero_python/accounting/models/__init__.py | 3 +- xero_python/accounting/models/account.py | 2 +- xero_python/accounting/models/account_type.py | 2 +- xero_python/accounting/models/accounts.py | 2 +- .../accounting/models/accounts_payable.py | 2 +- .../accounting/models/accounts_receivable.py | 2 +- xero_python/accounting/models/action.py | 2 +- xero_python/accounting/models/actions.py | 2 +- xero_python/accounting/models/address.py | 2 +- .../models/address_for_organisation.py | 2 +- xero_python/accounting/models/allocation.py | 2 +- xero_python/accounting/models/allocations.py | 2 +- xero_python/accounting/models/attachment.py | 2 +- xero_python/accounting/models/attachments.py | 2 +- .../accounting/models/balance_details.py | 2 +- xero_python/accounting/models/balances.py | 2 +- .../accounting/models/bank_transaction.py | 2 +- .../accounting/models/bank_transactions.py | 2 +- .../accounting/models/bank_transfer.py | 2 +- .../accounting/models/bank_transfers.py | 2 +- .../accounting/models/batch_payment.py | 2 +- .../models/batch_payment_details.py | 2 +- .../accounting/models/batch_payments.py | 2 +- xero_python/accounting/models/bill.py | 2 +- .../accounting/models/branding_theme.py | 2 +- .../accounting/models/branding_themes.py | 2 +- .../accounting/models/cis_org_setting.py | 2 +- .../accounting/models/cis_org_settings.py | 64 + xero_python/accounting/models/cis_setting.py | 2 +- xero_python/accounting/models/cis_settings.py | 2 +- xero_python/accounting/models/contact.py | 2 +- .../accounting/models/contact_group.py | 2 +- .../accounting/models/contact_groups.py | 2 +- .../accounting/models/contact_person.py | 2 +- xero_python/accounting/models/contacts.py | 2 +- .../accounting/models/conversion_balances.py | 2 +- .../accounting/models/conversion_date.py | 2 +- xero_python/accounting/models/country_code.py | 2 +- xero_python/accounting/models/credit_note.py | 31 +- xero_python/accounting/models/credit_notes.py | 2 +- xero_python/accounting/models/currencies.py | 2 +- xero_python/accounting/models/currency.py | 2 +- .../accounting/models/currency_code.py | 2 +- xero_python/accounting/models/element.py | 2 +- xero_python/accounting/models/employee.py | 2 +- xero_python/accounting/models/employees.py | 2 +- xero_python/accounting/models/error.py | 2 +- .../accounting/models/expense_claim.py | 2 +- .../accounting/models/expense_claims.py | 2 +- .../accounting/models/external_link.py | 2 +- .../accounting/models/history_record.py | 2 +- .../accounting/models/history_records.py | 2 +- .../accounting/models/import_summary.py | 2 +- .../models/import_summary_accounts.py | 2 +- .../models/import_summary_object.py | 2 +- .../models/import_summary_organisation.py | 2 +- xero_python/accounting/models/invoice.py | 2 +- .../accounting/models/invoice_reminder.py | 2 +- .../accounting/models/invoice_reminders.py | 2 +- xero_python/accounting/models/invoices.py | 2 +- xero_python/accounting/models/item.py | 2 +- xero_python/accounting/models/items.py | 2 +- xero_python/accounting/models/journal.py | 2 +- xero_python/accounting/models/journal_line.py | 2 +- xero_python/accounting/models/journals.py | 2 +- .../accounting/models/line_amount_types.py | 2 +- xero_python/accounting/models/line_item.py | 2 +- .../accounting/models/line_item_tracking.py | 2 +- .../accounting/models/linked_transaction.py | 2 +- .../accounting/models/linked_transactions.py | 2 +- .../accounting/models/manual_journal.py | 2 +- .../accounting/models/manual_journal_line.py | 2 +- .../accounting/models/manual_journals.py | 2 +- .../accounting/models/online_invoice.py | 2 +- .../accounting/models/online_invoices.py | 2 +- xero_python/accounting/models/organisation.py | 2 +- .../accounting/models/organisations.py | 2 +- xero_python/accounting/models/overpayment.py | 2 +- xero_python/accounting/models/overpayments.py | 2 +- xero_python/accounting/models/payment.py | 31 +- .../accounting/models/payment_delete.py | 2 +- .../accounting/models/payment_service.py | 2 +- .../accounting/models/payment_services.py | 2 +- xero_python/accounting/models/payment_term.py | 2 +- .../accounting/models/payment_term_type.py | 2 +- xero_python/accounting/models/payments.py | 2 +- xero_python/accounting/models/phone.py | 2 +- xero_python/accounting/models/prepayment.py | 2 +- xero_python/accounting/models/prepayments.py | 2 +- xero_python/accounting/models/purchase.py | 2 +- .../accounting/models/purchase_order.py | 2 +- .../accounting/models/purchase_orders.py | 2 +- xero_python/accounting/models/quote.py | 2 +- .../models/quote_line_amount_types.py | 2 +- .../accounting/models/quote_status_codes.py | 2 +- xero_python/accounting/models/quotes.py | 2 +- xero_python/accounting/models/receipt.py | 2 +- xero_python/accounting/models/receipts.py | 2 +- .../accounting/models/repeating_invoice.py | 2 +- .../accounting/models/repeating_invoices.py | 2 +- xero_python/accounting/models/report.py | 2 +- .../accounting/models/report_attribute.py | 2 +- xero_python/accounting/models/report_cell.py | 2 +- .../accounting/models/report_fields.py | 2 +- xero_python/accounting/models/report_row.py | 2 +- xero_python/accounting/models/report_rows.py | 2 +- .../accounting/models/report_with_row.py | 2 +- .../accounting/models/report_with_rows.py | 2 +- xero_python/accounting/models/reports.py | 2 +- .../accounting/models/request_empty.py | 2 +- xero_python/accounting/models/row_type.py | 2 +- .../models/sales_tracking_category.py | 2 +- xero_python/accounting/models/schedule.py | 2 +- xero_python/accounting/models/setup.py | 2 +- .../accounting/models/tax_component.py | 2 +- xero_python/accounting/models/tax_rate.py | 2 +- xero_python/accounting/models/tax_rates.py | 2 +- xero_python/accounting/models/tax_type.py | 2 +- .../models/ten_ninety_nine_contact.py | 2 +- xero_python/accounting/models/time_zone.py | 2 +- .../accounting/models/tracking_categories.py | 2 +- .../accounting/models/tracking_category.py | 2 +- .../accounting/models/tracking_option.py | 2 +- .../accounting/models/tracking_options.py | 2 +- xero_python/accounting/models/user.py | 2 +- xero_python/accounting/models/users.py | 2 +- .../accounting/models/validation_error.py | 2 +- xero_python/assets/__init__.py | 2 +- xero_python/assets/api/asset_api.py | 6 +- xero_python/assets/docs/AssetApi.md | 8 +- .../docs/FieldValidationErrorsElement.md | 2 +- .../docs/ResourceValidationErrorsElement.md | 2 +- xero_python/assets/models/__init__.py | 2 +- xero_python/assets/models/asset.py | 2 +- xero_python/assets/models/asset_status.py | 2 +- .../assets/models/asset_status_query_param.py | 2 +- xero_python/assets/models/asset_type.py | 2 +- xero_python/assets/models/assets.py | 2 +- .../assets/models/book_depreciation_detail.py | 2 +- .../models/book_depreciation_setting.py | 2 +- xero_python/assets/models/error.py | 2 +- .../models/field_validation_errors_element.py | 6 +- xero_python/assets/models/pagination.py | 2 +- .../resource_validation_errors_element.py | 6 +- xero_python/assets/models/setting.py | 2 +- xero_python/docs/README.md | 6 +- xero_python/identity/__init__.py | 4 +- xero_python/identity/api/identity_api.py | 14 +- xero_python/identity/docs/IdentityApi.md | 14 +- xero_python/identity/models/__init__.py | 4 +- xero_python/identity/models/access_token.py | 4 +- xero_python/identity/models/connection.py | 4 +- xero_python/identity/models/refresh_token.py | 4 +- xero_python/payrollau/__init__.py | 2 +- xero_python/payrollau/api/payroll_au_api.py | 78 +- xero_python/payrollau/docs/PayrollAuApi.md | 174 +- xero_python/payrollau/docs/SuperLine.md | 2 +- xero_python/payrollau/docs/SuperMembership.md | 2 +- xero_python/payrollau/models/__init__.py | 2 +- xero_python/payrollau/models/account.py | 2 +- xero_python/payrollau/models/account_type.py | 2 +- .../payrollau/models/allowance_type.py | 2 +- xero_python/payrollau/models/api_exception.py | 2 +- xero_python/payrollau/models/bank_account.py | 2 +- xero_python/payrollau/models/calendar_type.py | 2 +- .../payrollau/models/deduction_line.py | 2 +- .../payrollau/models/deduction_type.py | 2 +- .../models/deduction_type_calculation_type.py | 2 +- xero_python/payrollau/models/earnings_line.py | 2 +- xero_python/payrollau/models/earnings_rate.py | 2 +- .../models/earnings_rate_calculation_type.py | 2 +- xero_python/payrollau/models/earnings_type.py | 2 +- xero_python/payrollau/models/employee.py | 2 +- .../payrollau/models/employee_status.py | 2 +- xero_python/payrollau/models/employees.py | 2 +- .../payrollau/models/employment_basis.py | 2 +- .../employment_termination_payment_type.py | 2 +- .../entitlement_final_pay_payout_type.py | 2 +- xero_python/payrollau/models/home_address.py | 2 +- .../payrollau/models/leave_accrual_line.py | 2 +- .../payrollau/models/leave_application.py | 2 +- .../payrollau/models/leave_applications.py | 2 +- xero_python/payrollau/models/leave_balance.py | 2 +- .../payrollau/models/leave_earnings_line.py | 2 +- xero_python/payrollau/models/leave_line.py | 2 +- .../models/leave_line_calculation_type.py | 2 +- xero_python/payrollau/models/leave_lines.py | 2 +- xero_python/payrollau/models/leave_period.py | 2 +- .../payrollau/models/leave_period_status.py | 2 +- xero_python/payrollau/models/leave_type.py | 2 +- .../models/leave_type_contribution_type.py | 2 +- .../payrollau/models/manual_tax_type.py | 2 +- .../payrollau/models/opening_balances.py | 2 +- xero_python/payrollau/models/pay_item.py | 2 +- xero_python/payrollau/models/pay_items.py | 2 +- xero_python/payrollau/models/pay_run.py | 2 +- .../payrollau/models/pay_run_status.py | 2 +- xero_python/payrollau/models/pay_runs.py | 2 +- xero_python/payrollau/models/pay_template.py | 2 +- .../models/payment_frequency_type.py | 2 +- .../payrollau/models/payroll_calendar.py | 2 +- .../payrollau/models/payroll_calendars.py | 2 +- xero_python/payrollau/models/payslip.py | 2 +- xero_python/payrollau/models/payslip_lines.py | 2 +- .../payrollau/models/payslip_object.py | 2 +- .../payrollau/models/payslip_summary.py | 2 +- xero_python/payrollau/models/payslips.py | 2 +- xero_python/payrollau/models/rate_type.py | 2 +- .../payrollau/models/reimbursement_line.py | 2 +- .../payrollau/models/reimbursement_lines.py | 2 +- .../payrollau/models/reimbursement_type.py | 2 +- .../payrollau/models/residency_status.py | 2 +- xero_python/payrollau/models/settings.py | 2 +- .../payrollau/models/settings_object.py | 2 +- .../models/settings_tracking_categories.py | 2 +- ...ngs_tracking_categories_employee_groups.py | 2 +- ...racking_categories_timesheet_categories.py | 2 +- xero_python/payrollau/models/state.py | 2 +- xero_python/payrollau/models/super_fund.py | 2 +- .../payrollau/models/super_fund_product.py | 2 +- .../payrollau/models/super_fund_products.py | 2 +- .../payrollau/models/super_fund_type.py | 2 +- xero_python/payrollau/models/super_funds.py | 2 +- xero_python/payrollau/models/super_line.py | 6 +- .../payrollau/models/super_membership.py | 6 +- .../models/superannuation_calculation_type.py | 2 +- .../superannuation_contribution_type.py | 2 +- .../payrollau/models/superannuation_line.py | 2 +- .../payrollau/models/tax_declaration.py | 2 +- xero_python/payrollau/models/tax_line.py | 2 +- .../payrollau/models/tfn_exemption_type.py | 2 +- xero_python/payrollau/models/timesheet.py | 2 +- .../payrollau/models/timesheet_line.py | 2 +- .../payrollau/models/timesheet_object.py | 2 +- .../payrollau/models/timesheet_status.py | 2 +- xero_python/payrollau/models/timesheets.py | 2 +- .../payrollau/models/validation_error.py | 2 +- xero_python/payrollnz/api/payroll_nz_api.py | 264 +-- xero_python/payrollnz/docs/EarningsLine.md | 2 +- .../docs/EmployeeStatutorySickLeave.md | 2 +- .../payrollnz/docs/LeaveEarningsLine.md | 2 +- xero_python/payrollnz/docs/PayrollNZApi.md | 418 ++-- .../payrollnz/docs/SuperannuationLine.md | 2 +- xero_python/payrollnz/docs/Timesheet.md | 2 +- .../payrollnz/docs/TimesheetEarningsLine.md | 2 +- xero_python/payrollnz/models/earnings_line.py | 4 +- .../models/employee_statutory_sick_leave.py | 4 +- .../payrollnz/models/leave_earnings_line.py | 4 +- .../payrollnz/models/superannuation_line.py | 4 +- xero_python/payrollnz/models/timesheet.py | 4 +- .../models/timesheet_earnings_line.py | 4 +- xero_python/payrolluk/api/payroll_uk_api.py | 266 +-- .../docs/EmployeeStatutorySickLeave.md | 2 +- xero_python/payrolluk/docs/PayrollUkApi.md | 428 ++-- xero_python/payrolluk/docs/Timesheet.md | 2 +- .../models/employee_statutory_sick_leave.py | 4 +- xero_python/payrolluk/models/timesheet.py | 4 +- xero_python/project/api/project_api.py | 62 +- xero_python/project/docs/ProjectApi.md | 90 +- xero_python/rest.py | 4 +- 268 files changed, 2407 insertions(+), 2271 deletions(-) create mode 100644 xero_python/accounting/docs/CISOrgSettings.md create mode 100644 xero_python/accounting/models/cis_org_settings.py diff --git a/setup.py b/setup.py index a7d760ee..0f12def3 100644 --- a/setup.py +++ b/setup.py @@ -48,5 +48,5 @@ def read_file(filename): keywords="xero python sdk API oAuth", name="xero_python", packages=find_packages(include=["xero_python", "xero_python.*"]), - version="1.3.0", + version="1.4.0", ) diff --git a/xero_python/__init__.py b/xero_python/__init__.py index ea2527e3..cfbf45fc 100644 --- a/xero_python/__init__.py +++ b/xero_python/__init__.py @@ -2,4 +2,4 @@ __author__ = """Xero Developer API""" __email__ = "api@xero.com" -__version__ = "1.3.0" +__version__ = "1.4.0" diff --git a/xero_python/accounting/__init__.py b/xero_python/accounting/__init__.py index e7a8eb9e..59ae9915 100644 --- a/xero_python/accounting/__init__.py +++ b/xero_python/accounting/__init__.py @@ -3,7 +3,7 @@ # flake8: noqa """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 @@ -45,6 +45,7 @@ from xero_python.accounting.models.branding_theme import BrandingTheme from xero_python.accounting.models.branding_themes import BrandingThemes from xero_python.accounting.models.cis_org_setting import CISOrgSetting +from xero_python.accounting.models.cis_org_settings import CISOrgSettings from xero_python.accounting.models.cis_setting import CISSetting from xero_python.accounting.models.cis_settings import CISSettings from xero_python.accounting.models.contact import Contact diff --git a/xero_python/accounting/api/accounting_api.py b/xero_python/accounting/api/accounting_api.py index 0f4f8cc2..34b4ed56 100644 --- a/xero_python/accounting/api/accounting_api.py +++ b/xero_python/accounting/api/accounting_api.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.8.4 + OpenAPI spec version: 2.9.3 """ import importlib @@ -64,7 +64,7 @@ def create_account( _preload_content=True, _request_timeout=None, ): - """Allows you to create a new chart of accounts # noqa: E501 + """Creates a new chart of accounts # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Account account: Account object in body of request (required) @@ -145,7 +145,7 @@ def create_account_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to create Attachment on Account # noqa: E501 + """Creates an attachment on a specific account # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str account_id: Unique identifier for Account object (required) @@ -245,7 +245,7 @@ def create_bank_transaction_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to create an Attachment on BankTransaction by Filename # noqa: E501 + """Creates an attachment for a specific bank transaction by filename # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transaction_id: Xero generated unique identifier for a bank transaction (required) @@ -346,7 +346,7 @@ def create_bank_transaction_history_record( _preload_content=True, _request_timeout=None, ): - """Allows you to create history record for a bank transactions # noqa: E501 + """Creates a history record for a specific bank transactions # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transaction_id: Xero generated unique identifier for a bank transaction (required) @@ -438,7 +438,7 @@ def create_bank_transactions( _preload_content=True, _request_timeout=None, ): - """Allows you to create one or more spend or receive money transaction # noqa: E501 + """Creates one or more spent or received money transaction # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param BankTransactions bank_transactions: BankTransactions with an array of BankTransaction objects in body of request (required) @@ -525,7 +525,7 @@ def create_bank_transfer( _preload_content=True, _request_timeout=None, ): - """Allows you to create a bank transfers # noqa: E501 + """Creates a bank transfer # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param BankTransfers bank_transfers: BankTransfers with array of BankTransfer objects in request body (required) @@ -707,7 +707,7 @@ def create_bank_transfer_history_record( _preload_content=True, _request_timeout=None, ): - """Allows you to create history record for a bank transfers # noqa: E501 + """Creates a history record for a specific bank transfer # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transfer_id: Xero generated unique identifier for a bank transfer (required) @@ -798,7 +798,7 @@ def create_batch_payment( _preload_content=True, _request_timeout=None, ): - """Create one or many BatchPayments for invoices # noqa: E501 + """Creates one or many batch payments for invoices # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param BatchPayments batch_payments: BatchPayments with an array of Payments in body of request (required) @@ -882,7 +882,7 @@ def create_batch_payment_history_record( _preload_content=True, _request_timeout=None, ): - """Allows you to create a history record for a Batch Payment # noqa: E501 + """Creates a history record for a specific batch payment # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str batch_payment_id: Unique identifier for BatchPayment (required) @@ -973,7 +973,7 @@ def create_branding_theme_payment_services( _preload_content=True, _request_timeout=None, ): - """Allow for the creation of new custom payment service for specified Branding Theme # noqa: E501 + """Creates a new custom payment service for a specific branding theme # noqa: E501 OAuth2 scope: paymentservices :param str xero_tenant_id: Xero identifier for Tenant (required) :param str branding_theme_id: Unique identifier for a Branding Theme (required) @@ -1163,7 +1163,7 @@ def create_contact_group( _preload_content=True, _request_timeout=None, ): - """Allows you to create a contact group # noqa: E501 + """Creates a contact group # noqa: E501 OAuth2 scope: accounting.contacts :param str xero_tenant_id: Xero identifier for Tenant (required) :param ContactGroups contact_groups: ContactGroups with an array of names in request body (required) @@ -1243,11 +1243,11 @@ def create_contact_group_contacts( _preload_content=True, _request_timeout=None, ): - """Allows you to add Contacts to a Contact Group # noqa: E501 + """Creates contacts to a specific contact group # noqa: E501 OAuth2 scope: accounting.contacts :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_group_id: Unique identifier for a Contact Group (required) - :param Contacts contacts: Contacts with array of contacts specifiying the ContactID to be added to ContactGroup in body of request (required) + :param Contacts contacts: Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request (required) :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1334,7 +1334,7 @@ def create_contact_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a history records of an Contact # noqa: E501 + """Creates a new history record for a specific contact # noqa: E501 OAuth2 scope: accounting.contacts :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_id: Unique identifier for a Contact (required) @@ -1423,7 +1423,7 @@ def create_contacts( _preload_content=True, _request_timeout=None, ): - """Allows you to create a multiple contacts (bulk) in a Xero organisation # noqa: E501 + """Creates multiple contacts (bulk) in a Xero organisation # noqa: E501 OAuth2 scope: accounting.contacts :param str xero_tenant_id: Xero identifier for Tenant (required) :param Contacts contacts: Contacts with an array of Contact objects to create in body of request (required) @@ -1508,7 +1508,7 @@ def create_credit_note_allocation( _preload_content=True, _request_timeout=None, ): - """Allows you to create Allocation on CreditNote # noqa: E501 + """Creates allocation for a specific credit note # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str credit_note_id: Unique identifier for a Credit Note (required) @@ -1605,7 +1605,7 @@ def create_credit_note_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to create Attachments on CreditNote by file name # noqa: E501 + """Creates an attachment for a specific credit note # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str credit_note_id: Unique identifier for a Credit Note (required) @@ -1710,7 +1710,7 @@ def create_credit_note_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a history records of an CreditNote # noqa: E501 + """Retrieves history records of a specific credit note # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str credit_note_id: Unique identifier for a Credit Note (required) @@ -1800,7 +1800,7 @@ def create_credit_notes( _preload_content=True, _request_timeout=None, ): - """Allows you to create a credit note # noqa: E501 + """Creates a new credit note # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param CreditNotes credit_notes: Credit Notes with array of CreditNote object in body of request (required) @@ -1887,10 +1887,10 @@ def create_currency( _preload_content=True, _request_timeout=None, ): - """Allows you to create a new currency for an org # noqa: E501 + """Create a new currency for a Xero organisation # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) - :param Currency currency: Currency obejct in the body of request (required) + :param Currency currency: Currency object in the body of request (required) :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1967,7 +1967,7 @@ def create_employees( _preload_content=True, _request_timeout=None, ): - """Allows you to create new employees used in Xero payrun # noqa: E501 + """Creates new employees used in Xero payrun # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Employees employees: Employees with array of Employee object in body of request (required) @@ -2051,7 +2051,7 @@ def create_expense_claim_history( _preload_content=True, _request_timeout=None, ): - """Allows you to create a history records of an ExpenseClaim # noqa: E501 + """Creates a history record for a specific expense claim # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str expense_claim_id: Unique identifier for a ExpenseClaim (required) @@ -2141,7 +2141,7 @@ def create_expense_claims( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve expense claims # noqa: E501 + """Creates expense claims # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param ExpenseClaims expense_claims: ExpenseClaims with array of ExpenseClaim object in body of request (required) @@ -2223,7 +2223,7 @@ def create_invoice_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to create an Attachment on invoices or purchase bills by it's filename # noqa: E501 + """Creates an attachment for a specific invoice or purchase bill by filename # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) @@ -2326,7 +2326,7 @@ def create_invoice_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a history records of an invoice # noqa: E501 + """Creates a history record for a specific invoice # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) @@ -2416,7 +2416,7 @@ def create_invoices( _preload_content=True, _request_timeout=None, ): - """Allows you to create one or more sales invoices or purchase bills # noqa: E501 + """Creates one or more sales invoices or purchase bills # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param Invoices invoices: Invoices with an array of invoice objects in body of request (required) @@ -2504,7 +2504,7 @@ def create_item_history( _preload_content=True, _request_timeout=None, ): - """Allows you to create a history record for items # noqa: E501 + """Creates a history record for a specific item # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str item_id: Unique identifier for an Item (required) @@ -2594,7 +2594,7 @@ def create_items( _preload_content=True, _request_timeout=None, ): - """Allows you to create one or more items # noqa: E501 + """Creates one or more items # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Items items: Items with an array of Item objects in body of request (required) @@ -2680,7 +2680,7 @@ def create_linked_transaction( _preload_content=True, _request_timeout=None, ): - """Allows you to create linked transactions (billable expenses) # noqa: E501 + """Creates linked transactions (billable expenses) # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param LinkedTransaction linked_transaction: LinkedTransaction object in body of request (required) @@ -2761,7 +2761,7 @@ def create_manual_journal_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to create a specified Attachment on ManualJournal by file name # noqa: E501 + """Creates a specific attachment for a specific manual journal by file name # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str manual_journal_id: Unique identifier for a ManualJournal (required) @@ -2862,7 +2862,7 @@ def create_manual_journal_history_record( _preload_content=True, _request_timeout=None, ): - """Allows you to create history record for a manual journal # noqa: E501 + """Creates a history record for a specific manual journal # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str manual_journal_id: Xero generated unique identifier for a manual journal (required) @@ -2953,7 +2953,7 @@ def create_manual_journals( _preload_content=True, _request_timeout=None, ): - """Allows you to create one or more manual journals # noqa: E501 + """Creates one or more manual journals # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param ManualJournals manual_journals: ManualJournals array with ManualJournal object in body of request (required) @@ -3038,7 +3038,7 @@ def create_overpayment_allocations( _preload_content=True, _request_timeout=None, ): - """Allows you to create a single allocation for an overpayment # noqa: E501 + """Creates a single allocation for a specific overpayment # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str overpayment_id: Unique identifier for a Overpayment (required) @@ -3133,7 +3133,7 @@ def create_overpayment_history( _preload_content=True, _request_timeout=None, ): - """Allows you to create history records of an Overpayment # noqa: E501 + """Creates a history record for a specific overpayment # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str overpayment_id: Unique identifier for a Overpayment (required) @@ -3221,7 +3221,7 @@ def create_payment( _preload_content=True, _request_timeout=None, ): - """Allows you to create a single payment for invoices or credit notes # noqa: E501 + """Creates a single payment for invoice or credit notes # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param Payment payment: Request body with a single Payment object (required) @@ -3301,7 +3301,7 @@ def create_payment_history( _preload_content=True, _request_timeout=None, ): - """Allows you to create a history record for a payment # noqa: E501 + """Creates a history record for a specific payment # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str payment_id: Unique identifier for a Payment (required) @@ -3389,7 +3389,7 @@ def create_payment_service( _preload_content=True, _request_timeout=None, ): - """Allows you to create payment services # noqa: E501 + """Creates a payment service # noqa: E501 OAuth2 scope: paymentservices :param str xero_tenant_id: Xero identifier for Tenant (required) :param PaymentServices payment_services: PaymentServices array with PaymentService object in body of request (required) @@ -3469,7 +3469,7 @@ def create_payments( _preload_content=True, _request_timeout=None, ): - """Allows you to create multiple payments for invoices or credit notes # noqa: E501 + """Creates multiple payments for invoices or credit notes # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param Payments payments: Payments array with Payment object in body of request (required) @@ -3649,7 +3649,7 @@ def create_prepayment_history( _preload_content=True, _request_timeout=None, ): - """Allows you to create a history record for an Prepayment # noqa: E501 + """Creates a history record for a specific prepayment # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str prepayment_id: Unique identifier for a PrePayment (required) @@ -3739,7 +3739,7 @@ def create_purchase_order_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to create Attachment on Purchase Order # noqa: E501 + """Creates attachment for a specific purchase order # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str purchase_order_id: Unique identifier for Purchase Order object (required) @@ -3840,7 +3840,7 @@ def create_purchase_order_history( _preload_content=True, _request_timeout=None, ): - """Allows you to create HistoryRecord for purchase orders # noqa: E501 + """Creates a history record for a specific purchase orders # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str purchase_order_id: Unique identifier for a PurchaseOrder (required) @@ -3931,7 +3931,7 @@ def create_purchase_orders( _preload_content=True, _request_timeout=None, ): - """Allows you to create one or more purchase orders # noqa: E501 + """Creates one or more purchase orders # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param PurchaseOrders purchase_orders: PurchaseOrders with an array of PurchaseOrder object in body of request (required) @@ -4016,7 +4016,7 @@ def create_quote_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to create Attachment on Quote # noqa: E501 + """Creates attachment for a specific quote # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str quote_id: Unique identifier for Quote object (required) @@ -4115,7 +4115,7 @@ def create_quote_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a history records of an quote # noqa: E501 + """Creates a history record for a specific quote # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str quote_id: Unique identifier for an Quote (required) @@ -4204,7 +4204,7 @@ def create_quotes( _preload_content=True, _request_timeout=None, ): - """Allows you to create one or more quotes # noqa: E501 + """Create one or more quotes # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param Quotes quotes: Quotes with an array of Quote object in body of request (required) @@ -4288,7 +4288,7 @@ def create_receipt( _preload_content=True, _request_timeout=None, ): - """Allows you to create draft expense claim receipts for any user # noqa: E501 + """Creates draft expense claim receipts for any user # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param Receipts receipts: Receipts with an array of Receipt object in body of request (required) @@ -4373,7 +4373,7 @@ def create_receipt_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to create Attachment on expense claim receipts by file name # noqa: E501 + """Creates an attachment on a specific expense claim receipts by file name # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str receipt_id: Unique identifier for a Receipt (required) @@ -4472,7 +4472,7 @@ def create_receipt_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a history records of an Receipt # noqa: E501 + """Creates a history record for a specific receipt # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str receipt_id: Unique identifier for a Receipt (required) @@ -4562,7 +4562,7 @@ def create_repeating_invoice_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to create attachment on repeating invoices by file name # noqa: E501 + """Creates an attachment from a specific repeating invoices by file name # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str repeating_invoice_id: Unique identifier for a Repeating Invoice (required) @@ -4663,7 +4663,7 @@ def create_repeating_invoice_history( _preload_content=True, _request_timeout=None, ): - """Allows you to create history for a repeating invoice # noqa: E501 + """Creates a history record for a specific repeating invoice # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str repeating_invoice_id: Unique identifier for a Repeating Invoice (required) @@ -4753,7 +4753,7 @@ def create_tax_rates( _preload_content=True, _request_timeout=None, ): - """Allows you to create one or more Tax Rates # noqa: E501 + """Creates one or more tax rates # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param TaxRates tax_rates: TaxRates array with TaxRate object in body of request (required) @@ -4832,7 +4832,7 @@ def create_tracking_category( _preload_content=True, _request_timeout=None, ): - """Allows you to create tracking categories # noqa: E501 + """Create tracking categories # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param TrackingCategory tracking_category: TrackingCategory object in body of request (required) @@ -4912,7 +4912,7 @@ def create_tracking_options( _preload_content=True, _request_timeout=None, ): - """Allows you to create options for a specified tracking category # noqa: E501 + """Creates options for a specific tracking category # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str tracking_category_id: Unique identifier for a TrackingCategory (required) @@ -5000,7 +5000,7 @@ def delete_account( _preload_content=True, _request_timeout=None, ): - """Allows you to delete a chart of accounts # noqa: E501 + """Deletes a chart of accounts # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str account_id: Unique identifier for retrieving single object (required) @@ -5077,7 +5077,7 @@ def delete_contact_group_contact( _preload_content=True, _request_timeout=None, ): - """Allows you to delete a specific Contact from a Contact Group # noqa: E501 + """Deletes a specific contact from a contact group using a unique contact Id # noqa: E501 OAuth2 scope: accounting.contacts :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_group_id: Unique identifier for a Contact Group (required) @@ -5165,7 +5165,7 @@ def delete_contact_group_contacts( _preload_content=True, _request_timeout=None, ): - """Allows you to delete all Contacts from a Contact Group # noqa: E501 + """Deletes all contacts from a specific contact group # noqa: E501 OAuth2 scope: accounting.contacts :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_group_id: Unique identifier for a Contact Group (required) @@ -5238,7 +5238,7 @@ def delete_item( _preload_content=True, _request_timeout=None, ): - """Allows you to delete a specified item # noqa: E501 + """Deletes a specific item # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str item_id: Unique identifier for an Item (required) @@ -5313,7 +5313,7 @@ def delete_linked_transaction( _preload_content=True, _request_timeout=None, ): - """Allows you to delete a specified linked transactions (billable expenses) # noqa: E501 + """Deletes a specific linked transactions (billable expenses) # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str linked_transaction_id: Unique identifier for a LinkedTransaction (required) @@ -5390,7 +5390,7 @@ def delete_payment( _preload_content=True, _request_timeout=None, ): - """Allows you to update a specified payment for invoices and credit notes # noqa: E501 + """Updates a specific payment for invoices and credit notes # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str payment_id: Unique identifier for a Payment (required) @@ -5478,7 +5478,7 @@ def delete_tracking_category( _preload_content=True, _request_timeout=None, ): - """Allows you to delete tracking categories # noqa: E501 + """Deletes a specific tracking category # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str tracking_category_id: Unique identifier for a TrackingCategory (required) @@ -5555,7 +5555,7 @@ def delete_tracking_options( _preload_content=True, _request_timeout=None, ): - """Allows you to delete a specified option for a specified tracking category # noqa: E501 + """Deletes a specific option for a specific tracking category # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str tracking_category_id: Unique identifier for a TrackingCategory (required) @@ -5642,7 +5642,7 @@ def email_invoice( _preload_content=True, _request_timeout=None, ): - """Allows you to email a copy of invoice to related Contact # noqa: E501 + """Sends a copy of a specific invoice to related contact via email # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) @@ -5730,7 +5730,7 @@ def get_account( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a single chart of accounts # noqa: E501 + """Retrieves a single chart of accounts by using a unique account Id # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str account_id: Unique identifier for retrieving single object (required) @@ -5808,7 +5808,7 @@ def get_account_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachment on Account by Filename # noqa: E501 + """Retrieves an attachment for a specific account by filename # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str account_id: Unique identifier for Account object (required) @@ -5904,7 +5904,7 @@ def get_account_attachment_by_id( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve specific Attachment on Account # noqa: E501 + """Retrieves a specific attachment from a specific account using a unique attachment Id # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str account_id: Unique identifier for Account object (required) @@ -5998,7 +5998,7 @@ def get_account_attachments( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments for accounts # noqa: E501 + """Retrieves attachments for a specific accounts by using a unique account Id # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str account_id: Unique identifier for Account object (required) @@ -6076,7 +6076,7 @@ def get_accounts( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve the full chart of accounts # noqa: E501 + """Retrieves the full chart of accounts # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -6156,7 +6156,7 @@ def get_bank_transaction( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a single spend or receive money transaction # noqa: E501 + """Retrieves a single spent or received money transaction by using a unique bank transaction Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transaction_id: Xero generated unique identifier for a bank transaction (required) @@ -6238,7 +6238,7 @@ def get_bank_transaction_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments on BankTransaction by Filename # noqa: E501 + """Retrieves a specific attachment from a specific bank transaction by filename # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transaction_id: Xero generated unique identifier for a bank transaction (required) @@ -6336,7 +6336,7 @@ def get_bank_transaction_attachment_by_id( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments on a specific BankTransaction # noqa: E501 + """Retrieves specific attachments from a specific BankTransaction using a unique attachment Id # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transaction_id: Xero generated unique identifier for a bank transaction (required) @@ -6432,7 +6432,7 @@ def get_bank_transaction_attachments( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve any attachments to bank transactions # noqa: E501 + """Retrieves any attachments from a specific bank transactions # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transaction_id: Xero generated unique identifier for a bank transaction (required) @@ -6514,7 +6514,7 @@ def get_bank_transactions( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve any spend or receive money transactions # noqa: E501 + """Retrieves any spent or received money transactions # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -6601,7 +6601,7 @@ def get_bank_transactions_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve history from a bank transactions # noqa: E501 + """Retrieves history from a specific bank transaction using a unique bank transaction Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transaction_id: Xero generated unique identifier for a bank transaction (required) @@ -6679,7 +6679,7 @@ def get_bank_transfer( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve any bank transfers # noqa: E501 + """Retrieves specific bank transfers by using a unique bank transfer Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transfer_id: Xero generated unique identifier for a bank transfer (required) @@ -6757,7 +6757,7 @@ def get_bank_transfer_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments on BankTransfer by file name # noqa: E501 + """Retrieves a specific attachment on a specific bank transfer by file name # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transfer_id: Xero generated unique identifier for a bank transfer (required) @@ -6855,7 +6855,7 @@ def get_bank_transfer_attachment_by_id( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments on BankTransfer # noqa: E501 + """Retrieves a specific attachment from a specific bank transfer using a unique attachment ID # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transfer_id: Xero generated unique identifier for a bank transfer (required) @@ -6951,7 +6951,7 @@ def get_bank_transfer_attachments( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments from bank transfers # noqa: E501 + """Retrieves attachments from a specific bank transfer # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transfer_id: Xero generated unique identifier for a bank transfer (required) @@ -7029,7 +7029,7 @@ def get_bank_transfer_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve history from a bank transfers # noqa: E501 + """Retrieves history from a specific bank transfer using a unique bank transfer Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transfer_id: Xero generated unique identifier for a bank transfer (required) @@ -7107,7 +7107,7 @@ def get_bank_transfers( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve all bank transfers # noqa: E501 + """Retrieves all bank transfers # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -7186,7 +7186,7 @@ def get_batch_payment_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve history from a Batch Payment # noqa: E501 + """Retrieves history from a specific batch payment # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str batch_payment_id: Unique identifier for BatchPayment (required) @@ -7264,7 +7264,7 @@ def get_batch_payments( _preload_content=True, _request_timeout=None, ): - """Retrieve either one or many BatchPayments for invoices # noqa: E501 + """Retrieves either one or many batch payments for invoices # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -7343,7 +7343,7 @@ def get_branding_theme( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specific BrandingThemes # noqa: E501 + """Retrieves a specific branding theme using a unique branding theme Id # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str branding_theme_id: Unique identifier for a Branding Theme (required) @@ -7419,7 +7419,7 @@ def get_branding_theme_payment_services( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve the Payment services for a Branding Theme # noqa: E501 + """Retrieves the payment services for a specific branding theme # noqa: E501 OAuth2 scope: paymentservices :param str xero_tenant_id: Xero identifier for Tenant (required) :param str branding_theme_id: Unique identifier for a Branding Theme (required) @@ -7496,7 +7496,7 @@ def get_branding_themes( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve all the BrandingThemes # noqa: E501 + """Retrieves all the branding themes # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param bool _return_http_data_only: return received data only @@ -7563,7 +7563,7 @@ def get_contact( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a single contacts in a Xero organisation # noqa: E501 + """Retrieves a specific contacts in a Xero organisation using a unique contact Id # noqa: E501 OAuth2 scope: accounting.contacts.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_id: Unique identifier for a Contact (required) @@ -7641,7 +7641,7 @@ def get_contact_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments on Contacts by file name # noqa: E501 + """Retrieves a specific attachment from a specific contact by file name # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_id: Unique identifier for a Contact (required) @@ -7737,7 +7737,7 @@ def get_contact_attachment_by_id( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments on Contacts # noqa: E501 + """Retrieves a specific attachment from a specific contact using a unique attachment Id # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_id: Unique identifier for a Contact (required) @@ -7831,7 +7831,7 @@ def get_contact_attachments( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve, add and update contacts in a Xero organisation # noqa: E501 + """Retrieves attachments for a specific contact in a Xero organisation # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_id: Unique identifier for a Contact (required) @@ -7907,7 +7907,7 @@ def get_contact_by_contact_number( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a single contact by Contact Number in a Xero organisation # noqa: E501 + """Retrieves a specific contact by contact number in a Xero organisation # noqa: E501 OAuth2 scope: accounting.contacts.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_number: This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). (required) @@ -7985,7 +7985,7 @@ def get_contact_cis_settings( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve CISSettings for a contact in a Xero organisation # noqa: E501 + """Retrieves CIS settings for a specific contact in a Xero organisation # noqa: E501 OAuth2 scope: accounting.contacts.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_id: Unique identifier for a Contact (required) @@ -8061,7 +8061,7 @@ def get_contact_group( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a unique Contact Group by ID # noqa: E501 + """Retrieves a specific contact group by using a unique contact group Id # noqa: E501 OAuth2 scope: accounting.contacts.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_group_id: Unique identifier for a Contact Group (required) @@ -8138,7 +8138,7 @@ def get_contact_groups( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve the ContactID and Name of all the contacts in a contact group # noqa: E501 + """Retrieves the contact Id and name of all the contacts in a contact group # noqa: E501 OAuth2 scope: accounting.contacts.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str where: Filter by an any element @@ -8213,7 +8213,7 @@ def get_contact_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a history records of an Contact # noqa: E501 + """Retrieves history records for a specific contact # noqa: E501 OAuth2 scope: accounting.contacts.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_id: Unique identifier for a Contact (required) @@ -8294,7 +8294,7 @@ def get_contacts( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve all contacts in a Xero organisation # noqa: E501 + """Retrieves all contacts in a Xero organisation # noqa: E501 OAuth2 scope: accounting.contacts.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -8388,7 +8388,7 @@ def get_credit_note( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specific credit note # noqa: E501 + """Retrieves a specific credit note using a unique credit note Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str credit_note_id: Unique identifier for a Credit Note (required) @@ -8468,7 +8468,7 @@ def get_credit_note_as_pdf( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Credit Note as PDF files # noqa: E501 + """Retrieves credit notes as PDF files # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str credit_note_id: Unique identifier for a Credit Note (required) @@ -8546,7 +8546,7 @@ def get_credit_note_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments on CreditNote by file name # noqa: E501 + """Retrieves a specific attachment on a specific credit note by file name # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str credit_note_id: Unique identifier for a Credit Note (required) @@ -8644,7 +8644,7 @@ def get_credit_note_attachment_by_id( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments on CreditNote # noqa: E501 + """Retrieves a specific attachment from a specific credit note using a unique attachment Id # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str credit_note_id: Unique identifier for a Credit Note (required) @@ -8740,7 +8740,7 @@ def get_credit_note_attachments( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments for credit notes # noqa: E501 + """Retrieves attachments for a specific credit notes # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str credit_note_id: Unique identifier for a Credit Note (required) @@ -8816,7 +8816,7 @@ def get_credit_note_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a history records of an CreditNote # noqa: E501 + """Retrieves history records of a specific credit note # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str credit_note_id: Unique identifier for a Credit Note (required) @@ -8896,7 +8896,7 @@ def get_credit_notes( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve any credit notes # noqa: E501 + """Retrieves any credit notes # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -8984,7 +8984,7 @@ def get_currencies( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve currencies for your organisation # noqa: E501 + """Retrieves currencies for your Xero organisation # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str where: Filter by an any element @@ -9059,7 +9059,7 @@ def get_employee( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specific employee used in Xero payrun # noqa: E501 + """Retrieves a specific employee used in Xero payrun using a unique employee Id # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Unique identifier for a Employee (required) @@ -9137,7 +9137,7 @@ def get_employees( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve employees used in Xero payrun # noqa: E501 + """Retrieves employees used in Xero payrun # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -9216,7 +9216,7 @@ def get_expense_claim( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified expense claim # noqa: E501 + """Retrieves a specific expense claim using a unique expense claim Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str expense_claim_id: Unique identifier for a ExpenseClaim (required) @@ -9292,7 +9292,7 @@ def get_expense_claim_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a history records of an ExpenseClaim # noqa: E501 + """Retrieves history records of a specific expense claim # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str expense_claim_id: Unique identifier for a ExpenseClaim (required) @@ -9370,7 +9370,7 @@ def get_expense_claims( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve expense claims # noqa: E501 + """Retrieves expense claims # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -9450,7 +9450,7 @@ def get_invoice( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified sales invoice or purchase bill # noqa: E501 + """Retrieves a specific sales invoice or purchase bill using a unique invoice Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) @@ -9530,7 +9530,7 @@ def get_invoice_as_pdf( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve invoices or purchase bills as PDF files # noqa: E501 + """Retrieves invoices or purchase bills as PDF files # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) @@ -9608,7 +9608,7 @@ def get_invoice_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachment on invoices or purchase bills by it's filename # noqa: E501 + """Retrieves an attachment from a specific invoice or purchase bill by filename # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) @@ -9704,7 +9704,7 @@ def get_invoice_attachment_by_id( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified Attachment on invoices or purchase bills by it's ID # noqa: E501 + """Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) @@ -9798,7 +9798,7 @@ def get_invoice_attachments( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments on invoices or purchase bills # noqa: E501 + """Retrieves attachments for a specific invoice or purchase bill # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) @@ -9874,7 +9874,7 @@ def get_invoice_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a history records of an invoice # noqa: E501 + """Retrieves history records for a specific invoice # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) @@ -9949,7 +9949,7 @@ def get_invoice_reminders( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve invoice reminder settings # noqa: E501 + """Retrieves invoice reminder settings # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param bool _return_http_data_only: return received data only @@ -10026,7 +10026,7 @@ def get_invoices( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve any sales invoices or purchase bills # noqa: E501 + """Retrieves sales invoices or purchase bills # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -10143,7 +10143,7 @@ def get_item( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified item # noqa: E501 + """Retrieves a specific item using a unique item Id # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str item_id: Unique identifier for an Item (required) @@ -10222,7 +10222,7 @@ def get_item_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve history for items # noqa: E501 + """Retrieves history for a specific item # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str item_id: Unique identifier for an Item (required) @@ -10301,7 +10301,7 @@ def get_items( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve any items # noqa: E501 + """Retrieves items # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -10384,7 +10384,7 @@ def get_journal( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified journals. # noqa: E501 + """Retrieves a specific journal using a unique journal Id. # noqa: E501 OAuth2 scope: accounting.journals.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str journal_id: Unique identifier for a Journal (required) @@ -10462,7 +10462,7 @@ def get_journals( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve any journals. # noqa: E501 + """Retrieves journals # noqa: E501 OAuth2 scope: accounting.journals.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -10541,7 +10541,7 @@ def get_linked_transaction( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified linked transactions (billable expenses) # noqa: E501 + """Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str linked_transaction_id: Unique identifier for a LinkedTransaction (required) @@ -10622,14 +10622,14 @@ def get_linked_transactions( _preload_content=True, _request_timeout=None, ): - """Retrieve linked transactions (billable expenses) # noqa: E501 + """Retrieves linked transactions (billable expenses) # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1. :param str linked_transaction_id: The Xero identifier for an Linked Transaction :param str source_transaction_id: Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice :param str contact_id: Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer. - :param str status: Filter by the combination of ContactID and Status. Get the linked transactions associaed to a customer and with a status + :param str status: Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status :param str target_transaction_id: Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models @@ -10713,7 +10713,7 @@ def get_manual_journal( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified manual journals # noqa: E501 + """Retrieves a specific manual journal # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str manual_journal_id: Unique identifier for a ManualJournal (required) @@ -10791,7 +10791,7 @@ def get_manual_journal_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve specified Attachment on ManualJournal by file name # noqa: E501 + """Retrieves a specific attachment from a specific manual journal by file name # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str manual_journal_id: Unique identifier for a ManualJournal (required) @@ -10889,7 +10889,7 @@ def get_manual_journal_attachment_by_id( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve specified Attachment on ManualJournals # noqa: E501 + """Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str manual_journal_id: Unique identifier for a ManualJournal (required) @@ -10985,7 +10985,7 @@ def get_manual_journal_attachments( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachment for manual journals # noqa: E501 + """Retrieves attachment for a specific manual journal # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str manual_journal_id: Unique identifier for a ManualJournal (required) @@ -11066,7 +11066,7 @@ def get_manual_journals( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve any manual journals # noqa: E501 + """Retrieves manual journals # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -11149,7 +11149,7 @@ def get_manual_journals_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve history from a manual journal # noqa: E501 + """Retrieves history for a specific manual journal # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str manual_journal_id: Xero generated unique identifier for a manual journal (required) @@ -11225,7 +11225,7 @@ def get_online_invoice( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a URL to an online invoice # noqa: E501 + """Retrieves a URL to an online invoice # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) @@ -11300,7 +11300,7 @@ def get_organisation_actions( _preload_content=True, _request_timeout=None, ): - """Retrieve a list of the key actions your app has permission to perform in the connected organisation. # noqa: E501 + """Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation. # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param bool _return_http_data_only: return received data only @@ -11367,14 +11367,14 @@ def get_organisation_cis_settings( _preload_content=True, _request_timeout=None, ): - """Allows you To verify if an organisation is using contruction industry scheme, you can retrieve the CIS settings for the organistaion. # noqa: E501 + """Retrieves the CIS settings for the Xero organistaion. # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str organisation_id: The unique Xero identifier for an organisation (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: CISOrgSetting + :return: CISOrgSettings """ # verify the required parameter 'xero_tenant_id' is set @@ -11424,7 +11424,7 @@ def get_organisation_cis_settings( body=body_params, post_params=form_params, files=local_var_files, - response_type="CISOrgSetting", + response_type="CISOrgSettings", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, @@ -11444,7 +11444,7 @@ def get_organisations( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Organisation details # noqa: E501 + """Retrieves Xero organisation details # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param bool _return_http_data_only: return received data only @@ -11511,7 +11511,7 @@ def get_overpayment( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified overpayments # noqa: E501 + """Retrieves a specific overpayment using a unique overpayment Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str overpayment_id: Unique identifier for a Overpayment (required) @@ -11587,7 +11587,7 @@ def get_overpayment_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a history records of an Overpayment # noqa: E501 + """Retrieves history records of a specific overpayment # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str overpayment_id: Unique identifier for a Overpayment (required) @@ -11667,7 +11667,7 @@ def get_overpayments( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve overpayments # noqa: E501 + """Retrieves overpayments # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -11754,7 +11754,7 @@ def get_payment( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified payment for invoices and credit notes # noqa: E501 + """Retrieves a specific payment for invoices and credit notes using a unique payment Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str payment_id: Unique identifier for a Payment (required) @@ -11830,7 +11830,7 @@ def get_payment_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve history records of a payment # noqa: E501 + """Retrieves history records of a specific payment # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str payment_id: Unique identifier for a Payment (required) @@ -11905,7 +11905,7 @@ def get_payment_services( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve payment services # noqa: E501 + """Retrieves payment services # noqa: E501 OAuth2 scope: paymentservices :param str xero_tenant_id: Xero identifier for Tenant (required) :param bool _return_http_data_only: return received data only @@ -11975,7 +11975,7 @@ def get_payments( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve payments for invoices and credit notes # noqa: E501 + """Retrieves payments for invoices and credit notes # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -12134,7 +12134,7 @@ def get_prepayment_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a history records of an Prepayment # noqa: E501 + """Retrieves history record for a specific prepayment # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str prepayment_id: Unique identifier for a PrePayment (required) @@ -12214,7 +12214,7 @@ def get_prepayments( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve prepayments # noqa: E501 + """Retrieves prepayments # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -12301,7 +12301,7 @@ def get_purchase_order( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified purchase orders # noqa: E501 + """Retrieves a specific purchase order using a unique purchase order Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str purchase_order_id: Unique identifier for a PurchaseOrder (required) @@ -12377,7 +12377,7 @@ def get_purchase_order_as_pdf( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve purchase orders as PDF files # noqa: E501 + """Retrieves specific purchase order as PDF files using a unique purchase order Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str purchase_order_id: Unique identifier for an Purchase Order (required) @@ -12455,7 +12455,7 @@ def get_purchase_order_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachment on a Purchase Order by Filename # noqa: E501 + """Retrieves a specific attachment for a specific purchase order by filename # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str purchase_order_id: Unique identifier for Purchase Order object (required) @@ -12553,7 +12553,7 @@ def get_purchase_order_attachment_by_id( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve specific Attachment on purchase order # noqa: E501 + """Retrieves specific attachment for a specific purchase order using a unique attachment Id # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str purchase_order_id: Unique identifier for Purchase Order object (required) @@ -12649,7 +12649,7 @@ def get_purchase_order_attachments( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve attachments for purchase orders # noqa: E501 + """Retrieves attachments for a specific purchase order # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str purchase_order_id: Unique identifier for Purchase Orders object (required) @@ -12727,7 +12727,7 @@ def get_purchase_order_by_number( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified purchase orders # noqa: E501 + """Retrieves a specific purchase order using purchase order number # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str purchase_order_number: Unique identifier for a PurchaseOrder (required) @@ -12805,7 +12805,7 @@ def get_purchase_order_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve history for PurchaseOrder # noqa: E501 + """Retrieves history for a specific purchase order # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str purchase_order_id: Unique identifier for a PurchaseOrder (required) @@ -12886,7 +12886,7 @@ def get_purchase_orders( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve purchase orders # noqa: E501 + """Retrieves purchase orders # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -12977,7 +12977,7 @@ def get_quote( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified quote # noqa: E501 + """Retrieves a specific quote using a unique quote Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str quote_id: Unique identifier for an Quote (required) @@ -13052,7 +13052,7 @@ def get_quote_as_pdf( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve quotes as PDF files # noqa: E501 + """Retrieves a specific quote as a PDF file using a unique quote Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str quote_id: Unique identifier for an Quote (required) @@ -13130,7 +13130,7 @@ def get_quote_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachment on Quote by Filename # noqa: E501 + """Retrieves a specific attachment from a specific quote by filename # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str quote_id: Unique identifier for Quote object (required) @@ -13226,7 +13226,7 @@ def get_quote_attachment_by_id( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve specific Attachment on Quote # noqa: E501 + """Retrieves a specific attachment from a specific quote using a unique attachment Id # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str quote_id: Unique identifier for Quote object (required) @@ -13318,7 +13318,7 @@ def get_quote_attachments( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments for Quotes # noqa: E501 + """Retrieves attachments for a specific quote # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str quote_id: Unique identifier for Quote object (required) @@ -13394,7 +13394,7 @@ def get_quote_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a history records of an quote # noqa: E501 + """Retrieves history records of a specific quote # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str quote_id: Unique identifier for an Quote (required) @@ -13479,7 +13479,7 @@ def get_quotes( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve any sales quotes # noqa: E501 + """Retrieves sales quotes # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -13587,7 +13587,7 @@ def get_receipt( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified draft expense claim receipts # noqa: E501 + """Retrieves a specific draft expense claim receipt by using a unique receipt Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str receipt_id: Unique identifier for a Receipt (required) @@ -13669,7 +13669,7 @@ def get_receipt_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments on expense claim receipts by file name # noqa: E501 + """Retrieves a specific attachment from a specific expense claim receipts by file name # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str receipt_id: Unique identifier for a Receipt (required) @@ -13765,7 +13765,7 @@ def get_receipt_attachment_by_id( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments on expense claim receipts by ID # noqa: E501 + """Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str receipt_id: Unique identifier for a Receipt (required) @@ -13859,7 +13859,7 @@ def get_receipt_attachments( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments for expense claim receipts # noqa: E501 + """Retrieves attachments for a specific expense claim receipt # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str receipt_id: Unique identifier for a Receipt (required) @@ -13935,7 +13935,7 @@ def get_receipt_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a history records of an Receipt # noqa: E501 + """Retrieves a history record for a specific receipt # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str receipt_id: Unique identifier for a Receipt (required) @@ -14014,7 +14014,7 @@ def get_receipts( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve draft expense claim receipts for any user # noqa: E501 + """Retrieves draft expense claim receipts for any user # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -14097,7 +14097,7 @@ def get_repeating_invoice( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified repeating invoice # noqa: E501 + """Retrieves a specific repeating invoice by using a unique repeating invoice Id # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str repeating_invoice_id: Unique identifier for a Repeating Invoice (required) @@ -14175,7 +14175,7 @@ def get_repeating_invoice_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve specified attachment on repeating invoices by file name # noqa: E501 + """Retrieves a specific attachment from a specific repeating invoices by file name # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str repeating_invoice_id: Unique identifier for a Repeating Invoice (required) @@ -14273,7 +14273,7 @@ def get_repeating_invoice_attachment_by_id( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified Attachments on repeating invoices # noqa: E501 + """Retrieves a specific attachment from a specific repeating invoice # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str repeating_invoice_id: Unique identifier for a Repeating Invoice (required) @@ -14369,7 +14369,7 @@ def get_repeating_invoice_attachments( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Attachments on repeating invoice # noqa: E501 + """Retrieves attachments from a specific repeating invoice # noqa: E501 OAuth2 scope: accounting.attachments.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str repeating_invoice_id: Unique identifier for a Repeating Invoice (required) @@ -14449,7 +14449,7 @@ def get_repeating_invoice_history( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve history for a repeating invoice # noqa: E501 + """Retrieves history record for a specific repeating invoice # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str repeating_invoice_id: Unique identifier for a Repeating Invoice (required) @@ -14528,7 +14528,7 @@ def get_repeating_invoices( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve any repeating invoices # noqa: E501 + """Retrieves repeating invoices # noqa: E501 OAuth2 scope: accounting.transactions.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str where: Filter by an any element @@ -14606,7 +14606,7 @@ def get_report_aged_payables_by_contact( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve report for AgedPayablesByContact # noqa: E501 + """Retrieves report for aged payables by contact # noqa: E501 OAuth2 scope: accounting.reports.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_id: Unique identifier for a Contact (required) @@ -14699,7 +14699,7 @@ def get_report_aged_receivables_by_contact( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve report for AgedReceivablesByContact # noqa: E501 + """Retrieves report for aged receivables by contact # noqa: E501 OAuth2 scope: accounting.reports.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_id: Unique identifier for a Contact (required) @@ -14789,7 +14789,7 @@ def get_report_ba_sor_gst( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve report for BAS only valid for AU orgs # noqa: E501 + """Retrieves a specific report for BAS using a unique report Id (only valid for AU orgs) # noqa: E501 OAuth2 scope: accounting.reports.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str report_id: Unique identifier for a Report (required) @@ -14864,7 +14864,7 @@ def get_report_ba_sor_gst_list( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve report for BAS only valid for AU orgs # noqa: E501 + """Retrieves report for BAS (only valid for AU orgs) # noqa: E501 OAuth2 scope: accounting.reports.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param bool _return_http_data_only: return received data only @@ -14937,7 +14937,7 @@ def get_report_balance_sheet( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve report for BalanceSheet # noqa: E501 + """Retrieves report for balancesheet # noqa: E501 OAuth2 scope: accounting.reports.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param date date: The date of the Balance Sheet report @@ -15033,7 +15033,7 @@ def get_report_bank_summary( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve report for BankSummary # noqa: E501 + """Retrieves report for bank summary # noqa: E501 OAuth2 scope: accounting.reports.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param date from_date: The from date for the Bank Summary report e.g. 2018-03-31 @@ -15110,7 +15110,7 @@ def get_report_budget_summary( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve report for Budget Summary # noqa: E501 + """Retrieves report for budget summary # noqa: E501 OAuth2 scope: accounting.reports.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param date date: The date for the Bank Summary report e.g. 2018-03-31 @@ -15189,7 +15189,7 @@ def get_report_executive_summary( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve report for ExecutiveSummary # noqa: E501 + """Retrieves report for executive summary # noqa: E501 OAuth2 scope: accounting.reports.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param date date: The date for the Bank Summary report e.g. 2018-03-31 @@ -15271,7 +15271,7 @@ def get_report_profit_and_loss( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve report for ProfitAndLoss # noqa: E501 + """Retrieves report for profit and loss # noqa: E501 OAuth2 scope: accounting.reports.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param date from_date: The from date for the ProfitAndLoss report e.g. 2018-03-31 @@ -15378,7 +15378,7 @@ def get_report_ten_ninety_nine( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve report for TenNinetyNine # noqa: E501 + """Retrieve reports for 1099 # noqa: E501 OAuth2 scope: accounting.reports.tenninetynine.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str report_year: The year of the 1099 report @@ -15450,7 +15450,7 @@ def get_report_trial_balance( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve report for TrialBalance # noqa: E501 + """Retrieves report for trial balance # noqa: E501 OAuth2 scope: accounting.reports.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param date date: The date for the Trial Balance report e.g. 2018-03-31 @@ -15527,7 +15527,7 @@ def get_tax_rates( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve Tax Rates # noqa: E501 + """Retrieves tax rates # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str where: Filter by an any element @@ -15608,7 +15608,7 @@ def get_tracking_categories( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve tracking categories and options # noqa: E501 + """Retrieves tracking categories and options # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str where: Filter by an any element @@ -15687,7 +15687,7 @@ def get_tracking_category( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve tracking categories and options for specified category # noqa: E501 + """Retrieves specific tracking categories and options using a unique tracking category Id # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str tracking_category_id: Unique identifier for a TrackingCategory (required) @@ -15763,7 +15763,7 @@ def get_user( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified user # noqa: E501 + """Retrieves a specific user # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str user_id: Unique identifier for a User (required) @@ -15840,7 +15840,7 @@ def get_users( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve users # noqa: E501 + """Retrieves users # noqa: E501 OAuth2 scope: accounting.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param datetime if_modified_since: Only records created or modified since this timestamp will be returned @@ -15919,7 +15919,7 @@ def post_setup( _preload_content=True, _request_timeout=None, ): - """Allows you to set the chart of accounts, the conversion date and conversion balances # noqa: E501 + """Sets the chart of accounts, the conversion date and conversion balances # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Setup setup: Object including an accounts array, a conversion balances array and a conversion date object in body of request (required) @@ -15998,7 +15998,7 @@ def update_account( _preload_content=True, _request_timeout=None, ): - """Allows you to update a chart of accounts # noqa: E501 + """Updates a chart of accounts # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str account_id: Unique identifier for retrieving single object (required) @@ -16088,7 +16088,7 @@ def update_account_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to update Attachment on Account by Filename # noqa: E501 + """Updates attachment on a specific account by filename # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str account_id: Unique identifier for Account object (required) @@ -16188,7 +16188,7 @@ def update_bank_transaction( _preload_content=True, _request_timeout=None, ): - """Allows you to update a single spend or receive money transaction # noqa: E501 + """Updates a single spent or received money transaction # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transaction_id: Xero generated unique identifier for a bank transaction (required) @@ -16282,7 +16282,7 @@ def update_bank_transaction_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to update an Attachment on BankTransaction by Filename # noqa: E501 + """Updates a specific attachment from a specific bank transaction by filename # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transaction_id: Xero generated unique identifier for a bank transaction (required) @@ -16485,7 +16485,7 @@ def update_contact( _preload_content=True, _request_timeout=None, ): - """Allows you to update one contact in a Xero organisation # noqa: E501 + """Updates a specific contact in a Xero organisation # noqa: E501 OAuth2 scope: accounting.contacts :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_id: Unique identifier for a Contact (required) @@ -16674,7 +16674,7 @@ def update_contact_group( _preload_content=True, _request_timeout=None, ): - """Allows you to update a Contact Group # noqa: E501 + """Updates a specific contact group # noqa: E501 OAuth2 scope: accounting.contacts :param str xero_tenant_id: Xero identifier for Tenant (required) :param str contact_group_id: Unique identifier for a Contact Group (required) @@ -16764,7 +16764,7 @@ def update_credit_note( _preload_content=True, _request_timeout=None, ): - """Allows you to update a specific credit note # noqa: E501 + """Updates a specific credit note # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str credit_note_id: Unique identifier for a Credit Note (required) @@ -16858,7 +16858,7 @@ def update_credit_note_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to update Attachments on CreditNote by file name # noqa: E501 + """Updates attachments on a specific credit note by file name # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str credit_note_id: Unique identifier for a Credit Note (required) @@ -16959,7 +16959,7 @@ def update_expense_claim( _preload_content=True, _request_timeout=None, ): - """Allows you to update specified expense claims # noqa: E501 + """Updates a specific expense claims # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str expense_claim_id: Unique identifier for a ExpenseClaim (required) @@ -17049,7 +17049,7 @@ def update_invoice( _preload_content=True, _request_timeout=None, ): - """Allows you to update a specified sales invoices or purchase bills # noqa: E501 + """Updates a specific sales invoices or purchase bills # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) @@ -17143,7 +17143,7 @@ def update_invoice_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to update Attachment on invoices or purchase bills by it's filename # noqa: E501 + """Updates an attachment from a specific invoices or purchase bill by filename # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) @@ -17243,7 +17243,7 @@ def update_item( _preload_content=True, _request_timeout=None, ): - """Allows you to update a specified item # noqa: E501 + """Updates a specific item # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str item_id: Unique identifier for an Item (required) @@ -17334,7 +17334,7 @@ def update_linked_transaction( _preload_content=True, _request_timeout=None, ): - """Allows you to update a specified linked transactions (billable expenses) # noqa: E501 + """Updates a specific linked transactions (billable expenses) # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str linked_transaction_id: Unique identifier for a LinkedTransaction (required) @@ -17423,7 +17423,7 @@ def update_manual_journal( _preload_content=True, _request_timeout=None, ): - """Allows you to update a specified manual journal # noqa: E501 + """Updates a specific manual journal # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str manual_journal_id: Unique identifier for a ManualJournal (required) @@ -17513,7 +17513,7 @@ def update_manual_journal_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to update a specified Attachment on ManualJournal by file name # noqa: E501 + """Updates a specific attachment from a specific manual journal by file name # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str manual_journal_id: Unique identifier for a ManualJournal (required) @@ -17615,7 +17615,7 @@ def update_or_create_bank_transactions( _preload_content=True, _request_timeout=None, ): - """Allows you to update or create one or more spend or receive money transaction # noqa: E501 + """Updates or creates one or more spent or received money transaction # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param BankTransactions bank_transactions: (required) @@ -17705,7 +17705,7 @@ def update_or_create_contacts( _preload_content=True, _request_timeout=None, ): - """Allows you to update OR create one or more contacts in a Xero organisation # noqa: E501 + """Updates or creates one or more contacts in a Xero organisation # noqa: E501 OAuth2 scope: accounting.contacts :param str xero_tenant_id: Xero identifier for Tenant (required) :param Contacts contacts: (required) @@ -17790,7 +17790,7 @@ def update_or_create_credit_notes( _preload_content=True, _request_timeout=None, ): - """Allows you to update OR create one or more credit notes # noqa: E501 + """Updates or creates one or more credit notes # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param CreditNotes credit_notes: an array of Credit Notes with a single CreditNote object. (required) @@ -17880,7 +17880,7 @@ def update_or_create_employees( _preload_content=True, _request_timeout=None, ): - """Allows you to create a single new employees used in Xero payrun # noqa: E501 + """Creates a single new employees used in Xero payrun # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Employees employees: Employees with array of Employee object in body of request (required) @@ -17965,7 +17965,7 @@ def update_or_create_invoices( _preload_content=True, _request_timeout=None, ): - """Allows you to update OR create one or more sales invoices or purchase bills # noqa: E501 + """Updates or creates one or more sales invoices or purchase bills # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param Invoices invoices: (required) @@ -18054,7 +18054,7 @@ def update_or_create_items( _preload_content=True, _request_timeout=None, ): - """Allows you to update or create one or more items # noqa: E501 + """Updates or creates one or more items # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Items items: (required) @@ -18142,7 +18142,7 @@ def update_or_create_manual_journals( _preload_content=True, _request_timeout=None, ): - """Allows you to create a single manual journal # noqa: E501 + """Updates or creates a single manual journal # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param ManualJournals manual_journals: ManualJournals array with ManualJournal object in body of request (required) @@ -18228,7 +18228,7 @@ def update_or_create_purchase_orders( _preload_content=True, _request_timeout=None, ): - """Allows you to update or create one or more purchase orders # noqa: E501 + """Updates or creates one or more purchase orders # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param PurchaseOrders purchase_orders: (required) @@ -18314,7 +18314,7 @@ def update_or_create_quotes( _preload_content=True, _request_timeout=None, ): - """Allows you to update OR create one or more quotes # noqa: E501 + """Updates or creates one or more quotes # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param Quotes quotes: (required) @@ -18398,7 +18398,7 @@ def update_purchase_order( _preload_content=True, _request_timeout=None, ): - """Allows you to update a specified purchase order # noqa: E501 + """Updates a specific purchase order # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str purchase_order_id: Unique identifier for a PurchaseOrder (required) @@ -18488,7 +18488,7 @@ def update_purchase_order_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to update Attachment on Purchase Order by Filename # noqa: E501 + """Updates a specific attachment for a specific purchase order by filename # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str purchase_order_id: Unique identifier for Purchase Order object (required) @@ -18589,7 +18589,7 @@ def update_quote( _preload_content=True, _request_timeout=None, ): - """Allows you to update a specified quote # noqa: E501 + """Updates a specific quote # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str quote_id: Unique identifier for an Quote (required) @@ -18678,7 +18678,7 @@ def update_quote_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to update Attachment on Quote by Filename # noqa: E501 + """Updates a specific attachment from a specific quote by filename # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str quote_id: Unique identifier for Quote object (required) @@ -18778,7 +18778,7 @@ def update_receipt( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a specified draft expense claim receipts # noqa: E501 + """Updates a specific draft expense claim receipts # noqa: E501 OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param str receipt_id: Unique identifier for a Receipt (required) @@ -18872,7 +18872,7 @@ def update_receipt_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to update Attachment on expense claim receipts by file name # noqa: E501 + """Updates a specific attachment on a specific expense claim receipts by file name # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str receipt_id: Unique identifier for a Receipt (required) @@ -18972,7 +18972,7 @@ def update_repeating_invoice_attachment_by_file_name( _preload_content=True, _request_timeout=None, ): - """Allows you to update specified attachment on repeating invoices by file name # noqa: E501 + """Updates a specific attachment from a specific repeating invoices by file name # noqa: E501 OAuth2 scope: accounting.attachments :param str xero_tenant_id: Xero identifier for Tenant (required) :param str repeating_invoice_id: Unique identifier for a Repeating Invoice (required) @@ -19072,7 +19072,7 @@ def update_tax_rate( _preload_content=True, _request_timeout=None, ): - """Allows you to update Tax Rates # noqa: E501 + """Updates tax rates # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param TaxRates tax_rates: (required) @@ -19152,7 +19152,7 @@ def update_tracking_category( _preload_content=True, _request_timeout=None, ): - """Allows you to update tracking categories # noqa: E501 + """Updates a specific tracking category # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str tracking_category_id: Unique identifier for a TrackingCategory (required) @@ -19242,7 +19242,7 @@ def update_tracking_options( _preload_content=True, _request_timeout=None, ): - """Allows you to update options for a specified tracking category # noqa: E501 + """Updates a specific option for a specific tracking category # noqa: E501 OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str tracking_category_id: Unique identifier for a TrackingCategory (required) diff --git a/xero_python/accounting/docs/AccountingApi.md b/xero_python/accounting/docs/AccountingApi.md index a90e9b0b..3b912e71 100644 --- a/xero_python/accounting/docs/AccountingApi.md +++ b/xero_python/accounting/docs/AccountingApi.md @@ -4,236 +4,236 @@ All URIs are relative to *https://api.xero.com/api.xro/2.0* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_account**](AccountingApi.md#create_account) | **PUT** /Accounts | Allows you to create a new chart of accounts -[**create_account_attachment_by_file_name**](AccountingApi.md#create_account_attachment_by_file_name) | **PUT** /Accounts/{AccountID}/Attachments/{FileName} | Allows you to create Attachment on Account -[**create_bank_transaction_attachment_by_file_name**](AccountingApi.md#create_bank_transaction_attachment_by_file_name) | **PUT** /BankTransactions/{BankTransactionID}/Attachments/{FileName} | Allows you to create an Attachment on BankTransaction by Filename -[**create_bank_transaction_history_record**](AccountingApi.md#create_bank_transaction_history_record) | **PUT** /BankTransactions/{BankTransactionID}/History | Allows you to create history record for a bank transactions -[**create_bank_transactions**](AccountingApi.md#create_bank_transactions) | **PUT** /BankTransactions | Allows you to create one or more spend or receive money transaction -[**create_bank_transfer**](AccountingApi.md#create_bank_transfer) | **PUT** /BankTransfers | Allows you to create a bank transfers +[**create_account**](AccountingApi.md#create_account) | **PUT** /Accounts | Creates a new chart of accounts +[**create_account_attachment_by_file_name**](AccountingApi.md#create_account_attachment_by_file_name) | **PUT** /Accounts/{AccountID}/Attachments/{FileName} | Creates an attachment on a specific account +[**create_bank_transaction_attachment_by_file_name**](AccountingApi.md#create_bank_transaction_attachment_by_file_name) | **PUT** /BankTransactions/{BankTransactionID}/Attachments/{FileName} | Creates an attachment for a specific bank transaction by filename +[**create_bank_transaction_history_record**](AccountingApi.md#create_bank_transaction_history_record) | **PUT** /BankTransactions/{BankTransactionID}/History | Creates a history record for a specific bank transactions +[**create_bank_transactions**](AccountingApi.md#create_bank_transactions) | **PUT** /BankTransactions | Creates one or more spent or received money transaction +[**create_bank_transfer**](AccountingApi.md#create_bank_transfer) | **PUT** /BankTransfers | Creates a bank transfer [**create_bank_transfer_attachment_by_file_name**](AccountingApi.md#create_bank_transfer_attachment_by_file_name) | **PUT** /BankTransfers/{BankTransferID}/Attachments/{FileName} | -[**create_bank_transfer_history_record**](AccountingApi.md#create_bank_transfer_history_record) | **PUT** /BankTransfers/{BankTransferID}/History | Allows you to create history record for a bank transfers -[**create_batch_payment**](AccountingApi.md#create_batch_payment) | **PUT** /BatchPayments | Create one or many BatchPayments for invoices -[**create_batch_payment_history_record**](AccountingApi.md#create_batch_payment_history_record) | **PUT** /BatchPayments/{BatchPaymentID}/History | Allows you to create a history record for a Batch Payment -[**create_branding_theme_payment_services**](AccountingApi.md#create_branding_theme_payment_services) | **POST** /BrandingThemes/{BrandingThemeID}/PaymentServices | Allow for the creation of new custom payment service for specified Branding Theme +[**create_bank_transfer_history_record**](AccountingApi.md#create_bank_transfer_history_record) | **PUT** /BankTransfers/{BankTransferID}/History | Creates a history record for a specific bank transfer +[**create_batch_payment**](AccountingApi.md#create_batch_payment) | **PUT** /BatchPayments | Creates one or many batch payments for invoices +[**create_batch_payment_history_record**](AccountingApi.md#create_batch_payment_history_record) | **PUT** /BatchPayments/{BatchPaymentID}/History | Creates a history record for a specific batch payment +[**create_branding_theme_payment_services**](AccountingApi.md#create_branding_theme_payment_services) | **POST** /BrandingThemes/{BrandingThemeID}/PaymentServices | Creates a new custom payment service for a specific branding theme [**create_contact_attachment_by_file_name**](AccountingApi.md#create_contact_attachment_by_file_name) | **PUT** /Contacts/{ContactID}/Attachments/{FileName} | -[**create_contact_group**](AccountingApi.md#create_contact_group) | **PUT** /ContactGroups | Allows you to create a contact group -[**create_contact_group_contacts**](AccountingApi.md#create_contact_group_contacts) | **PUT** /ContactGroups/{ContactGroupID}/Contacts | Allows you to add Contacts to a Contact Group -[**create_contact_history**](AccountingApi.md#create_contact_history) | **PUT** /Contacts/{ContactID}/History | Allows you to retrieve a history records of an Contact -[**create_contacts**](AccountingApi.md#create_contacts) | **PUT** /Contacts | Allows you to create a multiple contacts (bulk) in a Xero organisation -[**create_credit_note_allocation**](AccountingApi.md#create_credit_note_allocation) | **PUT** /CreditNotes/{CreditNoteID}/Allocations | Allows you to create Allocation on CreditNote -[**create_credit_note_attachment_by_file_name**](AccountingApi.md#create_credit_note_attachment_by_file_name) | **PUT** /CreditNotes/{CreditNoteID}/Attachments/{FileName} | Allows you to create Attachments on CreditNote by file name -[**create_credit_note_history**](AccountingApi.md#create_credit_note_history) | **PUT** /CreditNotes/{CreditNoteID}/History | Allows you to retrieve a history records of an CreditNote -[**create_credit_notes**](AccountingApi.md#create_credit_notes) | **PUT** /CreditNotes | Allows you to create a credit note -[**create_currency**](AccountingApi.md#create_currency) | **PUT** /Currencies | Allows you to create a new currency for an org -[**create_employees**](AccountingApi.md#create_employees) | **PUT** /Employees | Allows you to create new employees used in Xero payrun -[**create_expense_claim_history**](AccountingApi.md#create_expense_claim_history) | **PUT** /ExpenseClaims/{ExpenseClaimID}/History | Allows you to create a history records of an ExpenseClaim -[**create_expense_claims**](AccountingApi.md#create_expense_claims) | **PUT** /ExpenseClaims | Allows you to retrieve expense claims -[**create_invoice_attachment_by_file_name**](AccountingApi.md#create_invoice_attachment_by_file_name) | **PUT** /Invoices/{InvoiceID}/Attachments/{FileName} | Allows you to create an Attachment on invoices or purchase bills by it's filename -[**create_invoice_history**](AccountingApi.md#create_invoice_history) | **PUT** /Invoices/{InvoiceID}/History | Allows you to retrieve a history records of an invoice -[**create_invoices**](AccountingApi.md#create_invoices) | **PUT** /Invoices | Allows you to create one or more sales invoices or purchase bills -[**create_item_history**](AccountingApi.md#create_item_history) | **PUT** /Items/{ItemID}/History | Allows you to create a history record for items -[**create_items**](AccountingApi.md#create_items) | **PUT** /Items | Allows you to create one or more items -[**create_linked_transaction**](AccountingApi.md#create_linked_transaction) | **PUT** /LinkedTransactions | Allows you to create linked transactions (billable expenses) -[**create_manual_journal_attachment_by_file_name**](AccountingApi.md#create_manual_journal_attachment_by_file_name) | **PUT** /ManualJournals/{ManualJournalID}/Attachments/{FileName} | Allows you to create a specified Attachment on ManualJournal by file name -[**create_manual_journal_history_record**](AccountingApi.md#create_manual_journal_history_record) | **PUT** /ManualJournals/{ManualJournalID}/History | Allows you to create history record for a manual journal -[**create_manual_journals**](AccountingApi.md#create_manual_journals) | **PUT** /ManualJournals | Allows you to create one or more manual journals -[**create_overpayment_allocations**](AccountingApi.md#create_overpayment_allocations) | **PUT** /Overpayments/{OverpaymentID}/Allocations | Allows you to create a single allocation for an overpayment -[**create_overpayment_history**](AccountingApi.md#create_overpayment_history) | **PUT** /Overpayments/{OverpaymentID}/History | Allows you to create history records of an Overpayment -[**create_payment**](AccountingApi.md#create_payment) | **POST** /Payments | Allows you to create a single payment for invoices or credit notes -[**create_payment_history**](AccountingApi.md#create_payment_history) | **PUT** /Payments/{PaymentID}/History | Allows you to create a history record for a payment -[**create_payment_service**](AccountingApi.md#create_payment_service) | **PUT** /PaymentServices | Allows you to create payment services -[**create_payments**](AccountingApi.md#create_payments) | **PUT** /Payments | Allows you to create multiple payments for invoices or credit notes +[**create_contact_group**](AccountingApi.md#create_contact_group) | **PUT** /ContactGroups | Creates a contact group +[**create_contact_group_contacts**](AccountingApi.md#create_contact_group_contacts) | **PUT** /ContactGroups/{ContactGroupID}/Contacts | Creates contacts to a specific contact group +[**create_contact_history**](AccountingApi.md#create_contact_history) | **PUT** /Contacts/{ContactID}/History | Creates a new history record for a specific contact +[**create_contacts**](AccountingApi.md#create_contacts) | **PUT** /Contacts | Creates multiple contacts (bulk) in a Xero organisation +[**create_credit_note_allocation**](AccountingApi.md#create_credit_note_allocation) | **PUT** /CreditNotes/{CreditNoteID}/Allocations | Creates allocation for a specific credit note +[**create_credit_note_attachment_by_file_name**](AccountingApi.md#create_credit_note_attachment_by_file_name) | **PUT** /CreditNotes/{CreditNoteID}/Attachments/{FileName} | Creates an attachment for a specific credit note +[**create_credit_note_history**](AccountingApi.md#create_credit_note_history) | **PUT** /CreditNotes/{CreditNoteID}/History | Retrieves history records of a specific credit note +[**create_credit_notes**](AccountingApi.md#create_credit_notes) | **PUT** /CreditNotes | Creates a new credit note +[**create_currency**](AccountingApi.md#create_currency) | **PUT** /Currencies | Create a new currency for a Xero organisation +[**create_employees**](AccountingApi.md#create_employees) | **PUT** /Employees | Creates new employees used in Xero payrun +[**create_expense_claim_history**](AccountingApi.md#create_expense_claim_history) | **PUT** /ExpenseClaims/{ExpenseClaimID}/History | Creates a history record for a specific expense claim +[**create_expense_claims**](AccountingApi.md#create_expense_claims) | **PUT** /ExpenseClaims | Creates expense claims +[**create_invoice_attachment_by_file_name**](AccountingApi.md#create_invoice_attachment_by_file_name) | **PUT** /Invoices/{InvoiceID}/Attachments/{FileName} | Creates an attachment for a specific invoice or purchase bill by filename +[**create_invoice_history**](AccountingApi.md#create_invoice_history) | **PUT** /Invoices/{InvoiceID}/History | Creates a history record for a specific invoice +[**create_invoices**](AccountingApi.md#create_invoices) | **PUT** /Invoices | Creates one or more sales invoices or purchase bills +[**create_item_history**](AccountingApi.md#create_item_history) | **PUT** /Items/{ItemID}/History | Creates a history record for a specific item +[**create_items**](AccountingApi.md#create_items) | **PUT** /Items | Creates one or more items +[**create_linked_transaction**](AccountingApi.md#create_linked_transaction) | **PUT** /LinkedTransactions | Creates linked transactions (billable expenses) +[**create_manual_journal_attachment_by_file_name**](AccountingApi.md#create_manual_journal_attachment_by_file_name) | **PUT** /ManualJournals/{ManualJournalID}/Attachments/{FileName} | Creates a specific attachment for a specific manual journal by file name +[**create_manual_journal_history_record**](AccountingApi.md#create_manual_journal_history_record) | **PUT** /ManualJournals/{ManualJournalID}/History | Creates a history record for a specific manual journal +[**create_manual_journals**](AccountingApi.md#create_manual_journals) | **PUT** /ManualJournals | Creates one or more manual journals +[**create_overpayment_allocations**](AccountingApi.md#create_overpayment_allocations) | **PUT** /Overpayments/{OverpaymentID}/Allocations | Creates a single allocation for a specific overpayment +[**create_overpayment_history**](AccountingApi.md#create_overpayment_history) | **PUT** /Overpayments/{OverpaymentID}/History | Creates a history record for a specific overpayment +[**create_payment**](AccountingApi.md#create_payment) | **POST** /Payments | Creates a single payment for invoice or credit notes +[**create_payment_history**](AccountingApi.md#create_payment_history) | **PUT** /Payments/{PaymentID}/History | Creates a history record for a specific payment +[**create_payment_service**](AccountingApi.md#create_payment_service) | **PUT** /PaymentServices | Creates a payment service +[**create_payments**](AccountingApi.md#create_payments) | **PUT** /Payments | Creates multiple payments for invoices or credit notes [**create_prepayment_allocations**](AccountingApi.md#create_prepayment_allocations) | **PUT** /Prepayments/{PrepaymentID}/Allocations | Allows you to create an Allocation for prepayments -[**create_prepayment_history**](AccountingApi.md#create_prepayment_history) | **PUT** /Prepayments/{PrepaymentID}/History | Allows you to create a history record for an Prepayment -[**create_purchase_order_attachment_by_file_name**](AccountingApi.md#create_purchase_order_attachment_by_file_name) | **PUT** /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName} | Allows you to create Attachment on Purchase Order -[**create_purchase_order_history**](AccountingApi.md#create_purchase_order_history) | **PUT** /PurchaseOrders/{PurchaseOrderID}/History | Allows you to create HistoryRecord for purchase orders -[**create_purchase_orders**](AccountingApi.md#create_purchase_orders) | **PUT** /PurchaseOrders | Allows you to create one or more purchase orders -[**create_quote_attachment_by_file_name**](AccountingApi.md#create_quote_attachment_by_file_name) | **PUT** /Quotes/{QuoteID}/Attachments/{FileName} | Allows you to create Attachment on Quote -[**create_quote_history**](AccountingApi.md#create_quote_history) | **PUT** /Quotes/{QuoteID}/History | Allows you to retrieve a history records of an quote -[**create_quotes**](AccountingApi.md#create_quotes) | **PUT** /Quotes | Allows you to create one or more quotes -[**create_receipt**](AccountingApi.md#create_receipt) | **PUT** /Receipts | Allows you to create draft expense claim receipts for any user -[**create_receipt_attachment_by_file_name**](AccountingApi.md#create_receipt_attachment_by_file_name) | **PUT** /Receipts/{ReceiptID}/Attachments/{FileName} | Allows you to create Attachment on expense claim receipts by file name -[**create_receipt_history**](AccountingApi.md#create_receipt_history) | **PUT** /Receipts/{ReceiptID}/History | Allows you to retrieve a history records of an Receipt -[**create_repeating_invoice_attachment_by_file_name**](AccountingApi.md#create_repeating_invoice_attachment_by_file_name) | **PUT** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} | Allows you to create attachment on repeating invoices by file name -[**create_repeating_invoice_history**](AccountingApi.md#create_repeating_invoice_history) | **PUT** /RepeatingInvoices/{RepeatingInvoiceID}/History | Allows you to create history for a repeating invoice -[**create_tax_rates**](AccountingApi.md#create_tax_rates) | **PUT** /TaxRates | Allows you to create one or more Tax Rates -[**create_tracking_category**](AccountingApi.md#create_tracking_category) | **PUT** /TrackingCategories | Allows you to create tracking categories -[**create_tracking_options**](AccountingApi.md#create_tracking_options) | **PUT** /TrackingCategories/{TrackingCategoryID}/Options | Allows you to create options for a specified tracking category -[**delete_account**](AccountingApi.md#delete_account) | **DELETE** /Accounts/{AccountID} | Allows you to delete a chart of accounts -[**delete_contact_group_contact**](AccountingApi.md#delete_contact_group_contact) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts/{ContactID} | Allows you to delete a specific Contact from a Contact Group -[**delete_contact_group_contacts**](AccountingApi.md#delete_contact_group_contacts) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts | Allows you to delete all Contacts from a Contact Group -[**delete_item**](AccountingApi.md#delete_item) | **DELETE** /Items/{ItemID} | Allows you to delete a specified item -[**delete_linked_transaction**](AccountingApi.md#delete_linked_transaction) | **DELETE** /LinkedTransactions/{LinkedTransactionID} | Allows you to delete a specified linked transactions (billable expenses) -[**delete_payment**](AccountingApi.md#delete_payment) | **POST** /Payments/{PaymentID} | Allows you to update a specified payment for invoices and credit notes -[**delete_tracking_category**](AccountingApi.md#delete_tracking_category) | **DELETE** /TrackingCategories/{TrackingCategoryID} | Allows you to delete tracking categories -[**delete_tracking_options**](AccountingApi.md#delete_tracking_options) | **DELETE** /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID} | Allows you to delete a specified option for a specified tracking category -[**email_invoice**](AccountingApi.md#email_invoice) | **POST** /Invoices/{InvoiceID}/Email | Allows you to email a copy of invoice to related Contact -[**get_account**](AccountingApi.md#get_account) | **GET** /Accounts/{AccountID} | Allows you to retrieve a single chart of accounts -[**get_account_attachment_by_file_name**](AccountingApi.md#get_account_attachment_by_file_name) | **GET** /Accounts/{AccountID}/Attachments/{FileName} | Allows you to retrieve Attachment on Account by Filename -[**get_account_attachment_by_id**](AccountingApi.md#get_account_attachment_by_id) | **GET** /Accounts/{AccountID}/Attachments/{AttachmentID} | Allows you to retrieve specific Attachment on Account -[**get_account_attachments**](AccountingApi.md#get_account_attachments) | **GET** /Accounts/{AccountID}/Attachments | Allows you to retrieve Attachments for accounts -[**get_accounts**](AccountingApi.md#get_accounts) | **GET** /Accounts | Allows you to retrieve the full chart of accounts -[**get_bank_transaction**](AccountingApi.md#get_bank_transaction) | **GET** /BankTransactions/{BankTransactionID} | Allows you to retrieve a single spend or receive money transaction -[**get_bank_transaction_attachment_by_file_name**](AccountingApi.md#get_bank_transaction_attachment_by_file_name) | **GET** /BankTransactions/{BankTransactionID}/Attachments/{FileName} | Allows you to retrieve Attachments on BankTransaction by Filename -[**get_bank_transaction_attachment_by_id**](AccountingApi.md#get_bank_transaction_attachment_by_id) | **GET** /BankTransactions/{BankTransactionID}/Attachments/{AttachmentID} | Allows you to retrieve Attachments on a specific BankTransaction -[**get_bank_transaction_attachments**](AccountingApi.md#get_bank_transaction_attachments) | **GET** /BankTransactions/{BankTransactionID}/Attachments | Allows you to retrieve any attachments to bank transactions -[**get_bank_transactions**](AccountingApi.md#get_bank_transactions) | **GET** /BankTransactions | Allows you to retrieve any spend or receive money transactions -[**get_bank_transactions_history**](AccountingApi.md#get_bank_transactions_history) | **GET** /BankTransactions/{BankTransactionID}/History | Allows you to retrieve history from a bank transactions -[**get_bank_transfer**](AccountingApi.md#get_bank_transfer) | **GET** /BankTransfers/{BankTransferID} | Allows you to retrieve any bank transfers -[**get_bank_transfer_attachment_by_file_name**](AccountingApi.md#get_bank_transfer_attachment_by_file_name) | **GET** /BankTransfers/{BankTransferID}/Attachments/{FileName} | Allows you to retrieve Attachments on BankTransfer by file name -[**get_bank_transfer_attachment_by_id**](AccountingApi.md#get_bank_transfer_attachment_by_id) | **GET** /BankTransfers/{BankTransferID}/Attachments/{AttachmentID} | Allows you to retrieve Attachments on BankTransfer -[**get_bank_transfer_attachments**](AccountingApi.md#get_bank_transfer_attachments) | **GET** /BankTransfers/{BankTransferID}/Attachments | Allows you to retrieve Attachments from bank transfers -[**get_bank_transfer_history**](AccountingApi.md#get_bank_transfer_history) | **GET** /BankTransfers/{BankTransferID}/History | Allows you to retrieve history from a bank transfers -[**get_bank_transfers**](AccountingApi.md#get_bank_transfers) | **GET** /BankTransfers | Allows you to retrieve all bank transfers -[**get_batch_payment_history**](AccountingApi.md#get_batch_payment_history) | **GET** /BatchPayments/{BatchPaymentID}/History | Allows you to retrieve history from a Batch Payment -[**get_batch_payments**](AccountingApi.md#get_batch_payments) | **GET** /BatchPayments | Retrieve either one or many BatchPayments for invoices -[**get_branding_theme**](AccountingApi.md#get_branding_theme) | **GET** /BrandingThemes/{BrandingThemeID} | Allows you to retrieve a specific BrandingThemes -[**get_branding_theme_payment_services**](AccountingApi.md#get_branding_theme_payment_services) | **GET** /BrandingThemes/{BrandingThemeID}/PaymentServices | Allows you to retrieve the Payment services for a Branding Theme -[**get_branding_themes**](AccountingApi.md#get_branding_themes) | **GET** /BrandingThemes | Allows you to retrieve all the BrandingThemes -[**get_contact**](AccountingApi.md#get_contact) | **GET** /Contacts/{ContactID} | Allows you to retrieve a single contacts in a Xero organisation -[**get_contact_attachment_by_file_name**](AccountingApi.md#get_contact_attachment_by_file_name) | **GET** /Contacts/{ContactID}/Attachments/{FileName} | Allows you to retrieve Attachments on Contacts by file name -[**get_contact_attachment_by_id**](AccountingApi.md#get_contact_attachment_by_id) | **GET** /Contacts/{ContactID}/Attachments/{AttachmentID} | Allows you to retrieve Attachments on Contacts -[**get_contact_attachments**](AccountingApi.md#get_contact_attachments) | **GET** /Contacts/{ContactID}/Attachments | Allows you to retrieve, add and update contacts in a Xero organisation -[**get_contact_by_contact_number**](AccountingApi.md#get_contact_by_contact_number) | **GET** /Contacts/{ContactNumber} | Allows you to retrieve a single contact by Contact Number in a Xero organisation -[**get_contact_cis_settings**](AccountingApi.md#get_contact_cis_settings) | **GET** /Contacts/{ContactID}/CISSettings | Allows you to retrieve CISSettings for a contact in a Xero organisation -[**get_contact_group**](AccountingApi.md#get_contact_group) | **GET** /ContactGroups/{ContactGroupID} | Allows you to retrieve a unique Contact Group by ID -[**get_contact_groups**](AccountingApi.md#get_contact_groups) | **GET** /ContactGroups | Allows you to retrieve the ContactID and Name of all the contacts in a contact group -[**get_contact_history**](AccountingApi.md#get_contact_history) | **GET** /Contacts/{ContactID}/History | Allows you to retrieve a history records of an Contact -[**get_contacts**](AccountingApi.md#get_contacts) | **GET** /Contacts | Allows you to retrieve all contacts in a Xero organisation -[**get_credit_note**](AccountingApi.md#get_credit_note) | **GET** /CreditNotes/{CreditNoteID} | Allows you to retrieve a specific credit note -[**get_credit_note_as_pdf**](AccountingApi.md#get_credit_note_as_pdf) | **GET** /CreditNotes/{CreditNoteID}/pdf | Allows you to retrieve Credit Note as PDF files -[**get_credit_note_attachment_by_file_name**](AccountingApi.md#get_credit_note_attachment_by_file_name) | **GET** /CreditNotes/{CreditNoteID}/Attachments/{FileName} | Allows you to retrieve Attachments on CreditNote by file name -[**get_credit_note_attachment_by_id**](AccountingApi.md#get_credit_note_attachment_by_id) | **GET** /CreditNotes/{CreditNoteID}/Attachments/{AttachmentID} | Allows you to retrieve Attachments on CreditNote -[**get_credit_note_attachments**](AccountingApi.md#get_credit_note_attachments) | **GET** /CreditNotes/{CreditNoteID}/Attachments | Allows you to retrieve Attachments for credit notes -[**get_credit_note_history**](AccountingApi.md#get_credit_note_history) | **GET** /CreditNotes/{CreditNoteID}/History | Allows you to retrieve a history records of an CreditNote -[**get_credit_notes**](AccountingApi.md#get_credit_notes) | **GET** /CreditNotes | Allows you to retrieve any credit notes -[**get_currencies**](AccountingApi.md#get_currencies) | **GET** /Currencies | Allows you to retrieve currencies for your organisation -[**get_employee**](AccountingApi.md#get_employee) | **GET** /Employees/{EmployeeID} | Allows you to retrieve a specific employee used in Xero payrun -[**get_employees**](AccountingApi.md#get_employees) | **GET** /Employees | Allows you to retrieve employees used in Xero payrun -[**get_expense_claim**](AccountingApi.md#get_expense_claim) | **GET** /ExpenseClaims/{ExpenseClaimID} | Allows you to retrieve a specified expense claim -[**get_expense_claim_history**](AccountingApi.md#get_expense_claim_history) | **GET** /ExpenseClaims/{ExpenseClaimID}/History | Allows you to retrieve a history records of an ExpenseClaim -[**get_expense_claims**](AccountingApi.md#get_expense_claims) | **GET** /ExpenseClaims | Allows you to retrieve expense claims -[**get_invoice**](AccountingApi.md#get_invoice) | **GET** /Invoices/{InvoiceID} | Allows you to retrieve a specified sales invoice or purchase bill -[**get_invoice_as_pdf**](AccountingApi.md#get_invoice_as_pdf) | **GET** /Invoices/{InvoiceID}/pdf | Allows you to retrieve invoices or purchase bills as PDF files -[**get_invoice_attachment_by_file_name**](AccountingApi.md#get_invoice_attachment_by_file_name) | **GET** /Invoices/{InvoiceID}/Attachments/{FileName} | Allows you to retrieve Attachment on invoices or purchase bills by it's filename -[**get_invoice_attachment_by_id**](AccountingApi.md#get_invoice_attachment_by_id) | **GET** /Invoices/{InvoiceID}/Attachments/{AttachmentID} | Allows you to retrieve a specified Attachment on invoices or purchase bills by it's ID -[**get_invoice_attachments**](AccountingApi.md#get_invoice_attachments) | **GET** /Invoices/{InvoiceID}/Attachments | Allows you to retrieve Attachments on invoices or purchase bills -[**get_invoice_history**](AccountingApi.md#get_invoice_history) | **GET** /Invoices/{InvoiceID}/History | Allows you to retrieve a history records of an invoice -[**get_invoice_reminders**](AccountingApi.md#get_invoice_reminders) | **GET** /InvoiceReminders/Settings | Allows you to retrieve invoice reminder settings -[**get_invoices**](AccountingApi.md#get_invoices) | **GET** /Invoices | Allows you to retrieve any sales invoices or purchase bills -[**get_item**](AccountingApi.md#get_item) | **GET** /Items/{ItemID} | Allows you to retrieve a specified item -[**get_item_history**](AccountingApi.md#get_item_history) | **GET** /Items/{ItemID}/History | Allows you to retrieve history for items -[**get_items**](AccountingApi.md#get_items) | **GET** /Items | Allows you to retrieve any items -[**get_journal**](AccountingApi.md#get_journal) | **GET** /Journals/{JournalID} | Allows you to retrieve a specified journals. -[**get_journals**](AccountingApi.md#get_journals) | **GET** /Journals | Allows you to retrieve any journals. -[**get_linked_transaction**](AccountingApi.md#get_linked_transaction) | **GET** /LinkedTransactions/{LinkedTransactionID} | Allows you to retrieve a specified linked transactions (billable expenses) -[**get_linked_transactions**](AccountingApi.md#get_linked_transactions) | **GET** /LinkedTransactions | Retrieve linked transactions (billable expenses) -[**get_manual_journal**](AccountingApi.md#get_manual_journal) | **GET** /ManualJournals/{ManualJournalID} | Allows you to retrieve a specified manual journals -[**get_manual_journal_attachment_by_file_name**](AccountingApi.md#get_manual_journal_attachment_by_file_name) | **GET** /ManualJournals/{ManualJournalID}/Attachments/{FileName} | Allows you to retrieve specified Attachment on ManualJournal by file name -[**get_manual_journal_attachment_by_id**](AccountingApi.md#get_manual_journal_attachment_by_id) | **GET** /ManualJournals/{ManualJournalID}/Attachments/{AttachmentID} | Allows you to retrieve specified Attachment on ManualJournals -[**get_manual_journal_attachments**](AccountingApi.md#get_manual_journal_attachments) | **GET** /ManualJournals/{ManualJournalID}/Attachments | Allows you to retrieve Attachment for manual journals -[**get_manual_journals**](AccountingApi.md#get_manual_journals) | **GET** /ManualJournals | Allows you to retrieve any manual journals -[**get_manual_journals_history**](AccountingApi.md#get_manual_journals_history) | **GET** /ManualJournals/{ManualJournalID}/History | Allows you to retrieve history from a manual journal -[**get_online_invoice**](AccountingApi.md#get_online_invoice) | **GET** /Invoices/{InvoiceID}/OnlineInvoice | Allows you to retrieve a URL to an online invoice -[**get_organisation_actions**](AccountingApi.md#get_organisation_actions) | **GET** /Organisation/Actions | Retrieve a list of the key actions your app has permission to perform in the connected organisation. -[**get_organisation_cis_settings**](AccountingApi.md#get_organisation_cis_settings) | **GET** /Organisation/{OrganisationID}/CISSettings | Allows you To verify if an organisation is using contruction industry scheme, you can retrieve the CIS settings for the organistaion. -[**get_organisations**](AccountingApi.md#get_organisations) | **GET** /Organisation | Allows you to retrieve Organisation details -[**get_overpayment**](AccountingApi.md#get_overpayment) | **GET** /Overpayments/{OverpaymentID} | Allows you to retrieve a specified overpayments -[**get_overpayment_history**](AccountingApi.md#get_overpayment_history) | **GET** /Overpayments/{OverpaymentID}/History | Allows you to retrieve a history records of an Overpayment -[**get_overpayments**](AccountingApi.md#get_overpayments) | **GET** /Overpayments | Allows you to retrieve overpayments -[**get_payment**](AccountingApi.md#get_payment) | **GET** /Payments/{PaymentID} | Allows you to retrieve a specified payment for invoices and credit notes -[**get_payment_history**](AccountingApi.md#get_payment_history) | **GET** /Payments/{PaymentID}/History | Allows you to retrieve history records of a payment -[**get_payment_services**](AccountingApi.md#get_payment_services) | **GET** /PaymentServices | Allows you to retrieve payment services -[**get_payments**](AccountingApi.md#get_payments) | **GET** /Payments | Allows you to retrieve payments for invoices and credit notes +[**create_prepayment_history**](AccountingApi.md#create_prepayment_history) | **PUT** /Prepayments/{PrepaymentID}/History | Creates a history record for a specific prepayment +[**create_purchase_order_attachment_by_file_name**](AccountingApi.md#create_purchase_order_attachment_by_file_name) | **PUT** /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName} | Creates attachment for a specific purchase order +[**create_purchase_order_history**](AccountingApi.md#create_purchase_order_history) | **PUT** /PurchaseOrders/{PurchaseOrderID}/History | Creates a history record for a specific purchase orders +[**create_purchase_orders**](AccountingApi.md#create_purchase_orders) | **PUT** /PurchaseOrders | Creates one or more purchase orders +[**create_quote_attachment_by_file_name**](AccountingApi.md#create_quote_attachment_by_file_name) | **PUT** /Quotes/{QuoteID}/Attachments/{FileName} | Creates attachment for a specific quote +[**create_quote_history**](AccountingApi.md#create_quote_history) | **PUT** /Quotes/{QuoteID}/History | Creates a history record for a specific quote +[**create_quotes**](AccountingApi.md#create_quotes) | **PUT** /Quotes | Create one or more quotes +[**create_receipt**](AccountingApi.md#create_receipt) | **PUT** /Receipts | Creates draft expense claim receipts for any user +[**create_receipt_attachment_by_file_name**](AccountingApi.md#create_receipt_attachment_by_file_name) | **PUT** /Receipts/{ReceiptID}/Attachments/{FileName} | Creates an attachment on a specific expense claim receipts by file name +[**create_receipt_history**](AccountingApi.md#create_receipt_history) | **PUT** /Receipts/{ReceiptID}/History | Creates a history record for a specific receipt +[**create_repeating_invoice_attachment_by_file_name**](AccountingApi.md#create_repeating_invoice_attachment_by_file_name) | **PUT** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} | Creates an attachment from a specific repeating invoices by file name +[**create_repeating_invoice_history**](AccountingApi.md#create_repeating_invoice_history) | **PUT** /RepeatingInvoices/{RepeatingInvoiceID}/History | Creates a history record for a specific repeating invoice +[**create_tax_rates**](AccountingApi.md#create_tax_rates) | **PUT** /TaxRates | Creates one or more tax rates +[**create_tracking_category**](AccountingApi.md#create_tracking_category) | **PUT** /TrackingCategories | Create tracking categories +[**create_tracking_options**](AccountingApi.md#create_tracking_options) | **PUT** /TrackingCategories/{TrackingCategoryID}/Options | Creates options for a specific tracking category +[**delete_account**](AccountingApi.md#delete_account) | **DELETE** /Accounts/{AccountID} | Deletes a chart of accounts +[**delete_contact_group_contact**](AccountingApi.md#delete_contact_group_contact) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts/{ContactID} | Deletes a specific contact from a contact group using a unique contact Id +[**delete_contact_group_contacts**](AccountingApi.md#delete_contact_group_contacts) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts | Deletes all contacts from a specific contact group +[**delete_item**](AccountingApi.md#delete_item) | **DELETE** /Items/{ItemID} | Deletes a specific item +[**delete_linked_transaction**](AccountingApi.md#delete_linked_transaction) | **DELETE** /LinkedTransactions/{LinkedTransactionID} | Deletes a specific linked transactions (billable expenses) +[**delete_payment**](AccountingApi.md#delete_payment) | **POST** /Payments/{PaymentID} | Updates a specific payment for invoices and credit notes +[**delete_tracking_category**](AccountingApi.md#delete_tracking_category) | **DELETE** /TrackingCategories/{TrackingCategoryID} | Deletes a specific tracking category +[**delete_tracking_options**](AccountingApi.md#delete_tracking_options) | **DELETE** /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID} | Deletes a specific option for a specific tracking category +[**email_invoice**](AccountingApi.md#email_invoice) | **POST** /Invoices/{InvoiceID}/Email | Sends a copy of a specific invoice to related contact via email +[**get_account**](AccountingApi.md#get_account) | **GET** /Accounts/{AccountID} | Retrieves a single chart of accounts by using a unique account Id +[**get_account_attachment_by_file_name**](AccountingApi.md#get_account_attachment_by_file_name) | **GET** /Accounts/{AccountID}/Attachments/{FileName} | Retrieves an attachment for a specific account by filename +[**get_account_attachment_by_id**](AccountingApi.md#get_account_attachment_by_id) | **GET** /Accounts/{AccountID}/Attachments/{AttachmentID} | Retrieves a specific attachment from a specific account using a unique attachment Id +[**get_account_attachments**](AccountingApi.md#get_account_attachments) | **GET** /Accounts/{AccountID}/Attachments | Retrieves attachments for a specific accounts by using a unique account Id +[**get_accounts**](AccountingApi.md#get_accounts) | **GET** /Accounts | Retrieves the full chart of accounts +[**get_bank_transaction**](AccountingApi.md#get_bank_transaction) | **GET** /BankTransactions/{BankTransactionID} | Retrieves a single spent or received money transaction by using a unique bank transaction Id +[**get_bank_transaction_attachment_by_file_name**](AccountingApi.md#get_bank_transaction_attachment_by_file_name) | **GET** /BankTransactions/{BankTransactionID}/Attachments/{FileName} | Retrieves a specific attachment from a specific bank transaction by filename +[**get_bank_transaction_attachment_by_id**](AccountingApi.md#get_bank_transaction_attachment_by_id) | **GET** /BankTransactions/{BankTransactionID}/Attachments/{AttachmentID} | Retrieves specific attachments from a specific BankTransaction using a unique attachment Id +[**get_bank_transaction_attachments**](AccountingApi.md#get_bank_transaction_attachments) | **GET** /BankTransactions/{BankTransactionID}/Attachments | Retrieves any attachments from a specific bank transactions +[**get_bank_transactions**](AccountingApi.md#get_bank_transactions) | **GET** /BankTransactions | Retrieves any spent or received money transactions +[**get_bank_transactions_history**](AccountingApi.md#get_bank_transactions_history) | **GET** /BankTransactions/{BankTransactionID}/History | Retrieves history from a specific bank transaction using a unique bank transaction Id +[**get_bank_transfer**](AccountingApi.md#get_bank_transfer) | **GET** /BankTransfers/{BankTransferID} | Retrieves specific bank transfers by using a unique bank transfer Id +[**get_bank_transfer_attachment_by_file_name**](AccountingApi.md#get_bank_transfer_attachment_by_file_name) | **GET** /BankTransfers/{BankTransferID}/Attachments/{FileName} | Retrieves a specific attachment on a specific bank transfer by file name +[**get_bank_transfer_attachment_by_id**](AccountingApi.md#get_bank_transfer_attachment_by_id) | **GET** /BankTransfers/{BankTransferID}/Attachments/{AttachmentID} | Retrieves a specific attachment from a specific bank transfer using a unique attachment ID +[**get_bank_transfer_attachments**](AccountingApi.md#get_bank_transfer_attachments) | **GET** /BankTransfers/{BankTransferID}/Attachments | Retrieves attachments from a specific bank transfer +[**get_bank_transfer_history**](AccountingApi.md#get_bank_transfer_history) | **GET** /BankTransfers/{BankTransferID}/History | Retrieves history from a specific bank transfer using a unique bank transfer Id +[**get_bank_transfers**](AccountingApi.md#get_bank_transfers) | **GET** /BankTransfers | Retrieves all bank transfers +[**get_batch_payment_history**](AccountingApi.md#get_batch_payment_history) | **GET** /BatchPayments/{BatchPaymentID}/History | Retrieves history from a specific batch payment +[**get_batch_payments**](AccountingApi.md#get_batch_payments) | **GET** /BatchPayments | Retrieves either one or many batch payments for invoices +[**get_branding_theme**](AccountingApi.md#get_branding_theme) | **GET** /BrandingThemes/{BrandingThemeID} | Retrieves a specific branding theme using a unique branding theme Id +[**get_branding_theme_payment_services**](AccountingApi.md#get_branding_theme_payment_services) | **GET** /BrandingThemes/{BrandingThemeID}/PaymentServices | Retrieves the payment services for a specific branding theme +[**get_branding_themes**](AccountingApi.md#get_branding_themes) | **GET** /BrandingThemes | Retrieves all the branding themes +[**get_contact**](AccountingApi.md#get_contact) | **GET** /Contacts/{ContactID} | Retrieves a specific contacts in a Xero organisation using a unique contact Id +[**get_contact_attachment_by_file_name**](AccountingApi.md#get_contact_attachment_by_file_name) | **GET** /Contacts/{ContactID}/Attachments/{FileName} | Retrieves a specific attachment from a specific contact by file name +[**get_contact_attachment_by_id**](AccountingApi.md#get_contact_attachment_by_id) | **GET** /Contacts/{ContactID}/Attachments/{AttachmentID} | Retrieves a specific attachment from a specific contact using a unique attachment Id +[**get_contact_attachments**](AccountingApi.md#get_contact_attachments) | **GET** /Contacts/{ContactID}/Attachments | Retrieves attachments for a specific contact in a Xero organisation +[**get_contact_by_contact_number**](AccountingApi.md#get_contact_by_contact_number) | **GET** /Contacts/{ContactNumber} | Retrieves a specific contact by contact number in a Xero organisation +[**get_contact_cis_settings**](AccountingApi.md#get_contact_cis_settings) | **GET** /Contacts/{ContactID}/CISSettings | Retrieves CIS settings for a specific contact in a Xero organisation +[**get_contact_group**](AccountingApi.md#get_contact_group) | **GET** /ContactGroups/{ContactGroupID} | Retrieves a specific contact group by using a unique contact group Id +[**get_contact_groups**](AccountingApi.md#get_contact_groups) | **GET** /ContactGroups | Retrieves the contact Id and name of all the contacts in a contact group +[**get_contact_history**](AccountingApi.md#get_contact_history) | **GET** /Contacts/{ContactID}/History | Retrieves history records for a specific contact +[**get_contacts**](AccountingApi.md#get_contacts) | **GET** /Contacts | Retrieves all contacts in a Xero organisation +[**get_credit_note**](AccountingApi.md#get_credit_note) | **GET** /CreditNotes/{CreditNoteID} | Retrieves a specific credit note using a unique credit note Id +[**get_credit_note_as_pdf**](AccountingApi.md#get_credit_note_as_pdf) | **GET** /CreditNotes/{CreditNoteID}/pdf | Retrieves credit notes as PDF files +[**get_credit_note_attachment_by_file_name**](AccountingApi.md#get_credit_note_attachment_by_file_name) | **GET** /CreditNotes/{CreditNoteID}/Attachments/{FileName} | Retrieves a specific attachment on a specific credit note by file name +[**get_credit_note_attachment_by_id**](AccountingApi.md#get_credit_note_attachment_by_id) | **GET** /CreditNotes/{CreditNoteID}/Attachments/{AttachmentID} | Retrieves a specific attachment from a specific credit note using a unique attachment Id +[**get_credit_note_attachments**](AccountingApi.md#get_credit_note_attachments) | **GET** /CreditNotes/{CreditNoteID}/Attachments | Retrieves attachments for a specific credit notes +[**get_credit_note_history**](AccountingApi.md#get_credit_note_history) | **GET** /CreditNotes/{CreditNoteID}/History | Retrieves history records of a specific credit note +[**get_credit_notes**](AccountingApi.md#get_credit_notes) | **GET** /CreditNotes | Retrieves any credit notes +[**get_currencies**](AccountingApi.md#get_currencies) | **GET** /Currencies | Retrieves currencies for your Xero organisation +[**get_employee**](AccountingApi.md#get_employee) | **GET** /Employees/{EmployeeID} | Retrieves a specific employee used in Xero payrun using a unique employee Id +[**get_employees**](AccountingApi.md#get_employees) | **GET** /Employees | Retrieves employees used in Xero payrun +[**get_expense_claim**](AccountingApi.md#get_expense_claim) | **GET** /ExpenseClaims/{ExpenseClaimID} | Retrieves a specific expense claim using a unique expense claim Id +[**get_expense_claim_history**](AccountingApi.md#get_expense_claim_history) | **GET** /ExpenseClaims/{ExpenseClaimID}/History | Retrieves history records of a specific expense claim +[**get_expense_claims**](AccountingApi.md#get_expense_claims) | **GET** /ExpenseClaims | Retrieves expense claims +[**get_invoice**](AccountingApi.md#get_invoice) | **GET** /Invoices/{InvoiceID} | Retrieves a specific sales invoice or purchase bill using a unique invoice Id +[**get_invoice_as_pdf**](AccountingApi.md#get_invoice_as_pdf) | **GET** /Invoices/{InvoiceID}/pdf | Retrieves invoices or purchase bills as PDF files +[**get_invoice_attachment_by_file_name**](AccountingApi.md#get_invoice_attachment_by_file_name) | **GET** /Invoices/{InvoiceID}/Attachments/{FileName} | Retrieves an attachment from a specific invoice or purchase bill by filename +[**get_invoice_attachment_by_id**](AccountingApi.md#get_invoice_attachment_by_id) | **GET** /Invoices/{InvoiceID}/Attachments/{AttachmentID} | Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id +[**get_invoice_attachments**](AccountingApi.md#get_invoice_attachments) | **GET** /Invoices/{InvoiceID}/Attachments | Retrieves attachments for a specific invoice or purchase bill +[**get_invoice_history**](AccountingApi.md#get_invoice_history) | **GET** /Invoices/{InvoiceID}/History | Retrieves history records for a specific invoice +[**get_invoice_reminders**](AccountingApi.md#get_invoice_reminders) | **GET** /InvoiceReminders/Settings | Retrieves invoice reminder settings +[**get_invoices**](AccountingApi.md#get_invoices) | **GET** /Invoices | Retrieves sales invoices or purchase bills +[**get_item**](AccountingApi.md#get_item) | **GET** /Items/{ItemID} | Retrieves a specific item using a unique item Id +[**get_item_history**](AccountingApi.md#get_item_history) | **GET** /Items/{ItemID}/History | Retrieves history for a specific item +[**get_items**](AccountingApi.md#get_items) | **GET** /Items | Retrieves items +[**get_journal**](AccountingApi.md#get_journal) | **GET** /Journals/{JournalID} | Retrieves a specific journal using a unique journal Id. +[**get_journals**](AccountingApi.md#get_journals) | **GET** /Journals | Retrieves journals +[**get_linked_transaction**](AccountingApi.md#get_linked_transaction) | **GET** /LinkedTransactions/{LinkedTransactionID} | Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id +[**get_linked_transactions**](AccountingApi.md#get_linked_transactions) | **GET** /LinkedTransactions | Retrieves linked transactions (billable expenses) +[**get_manual_journal**](AccountingApi.md#get_manual_journal) | **GET** /ManualJournals/{ManualJournalID} | Retrieves a specific manual journal +[**get_manual_journal_attachment_by_file_name**](AccountingApi.md#get_manual_journal_attachment_by_file_name) | **GET** /ManualJournals/{ManualJournalID}/Attachments/{FileName} | Retrieves a specific attachment from a specific manual journal by file name +[**get_manual_journal_attachment_by_id**](AccountingApi.md#get_manual_journal_attachment_by_id) | **GET** /ManualJournals/{ManualJournalID}/Attachments/{AttachmentID} | Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id +[**get_manual_journal_attachments**](AccountingApi.md#get_manual_journal_attachments) | **GET** /ManualJournals/{ManualJournalID}/Attachments | Retrieves attachment for a specific manual journal +[**get_manual_journals**](AccountingApi.md#get_manual_journals) | **GET** /ManualJournals | Retrieves manual journals +[**get_manual_journals_history**](AccountingApi.md#get_manual_journals_history) | **GET** /ManualJournals/{ManualJournalID}/History | Retrieves history for a specific manual journal +[**get_online_invoice**](AccountingApi.md#get_online_invoice) | **GET** /Invoices/{InvoiceID}/OnlineInvoice | Retrieves a URL to an online invoice +[**get_organisation_actions**](AccountingApi.md#get_organisation_actions) | **GET** /Organisation/Actions | Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation. +[**get_organisation_cis_settings**](AccountingApi.md#get_organisation_cis_settings) | **GET** /Organisation/{OrganisationID}/CISSettings | Retrieves the CIS settings for the Xero organistaion. +[**get_organisations**](AccountingApi.md#get_organisations) | **GET** /Organisation | Retrieves Xero organisation details +[**get_overpayment**](AccountingApi.md#get_overpayment) | **GET** /Overpayments/{OverpaymentID} | Retrieves a specific overpayment using a unique overpayment Id +[**get_overpayment_history**](AccountingApi.md#get_overpayment_history) | **GET** /Overpayments/{OverpaymentID}/History | Retrieves history records of a specific overpayment +[**get_overpayments**](AccountingApi.md#get_overpayments) | **GET** /Overpayments | Retrieves overpayments +[**get_payment**](AccountingApi.md#get_payment) | **GET** /Payments/{PaymentID} | Retrieves a specific payment for invoices and credit notes using a unique payment Id +[**get_payment_history**](AccountingApi.md#get_payment_history) | **GET** /Payments/{PaymentID}/History | Retrieves history records of a specific payment +[**get_payment_services**](AccountingApi.md#get_payment_services) | **GET** /PaymentServices | Retrieves payment services +[**get_payments**](AccountingApi.md#get_payments) | **GET** /Payments | Retrieves payments for invoices and credit notes [**get_prepayment**](AccountingApi.md#get_prepayment) | **GET** /Prepayments/{PrepaymentID} | Allows you to retrieve a specified prepayments -[**get_prepayment_history**](AccountingApi.md#get_prepayment_history) | **GET** /Prepayments/{PrepaymentID}/History | Allows you to retrieve a history records of an Prepayment -[**get_prepayments**](AccountingApi.md#get_prepayments) | **GET** /Prepayments | Allows you to retrieve prepayments -[**get_purchase_order**](AccountingApi.md#get_purchase_order) | **GET** /PurchaseOrders/{PurchaseOrderID} | Allows you to retrieve a specified purchase orders -[**get_purchase_order_as_pdf**](AccountingApi.md#get_purchase_order_as_pdf) | **GET** /PurchaseOrders/{PurchaseOrderID}/pdf | Allows you to retrieve purchase orders as PDF files -[**get_purchase_order_attachment_by_file_name**](AccountingApi.md#get_purchase_order_attachment_by_file_name) | **GET** /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName} | Allows you to retrieve Attachment on a Purchase Order by Filename -[**get_purchase_order_attachment_by_id**](AccountingApi.md#get_purchase_order_attachment_by_id) | **GET** /PurchaseOrders/{PurchaseOrderID}/Attachments/{AttachmentID} | Allows you to retrieve specific Attachment on purchase order -[**get_purchase_order_attachments**](AccountingApi.md#get_purchase_order_attachments) | **GET** /PurchaseOrders/{PurchaseOrderID}/Attachments | Allows you to retrieve attachments for purchase orders -[**get_purchase_order_by_number**](AccountingApi.md#get_purchase_order_by_number) | **GET** /PurchaseOrders/{PurchaseOrderNumber} | Allows you to retrieve a specified purchase orders -[**get_purchase_order_history**](AccountingApi.md#get_purchase_order_history) | **GET** /PurchaseOrders/{PurchaseOrderID}/History | Allows you to retrieve history for PurchaseOrder -[**get_purchase_orders**](AccountingApi.md#get_purchase_orders) | **GET** /PurchaseOrders | Allows you to retrieve purchase orders -[**get_quote**](AccountingApi.md#get_quote) | **GET** /Quotes/{QuoteID} | Allows you to retrieve a specified quote -[**get_quote_as_pdf**](AccountingApi.md#get_quote_as_pdf) | **GET** /Quotes/{QuoteID}/pdf | Allows you to retrieve quotes as PDF files -[**get_quote_attachment_by_file_name**](AccountingApi.md#get_quote_attachment_by_file_name) | **GET** /Quotes/{QuoteID}/Attachments/{FileName} | Allows you to retrieve Attachment on Quote by Filename -[**get_quote_attachment_by_id**](AccountingApi.md#get_quote_attachment_by_id) | **GET** /Quotes/{QuoteID}/Attachments/{AttachmentID} | Allows you to retrieve specific Attachment on Quote -[**get_quote_attachments**](AccountingApi.md#get_quote_attachments) | **GET** /Quotes/{QuoteID}/Attachments | Allows you to retrieve Attachments for Quotes -[**get_quote_history**](AccountingApi.md#get_quote_history) | **GET** /Quotes/{QuoteID}/History | Allows you to retrieve a history records of an quote -[**get_quotes**](AccountingApi.md#get_quotes) | **GET** /Quotes | Allows you to retrieve any sales quotes -[**get_receipt**](AccountingApi.md#get_receipt) | **GET** /Receipts/{ReceiptID} | Allows you to retrieve a specified draft expense claim receipts -[**get_receipt_attachment_by_file_name**](AccountingApi.md#get_receipt_attachment_by_file_name) | **GET** /Receipts/{ReceiptID}/Attachments/{FileName} | Allows you to retrieve Attachments on expense claim receipts by file name -[**get_receipt_attachment_by_id**](AccountingApi.md#get_receipt_attachment_by_id) | **GET** /Receipts/{ReceiptID}/Attachments/{AttachmentID} | Allows you to retrieve Attachments on expense claim receipts by ID -[**get_receipt_attachments**](AccountingApi.md#get_receipt_attachments) | **GET** /Receipts/{ReceiptID}/Attachments | Allows you to retrieve Attachments for expense claim receipts -[**get_receipt_history**](AccountingApi.md#get_receipt_history) | **GET** /Receipts/{ReceiptID}/History | Allows you to retrieve a history records of an Receipt -[**get_receipts**](AccountingApi.md#get_receipts) | **GET** /Receipts | Allows you to retrieve draft expense claim receipts for any user -[**get_repeating_invoice**](AccountingApi.md#get_repeating_invoice) | **GET** /RepeatingInvoices/{RepeatingInvoiceID} | Allows you to retrieve a specified repeating invoice -[**get_repeating_invoice_attachment_by_file_name**](AccountingApi.md#get_repeating_invoice_attachment_by_file_name) | **GET** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} | Allows you to retrieve specified attachment on repeating invoices by file name -[**get_repeating_invoice_attachment_by_id**](AccountingApi.md#get_repeating_invoice_attachment_by_id) | **GET** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID} | Allows you to retrieve a specified Attachments on repeating invoices -[**get_repeating_invoice_attachments**](AccountingApi.md#get_repeating_invoice_attachments) | **GET** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments | Allows you to retrieve Attachments on repeating invoice -[**get_repeating_invoice_history**](AccountingApi.md#get_repeating_invoice_history) | **GET** /RepeatingInvoices/{RepeatingInvoiceID}/History | Allows you to retrieve history for a repeating invoice -[**get_repeating_invoices**](AccountingApi.md#get_repeating_invoices) | **GET** /RepeatingInvoices | Allows you to retrieve any repeating invoices -[**get_report_aged_payables_by_contact**](AccountingApi.md#get_report_aged_payables_by_contact) | **GET** /Reports/AgedPayablesByContact | Allows you to retrieve report for AgedPayablesByContact -[**get_report_aged_receivables_by_contact**](AccountingApi.md#get_report_aged_receivables_by_contact) | **GET** /Reports/AgedReceivablesByContact | Allows you to retrieve report for AgedReceivablesByContact -[**get_report_ba_sor_gst**](AccountingApi.md#get_report_ba_sor_gst) | **GET** /Reports/{ReportID} | Allows you to retrieve report for BAS only valid for AU orgs -[**get_report_ba_sor_gst_list**](AccountingApi.md#get_report_ba_sor_gst_list) | **GET** /Reports | Allows you to retrieve report for BAS only valid for AU orgs -[**get_report_balance_sheet**](AccountingApi.md#get_report_balance_sheet) | **GET** /Reports/BalanceSheet | Allows you to retrieve report for BalanceSheet -[**get_report_bank_summary**](AccountingApi.md#get_report_bank_summary) | **GET** /Reports/BankSummary | Allows you to retrieve report for BankSummary -[**get_report_budget_summary**](AccountingApi.md#get_report_budget_summary) | **GET** /Reports/BudgetSummary | Allows you to retrieve report for Budget Summary -[**get_report_executive_summary**](AccountingApi.md#get_report_executive_summary) | **GET** /Reports/ExecutiveSummary | Allows you to retrieve report for ExecutiveSummary -[**get_report_profit_and_loss**](AccountingApi.md#get_report_profit_and_loss) | **GET** /Reports/ProfitAndLoss | Allows you to retrieve report for ProfitAndLoss -[**get_report_ten_ninety_nine**](AccountingApi.md#get_report_ten_ninety_nine) | **GET** /Reports/TenNinetyNine | Allows you to retrieve report for TenNinetyNine -[**get_report_trial_balance**](AccountingApi.md#get_report_trial_balance) | **GET** /Reports/TrialBalance | Allows you to retrieve report for TrialBalance -[**get_tax_rates**](AccountingApi.md#get_tax_rates) | **GET** /TaxRates | Allows you to retrieve Tax Rates -[**get_tracking_categories**](AccountingApi.md#get_tracking_categories) | **GET** /TrackingCategories | Allows you to retrieve tracking categories and options -[**get_tracking_category**](AccountingApi.md#get_tracking_category) | **GET** /TrackingCategories/{TrackingCategoryID} | Allows you to retrieve tracking categories and options for specified category -[**get_user**](AccountingApi.md#get_user) | **GET** /Users/{UserID} | Allows you to retrieve a specified user -[**get_users**](AccountingApi.md#get_users) | **GET** /Users | Allows you to retrieve users -[**post_setup**](AccountingApi.md#post_setup) | **POST** /Setup | Allows you to set the chart of accounts, the conversion date and conversion balances -[**update_account**](AccountingApi.md#update_account) | **POST** /Accounts/{AccountID} | Allows you to update a chart of accounts -[**update_account_attachment_by_file_name**](AccountingApi.md#update_account_attachment_by_file_name) | **POST** /Accounts/{AccountID}/Attachments/{FileName} | Allows you to update Attachment on Account by Filename -[**update_bank_transaction**](AccountingApi.md#update_bank_transaction) | **POST** /BankTransactions/{BankTransactionID} | Allows you to update a single spend or receive money transaction -[**update_bank_transaction_attachment_by_file_name**](AccountingApi.md#update_bank_transaction_attachment_by_file_name) | **POST** /BankTransactions/{BankTransactionID}/Attachments/{FileName} | Allows you to update an Attachment on BankTransaction by Filename +[**get_prepayment_history**](AccountingApi.md#get_prepayment_history) | **GET** /Prepayments/{PrepaymentID}/History | Retrieves history record for a specific prepayment +[**get_prepayments**](AccountingApi.md#get_prepayments) | **GET** /Prepayments | Retrieves prepayments +[**get_purchase_order**](AccountingApi.md#get_purchase_order) | **GET** /PurchaseOrders/{PurchaseOrderID} | Retrieves a specific purchase order using a unique purchase order Id +[**get_purchase_order_as_pdf**](AccountingApi.md#get_purchase_order_as_pdf) | **GET** /PurchaseOrders/{PurchaseOrderID}/pdf | Retrieves specific purchase order as PDF files using a unique purchase order Id +[**get_purchase_order_attachment_by_file_name**](AccountingApi.md#get_purchase_order_attachment_by_file_name) | **GET** /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName} | Retrieves a specific attachment for a specific purchase order by filename +[**get_purchase_order_attachment_by_id**](AccountingApi.md#get_purchase_order_attachment_by_id) | **GET** /PurchaseOrders/{PurchaseOrderID}/Attachments/{AttachmentID} | Retrieves specific attachment for a specific purchase order using a unique attachment Id +[**get_purchase_order_attachments**](AccountingApi.md#get_purchase_order_attachments) | **GET** /PurchaseOrders/{PurchaseOrderID}/Attachments | Retrieves attachments for a specific purchase order +[**get_purchase_order_by_number**](AccountingApi.md#get_purchase_order_by_number) | **GET** /PurchaseOrders/{PurchaseOrderNumber} | Retrieves a specific purchase order using purchase order number +[**get_purchase_order_history**](AccountingApi.md#get_purchase_order_history) | **GET** /PurchaseOrders/{PurchaseOrderID}/History | Retrieves history for a specific purchase order +[**get_purchase_orders**](AccountingApi.md#get_purchase_orders) | **GET** /PurchaseOrders | Retrieves purchase orders +[**get_quote**](AccountingApi.md#get_quote) | **GET** /Quotes/{QuoteID} | Retrieves a specific quote using a unique quote Id +[**get_quote_as_pdf**](AccountingApi.md#get_quote_as_pdf) | **GET** /Quotes/{QuoteID}/pdf | Retrieves a specific quote as a PDF file using a unique quote Id +[**get_quote_attachment_by_file_name**](AccountingApi.md#get_quote_attachment_by_file_name) | **GET** /Quotes/{QuoteID}/Attachments/{FileName} | Retrieves a specific attachment from a specific quote by filename +[**get_quote_attachment_by_id**](AccountingApi.md#get_quote_attachment_by_id) | **GET** /Quotes/{QuoteID}/Attachments/{AttachmentID} | Retrieves a specific attachment from a specific quote using a unique attachment Id +[**get_quote_attachments**](AccountingApi.md#get_quote_attachments) | **GET** /Quotes/{QuoteID}/Attachments | Retrieves attachments for a specific quote +[**get_quote_history**](AccountingApi.md#get_quote_history) | **GET** /Quotes/{QuoteID}/History | Retrieves history records of a specific quote +[**get_quotes**](AccountingApi.md#get_quotes) | **GET** /Quotes | Retrieves sales quotes +[**get_receipt**](AccountingApi.md#get_receipt) | **GET** /Receipts/{ReceiptID} | Retrieves a specific draft expense claim receipt by using a unique receipt Id +[**get_receipt_attachment_by_file_name**](AccountingApi.md#get_receipt_attachment_by_file_name) | **GET** /Receipts/{ReceiptID}/Attachments/{FileName} | Retrieves a specific attachment from a specific expense claim receipts by file name +[**get_receipt_attachment_by_id**](AccountingApi.md#get_receipt_attachment_by_id) | **GET** /Receipts/{ReceiptID}/Attachments/{AttachmentID} | Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id +[**get_receipt_attachments**](AccountingApi.md#get_receipt_attachments) | **GET** /Receipts/{ReceiptID}/Attachments | Retrieves attachments for a specific expense claim receipt +[**get_receipt_history**](AccountingApi.md#get_receipt_history) | **GET** /Receipts/{ReceiptID}/History | Retrieves a history record for a specific receipt +[**get_receipts**](AccountingApi.md#get_receipts) | **GET** /Receipts | Retrieves draft expense claim receipts for any user +[**get_repeating_invoice**](AccountingApi.md#get_repeating_invoice) | **GET** /RepeatingInvoices/{RepeatingInvoiceID} | Retrieves a specific repeating invoice by using a unique repeating invoice Id +[**get_repeating_invoice_attachment_by_file_name**](AccountingApi.md#get_repeating_invoice_attachment_by_file_name) | **GET** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} | Retrieves a specific attachment from a specific repeating invoices by file name +[**get_repeating_invoice_attachment_by_id**](AccountingApi.md#get_repeating_invoice_attachment_by_id) | **GET** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID} | Retrieves a specific attachment from a specific repeating invoice +[**get_repeating_invoice_attachments**](AccountingApi.md#get_repeating_invoice_attachments) | **GET** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments | Retrieves attachments from a specific repeating invoice +[**get_repeating_invoice_history**](AccountingApi.md#get_repeating_invoice_history) | **GET** /RepeatingInvoices/{RepeatingInvoiceID}/History | Retrieves history record for a specific repeating invoice +[**get_repeating_invoices**](AccountingApi.md#get_repeating_invoices) | **GET** /RepeatingInvoices | Retrieves repeating invoices +[**get_report_aged_payables_by_contact**](AccountingApi.md#get_report_aged_payables_by_contact) | **GET** /Reports/AgedPayablesByContact | Retrieves report for aged payables by contact +[**get_report_aged_receivables_by_contact**](AccountingApi.md#get_report_aged_receivables_by_contact) | **GET** /Reports/AgedReceivablesByContact | Retrieves report for aged receivables by contact +[**get_report_ba_sor_gst**](AccountingApi.md#get_report_ba_sor_gst) | **GET** /Reports/{ReportID} | Retrieves a specific report for BAS using a unique report Id (only valid for AU orgs) +[**get_report_ba_sor_gst_list**](AccountingApi.md#get_report_ba_sor_gst_list) | **GET** /Reports | Retrieves report for BAS (only valid for AU orgs) +[**get_report_balance_sheet**](AccountingApi.md#get_report_balance_sheet) | **GET** /Reports/BalanceSheet | Retrieves report for balancesheet +[**get_report_bank_summary**](AccountingApi.md#get_report_bank_summary) | **GET** /Reports/BankSummary | Retrieves report for bank summary +[**get_report_budget_summary**](AccountingApi.md#get_report_budget_summary) | **GET** /Reports/BudgetSummary | Retrieves report for budget summary +[**get_report_executive_summary**](AccountingApi.md#get_report_executive_summary) | **GET** /Reports/ExecutiveSummary | Retrieves report for executive summary +[**get_report_profit_and_loss**](AccountingApi.md#get_report_profit_and_loss) | **GET** /Reports/ProfitAndLoss | Retrieves report for profit and loss +[**get_report_ten_ninety_nine**](AccountingApi.md#get_report_ten_ninety_nine) | **GET** /Reports/TenNinetyNine | Retrieve reports for 1099 +[**get_report_trial_balance**](AccountingApi.md#get_report_trial_balance) | **GET** /Reports/TrialBalance | Retrieves report for trial balance +[**get_tax_rates**](AccountingApi.md#get_tax_rates) | **GET** /TaxRates | Retrieves tax rates +[**get_tracking_categories**](AccountingApi.md#get_tracking_categories) | **GET** /TrackingCategories | Retrieves tracking categories and options +[**get_tracking_category**](AccountingApi.md#get_tracking_category) | **GET** /TrackingCategories/{TrackingCategoryID} | Retrieves specific tracking categories and options using a unique tracking category Id +[**get_user**](AccountingApi.md#get_user) | **GET** /Users/{UserID} | Retrieves a specific user +[**get_users**](AccountingApi.md#get_users) | **GET** /Users | Retrieves users +[**post_setup**](AccountingApi.md#post_setup) | **POST** /Setup | Sets the chart of accounts, the conversion date and conversion balances +[**update_account**](AccountingApi.md#update_account) | **POST** /Accounts/{AccountID} | Updates a chart of accounts +[**update_account_attachment_by_file_name**](AccountingApi.md#update_account_attachment_by_file_name) | **POST** /Accounts/{AccountID}/Attachments/{FileName} | Updates attachment on a specific account by filename +[**update_bank_transaction**](AccountingApi.md#update_bank_transaction) | **POST** /BankTransactions/{BankTransactionID} | Updates a single spent or received money transaction +[**update_bank_transaction_attachment_by_file_name**](AccountingApi.md#update_bank_transaction_attachment_by_file_name) | **POST** /BankTransactions/{BankTransactionID}/Attachments/{FileName} | Updates a specific attachment from a specific bank transaction by filename [**update_bank_transfer_attachment_by_file_name**](AccountingApi.md#update_bank_transfer_attachment_by_file_name) | **POST** /BankTransfers/{BankTransferID}/Attachments/{FileName} | -[**update_contact**](AccountingApi.md#update_contact) | **POST** /Contacts/{ContactID} | Allows you to update one contact in a Xero organisation +[**update_contact**](AccountingApi.md#update_contact) | **POST** /Contacts/{ContactID} | Updates a specific contact in a Xero organisation [**update_contact_attachment_by_file_name**](AccountingApi.md#update_contact_attachment_by_file_name) | **POST** /Contacts/{ContactID}/Attachments/{FileName} | -[**update_contact_group**](AccountingApi.md#update_contact_group) | **POST** /ContactGroups/{ContactGroupID} | Allows you to update a Contact Group -[**update_credit_note**](AccountingApi.md#update_credit_note) | **POST** /CreditNotes/{CreditNoteID} | Allows you to update a specific credit note -[**update_credit_note_attachment_by_file_name**](AccountingApi.md#update_credit_note_attachment_by_file_name) | **POST** /CreditNotes/{CreditNoteID}/Attachments/{FileName} | Allows you to update Attachments on CreditNote by file name -[**update_expense_claim**](AccountingApi.md#update_expense_claim) | **POST** /ExpenseClaims/{ExpenseClaimID} | Allows you to update specified expense claims -[**update_invoice**](AccountingApi.md#update_invoice) | **POST** /Invoices/{InvoiceID} | Allows you to update a specified sales invoices or purchase bills -[**update_invoice_attachment_by_file_name**](AccountingApi.md#update_invoice_attachment_by_file_name) | **POST** /Invoices/{InvoiceID}/Attachments/{FileName} | Allows you to update Attachment on invoices or purchase bills by it's filename -[**update_item**](AccountingApi.md#update_item) | **POST** /Items/{ItemID} | Allows you to update a specified item -[**update_linked_transaction**](AccountingApi.md#update_linked_transaction) | **POST** /LinkedTransactions/{LinkedTransactionID} | Allows you to update a specified linked transactions (billable expenses) -[**update_manual_journal**](AccountingApi.md#update_manual_journal) | **POST** /ManualJournals/{ManualJournalID} | Allows you to update a specified manual journal -[**update_manual_journal_attachment_by_file_name**](AccountingApi.md#update_manual_journal_attachment_by_file_name) | **POST** /ManualJournals/{ManualJournalID}/Attachments/{FileName} | Allows you to update a specified Attachment on ManualJournal by file name -[**update_or_create_bank_transactions**](AccountingApi.md#update_or_create_bank_transactions) | **POST** /BankTransactions | Allows you to update or create one or more spend or receive money transaction -[**update_or_create_contacts**](AccountingApi.md#update_or_create_contacts) | **POST** /Contacts | Allows you to update OR create one or more contacts in a Xero organisation -[**update_or_create_credit_notes**](AccountingApi.md#update_or_create_credit_notes) | **POST** /CreditNotes | Allows you to update OR create one or more credit notes -[**update_or_create_employees**](AccountingApi.md#update_or_create_employees) | **POST** /Employees | Allows you to create a single new employees used in Xero payrun -[**update_or_create_invoices**](AccountingApi.md#update_or_create_invoices) | **POST** /Invoices | Allows you to update OR create one or more sales invoices or purchase bills -[**update_or_create_items**](AccountingApi.md#update_or_create_items) | **POST** /Items | Allows you to update or create one or more items -[**update_or_create_manual_journals**](AccountingApi.md#update_or_create_manual_journals) | **POST** /ManualJournals | Allows you to create a single manual journal -[**update_or_create_purchase_orders**](AccountingApi.md#update_or_create_purchase_orders) | **POST** /PurchaseOrders | Allows you to update or create one or more purchase orders -[**update_or_create_quotes**](AccountingApi.md#update_or_create_quotes) | **POST** /Quotes | Allows you to update OR create one or more quotes -[**update_purchase_order**](AccountingApi.md#update_purchase_order) | **POST** /PurchaseOrders/{PurchaseOrderID} | Allows you to update a specified purchase order -[**update_purchase_order_attachment_by_file_name**](AccountingApi.md#update_purchase_order_attachment_by_file_name) | **POST** /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName} | Allows you to update Attachment on Purchase Order by Filename -[**update_quote**](AccountingApi.md#update_quote) | **POST** /Quotes/{QuoteID} | Allows you to update a specified quote -[**update_quote_attachment_by_file_name**](AccountingApi.md#update_quote_attachment_by_file_name) | **POST** /Quotes/{QuoteID}/Attachments/{FileName} | Allows you to update Attachment on Quote by Filename -[**update_receipt**](AccountingApi.md#update_receipt) | **POST** /Receipts/{ReceiptID} | Allows you to retrieve a specified draft expense claim receipts -[**update_receipt_attachment_by_file_name**](AccountingApi.md#update_receipt_attachment_by_file_name) | **POST** /Receipts/{ReceiptID}/Attachments/{FileName} | Allows you to update Attachment on expense claim receipts by file name -[**update_repeating_invoice_attachment_by_file_name**](AccountingApi.md#update_repeating_invoice_attachment_by_file_name) | **POST** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} | Allows you to update specified attachment on repeating invoices by file name -[**update_tax_rate**](AccountingApi.md#update_tax_rate) | **POST** /TaxRates | Allows you to update Tax Rates -[**update_tracking_category**](AccountingApi.md#update_tracking_category) | **POST** /TrackingCategories/{TrackingCategoryID} | Allows you to update tracking categories -[**update_tracking_options**](AccountingApi.md#update_tracking_options) | **POST** /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID} | Allows you to update options for a specified tracking category +[**update_contact_group**](AccountingApi.md#update_contact_group) | **POST** /ContactGroups/{ContactGroupID} | Updates a specific contact group +[**update_credit_note**](AccountingApi.md#update_credit_note) | **POST** /CreditNotes/{CreditNoteID} | Updates a specific credit note +[**update_credit_note_attachment_by_file_name**](AccountingApi.md#update_credit_note_attachment_by_file_name) | **POST** /CreditNotes/{CreditNoteID}/Attachments/{FileName} | Updates attachments on a specific credit note by file name +[**update_expense_claim**](AccountingApi.md#update_expense_claim) | **POST** /ExpenseClaims/{ExpenseClaimID} | Updates a specific expense claims +[**update_invoice**](AccountingApi.md#update_invoice) | **POST** /Invoices/{InvoiceID} | Updates a specific sales invoices or purchase bills +[**update_invoice_attachment_by_file_name**](AccountingApi.md#update_invoice_attachment_by_file_name) | **POST** /Invoices/{InvoiceID}/Attachments/{FileName} | Updates an attachment from a specific invoices or purchase bill by filename +[**update_item**](AccountingApi.md#update_item) | **POST** /Items/{ItemID} | Updates a specific item +[**update_linked_transaction**](AccountingApi.md#update_linked_transaction) | **POST** /LinkedTransactions/{LinkedTransactionID} | Updates a specific linked transactions (billable expenses) +[**update_manual_journal**](AccountingApi.md#update_manual_journal) | **POST** /ManualJournals/{ManualJournalID} | Updates a specific manual journal +[**update_manual_journal_attachment_by_file_name**](AccountingApi.md#update_manual_journal_attachment_by_file_name) | **POST** /ManualJournals/{ManualJournalID}/Attachments/{FileName} | Updates a specific attachment from a specific manual journal by file name +[**update_or_create_bank_transactions**](AccountingApi.md#update_or_create_bank_transactions) | **POST** /BankTransactions | Updates or creates one or more spent or received money transaction +[**update_or_create_contacts**](AccountingApi.md#update_or_create_contacts) | **POST** /Contacts | Updates or creates one or more contacts in a Xero organisation +[**update_or_create_credit_notes**](AccountingApi.md#update_or_create_credit_notes) | **POST** /CreditNotes | Updates or creates one or more credit notes +[**update_or_create_employees**](AccountingApi.md#update_or_create_employees) | **POST** /Employees | Creates a single new employees used in Xero payrun +[**update_or_create_invoices**](AccountingApi.md#update_or_create_invoices) | **POST** /Invoices | Updates or creates one or more sales invoices or purchase bills +[**update_or_create_items**](AccountingApi.md#update_or_create_items) | **POST** /Items | Updates or creates one or more items +[**update_or_create_manual_journals**](AccountingApi.md#update_or_create_manual_journals) | **POST** /ManualJournals | Updates or creates a single manual journal +[**update_or_create_purchase_orders**](AccountingApi.md#update_or_create_purchase_orders) | **POST** /PurchaseOrders | Updates or creates one or more purchase orders +[**update_or_create_quotes**](AccountingApi.md#update_or_create_quotes) | **POST** /Quotes | Updates or creates one or more quotes +[**update_purchase_order**](AccountingApi.md#update_purchase_order) | **POST** /PurchaseOrders/{PurchaseOrderID} | Updates a specific purchase order +[**update_purchase_order_attachment_by_file_name**](AccountingApi.md#update_purchase_order_attachment_by_file_name) | **POST** /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName} | Updates a specific attachment for a specific purchase order by filename +[**update_quote**](AccountingApi.md#update_quote) | **POST** /Quotes/{QuoteID} | Updates a specific quote +[**update_quote_attachment_by_file_name**](AccountingApi.md#update_quote_attachment_by_file_name) | **POST** /Quotes/{QuoteID}/Attachments/{FileName} | Updates a specific attachment from a specific quote by filename +[**update_receipt**](AccountingApi.md#update_receipt) | **POST** /Receipts/{ReceiptID} | Updates a specific draft expense claim receipts +[**update_receipt_attachment_by_file_name**](AccountingApi.md#update_receipt_attachment_by_file_name) | **POST** /Receipts/{ReceiptID}/Attachments/{FileName} | Updates a specific attachment on a specific expense claim receipts by file name +[**update_repeating_invoice_attachment_by_file_name**](AccountingApi.md#update_repeating_invoice_attachment_by_file_name) | **POST** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} | Updates a specific attachment from a specific repeating invoices by file name +[**update_tax_rate**](AccountingApi.md#update_tax_rate) | **POST** /TaxRates | Updates tax rates +[**update_tracking_category**](AccountingApi.md#update_tracking_category) | **POST** /TrackingCategories/{TrackingCategoryID} | Updates a specific tracking category +[**update_tracking_options**](AccountingApi.md#update_tracking_options) | **POST** /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID} | Updates a specific option for a specific tracking category # **create_account** > Accounts create_account(xero_tenant_id, account) -Allows you to create a new chart of accounts +Creates a new chart of accounts ### Example @@ -264,7 +264,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant account = { "Code":"123456", "Name":"Foobar", "Type":"EXPENSE", "Description":"Hello World" } # Account | Account object in body of request try: - # Allows you to create a new chart of accounts + # Creates a new chart of accounts api_response = api_instance.create_account(xero_tenant_id, account) pprint(api_response) except ApiException as e: @@ -296,7 +296,7 @@ Name | Type | Description | Notes # **create_account_attachment_by_file_name** > Attachments create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) -Allows you to create Attachment on Account +Creates an attachment on a specific account ### Example @@ -325,11 +325,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -account_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Account object +account_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Account object file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to create Attachment on Account + # Creates an attachment on a specific account api_response = api_instance.create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) pprint(api_response) except ApiException as e: @@ -363,7 +363,7 @@ Name | Type | Description | Notes # **create_bank_transaction_attachment_by_file_name** > Attachments create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) -Allows you to create an Attachment on BankTransaction by Filename +Creates an attachment for a specific bank transaction by filename ### Example @@ -392,11 +392,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transaction +bank_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transaction file_name = 'xero-dev.jpg' # str | The name of the file being attached body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to create an Attachment on BankTransaction by Filename + # Creates an attachment for a specific bank transaction by filename api_response = api_instance.create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) pprint(api_response) except ApiException as e: @@ -430,7 +430,7 @@ Name | Type | Description | Notes # **create_bank_transaction_history_record** > HistoryRecords create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records) -Allows you to create history record for a bank transactions +Creates a history record for a specific bank transactions ### Example @@ -459,10 +459,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transaction +bank_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transaction history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to create history record for a bank transactions + # Creates a history record for a specific bank transactions api_response = api_instance.create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records) pprint(api_response) except ApiException as e: @@ -495,7 +495,7 @@ Name | Type | Description | Notes # **create_bank_transactions** > BankTransactions create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp) -Allows you to create one or more spend or receive money transaction +Creates one or more spent or received money transaction ### Example @@ -524,11 +524,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transactions = { bankTransactions: [{ type: BankTransaction.TypeEnum.SPEND, contact: { contactID: "00000000-0000-0000-000-000000000000" }, lineItems: [{ description: "Foobar", quantity: 1.0, unitAmount: 20.0, accountCode: "000" } ], bankAccount: { code: "000" }}]} # BankTransactions | BankTransactions with an array of BankTransaction objects in body of request +bank_transactions = { bankTransactions: [{ type: BankTransaction.TypeEnum.SPEND, contact: { contactID: "00000000-0000-0000-0000-000000000000" }, lineItems: [{ description: "Foobar", quantity: 1.0, unitAmount: 20.0, accountCode: "000" } ], bankAccount: { code: "000" }}]} # BankTransactions | BankTransactions with an array of BankTransaction objects in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to create one or more spend or receive money transaction + # Creates one or more spent or received money transaction api_response = api_instance.create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -562,7 +562,7 @@ Name | Type | Description | Notes # **create_bank_transfer** > BankTransfers create_bank_transfer(xero_tenant_id, bank_transfers) -Allows you to create a bank transfers +Creates a bank transfer ### Example @@ -591,9 +591,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transfers = { "BankTransfers": [ { "FromBankAccount": { "Code": "090", "Name": "My Savings", "AccountID": "00000000-0000-0000-000-000000000000", "Type": "BANK", "BankAccountNumber": "123455", "Status": "ACTIVE", "BankAccountType": "BANK", "CurrencyCode": "USD", "TaxType": "NONE", "EnablePaymentsToAccount": false, "ShowInExpenseClaims": false, "Class": "ASSET", "ReportingCode": "ASS", "ReportingCodeName": "Assets", "HasAttachments": false, "UpdatedDateUTC": "2016-10-17T13:45:33.993-07:00" }, "ToBankAccount": { "Code": "088", "Name": "Business Wells Fargo", "AccountID": "00000000-0000-0000-000-000000000000", "Type": "BANK", "BankAccountNumber": "123455", "Status": "ACTIVE", "BankAccountType": "BANK", "CurrencyCode": "USD", "TaxType": "NONE", "EnablePaymentsToAccount": false, "ShowInExpenseClaims": false, "Class": "ASSET", "ReportingCode": "ASS", "ReportingCodeName": "Assets", "HasAttachments": false, "UpdatedDateUTC": "2016-06-03T08:31:14.517-07:00" }, "Amount": "50.00" } ] } # BankTransfers | BankTransfers with array of BankTransfer objects in request body +bank_transfers = { "BankTransfers": [ { "FromBankAccount": { "Code": "090", "Name": "My Savings", "AccountID": "00000000-0000-0000-0000-000000000000", "Type": "BANK", "BankAccountNumber": "123455", "Status": "ACTIVE", "BankAccountType": "BANK", "CurrencyCode": "USD", "TaxType": "NONE", "EnablePaymentsToAccount": false, "ShowInExpenseClaims": false, "Class": "ASSET", "ReportingCode": "ASS", "ReportingCodeName": "Assets", "HasAttachments": false, "UpdatedDateUTC": "2016-10-17T13:45:33.993-07:00" }, "ToBankAccount": { "Code": "088", "Name": "Business Wells Fargo", "AccountID": "00000000-0000-0000-0000-000000000000", "Type": "BANK", "BankAccountNumber": "123455", "Status": "ACTIVE", "BankAccountType": "BANK", "CurrencyCode": "USD", "TaxType": "NONE", "EnablePaymentsToAccount": false, "ShowInExpenseClaims": false, "Class": "ASSET", "ReportingCode": "ASS", "ReportingCodeName": "Assets", "HasAttachments": false, "UpdatedDateUTC": "2016-06-03T08:31:14.517-07:00" }, "Amount": "50.00" } ] } # BankTransfers | BankTransfers with array of BankTransfer objects in request body try: - # Allows you to create a bank transfers + # Creates a bank transfer api_response = api_instance.create_bank_transfer(xero_tenant_id, bank_transfers) pprint(api_response) except ApiException as e: @@ -654,7 +654,7 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transfer +bank_transfer_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transfer file_name = 'xero-dev.jpg' # str | The name of the file being attached to a Bank Transfer body = 'body_example' # str | Byte array of file in body of request try: @@ -691,7 +691,7 @@ Name | Type | Description | Notes # **create_bank_transfer_history_record** > HistoryRecords create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records) -Allows you to create history record for a bank transfers +Creates a history record for a specific bank transfer ### Example @@ -720,10 +720,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transfer +bank_transfer_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transfer history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to create history record for a bank transfers + # Creates a history record for a specific bank transfer api_response = api_instance.create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records) pprint(api_response) except ApiException as e: @@ -756,7 +756,7 @@ Name | Type | Description | Notes # **create_batch_payment** > BatchPayments create_batch_payment(xero_tenant_id, batch_payments, summarize_errors=summarize_errors) -Create one or many BatchPayments for invoices +Creates one or many batch payments for invoices ### Example @@ -785,10 +785,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -batch_payments = { "BatchPayments": [ { "Account": { "AccountID": "00000000-0000-0000-000-000000000000" }, "Reference": "ref", "Date": "2018-08-01", "Payments": [ { "Account": { "Code": "001" }, "Date": "2019-12-31", "Amount": 500, "Invoice": { "InvoiceID": "00000000-0000-0000-000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" } } ] } ] } # BatchPayments | BatchPayments with an array of Payments in body of request +batch_payments = { "BatchPayments": [ { "Account": { "AccountID": "00000000-0000-0000-0000-000000000000" }, "Reference": "ref", "Date": "2018-08-01", "Payments": [ { "Account": { "Code": "001" }, "Date": "2019-12-31", "Amount": 500, "Invoice": { "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" } } ] } ] } # BatchPayments | BatchPayments with an array of Payments in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: - # Create one or many BatchPayments for invoices + # Creates one or many batch payments for invoices api_response = api_instance.create_batch_payment(xero_tenant_id, batch_payments, summarize_errors=summarize_errors) pprint(api_response) except ApiException as e: @@ -821,7 +821,7 @@ Name | Type | Description | Notes # **create_batch_payment_history_record** > HistoryRecords create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records) -Allows you to create a history record for a Batch Payment +Creates a history record for a specific batch payment ### Example @@ -850,10 +850,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -batch_payment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for BatchPayment +batch_payment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for BatchPayment history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to create a history record for a Batch Payment + # Creates a history record for a specific batch payment api_response = api_instance.create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records) pprint(api_response) except ApiException as e: @@ -886,7 +886,7 @@ Name | Type | Description | Notes # **create_branding_theme_payment_services** > PaymentServices create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_service) -Allow for the creation of new custom payment service for specified Branding Theme +Creates a new custom payment service for a specific branding theme ### Example @@ -915,10 +915,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -branding_theme_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Branding Theme +branding_theme_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Branding Theme payment_service = { "PaymentServiceID": "00000000-0000-0000-0000-000000000000", "PaymentServiceName": "ACME Payments", "PaymentServiceUrl": "https://www.payupnow.com/", "PayNowText": "Pay Now" } # PaymentService | PaymentService object in body of request try: - # Allow for the creation of new custom payment service for specified Branding Theme + # Creates a new custom payment service for a specific branding theme api_response = api_instance.create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_service) pprint(api_response) except ApiException as e: @@ -980,7 +980,7 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact +contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact file_name = 'xero-dev.jpg' # str | Name for the file you are attaching body = 'body_example' # str | Byte array of file in body of request try: @@ -1017,7 +1017,7 @@ Name | Type | Description | Notes # **create_contact_group** > ContactGroups create_contact_group(xero_tenant_id, contact_groups) -Allows you to create a contact group +Creates a contact group ### Example @@ -1048,7 +1048,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant contact_groups = { "ContactGroups": [{ "Name": "VIPs" }]} # ContactGroups | ContactGroups with an array of names in request body try: - # Allows you to create a contact group + # Creates a contact group api_response = api_instance.create_contact_group(xero_tenant_id, contact_groups) pprint(api_response) except ApiException as e: @@ -1080,7 +1080,7 @@ Name | Type | Description | Notes # **create_contact_group_contacts** > Contacts create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts) -Allows you to add Contacts to a Contact Group +Creates contacts to a specific contact group ### Example @@ -1109,10 +1109,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_group_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact Group -contacts = { "Contacts": [ { "ContactID": "a3675fc4-f8dd-4f03-ba5b-f1870566bcd7" }, { "ContactID": "4e1753b9-018a-4775-b6aa-1bc7871cfee3" } ] } # Contacts | Contacts with array of contacts specifiying the ContactID to be added to ContactGroup in body of request +contact_group_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact Group +contacts = { "Contacts": [ { "ContactID": "a3675fc4-f8dd-4f03-ba5b-f1870566bcd7" }, { "ContactID": "4e1753b9-018a-4775-b6aa-1bc7871cfee3" } ] } # Contacts | Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request try: - # Allows you to add Contacts to a Contact Group + # Creates contacts to a specific contact group api_response = api_instance.create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts) pprint(api_response) except ApiException as e: @@ -1125,7 +1125,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **contact_group_id** | [**str**](.md)| Unique identifier for a Contact Group | - **contacts** | [**Contacts**](Contacts.md)| Contacts with array of contacts specifiying the ContactID to be added to ContactGroup in body of request | + **contacts** | [**Contacts**](Contacts.md)| Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request | ### Return type @@ -1145,7 +1145,7 @@ Name | Type | Description | Notes # **create_contact_history** > HistoryRecords create_contact_history(xero_tenant_id, contact_id, history_records) -Allows you to retrieve a history records of an Contact +Creates a new history record for a specific contact ### Example @@ -1174,10 +1174,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact +contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to retrieve a history records of an Contact + # Creates a new history record for a specific contact api_response = api_instance.create_contact_history(xero_tenant_id, contact_id, history_records) pprint(api_response) except ApiException as e: @@ -1210,7 +1210,7 @@ Name | Type | Description | Notes # **create_contacts** > Contacts create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors) -Allows you to create a multiple contacts (bulk) in a Xero organisation +Creates multiple contacts (bulk) in a Xero organisation ### Example @@ -1242,7 +1242,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant contacts = { "Id": "e997d6d7-6dad-4458-beb8-d9c1bf7f2edf", "Status": "OK", "ProviderName": "Xero API Partner", "DateTimeUTC": "/Date(1551399321121)/", "Contacts": [ { "ContactID": "3ff6d40c-af9a-40a3-89ce-3c1556a25591", "ContactStatus": "ACTIVE", "Name": "Foo9987", "EmailAddress": "sid32476@blah.com", "BankAccountDetails": "", "Addresses": [ { "AddressType": "STREET", "City": "", "Region": "", "PostalCode": "", "Country": "" }, { "AddressType": "POBOX", "City": "", "Region": "", "PostalCode": "", "Country": "" } ], "Phones": [ { "PhoneType": "DEFAULT", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "DDI", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "FAX", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "MOBILE", "PhoneNumber": "555-1212", "PhoneAreaCode": "415", "PhoneCountryCode": "" } ], "UpdatedDateUTC": "/Date(1551399321043+0000)/", "ContactGroups": [], "IsSupplier": false, "IsCustomer": false, "SalesTrackingCategories": [], "PurchasesTrackingCategories": [], "PaymentTerms": { "Bills": { "Day": 15, "Type": "OFCURRENTMONTH" }, "Sales": { "Day": 10, "Type": "DAYSAFTERBILLMONTH" } }, "ContactPersons": [], "HasValidationErrors": false } ] } # Contacts | Contacts with an array of Contact objects to create in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: - # Allows you to create a multiple contacts (bulk) in a Xero organisation + # Creates multiple contacts (bulk) in a Xero organisation api_response = api_instance.create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors) pprint(api_response) except ApiException as e: @@ -1275,7 +1275,7 @@ Name | Type | Description | Notes # **create_credit_note_allocation** > Allocations create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, summarize_errors=summarize_errors) -Allows you to create Allocation on CreditNote +Creates allocation for a specific credit note ### Example @@ -1304,11 +1304,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Credit Note +credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note allocations = { "Allocations": [ { "Invoice": { "LineItems": [], "InvoiceID": "c45720a1-ade3-4a38-a064-d15489be6841" }, "Amount": 1, "Date": "2019-03-05" } ] } # Allocations | Allocations with array of Allocation object in body of request. summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: - # Allows you to create Allocation on CreditNote + # Creates allocation for a specific credit note api_response = api_instance.create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, summarize_errors=summarize_errors) pprint(api_response) except ApiException as e: @@ -1342,7 +1342,7 @@ Name | Type | Description | Notes # **create_credit_note_attachment_by_file_name** > Attachments create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, include_online=include_online) -Allows you to create Attachments on CreditNote by file name +Creates an attachment for a specific credit note ### Example @@ -1371,12 +1371,12 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Credit Note +credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note file_name = 'xero-dev.jpg' # str | Name of the file you are attaching to Credit Note body = 'body_example' # str | Byte array of file in body of request include_online = False # bool | Allows an attachment to be seen by the end customer within their online invoice (optional) (default to False) try: - # Allows you to create Attachments on CreditNote by file name + # Creates an attachment for a specific credit note api_response = api_instance.create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, include_online=include_online) pprint(api_response) except ApiException as e: @@ -1411,7 +1411,7 @@ Name | Type | Description | Notes # **create_credit_note_history** > HistoryRecords create_credit_note_history(xero_tenant_id, credit_note_id, history_records) -Allows you to retrieve a history records of an CreditNote +Retrieves history records of a specific credit note ### Example @@ -1440,10 +1440,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Credit Note +credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to retrieve a history records of an CreditNote + # Retrieves history records of a specific credit note api_response = api_instance.create_credit_note_history(xero_tenant_id, credit_note_id, history_records) pprint(api_response) except ApiException as e: @@ -1476,7 +1476,7 @@ Name | Type | Description | Notes # **create_credit_notes** > CreditNotes create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp) -Allows you to create a credit note +Creates a new credit note ### Example @@ -1509,7 +1509,7 @@ credit_notes = { "CreditNotes":[ { "Type":"ACCPAYCREDIT", "Contact":{ "ContactID summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to create a credit note + # Creates a new credit note api_response = api_instance.create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -1543,7 +1543,7 @@ Name | Type | Description | Notes # **create_currency** > Currencies create_currency(xero_tenant_id, currency) -Allows you to create a new currency for an org +Create a new currency for a Xero organisation ### Example @@ -1572,9 +1572,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -currency = { "Code": "USD", "Description": "United States Dollar" } # Currency | Currency obejct in the body of request +currency = { "Code": "USD", "Description": "United States Dollar" } # Currency | Currency object in the body of request try: - # Allows you to create a new currency for an org + # Create a new currency for a Xero organisation api_response = api_instance.create_currency(xero_tenant_id, currency) pprint(api_response) except ApiException as e: @@ -1586,7 +1586,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **currency** | [**Currency**](Currency.md)| Currency obejct in the body of request | + **currency** | [**Currency**](Currency.md)| Currency object in the body of request | ### Return type @@ -1606,7 +1606,7 @@ Name | Type | Description | Notes # **create_employees** > Employees create_employees(xero_tenant_id, employees, summarize_errors=summarize_errors) -Allows you to create new employees used in Xero payrun +Creates new employees used in Xero payrun ### Example @@ -1638,7 +1638,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant employees = { "Employees": [ { "FirstName": "Nick", "LastName": "Fury", "ExternalLink": { "Url": "http://twitter.com/#!/search/Nick+Fury" } } ] } # Employees | Employees with array of Employee object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: - # Allows you to create new employees used in Xero payrun + # Creates new employees used in Xero payrun api_response = api_instance.create_employees(xero_tenant_id, employees, summarize_errors=summarize_errors) pprint(api_response) except ApiException as e: @@ -1671,7 +1671,7 @@ Name | Type | Description | Notes # **create_expense_claim_history** > HistoryRecords create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records) -Allows you to create a history records of an ExpenseClaim +Creates a history record for a specific expense claim ### Example @@ -1700,10 +1700,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -expense_claim_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a ExpenseClaim +expense_claim_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ExpenseClaim history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to create a history records of an ExpenseClaim + # Creates a history record for a specific expense claim api_response = api_instance.create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records) pprint(api_response) except ApiException as e: @@ -1736,7 +1736,7 @@ Name | Type | Description | Notes # **create_expense_claims** > ExpenseClaims create_expense_claims(xero_tenant_id, expense_claims) -Allows you to retrieve expense claims +Creates expense claims ### Example @@ -1767,7 +1767,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant expense_claims = { "ExpenseClaims": [ { "Status": "SUBMITTED", "User": { "UserID": "d1164823-0ac1-41ad-987b-b4e30fe0b273" }, "Receipts": [ { "Lineitems": [], "ReceiptID": "dc1c7f6d-0a4c-402f-acac-551d62ce5816" } ] } ] } # ExpenseClaims | ExpenseClaims with array of ExpenseClaim object in body of request try: - # Allows you to retrieve expense claims + # Creates expense claims api_response = api_instance.create_expense_claims(xero_tenant_id, expense_claims) pprint(api_response) except ApiException as e: @@ -1799,7 +1799,7 @@ Name | Type | Description | Notes # **create_invoice_attachment_by_file_name** > Attachments create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, include_online=include_online) -Allows you to create an Attachment on invoices or purchase bills by it's filename +Creates an attachment for a specific invoice or purchase bill by filename ### Example @@ -1828,12 +1828,12 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Invoice +invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice file_name = 'xero-dev.jpg' # str | Name of the file you are attaching body = 'body_example' # str | Byte array of file in body of request include_online = False # bool | Allows an attachment to be seen by the end customer within their online invoice (optional) (default to False) try: - # Allows you to create an Attachment on invoices or purchase bills by it's filename + # Creates an attachment for a specific invoice or purchase bill by filename api_response = api_instance.create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, include_online=include_online) pprint(api_response) except ApiException as e: @@ -1868,7 +1868,7 @@ Name | Type | Description | Notes # **create_invoice_history** > HistoryRecords create_invoice_history(xero_tenant_id, invoice_id, history_records) -Allows you to retrieve a history records of an invoice +Creates a history record for a specific invoice ### Example @@ -1897,10 +1897,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Invoice +invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to retrieve a history records of an invoice + # Creates a history record for a specific invoice api_response = api_instance.create_invoice_history(xero_tenant_id, invoice_id, history_records) pprint(api_response) except ApiException as e: @@ -1933,7 +1933,7 @@ Name | Type | Description | Notes # **create_invoices** > Invoices create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp) -Allows you to create one or more sales invoices or purchase bills +Creates one or more sales invoices or purchase bills ### Example @@ -1966,7 +1966,7 @@ invoices = { "Invoices": [ { "Type": "ACCREC", "Contact": { "ContactID": "430fa1 summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to create one or more sales invoices or purchase bills + # Creates one or more sales invoices or purchase bills api_response = api_instance.create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -2000,7 +2000,7 @@ Name | Type | Description | Notes # **create_item_history** > HistoryRecords create_item_history(xero_tenant_id, item_id, history_records) -Allows you to create a history record for items +Creates a history record for a specific item ### Example @@ -2029,10 +2029,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -item_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Item +item_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Item history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to create a history record for items + # Creates a history record for a specific item api_response = api_instance.create_item_history(xero_tenant_id, item_id, history_records) pprint(api_response) except ApiException as e: @@ -2065,7 +2065,7 @@ Name | Type | Description | Notes # **create_items** > Items create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp) -Allows you to create one or more items +Creates one or more items ### Example @@ -2098,7 +2098,7 @@ items = { "Items": [ { "Code": "code123", "Name": "Item Name XYZ", "Description" summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to create one or more items + # Creates one or more items api_response = api_instance.create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -2132,7 +2132,7 @@ Name | Type | Description | Notes # **create_linked_transaction** > LinkedTransactions create_linked_transaction(xero_tenant_id, linked_transaction) -Allows you to create linked transactions (billable expenses) +Creates linked transactions (billable expenses) ### Example @@ -2163,7 +2163,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant linked_transaction = { "LinkedTransactions": [ { "SourceTransactionID": "a848644a-f20f-4630-98c3-386bd7505631", "SourceLineItemID": "b0df260d-3cc8-4ced-9bd6-41924f624ed3" } ] } # LinkedTransaction | LinkedTransaction object in body of request try: - # Allows you to create linked transactions (billable expenses) + # Creates linked transactions (billable expenses) api_response = api_instance.create_linked_transaction(xero_tenant_id, linked_transaction) pprint(api_response) except ApiException as e: @@ -2195,7 +2195,7 @@ Name | Type | Description | Notes # **create_manual_journal_attachment_by_file_name** > Attachments create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) -Allows you to create a specified Attachment on ManualJournal by file name +Creates a specific attachment for a specific manual journal by file name ### Example @@ -2224,11 +2224,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a ManualJournal +manual_journal_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ManualJournal file_name = 'xero-dev.jpg' # str | The name of the file being attached to a ManualJournal body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to create a specified Attachment on ManualJournal by file name + # Creates a specific attachment for a specific manual journal by file name api_response = api_instance.create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) pprint(api_response) except ApiException as e: @@ -2262,7 +2262,7 @@ Name | Type | Description | Notes # **create_manual_journal_history_record** > HistoryRecords create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records) -Allows you to create history record for a manual journal +Creates a history record for a specific manual journal ### Example @@ -2291,10 +2291,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a manual journal +manual_journal_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a manual journal history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to create history record for a manual journal + # Creates a history record for a specific manual journal api_response = api_instance.create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records) pprint(api_response) except ApiException as e: @@ -2327,7 +2327,7 @@ Name | Type | Description | Notes # **create_manual_journals** > ManualJournals create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors) -Allows you to create one or more manual journals +Creates one or more manual journals ### Example @@ -2359,7 +2359,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant manual_journals = { "ManualJournals": [ { "Narration": "Journal Desc", "JournalLines": [ { "LineAmount": 100, "AccountCode": "400", "Description": "Money Movement" }, { "LineAmount": -100, "AccountCode": "400", "Description": "Prepayment of things", "Tracking": [ { "Name": "North", "Option": "Region" } ] } ], "Date": "2019-03-14" } ] } # ManualJournals | ManualJournals array with ManualJournal object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: - # Allows you to create one or more manual journals + # Creates one or more manual journals api_response = api_instance.create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors) pprint(api_response) except ApiException as e: @@ -2392,7 +2392,7 @@ Name | Type | Description | Notes # **create_overpayment_allocations** > Allocations create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, summarize_errors=summarize_errors) -Allows you to create a single allocation for an overpayment +Creates a single allocation for a specific overpayment ### Example @@ -2421,11 +2421,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -overpayment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Overpayment -allocations = { "Allocations": [ { "Invoice": { "InvoiceID": "00000000-0000-0000-000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }, "Amount": 10.00, "Date": "2019-03-12" } ] } # Allocations | Allocations array with Allocation object in body of request +overpayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Overpayment +allocations = { "Allocations": [ { "Invoice": { "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }, "Amount": 10.00, "Date": "2019-03-12" } ] } # Allocations | Allocations array with Allocation object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: - # Allows you to create a single allocation for an overpayment + # Creates a single allocation for a specific overpayment api_response = api_instance.create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, summarize_errors=summarize_errors) pprint(api_response) except ApiException as e: @@ -2459,7 +2459,7 @@ Name | Type | Description | Notes # **create_overpayment_history** > HistoryRecords create_overpayment_history(xero_tenant_id, overpayment_id, history_records) -Allows you to create history records of an Overpayment +Creates a history record for a specific overpayment ### Example @@ -2488,10 +2488,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -overpayment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Overpayment +overpayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Overpayment history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to create history records of an Overpayment + # Creates a history record for a specific overpayment api_response = api_instance.create_overpayment_history(xero_tenant_id, overpayment_id, history_records) pprint(api_response) except ApiException as e: @@ -2524,7 +2524,7 @@ Name | Type | Description | Notes # **create_payment** > Payments create_payment(xero_tenant_id, payment) -Allows you to create a single payment for invoices or credit notes +Creates a single payment for invoice or credit notes ### Example @@ -2553,9 +2553,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -payment = { "Payments": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-000-000000000000" }, "Account": { "Code": "970" }, "Date": "2019-03-12", "Amount": 1 } ] } # Payment | Request body with a single Payment object +payment = { "Payments": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-0000-000000000000" }, "Account": { "Code": "970" }, "Date": "2019-03-12", "Amount": 1 } ] } # Payment | Request body with a single Payment object try: - # Allows you to create a single payment for invoices or credit notes + # Creates a single payment for invoice or credit notes api_response = api_instance.create_payment(xero_tenant_id, payment) pprint(api_response) except ApiException as e: @@ -2587,7 +2587,7 @@ Name | Type | Description | Notes # **create_payment_history** > HistoryRecords create_payment_history(xero_tenant_id, payment_id, history_records) -Allows you to create a history record for a payment +Creates a history record for a specific payment ### Example @@ -2616,10 +2616,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -payment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Payment +payment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Payment history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to create a history record for a payment + # Creates a history record for a specific payment api_response = api_instance.create_payment_history(xero_tenant_id, payment_id, history_records) pprint(api_response) except ApiException as e: @@ -2652,7 +2652,7 @@ Name | Type | Description | Notes # **create_payment_service** > PaymentServices create_payment_service(xero_tenant_id, payment_services) -Allows you to create payment services +Creates a payment service ### Example @@ -2683,7 +2683,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant payment_services = { "PaymentServices": [ { "PaymentServiceName": "PayUpNow", "PaymentServiceUrl": "https://www.payupnow.com/", "PayNowText": "Time To Pay" } ] } # PaymentServices | PaymentServices array with PaymentService object in body of request try: - # Allows you to create payment services + # Creates a payment service api_response = api_instance.create_payment_service(xero_tenant_id, payment_services) pprint(api_response) except ApiException as e: @@ -2715,7 +2715,7 @@ Name | Type | Description | Notes # **create_payments** > Payments create_payments(xero_tenant_id, payments, summarize_errors=summarize_errors) -Allows you to create multiple payments for invoices or credit notes +Creates multiple payments for invoices or credit notes ### Example @@ -2744,10 +2744,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -payments = { "Payments": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-000-000000000000" }, "Account": { "Code": "970" }, "Date": "2019-03-12", "Amount": 1 } ] } # Payments | Payments array with Payment object in body of request +payments = { "Payments": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-0000-000000000000" }, "Account": { "Code": "970" }, "Date": "2019-03-12", "Amount": 1 } ] } # Payments | Payments array with Payment object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: - # Allows you to create multiple payments for invoices or credit notes + # Creates multiple payments for invoices or credit notes api_response = api_instance.create_payments(xero_tenant_id, payments, summarize_errors=summarize_errors) pprint(api_response) except ApiException as e: @@ -2809,8 +2809,8 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -prepayment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Prepayment -allocations = { "Allocations": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-000-000000000000" }, "Amount": 1, "Date": "2019-01-10" } ] } # Allocations | Allocations with an array of Allocation object in body of request +prepayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Prepayment +allocations = { "Allocations": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-0000-000000000000" }, "Amount": 1, "Date": "2019-01-10" } ] } # Allocations | Allocations with an array of Allocation object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: # Allows you to create an Allocation for prepayments @@ -2847,7 +2847,7 @@ Name | Type | Description | Notes # **create_prepayment_history** > HistoryRecords create_prepayment_history(xero_tenant_id, prepayment_id, history_records) -Allows you to create a history record for an Prepayment +Creates a history record for a specific prepayment ### Example @@ -2876,10 +2876,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -prepayment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a PrePayment +prepayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a PrePayment history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to create a history record for an Prepayment + # Creates a history record for a specific prepayment api_response = api_instance.create_prepayment_history(xero_tenant_id, prepayment_id, history_records) pprint(api_response) except ApiException as e: @@ -2912,7 +2912,7 @@ Name | Type | Description | Notes # **create_purchase_order_attachment_by_file_name** > Attachments create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) -Allows you to create Attachment on Purchase Order +Creates attachment for a specific purchase order ### Example @@ -2941,11 +2941,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Purchase Order object +purchase_order_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Purchase Order object file_name = 'xero-dev.png' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to create Attachment on Purchase Order + # Creates attachment for a specific purchase order api_response = api_instance.create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) pprint(api_response) except ApiException as e: @@ -2979,7 +2979,7 @@ Name | Type | Description | Notes # **create_purchase_order_history** > HistoryRecords create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records) -Allows you to create HistoryRecord for purchase orders +Creates a history record for a specific purchase orders ### Example @@ -3008,10 +3008,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a PurchaseOrder +purchase_order_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a PurchaseOrder history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to create HistoryRecord for purchase orders + # Creates a history record for a specific purchase orders api_response = api_instance.create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records) pprint(api_response) except ApiException as e: @@ -3044,7 +3044,7 @@ Name | Type | Description | Notes # **create_purchase_orders** > PurchaseOrders create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors) -Allows you to create one or more purchase orders +Creates one or more purchase orders ### Example @@ -3073,10 +3073,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -purchase_orders = { "PurchaseOrders": [ { "Contact": { "ContactID": "00000000-0000-0000-000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "710" } ], "Date": "2019-03-13" } ] } # PurchaseOrders | PurchaseOrders with an array of PurchaseOrder object in body of request +purchase_orders = { "PurchaseOrders": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "710" } ], "Date": "2019-03-13" } ] } # PurchaseOrders | PurchaseOrders with an array of PurchaseOrder object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: - # Allows you to create one or more purchase orders + # Creates one or more purchase orders api_response = api_instance.create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors) pprint(api_response) except ApiException as e: @@ -3109,7 +3109,7 @@ Name | Type | Description | Notes # **create_quote_attachment_by_file_name** > Attachments create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) -Allows you to create Attachment on Quote +Creates attachment for a specific quote ### Example @@ -3138,11 +3138,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -quote_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Quote object +quote_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Quote object file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to create Attachment on Quote + # Creates attachment for a specific quote api_response = api_instance.create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) pprint(api_response) except ApiException as e: @@ -3176,7 +3176,7 @@ Name | Type | Description | Notes # **create_quote_history** > HistoryRecords create_quote_history(xero_tenant_id, quote_id, history_records) -Allows you to retrieve a history records of an quote +Creates a history record for a specific quote ### Example @@ -3205,10 +3205,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -quote_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Quote +quote_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Quote history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to retrieve a history records of an quote + # Creates a history record for a specific quote api_response = api_instance.create_quote_history(xero_tenant_id, quote_id, history_records) pprint(api_response) except ApiException as e: @@ -3241,7 +3241,7 @@ Name | Type | Description | Notes # **create_quotes** > Quotes create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors) -Allows you to create one or more quotes +Create one or more quotes ### Example @@ -3270,10 +3270,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -quotes = { "Quotes": [ { "Contact": { "ContactID": "00000000-0000-0000-000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "12775" } ], "Date": "2020-02-01" } ] } # Quotes | Quotes with an array of Quote object in body of request +quotes = { "Quotes": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "12775" } ], "Date": "2020-02-01" } ] } # Quotes | Quotes with an array of Quote object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: - # Allows you to create one or more quotes + # Create one or more quotes api_response = api_instance.create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors) pprint(api_response) except ApiException as e: @@ -3306,7 +3306,7 @@ Name | Type | Description | Notes # **create_receipt** > Receipts create_receipt(xero_tenant_id, receipts, unitdp=unitdp) -Allows you to create draft expense claim receipts for any user +Creates draft expense claim receipts for any user ### Example @@ -3335,10 +3335,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -receipts = { "Receipts": [ { "Contact": { "ContactID": "00000000-0000-0000-000-000000000000" }, "Lineitems": [ { "Description": "Foobar", "Quantity": 2, "UnitAmount": 20, "AccountCode": "400", "TaxType": "NONE", "LineAmount": 40 } ], "User": { "UserID": "00000000-0000-0000-000-000000000000" }, "LineAmountTypes": "NoTax", "Status": "DRAFT" } ] } # Receipts | Receipts with an array of Receipt object in body of request +receipts = { "Receipts": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "Lineitems": [ { "Description": "Foobar", "Quantity": 2, "UnitAmount": 20, "AccountCode": "400", "TaxType": "NONE", "LineAmount": 40 } ], "User": { "UserID": "00000000-0000-0000-0000-000000000000" }, "LineAmountTypes": "NoTax", "Status": "DRAFT" } ] } # Receipts | Receipts with an array of Receipt object in body of request unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to create draft expense claim receipts for any user + # Creates draft expense claim receipts for any user api_response = api_instance.create_receipt(xero_tenant_id, receipts, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -3371,7 +3371,7 @@ Name | Type | Description | Notes # **create_receipt_attachment_by_file_name** > Attachments create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) -Allows you to create Attachment on expense claim receipts by file name +Creates an attachment on a specific expense claim receipts by file name ### Example @@ -3400,11 +3400,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Receipt +receipt_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Receipt file_name = 'xero-dev.jpg' # str | The name of the file being attached to the Receipt body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to create Attachment on expense claim receipts by file name + # Creates an attachment on a specific expense claim receipts by file name api_response = api_instance.create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) pprint(api_response) except ApiException as e: @@ -3438,7 +3438,7 @@ Name | Type | Description | Notes # **create_receipt_history** > HistoryRecords create_receipt_history(xero_tenant_id, receipt_id, history_records) -Allows you to retrieve a history records of an Receipt +Creates a history record for a specific receipt ### Example @@ -3467,10 +3467,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Receipt +receipt_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Receipt history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to retrieve a history records of an Receipt + # Creates a history record for a specific receipt api_response = api_instance.create_receipt_history(xero_tenant_id, receipt_id, history_records) pprint(api_response) except ApiException as e: @@ -3503,7 +3503,7 @@ Name | Type | Description | Notes # **create_repeating_invoice_attachment_by_file_name** > Attachments create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) -Allows you to create attachment on repeating invoices by file name +Creates an attachment from a specific repeating invoices by file name ### Example @@ -3532,11 +3532,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Repeating Invoice +repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Repeating Invoice file_name = 'xero-dev.jpg' # str | The name of the file being attached to a Repeating Invoice body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to create attachment on repeating invoices by file name + # Creates an attachment from a specific repeating invoices by file name api_response = api_instance.create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) pprint(api_response) except ApiException as e: @@ -3570,7 +3570,7 @@ Name | Type | Description | Notes # **create_repeating_invoice_history** > HistoryRecords create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records) -Allows you to create history for a repeating invoice +Creates a history record for a specific repeating invoice ### Example @@ -3599,10 +3599,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Repeating Invoice +repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Repeating Invoice history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request try: - # Allows you to create history for a repeating invoice + # Creates a history record for a specific repeating invoice api_response = api_instance.create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records) pprint(api_response) except ApiException as e: @@ -3635,7 +3635,7 @@ Name | Type | Description | Notes # **create_tax_rates** > TaxRates create_tax_rates(xero_tenant_id, tax_rates) -Allows you to create one or more Tax Rates +Creates one or more tax rates ### Example @@ -3666,7 +3666,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant tax_rates = { "TaxRates": [ { "Name": "CA State Tax", "TaxComponents": [ { "Name": "State Tax", "Rate": 2.25 } ] } ] } # TaxRates | TaxRates array with TaxRate object in body of request try: - # Allows you to create one or more Tax Rates + # Creates one or more tax rates api_response = api_instance.create_tax_rates(xero_tenant_id, tax_rates) pprint(api_response) except ApiException as e: @@ -3698,7 +3698,7 @@ Name | Type | Description | Notes # **create_tracking_category** > TrackingCategories create_tracking_category(xero_tenant_id, tracking_category) -Allows you to create tracking categories +Create tracking categories ### Example @@ -3729,7 +3729,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant tracking_category = { name: "FooBar" } # TrackingCategory | TrackingCategory object in body of request try: - # Allows you to create tracking categories + # Create tracking categories api_response = api_instance.create_tracking_category(xero_tenant_id, tracking_category) pprint(api_response) except ApiException as e: @@ -3761,7 +3761,7 @@ Name | Type | Description | Notes # **create_tracking_options** > TrackingOptions create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option) -Allows you to create options for a specified tracking category +Creates options for a specific tracking category ### Example @@ -3790,10 +3790,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -tracking_category_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a TrackingCategory +tracking_category_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a TrackingCategory tracking_option = { name: " Bar" } # TrackingOption | TrackingOption object in body of request try: - # Allows you to create options for a specified tracking category + # Creates options for a specific tracking category api_response = api_instance.create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option) pprint(api_response) except ApiException as e: @@ -3826,7 +3826,7 @@ Name | Type | Description | Notes # **delete_account** > Accounts delete_account(xero_tenant_id, account_id) -Allows you to delete a chart of accounts +Deletes a chart of accounts ### Example @@ -3855,9 +3855,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -account_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for retrieving single object +account_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for retrieving single object try: - # Allows you to delete a chart of accounts + # Deletes a chart of accounts api_response = api_instance.delete_account(xero_tenant_id, account_id) pprint(api_response) except ApiException as e: @@ -3889,7 +3889,7 @@ Name | Type | Description | Notes # **delete_contact_group_contact** > delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id) -Allows you to delete a specific Contact from a Contact Group +Deletes a specific contact from a contact group using a unique contact Id ### Example @@ -3918,10 +3918,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_group_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact Group -contact_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact +contact_group_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact Group +contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact try: - # Allows you to delete a specific Contact from a Contact Group + # Deletes a specific contact from a contact group using a unique contact Id api_instance.delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id) except ApiException as e: print("Exception when calling AccountingApi->delete_contact_group_contact: %s\n" % e) @@ -3953,7 +3953,7 @@ void (empty response body) # **delete_contact_group_contacts** > delete_contact_group_contacts(xero_tenant_id, contact_group_id) -Allows you to delete all Contacts from a Contact Group +Deletes all contacts from a specific contact group ### Example @@ -3982,9 +3982,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_group_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact Group +contact_group_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact Group try: - # Allows you to delete all Contacts from a Contact Group + # Deletes all contacts from a specific contact group api_instance.delete_contact_group_contacts(xero_tenant_id, contact_group_id) except ApiException as e: print("Exception when calling AccountingApi->delete_contact_group_contacts: %s\n" % e) @@ -4015,7 +4015,7 @@ void (empty response body) # **delete_item** > delete_item(xero_tenant_id, item_id) -Allows you to delete a specified item +Deletes a specific item ### Example @@ -4044,9 +4044,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -item_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Item +item_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Item try: - # Allows you to delete a specified item + # Deletes a specific item api_instance.delete_item(xero_tenant_id, item_id) except ApiException as e: print("Exception when calling AccountingApi->delete_item: %s\n" % e) @@ -4077,7 +4077,7 @@ void (empty response body) # **delete_linked_transaction** > delete_linked_transaction(xero_tenant_id, linked_transaction_id) -Allows you to delete a specified linked transactions (billable expenses) +Deletes a specific linked transactions (billable expenses) ### Example @@ -4106,9 +4106,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -linked_transaction_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a LinkedTransaction +linked_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a LinkedTransaction try: - # Allows you to delete a specified linked transactions (billable expenses) + # Deletes a specific linked transactions (billable expenses) api_instance.delete_linked_transaction(xero_tenant_id, linked_transaction_id) except ApiException as e: print("Exception when calling AccountingApi->delete_linked_transaction: %s\n" % e) @@ -4139,7 +4139,7 @@ void (empty response body) # **delete_payment** > Payments delete_payment(xero_tenant_id, payment_id, payment_delete) -Allows you to update a specified payment for invoices and credit notes +Updates a specific payment for invoices and credit notes ### Example @@ -4168,10 +4168,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -payment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Payment +payment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Payment payment_delete = { "Payments":[ { "Status":"DELETED" } ] } # PaymentDelete | try: - # Allows you to update a specified payment for invoices and credit notes + # Updates a specific payment for invoices and credit notes api_response = api_instance.delete_payment(xero_tenant_id, payment_id, payment_delete) pprint(api_response) except ApiException as e: @@ -4204,7 +4204,7 @@ Name | Type | Description | Notes # **delete_tracking_category** > TrackingCategories delete_tracking_category(xero_tenant_id, tracking_category_id) -Allows you to delete tracking categories +Deletes a specific tracking category ### Example @@ -4233,9 +4233,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -tracking_category_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a TrackingCategory +tracking_category_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a TrackingCategory try: - # Allows you to delete tracking categories + # Deletes a specific tracking category api_response = api_instance.delete_tracking_category(xero_tenant_id, tracking_category_id) pprint(api_response) except ApiException as e: @@ -4267,7 +4267,7 @@ Name | Type | Description | Notes # **delete_tracking_options** > TrackingOptions delete_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id) -Allows you to delete a specified option for a specified tracking category +Deletes a specific option for a specific tracking category ### Example @@ -4296,10 +4296,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -tracking_category_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a TrackingCategory -tracking_option_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Tracking Option +tracking_category_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a TrackingCategory +tracking_option_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Tracking Option try: - # Allows you to delete a specified option for a specified tracking category + # Deletes a specific option for a specific tracking category api_response = api_instance.delete_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id) pprint(api_response) except ApiException as e: @@ -4332,7 +4332,7 @@ Name | Type | Description | Notes # **email_invoice** > email_invoice(xero_tenant_id, invoice_id, request_empty) -Allows you to email a copy of invoice to related Contact +Sends a copy of a specific invoice to related contact via email ### Example @@ -4361,10 +4361,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Invoice +invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice request_empty = {} # RequestEmpty | try: - # Allows you to email a copy of invoice to related Contact + # Sends a copy of a specific invoice to related contact via email api_instance.email_invoice(xero_tenant_id, invoice_id, request_empty) except ApiException as e: print("Exception when calling AccountingApi->email_invoice: %s\n" % e) @@ -4396,7 +4396,7 @@ void (empty response body) # **get_account** > Accounts get_account(xero_tenant_id, account_id) -Allows you to retrieve a single chart of accounts +Retrieves a single chart of accounts by using a unique account Id ### Example @@ -4425,9 +4425,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -account_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for retrieving single object +account_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for retrieving single object try: - # Allows you to retrieve a single chart of accounts + # Retrieves a single chart of accounts by using a unique account Id api_response = api_instance.get_account(xero_tenant_id, account_id) pprint(api_response) except ApiException as e: @@ -4459,7 +4459,7 @@ Name | Type | Description | Notes # **get_account_attachment_by_file_name** > file get_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, content_type) -Allows you to retrieve Attachment on Account by Filename +Retrieves an attachment for a specific account by filename ### Example @@ -4488,11 +4488,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -account_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Account object +account_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Account object file_name = 'xero-dev.jpg' # str | Name of the attachment content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve Attachment on Account by Filename + # Retrieves an attachment for a specific account by filename api_response = api_instance.get_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, content_type) pprint(api_response) except ApiException as e: @@ -4526,7 +4526,7 @@ Name | Type | Description | Notes # **get_account_attachment_by_id** > file get_account_attachment_by_id(xero_tenant_id, account_id, attachment_id, content_type) -Allows you to retrieve specific Attachment on Account +Retrieves a specific attachment from a specific account using a unique attachment Id ### Example @@ -4555,11 +4555,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -account_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Account object -attachment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Attachment object +account_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Account object +attachment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Attachment object content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve specific Attachment on Account + # Retrieves a specific attachment from a specific account using a unique attachment Id api_response = api_instance.get_account_attachment_by_id(xero_tenant_id, account_id, attachment_id, content_type) pprint(api_response) except ApiException as e: @@ -4593,7 +4593,7 @@ Name | Type | Description | Notes # **get_account_attachments** > Attachments get_account_attachments(xero_tenant_id, account_id) -Allows you to retrieve Attachments for accounts +Retrieves attachments for a specific accounts by using a unique account Id ### Example @@ -4622,9 +4622,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -account_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Account object +account_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Account object try: - # Allows you to retrieve Attachments for accounts + # Retrieves attachments for a specific accounts by using a unique account Id api_response = api_instance.get_account_attachments(xero_tenant_id, account_id) pprint(api_response) except ApiException as e: @@ -4656,7 +4656,7 @@ Name | Type | Description | Notes # **get_accounts** > Accounts get_accounts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) -Allows you to retrieve the full chart of accounts +Retrieves the full chart of accounts ### Example @@ -4689,7 +4689,7 @@ if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records cr where = 'Status=="ACTIVE" AND Type=="BANK"' # str | Filter by an any element (optional) order = 'Name ASC' # str | Order by an any element (optional) try: - # Allows you to retrieve the full chart of accounts + # Retrieves the full chart of accounts api_response = api_instance.get_accounts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) pprint(api_response) except ApiException as e: @@ -4723,7 +4723,7 @@ Name | Type | Description | Notes # **get_bank_transaction** > BankTransactions get_bank_transaction(xero_tenant_id, bank_transaction_id, unitdp=unitdp) -Allows you to retrieve a single spend or receive money transaction +Retrieves a single spent or received money transaction by using a unique bank transaction Id ### Example @@ -4752,10 +4752,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transaction +bank_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transaction unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to retrieve a single spend or receive money transaction + # Retrieves a single spent or received money transaction by using a unique bank transaction Id api_response = api_instance.get_bank_transaction(xero_tenant_id, bank_transaction_id, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -4788,7 +4788,7 @@ Name | Type | Description | Notes # **get_bank_transaction_attachment_by_file_name** > file get_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, content_type) -Allows you to retrieve Attachments on BankTransaction by Filename +Retrieves a specific attachment from a specific bank transaction by filename ### Example @@ -4817,11 +4817,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transaction +bank_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transaction file_name = 'xero-dev.jpg' # str | The name of the file being attached content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve Attachments on BankTransaction by Filename + # Retrieves a specific attachment from a specific bank transaction by filename api_response = api_instance.get_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, content_type) pprint(api_response) except ApiException as e: @@ -4855,7 +4855,7 @@ Name | Type | Description | Notes # **get_bank_transaction_attachment_by_id** > file get_bank_transaction_attachment_by_id(xero_tenant_id, bank_transaction_id, attachment_id, content_type) -Allows you to retrieve Attachments on a specific BankTransaction +Retrieves specific attachments from a specific BankTransaction using a unique attachment Id ### Example @@ -4884,11 +4884,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transaction -attachment_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for an attachment +bank_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transaction +attachment_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for an attachment content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve Attachments on a specific BankTransaction + # Retrieves specific attachments from a specific BankTransaction using a unique attachment Id api_response = api_instance.get_bank_transaction_attachment_by_id(xero_tenant_id, bank_transaction_id, attachment_id, content_type) pprint(api_response) except ApiException as e: @@ -4922,7 +4922,7 @@ Name | Type | Description | Notes # **get_bank_transaction_attachments** > Attachments get_bank_transaction_attachments(xero_tenant_id, bank_transaction_id) -Allows you to retrieve any attachments to bank transactions +Retrieves any attachments from a specific bank transactions ### Example @@ -4951,9 +4951,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transaction +bank_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transaction try: - # Allows you to retrieve any attachments to bank transactions + # Retrieves any attachments from a specific bank transactions api_response = api_instance.get_bank_transaction_attachments(xero_tenant_id, bank_transaction_id) pprint(api_response) except ApiException as e: @@ -4985,7 +4985,7 @@ Name | Type | Description | Notes # **get_bank_transactions** > BankTransactions get_bank_transactions(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) -Allows you to retrieve any spend or receive money transactions +Retrieves any spent or received money transactions ### Example @@ -5020,7 +5020,7 @@ order = 'Type ASC' # str | Order by an any element (optional) page = 1 # int | Up to 100 bank transactions will be returned in a single API call with line items details (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to retrieve any spend or receive money transactions + # Retrieves any spent or received money transactions api_response = api_instance.get_bank_transactions(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -5056,7 +5056,7 @@ Name | Type | Description | Notes # **get_bank_transactions_history** > HistoryRecords get_bank_transactions_history(xero_tenant_id, bank_transaction_id) -Allows you to retrieve history from a bank transactions +Retrieves history from a specific bank transaction using a unique bank transaction Id ### Example @@ -5085,9 +5085,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transaction +bank_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transaction try: - # Allows you to retrieve history from a bank transactions + # Retrieves history from a specific bank transaction using a unique bank transaction Id api_response = api_instance.get_bank_transactions_history(xero_tenant_id, bank_transaction_id) pprint(api_response) except ApiException as e: @@ -5119,7 +5119,7 @@ Name | Type | Description | Notes # **get_bank_transfer** > BankTransfers get_bank_transfer(xero_tenant_id, bank_transfer_id) -Allows you to retrieve any bank transfers +Retrieves specific bank transfers by using a unique bank transfer Id ### Example @@ -5148,9 +5148,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transfer +bank_transfer_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transfer try: - # Allows you to retrieve any bank transfers + # Retrieves specific bank transfers by using a unique bank transfer Id api_response = api_instance.get_bank_transfer(xero_tenant_id, bank_transfer_id) pprint(api_response) except ApiException as e: @@ -5182,7 +5182,7 @@ Name | Type | Description | Notes # **get_bank_transfer_attachment_by_file_name** > file get_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, content_type) -Allows you to retrieve Attachments on BankTransfer by file name +Retrieves a specific attachment on a specific bank transfer by file name ### Example @@ -5211,11 +5211,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transfer +bank_transfer_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transfer file_name = 'xero-dev.jpg' # str | The name of the file being attached to a Bank Transfer content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve Attachments on BankTransfer by file name + # Retrieves a specific attachment on a specific bank transfer by file name api_response = api_instance.get_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, content_type) pprint(api_response) except ApiException as e: @@ -5249,7 +5249,7 @@ Name | Type | Description | Notes # **get_bank_transfer_attachment_by_id** > file get_bank_transfer_attachment_by_id(xero_tenant_id, bank_transfer_id, attachment_id, content_type) -Allows you to retrieve Attachments on BankTransfer +Retrieves a specific attachment from a specific bank transfer using a unique attachment ID ### Example @@ -5278,11 +5278,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transfer -attachment_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for an Attachment to a bank transfer +bank_transfer_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transfer +attachment_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for an Attachment to a bank transfer content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve Attachments on BankTransfer + # Retrieves a specific attachment from a specific bank transfer using a unique attachment ID api_response = api_instance.get_bank_transfer_attachment_by_id(xero_tenant_id, bank_transfer_id, attachment_id, content_type) pprint(api_response) except ApiException as e: @@ -5316,7 +5316,7 @@ Name | Type | Description | Notes # **get_bank_transfer_attachments** > Attachments get_bank_transfer_attachments(xero_tenant_id, bank_transfer_id) -Allows you to retrieve Attachments from bank transfers +Retrieves attachments from a specific bank transfer ### Example @@ -5345,9 +5345,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transfer +bank_transfer_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transfer try: - # Allows you to retrieve Attachments from bank transfers + # Retrieves attachments from a specific bank transfer api_response = api_instance.get_bank_transfer_attachments(xero_tenant_id, bank_transfer_id) pprint(api_response) except ApiException as e: @@ -5379,7 +5379,7 @@ Name | Type | Description | Notes # **get_bank_transfer_history** > HistoryRecords get_bank_transfer_history(xero_tenant_id, bank_transfer_id) -Allows you to retrieve history from a bank transfers +Retrieves history from a specific bank transfer using a unique bank transfer Id ### Example @@ -5408,9 +5408,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transfer +bank_transfer_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transfer try: - # Allows you to retrieve history from a bank transfers + # Retrieves history from a specific bank transfer using a unique bank transfer Id api_response = api_instance.get_bank_transfer_history(xero_tenant_id, bank_transfer_id) pprint(api_response) except ApiException as e: @@ -5442,7 +5442,7 @@ Name | Type | Description | Notes # **get_bank_transfers** > BankTransfers get_bank_transfers(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) -Allows you to retrieve all bank transfers +Retrieves all bank transfers ### Example @@ -5475,7 +5475,7 @@ if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records cr where = 'HasAttachments==true' # str | Filter by an any element (optional) order = 'Amount ASC' # str | Order by an any element (optional) try: - # Allows you to retrieve all bank transfers + # Retrieves all bank transfers api_response = api_instance.get_bank_transfers(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) pprint(api_response) except ApiException as e: @@ -5509,7 +5509,7 @@ Name | Type | Description | Notes # **get_batch_payment_history** > HistoryRecords get_batch_payment_history(xero_tenant_id, batch_payment_id) -Allows you to retrieve history from a Batch Payment +Retrieves history from a specific batch payment ### Example @@ -5538,9 +5538,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -batch_payment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for BatchPayment +batch_payment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for BatchPayment try: - # Allows you to retrieve history from a Batch Payment + # Retrieves history from a specific batch payment api_response = api_instance.get_batch_payment_history(xero_tenant_id, batch_payment_id) pprint(api_response) except ApiException as e: @@ -5572,7 +5572,7 @@ Name | Type | Description | Notes # **get_batch_payments** > BatchPayments get_batch_payments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) -Retrieve either one or many BatchPayments for invoices +Retrieves either one or many batch payments for invoices ### Example @@ -5605,7 +5605,7 @@ if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records cr where = 'Status==\"AUTHORISED\"' # str | Filter by an any element (optional) order = 'Date ASC' # str | Order by an any element (optional) try: - # Retrieve either one or many BatchPayments for invoices + # Retrieves either one or many batch payments for invoices api_response = api_instance.get_batch_payments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) pprint(api_response) except ApiException as e: @@ -5639,7 +5639,7 @@ Name | Type | Description | Notes # **get_branding_theme** > BrandingThemes get_branding_theme(xero_tenant_id, branding_theme_id) -Allows you to retrieve a specific BrandingThemes +Retrieves a specific branding theme using a unique branding theme Id ### Example @@ -5668,9 +5668,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -branding_theme_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Branding Theme +branding_theme_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Branding Theme try: - # Allows you to retrieve a specific BrandingThemes + # Retrieves a specific branding theme using a unique branding theme Id api_response = api_instance.get_branding_theme(xero_tenant_id, branding_theme_id) pprint(api_response) except ApiException as e: @@ -5702,7 +5702,7 @@ Name | Type | Description | Notes # **get_branding_theme_payment_services** > PaymentServices get_branding_theme_payment_services(xero_tenant_id, branding_theme_id) -Allows you to retrieve the Payment services for a Branding Theme +Retrieves the payment services for a specific branding theme ### Example @@ -5731,9 +5731,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -branding_theme_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Branding Theme +branding_theme_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Branding Theme try: - # Allows you to retrieve the Payment services for a Branding Theme + # Retrieves the payment services for a specific branding theme api_response = api_instance.get_branding_theme_payment_services(xero_tenant_id, branding_theme_id) pprint(api_response) except ApiException as e: @@ -5765,7 +5765,7 @@ Name | Type | Description | Notes # **get_branding_themes** > BrandingThemes get_branding_themes(xero_tenant_id) -Allows you to retrieve all the BrandingThemes +Retrieves all the branding themes ### Example @@ -5795,7 +5795,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant try: - # Allows you to retrieve all the BrandingThemes + # Retrieves all the branding themes api_response = api_instance.get_branding_themes(xero_tenant_id) pprint(api_response) except ApiException as e: @@ -5826,7 +5826,7 @@ Name | Type | Description | Notes # **get_contact** > Contacts get_contact(xero_tenant_id, contact_id) -Allows you to retrieve a single contacts in a Xero organisation +Retrieves a specific contacts in a Xero organisation using a unique contact Id ### Example @@ -5855,9 +5855,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact +contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact try: - # Allows you to retrieve a single contacts in a Xero organisation + # Retrieves a specific contacts in a Xero organisation using a unique contact Id api_response = api_instance.get_contact(xero_tenant_id, contact_id) pprint(api_response) except ApiException as e: @@ -5889,7 +5889,7 @@ Name | Type | Description | Notes # **get_contact_attachment_by_file_name** > file get_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, content_type) -Allows you to retrieve Attachments on Contacts by file name +Retrieves a specific attachment from a specific contact by file name ### Example @@ -5918,11 +5918,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact +contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact file_name = 'xero-dev.jpg' # str | Name for the file you are attaching content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve Attachments on Contacts by file name + # Retrieves a specific attachment from a specific contact by file name api_response = api_instance.get_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, content_type) pprint(api_response) except ApiException as e: @@ -5956,7 +5956,7 @@ Name | Type | Description | Notes # **get_contact_attachment_by_id** > file get_contact_attachment_by_id(xero_tenant_id, contact_id, attachment_id, content_type) -Allows you to retrieve Attachments on Contacts +Retrieves a specific attachment from a specific contact using a unique attachment Id ### Example @@ -5985,11 +5985,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact -attachment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Attachment +contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact +attachment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Attachment content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve Attachments on Contacts + # Retrieves a specific attachment from a specific contact using a unique attachment Id api_response = api_instance.get_contact_attachment_by_id(xero_tenant_id, contact_id, attachment_id, content_type) pprint(api_response) except ApiException as e: @@ -6023,7 +6023,7 @@ Name | Type | Description | Notes # **get_contact_attachments** > Attachments get_contact_attachments(xero_tenant_id, contact_id) -Allows you to retrieve, add and update contacts in a Xero organisation +Retrieves attachments for a specific contact in a Xero organisation ### Example @@ -6052,9 +6052,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact +contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact try: - # Allows you to retrieve, add and update contacts in a Xero organisation + # Retrieves attachments for a specific contact in a Xero organisation api_response = api_instance.get_contact_attachments(xero_tenant_id, contact_id) pprint(api_response) except ApiException as e: @@ -6086,7 +6086,7 @@ Name | Type | Description | Notes # **get_contact_by_contact_number** > Contacts get_contact_by_contact_number(xero_tenant_id, contact_number) -Allows you to retrieve a single contact by Contact Number in a Xero organisation +Retrieves a specific contact by contact number in a Xero organisation ### Example @@ -6117,7 +6117,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant contact_number = 'SB2' # str | This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). try: - # Allows you to retrieve a single contact by Contact Number in a Xero organisation + # Retrieves a specific contact by contact number in a Xero organisation api_response = api_instance.get_contact_by_contact_number(xero_tenant_id, contact_number) pprint(api_response) except ApiException as e: @@ -6149,7 +6149,7 @@ Name | Type | Description | Notes # **get_contact_cis_settings** > CISSettings get_contact_cis_settings(xero_tenant_id, contact_id) -Allows you to retrieve CISSettings for a contact in a Xero organisation +Retrieves CIS settings for a specific contact in a Xero organisation ### Example @@ -6178,9 +6178,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact +contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact try: - # Allows you to retrieve CISSettings for a contact in a Xero organisation + # Retrieves CIS settings for a specific contact in a Xero organisation api_response = api_instance.get_contact_cis_settings(xero_tenant_id, contact_id) pprint(api_response) except ApiException as e: @@ -6212,7 +6212,7 @@ Name | Type | Description | Notes # **get_contact_group** > ContactGroups get_contact_group(xero_tenant_id, contact_group_id) -Allows you to retrieve a unique Contact Group by ID +Retrieves a specific contact group by using a unique contact group Id ### Example @@ -6241,9 +6241,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_group_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact Group +contact_group_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact Group try: - # Allows you to retrieve a unique Contact Group by ID + # Retrieves a specific contact group by using a unique contact group Id api_response = api_instance.get_contact_group(xero_tenant_id, contact_group_id) pprint(api_response) except ApiException as e: @@ -6275,7 +6275,7 @@ Name | Type | Description | Notes # **get_contact_groups** > ContactGroups get_contact_groups(xero_tenant_id, where=where, order=order) -Allows you to retrieve the ContactID and Name of all the contacts in a contact group +Retrieves the contact Id and name of all the contacts in a contact group ### Example @@ -6307,7 +6307,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) order = 'Name ASC' # str | Order by an any element (optional) try: - # Allows you to retrieve the ContactID and Name of all the contacts in a contact group + # Retrieves the contact Id and name of all the contacts in a contact group api_response = api_instance.get_contact_groups(xero_tenant_id, where=where, order=order) pprint(api_response) except ApiException as e: @@ -6340,7 +6340,7 @@ Name | Type | Description | Notes # **get_contact_history** > HistoryRecords get_contact_history(xero_tenant_id, contact_id) -Allows you to retrieve a history records of an Contact +Retrieves history records for a specific contact ### Example @@ -6369,9 +6369,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact +contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact try: - # Allows you to retrieve a history records of an Contact + # Retrieves history records for a specific contact api_response = api_instance.get_contact_history(xero_tenant_id, contact_id) pprint(api_response) except ApiException as e: @@ -6403,7 +6403,7 @@ Name | Type | Description | Notes # **get_contacts** > Contacts get_contacts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, page=page, include_archived=include_archived) -Allows you to retrieve all contacts in a Xero organisation +Retrieves all contacts in a Xero organisation ### Example @@ -6435,11 +6435,11 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records created or modified since this timestamp will be returned (optional) where = 'ContactStatus=="ACTIVE"' # str | Filter by an any element (optional) order = 'Name ASC' # str | Order by an any element (optional) -i_ds = ['"00000000-0000-0000-000-000000000000"'] # list[str] | Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. (optional) +i_ds = ['"00000000-0000-0000-0000-000000000000"'] # list[str] | Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. (optional) page = 1 # int | e.g. page=1 - Up to 100 contacts will be returned in a single API call. (optional) include_archived = True # bool | e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response (optional) try: - # Allows you to retrieve all contacts in a Xero organisation + # Retrieves all contacts in a Xero organisation api_response = api_instance.get_contacts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, page=page, include_archived=include_archived) pprint(api_response) except ApiException as e: @@ -6476,7 +6476,7 @@ Name | Type | Description | Notes # **get_credit_note** > CreditNotes get_credit_note(xero_tenant_id, credit_note_id, unitdp=unitdp) -Allows you to retrieve a specific credit note +Retrieves a specific credit note using a unique credit note Id ### Example @@ -6505,10 +6505,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Credit Note +credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to retrieve a specific credit note + # Retrieves a specific credit note using a unique credit note Id api_response = api_instance.get_credit_note(xero_tenant_id, credit_note_id, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -6541,7 +6541,7 @@ Name | Type | Description | Notes # **get_credit_note_as_pdf** > file get_credit_note_as_pdf(xero_tenant_id, credit_note_id) -Allows you to retrieve Credit Note as PDF files +Retrieves credit notes as PDF files ### Example @@ -6570,9 +6570,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Credit Note +credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note try: - # Allows you to retrieve Credit Note as PDF files + # Retrieves credit notes as PDF files api_response = api_instance.get_credit_note_as_pdf(xero_tenant_id, credit_note_id) pprint(api_response) except ApiException as e: @@ -6604,7 +6604,7 @@ Name | Type | Description | Notes # **get_credit_note_attachment_by_file_name** > file get_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, content_type) -Allows you to retrieve Attachments on CreditNote by file name +Retrieves a specific attachment on a specific credit note by file name ### Example @@ -6633,11 +6633,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Credit Note +credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note file_name = 'xero-dev.jpg' # str | Name of the file you are attaching to Credit Note content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve Attachments on CreditNote by file name + # Retrieves a specific attachment on a specific credit note by file name api_response = api_instance.get_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, content_type) pprint(api_response) except ApiException as e: @@ -6671,7 +6671,7 @@ Name | Type | Description | Notes # **get_credit_note_attachment_by_id** > file get_credit_note_attachment_by_id(xero_tenant_id, credit_note_id, attachment_id, content_type) -Allows you to retrieve Attachments on CreditNote +Retrieves a specific attachment from a specific credit note using a unique attachment Id ### Example @@ -6700,11 +6700,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Credit Note -attachment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Attachment +credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note +attachment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Attachment content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve Attachments on CreditNote + # Retrieves a specific attachment from a specific credit note using a unique attachment Id api_response = api_instance.get_credit_note_attachment_by_id(xero_tenant_id, credit_note_id, attachment_id, content_type) pprint(api_response) except ApiException as e: @@ -6738,7 +6738,7 @@ Name | Type | Description | Notes # **get_credit_note_attachments** > Attachments get_credit_note_attachments(xero_tenant_id, credit_note_id) -Allows you to retrieve Attachments for credit notes +Retrieves attachments for a specific credit notes ### Example @@ -6767,9 +6767,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Credit Note +credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note try: - # Allows you to retrieve Attachments for credit notes + # Retrieves attachments for a specific credit notes api_response = api_instance.get_credit_note_attachments(xero_tenant_id, credit_note_id) pprint(api_response) except ApiException as e: @@ -6801,7 +6801,7 @@ Name | Type | Description | Notes # **get_credit_note_history** > HistoryRecords get_credit_note_history(xero_tenant_id, credit_note_id) -Allows you to retrieve a history records of an CreditNote +Retrieves history records of a specific credit note ### Example @@ -6830,9 +6830,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Credit Note +credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note try: - # Allows you to retrieve a history records of an CreditNote + # Retrieves history records of a specific credit note api_response = api_instance.get_credit_note_history(xero_tenant_id, credit_note_id) pprint(api_response) except ApiException as e: @@ -6864,7 +6864,7 @@ Name | Type | Description | Notes # **get_credit_notes** > CreditNotes get_credit_notes(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) -Allows you to retrieve any credit notes +Retrieves any credit notes ### Example @@ -6899,7 +6899,7 @@ order = 'CreditNoteNumber ASC' # str | Order by an any element (optional) page = 1 # int | e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to retrieve any credit notes + # Retrieves any credit notes api_response = api_instance.get_credit_notes(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -6935,7 +6935,7 @@ Name | Type | Description | Notes # **get_currencies** > Currencies get_currencies(xero_tenant_id, where=where, order=order) -Allows you to retrieve currencies for your organisation +Retrieves currencies for your Xero organisation ### Example @@ -6967,7 +6967,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant where = 'Code==\"USD\"' # str | Filter by an any element (optional) order = 'Code ASC' # str | Order by an any element (optional) try: - # Allows you to retrieve currencies for your organisation + # Retrieves currencies for your Xero organisation api_response = api_instance.get_currencies(xero_tenant_id, where=where, order=order) pprint(api_response) except ApiException as e: @@ -7000,7 +7000,7 @@ Name | Type | Description | Notes # **get_employee** > Employees get_employee(xero_tenant_id, employee_id) -Allows you to retrieve a specific employee used in Xero payrun +Retrieves a specific employee used in Xero payrun using a unique employee Id ### Example @@ -7029,9 +7029,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -employee_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Employee +employee_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Employee try: - # Allows you to retrieve a specific employee used in Xero payrun + # Retrieves a specific employee used in Xero payrun using a unique employee Id api_response = api_instance.get_employee(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -7063,7 +7063,7 @@ Name | Type | Description | Notes # **get_employees** > Employees get_employees(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) -Allows you to retrieve employees used in Xero payrun +Retrieves employees used in Xero payrun ### Example @@ -7096,7 +7096,7 @@ if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records cr where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) order = 'LastName ASC' # str | Order by an any element (optional) try: - # Allows you to retrieve employees used in Xero payrun + # Retrieves employees used in Xero payrun api_response = api_instance.get_employees(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) pprint(api_response) except ApiException as e: @@ -7130,7 +7130,7 @@ Name | Type | Description | Notes # **get_expense_claim** > ExpenseClaims get_expense_claim(xero_tenant_id, expense_claim_id) -Allows you to retrieve a specified expense claim +Retrieves a specific expense claim using a unique expense claim Id ### Example @@ -7159,9 +7159,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -expense_claim_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a ExpenseClaim +expense_claim_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ExpenseClaim try: - # Allows you to retrieve a specified expense claim + # Retrieves a specific expense claim using a unique expense claim Id api_response = api_instance.get_expense_claim(xero_tenant_id, expense_claim_id) pprint(api_response) except ApiException as e: @@ -7193,7 +7193,7 @@ Name | Type | Description | Notes # **get_expense_claim_history** > HistoryRecords get_expense_claim_history(xero_tenant_id, expense_claim_id) -Allows you to retrieve a history records of an ExpenseClaim +Retrieves history records of a specific expense claim ### Example @@ -7222,9 +7222,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -expense_claim_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a ExpenseClaim +expense_claim_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ExpenseClaim try: - # Allows you to retrieve a history records of an ExpenseClaim + # Retrieves history records of a specific expense claim api_response = api_instance.get_expense_claim_history(xero_tenant_id, expense_claim_id) pprint(api_response) except ApiException as e: @@ -7256,7 +7256,7 @@ Name | Type | Description | Notes # **get_expense_claims** > ExpenseClaims get_expense_claims(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) -Allows you to retrieve expense claims +Retrieves expense claims ### Example @@ -7289,7 +7289,7 @@ if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records cr where = 'Status==\"SUBMITTED\"' # str | Filter by an any element (optional) order = 'Status ASC' # str | Order by an any element (optional) try: - # Allows you to retrieve expense claims + # Retrieves expense claims api_response = api_instance.get_expense_claims(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) pprint(api_response) except ApiException as e: @@ -7323,7 +7323,7 @@ Name | Type | Description | Notes # **get_invoice** > Invoices get_invoice(xero_tenant_id, invoice_id, unitdp=unitdp) -Allows you to retrieve a specified sales invoice or purchase bill +Retrieves a specific sales invoice or purchase bill using a unique invoice Id ### Example @@ -7352,10 +7352,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Invoice +invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to retrieve a specified sales invoice or purchase bill + # Retrieves a specific sales invoice or purchase bill using a unique invoice Id api_response = api_instance.get_invoice(xero_tenant_id, invoice_id, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -7388,7 +7388,7 @@ Name | Type | Description | Notes # **get_invoice_as_pdf** > file get_invoice_as_pdf(xero_tenant_id, invoice_id) -Allows you to retrieve invoices or purchase bills as PDF files +Retrieves invoices or purchase bills as PDF files ### Example @@ -7417,9 +7417,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Invoice +invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice try: - # Allows you to retrieve invoices or purchase bills as PDF files + # Retrieves invoices or purchase bills as PDF files api_response = api_instance.get_invoice_as_pdf(xero_tenant_id, invoice_id) pprint(api_response) except ApiException as e: @@ -7451,7 +7451,7 @@ Name | Type | Description | Notes # **get_invoice_attachment_by_file_name** > file get_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, content_type) -Allows you to retrieve Attachment on invoices or purchase bills by it's filename +Retrieves an attachment from a specific invoice or purchase bill by filename ### Example @@ -7480,11 +7480,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Invoice +invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice file_name = 'xero-dev.jpg' # str | Name of the file you are attaching content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve Attachment on invoices or purchase bills by it's filename + # Retrieves an attachment from a specific invoice or purchase bill by filename api_response = api_instance.get_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, content_type) pprint(api_response) except ApiException as e: @@ -7518,7 +7518,7 @@ Name | Type | Description | Notes # **get_invoice_attachment_by_id** > file get_invoice_attachment_by_id(xero_tenant_id, invoice_id, attachment_id, content_type) -Allows you to retrieve a specified Attachment on invoices or purchase bills by it's ID +Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id ### Example @@ -7547,11 +7547,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Invoice -attachment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Attachment +invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice +attachment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Attachment content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve a specified Attachment on invoices or purchase bills by it's ID + # Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id api_response = api_instance.get_invoice_attachment_by_id(xero_tenant_id, invoice_id, attachment_id, content_type) pprint(api_response) except ApiException as e: @@ -7585,7 +7585,7 @@ Name | Type | Description | Notes # **get_invoice_attachments** > Attachments get_invoice_attachments(xero_tenant_id, invoice_id) -Allows you to retrieve Attachments on invoices or purchase bills +Retrieves attachments for a specific invoice or purchase bill ### Example @@ -7614,9 +7614,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Invoice +invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice try: - # Allows you to retrieve Attachments on invoices or purchase bills + # Retrieves attachments for a specific invoice or purchase bill api_response = api_instance.get_invoice_attachments(xero_tenant_id, invoice_id) pprint(api_response) except ApiException as e: @@ -7648,7 +7648,7 @@ Name | Type | Description | Notes # **get_invoice_history** > HistoryRecords get_invoice_history(xero_tenant_id, invoice_id) -Allows you to retrieve a history records of an invoice +Retrieves history records for a specific invoice ### Example @@ -7677,9 +7677,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Invoice +invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice try: - # Allows you to retrieve a history records of an invoice + # Retrieves history records for a specific invoice api_response = api_instance.get_invoice_history(xero_tenant_id, invoice_id) pprint(api_response) except ApiException as e: @@ -7711,7 +7711,7 @@ Name | Type | Description | Notes # **get_invoice_reminders** > InvoiceReminders get_invoice_reminders(xero_tenant_id) -Allows you to retrieve invoice reminder settings +Retrieves invoice reminder settings ### Example @@ -7741,7 +7741,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant try: - # Allows you to retrieve invoice reminder settings + # Retrieves invoice reminder settings api_response = api_instance.get_invoice_reminders(xero_tenant_id) pprint(api_response) except ApiException as e: @@ -7772,7 +7772,7 @@ Name | Type | Description | Notes # **get_invoices** > Invoices get_invoices(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, invoice_numbers=invoice_numbers, contact_i_ds=contact_i_ds, statuses=statuses, page=page, include_archived=include_archived, created_by_my_app=created_by_my_app, unitdp=unitdp) -Allows you to retrieve any sales invoices or purchase bills +Retrieves sales invoices or purchase bills ### Example @@ -7804,16 +7804,16 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records created or modified since this timestamp will be returned (optional) where = 'Status==\"DRAFT\"' # str | Filter by an any element (optional) order = 'InvoiceNumber ASC' # str | Order by an any element (optional) -i_ds = ['"00000000-0000-0000-000-000000000000"'] # list[str] | Filter by a comma-separated list of InvoicesIDs. (optional) +i_ds = ['"00000000-0000-0000-0000-000000000000"'] # list[str] | Filter by a comma-separated list of InvoicesIDs. (optional) invoice_numbers = ['"INV-001", "INV-002"'] # list[str] | Filter by a comma-separated list of InvoiceNumbers. (optional) -contact_i_ds = ['"00000000-0000-0000-000-000000000000"'] # list[str] | Filter by a comma-separated list of ContactIDs. (optional) +contact_i_ds = ['"00000000-0000-0000-0000-000000000000"'] # list[str] | Filter by a comma-separated list of ContactIDs. (optional) statuses = ['"DRAFT", "SUBMITTED"'] # list[str] | Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter. (optional) page = 1 # int | e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice (optional) include_archived = True # bool | e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response (optional) created_by_my_app = false # bool | When set to true you'll only retrieve Invoices created by your app (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to retrieve any sales invoices or purchase bills + # Retrieves sales invoices or purchase bills api_response = api_instance.get_invoices(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, invoice_numbers=invoice_numbers, contact_i_ds=contact_i_ds, statuses=statuses, page=page, include_archived=include_archived, created_by_my_app=created_by_my_app, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -7855,7 +7855,7 @@ Name | Type | Description | Notes # **get_item** > Items get_item(xero_tenant_id, item_id, unitdp=unitdp) -Allows you to retrieve a specified item +Retrieves a specific item using a unique item Id ### Example @@ -7884,10 +7884,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -item_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Item +item_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Item unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to retrieve a specified item + # Retrieves a specific item using a unique item Id api_response = api_instance.get_item(xero_tenant_id, item_id, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -7920,7 +7920,7 @@ Name | Type | Description | Notes # **get_item_history** > HistoryRecords get_item_history(xero_tenant_id, item_id) -Allows you to retrieve history for items +Retrieves history for a specific item ### Example @@ -7949,9 +7949,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -item_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Item +item_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Item try: - # Allows you to retrieve history for items + # Retrieves history for a specific item api_response = api_instance.get_item_history(xero_tenant_id, item_id) pprint(api_response) except ApiException as e: @@ -7983,7 +7983,7 @@ Name | Type | Description | Notes # **get_items** > Items get_items(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, unitdp=unitdp) -Allows you to retrieve any items +Retrieves items ### Example @@ -8017,7 +8017,7 @@ where = 'IsSold==true' # str | Filter by an any element (optional) order = 'Code ASC' # str | Order by an any element (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to retrieve any items + # Retrieves items api_response = api_instance.get_items(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -8052,7 +8052,7 @@ Name | Type | Description | Notes # **get_journal** > Journals get_journal(xero_tenant_id, journal_id) -Allows you to retrieve a specified journals. +Retrieves a specific journal using a unique journal Id. ### Example @@ -8081,9 +8081,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -journal_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Journal +journal_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Journal try: - # Allows you to retrieve a specified journals. + # Retrieves a specific journal using a unique journal Id. api_response = api_instance.get_journal(xero_tenant_id, journal_id) pprint(api_response) except ApiException as e: @@ -8115,7 +8115,7 @@ Name | Type | Description | Notes # **get_journals** > Journals get_journals(xero_tenant_id, if_modified_since=if_modified_since, offset=offset, payments_only=payments_only) -Allows you to retrieve any journals. +Retrieves journals ### Example @@ -8148,7 +8148,7 @@ if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records cr offset = 10 # int | Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned (optional) payments_only = True # bool | Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default. (optional) try: - # Allows you to retrieve any journals. + # Retrieves journals api_response = api_instance.get_journals(xero_tenant_id, if_modified_since=if_modified_since, offset=offset, payments_only=payments_only) pprint(api_response) except ApiException as e: @@ -8182,7 +8182,7 @@ Name | Type | Description | Notes # **get_linked_transaction** > LinkedTransactions get_linked_transaction(xero_tenant_id, linked_transaction_id) -Allows you to retrieve a specified linked transactions (billable expenses) +Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id ### Example @@ -8211,9 +8211,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -linked_transaction_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a LinkedTransaction +linked_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a LinkedTransaction try: - # Allows you to retrieve a specified linked transactions (billable expenses) + # Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id api_response = api_instance.get_linked_transaction(xero_tenant_id, linked_transaction_id) pprint(api_response) except ApiException as e: @@ -8245,7 +8245,7 @@ Name | Type | Description | Notes # **get_linked_transactions** > LinkedTransactions get_linked_transactions(xero_tenant_id, page=page, linked_transaction_id=linked_transaction_id, source_transaction_id=source_transaction_id, contact_id=contact_id, status=status, target_transaction_id=target_transaction_id) -Retrieve linked transactions (billable expenses) +Retrieves linked transactions (billable expenses) ### Example @@ -8275,13 +8275,13 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant page = 1 # int | Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1. (optional) -linked_transaction_id = '00000000-0000-0000-000-000000000000' # str | The Xero identifier for an Linked Transaction (optional) -source_transaction_id = '00000000-0000-0000-000-000000000000' # str | Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice (optional) -contact_id = '00000000-0000-0000-000-000000000000' # str | Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer. (optional) -status = 'APPROVED' # str | Filter by the combination of ContactID and Status. Get the linked transactions associaed to a customer and with a status (optional) -target_transaction_id = '00000000-0000-0000-000-000000000000' # str | Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice (optional) +linked_transaction_id = '00000000-0000-0000-0000-000000000000' # str | The Xero identifier for an Linked Transaction (optional) +source_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice (optional) +contact_id = '00000000-0000-0000-0000-000000000000' # str | Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer. (optional) +status = 'APPROVED' # str | Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status (optional) +target_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice (optional) try: - # Retrieve linked transactions (billable expenses) + # Retrieves linked transactions (billable expenses) api_response = api_instance.get_linked_transactions(xero_tenant_id, page=page, linked_transaction_id=linked_transaction_id, source_transaction_id=source_transaction_id, contact_id=contact_id, status=status, target_transaction_id=target_transaction_id) pprint(api_response) except ApiException as e: @@ -8297,7 +8297,7 @@ Name | Type | Description | Notes **linked_transaction_id** | [**str**](.md)| The Xero identifier for an Linked Transaction | [optional] **source_transaction_id** | [**str**](.md)| Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice | [optional] **contact_id** | [**str**](.md)| Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer. | [optional] - **status** | **str**| Filter by the combination of ContactID and Status. Get the linked transactions associaed to a customer and with a status | [optional] + **status** | **str**| Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status | [optional] **target_transaction_id** | [**str**](.md)| Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice | [optional] ### Return type @@ -8318,7 +8318,7 @@ Name | Type | Description | Notes # **get_manual_journal** > ManualJournals get_manual_journal(xero_tenant_id, manual_journal_id) -Allows you to retrieve a specified manual journals +Retrieves a specific manual journal ### Example @@ -8347,9 +8347,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a ManualJournal +manual_journal_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ManualJournal try: - # Allows you to retrieve a specified manual journals + # Retrieves a specific manual journal api_response = api_instance.get_manual_journal(xero_tenant_id, manual_journal_id) pprint(api_response) except ApiException as e: @@ -8381,7 +8381,7 @@ Name | Type | Description | Notes # **get_manual_journal_attachment_by_file_name** > file get_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, content_type) -Allows you to retrieve specified Attachment on ManualJournal by file name +Retrieves a specific attachment from a specific manual journal by file name ### Example @@ -8410,11 +8410,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a ManualJournal +manual_journal_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ManualJournal file_name = 'xero-dev.jpg' # str | The name of the file being attached to a ManualJournal content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve specified Attachment on ManualJournal by file name + # Retrieves a specific attachment from a specific manual journal by file name api_response = api_instance.get_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, content_type) pprint(api_response) except ApiException as e: @@ -8448,7 +8448,7 @@ Name | Type | Description | Notes # **get_manual_journal_attachment_by_id** > file get_manual_journal_attachment_by_id(xero_tenant_id, manual_journal_id, attachment_id, content_type) -Allows you to retrieve specified Attachment on ManualJournals +Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id ### Example @@ -8477,11 +8477,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a ManualJournal -attachment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Attachment +manual_journal_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ManualJournal +attachment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Attachment content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve specified Attachment on ManualJournals + # Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id api_response = api_instance.get_manual_journal_attachment_by_id(xero_tenant_id, manual_journal_id, attachment_id, content_type) pprint(api_response) except ApiException as e: @@ -8515,7 +8515,7 @@ Name | Type | Description | Notes # **get_manual_journal_attachments** > Attachments get_manual_journal_attachments(xero_tenant_id, manual_journal_id) -Allows you to retrieve Attachment for manual journals +Retrieves attachment for a specific manual journal ### Example @@ -8544,9 +8544,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a ManualJournal +manual_journal_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ManualJournal try: - # Allows you to retrieve Attachment for manual journals + # Retrieves attachment for a specific manual journal api_response = api_instance.get_manual_journal_attachments(xero_tenant_id, manual_journal_id) pprint(api_response) except ApiException as e: @@ -8578,7 +8578,7 @@ Name | Type | Description | Notes # **get_manual_journals** > ManualJournals get_manual_journals(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) -Allows you to retrieve any manual journals +Retrieves manual journals ### Example @@ -8612,7 +8612,7 @@ where = 'Status==\"DRAFT\"' # str | Filter by an any element (optional) order = 'Date ASC' # str | Order by an any element (optional) page = 1 # int | e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment (optional) try: - # Allows you to retrieve any manual journals + # Retrieves manual journals api_response = api_instance.get_manual_journals(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) pprint(api_response) except ApiException as e: @@ -8647,7 +8647,7 @@ Name | Type | Description | Notes # **get_manual_journals_history** > HistoryRecords get_manual_journals_history(xero_tenant_id, manual_journal_id) -Allows you to retrieve history from a manual journal +Retrieves history for a specific manual journal ### Example @@ -8676,9 +8676,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a manual journal +manual_journal_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a manual journal try: - # Allows you to retrieve history from a manual journal + # Retrieves history for a specific manual journal api_response = api_instance.get_manual_journals_history(xero_tenant_id, manual_journal_id) pprint(api_response) except ApiException as e: @@ -8710,7 +8710,7 @@ Name | Type | Description | Notes # **get_online_invoice** > OnlineInvoices get_online_invoice(xero_tenant_id, invoice_id) -Allows you to retrieve a URL to an online invoice +Retrieves a URL to an online invoice ### Example @@ -8739,9 +8739,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Invoice +invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice try: - # Allows you to retrieve a URL to an online invoice + # Retrieves a URL to an online invoice api_response = api_instance.get_online_invoice(xero_tenant_id, invoice_id) pprint(api_response) except ApiException as e: @@ -8773,7 +8773,7 @@ Name | Type | Description | Notes # **get_organisation_actions** > Actions get_organisation_actions(xero_tenant_id) -Retrieve a list of the key actions your app has permission to perform in the connected organisation. +Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation. ### Example @@ -8803,7 +8803,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant try: - # Retrieve a list of the key actions your app has permission to perform in the connected organisation. + # Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation. api_response = api_instance.get_organisation_actions(xero_tenant_id) pprint(api_response) except ApiException as e: @@ -8832,9 +8832,9 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_organisation_cis_settings** -> CISOrgSetting get_organisation_cis_settings(xero_tenant_id, organisation_id) +> CISOrgSettings get_organisation_cis_settings(xero_tenant_id, organisation_id) -Allows you To verify if an organisation is using contruction industry scheme, you can retrieve the CIS settings for the organistaion. +Retrieves the CIS settings for the Xero organistaion. ### Example @@ -8863,9 +8863,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -organisation_id = '00000000-0000-0000-000-000000000000' # str | The unique Xero identifier for an organisation +organisation_id = '00000000-0000-0000-0000-000000000000' # str | The unique Xero identifier for an organisation try: - # Allows you To verify if an organisation is using contruction industry scheme, you can retrieve the CIS settings for the organistaion. + # Retrieves the CIS settings for the Xero organistaion. api_response = api_instance.get_organisation_cis_settings(xero_tenant_id, organisation_id) pprint(api_response) except ApiException as e: @@ -8881,7 +8881,7 @@ Name | Type | Description | Notes ### Return type -[**CISOrgSetting**](CISOrgSetting.md) +[**CISOrgSettings**](CISOrgSettings.md) ### Authorization @@ -8897,7 +8897,7 @@ Name | Type | Description | Notes # **get_organisations** > Organisations get_organisations(xero_tenant_id) -Allows you to retrieve Organisation details +Retrieves Xero organisation details ### Example @@ -8927,7 +8927,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant try: - # Allows you to retrieve Organisation details + # Retrieves Xero organisation details api_response = api_instance.get_organisations(xero_tenant_id) pprint(api_response) except ApiException as e: @@ -8958,7 +8958,7 @@ Name | Type | Description | Notes # **get_overpayment** > Overpayments get_overpayment(xero_tenant_id, overpayment_id) -Allows you to retrieve a specified overpayments +Retrieves a specific overpayment using a unique overpayment Id ### Example @@ -8987,9 +8987,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -overpayment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Overpayment +overpayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Overpayment try: - # Allows you to retrieve a specified overpayments + # Retrieves a specific overpayment using a unique overpayment Id api_response = api_instance.get_overpayment(xero_tenant_id, overpayment_id) pprint(api_response) except ApiException as e: @@ -9021,7 +9021,7 @@ Name | Type | Description | Notes # **get_overpayment_history** > HistoryRecords get_overpayment_history(xero_tenant_id, overpayment_id) -Allows you to retrieve a history records of an Overpayment +Retrieves history records of a specific overpayment ### Example @@ -9050,9 +9050,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -overpayment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Overpayment +overpayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Overpayment try: - # Allows you to retrieve a history records of an Overpayment + # Retrieves history records of a specific overpayment api_response = api_instance.get_overpayment_history(xero_tenant_id, overpayment_id) pprint(api_response) except ApiException as e: @@ -9084,7 +9084,7 @@ Name | Type | Description | Notes # **get_overpayments** > Overpayments get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) -Allows you to retrieve overpayments +Retrieves overpayments ### Example @@ -9119,7 +9119,7 @@ order = 'Status ASC' # str | Order by an any element (optional) page = 1 # int | e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to retrieve overpayments + # Retrieves overpayments api_response = api_instance.get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -9155,7 +9155,7 @@ Name | Type | Description | Notes # **get_payment** > Payments get_payment(xero_tenant_id, payment_id) -Allows you to retrieve a specified payment for invoices and credit notes +Retrieves a specific payment for invoices and credit notes using a unique payment Id ### Example @@ -9184,9 +9184,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -payment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Payment +payment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Payment try: - # Allows you to retrieve a specified payment for invoices and credit notes + # Retrieves a specific payment for invoices and credit notes using a unique payment Id api_response = api_instance.get_payment(xero_tenant_id, payment_id) pprint(api_response) except ApiException as e: @@ -9218,7 +9218,7 @@ Name | Type | Description | Notes # **get_payment_history** > HistoryRecords get_payment_history(xero_tenant_id, payment_id) -Allows you to retrieve history records of a payment +Retrieves history records of a specific payment ### Example @@ -9247,9 +9247,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -payment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Payment +payment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Payment try: - # Allows you to retrieve history records of a payment + # Retrieves history records of a specific payment api_response = api_instance.get_payment_history(xero_tenant_id, payment_id) pprint(api_response) except ApiException as e: @@ -9281,7 +9281,7 @@ Name | Type | Description | Notes # **get_payment_services** > PaymentServices get_payment_services(xero_tenant_id) -Allows you to retrieve payment services +Retrieves payment services ### Example @@ -9311,7 +9311,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant try: - # Allows you to retrieve payment services + # Retrieves payment services api_response = api_instance.get_payment_services(xero_tenant_id) pprint(api_response) except ApiException as e: @@ -9342,7 +9342,7 @@ Name | Type | Description | Notes # **get_payments** > Payments get_payments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) -Allows you to retrieve payments for invoices and credit notes +Retrieves payments for invoices and credit notes ### Example @@ -9376,7 +9376,7 @@ where = 'Status==\"AUTHORISED\"' # str | Filter by an any element (optional) order = 'Amount ASC' # str | Order by an any element (optional) page = 1 # int | Up to 100 payments will be returned in a single API call (optional) try: - # Allows you to retrieve payments for invoices and credit notes + # Retrieves payments for invoices and credit notes api_response = api_instance.get_payments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) pprint(api_response) except ApiException as e: @@ -9440,7 +9440,7 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -prepayment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a PrePayment +prepayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a PrePayment try: # Allows you to retrieve a specified prepayments api_response = api_instance.get_prepayment(xero_tenant_id, prepayment_id) @@ -9474,7 +9474,7 @@ Name | Type | Description | Notes # **get_prepayment_history** > HistoryRecords get_prepayment_history(xero_tenant_id, prepayment_id) -Allows you to retrieve a history records of an Prepayment +Retrieves history record for a specific prepayment ### Example @@ -9503,9 +9503,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -prepayment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a PrePayment +prepayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a PrePayment try: - # Allows you to retrieve a history records of an Prepayment + # Retrieves history record for a specific prepayment api_response = api_instance.get_prepayment_history(xero_tenant_id, prepayment_id) pprint(api_response) except ApiException as e: @@ -9537,7 +9537,7 @@ Name | Type | Description | Notes # **get_prepayments** > Prepayments get_prepayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) -Allows you to retrieve prepayments +Retrieves prepayments ### Example @@ -9572,7 +9572,7 @@ order = 'Reference ASC' # str | Order by an any element (optional) page = 1 # int | e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to retrieve prepayments + # Retrieves prepayments api_response = api_instance.get_prepayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -9608,7 +9608,7 @@ Name | Type | Description | Notes # **get_purchase_order** > PurchaseOrders get_purchase_order(xero_tenant_id, purchase_order_id) -Allows you to retrieve a specified purchase orders +Retrieves a specific purchase order using a unique purchase order Id ### Example @@ -9637,9 +9637,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a PurchaseOrder +purchase_order_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a PurchaseOrder try: - # Allows you to retrieve a specified purchase orders + # Retrieves a specific purchase order using a unique purchase order Id api_response = api_instance.get_purchase_order(xero_tenant_id, purchase_order_id) pprint(api_response) except ApiException as e: @@ -9671,7 +9671,7 @@ Name | Type | Description | Notes # **get_purchase_order_as_pdf** > file get_purchase_order_as_pdf(xero_tenant_id, purchase_order_id) -Allows you to retrieve purchase orders as PDF files +Retrieves specific purchase order as PDF files using a unique purchase order Id ### Example @@ -9700,9 +9700,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Purchase Order +purchase_order_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Purchase Order try: - # Allows you to retrieve purchase orders as PDF files + # Retrieves specific purchase order as PDF files using a unique purchase order Id api_response = api_instance.get_purchase_order_as_pdf(xero_tenant_id, purchase_order_id) pprint(api_response) except ApiException as e: @@ -9734,7 +9734,7 @@ Name | Type | Description | Notes # **get_purchase_order_attachment_by_file_name** > file get_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, content_type) -Allows you to retrieve Attachment on a Purchase Order by Filename +Retrieves a specific attachment for a specific purchase order by filename ### Example @@ -9763,11 +9763,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Purchase Order object +purchase_order_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Purchase Order object file_name = 'xero-dev.jpg' # str | Name of the attachment content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve Attachment on a Purchase Order by Filename + # Retrieves a specific attachment for a specific purchase order by filename api_response = api_instance.get_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, content_type) pprint(api_response) except ApiException as e: @@ -9801,7 +9801,7 @@ Name | Type | Description | Notes # **get_purchase_order_attachment_by_id** > file get_purchase_order_attachment_by_id(xero_tenant_id, purchase_order_id, attachment_id, content_type) -Allows you to retrieve specific Attachment on purchase order +Retrieves specific attachment for a specific purchase order using a unique attachment Id ### Example @@ -9830,11 +9830,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Purchase Order object -attachment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Attachment object +purchase_order_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Purchase Order object +attachment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Attachment object content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve specific Attachment on purchase order + # Retrieves specific attachment for a specific purchase order using a unique attachment Id api_response = api_instance.get_purchase_order_attachment_by_id(xero_tenant_id, purchase_order_id, attachment_id, content_type) pprint(api_response) except ApiException as e: @@ -9868,7 +9868,7 @@ Name | Type | Description | Notes # **get_purchase_order_attachments** > Attachments get_purchase_order_attachments(xero_tenant_id, purchase_order_id) -Allows you to retrieve attachments for purchase orders +Retrieves attachments for a specific purchase order ### Example @@ -9897,9 +9897,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Purchase Orders object +purchase_order_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Purchase Orders object try: - # Allows you to retrieve attachments for purchase orders + # Retrieves attachments for a specific purchase order api_response = api_instance.get_purchase_order_attachments(xero_tenant_id, purchase_order_id) pprint(api_response) except ApiException as e: @@ -9931,7 +9931,7 @@ Name | Type | Description | Notes # **get_purchase_order_by_number** > PurchaseOrders get_purchase_order_by_number(xero_tenant_id, purchase_order_number) -Allows you to retrieve a specified purchase orders +Retrieves a specific purchase order using purchase order number ### Example @@ -9962,7 +9962,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant purchase_order_number = 'PO1234' # str | Unique identifier for a PurchaseOrder try: - # Allows you to retrieve a specified purchase orders + # Retrieves a specific purchase order using purchase order number api_response = api_instance.get_purchase_order_by_number(xero_tenant_id, purchase_order_number) pprint(api_response) except ApiException as e: @@ -9994,7 +9994,7 @@ Name | Type | Description | Notes # **get_purchase_order_history** > HistoryRecords get_purchase_order_history(xero_tenant_id, purchase_order_id) -Allows you to retrieve history for PurchaseOrder +Retrieves history for a specific purchase order ### Example @@ -10023,9 +10023,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a PurchaseOrder +purchase_order_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a PurchaseOrder try: - # Allows you to retrieve history for PurchaseOrder + # Retrieves history for a specific purchase order api_response = api_instance.get_purchase_order_history(xero_tenant_id, purchase_order_id) pprint(api_response) except ApiException as e: @@ -10057,7 +10057,7 @@ Name | Type | Description | Notes # **get_purchase_orders** > PurchaseOrders get_purchase_orders(xero_tenant_id, if_modified_since=if_modified_since, status=status, date_from=date_from, date_to=date_to, order=order, page=page) -Allows you to retrieve purchase orders +Retrieves purchase orders ### Example @@ -10093,7 +10093,7 @@ date_to = '2019-12-31' # str | Filter by purchase order date (e.g. GET https://. order = 'PurchaseOrderNumber ASC' # str | Order by an any element (optional) page = 1 # int | To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned. (optional) try: - # Allows you to retrieve purchase orders + # Retrieves purchase orders api_response = api_instance.get_purchase_orders(xero_tenant_id, if_modified_since=if_modified_since, status=status, date_from=date_from, date_to=date_to, order=order, page=page) pprint(api_response) except ApiException as e: @@ -10130,7 +10130,7 @@ Name | Type | Description | Notes # **get_quote** > Quotes get_quote(xero_tenant_id, quote_id) -Allows you to retrieve a specified quote +Retrieves a specific quote using a unique quote Id ### Example @@ -10159,9 +10159,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -quote_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Quote +quote_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Quote try: - # Allows you to retrieve a specified quote + # Retrieves a specific quote using a unique quote Id api_response = api_instance.get_quote(xero_tenant_id, quote_id) pprint(api_response) except ApiException as e: @@ -10193,7 +10193,7 @@ Name | Type | Description | Notes # **get_quote_as_pdf** > file get_quote_as_pdf(xero_tenant_id, quote_id) -Allows you to retrieve quotes as PDF files +Retrieves a specific quote as a PDF file using a unique quote Id ### Example @@ -10222,9 +10222,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -quote_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Quote +quote_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Quote try: - # Allows you to retrieve quotes as PDF files + # Retrieves a specific quote as a PDF file using a unique quote Id api_response = api_instance.get_quote_as_pdf(xero_tenant_id, quote_id) pprint(api_response) except ApiException as e: @@ -10256,7 +10256,7 @@ Name | Type | Description | Notes # **get_quote_attachment_by_file_name** > file get_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, content_type) -Allows you to retrieve Attachment on Quote by Filename +Retrieves a specific attachment from a specific quote by filename ### Example @@ -10285,11 +10285,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -quote_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Quote object +quote_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Quote object file_name = 'xero-dev.jpg' # str | Name of the attachment content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve Attachment on Quote by Filename + # Retrieves a specific attachment from a specific quote by filename api_response = api_instance.get_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, content_type) pprint(api_response) except ApiException as e: @@ -10323,7 +10323,7 @@ Name | Type | Description | Notes # **get_quote_attachment_by_id** > file get_quote_attachment_by_id(xero_tenant_id, quote_id, attachment_id, content_type) -Allows you to retrieve specific Attachment on Quote +Retrieves a specific attachment from a specific quote using a unique attachment Id ### Example @@ -10352,11 +10352,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -quote_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Quote object -attachment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Attachment object +quote_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Quote object +attachment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Attachment object content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve specific Attachment on Quote + # Retrieves a specific attachment from a specific quote using a unique attachment Id api_response = api_instance.get_quote_attachment_by_id(xero_tenant_id, quote_id, attachment_id, content_type) pprint(api_response) except ApiException as e: @@ -10390,7 +10390,7 @@ Name | Type | Description | Notes # **get_quote_attachments** > Attachments get_quote_attachments(xero_tenant_id, quote_id) -Allows you to retrieve Attachments for Quotes +Retrieves attachments for a specific quote ### Example @@ -10419,9 +10419,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -quote_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Quote object +quote_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Quote object try: - # Allows you to retrieve Attachments for Quotes + # Retrieves attachments for a specific quote api_response = api_instance.get_quote_attachments(xero_tenant_id, quote_id) pprint(api_response) except ApiException as e: @@ -10453,7 +10453,7 @@ Name | Type | Description | Notes # **get_quote_history** > HistoryRecords get_quote_history(xero_tenant_id, quote_id) -Allows you to retrieve a history records of an quote +Retrieves history records of a specific quote ### Example @@ -10482,9 +10482,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -quote_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Quote +quote_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Quote try: - # Allows you to retrieve a history records of an quote + # Retrieves history records of a specific quote api_response = api_instance.get_quote_history(xero_tenant_id, quote_id) pprint(api_response) except ApiException as e: @@ -10516,7 +10516,7 @@ Name | Type | Description | Notes # **get_quotes** > Quotes get_quotes(xero_tenant_id, if_modified_since=if_modified_since, date_from=date_from, date_to=date_to, expiry_date_from=expiry_date_from, expiry_date_to=expiry_date_to, contact_id=contact_id, status=status, page=page, order=order, quote_number=quote_number) -Allows you to retrieve any sales quotes +Retrieves sales quotes ### Example @@ -10550,13 +10550,13 @@ date_from = '2013-10-20' # date | Filter for quotes after a particular date (opt date_to = '2013-10-20' # date | Filter for quotes before a particular date (optional) expiry_date_from = '2013-10-20' # date | Filter for quotes expiring after a particular date (optional) expiry_date_to = '2013-10-20' # date | Filter for quotes before a particular date (optional) -contact_id = '00000000-0000-0000-000-000000000000' # str | Filter for quotes belonging to a particular contact (optional) +contact_id = '00000000-0000-0000-0000-000000000000' # str | Filter for quotes belonging to a particular contact (optional) status = 'DRAFT' # str | Filter for quotes of a particular Status (optional) page = 1 # int | e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote (optional) order = 'Status ASC' # str | Order by an any element (optional) quote_number = 'QU-0001' # str | Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001) (optional) try: - # Allows you to retrieve any sales quotes + # Retrieves sales quotes api_response = api_instance.get_quotes(xero_tenant_id, if_modified_since=if_modified_since, date_from=date_from, date_to=date_to, expiry_date_from=expiry_date_from, expiry_date_to=expiry_date_to, contact_id=contact_id, status=status, page=page, order=order, quote_number=quote_number) pprint(api_response) except ApiException as e: @@ -10597,7 +10597,7 @@ Name | Type | Description | Notes # **get_receipt** > Receipts get_receipt(xero_tenant_id, receipt_id, unitdp=unitdp) -Allows you to retrieve a specified draft expense claim receipts +Retrieves a specific draft expense claim receipt by using a unique receipt Id ### Example @@ -10626,10 +10626,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Receipt +receipt_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Receipt unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to retrieve a specified draft expense claim receipts + # Retrieves a specific draft expense claim receipt by using a unique receipt Id api_response = api_instance.get_receipt(xero_tenant_id, receipt_id, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -10662,7 +10662,7 @@ Name | Type | Description | Notes # **get_receipt_attachment_by_file_name** > file get_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, content_type) -Allows you to retrieve Attachments on expense claim receipts by file name +Retrieves a specific attachment from a specific expense claim receipts by file name ### Example @@ -10691,11 +10691,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Receipt +receipt_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Receipt file_name = 'xero-dev.jpg' # str | The name of the file being attached to the Receipt content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve Attachments on expense claim receipts by file name + # Retrieves a specific attachment from a specific expense claim receipts by file name api_response = api_instance.get_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, content_type) pprint(api_response) except ApiException as e: @@ -10729,7 +10729,7 @@ Name | Type | Description | Notes # **get_receipt_attachment_by_id** > file get_receipt_attachment_by_id(xero_tenant_id, receipt_id, attachment_id, content_type) -Allows you to retrieve Attachments on expense claim receipts by ID +Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id ### Example @@ -10758,11 +10758,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Receipt -attachment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Attachment +receipt_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Receipt +attachment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Attachment content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve Attachments on expense claim receipts by ID + # Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id api_response = api_instance.get_receipt_attachment_by_id(xero_tenant_id, receipt_id, attachment_id, content_type) pprint(api_response) except ApiException as e: @@ -10796,7 +10796,7 @@ Name | Type | Description | Notes # **get_receipt_attachments** > Attachments get_receipt_attachments(xero_tenant_id, receipt_id) -Allows you to retrieve Attachments for expense claim receipts +Retrieves attachments for a specific expense claim receipt ### Example @@ -10825,9 +10825,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Receipt +receipt_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Receipt try: - # Allows you to retrieve Attachments for expense claim receipts + # Retrieves attachments for a specific expense claim receipt api_response = api_instance.get_receipt_attachments(xero_tenant_id, receipt_id) pprint(api_response) except ApiException as e: @@ -10859,7 +10859,7 @@ Name | Type | Description | Notes # **get_receipt_history** > HistoryRecords get_receipt_history(xero_tenant_id, receipt_id) -Allows you to retrieve a history records of an Receipt +Retrieves a history record for a specific receipt ### Example @@ -10888,9 +10888,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Receipt +receipt_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Receipt try: - # Allows you to retrieve a history records of an Receipt + # Retrieves a history record for a specific receipt api_response = api_instance.get_receipt_history(xero_tenant_id, receipt_id) pprint(api_response) except ApiException as e: @@ -10922,7 +10922,7 @@ Name | Type | Description | Notes # **get_receipts** > Receipts get_receipts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, unitdp=unitdp) -Allows you to retrieve draft expense claim receipts for any user +Retrieves draft expense claim receipts for any user ### Example @@ -10956,7 +10956,7 @@ where = 'Status==\"DRAFT\"' # str | Filter by an any element (optional) order = 'ReceiptNumber ASC' # str | Order by an any element (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to retrieve draft expense claim receipts for any user + # Retrieves draft expense claim receipts for any user api_response = api_instance.get_receipts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -10991,7 +10991,7 @@ Name | Type | Description | Notes # **get_repeating_invoice** > RepeatingInvoices get_repeating_invoice(xero_tenant_id, repeating_invoice_id) -Allows you to retrieve a specified repeating invoice +Retrieves a specific repeating invoice by using a unique repeating invoice Id ### Example @@ -11020,9 +11020,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Repeating Invoice +repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Repeating Invoice try: - # Allows you to retrieve a specified repeating invoice + # Retrieves a specific repeating invoice by using a unique repeating invoice Id api_response = api_instance.get_repeating_invoice(xero_tenant_id, repeating_invoice_id) pprint(api_response) except ApiException as e: @@ -11054,7 +11054,7 @@ Name | Type | Description | Notes # **get_repeating_invoice_attachment_by_file_name** > file get_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, content_type) -Allows you to retrieve specified attachment on repeating invoices by file name +Retrieves a specific attachment from a specific repeating invoices by file name ### Example @@ -11083,11 +11083,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Repeating Invoice +repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Repeating Invoice file_name = 'xero-dev.jpg' # str | The name of the file being attached to a Repeating Invoice content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve specified attachment on repeating invoices by file name + # Retrieves a specific attachment from a specific repeating invoices by file name api_response = api_instance.get_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, content_type) pprint(api_response) except ApiException as e: @@ -11121,7 +11121,7 @@ Name | Type | Description | Notes # **get_repeating_invoice_attachment_by_id** > file get_repeating_invoice_attachment_by_id(xero_tenant_id, repeating_invoice_id, attachment_id, content_type) -Allows you to retrieve a specified Attachments on repeating invoices +Retrieves a specific attachment from a specific repeating invoice ### Example @@ -11150,11 +11150,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Repeating Invoice -attachment_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Attachment +repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Repeating Invoice +attachment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Attachment content_type = 'image/jpg' # str | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf try: - # Allows you to retrieve a specified Attachments on repeating invoices + # Retrieves a specific attachment from a specific repeating invoice api_response = api_instance.get_repeating_invoice_attachment_by_id(xero_tenant_id, repeating_invoice_id, attachment_id, content_type) pprint(api_response) except ApiException as e: @@ -11188,7 +11188,7 @@ Name | Type | Description | Notes # **get_repeating_invoice_attachments** > Attachments get_repeating_invoice_attachments(xero_tenant_id, repeating_invoice_id) -Allows you to retrieve Attachments on repeating invoice +Retrieves attachments from a specific repeating invoice ### Example @@ -11217,9 +11217,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Repeating Invoice +repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Repeating Invoice try: - # Allows you to retrieve Attachments on repeating invoice + # Retrieves attachments from a specific repeating invoice api_response = api_instance.get_repeating_invoice_attachments(xero_tenant_id, repeating_invoice_id) pprint(api_response) except ApiException as e: @@ -11251,7 +11251,7 @@ Name | Type | Description | Notes # **get_repeating_invoice_history** > HistoryRecords get_repeating_invoice_history(xero_tenant_id, repeating_invoice_id) -Allows you to retrieve history for a repeating invoice +Retrieves history record for a specific repeating invoice ### Example @@ -11280,9 +11280,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Repeating Invoice +repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Repeating Invoice try: - # Allows you to retrieve history for a repeating invoice + # Retrieves history record for a specific repeating invoice api_response = api_instance.get_repeating_invoice_history(xero_tenant_id, repeating_invoice_id) pprint(api_response) except ApiException as e: @@ -11314,7 +11314,7 @@ Name | Type | Description | Notes # **get_repeating_invoices** > RepeatingInvoices get_repeating_invoices(xero_tenant_id, where=where, order=order) -Allows you to retrieve any repeating invoices +Retrieves repeating invoices ### Example @@ -11346,7 +11346,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant where = 'Status==\"DRAFT\"' # str | Filter by an any element (optional) order = 'Total ASC' # str | Order by an any element (optional) try: - # Allows you to retrieve any repeating invoices + # Retrieves repeating invoices api_response = api_instance.get_repeating_invoices(xero_tenant_id, where=where, order=order) pprint(api_response) except ApiException as e: @@ -11379,7 +11379,7 @@ Name | Type | Description | Notes # **get_report_aged_payables_by_contact** > ReportWithRows get_report_aged_payables_by_contact(xero_tenant_id, contact_id, date=date, from_date=from_date, to_date=to_date) -Allows you to retrieve report for AgedPayablesByContact +Retrieves report for aged payables by contact ### Example @@ -11408,12 +11408,12 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact +contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact date = '2013-10-20' # date | The date of the Aged Payables By Contact report (optional) from_date = '2013-10-20' # date | The from date of the Aged Payables By Contact report (optional) to_date = '2013-10-20' # date | The to date of the Aged Payables By Contact report (optional) try: - # Allows you to retrieve report for AgedPayablesByContact + # Retrieves report for aged payables by contact api_response = api_instance.get_report_aged_payables_by_contact(xero_tenant_id, contact_id, date=date, from_date=from_date, to_date=to_date) pprint(api_response) except ApiException as e: @@ -11448,7 +11448,7 @@ Name | Type | Description | Notes # **get_report_aged_receivables_by_contact** > ReportWithRows get_report_aged_receivables_by_contact(xero_tenant_id, contact_id, date=date, from_date=from_date, to_date=to_date) -Allows you to retrieve report for AgedReceivablesByContact +Retrieves report for aged receivables by contact ### Example @@ -11477,12 +11477,12 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact +contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact date = '2013-10-20' # date | The date of the Aged Receivables By Contact report (optional) from_date = '2013-10-20' # date | The from date of the Aged Receivables By Contact report (optional) to_date = '2013-10-20' # date | The to date of the Aged Receivables By Contact report (optional) try: - # Allows you to retrieve report for AgedReceivablesByContact + # Retrieves report for aged receivables by contact api_response = api_instance.get_report_aged_receivables_by_contact(xero_tenant_id, contact_id, date=date, from_date=from_date, to_date=to_date) pprint(api_response) except ApiException as e: @@ -11517,7 +11517,7 @@ Name | Type | Description | Notes # **get_report_ba_sor_gst** > ReportWithRows get_report_ba_sor_gst(xero_tenant_id, report_id) -Allows you to retrieve report for BAS only valid for AU orgs +Retrieves a specific report for BAS using a unique report Id (only valid for AU orgs) ### Example @@ -11546,9 +11546,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -report_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Report +report_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Report try: - # Allows you to retrieve report for BAS only valid for AU orgs + # Retrieves a specific report for BAS using a unique report Id (only valid for AU orgs) api_response = api_instance.get_report_ba_sor_gst(xero_tenant_id, report_id) pprint(api_response) except ApiException as e: @@ -11580,7 +11580,7 @@ Name | Type | Description | Notes # **get_report_ba_sor_gst_list** > ReportWithRows get_report_ba_sor_gst_list(xero_tenant_id) -Allows you to retrieve report for BAS only valid for AU orgs +Retrieves report for BAS (only valid for AU orgs) ### Example @@ -11610,7 +11610,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant try: - # Allows you to retrieve report for BAS only valid for AU orgs + # Retrieves report for BAS (only valid for AU orgs) api_response = api_instance.get_report_ba_sor_gst_list(xero_tenant_id) pprint(api_response) except ApiException as e: @@ -11641,7 +11641,7 @@ Name | Type | Description | Notes # **get_report_balance_sheet** > ReportWithRows get_report_balance_sheet(xero_tenant_id, date=date, periods=periods, timeframe=timeframe, tracking_option_id1=tracking_option_id1, tracking_option_id2=tracking_option_id2, standard_layout=standard_layout, payments_only=payments_only) -Allows you to retrieve report for BalanceSheet +Retrieves report for balancesheet ### Example @@ -11673,12 +11673,12 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant date = '2019-11-01' # date | The date of the Balance Sheet report (optional) periods = 3 # int | The number of periods for the Balance Sheet report (optional) timeframe = 'MONTH' # str | The period size to compare to (MONTH, QUARTER, YEAR) (optional) -tracking_option_id1 = '00000000-0000-0000-000-000000000000' # str | The tracking option 1 for the Balance Sheet report (optional) -tracking_option_id2 = '00000000-0000-0000-000-000000000000' # str | The tracking option 2 for the Balance Sheet report (optional) +tracking_option_id1 = '00000000-0000-0000-0000-000000000000' # str | The tracking option 1 for the Balance Sheet report (optional) +tracking_option_id2 = '00000000-0000-0000-0000-000000000000' # str | The tracking option 2 for the Balance Sheet report (optional) standard_layout = true # bool | The standard layout boolean for the Balance Sheet report (optional) payments_only = false # bool | return a cash basis for the Balance Sheet report (optional) try: - # Allows you to retrieve report for BalanceSheet + # Retrieves report for balancesheet api_response = api_instance.get_report_balance_sheet(xero_tenant_id, date=date, periods=periods, timeframe=timeframe, tracking_option_id1=tracking_option_id1, tracking_option_id2=tracking_option_id2, standard_layout=standard_layout, payments_only=payments_only) pprint(api_response) except ApiException as e: @@ -11716,7 +11716,7 @@ Name | Type | Description | Notes # **get_report_bank_summary** > ReportWithRows get_report_bank_summary(xero_tenant_id, from_date=from_date, to_date=to_date) -Allows you to retrieve report for BankSummary +Retrieves report for bank summary ### Example @@ -11748,7 +11748,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant from_date = '2019-11-01' # date | The from date for the Bank Summary report e.g. 2018-03-31 (optional) to_date = '2019-11-30' # date | The to date for the Bank Summary report e.g. 2018-03-31 (optional) try: - # Allows you to retrieve report for BankSummary + # Retrieves report for bank summary api_response = api_instance.get_report_bank_summary(xero_tenant_id, from_date=from_date, to_date=to_date) pprint(api_response) except ApiException as e: @@ -11781,7 +11781,7 @@ Name | Type | Description | Notes # **get_report_budget_summary** > ReportWithRows get_report_budget_summary(xero_tenant_id, date=date, period=period, timeframe=timeframe) -Allows you to retrieve report for Budget Summary +Retrieves report for budget summary ### Example @@ -11814,7 +11814,7 @@ date = '2019-03-31' # date | The date for the Bank Summary report e.g. 2018-03-3 period = 2 # int | The number of periods to compare (integer between 1 and 12) (optional) timeframe = 3 # int | The period size to compare to (1=month, 3=quarter, 12=year) (optional) try: - # Allows you to retrieve report for Budget Summary + # Retrieves report for budget summary api_response = api_instance.get_report_budget_summary(xero_tenant_id, date=date, period=period, timeframe=timeframe) pprint(api_response) except ApiException as e: @@ -11848,7 +11848,7 @@ Name | Type | Description | Notes # **get_report_executive_summary** > ReportWithRows get_report_executive_summary(xero_tenant_id, date=date) -Allows you to retrieve report for ExecutiveSummary +Retrieves report for executive summary ### Example @@ -11879,7 +11879,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant date = '2019-03-31' # date | The date for the Bank Summary report e.g. 2018-03-31 (optional) try: - # Allows you to retrieve report for ExecutiveSummary + # Retrieves report for executive summary api_response = api_instance.get_report_executive_summary(xero_tenant_id, date=date) pprint(api_response) except ApiException as e: @@ -11911,7 +11911,7 @@ Name | Type | Description | Notes # **get_report_profit_and_loss** > ReportWithRows get_report_profit_and_loss(xero_tenant_id, from_date=from_date, to_date=to_date, periods=periods, timeframe=timeframe, tracking_category_id=tracking_category_id, tracking_category_id2=tracking_category_id2, tracking_option_id=tracking_option_id, tracking_option_id2=tracking_option_id2, standard_layout=standard_layout, payments_only=payments_only) -Allows you to retrieve report for ProfitAndLoss +Retrieves report for profit and loss ### Example @@ -11944,14 +11944,14 @@ from_date = '2019-03-01' # date | The from date for the ProfitAndLoss report e.g to_date = '2019-03-31' # date | The to date for the ProfitAndLoss report e.g. 2018-03-31 (optional) periods = 3 # int | The number of periods to compare (integer between 1 and 12) (optional) timeframe = 'MONTH' # str | The period size to compare to (MONTH, QUARTER, YEAR) (optional) -tracking_category_id = '00000000-0000-0000-000-000000000000' # str | The trackingCategory 1 for the ProfitAndLoss report (optional) -tracking_category_id2 = '00000000-0000-0000-000-000000000000' # str | The trackingCategory 2 for the ProfitAndLoss report (optional) -tracking_option_id = '00000000-0000-0000-000-000000000000' # str | The tracking option 1 for the ProfitAndLoss report (optional) -tracking_option_id2 = '00000000-0000-0000-000-000000000000' # str | The tracking option 2 for the ProfitAndLoss report (optional) +tracking_category_id = '00000000-0000-0000-0000-000000000000' # str | The trackingCategory 1 for the ProfitAndLoss report (optional) +tracking_category_id2 = '00000000-0000-0000-0000-000000000000' # str | The trackingCategory 2 for the ProfitAndLoss report (optional) +tracking_option_id = '00000000-0000-0000-0000-000000000000' # str | The tracking option 1 for the ProfitAndLoss report (optional) +tracking_option_id2 = '00000000-0000-0000-0000-000000000000' # str | The tracking option 2 for the ProfitAndLoss report (optional) standard_layout = true # bool | Return the standard layout for the ProfitAndLoss report (optional) payments_only = false # bool | Return cash only basis for the ProfitAndLoss report (optional) try: - # Allows you to retrieve report for ProfitAndLoss + # Retrieves report for profit and loss api_response = api_instance.get_report_profit_and_loss(xero_tenant_id, from_date=from_date, to_date=to_date, periods=periods, timeframe=timeframe, tracking_category_id=tracking_category_id, tracking_category_id2=tracking_category_id2, tracking_option_id=tracking_option_id, tracking_option_id2=tracking_option_id2, standard_layout=standard_layout, payments_only=payments_only) pprint(api_response) except ApiException as e: @@ -11992,7 +11992,7 @@ Name | Type | Description | Notes # **get_report_ten_ninety_nine** > Reports get_report_ten_ninety_nine(xero_tenant_id, report_year=report_year) -Allows you to retrieve report for TenNinetyNine +Retrieve reports for 1099 ### Example @@ -12023,7 +12023,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant report_year = '2019' # str | The year of the 1099 report (optional) try: - # Allows you to retrieve report for TenNinetyNine + # Retrieve reports for 1099 api_response = api_instance.get_report_ten_ninety_nine(xero_tenant_id, report_year=report_year) pprint(api_response) except ApiException as e: @@ -12055,7 +12055,7 @@ Name | Type | Description | Notes # **get_report_trial_balance** > ReportWithRows get_report_trial_balance(xero_tenant_id, date=date, payments_only=payments_only) -Allows you to retrieve report for TrialBalance +Retrieves report for trial balance ### Example @@ -12087,7 +12087,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant date = '2019-10-31' # date | The date for the Trial Balance report e.g. 2018-03-31 (optional) payments_only = true # bool | Return cash only basis for the Trial Balance report (optional) try: - # Allows you to retrieve report for TrialBalance + # Retrieves report for trial balance api_response = api_instance.get_report_trial_balance(xero_tenant_id, date=date, payments_only=payments_only) pprint(api_response) except ApiException as e: @@ -12120,7 +12120,7 @@ Name | Type | Description | Notes # **get_tax_rates** > TaxRates get_tax_rates(xero_tenant_id, where=where, order=order, tax_type=tax_type) -Allows you to retrieve Tax Rates +Retrieves tax rates ### Example @@ -12153,7 +12153,7 @@ where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) order = 'Name ASC' # str | Order by an any element (optional) tax_type = 'INPUT' # str | Filter by tax type (optional) try: - # Allows you to retrieve Tax Rates + # Retrieves tax rates api_response = api_instance.get_tax_rates(xero_tenant_id, where=where, order=order, tax_type=tax_type) pprint(api_response) except ApiException as e: @@ -12187,7 +12187,7 @@ Name | Type | Description | Notes # **get_tracking_categories** > TrackingCategories get_tracking_categories(xero_tenant_id, where=where, order=order, include_archived=include_archived) -Allows you to retrieve tracking categories and options +Retrieves tracking categories and options ### Example @@ -12220,7 +12220,7 @@ where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) order = 'Name ASC' # str | Order by an any element (optional) include_archived = True # bool | e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response (optional) try: - # Allows you to retrieve tracking categories and options + # Retrieves tracking categories and options api_response = api_instance.get_tracking_categories(xero_tenant_id, where=where, order=order, include_archived=include_archived) pprint(api_response) except ApiException as e: @@ -12254,7 +12254,7 @@ Name | Type | Description | Notes # **get_tracking_category** > TrackingCategories get_tracking_category(xero_tenant_id, tracking_category_id) -Allows you to retrieve tracking categories and options for specified category +Retrieves specific tracking categories and options using a unique tracking category Id ### Example @@ -12283,9 +12283,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -tracking_category_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a TrackingCategory +tracking_category_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a TrackingCategory try: - # Allows you to retrieve tracking categories and options for specified category + # Retrieves specific tracking categories and options using a unique tracking category Id api_response = api_instance.get_tracking_category(xero_tenant_id, tracking_category_id) pprint(api_response) except ApiException as e: @@ -12317,7 +12317,7 @@ Name | Type | Description | Notes # **get_user** > Users get_user(xero_tenant_id, user_id) -Allows you to retrieve a specified user +Retrieves a specific user ### Example @@ -12346,9 +12346,9 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -user_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a User +user_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a User try: - # Allows you to retrieve a specified user + # Retrieves a specific user api_response = api_instance.get_user(xero_tenant_id, user_id) pprint(api_response) except ApiException as e: @@ -12380,7 +12380,7 @@ Name | Type | Description | Notes # **get_users** > Users get_users(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) -Allows you to retrieve users +Retrieves users ### Example @@ -12413,7 +12413,7 @@ if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records cr where = 'IsSubscriber==true' # str | Filter by an any element (optional) order = 'LastName ASC' # str | Order by an any element (optional) try: - # Allows you to retrieve users + # Retrieves users api_response = api_instance.get_users(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order) pprint(api_response) except ApiException as e: @@ -12447,7 +12447,7 @@ Name | Type | Description | Notes # **post_setup** > ImportSummaryObject post_setup(xero_tenant_id, setup) -Allows you to set the chart of accounts, the conversion date and conversion balances +Sets the chart of accounts, the conversion date and conversion balances ### Example @@ -12478,7 +12478,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant setup = { "ConversionDate": {}, "ConversionBalances": [], "Accounts": [ { "Code": "200", "Name": "Sales", "Type": "SALES", "ReportingCode": "REV.TRA.GOO" }, { "Code": "400", "Name": "Advertising", "Type": "OVERHEADS", "ReportingCode": "EXP" }, { "Code": "610", "Name": "Accounts Receivable", "Type": "CURRENT", "SystemAccount": "DEBTORS", "ReportingCode": "ASS.CUR.REC.TRA" }, { "Code": "800", "Name": "Accounts Payable", "Type": "CURRLIAB", "SystemAccount": "CREDITORS", "ReportingCode": "LIA.CUR.PAY" } ] } # Setup | Object including an accounts array, a conversion balances array and a conversion date object in body of request try: - # Allows you to set the chart of accounts, the conversion date and conversion balances + # Sets the chart of accounts, the conversion date and conversion balances api_response = api_instance.post_setup(xero_tenant_id, setup) pprint(api_response) except ApiException as e: @@ -12510,7 +12510,7 @@ Name | Type | Description | Notes # **update_account** > Accounts update_account(xero_tenant_id, account_id, accounts) -Allows you to update a chart of accounts +Updates a chart of accounts ### Example @@ -12539,10 +12539,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -account_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for retrieving single object +account_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for retrieving single object accounts = { "Accounts":[ { "Code":"123456", "Name":"BarFoo", "AccountID":"99ce6032-0678-4aa0-8148-240c75fee33a", "Type":"EXPENSE", "Description":"GoodBye World", "TaxType":"INPUT", "EnablePaymentsToAccount":false, "ShowInExpenseClaims":false, "Class":"EXPENSE", "ReportingCode":"EXP", "ReportingCodeName":"Expense", "UpdatedDateUTC":"2019-02-21T16:29:47.96-08:00" } ] } # Accounts | Request of type Accounts array with one Account try: - # Allows you to update a chart of accounts + # Updates a chart of accounts api_response = api_instance.update_account(xero_tenant_id, account_id, accounts) pprint(api_response) except ApiException as e: @@ -12575,7 +12575,7 @@ Name | Type | Description | Notes # **update_account_attachment_by_file_name** > Attachments update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) -Allows you to update Attachment on Account by Filename +Updates attachment on a specific account by filename ### Example @@ -12604,11 +12604,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -account_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Account object +account_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Account object file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to update Attachment on Account by Filename + # Updates attachment on a specific account by filename api_response = api_instance.update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) pprint(api_response) except ApiException as e: @@ -12642,7 +12642,7 @@ Name | Type | Description | Notes # **update_bank_transaction** > BankTransactions update_bank_transaction(xero_tenant_id, bank_transaction_id, bank_transactions, unitdp=unitdp) -Allows you to update a single spend or receive money transaction +Updates a single spent or received money transaction ### Example @@ -12671,11 +12671,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transaction -bank_transactions = { "BankTransactions": [ { "Type": "SPEND", "Contact": { "ContactID": "00000000-0000-0000-000-000000000000", "ContactStatus": "ACTIVE", "Name": "Buzz Lightyear", "FirstName": "Buzz", "LastName": "Lightyear", "EmailAddress": "buzz.Lightyear@email.com", "ContactPersons": [], "BankAccountDetails": "", "Addresses": [ { "AddressType": "STREET", "City": "", "Region": "", "PostalCode": "", "Country": "" }, { "AddressType": "POBOX", "AddressLine1": "", "AddressLine2": "", "AddressLine3": "", "AddressLine4": "", "City": "Palo Alto", "Region": "CA", "PostalCode": "94020", "Country": "United States" } ], "Phones": [ { "PhoneType": "DEFAULT", "PhoneNumber": "847-1294", "PhoneAreaCode": "(626)", "PhoneCountryCode": "" }, { "PhoneType": "DDI", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "FAX", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "MOBILE", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" } ], "UpdatedDateUTC": "2017-08-21T13:49:04.227-07:00", "ContactGroups": [] }, "Lineitems": [], "BankAccount": { "Code": "088", "Name": "Business Wells Fargo", "AccountID": "00000000-0000-0000-000-000000000000" }, "IsReconciled": false, "Date": "2019-02-25", "Reference": "You just updated", "CurrencyCode": "USD", "CurrencyRate": 1, "Status": "AUTHORISED", "LineAmountTypes": "Inclusive", "TotalTax": 1.74, "BankTransactionID": "00000000-0000-0000-000-000000000000", "UpdatedDateUTC": "2019-02-26T12:39:27.813-08:00" } ] } # BankTransactions | +bank_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transaction +bank_transactions = { "BankTransactions": [ { "Type": "SPEND", "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000", "ContactStatus": "ACTIVE", "Name": "Buzz Lightyear", "FirstName": "Buzz", "LastName": "Lightyear", "EmailAddress": "buzz.Lightyear@email.com", "ContactPersons": [], "BankAccountDetails": "", "Addresses": [ { "AddressType": "STREET", "City": "", "Region": "", "PostalCode": "", "Country": "" }, { "AddressType": "POBOX", "AddressLine1": "", "AddressLine2": "", "AddressLine3": "", "AddressLine4": "", "City": "Palo Alto", "Region": "CA", "PostalCode": "94020", "Country": "United States" } ], "Phones": [ { "PhoneType": "DEFAULT", "PhoneNumber": "847-1294", "PhoneAreaCode": "(626)", "PhoneCountryCode": "" }, { "PhoneType": "DDI", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "FAX", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "MOBILE", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" } ], "UpdatedDateUTC": "2017-08-21T13:49:04.227-07:00", "ContactGroups": [] }, "Lineitems": [], "BankAccount": { "Code": "088", "Name": "Business Wells Fargo", "AccountID": "00000000-0000-0000-0000-000000000000" }, "IsReconciled": false, "Date": "2019-02-25", "Reference": "You just updated", "CurrencyCode": "USD", "CurrencyRate": 1, "Status": "AUTHORISED", "LineAmountTypes": "Inclusive", "TotalTax": 1.74, "BankTransactionID": "00000000-0000-0000-0000-000000000000", "UpdatedDateUTC": "2019-02-26T12:39:27.813-08:00" } ] } # BankTransactions | unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to update a single spend or receive money transaction + # Updates a single spent or received money transaction api_response = api_instance.update_bank_transaction(xero_tenant_id, bank_transaction_id, bank_transactions, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -12709,7 +12709,7 @@ Name | Type | Description | Notes # **update_bank_transaction_attachment_by_file_name** > Attachments update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) -Allows you to update an Attachment on BankTransaction by Filename +Updates a specific attachment from a specific bank transaction by filename ### Example @@ -12738,11 +12738,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transaction +bank_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transaction file_name = 'xero-dev.jpg' # str | The name of the file being attached body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to update an Attachment on BankTransaction by Filename + # Updates a specific attachment from a specific bank transaction by filename api_response = api_instance.update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) pprint(api_response) except ApiException as e: @@ -12805,7 +12805,7 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-000-000000000000' # str | Xero generated unique identifier for a bank transfer +bank_transfer_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transfer file_name = 'xero-dev.jpg' # str | The name of the file being attached to a Bank Transfer body = 'body_example' # str | Byte array of file in body of request try: @@ -12842,7 +12842,7 @@ Name | Type | Description | Notes # **update_contact** > Contacts update_contact(xero_tenant_id, contact_id, contacts) -Allows you to update one contact in a Xero organisation +Updates a specific contact in a Xero organisation ### Example @@ -12871,10 +12871,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact -contacts = { "Contacts": [{ "ContactID": "00000000-0000-0000-000-000000000000", "Name": "Thanos" }]} # Contacts | an array of Contacts containing single Contact object with properties to update +contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact +contacts = { "Contacts": [{ "ContactID": "00000000-0000-0000-0000-000000000000", "Name": "Thanos" }]} # Contacts | an array of Contacts containing single Contact object with properties to update try: - # Allows you to update one contact in a Xero organisation + # Updates a specific contact in a Xero organisation api_response = api_instance.update_contact(xero_tenant_id, contact_id, contacts) pprint(api_response) except ApiException as e: @@ -12936,7 +12936,7 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact +contact_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact file_name = 'xero-dev.jpg' # str | Name for the file you are attaching body = 'body_example' # str | Byte array of file in body of request try: @@ -12973,7 +12973,7 @@ Name | Type | Description | Notes # **update_contact_group** > ContactGroups update_contact_group(xero_tenant_id, contact_group_id, contact_groups) -Allows you to update a Contact Group +Updates a specific contact group ### Example @@ -13002,10 +13002,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -contact_group_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Contact Group +contact_group_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Contact Group contact_groups = { "ContactGroups":[ { "Name":"Suppliers" } ] } # ContactGroups | an array of Contact groups with Name of specific group to update try: - # Allows you to update a Contact Group + # Updates a specific contact group api_response = api_instance.update_contact_group(xero_tenant_id, contact_group_id, contact_groups) pprint(api_response) except ApiException as e: @@ -13038,7 +13038,7 @@ Name | Type | Description | Notes # **update_credit_note** > CreditNotes update_credit_note(xero_tenant_id, credit_note_id, credit_notes, unitdp=unitdp) -Allows you to update a specific credit note +Updates a specific credit note ### Example @@ -13067,11 +13067,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Credit Note +credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note credit_notes = { "CreditNotes": [ { "Type": "ACCPAYCREDIT", "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8" }, "Date": "2019-01-05", "Status": "AUTHORISED", "Reference": "HelloWorld", "LineItems": [ { "Description": "Foobar", "Quantity": 2, "UnitAmount": 20, "AccountCode": "400" } ] } ] } # CreditNotes | an array of Credit Notes containing credit note details to update unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to update a specific credit note + # Updates a specific credit note api_response = api_instance.update_credit_note(xero_tenant_id, credit_note_id, credit_notes, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -13105,7 +13105,7 @@ Name | Type | Description | Notes # **update_credit_note_attachment_by_file_name** > Attachments update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body) -Allows you to update Attachments on CreditNote by file name +Updates attachments on a specific credit note by file name ### Example @@ -13134,11 +13134,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Credit Note +credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note file_name = 'xero-dev.jpg' # str | Name of the file you are attaching to Credit Note body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to update Attachments on CreditNote by file name + # Updates attachments on a specific credit note by file name api_response = api_instance.update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body) pprint(api_response) except ApiException as e: @@ -13172,7 +13172,7 @@ Name | Type | Description | Notes # **update_expense_claim** > ExpenseClaims update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims) -Allows you to update specified expense claims +Updates a specific expense claims ### Example @@ -13201,10 +13201,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -expense_claim_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a ExpenseClaim +expense_claim_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ExpenseClaim expense_claims = { "ExpenseClaims": [ { "Status": "SUBMITTED", "User": { "UserID": "d1164823-0ac1-41ad-987b-b4e30fe0b273" }, "Receipts": [ { "Lineitems": [], "ReceiptID": "dc1c7f6d-0a4c-402f-acac-551d62ce5816" } ] } ] } # ExpenseClaims | try: - # Allows you to update specified expense claims + # Updates a specific expense claims api_response = api_instance.update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims) pprint(api_response) except ApiException as e: @@ -13237,7 +13237,7 @@ Name | Type | Description | Notes # **update_invoice** > Invoices update_invoice(xero_tenant_id, invoice_id, invoices, unitdp=unitdp) -Allows you to update a specified sales invoices or purchase bills +Updates a specific sales invoices or purchase bills ### Example @@ -13266,11 +13266,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Invoice -invoices = { "Invoices": [{ Reference: "May the force be with you", "InvoiceID": "00000000-0000-0000-000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }]} # Invoices | +invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice +invoices = { "Invoices": [{ Reference: "May the force be with you", "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }]} # Invoices | unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to update a specified sales invoices or purchase bills + # Updates a specific sales invoices or purchase bills api_response = api_instance.update_invoice(xero_tenant_id, invoice_id, invoices, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -13304,7 +13304,7 @@ Name | Type | Description | Notes # **update_invoice_attachment_by_file_name** > Attachments update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body) -Allows you to update Attachment on invoices or purchase bills by it's filename +Updates an attachment from a specific invoices or purchase bill by filename ### Example @@ -13333,11 +13333,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Invoice +invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice file_name = 'xero-dev.jpg' # str | Name of the file you are attaching body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to update Attachment on invoices or purchase bills by it's filename + # Updates an attachment from a specific invoices or purchase bill by filename api_response = api_instance.update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body) pprint(api_response) except ApiException as e: @@ -13371,7 +13371,7 @@ Name | Type | Description | Notes # **update_item** > Items update_item(xero_tenant_id, item_id, items, unitdp=unitdp) -Allows you to update a specified item +Updates a specific item ### Example @@ -13400,11 +13400,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -item_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Item +item_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Item items = { "Items": [ { "Code": "ItemCode123", "Description": "Description 123" } ] } # Items | unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to update a specified item + # Updates a specific item api_response = api_instance.update_item(xero_tenant_id, item_id, items, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -13438,7 +13438,7 @@ Name | Type | Description | Notes # **update_linked_transaction** > LinkedTransactions update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions) -Allows you to update a specified linked transactions (billable expenses) +Updates a specific linked transactions (billable expenses) ### Example @@ -13467,10 +13467,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -linked_transaction_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a LinkedTransaction -linked_transactions = { "LinkedTransactions": [ { "SourceTransactionID": "00000000-0000-0000-000-000000000000", "SourceLineItemID": "00000000-0000-0000-000-000000000000" } ] } # LinkedTransactions | +linked_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a LinkedTransaction +linked_transactions = { "LinkedTransactions": [ { "SourceTransactionID": "00000000-0000-0000-0000-000000000000", "SourceLineItemID": "00000000-0000-0000-0000-000000000000" } ] } # LinkedTransactions | try: - # Allows you to update a specified linked transactions (billable expenses) + # Updates a specific linked transactions (billable expenses) api_response = api_instance.update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions) pprint(api_response) except ApiException as e: @@ -13503,7 +13503,7 @@ Name | Type | Description | Notes # **update_manual_journal** > ManualJournals update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals) -Allows you to update a specified manual journal +Updates a specific manual journal ### Example @@ -13532,10 +13532,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a ManualJournal -manual_journals = { "ManualJournals": [ { "Narration": "Hello Xero", "ManualJournalID": "00000000-0000-0000-000-000000000000", "JournalLines": [] } ] } # ManualJournals | +manual_journal_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ManualJournal +manual_journals = { "ManualJournals": [ { "Narration": "Hello Xero", "ManualJournalID": "00000000-0000-0000-0000-000000000000", "JournalLines": [] } ] } # ManualJournals | try: - # Allows you to update a specified manual journal + # Updates a specific manual journal api_response = api_instance.update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals) pprint(api_response) except ApiException as e: @@ -13568,7 +13568,7 @@ Name | Type | Description | Notes # **update_manual_journal_attachment_by_file_name** > Attachments update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) -Allows you to update a specified Attachment on ManualJournal by file name +Updates a specific attachment from a specific manual journal by file name ### Example @@ -13597,11 +13597,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a ManualJournal +manual_journal_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a ManualJournal file_name = 'xero-dev.jpg' # str | The name of the file being attached to a ManualJournal body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to update a specified Attachment on ManualJournal by file name + # Updates a specific attachment from a specific manual journal by file name api_response = api_instance.update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) pprint(api_response) except ApiException as e: @@ -13635,7 +13635,7 @@ Name | Type | Description | Notes # **update_or_create_bank_transactions** > BankTransactions update_or_create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp) -Allows you to update or create one or more spend or receive money transaction +Updates or creates one or more spent or received money transaction ### Example @@ -13664,11 +13664,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -bank_transactions = { "BankTransactions": [ { "Type": "SPEND", "Contact": { "ContactID": "00000000-0000-0000-000-000000000000" }, "Lineitems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "400" } ], "BankAccount": { "Code": "088" } } ] } # BankTransactions | +bank_transactions = { "BankTransactions": [ { "Type": "SPEND", "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "Lineitems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "400" } ], "BankAccount": { "Code": "088" } } ] } # BankTransactions | summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to update or create one or more spend or receive money transaction + # Updates or creates one or more spent or received money transaction api_response = api_instance.update_or_create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -13702,7 +13702,7 @@ Name | Type | Description | Notes # **update_or_create_contacts** > Contacts update_or_create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors) -Allows you to update OR create one or more contacts in a Xero organisation +Updates or creates one or more contacts in a Xero organisation ### Example @@ -13734,7 +13734,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant contacts = { "Contacts": [ { "Name": "Bruce Banner", "EmailAddress": "hulk@avengers.com", "Phones": [ { "PhoneType": "MOBILE", "PhoneNumber": "555-1212", "PhoneAreaCode": "415" } ], "PaymentTerms": { "Bills": { "Day": 15, "Type": "OFCURRENTMONTH" }, "Sales": { "Day": 10, "Type": "DAYSAFTERBILLMONTH" } } } ] } # Contacts | summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: - # Allows you to update OR create one or more contacts in a Xero organisation + # Updates or creates one or more contacts in a Xero organisation api_response = api_instance.update_or_create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors) pprint(api_response) except ApiException as e: @@ -13767,7 +13767,7 @@ Name | Type | Description | Notes # **update_or_create_credit_notes** > CreditNotes update_or_create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp) -Allows you to update OR create one or more credit notes +Updates or creates one or more credit notes ### Example @@ -13800,7 +13800,7 @@ credit_notes = { "CreditNotes":[ { "Type":"ACCPAYCREDIT", "Contact":{ "ContactID summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to update OR create one or more credit notes + # Updates or creates one or more credit notes api_response = api_instance.update_or_create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -13834,7 +13834,7 @@ Name | Type | Description | Notes # **update_or_create_employees** > Employees update_or_create_employees(xero_tenant_id, employees, summarize_errors=summarize_errors) -Allows you to create a single new employees used in Xero payrun +Creates a single new employees used in Xero payrun ### Example @@ -13866,7 +13866,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant employees = { "Employees": [ { "FirstName": "Nick", "LastName": "Fury", "ExternalLink": { "Url": "http://twitter.com/#!/search/Nick+Fury" } } ] } # Employees | Employees with array of Employee object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: - # Allows you to create a single new employees used in Xero payrun + # Creates a single new employees used in Xero payrun api_response = api_instance.update_or_create_employees(xero_tenant_id, employees, summarize_errors=summarize_errors) pprint(api_response) except ApiException as e: @@ -13899,7 +13899,7 @@ Name | Type | Description | Notes # **update_or_create_invoices** > Invoices update_or_create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp) -Allows you to update OR create one or more sales invoices or purchase bills +Updates or creates one or more sales invoices or purchase bills ### Example @@ -13932,7 +13932,7 @@ invoices = { "Invoices": [ { "Type": "ACCREC", "Contact": { "ContactID": "430fa1 summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to update OR create one or more sales invoices or purchase bills + # Updates or creates one or more sales invoices or purchase bills api_response = api_instance.update_or_create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -13966,7 +13966,7 @@ Name | Type | Description | Notes # **update_or_create_items** > Items update_or_create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp) -Allows you to update or create one or more items +Updates or creates one or more items ### Example @@ -13999,7 +13999,7 @@ items = { "Items": [ { "Code": "ItemCode123", "Name": "ItemName XYZ", "Descripti summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to update or create one or more items + # Updates or creates one or more items api_response = api_instance.update_or_create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -14033,7 +14033,7 @@ Name | Type | Description | Notes # **update_or_create_manual_journals** > ManualJournals update_or_create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors) -Allows you to create a single manual journal +Updates or creates a single manual journal ### Example @@ -14065,7 +14065,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant manual_journals = { "ManualJournals": [ { "Narration": "Journal Desc", "JournalLines": [ { "LineAmount": 100, "AccountCode": "400", "Description": "Money Movement" }, { "LineAmount": -100, "AccountCode": "400", "Description": "Prepayment of things", "Tracking": [ { "Name": "North", "Option": "Region" } ] } ], "Date": "2019-03-14" } ] } # ManualJournals | ManualJournals array with ManualJournal object in body of request summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: - # Allows you to create a single manual journal + # Updates or creates a single manual journal api_response = api_instance.update_or_create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors) pprint(api_response) except ApiException as e: @@ -14098,7 +14098,7 @@ Name | Type | Description | Notes # **update_or_create_purchase_orders** > PurchaseOrders update_or_create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors) -Allows you to update or create one or more purchase orders +Updates or creates one or more purchase orders ### Example @@ -14127,10 +14127,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -purchase_orders = { "PurchaseOrders": [ { "Contact": { "ContactID": "00000000-0000-0000-000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "710" } ], "Date": "2019-03-13" } ] } # PurchaseOrders | +purchase_orders = { "PurchaseOrders": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "710" } ], "Date": "2019-03-13" } ] } # PurchaseOrders | summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: - # Allows you to update or create one or more purchase orders + # Updates or creates one or more purchase orders api_response = api_instance.update_or_create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors) pprint(api_response) except ApiException as e: @@ -14163,7 +14163,7 @@ Name | Type | Description | Notes # **update_or_create_quotes** > Quotes update_or_create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors) -Allows you to update OR create one or more quotes +Updates or creates one or more quotes ### Example @@ -14192,10 +14192,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -quotes = { "Quotes": [ { "Contact": { "ContactID": "00000000-0000-0000-000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "12775" } ], "Date": "2020-02-01" } ] } # Quotes | +quotes = { "Quotes": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "12775" } ], "Date": "2020-02-01" } ] } # Quotes | summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) try: - # Allows you to update OR create one or more quotes + # Updates or creates one or more quotes api_response = api_instance.update_or_create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors) pprint(api_response) except ApiException as e: @@ -14228,7 +14228,7 @@ Name | Type | Description | Notes # **update_purchase_order** > PurchaseOrders update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders) -Allows you to update a specified purchase order +Updates a specific purchase order ### Example @@ -14257,10 +14257,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a PurchaseOrder +purchase_order_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a PurchaseOrder purchase_orders = { "PurchaseOrders": [ { "AttentionTo": "Peter Parker", "LineItems": [], "Contact": {} } ] } # PurchaseOrders | try: - # Allows you to update a specified purchase order + # Updates a specific purchase order api_response = api_instance.update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders) pprint(api_response) except ApiException as e: @@ -14293,7 +14293,7 @@ Name | Type | Description | Notes # **update_purchase_order_attachment_by_file_name** > Attachments update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) -Allows you to update Attachment on Purchase Order by Filename +Updates a specific attachment for a specific purchase order by filename ### Example @@ -14322,11 +14322,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Purchase Order object +purchase_order_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Purchase Order object file_name = 'xero-dev.png' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to update Attachment on Purchase Order by Filename + # Updates a specific attachment for a specific purchase order by filename api_response = api_instance.update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) pprint(api_response) except ApiException as e: @@ -14360,7 +14360,7 @@ Name | Type | Description | Notes # **update_quote** > Quotes update_quote(xero_tenant_id, quote_id, quotes) -Allows you to update a specified quote +Updates a specific quote ### Example @@ -14389,10 +14389,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -quote_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for an Quote -quotes = { "Quotes": [ { "Reference": "I am an update", "Contact": { "ContactID": "00000000-0000-0000-000-000000000000" }, "Date": "2020-02-01" } ] } # Quotes | +quote_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Quote +quotes = { "Quotes": [ { "Reference": "I am an update", "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "Date": "2020-02-01" } ] } # Quotes | try: - # Allows you to update a specified quote + # Updates a specific quote api_response = api_instance.update_quote(xero_tenant_id, quote_id, quotes) pprint(api_response) except ApiException as e: @@ -14425,7 +14425,7 @@ Name | Type | Description | Notes # **update_quote_attachment_by_file_name** > Attachments update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) -Allows you to update Attachment on Quote by Filename +Updates a specific attachment from a specific quote by filename ### Example @@ -14454,11 +14454,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -quote_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for Quote object +quote_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Quote object file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to update Attachment on Quote by Filename + # Updates a specific attachment from a specific quote by filename api_response = api_instance.update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) pprint(api_response) except ApiException as e: @@ -14492,7 +14492,7 @@ Name | Type | Description | Notes # **update_receipt** > Receipts update_receipt(xero_tenant_id, receipt_id, receipts, unitdp=unitdp) -Allows you to retrieve a specified draft expense claim receipts +Updates a specific draft expense claim receipts ### Example @@ -14521,11 +14521,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Receipt -receipts = { "Receipts": [ { "Lineitems": [], "User": { "UserID": "00000000-0000-0000-000-000000000000" }, "Reference": "Foobar" } ] } # Receipts | +receipt_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Receipt +receipts = { "Receipts": [ { "Lineitems": [], "User": { "UserID": "00000000-0000-0000-0000-000000000000" }, "Reference": "Foobar" } ] } # Receipts | unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) try: - # Allows you to retrieve a specified draft expense claim receipts + # Updates a specific draft expense claim receipts api_response = api_instance.update_receipt(xero_tenant_id, receipt_id, receipts, unitdp=unitdp) pprint(api_response) except ApiException as e: @@ -14559,7 +14559,7 @@ Name | Type | Description | Notes # **update_receipt_attachment_by_file_name** > Attachments update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) -Allows you to update Attachment on expense claim receipts by file name +Updates a specific attachment on a specific expense claim receipts by file name ### Example @@ -14588,11 +14588,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Receipt +receipt_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Receipt file_name = 'xero-dev.jpg' # str | The name of the file being attached to the Receipt body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to update Attachment on expense claim receipts by file name + # Updates a specific attachment on a specific expense claim receipts by file name api_response = api_instance.update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) pprint(api_response) except ApiException as e: @@ -14626,7 +14626,7 @@ Name | Type | Description | Notes # **update_repeating_invoice_attachment_by_file_name** > Attachments update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) -Allows you to update specified attachment on repeating invoices by file name +Updates a specific attachment from a specific repeating invoices by file name ### Example @@ -14655,11 +14655,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Repeating Invoice +repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Repeating Invoice file_name = 'xero-dev.jpg' # str | The name of the file being attached to a Repeating Invoice body = 'body_example' # str | Byte array of file in body of request try: - # Allows you to update specified attachment on repeating invoices by file name + # Updates a specific attachment from a specific repeating invoices by file name api_response = api_instance.update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) pprint(api_response) except ApiException as e: @@ -14693,7 +14693,7 @@ Name | Type | Description | Notes # **update_tax_rate** > TaxRates update_tax_rate(xero_tenant_id, tax_rates) -Allows you to update Tax Rates +Updates tax rates ### Example @@ -14724,7 +14724,7 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant tax_rates = { "TaxRates": [ { "Name": "State Tax NY", "TaxComponents": [ { "Name": "State Tax", "Rate": 2.25 } ], "Status": "DELETED", "ReportTaxType": "INPUT" } ] } # TaxRates | try: - # Allows you to update Tax Rates + # Updates tax rates api_response = api_instance.update_tax_rate(xero_tenant_id, tax_rates) pprint(api_response) except ApiException as e: @@ -14756,7 +14756,7 @@ Name | Type | Description | Notes # **update_tracking_category** > TrackingCategories update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category) -Allows you to update tracking categories +Updates a specific tracking category ### Example @@ -14785,10 +14785,10 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -tracking_category_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a TrackingCategory +tracking_category_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a TrackingCategory tracking_category = { "Name": "Avengers" } # TrackingCategory | try: - # Allows you to update tracking categories + # Updates a specific tracking category api_response = api_instance.update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category) pprint(api_response) except ApiException as e: @@ -14821,7 +14821,7 @@ Name | Type | Description | Notes # **update_tracking_options** > TrackingOptions update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option) -Allows you to update options for a specified tracking category +Updates a specific option for a specific tracking category ### Example @@ -14850,11 +14850,11 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -tracking_category_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a TrackingCategory -tracking_option_id = '00000000-0000-0000-000-000000000000' # str | Unique identifier for a Tracking Option +tracking_category_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a TrackingCategory +tracking_option_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Tracking Option tracking_option = { name: "Vision" } # TrackingOption | try: - # Allows you to update options for a specified tracking category + # Updates a specific option for a specific tracking category api_response = api_instance.update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option) pprint(api_response) except ApiException as e: diff --git a/xero_python/accounting/docs/CISOrgSettings.md b/xero_python/accounting/docs/CISOrgSettings.md new file mode 100644 index 00000000..8aefff61 --- /dev/null +++ b/xero_python/accounting/docs/CISOrgSettings.md @@ -0,0 +1,10 @@ +# CISOrgSettings + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cis_settings** | [**list[CISOrgSetting]**](CISOrgSetting.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/CreditNote.md b/xero_python/accounting/docs/CreditNote.md index 5126f005..a36c6472 100644 --- a/xero_python/accounting/docs/CreditNote.md +++ b/xero_python/accounting/docs/CreditNote.md @@ -32,6 +32,7 @@ Name | Type | Description | Notes **has_attachments** | **bool** | boolean to indicate if a credit note has an attachment | [optional] [default to False] **has_errors** | **bool** | A boolean to indicate if a credit note has an validation errors | [optional] [default to False] **validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning 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/accounting/docs/Payment.md b/xero_python/accounting/docs/Payment.md index a54d0551..834c47a1 100644 --- a/xero_python/accounting/docs/Payment.md +++ b/xero_python/accounting/docs/Payment.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **payment_type** | **str** | See Payment Types. | [optional] **updated_date_utc** | **datetime** | UTC timestamp of last update to the payment | [optional] **payment_id** | **str** | The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional] +**batch_payment_id** | **str** | Present if the payment was created as part of a batch. | [optional] **bank_account_number** | **str** | The suppliers bank account number the payment is being made to | [optional] **particulars** | **str** | The suppliers bank account number the payment is being made to | [optional] **details** | **str** | The information to appear on the supplier's bank account | [optional] diff --git a/xero_python/accounting/models/__init__.py b/xero_python/accounting/models/__init__.py index 48003c1b..053b6f68 100644 --- a/xero_python/accounting/models/__init__.py +++ b/xero_python/accounting/models/__init__.py @@ -2,7 +2,7 @@ # flake8: noqa """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 @@ -40,6 +40,7 @@ from xero_python.accounting.models.branding_theme import BrandingTheme from xero_python.accounting.models.branding_themes import BrandingThemes from xero_python.accounting.models.cis_org_setting import CISOrgSetting +from xero_python.accounting.models.cis_org_settings import CISOrgSettings from xero_python.accounting.models.cis_setting import CISSetting from xero_python.accounting.models.cis_settings import CISSettings from xero_python.accounting.models.contact import Contact diff --git a/xero_python/accounting/models/account.py b/xero_python/accounting/models/account.py index dd72e0bf..999f9670 100644 --- a/xero_python/accounting/models/account.py +++ b/xero_python/accounting/models/account.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/account_type.py b/xero_python/accounting/models/account_type.py index 59625af0..a98ef206 100644 --- a/xero_python/accounting/models/account_type.py +++ b/xero_python/accounting/models/account_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/accounts.py b/xero_python/accounting/models/accounts.py index 683f097a..4760a7da 100644 --- a/xero_python/accounting/models/accounts.py +++ b/xero_python/accounting/models/accounts.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/accounts_payable.py b/xero_python/accounting/models/accounts_payable.py index 3284c5c0..38a3283f 100644 --- a/xero_python/accounting/models/accounts_payable.py +++ b/xero_python/accounting/models/accounts_payable.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/accounts_receivable.py b/xero_python/accounting/models/accounts_receivable.py index ef8940ec..16c9da8a 100644 --- a/xero_python/accounting/models/accounts_receivable.py +++ b/xero_python/accounting/models/accounts_receivable.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/action.py b/xero_python/accounting/models/action.py index 72eda542..e6d2e9b4 100644 --- a/xero_python/accounting/models/action.py +++ b/xero_python/accounting/models/action.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/actions.py b/xero_python/accounting/models/actions.py index d490d35e..03cbc5fe 100644 --- a/xero_python/accounting/models/actions.py +++ b/xero_python/accounting/models/actions.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/address.py b/xero_python/accounting/models/address.py index 55be0a9d..29eb30c4 100644 --- a/xero_python/accounting/models/address.py +++ b/xero_python/accounting/models/address.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/address_for_organisation.py b/xero_python/accounting/models/address_for_organisation.py index d84e7a9c..02096169 100644 --- a/xero_python/accounting/models/address_for_organisation.py +++ b/xero_python/accounting/models/address_for_organisation.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/allocation.py b/xero_python/accounting/models/allocation.py index 293dd15f..200a6e7d 100644 --- a/xero_python/accounting/models/allocation.py +++ b/xero_python/accounting/models/allocation.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/allocations.py b/xero_python/accounting/models/allocations.py index 35841ec7..8af6bcac 100644 --- a/xero_python/accounting/models/allocations.py +++ b/xero_python/accounting/models/allocations.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/attachment.py b/xero_python/accounting/models/attachment.py index cac9e0dd..36f982ae 100644 --- a/xero_python/accounting/models/attachment.py +++ b/xero_python/accounting/models/attachment.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/attachments.py b/xero_python/accounting/models/attachments.py index dff180ef..e920289c 100644 --- a/xero_python/accounting/models/attachments.py +++ b/xero_python/accounting/models/attachments.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/balance_details.py b/xero_python/accounting/models/balance_details.py index d13fc7cf..028d43ef 100644 --- a/xero_python/accounting/models/balance_details.py +++ b/xero_python/accounting/models/balance_details.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/balances.py b/xero_python/accounting/models/balances.py index ce958b26..d881b5ee 100644 --- a/xero_python/accounting/models/balances.py +++ b/xero_python/accounting/models/balances.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/bank_transaction.py b/xero_python/accounting/models/bank_transaction.py index 627685fc..b0a1c45f 100644 --- a/xero_python/accounting/models/bank_transaction.py +++ b/xero_python/accounting/models/bank_transaction.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/bank_transactions.py b/xero_python/accounting/models/bank_transactions.py index 1df5e2d0..b7bc4f39 100644 --- a/xero_python/accounting/models/bank_transactions.py +++ b/xero_python/accounting/models/bank_transactions.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/bank_transfer.py b/xero_python/accounting/models/bank_transfer.py index 6090bb9b..f9d8ba4e 100644 --- a/xero_python/accounting/models/bank_transfer.py +++ b/xero_python/accounting/models/bank_transfer.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/bank_transfers.py b/xero_python/accounting/models/bank_transfers.py index 9420d107..d711bed9 100644 --- a/xero_python/accounting/models/bank_transfers.py +++ b/xero_python/accounting/models/bank_transfers.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/batch_payment.py b/xero_python/accounting/models/batch_payment.py index 9afe70b7..3a83b7e0 100644 --- a/xero_python/accounting/models/batch_payment.py +++ b/xero_python/accounting/models/batch_payment.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/batch_payment_details.py b/xero_python/accounting/models/batch_payment_details.py index 7e1b5228..26ede767 100644 --- a/xero_python/accounting/models/batch_payment_details.py +++ b/xero_python/accounting/models/batch_payment_details.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/batch_payments.py b/xero_python/accounting/models/batch_payments.py index 76aa391c..6bf51304 100644 --- a/xero_python/accounting/models/batch_payments.py +++ b/xero_python/accounting/models/batch_payments.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/bill.py b/xero_python/accounting/models/bill.py index 1fa620a7..e061e8d0 100644 --- a/xero_python/accounting/models/bill.py +++ b/xero_python/accounting/models/bill.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/branding_theme.py b/xero_python/accounting/models/branding_theme.py index 7ee0ad42..aed92601 100644 --- a/xero_python/accounting/models/branding_theme.py +++ b/xero_python/accounting/models/branding_theme.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/branding_themes.py b/xero_python/accounting/models/branding_themes.py index 2afa5317..70b20a1f 100644 --- a/xero_python/accounting/models/branding_themes.py +++ b/xero_python/accounting/models/branding_themes.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/cis_org_setting.py b/xero_python/accounting/models/cis_org_setting.py index 06c066f4..e0dfafd9 100644 --- a/xero_python/accounting/models/cis_org_setting.py +++ b/xero_python/accounting/models/cis_org_setting.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/cis_org_settings.py b/xero_python/accounting/models/cis_org_settings.py new file mode 100644 index 00000000..fd731399 --- /dev/null +++ b/xero_python/accounting/models/cis_org_settings.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + Xero Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class CISOrgSettings(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 = {"cis_settings": "list[CISOrgSetting]"} + + attribute_map = {"cis_settings": "CISSettings"} + + def __init__(self, cis_settings=None): # noqa: E501 + """CISOrgSettings - a model defined in OpenAPI""" # noqa: E501 + + self._cis_settings = None + self.discriminator = None + + if cis_settings is not None: + self.cis_settings = cis_settings + + @property + def cis_settings(self): + """Gets the cis_settings of this CISOrgSettings. # noqa: E501 + + + :return: The cis_settings of this CISOrgSettings. # noqa: E501 + :rtype: list[CISOrgSetting] + """ + return self._cis_settings + + @cis_settings.setter + def cis_settings(self, cis_settings): + """Sets the cis_settings of this CISOrgSettings. + + + :param cis_settings: The cis_settings of this CISOrgSettings. # noqa: E501 + :type: list[CISOrgSetting] + """ + + self._cis_settings = cis_settings diff --git a/xero_python/accounting/models/cis_setting.py b/xero_python/accounting/models/cis_setting.py index 7dc8597b..8783c1ea 100644 --- a/xero_python/accounting/models/cis_setting.py +++ b/xero_python/accounting/models/cis_setting.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/cis_settings.py b/xero_python/accounting/models/cis_settings.py index c022e04c..46e0e6e3 100644 --- a/xero_python/accounting/models/cis_settings.py +++ b/xero_python/accounting/models/cis_settings.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/contact.py b/xero_python/accounting/models/contact.py index f4cc799c..283a0a4e 100644 --- a/xero_python/accounting/models/contact.py +++ b/xero_python/accounting/models/contact.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/contact_group.py b/xero_python/accounting/models/contact_group.py index dff69353..9cd69113 100644 --- a/xero_python/accounting/models/contact_group.py +++ b/xero_python/accounting/models/contact_group.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/contact_groups.py b/xero_python/accounting/models/contact_groups.py index 44c5b00b..bce51bcd 100644 --- a/xero_python/accounting/models/contact_groups.py +++ b/xero_python/accounting/models/contact_groups.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/contact_person.py b/xero_python/accounting/models/contact_person.py index a9f79e68..c15cc088 100644 --- a/xero_python/accounting/models/contact_person.py +++ b/xero_python/accounting/models/contact_person.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/contacts.py b/xero_python/accounting/models/contacts.py index d2fdf56b..3c282333 100644 --- a/xero_python/accounting/models/contacts.py +++ b/xero_python/accounting/models/contacts.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/conversion_balances.py b/xero_python/accounting/models/conversion_balances.py index 9e2efc08..25c218a8 100644 --- a/xero_python/accounting/models/conversion_balances.py +++ b/xero_python/accounting/models/conversion_balances.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/conversion_date.py b/xero_python/accounting/models/conversion_date.py index 633b35b5..dd2ed01a 100644 --- a/xero_python/accounting/models/conversion_date.py +++ b/xero_python/accounting/models/conversion_date.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/country_code.py b/xero_python/accounting/models/country_code.py index 16394a5b..92225ce1 100644 --- a/xero_python/accounting/models/country_code.py +++ b/xero_python/accounting/models/country_code.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/credit_note.py b/xero_python/accounting/models/credit_note.py index 7f85f39a..e9967365 100644 --- a/xero_python/accounting/models/credit_note.py +++ b/xero_python/accounting/models/credit_note.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 @@ -59,6 +59,7 @@ class CreditNote(BaseModel): "has_attachments": "bool", "has_errors": "bool", "validation_errors": "list[ValidationError]", + "warnings": "list[ValidationError]", } attribute_map = { @@ -91,6 +92,7 @@ class CreditNote(BaseModel): "has_attachments": "HasAttachments", "has_errors": "HasErrors", "validation_errors": "ValidationErrors", + "warnings": "Warnings", } def __init__( @@ -124,6 +126,7 @@ def __init__( has_attachments=False, has_errors=False, validation_errors=None, + warnings=None, ): # noqa: E501 """CreditNote - a model defined in OpenAPI""" # noqa: E501 @@ -156,6 +159,7 @@ def __init__( self._has_attachments = None self._has_errors = None self._validation_errors = None + self._warnings = None self.discriminator = None if type is not None: @@ -216,6 +220,8 @@ def __init__( self.has_errors = has_errors if validation_errors is not None: self.validation_errors = validation_errors + if warnings is not None: + self.warnings = warnings @property def type(self): @@ -903,3 +909,26 @@ def validation_errors(self, validation_errors): """ self._validation_errors = validation_errors + + @property + def warnings(self): + """Gets the warnings of this CreditNote. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this CreditNote. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this CreditNote. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this CreditNote. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings diff --git a/xero_python/accounting/models/credit_notes.py b/xero_python/accounting/models/credit_notes.py index d904758f..68464a16 100644 --- a/xero_python/accounting/models/credit_notes.py +++ b/xero_python/accounting/models/credit_notes.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/currencies.py b/xero_python/accounting/models/currencies.py index 07d7758d..da5d13d8 100644 --- a/xero_python/accounting/models/currencies.py +++ b/xero_python/accounting/models/currencies.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/currency.py b/xero_python/accounting/models/currency.py index 3d8ebaff..b9c2b578 100644 --- a/xero_python/accounting/models/currency.py +++ b/xero_python/accounting/models/currency.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/currency_code.py b/xero_python/accounting/models/currency_code.py index 6cf13dc7..8db1c6d8 100644 --- a/xero_python/accounting/models/currency_code.py +++ b/xero_python/accounting/models/currency_code.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/element.py b/xero_python/accounting/models/element.py index b4b5526a..03ac5c8b 100644 --- a/xero_python/accounting/models/element.py +++ b/xero_python/accounting/models/element.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/employee.py b/xero_python/accounting/models/employee.py index 73675ff9..3dc407e8 100644 --- a/xero_python/accounting/models/employee.py +++ b/xero_python/accounting/models/employee.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/employees.py b/xero_python/accounting/models/employees.py index a17af567..df589850 100644 --- a/xero_python/accounting/models/employees.py +++ b/xero_python/accounting/models/employees.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/error.py b/xero_python/accounting/models/error.py index c713c4a4..a6ade5ff 100644 --- a/xero_python/accounting/models/error.py +++ b/xero_python/accounting/models/error.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/expense_claim.py b/xero_python/accounting/models/expense_claim.py index 04e58947..2bef393e 100644 --- a/xero_python/accounting/models/expense_claim.py +++ b/xero_python/accounting/models/expense_claim.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/expense_claims.py b/xero_python/accounting/models/expense_claims.py index 4f948774..9059e32f 100644 --- a/xero_python/accounting/models/expense_claims.py +++ b/xero_python/accounting/models/expense_claims.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/external_link.py b/xero_python/accounting/models/external_link.py index 4fd58007..03255533 100644 --- a/xero_python/accounting/models/external_link.py +++ b/xero_python/accounting/models/external_link.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/history_record.py b/xero_python/accounting/models/history_record.py index ec738d72..ac050085 100644 --- a/xero_python/accounting/models/history_record.py +++ b/xero_python/accounting/models/history_record.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/history_records.py b/xero_python/accounting/models/history_records.py index 2b6a1909..4f582690 100644 --- a/xero_python/accounting/models/history_records.py +++ b/xero_python/accounting/models/history_records.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/import_summary.py b/xero_python/accounting/models/import_summary.py index 4b99df1f..9671b738 100644 --- a/xero_python/accounting/models/import_summary.py +++ b/xero_python/accounting/models/import_summary.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/import_summary_accounts.py b/xero_python/accounting/models/import_summary_accounts.py index 49cdb3f4..00e81c40 100644 --- a/xero_python/accounting/models/import_summary_accounts.py +++ b/xero_python/accounting/models/import_summary_accounts.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/import_summary_object.py b/xero_python/accounting/models/import_summary_object.py index 8bd832ed..cf53020b 100644 --- a/xero_python/accounting/models/import_summary_object.py +++ b/xero_python/accounting/models/import_summary_object.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/import_summary_organisation.py b/xero_python/accounting/models/import_summary_organisation.py index 4dd5692e..4f019e37 100644 --- a/xero_python/accounting/models/import_summary_organisation.py +++ b/xero_python/accounting/models/import_summary_organisation.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/invoice.py b/xero_python/accounting/models/invoice.py index 9cc46bbe..ce7cacab 100644 --- a/xero_python/accounting/models/invoice.py +++ b/xero_python/accounting/models/invoice.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/invoice_reminder.py b/xero_python/accounting/models/invoice_reminder.py index 6df47bcf..367c526b 100644 --- a/xero_python/accounting/models/invoice_reminder.py +++ b/xero_python/accounting/models/invoice_reminder.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/invoice_reminders.py b/xero_python/accounting/models/invoice_reminders.py index 39163de6..981b831e 100644 --- a/xero_python/accounting/models/invoice_reminders.py +++ b/xero_python/accounting/models/invoice_reminders.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/invoices.py b/xero_python/accounting/models/invoices.py index 8be2869a..9f46a2b0 100644 --- a/xero_python/accounting/models/invoices.py +++ b/xero_python/accounting/models/invoices.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/item.py b/xero_python/accounting/models/item.py index 2e88ea37..3b20fc26 100644 --- a/xero_python/accounting/models/item.py +++ b/xero_python/accounting/models/item.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/items.py b/xero_python/accounting/models/items.py index 9bb1992d..587a54b1 100644 --- a/xero_python/accounting/models/items.py +++ b/xero_python/accounting/models/items.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/journal.py b/xero_python/accounting/models/journal.py index 36fb9782..bf78d7b5 100644 --- a/xero_python/accounting/models/journal.py +++ b/xero_python/accounting/models/journal.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/journal_line.py b/xero_python/accounting/models/journal_line.py index aca1bf1a..2e26b518 100644 --- a/xero_python/accounting/models/journal_line.py +++ b/xero_python/accounting/models/journal_line.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/journals.py b/xero_python/accounting/models/journals.py index c63ae702..ef4524e8 100644 --- a/xero_python/accounting/models/journals.py +++ b/xero_python/accounting/models/journals.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/line_amount_types.py b/xero_python/accounting/models/line_amount_types.py index 55ccb1e8..ac8f66ea 100644 --- a/xero_python/accounting/models/line_amount_types.py +++ b/xero_python/accounting/models/line_amount_types.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/line_item.py b/xero_python/accounting/models/line_item.py index b43bce39..7c7afc7a 100644 --- a/xero_python/accounting/models/line_item.py +++ b/xero_python/accounting/models/line_item.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/line_item_tracking.py b/xero_python/accounting/models/line_item_tracking.py index 87d945c4..f00e9043 100644 --- a/xero_python/accounting/models/line_item_tracking.py +++ b/xero_python/accounting/models/line_item_tracking.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/linked_transaction.py b/xero_python/accounting/models/linked_transaction.py index 57711d7d..c5ca46a1 100644 --- a/xero_python/accounting/models/linked_transaction.py +++ b/xero_python/accounting/models/linked_transaction.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/linked_transactions.py b/xero_python/accounting/models/linked_transactions.py index 2d163624..9cc8d14b 100644 --- a/xero_python/accounting/models/linked_transactions.py +++ b/xero_python/accounting/models/linked_transactions.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/manual_journal.py b/xero_python/accounting/models/manual_journal.py index d29d14ac..0a103d32 100644 --- a/xero_python/accounting/models/manual_journal.py +++ b/xero_python/accounting/models/manual_journal.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/manual_journal_line.py b/xero_python/accounting/models/manual_journal_line.py index 0d704936..e3adcb8f 100644 --- a/xero_python/accounting/models/manual_journal_line.py +++ b/xero_python/accounting/models/manual_journal_line.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/manual_journals.py b/xero_python/accounting/models/manual_journals.py index 1b9a06f5..823ba3d6 100644 --- a/xero_python/accounting/models/manual_journals.py +++ b/xero_python/accounting/models/manual_journals.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/online_invoice.py b/xero_python/accounting/models/online_invoice.py index cc771aeb..00f786b8 100644 --- a/xero_python/accounting/models/online_invoice.py +++ b/xero_python/accounting/models/online_invoice.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/online_invoices.py b/xero_python/accounting/models/online_invoices.py index 39e6500a..fa7f4f8b 100644 --- a/xero_python/accounting/models/online_invoices.py +++ b/xero_python/accounting/models/online_invoices.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/organisation.py b/xero_python/accounting/models/organisation.py index 8d603f9f..df6c054a 100644 --- a/xero_python/accounting/models/organisation.py +++ b/xero_python/accounting/models/organisation.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/organisations.py b/xero_python/accounting/models/organisations.py index 5ad6c3b4..fef4b42d 100644 --- a/xero_python/accounting/models/organisations.py +++ b/xero_python/accounting/models/organisations.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/overpayment.py b/xero_python/accounting/models/overpayment.py index f444ec43..0fb57edd 100644 --- a/xero_python/accounting/models/overpayment.py +++ b/xero_python/accounting/models/overpayment.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/overpayments.py b/xero_python/accounting/models/overpayments.py index ed014226..356a6a96 100644 --- a/xero_python/accounting/models/overpayments.py +++ b/xero_python/accounting/models/overpayments.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/payment.py b/xero_python/accounting/models/payment.py index b63ba15e..ecb80373 100644 --- a/xero_python/accounting/models/payment.py +++ b/xero_python/accounting/models/payment.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 @@ -47,6 +47,7 @@ class Payment(BaseModel): "payment_type": "str", "updated_date_utc": "datetime[ms-format]", "payment_id": "str", + "batch_payment_id": "str", "bank_account_number": "str", "particulars": "str", "details": "str", @@ -74,6 +75,7 @@ class Payment(BaseModel): "payment_type": "PaymentType", "updated_date_utc": "UpdatedDateUTC", "payment_id": "PaymentID", + "batch_payment_id": "BatchPaymentID", "bank_account_number": "BankAccountNumber", "particulars": "Particulars", "details": "Details", @@ -102,6 +104,7 @@ def __init__( payment_type=None, updated_date_utc=None, payment_id=None, + batch_payment_id=None, bank_account_number=None, particulars=None, details=None, @@ -129,6 +132,7 @@ def __init__( self._payment_type = None self._updated_date_utc = None self._payment_id = None + self._batch_payment_id = None self._bank_account_number = None self._particulars = None self._details = None @@ -172,6 +176,8 @@ def __init__( self.updated_date_utc = updated_date_utc if payment_id is not None: self.payment_id = payment_id + if batch_payment_id is not None: + self.batch_payment_id = batch_payment_id if bank_account_number is not None: self.bank_account_number = bank_account_number if particulars is not None: @@ -596,6 +602,29 @@ def payment_id(self, payment_id): self._payment_id = payment_id + @property + def batch_payment_id(self): + """Gets the batch_payment_id of this Payment. # noqa: E501 + + Present if the payment was created as part of a batch. # noqa: E501 + + :return: The batch_payment_id of this Payment. # noqa: E501 + :rtype: str + """ + return self._batch_payment_id + + @batch_payment_id.setter + def batch_payment_id(self, batch_payment_id): + """Sets the batch_payment_id of this Payment. + + Present if the payment was created as part of a batch. # noqa: E501 + + :param batch_payment_id: The batch_payment_id of this Payment. # noqa: E501 + :type: str + """ + + self._batch_payment_id = batch_payment_id + @property def bank_account_number(self): """Gets the bank_account_number of this Payment. # noqa: E501 diff --git a/xero_python/accounting/models/payment_delete.py b/xero_python/accounting/models/payment_delete.py index b65acb14..b18f5f3c 100644 --- a/xero_python/accounting/models/payment_delete.py +++ b/xero_python/accounting/models/payment_delete.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/payment_service.py b/xero_python/accounting/models/payment_service.py index ce6b941d..c63579a4 100644 --- a/xero_python/accounting/models/payment_service.py +++ b/xero_python/accounting/models/payment_service.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/payment_services.py b/xero_python/accounting/models/payment_services.py index 458b6919..4ae75dec 100644 --- a/xero_python/accounting/models/payment_services.py +++ b/xero_python/accounting/models/payment_services.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/payment_term.py b/xero_python/accounting/models/payment_term.py index 427c10da..8ca4ca64 100644 --- a/xero_python/accounting/models/payment_term.py +++ b/xero_python/accounting/models/payment_term.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/payment_term_type.py b/xero_python/accounting/models/payment_term_type.py index 476d896a..7a1e4895 100644 --- a/xero_python/accounting/models/payment_term_type.py +++ b/xero_python/accounting/models/payment_term_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/payments.py b/xero_python/accounting/models/payments.py index e93d5745..7ecdc156 100644 --- a/xero_python/accounting/models/payments.py +++ b/xero_python/accounting/models/payments.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/phone.py b/xero_python/accounting/models/phone.py index 9b4e2195..54830d27 100644 --- a/xero_python/accounting/models/phone.py +++ b/xero_python/accounting/models/phone.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/prepayment.py b/xero_python/accounting/models/prepayment.py index 9fc0e0bc..bf313776 100644 --- a/xero_python/accounting/models/prepayment.py +++ b/xero_python/accounting/models/prepayment.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/prepayments.py b/xero_python/accounting/models/prepayments.py index 5c8b6c77..ffbc8869 100644 --- a/xero_python/accounting/models/prepayments.py +++ b/xero_python/accounting/models/prepayments.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/purchase.py b/xero_python/accounting/models/purchase.py index 3b909a42..3b59da58 100644 --- a/xero_python/accounting/models/purchase.py +++ b/xero_python/accounting/models/purchase.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/purchase_order.py b/xero_python/accounting/models/purchase_order.py index 3cb23ae7..18ae1ace 100644 --- a/xero_python/accounting/models/purchase_order.py +++ b/xero_python/accounting/models/purchase_order.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/purchase_orders.py b/xero_python/accounting/models/purchase_orders.py index cc6f4472..0d31143e 100644 --- a/xero_python/accounting/models/purchase_orders.py +++ b/xero_python/accounting/models/purchase_orders.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/quote.py b/xero_python/accounting/models/quote.py index 0ee9ec65..13c1e7f5 100644 --- a/xero_python/accounting/models/quote.py +++ b/xero_python/accounting/models/quote.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/quote_line_amount_types.py b/xero_python/accounting/models/quote_line_amount_types.py index 390226a6..d2d30d94 100644 --- a/xero_python/accounting/models/quote_line_amount_types.py +++ b/xero_python/accounting/models/quote_line_amount_types.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/quote_status_codes.py b/xero_python/accounting/models/quote_status_codes.py index 87ea9977..544f5fbc 100644 --- a/xero_python/accounting/models/quote_status_codes.py +++ b/xero_python/accounting/models/quote_status_codes.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/quotes.py b/xero_python/accounting/models/quotes.py index acdadefb..fefb8098 100644 --- a/xero_python/accounting/models/quotes.py +++ b/xero_python/accounting/models/quotes.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/receipt.py b/xero_python/accounting/models/receipt.py index 4b6d646f..b5222558 100644 --- a/xero_python/accounting/models/receipt.py +++ b/xero_python/accounting/models/receipt.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/receipts.py b/xero_python/accounting/models/receipts.py index 56d1624e..6f777231 100644 --- a/xero_python/accounting/models/receipts.py +++ b/xero_python/accounting/models/receipts.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/repeating_invoice.py b/xero_python/accounting/models/repeating_invoice.py index 437af7b5..072582b9 100644 --- a/xero_python/accounting/models/repeating_invoice.py +++ b/xero_python/accounting/models/repeating_invoice.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/repeating_invoices.py b/xero_python/accounting/models/repeating_invoices.py index aa9afded..8bf075d8 100644 --- a/xero_python/accounting/models/repeating_invoices.py +++ b/xero_python/accounting/models/repeating_invoices.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/report.py b/xero_python/accounting/models/report.py index 95ac43d5..584a8a3f 100644 --- a/xero_python/accounting/models/report.py +++ b/xero_python/accounting/models/report.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/report_attribute.py b/xero_python/accounting/models/report_attribute.py index 85c796ee..9596b5bb 100644 --- a/xero_python/accounting/models/report_attribute.py +++ b/xero_python/accounting/models/report_attribute.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/report_cell.py b/xero_python/accounting/models/report_cell.py index b1828981..2a261c3a 100644 --- a/xero_python/accounting/models/report_cell.py +++ b/xero_python/accounting/models/report_cell.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/report_fields.py b/xero_python/accounting/models/report_fields.py index cee654bb..f0463eb8 100644 --- a/xero_python/accounting/models/report_fields.py +++ b/xero_python/accounting/models/report_fields.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/report_row.py b/xero_python/accounting/models/report_row.py index 07343112..a8fabdb4 100644 --- a/xero_python/accounting/models/report_row.py +++ b/xero_python/accounting/models/report_row.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/report_rows.py b/xero_python/accounting/models/report_rows.py index b55c287b..ddeb0065 100644 --- a/xero_python/accounting/models/report_rows.py +++ b/xero_python/accounting/models/report_rows.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/report_with_row.py b/xero_python/accounting/models/report_with_row.py index 9188eafe..3e383501 100644 --- a/xero_python/accounting/models/report_with_row.py +++ b/xero_python/accounting/models/report_with_row.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/report_with_rows.py b/xero_python/accounting/models/report_with_rows.py index 84e125b1..e82c741a 100644 --- a/xero_python/accounting/models/report_with_rows.py +++ b/xero_python/accounting/models/report_with_rows.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/reports.py b/xero_python/accounting/models/reports.py index e0561f16..a2258e8e 100644 --- a/xero_python/accounting/models/reports.py +++ b/xero_python/accounting/models/reports.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/request_empty.py b/xero_python/accounting/models/request_empty.py index d30d00c8..05d2a175 100644 --- a/xero_python/accounting/models/request_empty.py +++ b/xero_python/accounting/models/request_empty.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/row_type.py b/xero_python/accounting/models/row_type.py index 2ae55492..ab3af3cb 100644 --- a/xero_python/accounting/models/row_type.py +++ b/xero_python/accounting/models/row_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/sales_tracking_category.py b/xero_python/accounting/models/sales_tracking_category.py index 64aeb97d..deddf4b0 100644 --- a/xero_python/accounting/models/sales_tracking_category.py +++ b/xero_python/accounting/models/sales_tracking_category.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/schedule.py b/xero_python/accounting/models/schedule.py index 6fba5e5b..12658049 100644 --- a/xero_python/accounting/models/schedule.py +++ b/xero_python/accounting/models/schedule.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/setup.py b/xero_python/accounting/models/setup.py index 215084e8..d598cff6 100644 --- a/xero_python/accounting/models/setup.py +++ b/xero_python/accounting/models/setup.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/tax_component.py b/xero_python/accounting/models/tax_component.py index e46f9e52..1da4b857 100644 --- a/xero_python/accounting/models/tax_component.py +++ b/xero_python/accounting/models/tax_component.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/tax_rate.py b/xero_python/accounting/models/tax_rate.py index 51af8724..e7a1308e 100644 --- a/xero_python/accounting/models/tax_rate.py +++ b/xero_python/accounting/models/tax_rate.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/tax_rates.py b/xero_python/accounting/models/tax_rates.py index 348f453e..e67d36ed 100644 --- a/xero_python/accounting/models/tax_rates.py +++ b/xero_python/accounting/models/tax_rates.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/tax_type.py b/xero_python/accounting/models/tax_type.py index 7fdf1eff..7a35e1db 100644 --- a/xero_python/accounting/models/tax_type.py +++ b/xero_python/accounting/models/tax_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/ten_ninety_nine_contact.py b/xero_python/accounting/models/ten_ninety_nine_contact.py index 2945b7c7..d01c81ca 100644 --- a/xero_python/accounting/models/ten_ninety_nine_contact.py +++ b/xero_python/accounting/models/ten_ninety_nine_contact.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/time_zone.py b/xero_python/accounting/models/time_zone.py index c0a39a17..7b5ba428 100644 --- a/xero_python/accounting/models/time_zone.py +++ b/xero_python/accounting/models/time_zone.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/tracking_categories.py b/xero_python/accounting/models/tracking_categories.py index 757feed9..b3e0c11b 100644 --- a/xero_python/accounting/models/tracking_categories.py +++ b/xero_python/accounting/models/tracking_categories.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/tracking_category.py b/xero_python/accounting/models/tracking_category.py index b01a8fab..af4d61ba 100644 --- a/xero_python/accounting/models/tracking_category.py +++ b/xero_python/accounting/models/tracking_category.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/tracking_option.py b/xero_python/accounting/models/tracking_option.py index e4166871..3d76ca94 100644 --- a/xero_python/accounting/models/tracking_option.py +++ b/xero_python/accounting/models/tracking_option.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/tracking_options.py b/xero_python/accounting/models/tracking_options.py index 1ed340d2..3508b2d0 100644 --- a/xero_python/accounting/models/tracking_options.py +++ b/xero_python/accounting/models/tracking_options.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/user.py b/xero_python/accounting/models/user.py index a7cf4d4c..ac870fc4 100644 --- a/xero_python/accounting/models/user.py +++ b/xero_python/accounting/models/user.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/users.py b/xero_python/accounting/models/users.py index 20897e18..8f1acaff 100644 --- a/xero_python/accounting/models/users.py +++ b/xero_python/accounting/models/users.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/accounting/models/validation_error.py b/xero_python/accounting/models/validation_error.py index 05adbce3..cdad4864 100644 --- a/xero_python/accounting/models/validation_error.py +++ b/xero_python/accounting/models/validation_error.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Accounting API + Xero Accounting API No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 diff --git a/xero_python/assets/__init__.py b/xero_python/assets/__init__.py index 4c2f7a37..b69a585a 100644 --- a/xero_python/assets/__init__.py +++ b/xero_python/assets/__init__.py @@ -5,7 +5,7 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 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 d36afae8..1d3c9f86 100644 --- a/xero_python/assets/api/asset_api.py +++ b/xero_python/assets/api/asset_api.py @@ -3,14 +3,14 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 Contact: api@xero.com Generated by: https://openapi-generator.tech """ """ - OpenAPI spec version: 2.8.4 + OpenAPI spec version: 2.9.3 """ import importlib @@ -217,7 +217,7 @@ def get_asset_by_id( _preload_content=True, _request_timeout=None, ): - """retrieves fixed asset by id # noqa: E501 + """Retrieves fixed asset by id # noqa: E501 OAuth2 scope: assets.read By passing in the appropriate asset id, you can search for a specific fixed asset in the system # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) diff --git a/xero_python/assets/docs/AssetApi.md b/xero_python/assets/docs/AssetApi.md index 6a014a2d..773fe9a4 100644 --- a/xero_python/assets/docs/AssetApi.md +++ b/xero_python/assets/docs/AssetApi.md @@ -6,7 +6,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create_asset**](AssetApi.md#create_asset) | **POST** /Assets | adds a fixed asset [**create_asset_type**](AssetApi.md#create_asset_type) | **POST** /AssetTypes | adds a fixed asset type -[**get_asset_by_id**](AssetApi.md#get_asset_by_id) | **GET** /Assets/{id} | retrieves fixed asset by id +[**get_asset_by_id**](AssetApi.md#get_asset_by_id) | **GET** /Assets/{id} | Retrieves fixed asset by id [**get_asset_settings**](AssetApi.md#get_asset_settings) | **GET** /Settings | searches fixed asset settings [**get_asset_types**](AssetApi.md#get_asset_types) | **GET** /AssetTypes | searches fixed asset types [**get_assets**](AssetApi.md#get_assets) | **GET** /Assets | searches fixed asset @@ -145,7 +145,7 @@ Name | Type | Description | Notes # **get_asset_by_id** > Asset get_asset_by_id(xero_tenant_id, id) -retrieves fixed asset by id +Retrieves fixed asset by id By passing in the appropriate asset id, you can search for a specific fixed asset in the system @@ -178,7 +178,7 @@ api_instance = AssetApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant id = '4f7bcdcb-5ec1-4258-9558-19f662fccdfe' # str | fixed asset id for single object try: - # retrieves fixed asset by id + # Retrieves fixed asset by id api_response = api_instance.get_asset_by_id(xero_tenant_id, id) pprint(api_response) except ApiException as e: @@ -372,7 +372,7 @@ page = 1 # int | Results are paged. This specifies which page of the results to page_size = 5 # int | The number of records returned per page. By default the number of records returned is 10. (optional) order_by = 'AssetName' # str | Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice. (optional) sort_direction = 'ASC' # str | ASC or DESC (optional) -filter_by = 'Draft' # str | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields. (optional) +filter_by = 'Company Car' # str | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields. (optional) try: # searches fixed asset api_response = api_instance.get_assets(xero_tenant_id, status, page=page, page_size=page_size, order_by=order_by, sort_direction=sort_direction, filter_by=filter_by) diff --git a/xero_python/assets/docs/FieldValidationErrorsElement.md b/xero_python/assets/docs/FieldValidationErrorsElement.md index 58a16685..3ed58c6b 100644 --- a/xero_python/assets/docs/FieldValidationErrorsElement.md +++ b/xero_python/assets/docs/FieldValidationErrorsElement.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **field_name** | **str** | The field name of the erroneous field | [optional] **value_provided** | **str** | The provided value | [optional] -**localised_message** | **str** | Explaination of the field validation error | [optional] +**localised_message** | **str** | Explanation of the field validation error | [optional] **type** | **str** | Internal type of the field validation error message | [optional] **title** | **str** | Title of the field validation error | [optional] **detail** | **str** | Detail of the field validation error | [optional] diff --git a/xero_python/assets/docs/ResourceValidationErrorsElement.md b/xero_python/assets/docs/ResourceValidationErrorsElement.md index 2b95e6e0..dc2af1bf 100644 --- a/xero_python/assets/docs/ResourceValidationErrorsElement.md +++ b/xero_python/assets/docs/ResourceValidationErrorsElement.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **resource_name** | **str** | The field name of the erroneous field | [optional] -**localised_message** | **str** | Explaination of the resource validation error | [optional] +**localised_message** | **str** | Explanation of the resource validation error | [optional] **type** | **str** | Internal type of the resource error message | [optional] **title** | **str** | Title of the resource validation error | [optional] **detail** | **str** | Detail of the resource validation error | [optional] diff --git a/xero_python/assets/models/__init__.py b/xero_python/assets/models/__init__.py index bc446035..5cbde7cb 100644 --- a/xero_python/assets/models/__init__.py +++ b/xero_python/assets/models/__init__.py @@ -4,7 +4,7 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 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 0b5aab13..376ceca3 100644 --- a/xero_python/assets/models/asset.py +++ b/xero_python/assets/models/asset.py @@ -3,7 +3,7 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 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 4cd0874e..598f0a0d 100644 --- a/xero_python/assets/models/asset_status.py +++ b/xero_python/assets/models/asset_status.py @@ -3,7 +3,7 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 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 0d7106e0..6c0a08ff 100644 --- a/xero_python/assets/models/asset_status_query_param.py +++ b/xero_python/assets/models/asset_status_query_param.py @@ -3,7 +3,7 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 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 431efa5a..d994ca83 100644 --- a/xero_python/assets/models/asset_type.py +++ b/xero_python/assets/models/asset_type.py @@ -3,7 +3,7 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 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 2e395bed..6ad9c906 100644 --- a/xero_python/assets/models/assets.py +++ b/xero_python/assets/models/assets.py @@ -3,7 +3,7 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 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 aa8f37b9..1347bf19 100644 --- a/xero_python/assets/models/book_depreciation_detail.py +++ b/xero_python/assets/models/book_depreciation_detail.py @@ -3,7 +3,7 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 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 99a9e695..ca17f803 100644 --- a/xero_python/assets/models/book_depreciation_setting.py +++ b/xero_python/assets/models/book_depreciation_setting.py @@ -3,7 +3,7 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 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 8964304d..91268b74 100644 --- a/xero_python/assets/models/error.py +++ b/xero_python/assets/models/error.py @@ -3,7 +3,7 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 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 d2356753..a414c562 100644 --- a/xero_python/assets/models/field_validation_errors_element.py +++ b/xero_python/assets/models/field_validation_errors_element.py @@ -3,7 +3,7 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 Contact: api@xero.com Generated by: https://openapi-generator.tech @@ -129,7 +129,7 @@ def value_provided(self, value_provided): def localised_message(self): """Gets the localised_message of this FieldValidationErrorsElement. # noqa: E501 - Explaination of the field validation error # noqa: E501 + Explanation of the field validation error # noqa: E501 :return: The localised_message of this FieldValidationErrorsElement. # noqa: E501 :rtype: str @@ -140,7 +140,7 @@ def localised_message(self): def localised_message(self, localised_message): """Sets the localised_message of this FieldValidationErrorsElement. - Explaination of the field validation error # noqa: E501 + Explanation of the field validation error # noqa: E501 :param localised_message: The localised_message of this FieldValidationErrorsElement. # noqa: E501 :type: str diff --git a/xero_python/assets/models/pagination.py b/xero_python/assets/models/pagination.py index d395cc9a..9ef45805 100644 --- a/xero_python/assets/models/pagination.py +++ b/xero_python/assets/models/pagination.py @@ -3,7 +3,7 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 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 b239fc16..8b902409 100644 --- a/xero_python/assets/models/resource_validation_errors_element.py +++ b/xero_python/assets/models/resource_validation_errors_element.py @@ -3,7 +3,7 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 Contact: api@xero.com Generated by: https://openapi-generator.tech @@ -100,7 +100,7 @@ def resource_name(self, resource_name): def localised_message(self): """Gets the localised_message of this ResourceValidationErrorsElement. # noqa: E501 - Explaination of the resource validation error # noqa: E501 + Explanation of the resource validation error # noqa: E501 :return: The localised_message of this ResourceValidationErrorsElement. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def localised_message(self): def localised_message(self, localised_message): """Sets the localised_message of this ResourceValidationErrorsElement. - Explaination of the resource validation error # noqa: E501 + Explanation of the resource validation error # noqa: E501 :param localised_message: The localised_message of this ResourceValidationErrorsElement. # noqa: E501 :type: str diff --git a/xero_python/assets/models/setting.py b/xero_python/assets/models/setting.py index de50b29c..e8be8340 100644 --- a/xero_python/assets/models/setting.py +++ b/xero_python/assets/models/setting.py @@ -3,7 +3,7 @@ """ Xero Assets API - This is the Xero Assets API # noqa: E501 + The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc. # noqa: E501 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 7982d5e9..1bc72733 100644 --- a/xero_python/docs/README.md +++ b/xero_python/docs/README.md @@ -1,10 +1,10 @@ # xero-python -This specifing endpoints related to managing authentication tokens and identity for Xero API +These endpoints are related to managing authentication tokens and identity for Xero API 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.8.4 -- Package version: 1.3.0 +- API version: 2.9.3 +- Package version: 1.4.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://developer.xero.com](https://developer.xero.com) diff --git a/xero_python/identity/__init__.py b/xero_python/identity/__init__.py index eb5b71d2..bbe8fed7 100644 --- a/xero_python/identity/__init__.py +++ b/xero_python/identity/__init__.py @@ -3,9 +3,9 @@ # flake8: noqa """ - Xero oAuth 2 identity service + Xero OAuth 2 Identity Service API - This specifing endpoints related to managing authentication tokens and identity for Xero API # noqa: E501 + These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 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 273bb6c5..018bdfb2 100644 --- a/xero_python/identity/api/identity_api.py +++ b/xero_python/identity/api/identity_api.py @@ -1,16 +1,16 @@ # coding: utf-8 """ - Xero oAuth 2 identity service + Xero OAuth 2 Identity Service API - This specifing endpoints related to managing authentication tokens and identity for Xero API # noqa: E501 + These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 Contact: api@xero.com Generated by: https://openapi-generator.tech """ """ - OpenAPI spec version: 2.8.4 + OpenAPI spec version: 2.9.3 """ import importlib @@ -63,7 +63,7 @@ def delete_connection( _preload_content=True, _request_timeout=None, ): - """Allows you to delete a connection for this user (i.e. disconnect a tenant) # noqa: E501 + """Deletes a connection for this user (i.e. disconnect a tenant) # noqa: E501 OAuth2 scope: N/A Override the base server url that include version # noqa: E501 :param str id: Unique identifier for retrieving single object (required) @@ -95,7 +95,7 @@ def delete_connection( body_params = None # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/connections/{id}") + url = self.get_resource_url("/Connections/{id}") try: return self.api_client.call_api( @@ -125,7 +125,7 @@ def get_connections( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve the connections for this user # noqa: E501 + """Retrieves the connections for this user # noqa: E501 OAuth2 scope: N/A Override the base server url that include version # noqa: E501 :param str auth_event_id: Filter by authEventId @@ -156,7 +156,7 @@ def get_connections( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/connections") + url = self.get_resource_url("/Connections") try: return self.api_client.call_api( diff --git a/xero_python/identity/docs/IdentityApi.md b/xero_python/identity/docs/IdentityApi.md index 619feb93..2e1fe7a2 100644 --- a/xero_python/identity/docs/IdentityApi.md +++ b/xero_python/identity/docs/IdentityApi.md @@ -4,14 +4,14 @@ All URIs are relative to *https://api.xero.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**delete_connection**](IdentityApi.md#delete_connection) | **DELETE** /connections/{id} | Allows you to delete a connection for this user (i.e. disconnect a tenant) -[**get_connections**](IdentityApi.md#get_connections) | **GET** /connections | Allows you to retrieve the connections for this user +[**delete_connection**](IdentityApi.md#delete_connection) | **DELETE** /Connections/{id} | Deletes a connection for this user (i.e. disconnect a tenant) +[**get_connections**](IdentityApi.md#get_connections) | **GET** /Connections | Retrieves the connections for this user # **delete_connection** > delete_connection(id) -Allows you to delete a connection for this user (i.e. disconnect a tenant) +Deletes a connection for this user (i.e. disconnect a tenant) Override the base server url that include version @@ -43,7 +43,7 @@ api_instance = IdentityApi(api_client) id = 'id_example' # str | Unique identifier for retrieving single object try: - # Allows you to delete a connection for this user (i.e. disconnect a tenant) + # Deletes a connection for this user (i.e. disconnect a tenant) api_instance.delete_connection(id) except ApiException as e: print("Exception when calling IdentityApi->delete_connection: %s\n" % e) @@ -73,7 +73,7 @@ void (empty response body) # **get_connections** > list[Connection] get_connections(auth_event_id=auth_event_id) -Allows you to retrieve the connections for this user +Retrieves the connections for this user Override the base server url that include version @@ -103,9 +103,9 @@ api_client = ApiClient( # create an instance of the API class api_instance = IdentityApi(api_client) -auth_event_id = '00000000-0000-0000-000-000000000000' # str | Filter by authEventId (optional) +auth_event_id = '00000000-0000-0000-0000-000000000000' # str | Filter by authEventId (optional) try: - # Allows you to retrieve the connections for this user + # Retrieves the connections for this user api_response = api_instance.get_connections(auth_event_id=auth_event_id) pprint(api_response) except ApiException as e: diff --git a/xero_python/identity/models/__init__.py b/xero_python/identity/models/__init__.py index 2c07a0f0..961bbd7f 100644 --- a/xero_python/identity/models/__init__.py +++ b/xero_python/identity/models/__init__.py @@ -2,9 +2,9 @@ # flake8: noqa """ - Xero oAuth 2 identity service + Xero OAuth 2 Identity Service API - This specifing endpoints related to managing authentication tokens and identity for Xero API # noqa: E501 + These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 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 c03a2e47..e2395ff5 100644 --- a/xero_python/identity/models/access_token.py +++ b/xero_python/identity/models/access_token.py @@ -1,9 +1,9 @@ # coding: utf-8 """ - Xero oAuth 2 identity service + Xero OAuth 2 Identity Service API - This specifing endpoints related to managing authentication tokens and identity for Xero API # noqa: E501 + These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 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 37df231d..543e6921 100644 --- a/xero_python/identity/models/connection.py +++ b/xero_python/identity/models/connection.py @@ -1,9 +1,9 @@ # coding: utf-8 """ - Xero oAuth 2 identity service + Xero OAuth 2 Identity Service API - This specifing endpoints related to managing authentication tokens and identity for Xero API # noqa: E501 + These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 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 fe6387e3..c7acab29 100644 --- a/xero_python/identity/models/refresh_token.py +++ b/xero_python/identity/models/refresh_token.py @@ -1,9 +1,9 @@ # coding: utf-8 """ - Xero oAuth 2 identity service + Xero OAuth 2 Identity Service API - This specifing endpoints related to managing authentication tokens and identity for Xero API # noqa: E501 + These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 Contact: api@xero.com Generated by: https://openapi-generator.tech diff --git a/xero_python/payrollau/__init__.py b/xero_python/payrollau/__init__.py index 08bf7694..08f6cc2e 100644 --- a/xero_python/payrollau/__init__.py +++ b/xero_python/payrollau/__init__.py @@ -3,7 +3,7 @@ # flake8: noqa """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/api/payroll_au_api.py b/xero_python/payrollau/api/payroll_au_api.py index c8f94459..87129a2b 100644 --- a/xero_python/payrollau/api/payroll_au_api.py +++ b/xero_python/payrollau/api/payroll_au_api.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.8.4 + OpenAPI spec version: 2.9.3 """ import importlib @@ -64,7 +64,7 @@ def create_employee( _preload_content=True, _request_timeout=None, ): - """Use this method to create a payroll employee # noqa: E501 + """Creates a payroll employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param list[Employee] employee: (required) @@ -143,7 +143,7 @@ def create_leave_application( _preload_content=True, _request_timeout=None, ): - """Use this method to create a Leave Application # noqa: E501 + """Creates 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) @@ -222,7 +222,7 @@ def create_pay_item( _preload_content=True, _request_timeout=None, ): - """Use this method to create a Pay Item # noqa: E501 + """Creates a pay item # noqa: E501 OAuth2 scope: payroll.payitems :param str xero_tenant_id: Xero identifier for Tenant (required) :param PayItem pay_item: (required) @@ -301,7 +301,7 @@ def create_pay_run( _preload_content=True, _request_timeout=None, ): - """Use this method to create a PayRun # noqa: E501 + """Creates a pay run # noqa: E501 OAuth2 scope: payroll.payruns :param str xero_tenant_id: Xero identifier for Tenant (required) :param list[PayRun] pay_run: (required) @@ -380,7 +380,7 @@ def create_payroll_calendar( _preload_content=True, _request_timeout=None, ): - """Use this method to create a Payroll Calendars # noqa: E501 + """Creates a Payroll Calendar # noqa: E501 OAuth2 scope: payroll.payrollcalendars :param str xero_tenant_id: Xero identifier for Tenant (required) :param list[PayrollCalendar] payroll_calendar: (required) @@ -459,7 +459,7 @@ def create_superfund( _preload_content=True, _request_timeout=None, ): - """Use this method to create a super fund # noqa: E501 + """Creates a superfund # noqa: E501 OAuth2 scope: payroll.superfunds :param str xero_tenant_id: Xero identifier for Tenant (required) :param list[SuperFund] super_fund: (required) @@ -538,7 +538,7 @@ def create_timesheet( _preload_content=True, _request_timeout=None, ): - """Use this method to create a timesheet # noqa: E501 + """Creates a timesheet # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param list[Timesheet] timesheet: (required) @@ -617,7 +617,7 @@ def get_employee( _preload_content=True, _request_timeout=None, ): - """searches for an employee by unique id # noqa: E501 + """Retrieves an employee's detail by unique employee 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) @@ -642,7 +642,7 @@ def get_employee( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -662,7 +662,7 @@ def get_employee( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}") + url = self.get_resource_url("/Employees/{EmployeeID}") try: return self.api_client.call_api( @@ -696,7 +696,7 @@ def get_employees( _preload_content=True, _request_timeout=None, ): - """searches employees # noqa: E501 + """Searches payroll 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 @@ -779,7 +779,7 @@ def get_leave_application( _preload_content=True, _request_timeout=None, ): - """searches for an Leave Application by unique id # noqa: E501 + """Retrieves a leave application by a unique leave application 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) @@ -804,7 +804,7 @@ def get_leave_application( collection_formats = {} path_params = { - "LeaveApplicationId": leave_application_id, + "LeaveApplicationID": leave_application_id, } query_params = [] @@ -824,7 +824,7 @@ def get_leave_application( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/LeaveApplications/{LeaveApplicationId}") + url = self.get_resource_url("/LeaveApplications/{LeaveApplicationID}") try: return self.api_client.call_api( @@ -858,7 +858,7 @@ def get_leave_applications( _preload_content=True, _request_timeout=None, ): - """searches Leave Applications # noqa: E501 + """Retrieves 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 @@ -944,7 +944,7 @@ def get_pay_items( _preload_content=True, _request_timeout=None, ): - """searches Pay Items # noqa: E501 + """Retrieves 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 @@ -1027,7 +1027,7 @@ def get_pay_run( _preload_content=True, _request_timeout=None, ): - """searches for an payrun by unique id # noqa: E501 + """Retrieves a pay run by using a unique pay run 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) @@ -1106,7 +1106,7 @@ def get_pay_runs( _preload_content=True, _request_timeout=None, ): - """searches PayRuns # noqa: E501 + """Retrieves pay runs # 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 @@ -1189,7 +1189,7 @@ def get_payroll_calendar( _preload_content=True, _request_timeout=None, ): - """searches Payroll Calendars # noqa: E501 + """Retrieves payroll calendar by using a unique payroll calendar ID # 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) @@ -1268,7 +1268,7 @@ def get_payroll_calendars( _preload_content=True, _request_timeout=None, ): - """searches Payroll Calendars # noqa: E501 + """Retrieves 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 @@ -1351,7 +1351,7 @@ def get_payslip( _preload_content=True, _request_timeout=None, ): - """searches for an payslip by unique id # noqa: E501 + """Retrieves for a payslip by a unique payslip 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) @@ -1426,7 +1426,7 @@ def get_settings( _preload_content=True, _request_timeout=None, ): - """retrieve settings # noqa: E501 + """Retrieves payroll 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 @@ -1493,7 +1493,7 @@ def get_superfund( _preload_content=True, _request_timeout=None, ): - """searches for an Superfund by unique id # noqa: E501 + """Retrieves a superfund by using a unique superfund 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) @@ -1570,7 +1570,7 @@ def get_superfund_products( _preload_content=True, _request_timeout=None, ): - """searches SuperfundProducts # noqa: E501 + """Retrieves superfund products # 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 @@ -1648,7 +1648,7 @@ def get_superfunds( _preload_content=True, _request_timeout=None, ): - """searches SuperFunds # noqa: E501 + """Retrieves 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 @@ -1731,7 +1731,7 @@ def get_timesheet( _preload_content=True, _request_timeout=None, ): - """searches for an timesheet by unique id # noqa: E501 + """Retrieves a timesheet by using a unique timesheet 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) @@ -1810,7 +1810,7 @@ def get_timesheets( _preload_content=True, _request_timeout=None, ): - """searches timesheets # noqa: E501 + """Retrieves 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 @@ -1894,7 +1894,7 @@ def update_employee( _preload_content=True, _request_timeout=None, ): - """Update an Employee # noqa: E501 + """Updates an employee's detail # noqa: E501 OAuth2 scope: payroll.employees Update properties on a single employee # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) @@ -1921,7 +1921,7 @@ def update_employee( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -1946,7 +1946,7 @@ def update_employee( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}") + url = self.get_resource_url("/Employees/{EmployeeID}") try: return self.api_client.call_api( @@ -1978,7 +1978,7 @@ def update_leave_application( _preload_content=True, _request_timeout=None, ): - """Use this method to update a Leave Application # noqa: E501 + """Updates a specific 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) @@ -2010,7 +2010,7 @@ def update_leave_application( collection_formats = {} path_params = { - "LeaveApplicationId": leave_application_id, + "LeaveApplicationID": leave_application_id, } query_params = [] @@ -2035,7 +2035,7 @@ def update_leave_application( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/LeaveApplications/{LeaveApplicationId}") + url = self.get_resource_url("/LeaveApplications/{LeaveApplicationID}") try: return self.api_client.call_api( @@ -2067,7 +2067,7 @@ def update_pay_run( _preload_content=True, _request_timeout=None, ): - """Update a PayRun # noqa: E501 + """Updates a pay run # noqa: E501 OAuth2 scope: payroll.payruns Update properties on a single PayRun # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) @@ -2151,7 +2151,7 @@ def update_payslip( _preload_content=True, _request_timeout=None, ): - """Update a Payslip # noqa: E501 + """Updates 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) @@ -2235,7 +2235,7 @@ def update_superfund( _preload_content=True, _request_timeout=None, ): - """Update a Superfund # noqa: E501 + """Updates 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) @@ -2319,7 +2319,7 @@ def update_timesheet( _preload_content=True, _request_timeout=None, ): - """Update a Timesheet # noqa: E501 + """Updates 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) diff --git a/xero_python/payrollau/docs/PayrollAuApi.md b/xero_python/payrollau/docs/PayrollAuApi.md index fc613e22..6734f029 100644 --- a/xero_python/payrollau/docs/PayrollAuApi.md +++ b/xero_python/payrollau/docs/PayrollAuApi.md @@ -4,41 +4,41 @@ 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**](PayrollAuApi.md#create_employee) | **POST** /Employees | Creates a payroll employee +[**create_leave_application**](PayrollAuApi.md#create_leave_application) | **POST** /LeaveApplications | Creates a leave application +[**create_pay_item**](PayrollAuApi.md#create_pay_item) | **POST** /PayItems | Creates a pay item +[**create_pay_run**](PayrollAuApi.md#create_pay_run) | **POST** /PayRuns | Creates a pay run +[**create_payroll_calendar**](PayrollAuApi.md#create_payroll_calendar) | **POST** /PayrollCalendars | Creates a Payroll Calendar +[**create_superfund**](PayrollAuApi.md#create_superfund) | **POST** /Superfunds | Creates a superfund +[**create_timesheet**](PayrollAuApi.md#create_timesheet) | **POST** /Timesheets | Creates a timesheet +[**get_employee**](PayrollAuApi.md#get_employee) | **GET** /Employees/{EmployeeID} | Retrieves an employee's detail by unique employee id +[**get_employees**](PayrollAuApi.md#get_employees) | **GET** /Employees | Searches payroll employees +[**get_leave_application**](PayrollAuApi.md#get_leave_application) | **GET** /LeaveApplications/{LeaveApplicationID} | Retrieves a leave application by a unique leave application id +[**get_leave_applications**](PayrollAuApi.md#get_leave_applications) | **GET** /LeaveApplications | Retrieves leave applications +[**get_pay_items**](PayrollAuApi.md#get_pay_items) | **GET** /PayItems | Retrieves pay items +[**get_pay_run**](PayrollAuApi.md#get_pay_run) | **GET** /PayRuns/{PayRunID} | Retrieves a pay run by using a unique pay run id +[**get_pay_runs**](PayrollAuApi.md#get_pay_runs) | **GET** /PayRuns | Retrieves pay runs +[**get_payroll_calendar**](PayrollAuApi.md#get_payroll_calendar) | **GET** /PayrollCalendars/{PayrollCalendarID} | Retrieves payroll calendar by using a unique payroll calendar ID +[**get_payroll_calendars**](PayrollAuApi.md#get_payroll_calendars) | **GET** /PayrollCalendars | Retrieves payroll calendars +[**get_payslip**](PayrollAuApi.md#get_payslip) | **GET** /Payslip/{PayslipID} | Retrieves for a payslip by a unique payslip id +[**get_settings**](PayrollAuApi.md#get_settings) | **GET** /Settings | Retrieves payroll settings +[**get_superfund**](PayrollAuApi.md#get_superfund) | **GET** /Superfunds/{SuperFundID} | Retrieves a superfund by using a unique superfund ID +[**get_superfund_products**](PayrollAuApi.md#get_superfund_products) | **GET** /SuperfundProducts | Retrieves superfund products +[**get_superfunds**](PayrollAuApi.md#get_superfunds) | **GET** /Superfunds | Retrieves superfunds +[**get_timesheet**](PayrollAuApi.md#get_timesheet) | **GET** /Timesheets/{TimesheetID} | Retrieves a timesheet by using a unique timesheet id +[**get_timesheets**](PayrollAuApi.md#get_timesheets) | **GET** /Timesheets | Retrieves timesheets +[**update_employee**](PayrollAuApi.md#update_employee) | **POST** /Employees/{EmployeeID} | Updates an employee's detail +[**update_leave_application**](PayrollAuApi.md#update_leave_application) | **POST** /LeaveApplications/{LeaveApplicationID} | Updates a specific leave application +[**update_pay_run**](PayrollAuApi.md#update_pay_run) | **POST** /PayRuns/{PayRunID} | Updates a pay run +[**update_payslip**](PayrollAuApi.md#update_payslip) | **POST** /Payslip/{PayslipID} | Updates a payslip +[**update_superfund**](PayrollAuApi.md#update_superfund) | **POST** /Superfunds/{SuperFundID} | Updates a superfund +[**update_timesheet**](PayrollAuApi.md#update_timesheet) | **POST** /Timesheets/{TimesheetID} | Updates a timesheet # **create_employee** > Employees create_employee(xero_tenant_id, employee) -Use this method to create a payroll employee +Creates a payroll employee ### Example @@ -69,7 +69,7 @@ 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 + # Creates a payroll employee api_response = api_instance.create_employee(xero_tenant_id, employee) pprint(api_response) except ApiException as e: @@ -101,7 +101,7 @@ Name | Type | Description | Notes # **create_leave_application** > LeaveApplications create_leave_application(xero_tenant_id, leave_application) -Use this method to create a Leave Application +Creates a leave application ### Example @@ -132,7 +132,7 @@ 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 + # Creates a leave application api_response = api_instance.create_leave_application(xero_tenant_id, leave_application) pprint(api_response) except ApiException as e: @@ -164,7 +164,7 @@ Name | Type | Description | Notes # **create_pay_item** > PayItems create_pay_item(xero_tenant_id, pay_item) -Use this method to create a Pay Item +Creates a pay item ### Example @@ -195,7 +195,7 @@ 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 + # Creates a pay item api_response = api_instance.create_pay_item(xero_tenant_id, pay_item) pprint(api_response) except ApiException as e: @@ -227,7 +227,7 @@ Name | Type | Description | Notes # **create_pay_run** > PayRuns create_pay_run(xero_tenant_id, pay_run) -Use this method to create a PayRun +Creates a pay run ### Example @@ -258,7 +258,7 @@ 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 + # Creates a pay run api_response = api_instance.create_pay_run(xero_tenant_id, pay_run) pprint(api_response) except ApiException as e: @@ -290,7 +290,7 @@ Name | Type | Description | Notes # **create_payroll_calendar** > PayrollCalendars create_payroll_calendar(xero_tenant_id, payroll_calendar) -Use this method to create a Payroll Calendars +Creates a Payroll Calendar ### Example @@ -321,7 +321,7 @@ 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 + # Creates a Payroll Calendar api_response = api_instance.create_payroll_calendar(xero_tenant_id, payroll_calendar) pprint(api_response) except ApiException as e: @@ -353,7 +353,7 @@ Name | Type | Description | Notes # **create_superfund** > SuperFunds create_superfund(xero_tenant_id, super_fund) -Use this method to create a super fund +Creates a superfund ### Example @@ -384,7 +384,7 @@ 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 + # Creates a superfund api_response = api_instance.create_superfund(xero_tenant_id, super_fund) pprint(api_response) except ApiException as e: @@ -416,7 +416,7 @@ Name | Type | Description | Notes # **create_timesheet** > Timesheets create_timesheet(xero_tenant_id, timesheet) -Use this method to create a timesheet +Creates a timesheet ### Example @@ -447,7 +447,7 @@ 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 + # Creates a timesheet api_response = api_instance.create_timesheet(xero_tenant_id, timesheet) pprint(api_response) except ApiException as e: @@ -479,7 +479,7 @@ Name | Type | Description | Notes # **get_employee** > Employees get_employee(xero_tenant_id, employee_id) -searches for an employee by unique id +Retrieves an employee's detail by unique employee id ### Example @@ -510,7 +510,7 @@ 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 + # Retrieves an employee's detail by unique employee id api_response = api_instance.get_employee(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -542,7 +542,7 @@ Name | Type | Description | Notes # **get_employees** > Employees get_employees(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) -searches employees +Searches payroll employees ### Example @@ -576,7 +576,7 @@ 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 + # Searches payroll 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: @@ -611,7 +611,7 @@ Name | Type | Description | Notes # **get_leave_application** > LeaveApplications get_leave_application(xero_tenant_id, leave_application_id) -searches for an Leave Application by unique id +Retrieves a leave application by a unique leave application id ### Example @@ -642,7 +642,7 @@ 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 + # Retrieves a leave application by a unique leave application id api_response = api_instance.get_leave_application(xero_tenant_id, leave_application_id) pprint(api_response) except ApiException as e: @@ -674,7 +674,7 @@ Name | Type | Description | Notes # **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 +Retrieves leave applications ### Example @@ -708,7 +708,7 @@ 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 + # Retrieves 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: @@ -743,7 +743,7 @@ Name | Type | Description | Notes # **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 +Retrieves pay items ### Example @@ -777,7 +777,7 @@ 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 + # Retrieves 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: @@ -812,7 +812,7 @@ Name | Type | Description | Notes # **get_pay_run** > PayRuns get_pay_run(xero_tenant_id, pay_run_id) -searches for an payrun by unique id +Retrieves a pay run by using a unique pay run id ### Example @@ -843,7 +843,7 @@ 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 + # Retrieves a pay run by using a unique pay run id api_response = api_instance.get_pay_run(xero_tenant_id, pay_run_id) pprint(api_response) except ApiException as e: @@ -875,7 +875,7 @@ Name | Type | Description | Notes # **get_pay_runs** > PayRuns get_pay_runs(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) -searches PayRuns +Retrieves pay runs ### Example @@ -909,7 +909,7 @@ 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 + # Retrieves pay runs 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: @@ -944,7 +944,7 @@ Name | Type | Description | Notes # **get_payroll_calendar** > PayrollCalendars get_payroll_calendar(xero_tenant_id, payroll_calendar_id) -searches Payroll Calendars +Retrieves payroll calendar by using a unique payroll calendar ID ### Example @@ -975,7 +975,7 @@ 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 + # Retrieves payroll calendar by using a unique payroll calendar ID api_response = api_instance.get_payroll_calendar(xero_tenant_id, payroll_calendar_id) pprint(api_response) except ApiException as e: @@ -1007,7 +1007,7 @@ Name | Type | Description | Notes # **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 +Retrieves payroll calendars ### Example @@ -1041,7 +1041,7 @@ 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 + # Retrieves 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: @@ -1076,7 +1076,7 @@ Name | Type | Description | Notes # **get_payslip** > PayslipObject get_payslip(xero_tenant_id, payslip_id) -searches for an payslip by unique id +Retrieves for a payslip by a unique payslip id ### Example @@ -1107,7 +1107,7 @@ 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 + # Retrieves for a payslip by a unique payslip id api_response = api_instance.get_payslip(xero_tenant_id, payslip_id) pprint(api_response) except ApiException as e: @@ -1139,7 +1139,7 @@ Name | Type | Description | Notes # **get_settings** > SettingsObject get_settings(xero_tenant_id) -retrieve settings +Retrieves payroll settings ### Example @@ -1169,7 +1169,7 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant try: - # retrieve settings + # Retrieves payroll settings api_response = api_instance.get_settings(xero_tenant_id) pprint(api_response) except ApiException as e: @@ -1200,7 +1200,7 @@ Name | Type | Description | Notes # **get_superfund** > SuperFunds get_superfund(xero_tenant_id, super_fund_id) -searches for an Superfund by unique id +Retrieves a superfund by using a unique superfund ID ### Example @@ -1231,7 +1231,7 @@ 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 + # Retrieves a superfund by using a unique superfund ID api_response = api_instance.get_superfund(xero_tenant_id, super_fund_id) pprint(api_response) except ApiException as e: @@ -1263,7 +1263,7 @@ Name | Type | Description | Notes # **get_superfund_products** > SuperFundProducts get_superfund_products(xero_tenant_id, abn=abn, usi=usi) -searches SuperfundProducts +Retrieves superfund products ### Example @@ -1295,7 +1295,7 @@ 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 + # Retrieves superfund products api_response = api_instance.get_superfund_products(xero_tenant_id, abn=abn, usi=usi) pprint(api_response) except ApiException as e: @@ -1328,7 +1328,7 @@ Name | Type | Description | Notes # **get_superfunds** > SuperFunds get_superfunds(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) -searches SuperFunds +Retrieves superfunds ### Example @@ -1362,7 +1362,7 @@ 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 + # Retrieves 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: @@ -1397,7 +1397,7 @@ Name | Type | Description | Notes # **get_timesheet** > TimesheetObject get_timesheet(xero_tenant_id, timesheet_id) -searches for an timesheet by unique id +Retrieves a timesheet by using a unique timesheet id ### Example @@ -1428,7 +1428,7 @@ 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 + # Retrieves a timesheet by using a unique timesheet id api_response = api_instance.get_timesheet(xero_tenant_id, timesheet_id) pprint(api_response) except ApiException as e: @@ -1460,7 +1460,7 @@ Name | Type | Description | Notes # **get_timesheets** > Timesheets get_timesheets(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) -searches timesheets +Retrieves timesheets ### Example @@ -1494,7 +1494,7 @@ 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 + # Retrieves 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: @@ -1529,7 +1529,7 @@ Name | Type | Description | Notes # **update_employee** > Employees update_employee(xero_tenant_id, employee_id, employee=employee) -Update an Employee +Updates an employee's detail Update properties on a single employee @@ -1563,7 +1563,7 @@ 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 + # Updates an employee's detail api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee=employee) pprint(api_response) except ApiException as e: @@ -1596,7 +1596,7 @@ Name | Type | Description | Notes # **update_leave_application** > LeaveApplications update_leave_application(xero_tenant_id, leave_application_id, leave_application) -Use this method to update a Leave Application +Updates a specific leave application ### Example @@ -1628,7 +1628,7 @@ 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 + # Updates a specific leave application api_response = api_instance.update_leave_application(xero_tenant_id, leave_application_id, leave_application) pprint(api_response) except ApiException as e: @@ -1661,7 +1661,7 @@ Name | Type | Description | Notes # **update_pay_run** > PayRuns update_pay_run(xero_tenant_id, pay_run_id, pay_run=pay_run) -Update a PayRun +Updates a pay run Update properties on a single PayRun @@ -1695,7 +1695,7 @@ 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 + # Updates a pay run api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run=pay_run) pprint(api_response) except ApiException as e: @@ -1728,7 +1728,7 @@ Name | Type | Description | Notes # **update_payslip** > Payslips update_payslip(xero_tenant_id, payslip_id, payslip_lines=payslip_lines) -Update a Payslip +Updates a payslip Update lines on a single payslips @@ -1762,7 +1762,7 @@ 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 + # Updates a payslip api_response = api_instance.update_payslip(xero_tenant_id, payslip_id, payslip_lines=payslip_lines) pprint(api_response) except ApiException as e: @@ -1795,7 +1795,7 @@ Name | Type | Description | Notes # **update_superfund** > SuperFunds update_superfund(xero_tenant_id, super_fund_id, super_fund=super_fund) -Update a Superfund +Updates a superfund Update properties on a single Superfund @@ -1829,7 +1829,7 @@ 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 + # Updates 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: @@ -1862,7 +1862,7 @@ Name | Type | Description | Notes # **update_timesheet** > Timesheets update_timesheet(xero_tenant_id, timesheet_id, timesheet=timesheet) -Update a Timesheet +Updates a timesheet Update properties on a single timesheet @@ -1896,7 +1896,7 @@ 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 + # Updates a timesheet api_response = api_instance.update_timesheet(xero_tenant_id, timesheet_id, timesheet=timesheet) pprint(api_response) except ApiException as e: diff --git a/xero_python/payrollau/docs/SuperLine.md b/xero_python/payrollau/docs/SuperLine.md index b8901ad1..dfc9cf40 100644 --- a/xero_python/payrollau/docs/SuperLine.md +++ b/xero_python/payrollau/docs/SuperLine.md @@ -6,7 +6,7 @@ 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] +**minimum_monthly_earnings** | **float** | amount of minimum 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] diff --git a/xero_python/payrollau/docs/SuperMembership.md b/xero_python/payrollau/docs/SuperMembership.md index 94350c76..6d77061a 100644 --- a/xero_python/payrollau/docs/SuperMembership.md +++ b/xero_python/payrollau/docs/SuperMembership.md @@ -5,7 +5,7 @@ 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** | **str** | The memberhsip number assigned to the employee by the super fund. | +**employee_number** | **str** | The membership 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/models/__init__.py b/xero_python/payrollau/models/__init__.py index bca00bc4..300a4658 100644 --- a/xero_python/payrollau/models/__init__.py +++ b/xero_python/payrollau/models/__init__.py @@ -2,7 +2,7 @@ # flake8: noqa """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/account.py b/xero_python/payrollau/models/account.py index 97215160..eb44265b 100644 --- a/xero_python/payrollau/models/account.py +++ b/xero_python/payrollau/models/account.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/account_type.py b/xero_python/payrollau/models/account_type.py index 1a647a27..19d93988 100644 --- a/xero_python/payrollau/models/account_type.py +++ b/xero_python/payrollau/models/account_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/allowance_type.py b/xero_python/payrollau/models/allowance_type.py index c3a4da35..eb39dbcc 100644 --- a/xero_python/payrollau/models/allowance_type.py +++ b/xero_python/payrollau/models/allowance_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/api_exception.py b/xero_python/payrollau/models/api_exception.py index 50b654a2..d4c9d5e6 100644 --- a/xero_python/payrollau/models/api_exception.py +++ b/xero_python/payrollau/models/api_exception.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/bank_account.py b/xero_python/payrollau/models/bank_account.py index d32fbcbe..821d29a3 100644 --- a/xero_python/payrollau/models/bank_account.py +++ b/xero_python/payrollau/models/bank_account.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/calendar_type.py b/xero_python/payrollau/models/calendar_type.py index 3c747b90..44bc1242 100644 --- a/xero_python/payrollau/models/calendar_type.py +++ b/xero_python/payrollau/models/calendar_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/deduction_line.py b/xero_python/payrollau/models/deduction_line.py index 82d3ac19..5e460fe5 100644 --- a/xero_python/payrollau/models/deduction_line.py +++ b/xero_python/payrollau/models/deduction_line.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/deduction_type.py b/xero_python/payrollau/models/deduction_type.py index 89d92e98..710f70c6 100644 --- a/xero_python/payrollau/models/deduction_type.py +++ b/xero_python/payrollau/models/deduction_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/deduction_type_calculation_type.py b/xero_python/payrollau/models/deduction_type_calculation_type.py index 793f6099..064ed497 100644 --- a/xero_python/payrollau/models/deduction_type_calculation_type.py +++ b/xero_python/payrollau/models/deduction_type_calculation_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/earnings_line.py b/xero_python/payrollau/models/earnings_line.py index 0139a793..09ba7a36 100644 --- a/xero_python/payrollau/models/earnings_line.py +++ b/xero_python/payrollau/models/earnings_line.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/earnings_rate.py b/xero_python/payrollau/models/earnings_rate.py index 5626490e..837af61c 100644 --- a/xero_python/payrollau/models/earnings_rate.py +++ b/xero_python/payrollau/models/earnings_rate.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/earnings_rate_calculation_type.py b/xero_python/payrollau/models/earnings_rate_calculation_type.py index 66b10afe..5673f2da 100644 --- a/xero_python/payrollau/models/earnings_rate_calculation_type.py +++ b/xero_python/payrollau/models/earnings_rate_calculation_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/earnings_type.py b/xero_python/payrollau/models/earnings_type.py index 45ab83ab..c3a3ecb4 100644 --- a/xero_python/payrollau/models/earnings_type.py +++ b/xero_python/payrollau/models/earnings_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/employee.py b/xero_python/payrollau/models/employee.py index 0016fdb3..6c47cd24 100644 --- a/xero_python/payrollau/models/employee.py +++ b/xero_python/payrollau/models/employee.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/employee_status.py b/xero_python/payrollau/models/employee_status.py index 4c54c4e3..628aed98 100644 --- a/xero_python/payrollau/models/employee_status.py +++ b/xero_python/payrollau/models/employee_status.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/employees.py b/xero_python/payrollau/models/employees.py index e7aa1b56..0ea5f01a 100644 --- a/xero_python/payrollau/models/employees.py +++ b/xero_python/payrollau/models/employees.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/employment_basis.py b/xero_python/payrollau/models/employment_basis.py index 04e60ac1..5ca369a9 100644 --- a/xero_python/payrollau/models/employment_basis.py +++ b/xero_python/payrollau/models/employment_basis.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/employment_termination_payment_type.py b/xero_python/payrollau/models/employment_termination_payment_type.py index ce65d340..62bfe29b 100644 --- a/xero_python/payrollau/models/employment_termination_payment_type.py +++ b/xero_python/payrollau/models/employment_termination_payment_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/entitlement_final_pay_payout_type.py b/xero_python/payrollau/models/entitlement_final_pay_payout_type.py index 7e42e3b3..f25e777b 100644 --- a/xero_python/payrollau/models/entitlement_final_pay_payout_type.py +++ b/xero_python/payrollau/models/entitlement_final_pay_payout_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/home_address.py b/xero_python/payrollau/models/home_address.py index 7228eba9..1d0a43fe 100644 --- a/xero_python/payrollau/models/home_address.py +++ b/xero_python/payrollau/models/home_address.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_accrual_line.py b/xero_python/payrollau/models/leave_accrual_line.py index 4d7aeeed..0c067d77 100644 --- a/xero_python/payrollau/models/leave_accrual_line.py +++ b/xero_python/payrollau/models/leave_accrual_line.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_application.py b/xero_python/payrollau/models/leave_application.py index 11aae6aa..496ebd6d 100644 --- a/xero_python/payrollau/models/leave_application.py +++ b/xero_python/payrollau/models/leave_application.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_applications.py b/xero_python/payrollau/models/leave_applications.py index e14c1ac6..76b072d2 100644 --- a/xero_python/payrollau/models/leave_applications.py +++ b/xero_python/payrollau/models/leave_applications.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_balance.py b/xero_python/payrollau/models/leave_balance.py index 16f96730..005e2628 100644 --- a/xero_python/payrollau/models/leave_balance.py +++ b/xero_python/payrollau/models/leave_balance.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_earnings_line.py b/xero_python/payrollau/models/leave_earnings_line.py index ca5bd892..240f0627 100644 --- a/xero_python/payrollau/models/leave_earnings_line.py +++ b/xero_python/payrollau/models/leave_earnings_line.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_line.py b/xero_python/payrollau/models/leave_line.py index 78c97c67..b37e47c5 100644 --- a/xero_python/payrollau/models/leave_line.py +++ b/xero_python/payrollau/models/leave_line.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_line_calculation_type.py b/xero_python/payrollau/models/leave_line_calculation_type.py index 6658c213..713503bd 100644 --- a/xero_python/payrollau/models/leave_line_calculation_type.py +++ b/xero_python/payrollau/models/leave_line_calculation_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_lines.py b/xero_python/payrollau/models/leave_lines.py index ad11ee75..ec518109 100644 --- a/xero_python/payrollau/models/leave_lines.py +++ b/xero_python/payrollau/models/leave_lines.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_period.py b/xero_python/payrollau/models/leave_period.py index 4895882c..7866ab3a 100644 --- a/xero_python/payrollau/models/leave_period.py +++ b/xero_python/payrollau/models/leave_period.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_period_status.py b/xero_python/payrollau/models/leave_period_status.py index be9b3869..49a73e28 100644 --- a/xero_python/payrollau/models/leave_period_status.py +++ b/xero_python/payrollau/models/leave_period_status.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_type.py b/xero_python/payrollau/models/leave_type.py index 5e67be4c..8826df30 100644 --- a/xero_python/payrollau/models/leave_type.py +++ b/xero_python/payrollau/models/leave_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_type_contribution_type.py b/xero_python/payrollau/models/leave_type_contribution_type.py index 632f27ce..e80b9751 100644 --- a/xero_python/payrollau/models/leave_type_contribution_type.py +++ b/xero_python/payrollau/models/leave_type_contribution_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/manual_tax_type.py b/xero_python/payrollau/models/manual_tax_type.py index 9ed7d371..223fd338 100644 --- a/xero_python/payrollau/models/manual_tax_type.py +++ b/xero_python/payrollau/models/manual_tax_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/opening_balances.py b/xero_python/payrollau/models/opening_balances.py index 33b30da4..93889b35 100644 --- a/xero_python/payrollau/models/opening_balances.py +++ b/xero_python/payrollau/models/opening_balances.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/pay_item.py b/xero_python/payrollau/models/pay_item.py index c32b8ff3..b6cf5fbc 100644 --- a/xero_python/payrollau/models/pay_item.py +++ b/xero_python/payrollau/models/pay_item.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/pay_items.py b/xero_python/payrollau/models/pay_items.py index 99312635..09fb1444 100644 --- a/xero_python/payrollau/models/pay_items.py +++ b/xero_python/payrollau/models/pay_items.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/pay_run.py b/xero_python/payrollau/models/pay_run.py index e290705a..b4147298 100644 --- a/xero_python/payrollau/models/pay_run.py +++ b/xero_python/payrollau/models/pay_run.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/pay_run_status.py b/xero_python/payrollau/models/pay_run_status.py index 33f390e8..c979661f 100644 --- a/xero_python/payrollau/models/pay_run_status.py +++ b/xero_python/payrollau/models/pay_run_status.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/pay_runs.py b/xero_python/payrollau/models/pay_runs.py index eea6de0e..f927b517 100644 --- a/xero_python/payrollau/models/pay_runs.py +++ b/xero_python/payrollau/models/pay_runs.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/pay_template.py b/xero_python/payrollau/models/pay_template.py index 47604bba..2d418db4 100644 --- a/xero_python/payrollau/models/pay_template.py +++ b/xero_python/payrollau/models/pay_template.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/payment_frequency_type.py b/xero_python/payrollau/models/payment_frequency_type.py index f787d106..429a0a47 100644 --- a/xero_python/payrollau/models/payment_frequency_type.py +++ b/xero_python/payrollau/models/payment_frequency_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/payroll_calendar.py b/xero_python/payrollau/models/payroll_calendar.py index 09f69847..32477d9e 100644 --- a/xero_python/payrollau/models/payroll_calendar.py +++ b/xero_python/payrollau/models/payroll_calendar.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/payroll_calendars.py b/xero_python/payrollau/models/payroll_calendars.py index 822b62ba..2eb58960 100644 --- a/xero_python/payrollau/models/payroll_calendars.py +++ b/xero_python/payrollau/models/payroll_calendars.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/payslip.py b/xero_python/payrollau/models/payslip.py index e604246f..2ba9e568 100644 --- a/xero_python/payrollau/models/payslip.py +++ b/xero_python/payrollau/models/payslip.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/payslip_lines.py b/xero_python/payrollau/models/payslip_lines.py index 502bbc9a..f47471b7 100644 --- a/xero_python/payrollau/models/payslip_lines.py +++ b/xero_python/payrollau/models/payslip_lines.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/payslip_object.py b/xero_python/payrollau/models/payslip_object.py index 69edff2f..f69acc67 100644 --- a/xero_python/payrollau/models/payslip_object.py +++ b/xero_python/payrollau/models/payslip_object.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/payslip_summary.py b/xero_python/payrollau/models/payslip_summary.py index 76bab3c5..97dbfa4c 100644 --- a/xero_python/payrollau/models/payslip_summary.py +++ b/xero_python/payrollau/models/payslip_summary.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/payslips.py b/xero_python/payrollau/models/payslips.py index 10225b8a..ee7f6744 100644 --- a/xero_python/payrollau/models/payslips.py +++ b/xero_python/payrollau/models/payslips.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/rate_type.py b/xero_python/payrollau/models/rate_type.py index e851ccaf..1bc96604 100644 --- a/xero_python/payrollau/models/rate_type.py +++ b/xero_python/payrollau/models/rate_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/reimbursement_line.py b/xero_python/payrollau/models/reimbursement_line.py index 34114994..43940ce5 100644 --- a/xero_python/payrollau/models/reimbursement_line.py +++ b/xero_python/payrollau/models/reimbursement_line.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/reimbursement_lines.py b/xero_python/payrollau/models/reimbursement_lines.py index da10c900..4d65d57c 100644 --- a/xero_python/payrollau/models/reimbursement_lines.py +++ b/xero_python/payrollau/models/reimbursement_lines.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/reimbursement_type.py b/xero_python/payrollau/models/reimbursement_type.py index 227b7f02..a0ba6d92 100644 --- a/xero_python/payrollau/models/reimbursement_type.py +++ b/xero_python/payrollau/models/reimbursement_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/residency_status.py b/xero_python/payrollau/models/residency_status.py index 056265c8..a9eaa6c3 100644 --- a/xero_python/payrollau/models/residency_status.py +++ b/xero_python/payrollau/models/residency_status.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/settings.py b/xero_python/payrollau/models/settings.py index be3e3e86..816f5777 100644 --- a/xero_python/payrollau/models/settings.py +++ b/xero_python/payrollau/models/settings.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/settings_object.py b/xero_python/payrollau/models/settings_object.py index 7bdc3367..05bf40b0 100644 --- a/xero_python/payrollau/models/settings_object.py +++ b/xero_python/payrollau/models/settings_object.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/settings_tracking_categories.py b/xero_python/payrollau/models/settings_tracking_categories.py index 350af4dd..9c65ea23 100644 --- a/xero_python/payrollau/models/settings_tracking_categories.py +++ b/xero_python/payrollau/models/settings_tracking_categories.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py b/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py index 550a4fdc..7e67f1b3 100644 --- a/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py +++ b/xero_python/payrollau/models/settings_tracking_categories_employee_groups.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py b/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py index b66512ce..5a37b5d6 100644 --- a/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py +++ b/xero_python/payrollau/models/settings_tracking_categories_timesheet_categories.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/state.py b/xero_python/payrollau/models/state.py index 080aca93..b6b7807a 100644 --- a/xero_python/payrollau/models/state.py +++ b/xero_python/payrollau/models/state.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/super_fund.py b/xero_python/payrollau/models/super_fund.py index 02dc60f6..435f3a0e 100644 --- a/xero_python/payrollau/models/super_fund.py +++ b/xero_python/payrollau/models/super_fund.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/super_fund_product.py b/xero_python/payrollau/models/super_fund_product.py index 0a6c91de..2a19af5c 100644 --- a/xero_python/payrollau/models/super_fund_product.py +++ b/xero_python/payrollau/models/super_fund_product.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/super_fund_products.py b/xero_python/payrollau/models/super_fund_products.py index a67401b8..a568a9b5 100644 --- a/xero_python/payrollau/models/super_fund_products.py +++ b/xero_python/payrollau/models/super_fund_products.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/super_fund_type.py b/xero_python/payrollau/models/super_fund_type.py index 7f27a448..71690a55 100644 --- a/xero_python/payrollau/models/super_fund_type.py +++ b/xero_python/payrollau/models/super_fund_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/super_funds.py b/xero_python/payrollau/models/super_funds.py index 2b950a74..8696d36f 100644 --- a/xero_python/payrollau/models/super_funds.py +++ b/xero_python/payrollau/models/super_funds.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/super_line.py b/xero_python/payrollau/models/super_line.py index 372c194d..c81dcac3 100644 --- a/xero_python/payrollau/models/super_line.py +++ b/xero_python/payrollau/models/super_line.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 @@ -160,7 +160,7 @@ def calculation_type(self, calculation_type): def minimum_monthly_earnings(self): """Gets the minimum_monthly_earnings of this SuperLine. # noqa: E501 - amount of mimimum earnings # noqa: E501 + amount of minimum earnings # noqa: E501 :return: The minimum_monthly_earnings of this SuperLine. # noqa: E501 :rtype: float @@ -171,7 +171,7 @@ def minimum_monthly_earnings(self): def minimum_monthly_earnings(self, minimum_monthly_earnings): """Sets the minimum_monthly_earnings of this SuperLine. - amount of mimimum earnings # noqa: E501 + amount of minimum earnings # noqa: E501 :param minimum_monthly_earnings: The minimum_monthly_earnings of this SuperLine. # noqa: E501 :type: float diff --git a/xero_python/payrollau/models/super_membership.py b/xero_python/payrollau/models/super_membership.py index 022d444c..dfd4cc94 100644 --- a/xero_python/payrollau/models/super_membership.py +++ b/xero_python/payrollau/models/super_membership.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 @@ -110,7 +110,7 @@ def super_fund_id(self, super_fund_id): 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 + The membership number assigned to the employee by the super fund. # noqa: E501 :return: The employee_number of this SuperMembership. # noqa: E501 :rtype: str @@ -121,7 +121,7 @@ def employee_number(self): 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 + The membership number assigned to the employee by the super fund. # noqa: E501 :param employee_number: The employee_number of this SuperMembership. # noqa: E501 :type: str diff --git a/xero_python/payrollau/models/superannuation_calculation_type.py b/xero_python/payrollau/models/superannuation_calculation_type.py index f47c4ea3..0c376fa2 100644 --- a/xero_python/payrollau/models/superannuation_calculation_type.py +++ b/xero_python/payrollau/models/superannuation_calculation_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/superannuation_contribution_type.py b/xero_python/payrollau/models/superannuation_contribution_type.py index ef108c6b..2ca054be 100644 --- a/xero_python/payrollau/models/superannuation_contribution_type.py +++ b/xero_python/payrollau/models/superannuation_contribution_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/superannuation_line.py b/xero_python/payrollau/models/superannuation_line.py index d9155c55..4537d6f6 100644 --- a/xero_python/payrollau/models/superannuation_line.py +++ b/xero_python/payrollau/models/superannuation_line.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/tax_declaration.py b/xero_python/payrollau/models/tax_declaration.py index 6542d0f9..53c8595f 100644 --- a/xero_python/payrollau/models/tax_declaration.py +++ b/xero_python/payrollau/models/tax_declaration.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/tax_line.py b/xero_python/payrollau/models/tax_line.py index 296c21bf..8b022601 100644 --- a/xero_python/payrollau/models/tax_line.py +++ b/xero_python/payrollau/models/tax_line.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/tfn_exemption_type.py b/xero_python/payrollau/models/tfn_exemption_type.py index 5e056759..df27d91d 100644 --- a/xero_python/payrollau/models/tfn_exemption_type.py +++ b/xero_python/payrollau/models/tfn_exemption_type.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/timesheet.py b/xero_python/payrollau/models/timesheet.py index fb623178..b6ac10f1 100644 --- a/xero_python/payrollau/models/timesheet.py +++ b/xero_python/payrollau/models/timesheet.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/timesheet_line.py b/xero_python/payrollau/models/timesheet_line.py index cc97527a..652decf9 100644 --- a/xero_python/payrollau/models/timesheet_line.py +++ b/xero_python/payrollau/models/timesheet_line.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/timesheet_object.py b/xero_python/payrollau/models/timesheet_object.py index 45a993db..d36079d7 100644 --- a/xero_python/payrollau/models/timesheet_object.py +++ b/xero_python/payrollau/models/timesheet_object.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/timesheet_status.py b/xero_python/payrollau/models/timesheet_status.py index 8244cb63..909fac8e 100644 --- a/xero_python/payrollau/models/timesheet_status.py +++ b/xero_python/payrollau/models/timesheet_status.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/timesheets.py b/xero_python/payrollau/models/timesheets.py index f716cd6b..1708bbee 100644 --- a/xero_python/payrollau/models/timesheets.py +++ b/xero_python/payrollau/models/timesheets.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollau/models/validation_error.py b/xero_python/payrollau/models/validation_error.py index 4c3aa024..bffdf366 100644 --- a/xero_python/payrollau/models/validation_error.py +++ b/xero_python/payrollau/models/validation_error.py @@ -1,7 +1,7 @@ # coding: utf-8 """ - Xero Payroll AU + Xero Payroll AU API This is the Xero Payroll API for orgs in Australia region. # noqa: E501 diff --git a/xero_python/payrollnz/api/payroll_nz_api.py b/xero_python/payrollnz/api/payroll_nz_api.py index acf90890..b7809b7f 100644 --- a/xero_python/payrollnz/api/payroll_nz_api.py +++ b/xero_python/payrollnz/api/payroll_nz_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.8.4 + OpenAPI spec version: 2.9.3 """ import importlib @@ -64,7 +64,7 @@ def approve_timesheet( _preload_content=True, _request_timeout=None, ): - """approve a timesheet # noqa: E501 + """Approves a timesheet # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) @@ -140,7 +140,7 @@ def create_deduction( _preload_content=True, _request_timeout=None, ): - """create a new deduction # noqa: E501 + """Creates a new deduction for a specific employee # noqa: E501 OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Deduction deduction: (required) @@ -219,7 +219,7 @@ def create_earnings_rate( _preload_content=True, _request_timeout=None, ): - """create a new earnings rate # noqa: E501 + """Creates a new earnings rate # noqa: E501 OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param EarningsRate earnings_rate: (required) @@ -298,7 +298,7 @@ def create_employee( _preload_content=True, _request_timeout=None, ): - """creates employees # noqa: E501 + """Creates an employees # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param Employee employee: (required) @@ -378,7 +378,7 @@ def create_employee_earnings_template( _preload_content=True, _request_timeout=None, ): - """creates employee earnings template records # noqa: E501 + """Creates earnings template records for an employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -410,7 +410,7 @@ def create_employee_earnings_template( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -435,7 +435,7 @@ def create_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/PayTemplates/earnings") + url = self.get_resource_url("/Employees/{EmployeeID}/PayTemplates/earnings") try: return self.api_client.call_api( @@ -469,7 +469,7 @@ def create_employee_leave( _preload_content=True, _request_timeout=None, ): - """creates employee leave records # noqa: E501 + """Creates leave records for a specific employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -501,7 +501,7 @@ def create_employee_leave( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -526,7 +526,7 @@ def create_employee_leave( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/Leave") + url = self.get_resource_url("/Employees/{EmployeeID}/Leave") try: return self.api_client.call_api( @@ -558,7 +558,7 @@ def create_employee_leave_setup( _preload_content=True, _request_timeout=None, ): - """Allows you to set-up leave for a specific employee. This is required before viewing, configuring and requesting leave for an employee # noqa: E501 + """Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -590,7 +590,7 @@ def create_employee_leave_setup( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -615,7 +615,7 @@ def create_employee_leave_setup( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/leaveSetup") + url = self.get_resource_url("/Employees/{EmployeeID}/leaveSetup") try: return self.api_client.call_api( @@ -647,7 +647,7 @@ def create_employee_leave_type( _preload_content=True, _request_timeout=None, ): - """creates employee leave type records # noqa: E501 + """Creates leave type records for a specific employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -679,7 +679,7 @@ def create_employee_leave_type( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -704,7 +704,7 @@ def create_employee_leave_type( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/LeaveTypes") + url = self.get_resource_url("/Employees/{EmployeeID}/LeaveTypes") try: return self.api_client.call_api( @@ -736,7 +736,7 @@ def create_employee_opening_balances( _preload_content=True, _request_timeout=None, ): - """creates employee opening balances # noqa: E501 + """Creates opening balances for a specific employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -768,7 +768,7 @@ def create_employee_opening_balances( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -793,7 +793,7 @@ def create_employee_opening_balances( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/openingBalances") + url = self.get_resource_url("/Employees/{EmployeeID}/openingBalances") try: return self.api_client.call_api( @@ -827,7 +827,7 @@ def create_employee_payment_method( _preload_content=True, _request_timeout=None, ): - """creates employee payment method # noqa: E501 + """Creates a payment method for an employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -859,7 +859,7 @@ def create_employee_payment_method( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -884,7 +884,7 @@ def create_employee_payment_method( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/PaymentMethods") + url = self.get_resource_url("/Employees/{EmployeeID}/PaymentMethods") try: return self.api_client.call_api( @@ -918,7 +918,7 @@ def create_employee_salary_and_wage( _preload_content=True, _request_timeout=None, ): - """creates employee salary and wage record # noqa: E501 + """Creates an employee salary and wage record # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -950,7 +950,7 @@ def create_employee_salary_and_wage( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -975,7 +975,7 @@ def create_employee_salary_and_wage( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/SalaryAndWages") + url = self.get_resource_url("/Employees/{EmployeeID}/SalaryAndWages") try: return self.api_client.call_api( @@ -1009,7 +1009,7 @@ def create_employment( _preload_content=True, _request_timeout=None, ): - """creates employment # noqa: E501 + """Creates an employment detail for a specific employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -1041,7 +1041,7 @@ def create_employment( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -1066,7 +1066,7 @@ def create_employment( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/Employment") + url = self.get_resource_url("/Employees/{EmployeeID}/Employment") try: return self.api_client.call_api( @@ -1097,7 +1097,7 @@ def create_leave_type( _preload_content=True, _request_timeout=None, ): - """create a new leave type # noqa: E501 + """Creates a new leave type # noqa: E501 OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param LeaveType leave_type: (required) @@ -1177,7 +1177,7 @@ def create_multiple_employee_earnings_template( _preload_content=True, _request_timeout=None, ): - """creates multiple employee earnings template records # noqa: E501 + """Creates multiple employee earnings template records for a specific employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -1209,7 +1209,7 @@ def create_multiple_employee_earnings_template( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -1234,7 +1234,7 @@ def create_multiple_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/paytemplateearnings") + url = self.get_resource_url("/Employees/{EmployeeID}/paytemplateearnings") try: return self.api_client.call_api( @@ -1267,7 +1267,7 @@ def create_pay_run( _preload_content=True, _request_timeout=None, ): - """create a pay run # noqa: E501 + """Creates a pay run # noqa: E501 OAuth2 scope: payroll.payruns :param str xero_tenant_id: Xero identifier for Tenant (required) :param PayRun pay_run: (required) @@ -1346,7 +1346,7 @@ def create_pay_run_calendar( _preload_content=True, _request_timeout=None, ): - """create a new payrun calendar # noqa: E501 + """Creates a new payrun calendar # noqa: E501 OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param PayRunCalendar pay_run_calendar: (required) @@ -1425,7 +1425,7 @@ def create_reimbursement( _preload_content=True, _request_timeout=None, ): - """create a new reimbursement # noqa: E501 + """Creates a new reimbursement # noqa: E501 OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Reimbursement reimbursement: (required) @@ -1504,7 +1504,7 @@ def create_superannuation( _preload_content=True, _request_timeout=None, ): - """create a new superannuation # noqa: E501 + """Creates a new superannuation # noqa: E501 OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Benefit benefit: (required) @@ -1552,7 +1552,7 @@ def create_superannuation( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/superannuations") + url = self.get_resource_url("/Superannuations") try: return self.api_client.call_api( @@ -1583,7 +1583,7 @@ def create_timesheet( _preload_content=True, _request_timeout=None, ): - """create a new timesheet # noqa: E501 + """Creates a new timesheet # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param Timesheet timesheet: (required) @@ -1663,7 +1663,7 @@ def create_timesheet_line( _preload_content=True, _request_timeout=None, ): - """create a new timesheet line # noqa: E501 + """Create a new timesheet line for a specific time sheet # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) @@ -1752,7 +1752,7 @@ def delete_employee_earnings_template( _preload_content=True, _request_timeout=None, ): - """deletes an employee earnings template record # noqa: E501 + """Deletes an employee's earnings template record # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -1784,7 +1784,7 @@ def delete_employee_earnings_template( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "PayTemplateEarningID": pay_template_earning_id, } @@ -1806,7 +1806,7 @@ def delete_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url( - "/Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID}" + "/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}" ) try: @@ -1841,7 +1841,7 @@ def delete_employee_leave( _preload_content=True, _request_timeout=None, ): - """deletes an employee leave record # noqa: E501 + """Deletes a leave record for a specific employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -1873,7 +1873,7 @@ def delete_employee_leave( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "LeaveID": leave_id, } @@ -1894,7 +1894,7 @@ def delete_employee_leave( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/Leave/{LeaveID}") + url = self.get_resource_url("/Employees/{EmployeeID}/Leave/{LeaveID}") try: return self.api_client.call_api( @@ -1926,7 +1926,7 @@ def delete_employee_salary_and_wage( _preload_content=True, _request_timeout=None, ): - """deletes an employee salary and wages record # noqa: E501 + """Deletes an employee's salary and wages record # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -1958,7 +1958,7 @@ def delete_employee_salary_and_wage( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "SalaryAndWagesID": salary_and_wages_id, } @@ -1980,7 +1980,7 @@ def delete_employee_salary_and_wage( # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url( - "/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}" + "/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}" ) try: @@ -2014,7 +2014,7 @@ def delete_timesheet( _preload_content=True, _request_timeout=None, ): - """delete a timesheet # noqa: E501 + """Deletes a timesheet # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) @@ -2091,7 +2091,7 @@ def delete_timesheet_line( _preload_content=True, _request_timeout=None, ): - """delete a timesheet line # noqa: E501 + """Deletes a timesheet line for a specific timesheet # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) @@ -2175,7 +2175,7 @@ def get_deduction( _preload_content=True, _request_timeout=None, ): - """retrieve a single deduction by id # noqa: E501 + """Retrieves a single deduction by using a unique deduction ID # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str deduction_id: Identifier for the deduction (required) @@ -2251,7 +2251,7 @@ def get_deductions( _preload_content=True, _request_timeout=None, ): - """searches deductions # noqa: E501 + """Retrieves deductions for a specific employee # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -2322,7 +2322,7 @@ def get_earnings_rate( _preload_content=True, _request_timeout=None, ): - """retrieve a single earnings rates by id # noqa: E501 + """Retrieves a specific earnings rates by using a unique earnings rate id # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str earnings_rate_id: Identifier for the earnings rate (required) @@ -2398,7 +2398,7 @@ def get_earnings_rates( _preload_content=True, _request_timeout=None, ): - """searches earnings rates # noqa: E501 + """Retrieves earnings rates # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -2469,7 +2469,7 @@ def get_employee( _preload_content=True, _request_timeout=None, ): - """searches employees # noqa: E501 + """Retrieves an employees using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -2494,7 +2494,7 @@ def get_employee( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -2514,7 +2514,7 @@ def get_employee( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}") + url = self.get_resource_url("/Employees/{EmployeeID}") try: return self.api_client.call_api( @@ -2545,7 +2545,7 @@ def get_employee_leave_balances( _preload_content=True, _request_timeout=None, ): - """search employee leave balances # noqa: E501 + """Retrieves leave balances for a specific employee # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -2570,7 +2570,7 @@ def get_employee_leave_balances( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -2590,7 +2590,7 @@ def get_employee_leave_balances( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/LeaveBalances") + url = self.get_resource_url("/Employees/{EmployeeID}/LeaveBalances") try: return self.api_client.call_api( @@ -2623,7 +2623,7 @@ def get_employee_leave_periods( _preload_content=True, _request_timeout=None, ): - """searches employee leave periods # noqa: E501 + """Retrieves leave periods for a specific employee # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -2650,7 +2650,7 @@ def get_employee_leave_periods( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -2676,7 +2676,7 @@ def get_employee_leave_periods( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/LeavePeriods") + url = self.get_resource_url("/Employees/{EmployeeID}/LeavePeriods") try: return self.api_client.call_api( @@ -2707,7 +2707,7 @@ def get_employee_leave_types( _preload_content=True, _request_timeout=None, ): - """searches employee leave types # noqa: E501 + """Retrieves leave types for a specific employee # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -2732,7 +2732,7 @@ def get_employee_leave_types( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -2752,7 +2752,7 @@ def get_employee_leave_types( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/LeaveTypes") + url = self.get_resource_url("/Employees/{EmployeeID}/LeaveTypes") try: return self.api_client.call_api( @@ -2783,7 +2783,7 @@ def get_employee_leaves( _preload_content=True, _request_timeout=None, ): - """search employee leave records # noqa: E501 + """Retrieves leave records for a specific employee # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -2808,7 +2808,7 @@ def get_employee_leaves( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -2828,7 +2828,7 @@ def get_employee_leaves( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/Leave") + url = self.get_resource_url("/Employees/{EmployeeID}/Leave") try: return self.api_client.call_api( @@ -2859,7 +2859,7 @@ def get_employee_opening_balances( _preload_content=True, _request_timeout=None, ): - """retrieve employee openingbalances # noqa: E501 + """Retrieves the opening balance for a specific employee # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -2884,7 +2884,7 @@ def get_employee_opening_balances( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -2904,7 +2904,7 @@ def get_employee_opening_balances( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/openingBalances") + url = self.get_resource_url("/Employees/{EmployeeID}/openingBalances") try: return self.api_client.call_api( @@ -2937,7 +2937,7 @@ def get_employee_pay_templates( _preload_content=True, _request_timeout=None, ): - """searches employee pay templates # noqa: E501 + """Retrieves pay templates for a specific employee # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -2962,7 +2962,7 @@ def get_employee_pay_templates( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -2982,7 +2982,7 @@ def get_employee_pay_templates( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/PayTemplates") + url = self.get_resource_url("/Employees/{EmployeeID}/PayTemplates") try: return self.api_client.call_api( @@ -3013,7 +3013,7 @@ def get_employee_payment_method( _preload_content=True, _request_timeout=None, ): - """retrieves an employee's payment method # noqa: E501 + """Retrieves available payment methods for a specific employee # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -3038,7 +3038,7 @@ def get_employee_payment_method( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -3058,7 +3058,7 @@ def get_employee_payment_method( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/PaymentMethods") + url = self.get_resource_url("/Employees/{EmployeeID}/PaymentMethods") try: return self.api_client.call_api( @@ -3090,7 +3090,7 @@ def get_employee_salary_and_wage( _preload_content=True, _request_timeout=None, ): - """get employee salary and wages record by id # noqa: E501 + """Retrieves an employee's salary and wages record by using a unique salary and wage ID # noqa: E501 OAuth2 scope: payroll.employees, payroll.employees.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -3122,7 +3122,7 @@ def get_employee_salary_and_wage( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "SalaryAndWagesID": salary_and_wages_id, } @@ -3144,7 +3144,7 @@ def get_employee_salary_and_wage( # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url( - "/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}" + "/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}" ) try: @@ -3179,7 +3179,7 @@ def get_employee_salary_and_wages( _preload_content=True, _request_timeout=None, ): - """retrieves an employee's salary and wages # noqa: E501 + """Retrieves an employee's salary and wages # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -3205,7 +3205,7 @@ def get_employee_salary_and_wages( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -3228,7 +3228,7 @@ def get_employee_salary_and_wages( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/SalaryAndWages") + url = self.get_resource_url("/Employees/{EmployeeID}/SalaryAndWages") try: return self.api_client.call_api( @@ -3261,7 +3261,7 @@ def get_employee_tax( _preload_content=True, _request_timeout=None, ): - """searches tax records for an employee # noqa: E501 + """Retrieves tax records for a specific employee # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -3286,7 +3286,7 @@ def get_employee_tax( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -3306,7 +3306,7 @@ def get_employee_tax( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/Tax") + url = self.get_resource_url("/Employees/{EmployeeID}/Tax") try: return self.api_client.call_api( @@ -3339,7 +3339,7 @@ def get_employees( _preload_content=True, _request_timeout=None, ): - """searches employees # noqa: E501 + """Retrieves employees # noqa: E501 OAuth2 scope: payroll.employees.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str first_name: Filter by first name @@ -3418,7 +3418,7 @@ def get_leave_type( _preload_content=True, _request_timeout=None, ): - """retrieve a single leave type by id # noqa: E501 + """Retrieves a specific leave type by using a unique leave type ID # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str leave_type_id: Identifier for the leave type (required) @@ -3495,7 +3495,7 @@ def get_leave_types( _preload_content=True, _request_timeout=None, ): - """searches leave types # noqa: E501 + """Retrieves leave types # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -3570,7 +3570,7 @@ def get_pay_run( _preload_content=True, _request_timeout=None, ): - """retrieve a single pay run by id # noqa: E501 + """Retrieves a specific pay run by using a unique pay run ID # noqa: E501 OAuth2 scope: payroll.payruns.read, payroll.payruns :param str xero_tenant_id: Xero identifier for Tenant (required) :param str pay_run_id: Identifier for the pay run (required) @@ -3646,7 +3646,7 @@ def get_pay_run_calendar( _preload_content=True, _request_timeout=None, ): - """retrieve a single payrun calendar by id # noqa: E501 + """Retrieves a specific payrun calendar by using a unique payroll calendar ID # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str payroll_calendar_id: Identifier for the payrun calendars (required) @@ -3722,7 +3722,7 @@ def get_pay_run_calendars( _preload_content=True, _request_timeout=None, ): - """searches payrun calendars # noqa: E501 + """Retrieves payrun calendars # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -3794,7 +3794,7 @@ def get_pay_runs( _preload_content=True, _request_timeout=None, ): - """searches pay runs # noqa: E501 + """Retrieves pay runs # noqa: E501 OAuth2 scope: payroll.payruns.read, payroll.payruns :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -3869,7 +3869,7 @@ def get_pay_slip( _preload_content=True, _request_timeout=None, ): - """retrieve a single payslip by id # noqa: E501 + """Retrieves a specific payslip by a unique pay slip ID # noqa: E501 OAuth2 scope: payroll.payslip.read, payroll.payslip :param str xero_tenant_id: Xero identifier for Tenant (required) :param str pay_slip_id: Identifier for the payslip (required) @@ -3946,7 +3946,7 @@ def get_pay_slips( _preload_content=True, _request_timeout=None, ): - """searches payslips # noqa: E501 + """Retrieves payslips # noqa: E501 OAuth2 scope: payroll.payslip.read, payroll.payslip :param str xero_tenant_id: Xero identifier for Tenant (required) :param str pay_run_id: PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun. (required) @@ -4026,7 +4026,7 @@ def get_reimbursement( _preload_content=True, _request_timeout=None, ): - """retrieve a single reimbursement by id # noqa: E501 + """Retrieves a specific reimbursement by using a unique reimbursement ID # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str reimbursement_id: Identifier for the reimbursement (required) @@ -4102,7 +4102,7 @@ def get_reimbursements( _preload_content=True, _request_timeout=None, ): - """searches reimbursements # noqa: E501 + """Retrieves reimbursements # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -4172,7 +4172,7 @@ def get_settings( _preload_content=True, _request_timeout=None, ): - """searches settings # noqa: E501 + """Retrieves settings # noqa: E501 OAuth2 scope: payroll.settings.read, settings.payslip :param str xero_tenant_id: Xero identifier for Tenant (required) :param bool _return_http_data_only: return received data only @@ -4239,7 +4239,7 @@ def get_statutory_deduction( _preload_content=True, _request_timeout=None, ): - """retrieve a single statutory deduction by id # noqa: E501 + """Retrieves a specific statutory deduction by using a unique statutory deductions id # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str id: Identifier for the statutory deduction (required) @@ -4264,7 +4264,7 @@ def get_statutory_deduction( collection_formats = {} path_params = { - "Id": id, + "id": id, } query_params = [] @@ -4284,7 +4284,7 @@ def get_statutory_deduction( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/StatutoryDeductions/{Id}") + url = self.get_resource_url("/StatutoryDeductions/{id}") try: return self.api_client.call_api( @@ -4315,7 +4315,7 @@ def get_statutory_deductions( _preload_content=True, _request_timeout=None, ): - """searches statutory deductions # noqa: E501 + """Retrieves statutory deductions # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -4386,7 +4386,7 @@ def get_superannuation( _preload_content=True, _request_timeout=None, ): - """searches for a unique superannuation # noqa: E501 + """Retrieves a specific superannuation using a unique superannuation ID # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str superannuation_id: Identifier for the superannuation (required) @@ -4431,7 +4431,7 @@ def get_superannuation( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/superannuations/{SuperannuationID}") + url = self.get_resource_url("/Superannuations/{SuperannuationID}") try: return self.api_client.call_api( @@ -4462,7 +4462,7 @@ def get_superannuations( _preload_content=True, _request_timeout=None, ): - """searches statutory deductions # noqa: E501 + """Retrieves superannuations # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -4502,7 +4502,7 @@ def get_superannuations( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/superannuations") + url = self.get_resource_url("/Superannuations") try: return self.api_client.call_api( @@ -4533,7 +4533,7 @@ def get_timesheet( _preload_content=True, _request_timeout=None, ): - """retrieve a single timesheet by id # noqa: E501 + """Retrieves a specific timesheet by using a unique timesheet ID # noqa: E501 OAuth2 scope: payroll.timesheets.read, timesheets.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) @@ -4611,11 +4611,11 @@ def get_timesheets( _preload_content=True, _request_timeout=None, ): - """searches timesheets # noqa: E501 + """Retrieves timesheets # noqa: E501 OAuth2 scope: payroll.timesheets.read, payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - :param str employee_id: By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeId} to get only the timesheets of a particular employee. + :param str employee_id: By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeID} to get only the timesheets of a particular employee. :param str payroll_calendar_id: By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models @@ -4689,7 +4689,7 @@ def get_tracking_categories( _preload_content=True, _request_timeout=None, ): - """searches tracking categories # noqa: E501 + """Retrieves tracking categories # noqa: E501 OAuth2 scope: payroll.settings.read, settings.payslip :param str xero_tenant_id: Xero identifier for Tenant (required) :param bool _return_http_data_only: return received data only @@ -4725,7 +4725,7 @@ def get_tracking_categories( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/settings/trackingCategories") + url = self.get_resource_url("/Settings/TrackingCategories") try: return self.api_client.call_api( @@ -4756,7 +4756,7 @@ def revert_timesheet( _preload_content=True, _request_timeout=None, ): - """revert a timesheet to draft # noqa: E501 + """Reverts a timesheet to draft # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) @@ -4833,7 +4833,7 @@ def update_employee( _preload_content=True, _request_timeout=None, ): - """updates employee # noqa: E501 + """Updates an existing employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -4865,7 +4865,7 @@ def update_employee( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -4890,7 +4890,7 @@ def update_employee( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}") + url = self.get_resource_url("/Employees/{EmployeeID}") try: return self.api_client.call_api( @@ -4923,7 +4923,7 @@ def update_employee_earnings_template( _preload_content=True, _request_timeout=None, ): - """updates employee earnings template records # noqa: E501 + """Updates an earnings template records for an employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -4962,7 +4962,7 @@ def update_employee_earnings_template( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "PayTemplateEarningID": pay_template_earning_id, } @@ -4989,7 +4989,7 @@ def update_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url( - "/Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID}" + "/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}" ) try: @@ -5025,7 +5025,7 @@ def update_employee_leave( _preload_content=True, _request_timeout=None, ): - """updates employee leave records # noqa: E501 + """Updates leave records for a specific employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -5064,7 +5064,7 @@ def update_employee_leave( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "LeaveID": leave_id, } @@ -5090,7 +5090,7 @@ def update_employee_leave( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/Leave/{LeaveID}") + url = self.get_resource_url("/Employees/{EmployeeID}/Leave/{LeaveID}") try: return self.api_client.call_api( @@ -5123,7 +5123,7 @@ def update_employee_salary_and_wage( _preload_content=True, _request_timeout=None, ): - """updates employee salary and wages record # noqa: E501 + """Updates an employee's salary and wages record # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -5162,7 +5162,7 @@ def update_employee_salary_and_wage( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "SalaryAndWagesID": salary_and_wages_id, } @@ -5189,7 +5189,7 @@ def update_employee_salary_and_wage( # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url( - "/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}" + "/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}" ) try: @@ -5224,7 +5224,7 @@ def update_employee_tax( _preload_content=True, _request_timeout=None, ): - """updates the tax records for an employee # noqa: E501 + """Updates the tax records for a specific employee # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -5256,7 +5256,7 @@ def update_employee_tax( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -5281,7 +5281,7 @@ def update_employee_tax( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/Tax") + url = self.get_resource_url("/Employees/{EmployeeID}/Tax") try: return self.api_client.call_api( @@ -5313,7 +5313,7 @@ def update_pay_run( _preload_content=True, _request_timeout=None, ): - """update a pay run # noqa: E501 + """Updates a pay run # noqa: E501 OAuth2 scope: payroll.payruns :param str xero_tenant_id: Xero identifier for Tenant (required) :param str pay_run_id: Identifier for the pay run (required) @@ -5402,7 +5402,7 @@ def update_pay_slip_line_items( _preload_content=True, _request_timeout=None, ): - """creates employee pay slip # noqa: E501 + """Creates an employee pay slip # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str pay_slip_id: Identifier for the payslip (required) @@ -5492,7 +5492,7 @@ def update_timesheet_line( _preload_content=True, _request_timeout=None, ): - """update a timesheet line # noqa: E501 + """Updates a timesheet line for a specific timesheet # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) diff --git a/xero_python/payrollnz/docs/EarningsLine.md b/xero_python/payrollnz/docs/EarningsLine.md index 4d25ede3..306366e2 100644 --- a/xero_python/payrollnz/docs/EarningsLine.md +++ b/xero_python/payrollnz/docs/EarningsLine.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **amount** | **float** | The amount of the earnings line. | [optional] **is_linked_to_timesheet** | **bool** | Identifies if the earnings is taken from the timesheet. False for earnings line | [optional] **is_average_daily_pay_rate** | **bool** | Identifies if the earnings is using an average daily pay rate | [optional] -**is_system_generated** | **bool** | Flag to indentify whether the earnings line is system generated or not. | [optional] +**is_system_generated** | **bool** | Flag to identify whether the earnings line is system generated or not. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/EmployeeStatutorySickLeave.md b/xero_python/payrollnz/docs/EmployeeStatutorySickLeave.md index 1b5443c0..9f346e67 100644 --- a/xero_python/payrollnz/docs/EmployeeStatutorySickLeave.md +++ b/xero_python/payrollnz/docs/EmployeeStatutorySickLeave.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **status** | **str** | the type of statutory leave | [optional] **work_pattern** | **list[str]** | The days of the work week the employee is scheduled to work at the time the leave is taken | **is_pregnancy_related** | **bool** | Whether the sick leave was pregnancy related | -**sufficient_notice** | **bool** | Whether the employee provided sufficent notice and documentation as required by the employer supporting the sick leave request | +**sufficient_notice** | **bool** | Whether the employee provided sufficient notice and documentation as required by the employer supporting the sick leave request | **is_entitled** | **bool** | Whether the leave was entitled to receive payment | [optional] **entitlement_weeks_requested** | **float** | The amount of requested time (in weeks) | [optional] **entitlement_weeks_qualified** | **float** | The amount of statutory sick leave time off (in weeks) that is available to take at the time the leave was requested | [optional] diff --git a/xero_python/payrollnz/docs/LeaveEarningsLine.md b/xero_python/payrollnz/docs/LeaveEarningsLine.md index 18f5951b..90ffd195 100644 --- a/xero_python/payrollnz/docs/LeaveEarningsLine.md +++ b/xero_python/payrollnz/docs/LeaveEarningsLine.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **amount** | **float** | The amount of the earnings line. | [optional] **is_linked_to_timesheet** | **bool** | Identifies if the leave earnings is taken from the timesheet. False for leave earnings line | [optional] **is_average_daily_pay_rate** | **bool** | Identifies if the earnings is using an average daily pay rate | [optional] -**is_system_generated** | **bool** | Flag to indentify whether the earnings line is system generated or not. | [optional] +**is_system_generated** | **bool** | Flag to identify whether the earnings line is system generated or not. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/PayrollNZApi.md b/xero_python/payrollnz/docs/PayrollNZApi.md index fedc40a9..3f6f2d60 100644 --- a/xero_python/payrollnz/docs/PayrollNZApi.md +++ b/xero_python/payrollnz/docs/PayrollNZApi.md @@ -4,80 +4,80 @@ All URIs are relative to *https://api.xero.com/payroll.xro/2.0* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve_timesheet**](PayrollNzApi.md#approve_timesheet) | **POST** /Timesheets/{TimesheetID}/Approve | approve a timesheet -[**create_deduction**](PayrollNzApi.md#create_deduction) | **POST** /Deductions | create a new deduction -[**create_earnings_rate**](PayrollNzApi.md#create_earnings_rate) | **POST** /EarningsRates | create a new earnings rate -[**create_employee**](PayrollNzApi.md#create_employee) | **POST** /Employees | creates employees -[**create_employee_earnings_template**](PayrollNzApi.md#create_employee_earnings_template) | **POST** /Employees/{EmployeeId}/PayTemplates/earnings | creates employee earnings template records -[**create_employee_leave**](PayrollNzApi.md#create_employee_leave) | **POST** /Employees/{EmployeeId}/Leave | creates employee leave records -[**create_employee_leave_setup**](PayrollNzApi.md#create_employee_leave_setup) | **POST** /Employees/{EmployeeId}/leaveSetup | Allows you to set-up leave for a specific employee. This is required before viewing, configuring and requesting leave for an employee -[**create_employee_leave_type**](PayrollNzApi.md#create_employee_leave_type) | **POST** /Employees/{EmployeeId}/LeaveTypes | creates employee leave type records -[**create_employee_opening_balances**](PayrollNzApi.md#create_employee_opening_balances) | **POST** /Employees/{EmployeeId}/openingBalances | creates employee opening balances -[**create_employee_payment_method**](PayrollNzApi.md#create_employee_payment_method) | **POST** /Employees/{EmployeeId}/PaymentMethods | creates employee payment method -[**create_employee_salary_and_wage**](PayrollNzApi.md#create_employee_salary_and_wage) | **POST** /Employees/{EmployeeId}/SalaryAndWages | creates employee salary and wage record -[**create_employment**](PayrollNzApi.md#create_employment) | **POST** /Employees/{EmployeeId}/Employment | creates employment -[**create_leave_type**](PayrollNzApi.md#create_leave_type) | **POST** /LeaveTypes | create a new leave type -[**create_multiple_employee_earnings_template**](PayrollNzApi.md#create_multiple_employee_earnings_template) | **POST** /Employees/{EmployeeId}/paytemplateearnings | creates multiple employee earnings template records -[**create_pay_run**](PayrollNzApi.md#create_pay_run) | **POST** /PayRuns | create a pay run -[**create_pay_run_calendar**](PayrollNzApi.md#create_pay_run_calendar) | **POST** /PayRunCalendars | create a new payrun calendar -[**create_reimbursement**](PayrollNzApi.md#create_reimbursement) | **POST** /Reimbursements | create a new reimbursement -[**create_superannuation**](PayrollNzApi.md#create_superannuation) | **POST** /superannuations | create a new superannuation -[**create_timesheet**](PayrollNzApi.md#create_timesheet) | **POST** /Timesheets | create a new timesheet -[**create_timesheet_line**](PayrollNzApi.md#create_timesheet_line) | **POST** /Timesheets/{TimesheetID}/Lines | create a new timesheet line -[**delete_employee_earnings_template**](PayrollNzApi.md#delete_employee_earnings_template) | **DELETE** /Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID} | deletes an employee earnings template record -[**delete_employee_leave**](PayrollNzApi.md#delete_employee_leave) | **DELETE** /Employees/{EmployeeId}/Leave/{LeaveID} | deletes an employee leave record -[**delete_employee_salary_and_wage**](PayrollNzApi.md#delete_employee_salary_and_wage) | **DELETE** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | deletes an employee salary and wages record -[**delete_timesheet**](PayrollNzApi.md#delete_timesheet) | **DELETE** /Timesheets/{TimesheetID} | delete a timesheet -[**delete_timesheet_line**](PayrollNzApi.md#delete_timesheet_line) | **DELETE** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | delete a timesheet line -[**get_deduction**](PayrollNzApi.md#get_deduction) | **GET** /Deductions/{deductionId} | retrieve a single deduction by id -[**get_deductions**](PayrollNzApi.md#get_deductions) | **GET** /Deductions | searches deductions -[**get_earnings_rate**](PayrollNzApi.md#get_earnings_rate) | **GET** /EarningsRates/{EarningsRateID} | retrieve a single earnings rates by id -[**get_earnings_rates**](PayrollNzApi.md#get_earnings_rates) | **GET** /EarningsRates | searches earnings rates -[**get_employee**](PayrollNzApi.md#get_employee) | **GET** /Employees/{EmployeeId} | searches employees -[**get_employee_leave_balances**](PayrollNzApi.md#get_employee_leave_balances) | **GET** /Employees/{EmployeeId}/LeaveBalances | search employee leave balances -[**get_employee_leave_periods**](PayrollNzApi.md#get_employee_leave_periods) | **GET** /Employees/{EmployeeId}/LeavePeriods | searches employee leave periods -[**get_employee_leave_types**](PayrollNzApi.md#get_employee_leave_types) | **GET** /Employees/{EmployeeId}/LeaveTypes | searches employee leave types -[**get_employee_leaves**](PayrollNzApi.md#get_employee_leaves) | **GET** /Employees/{EmployeeId}/Leave | search employee leave records -[**get_employee_opening_balances**](PayrollNzApi.md#get_employee_opening_balances) | **GET** /Employees/{EmployeeId}/openingBalances | retrieve employee openingbalances -[**get_employee_pay_templates**](PayrollNzApi.md#get_employee_pay_templates) | **GET** /Employees/{EmployeeId}/PayTemplates | searches employee pay templates -[**get_employee_payment_method**](PayrollNzApi.md#get_employee_payment_method) | **GET** /Employees/{EmployeeId}/PaymentMethods | retrieves an employee's payment method -[**get_employee_salary_and_wage**](PayrollNzApi.md#get_employee_salary_and_wage) | **GET** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | get employee salary and wages record by id -[**get_employee_salary_and_wages**](PayrollNzApi.md#get_employee_salary_and_wages) | **GET** /Employees/{EmployeeId}/SalaryAndWages | retrieves an employee's salary and wages -[**get_employee_tax**](PayrollNzApi.md#get_employee_tax) | **GET** /Employees/{EmployeeId}/Tax | searches tax records for an employee -[**get_employees**](PayrollNzApi.md#get_employees) | **GET** /Employees | searches employees -[**get_leave_type**](PayrollNzApi.md#get_leave_type) | **GET** /LeaveTypes/{LeaveTypeID} | retrieve a single leave type by id -[**get_leave_types**](PayrollNzApi.md#get_leave_types) | **GET** /LeaveTypes | searches leave types -[**get_pay_run**](PayrollNzApi.md#get_pay_run) | **GET** /PayRuns/{PayRunID} | retrieve a single pay run by id -[**get_pay_run_calendar**](PayrollNzApi.md#get_pay_run_calendar) | **GET** /PayRunCalendars/{PayrollCalendarID} | retrieve a single payrun calendar by id -[**get_pay_run_calendars**](PayrollNzApi.md#get_pay_run_calendars) | **GET** /PayRunCalendars | searches payrun calendars -[**get_pay_runs**](PayrollNzApi.md#get_pay_runs) | **GET** /PayRuns | searches pay runs -[**get_pay_slip**](PayrollNzApi.md#get_pay_slip) | **GET** /PaySlips/{PaySlipID} | retrieve a single payslip by id -[**get_pay_slips**](PayrollNzApi.md#get_pay_slips) | **GET** /PaySlips | searches payslips -[**get_reimbursement**](PayrollNzApi.md#get_reimbursement) | **GET** /Reimbursements/{ReimbursementID} | retrieve a single reimbursement by id -[**get_reimbursements**](PayrollNzApi.md#get_reimbursements) | **GET** /Reimbursements | searches reimbursements -[**get_settings**](PayrollNzApi.md#get_settings) | **GET** /Settings | searches settings -[**get_statutory_deduction**](PayrollNzApi.md#get_statutory_deduction) | **GET** /StatutoryDeductions/{Id} | retrieve a single statutory deduction by id -[**get_statutory_deductions**](PayrollNzApi.md#get_statutory_deductions) | **GET** /StatutoryDeductions | searches statutory deductions -[**get_superannuation**](PayrollNzApi.md#get_superannuation) | **GET** /superannuations/{SuperannuationID} | searches for a unique superannuation -[**get_superannuations**](PayrollNzApi.md#get_superannuations) | **GET** /superannuations | searches statutory deductions -[**get_timesheet**](PayrollNzApi.md#get_timesheet) | **GET** /Timesheets/{TimesheetID} | retrieve a single timesheet by id -[**get_timesheets**](PayrollNzApi.md#get_timesheets) | **GET** /Timesheets | searches timesheets -[**get_tracking_categories**](PayrollNzApi.md#get_tracking_categories) | **GET** /settings/trackingCategories | searches tracking categories -[**revert_timesheet**](PayrollNzApi.md#revert_timesheet) | **POST** /Timesheets/{TimesheetID}/RevertToDraft | revert a timesheet to draft -[**update_employee**](PayrollNzApi.md#update_employee) | **PUT** /Employees/{EmployeeId} | updates employee -[**update_employee_earnings_template**](PayrollNzApi.md#update_employee_earnings_template) | **PUT** /Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID} | updates employee earnings template records -[**update_employee_leave**](PayrollNzApi.md#update_employee_leave) | **PUT** /Employees/{EmployeeId}/Leave/{LeaveID} | updates employee leave records -[**update_employee_salary_and_wage**](PayrollNzApi.md#update_employee_salary_and_wage) | **PUT** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | updates employee salary and wages record -[**update_employee_tax**](PayrollNzApi.md#update_employee_tax) | **POST** /Employees/{EmployeeId}/Tax | updates the tax records for an employee -[**update_pay_run**](PayrollNzApi.md#update_pay_run) | **PUT** /PayRuns/{PayRunID} | update a pay run -[**update_pay_slip_line_items**](PayrollNzApi.md#update_pay_slip_line_items) | **PUT** /PaySlips/{PaySlipID} | creates employee pay slip -[**update_timesheet_line**](PayrollNzApi.md#update_timesheet_line) | **PUT** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | update a timesheet line +[**approve_timesheet**](PayrollNzApi.md#approve_timesheet) | **POST** /Timesheets/{TimesheetID}/Approve | Approves a timesheet +[**create_deduction**](PayrollNzApi.md#create_deduction) | **POST** /Deductions | Creates a new deduction for a specific employee +[**create_earnings_rate**](PayrollNzApi.md#create_earnings_rate) | **POST** /EarningsRates | Creates a new earnings rate +[**create_employee**](PayrollNzApi.md#create_employee) | **POST** /Employees | Creates an employees +[**create_employee_earnings_template**](PayrollNzApi.md#create_employee_earnings_template) | **POST** /Employees/{EmployeeID}/PayTemplates/earnings | Creates earnings template records for an employee +[**create_employee_leave**](PayrollNzApi.md#create_employee_leave) | **POST** /Employees/{EmployeeID}/Leave | Creates leave records for a specific employee +[**create_employee_leave_setup**](PayrollNzApi.md#create_employee_leave_setup) | **POST** /Employees/{EmployeeID}/leaveSetup | Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee +[**create_employee_leave_type**](PayrollNzApi.md#create_employee_leave_type) | **POST** /Employees/{EmployeeID}/LeaveTypes | Creates leave type records for a specific employee +[**create_employee_opening_balances**](PayrollNzApi.md#create_employee_opening_balances) | **POST** /Employees/{EmployeeID}/openingBalances | Creates opening balances for a specific employee +[**create_employee_payment_method**](PayrollNzApi.md#create_employee_payment_method) | **POST** /Employees/{EmployeeID}/PaymentMethods | Creates a payment method for an employee +[**create_employee_salary_and_wage**](PayrollNzApi.md#create_employee_salary_and_wage) | **POST** /Employees/{EmployeeID}/SalaryAndWages | Creates an employee salary and wage record +[**create_employment**](PayrollNzApi.md#create_employment) | **POST** /Employees/{EmployeeID}/Employment | Creates an employment detail for a specific employee +[**create_leave_type**](PayrollNzApi.md#create_leave_type) | **POST** /LeaveTypes | Creates a new leave type +[**create_multiple_employee_earnings_template**](PayrollNzApi.md#create_multiple_employee_earnings_template) | **POST** /Employees/{EmployeeID}/paytemplateearnings | Creates multiple employee earnings template records for a specific employee +[**create_pay_run**](PayrollNzApi.md#create_pay_run) | **POST** /PayRuns | Creates a pay run +[**create_pay_run_calendar**](PayrollNzApi.md#create_pay_run_calendar) | **POST** /PayRunCalendars | Creates a new payrun calendar +[**create_reimbursement**](PayrollNzApi.md#create_reimbursement) | **POST** /Reimbursements | Creates a new reimbursement +[**create_superannuation**](PayrollNzApi.md#create_superannuation) | **POST** /Superannuations | Creates a new superannuation +[**create_timesheet**](PayrollNzApi.md#create_timesheet) | **POST** /Timesheets | Creates a new timesheet +[**create_timesheet_line**](PayrollNzApi.md#create_timesheet_line) | **POST** /Timesheets/{TimesheetID}/Lines | Create a new timesheet line for a specific time sheet +[**delete_employee_earnings_template**](PayrollNzApi.md#delete_employee_earnings_template) | **DELETE** /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID} | Deletes an employee's earnings template record +[**delete_employee_leave**](PayrollNzApi.md#delete_employee_leave) | **DELETE** /Employees/{EmployeeID}/Leave/{LeaveID} | Deletes a leave record for a specific employee +[**delete_employee_salary_and_wage**](PayrollNzApi.md#delete_employee_salary_and_wage) | **DELETE** /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} | Deletes an employee's salary and wages record +[**delete_timesheet**](PayrollNzApi.md#delete_timesheet) | **DELETE** /Timesheets/{TimesheetID} | Deletes a timesheet +[**delete_timesheet_line**](PayrollNzApi.md#delete_timesheet_line) | **DELETE** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | Deletes a timesheet line for a specific timesheet +[**get_deduction**](PayrollNzApi.md#get_deduction) | **GET** /Deductions/{deductionId} | Retrieves a single deduction by using a unique deduction ID +[**get_deductions**](PayrollNzApi.md#get_deductions) | **GET** /Deductions | Retrieves deductions for a specific employee +[**get_earnings_rate**](PayrollNzApi.md#get_earnings_rate) | **GET** /EarningsRates/{EarningsRateID} | Retrieves a specific earnings rates by using a unique earnings rate id +[**get_earnings_rates**](PayrollNzApi.md#get_earnings_rates) | **GET** /EarningsRates | Retrieves earnings rates +[**get_employee**](PayrollNzApi.md#get_employee) | **GET** /Employees/{EmployeeID} | Retrieves an employees using a unique employee ID +[**get_employee_leave_balances**](PayrollNzApi.md#get_employee_leave_balances) | **GET** /Employees/{EmployeeID}/LeaveBalances | Retrieves leave balances for a specific employee +[**get_employee_leave_periods**](PayrollNzApi.md#get_employee_leave_periods) | **GET** /Employees/{EmployeeID}/LeavePeriods | Retrieves leave periods for a specific employee +[**get_employee_leave_types**](PayrollNzApi.md#get_employee_leave_types) | **GET** /Employees/{EmployeeID}/LeaveTypes | Retrieves leave types for a specific employee +[**get_employee_leaves**](PayrollNzApi.md#get_employee_leaves) | **GET** /Employees/{EmployeeID}/Leave | Retrieves leave records for a specific employee +[**get_employee_opening_balances**](PayrollNzApi.md#get_employee_opening_balances) | **GET** /Employees/{EmployeeID}/openingBalances | Retrieves the opening balance for a specific employee +[**get_employee_pay_templates**](PayrollNzApi.md#get_employee_pay_templates) | **GET** /Employees/{EmployeeID}/PayTemplates | Retrieves pay templates for a specific employee +[**get_employee_payment_method**](PayrollNzApi.md#get_employee_payment_method) | **GET** /Employees/{EmployeeID}/PaymentMethods | Retrieves available payment methods for a specific employee +[**get_employee_salary_and_wage**](PayrollNzApi.md#get_employee_salary_and_wage) | **GET** /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} | Retrieves an employee's salary and wages record by using a unique salary and wage ID +[**get_employee_salary_and_wages**](PayrollNzApi.md#get_employee_salary_and_wages) | **GET** /Employees/{EmployeeID}/SalaryAndWages | Retrieves an employee's salary and wages +[**get_employee_tax**](PayrollNzApi.md#get_employee_tax) | **GET** /Employees/{EmployeeID}/Tax | Retrieves tax records for a specific employee +[**get_employees**](PayrollNzApi.md#get_employees) | **GET** /Employees | Retrieves employees +[**get_leave_type**](PayrollNzApi.md#get_leave_type) | **GET** /LeaveTypes/{LeaveTypeID} | Retrieves a specific leave type by using a unique leave type ID +[**get_leave_types**](PayrollNzApi.md#get_leave_types) | **GET** /LeaveTypes | Retrieves leave types +[**get_pay_run**](PayrollNzApi.md#get_pay_run) | **GET** /PayRuns/{PayRunID} | Retrieves a specific pay run by using a unique pay run ID +[**get_pay_run_calendar**](PayrollNzApi.md#get_pay_run_calendar) | **GET** /PayRunCalendars/{PayrollCalendarID} | Retrieves a specific payrun calendar by using a unique payroll calendar ID +[**get_pay_run_calendars**](PayrollNzApi.md#get_pay_run_calendars) | **GET** /PayRunCalendars | Retrieves payrun calendars +[**get_pay_runs**](PayrollNzApi.md#get_pay_runs) | **GET** /PayRuns | Retrieves pay runs +[**get_pay_slip**](PayrollNzApi.md#get_pay_slip) | **GET** /PaySlips/{PaySlipID} | Retrieves a specific payslip by a unique pay slip ID +[**get_pay_slips**](PayrollNzApi.md#get_pay_slips) | **GET** /PaySlips | Retrieves payslips +[**get_reimbursement**](PayrollNzApi.md#get_reimbursement) | **GET** /Reimbursements/{ReimbursementID} | Retrieves a specific reimbursement by using a unique reimbursement ID +[**get_reimbursements**](PayrollNzApi.md#get_reimbursements) | **GET** /Reimbursements | Retrieves reimbursements +[**get_settings**](PayrollNzApi.md#get_settings) | **GET** /Settings | Retrieves settings +[**get_statutory_deduction**](PayrollNzApi.md#get_statutory_deduction) | **GET** /StatutoryDeductions/{id} | Retrieves a specific statutory deduction by using a unique statutory deductions id +[**get_statutory_deductions**](PayrollNzApi.md#get_statutory_deductions) | **GET** /StatutoryDeductions | Retrieves statutory deductions +[**get_superannuation**](PayrollNzApi.md#get_superannuation) | **GET** /Superannuations/{SuperannuationID} | Retrieves a specific superannuation using a unique superannuation ID +[**get_superannuations**](PayrollNzApi.md#get_superannuations) | **GET** /Superannuations | Retrieves superannuations +[**get_timesheet**](PayrollNzApi.md#get_timesheet) | **GET** /Timesheets/{TimesheetID} | Retrieves a specific timesheet by using a unique timesheet ID +[**get_timesheets**](PayrollNzApi.md#get_timesheets) | **GET** /Timesheets | Retrieves timesheets +[**get_tracking_categories**](PayrollNzApi.md#get_tracking_categories) | **GET** /Settings/TrackingCategories | Retrieves tracking categories +[**revert_timesheet**](PayrollNzApi.md#revert_timesheet) | **POST** /Timesheets/{TimesheetID}/RevertToDraft | Reverts a timesheet to draft +[**update_employee**](PayrollNzApi.md#update_employee) | **PUT** /Employees/{EmployeeID} | Updates an existing employee +[**update_employee_earnings_template**](PayrollNzApi.md#update_employee_earnings_template) | **PUT** /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID} | Updates an earnings template records for an employee +[**update_employee_leave**](PayrollNzApi.md#update_employee_leave) | **PUT** /Employees/{EmployeeID}/Leave/{LeaveID} | Updates leave records for a specific employee +[**update_employee_salary_and_wage**](PayrollNzApi.md#update_employee_salary_and_wage) | **PUT** /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} | Updates an employee's salary and wages record +[**update_employee_tax**](PayrollNzApi.md#update_employee_tax) | **POST** /Employees/{EmployeeID}/Tax | Updates the tax records for a specific employee +[**update_pay_run**](PayrollNzApi.md#update_pay_run) | **PUT** /PayRuns/{PayRunID} | Updates a pay run +[**update_pay_slip_line_items**](PayrollNzApi.md#update_pay_slip_line_items) | **PUT** /PaySlips/{PaySlipID} | Creates an employee pay slip +[**update_timesheet_line**](PayrollNzApi.md#update_timesheet_line) | **PUT** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | Updates a timesheet line for a specific timesheet # **approve_timesheet** > TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id) -approve a timesheet +Approves a timesheet ### Example @@ -108,7 +108,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet try: - # approve a timesheet + # Approves a timesheet api_response = api_instance.approve_timesheet(xero_tenant_id, timesheet_id) pprint(api_response) except ApiException as e: @@ -140,7 +140,7 @@ Name | Type | Description | Notes # **create_deduction** > DeductionObject create_deduction(xero_tenant_id, deduction) -create a new deduction +Creates a new deduction for a specific employee ### Example @@ -169,9 +169,9 @@ api_client = ApiClient( api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -deduction = { "deductionName": "My new deducation", "deductionCategory": "NzOther", "liabilityAccountId": "568f2e9a-0870-46cc-8678-f83f132ed4e3" } # Deduction | +deduction = { "deductionName": "My new deduction", "deductionCategory": "NzOther", "liabilityAccountId": "568f2e9a-0870-46cc-8678-f83f132ed4e3" } # Deduction | try: - # create a new deduction + # Creates a new deduction for a specific employee api_response = api_instance.create_deduction(xero_tenant_id, deduction) pprint(api_response) except ApiException as e: @@ -203,7 +203,7 @@ Name | Type | Description | Notes # **create_earnings_rate** > EarningsRateObject create_earnings_rate(xero_tenant_id, earnings_rate) -create a new earnings rate +Creates a new earnings rate ### Example @@ -234,7 +234,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant earnings_rate = { "name": "My Earnings Rate", "earningsType": "RegularEarnings", "rateType": "RatePerUnit", "typeOfUnits": "hours", "expenseAccountID": "e4eb36f6-97e3-4427-a394-dd4e1b355c2e" } # EarningsRate | try: - # create a new earnings rate + # Creates a new earnings rate api_response = api_instance.create_earnings_rate(xero_tenant_id, earnings_rate) pprint(api_response) except ApiException as e: @@ -266,7 +266,7 @@ Name | Type | Description | Notes # **create_employee** > EmployeeObject create_employee(xero_tenant_id, employee) -creates employees +Creates an employees ### Example @@ -297,7 +297,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee = { "title": "Mr", "firstName": "Mike", "lastName": "Johntzxzpxhmkgson", "dateOfBirth": "2000-01-01", "address": { "addressLine1": "101 Green St", "city": "San Francisco", "postCode": "4351", "countryName": "United Kingdom" }, "email": "83139@starkindustries.com", "gender": "M" } # Employee | try: - # creates employees + # Creates an employees api_response = api_instance.create_employee(xero_tenant_id, employee) pprint(api_response) except ApiException as e: @@ -329,7 +329,7 @@ Name | Type | Description | Notes # **create_employee_earnings_template** > EarningsTemplateObject create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) -creates employee earnings template records +Creates earnings template records for an employee ### Example @@ -361,7 +361,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object earnings_template = { "ratePerUnit": 20, "numberOfUnits": 8, "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "name": "My New One" } # EarningsTemplate | try: - # creates employee earnings template records + # Creates earnings template records for an employee api_response = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) pprint(api_response) except ApiException as e: @@ -394,7 +394,7 @@ Name | Type | Description | Notes # **create_employee_leave** > EmployeeLeaveObject create_employee_leave(xero_tenant_id, employee_id, employee_leave) -creates employee leave records +Creates leave records for a specific employee ### Example @@ -424,9 +424,9 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee_leave = { "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4", "description": "Creating a Desription", "startDate": "2020-04-24", "endDate": "2020-04-26" } # EmployeeLeave | +employee_leave = { "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4", "description": "Creating a Description", "startDate": "2020-04-24", "endDate": "2020-04-26" } # EmployeeLeave | try: - # creates employee leave records + # Creates leave records for a specific employee api_response = api_instance.create_employee_leave(xero_tenant_id, employee_id, employee_leave) pprint(api_response) except ApiException as e: @@ -459,7 +459,7 @@ Name | Type | Description | Notes # **create_employee_leave_setup** > EmployeeLeaveSetupObject create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setup) -Allows you to set-up leave for a specific employee. This is required before viewing, configuring and requesting leave for an employee +Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee ### Example @@ -491,7 +491,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object employee_leave_setup = { "holidayPayOpeningBalance": 10, "annualLeaveOpeningBalance": 100, "sickLeaveHoursToAccrueAnnually": 20, "sickLeaveOpeningBalance": 10 } # EmployeeLeaveSetup | try: - # Allows you to set-up leave for a specific employee. This is required before viewing, configuring and requesting leave for an employee + # Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee api_response = api_instance.create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setup) pprint(api_response) except ApiException as e: @@ -524,7 +524,7 @@ Name | Type | Description | Notes # **create_employee_leave_type** > EmployeeLeaveTypeObject create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type) -creates employee leave type records +Creates leave type records for a specific employee ### Example @@ -556,7 +556,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object employee_leave_type = { "leaveTypeID": "35da97ae-05b9-427f-9a98-69157ba42cec", "scheduleOfAccrual": "AnnuallyAfter6Months", "hoursAccruedAnnually": 10, "maximumToAccrue": 80, "openingBalance": 100, "rateAccruedHourly": 3.5 } # EmployeeLeaveType | try: - # creates employee leave type records + # Creates leave type records for a specific employee api_response = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type) pprint(api_response) except ApiException as e: @@ -589,7 +589,7 @@ Name | Type | Description | Notes # **create_employee_opening_balances** > EmployeeOpeningBalancesObject create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance) -creates employee opening balances +Creates opening balances for a specific employee ### Example @@ -621,7 +621,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object employee_opening_balance = [{"periodEndDate":"2020-10-01","daysPaid":3,"unpaidWeeks":2,"grossEarnings":40.0}] # list[EmployeeOpeningBalance] | try: - # creates employee opening balances + # Creates opening balances for a specific employee api_response = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance) pprint(api_response) except ApiException as e: @@ -654,7 +654,7 @@ Name | Type | Description | Notes # **create_employee_payment_method** > PaymentMethodObject create_employee_payment_method(xero_tenant_id, employee_id, payment_method) -creates employee payment method +Creates a payment method for an employee ### Example @@ -686,7 +686,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object payment_method = xero_python.payrollnz.PaymentMethod() # PaymentMethod | try: - # creates employee payment method + # Creates a payment method for an employee api_response = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, payment_method) pprint(api_response) except ApiException as e: @@ -719,7 +719,7 @@ Name | Type | Description | Notes # **create_employee_salary_and_wage** > SalaryAndWageObject create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage) -creates employee salary and wage record +Creates an employee salary and wage record ### Example @@ -751,7 +751,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object salary_and_wage = { "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnitsPerWeek": 2, "ratePerUnit": 10, "numberOfUnitsPerDay": 2, "daysPerWeek": 1, "effectiveFrom": "2020-05-01", "annualSalary": 100, "status": "Active", "paymentType": "Salary" } # SalaryAndWage | try: - # creates employee salary and wage record + # Creates an employee salary and wage record api_response = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage) pprint(api_response) except ApiException as e: @@ -784,7 +784,7 @@ Name | Type | Description | Notes # **create_employment** > EmploymentObject create_employment(xero_tenant_id, employee_id, employment) -creates employment +Creates an employment detail for a specific employee ### Example @@ -816,7 +816,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object employment = { "payrollCalendarID": "9aa56064-990f-4ad3-a189-d966d8f6a030", "startDate": "2020-09-02" } # Employment | try: - # creates employment + # Creates an employment detail for a specific employee api_response = api_instance.create_employment(xero_tenant_id, employee_id, employment) pprint(api_response) except ApiException as e: @@ -849,7 +849,7 @@ Name | Type | Description | Notes # **create_leave_type** > LeaveTypeObject create_leave_type(xero_tenant_id, leave_type) -create a new leave type +Creates a new leave type ### Example @@ -880,7 +880,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant leave_type = { "name": "My wqwhhiktun Leave", "isPaidLeave": false, "showOnPayslip": true } # LeaveType | try: - # create a new leave type + # Creates a new leave type api_response = api_instance.create_leave_type(xero_tenant_id, leave_type) pprint(api_response) except ApiException as e: @@ -912,7 +912,7 @@ Name | Type | Description | Notes # **create_multiple_employee_earnings_template** > EmployeeEarningsTemplates create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) -creates multiple employee earnings template records +Creates multiple employee earnings template records for a specific employee ### Example @@ -944,7 +944,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object earnings_template = [{"ratePerUnit":20.0,"numberOfUnits":8.0,"earningsRateID":"f9d8f5b5-9049-47f4-8541-35e200f750a5"},{"ratePerUnit":0.0,"numberOfUnits":8.0,"earningsRateID":"65b83d94-f20f-45e1-85ae-387fcf460c26"}] # list[EarningsTemplate] | try: - # creates multiple employee earnings template records + # Creates multiple employee earnings template records for a specific employee api_response = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) pprint(api_response) except ApiException as e: @@ -977,7 +977,7 @@ Name | Type | Description | Notes # **create_pay_run** > PayRunObject create_pay_run(xero_tenant_id, pay_run) -create a pay run +Creates a pay run ### Example @@ -1008,7 +1008,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_run = { "payrollCalendarID": "9aa56064-990f-4ad3-a189-d966d8f6a030", "periodStartDate": "2020-09-08", "periodEndDate": "2020-09-15", "paymentDate": "2020-09-20", "payRunStatus": "Draft", "payRunType": "Scheduled", "calendarType": "Weekly" } # PayRun | try: - # create a pay run + # Creates a pay run api_response = api_instance.create_pay_run(xero_tenant_id, pay_run) pprint(api_response) except ApiException as e: @@ -1040,7 +1040,7 @@ Name | Type | Description | Notes # **create_pay_run_calendar** > PayRunCalendarObject create_pay_run_calendar(xero_tenant_id, pay_run_calendar) -create a new payrun calendar +Creates a new payrun calendar ### Example @@ -1071,7 +1071,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_run_calendar = { "name": "My Weekly Cal", "calendarType": "Weekly", "periodStartDate": "2020-05-01", "paymentDate": "2020-05-15" } # PayRunCalendar | try: - # create a new payrun calendar + # Creates a new payrun calendar api_response = api_instance.create_pay_run_calendar(xero_tenant_id, pay_run_calendar) pprint(api_response) except ApiException as e: @@ -1103,7 +1103,7 @@ Name | Type | Description | Notes # **create_reimbursement** > ReimbursementObject create_reimbursement(xero_tenant_id, reimbursement) -create a new reimbursement +Creates a new reimbursement ### Example @@ -1134,7 +1134,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant reimbursement = { "name": "My new Reimburse", "accountID": "fa5cdc43-643b-4ad8-b4ac-3ffe0d0f4488", "reimbursementCategory": "GSTInclusive", "calculationType": "FixedAmount" } # Reimbursement | try: - # create a new reimbursement + # Creates a new reimbursement api_response = api_instance.create_reimbursement(xero_tenant_id, reimbursement) pprint(api_response) except ApiException as e: @@ -1166,7 +1166,7 @@ Name | Type | Description | Notes # **create_superannuation** > SuperannuationObject create_superannuation(xero_tenant_id, benefit) -create a new superannuation +Creates a new superannuation ### Example @@ -1197,7 +1197,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant benefit = { "name": "SidSaver", "category": "Other", "liabilityAccountId": "568f2e9a-0870-46cc-8678-f83f132ed4e3", "expenseAccountId": "e4eb36f6-97e3-4427-a394-dd4e1b355c2e", "CalculationTypeNZ": "FixedAmount", "standardAmount": 10 } # Benefit | try: - # create a new superannuation + # Creates a new superannuation api_response = api_instance.create_superannuation(xero_tenant_id, benefit) pprint(api_response) except ApiException as e: @@ -1229,7 +1229,7 @@ Name | Type | Description | Notes # **create_timesheet** > TimesheetObject create_timesheet(xero_tenant_id, timesheet) -create a new timesheet +Creates a new timesheet ### Example @@ -1260,7 +1260,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet = { "payrollCalendarID": "9aa56064-990f-4ad3-a189-d966d8f6a030", "employeeID": "68342973-c405-4b86-b5d3-d7b877c27995", "startDate": "2020-04-13", "endDate": "2020-04-19", "timesheetLines": [ { "date": "2020-04-13", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 8 }, { "date": "2020-04-15", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 6 } ] } # Timesheet | try: - # create a new timesheet + # Creates a new timesheet api_response = api_instance.create_timesheet(xero_tenant_id, timesheet) pprint(api_response) except ApiException as e: @@ -1292,7 +1292,7 @@ Name | Type | Description | Notes # **create_timesheet_line** > TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line) -create a new timesheet line +Create a new timesheet line for a specific time sheet ### Example @@ -1324,7 +1324,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet timesheet_line = { "date": "2020-08-03", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 1 } # TimesheetLine | try: - # create a new timesheet line + # Create a new timesheet line for a specific time sheet api_response = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line) pprint(api_response) except ApiException as e: @@ -1357,7 +1357,7 @@ Name | Type | Description | Notes # **delete_employee_earnings_template** > EarningsTemplateObject delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id) -deletes an employee earnings template record +Deletes an employee's earnings template record ### Example @@ -1389,7 +1389,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object try: - # deletes an employee earnings template record + # Deletes an employee's earnings template record api_response = api_instance.delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id) pprint(api_response) except ApiException as e: @@ -1422,7 +1422,7 @@ Name | Type | Description | Notes # **delete_employee_leave** > EmployeeLeaveObject delete_employee_leave(xero_tenant_id, employee_id, leave_id) -deletes an employee leave record +Deletes a leave record for a specific employee ### Example @@ -1454,7 +1454,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314' # str | Leave id for single object try: - # deletes an employee leave record + # Deletes a leave record for a specific employee api_response = api_instance.delete_employee_leave(xero_tenant_id, employee_id, leave_id) pprint(api_response) except ApiException as e: @@ -1487,7 +1487,7 @@ Name | Type | Description | Notes # **delete_employee_salary_and_wage** > SalaryAndWageObject delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) -deletes an employee salary and wages record +Deletes an employee's salary and wages record ### Example @@ -1519,7 +1519,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single salary and wages object try: - # deletes an employee salary and wages record + # Deletes an employee's salary and wages record api_response = api_instance.delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) pprint(api_response) except ApiException as e: @@ -1552,7 +1552,7 @@ Name | Type | Description | Notes # **delete_timesheet** > TimesheetLine delete_timesheet(xero_tenant_id, timesheet_id) -delete a timesheet +Deletes a timesheet ### Example @@ -1583,7 +1583,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet try: - # delete a timesheet + # Deletes a timesheet api_response = api_instance.delete_timesheet(xero_tenant_id, timesheet_id) pprint(api_response) except ApiException as e: @@ -1615,7 +1615,7 @@ Name | Type | Description | Notes # **delete_timesheet_line** > TimesheetLine delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id) -delete a timesheet line +Deletes a timesheet line for a specific timesheet ### Example @@ -1647,7 +1647,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet timesheet_line_id = 'timesheet_line_id_example' # str | Identifier for the timesheet line try: - # delete a timesheet line + # Deletes a timesheet line for a specific timesheet api_response = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id) pprint(api_response) except ApiException as e: @@ -1680,7 +1680,7 @@ Name | Type | Description | Notes # **get_deduction** > DeductionObject get_deduction(xero_tenant_id, deduction_id) -retrieve a single deduction by id +Retrieves a single deduction by using a unique deduction ID ### Example @@ -1711,7 +1711,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant deduction_id = 'deduction_id_example' # str | Identifier for the deduction try: - # retrieve a single deduction by id + # Retrieves a single deduction by using a unique deduction ID api_response = api_instance.get_deduction(xero_tenant_id, deduction_id) pprint(api_response) except ApiException as e: @@ -1743,7 +1743,7 @@ Name | Type | Description | Notes # **get_deductions** > Deductions get_deductions(xero_tenant_id, page=page) -searches deductions +Retrieves deductions for a specific employee ### Example @@ -1774,7 +1774,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches deductions + # Retrieves deductions for a specific employee api_response = api_instance.get_deductions(xero_tenant_id, page=page) pprint(api_response) except ApiException as e: @@ -1806,7 +1806,7 @@ Name | Type | Description | Notes # **get_earnings_rate** > EarningsRateObject get_earnings_rate(xero_tenant_id, earnings_rate_id) -retrieve a single earnings rates by id +Retrieves a specific earnings rates by using a unique earnings rate id ### Example @@ -1837,7 +1837,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant earnings_rate_id = 'earnings_rate_id_example' # str | Identifier for the earnings rate try: - # retrieve a single earnings rates by id + # Retrieves a specific earnings rates by using a unique earnings rate id api_response = api_instance.get_earnings_rate(xero_tenant_id, earnings_rate_id) pprint(api_response) except ApiException as e: @@ -1869,7 +1869,7 @@ Name | Type | Description | Notes # **get_earnings_rates** > EarningsRates get_earnings_rates(xero_tenant_id, page=page) -searches earnings rates +Retrieves earnings rates ### Example @@ -1900,7 +1900,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches earnings rates + # Retrieves earnings rates api_response = api_instance.get_earnings_rates(xero_tenant_id, page=page) pprint(api_response) except ApiException as e: @@ -1932,7 +1932,7 @@ Name | Type | Description | Notes # **get_employee** > EmployeeObject get_employee(xero_tenant_id, employee_id) -searches employees +Retrieves an employees using a unique employee ID ### Example @@ -1963,7 +1963,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # searches employees + # Retrieves an employees using a unique employee ID api_response = api_instance.get_employee(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -1995,7 +1995,7 @@ Name | Type | Description | Notes # **get_employee_leave_balances** > EmployeeLeaveBalances get_employee_leave_balances(xero_tenant_id, employee_id) -search employee leave balances +Retrieves leave balances for a specific employee ### Example @@ -2026,7 +2026,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # search employee leave balances + # Retrieves leave balances for a specific employee api_response = api_instance.get_employee_leave_balances(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -2058,7 +2058,7 @@ Name | Type | Description | Notes # **get_employee_leave_periods** > LeavePeriods get_employee_leave_periods(xero_tenant_id, employee_id, start_date=start_date, end_date=end_date) -searches employee leave periods +Retrieves leave periods for a specific employee ### Example @@ -2091,7 +2091,7 @@ employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for sin start_date = '2013-10-20' # date | Filter by start date (optional) end_date = 'Johnson' # date | Filter by end date (optional) try: - # searches employee leave periods + # Retrieves leave periods for a specific employee api_response = api_instance.get_employee_leave_periods(xero_tenant_id, employee_id, start_date=start_date, end_date=end_date) pprint(api_response) except ApiException as e: @@ -2125,7 +2125,7 @@ Name | Type | Description | Notes # **get_employee_leave_types** > EmployeeLeaveTypes get_employee_leave_types(xero_tenant_id, employee_id) -searches employee leave types +Retrieves leave types for a specific employee ### Example @@ -2156,7 +2156,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # searches employee leave types + # Retrieves leave types for a specific employee api_response = api_instance.get_employee_leave_types(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -2188,7 +2188,7 @@ Name | Type | Description | Notes # **get_employee_leaves** > EmployeeLeaves get_employee_leaves(xero_tenant_id, employee_id) -search employee leave records +Retrieves leave records for a specific employee ### Example @@ -2219,7 +2219,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # search employee leave records + # Retrieves leave records for a specific employee api_response = api_instance.get_employee_leaves(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -2251,7 +2251,7 @@ Name | Type | Description | Notes # **get_employee_opening_balances** > EmployeeOpeningBalancesObject get_employee_opening_balances(xero_tenant_id, employee_id) -retrieve employee openingbalances +Retrieves the opening balance for a specific employee ### Example @@ -2282,7 +2282,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # retrieve employee openingbalances + # Retrieves the opening balance for a specific employee api_response = api_instance.get_employee_opening_balances(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -2314,7 +2314,7 @@ Name | Type | Description | Notes # **get_employee_pay_templates** > EmployeePayTemplates get_employee_pay_templates(xero_tenant_id, employee_id) -searches employee pay templates +Retrieves pay templates for a specific employee ### Example @@ -2345,7 +2345,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # searches employee pay templates + # Retrieves pay templates for a specific employee api_response = api_instance.get_employee_pay_templates(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -2377,7 +2377,7 @@ Name | Type | Description | Notes # **get_employee_payment_method** > PaymentMethodObject get_employee_payment_method(xero_tenant_id, employee_id) -retrieves an employee's payment method +Retrieves available payment methods for a specific employee ### Example @@ -2408,7 +2408,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # retrieves an employee's payment method + # Retrieves available payment methods for a specific employee api_response = api_instance.get_employee_payment_method(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -2440,7 +2440,7 @@ Name | Type | Description | Notes # **get_employee_salary_and_wage** > SalaryAndWages get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) -get employee salary and wages record by id +Retrieves an employee's salary and wages record by using a unique salary and wage ID ### Example @@ -2472,7 +2472,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object try: - # get employee salary and wages record by id + # Retrieves an employee's salary and wages record by using a unique salary and wage ID api_response = api_instance.get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) pprint(api_response) except ApiException as e: @@ -2505,7 +2505,7 @@ Name | Type | Description | Notes # **get_employee_salary_and_wages** > SalaryAndWages get_employee_salary_and_wages(xero_tenant_id, employee_id, page=page) -retrieves an employee's salary and wages +Retrieves an employee's salary and wages ### Example @@ -2537,7 +2537,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # retrieves an employee's salary and wages + # Retrieves an employee's salary and wages api_response = api_instance.get_employee_salary_and_wages(xero_tenant_id, employee_id, page=page) pprint(api_response) except ApiException as e: @@ -2570,7 +2570,7 @@ Name | Type | Description | Notes # **get_employee_tax** > EmployeeTaxObject get_employee_tax(xero_tenant_id, employee_id) -searches tax records for an employee +Retrieves tax records for a specific employee ### Example @@ -2601,7 +2601,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # searches tax records for an employee + # Retrieves tax records for a specific employee api_response = api_instance.get_employee_tax(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -2633,7 +2633,7 @@ Name | Type | Description | Notes # **get_employees** > Employees get_employees(xero_tenant_id, first_name=first_name, last_name=last_name, page=page) -searches employees +Retrieves employees ### Example @@ -2666,7 +2666,7 @@ first_name = 'John' # str | Filter by first name (optional) last_name = 'Johnson' # str | Filter by last name (optional) page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches employees + # Retrieves employees api_response = api_instance.get_employees(xero_tenant_id, first_name=first_name, last_name=last_name, page=page) pprint(api_response) except ApiException as e: @@ -2700,7 +2700,7 @@ Name | Type | Description | Notes # **get_leave_type** > LeaveTypeObject get_leave_type(xero_tenant_id, leave_type_id) -retrieve a single leave type by id +Retrieves a specific leave type by using a unique leave type ID ### Example @@ -2731,7 +2731,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant leave_type_id = 'leave_type_id_example' # str | Identifier for the leave type try: - # retrieve a single leave type by id + # Retrieves a specific leave type by using a unique leave type ID api_response = api_instance.get_leave_type(xero_tenant_id, leave_type_id) pprint(api_response) except ApiException as e: @@ -2763,7 +2763,7 @@ Name | Type | Description | Notes # **get_leave_types** > LeaveTypes get_leave_types(xero_tenant_id, page=page, active_only=active_only) -searches leave types +Retrieves leave types ### Example @@ -2795,7 +2795,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) active_only = True # bool | Filters leave types by active status. By default the API returns all leave types. (optional) try: - # searches leave types + # Retrieves leave types api_response = api_instance.get_leave_types(xero_tenant_id, page=page, active_only=active_only) pprint(api_response) except ApiException as e: @@ -2828,7 +2828,7 @@ Name | Type | Description | Notes # **get_pay_run** > PayRunObject get_pay_run(xero_tenant_id, pay_run_id) -retrieve a single pay run by id +Retrieves a specific pay run by using a unique pay run ID ### Example @@ -2859,7 +2859,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_run_id = 'pay_run_id_example' # str | Identifier for the pay run try: - # retrieve a single pay run by id + # Retrieves a specific pay run by using a unique pay run ID api_response = api_instance.get_pay_run(xero_tenant_id, pay_run_id) pprint(api_response) except ApiException as e: @@ -2891,7 +2891,7 @@ Name | Type | Description | Notes # **get_pay_run_calendar** > PayRunCalendarObject get_pay_run_calendar(xero_tenant_id, payroll_calendar_id) -retrieve a single payrun calendar by id +Retrieves a specific payrun calendar by using a unique payroll calendar ID ### Example @@ -2922,7 +2922,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant payroll_calendar_id = 'payroll_calendar_id_example' # str | Identifier for the payrun calendars try: - # retrieve a single payrun calendar by id + # Retrieves a specific payrun calendar by using a unique payroll calendar ID api_response = api_instance.get_pay_run_calendar(xero_tenant_id, payroll_calendar_id) pprint(api_response) except ApiException as e: @@ -2954,7 +2954,7 @@ Name | Type | Description | Notes # **get_pay_run_calendars** > PayRunCalendars get_pay_run_calendars(xero_tenant_id, page=page) -searches payrun calendars +Retrieves payrun calendars ### Example @@ -2985,7 +2985,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches payrun calendars + # Retrieves payrun calendars api_response = api_instance.get_pay_run_calendars(xero_tenant_id, page=page) pprint(api_response) except ApiException as e: @@ -3017,7 +3017,7 @@ Name | Type | Description | Notes # **get_pay_runs** > PayRuns get_pay_runs(xero_tenant_id, page=page, status=status) -searches pay runs +Retrieves pay runs ### Example @@ -3049,7 +3049,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) status = 'status_example' # str | By default get payruns will return all the payruns for an organization. You can add GET https://api.xero.com/payroll.xro/2.0/payRuns?statu={PayRunStatus} to filter the payruns by status. (optional) try: - # searches pay runs + # Retrieves pay runs api_response = api_instance.get_pay_runs(xero_tenant_id, page=page, status=status) pprint(api_response) except ApiException as e: @@ -3082,7 +3082,7 @@ Name | Type | Description | Notes # **get_pay_slip** > PaySlipObject get_pay_slip(xero_tenant_id, pay_slip_id) -retrieve a single payslip by id +Retrieves a specific payslip by a unique pay slip ID ### Example @@ -3113,7 +3113,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_slip_id = 'pay_slip_id_example' # str | Identifier for the payslip try: - # retrieve a single payslip by id + # Retrieves a specific payslip by a unique pay slip ID api_response = api_instance.get_pay_slip(xero_tenant_id, pay_slip_id) pprint(api_response) except ApiException as e: @@ -3145,7 +3145,7 @@ Name | Type | Description | Notes # **get_pay_slips** > PaySlips get_pay_slips(xero_tenant_id, pay_run_id, page=page) -searches payslips +Retrieves payslips ### Example @@ -3177,7 +3177,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_run_id = 'pay_run_id_example' # str | PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun. page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches payslips + # Retrieves payslips api_response = api_instance.get_pay_slips(xero_tenant_id, pay_run_id, page=page) pprint(api_response) except ApiException as e: @@ -3210,7 +3210,7 @@ Name | Type | Description | Notes # **get_reimbursement** > ReimbursementObject get_reimbursement(xero_tenant_id, reimbursement_id) -retrieve a single reimbursement by id +Retrieves a specific reimbursement by using a unique reimbursement ID ### Example @@ -3241,7 +3241,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant reimbursement_id = 'reimbursement_id_example' # str | Identifier for the reimbursement try: - # retrieve a single reimbursement by id + # Retrieves a specific reimbursement by using a unique reimbursement ID api_response = api_instance.get_reimbursement(xero_tenant_id, reimbursement_id) pprint(api_response) except ApiException as e: @@ -3273,7 +3273,7 @@ Name | Type | Description | Notes # **get_reimbursements** > Reimbursements get_reimbursements(xero_tenant_id, page=page) -searches reimbursements +Retrieves reimbursements ### Example @@ -3304,7 +3304,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches reimbursements + # Retrieves reimbursements api_response = api_instance.get_reimbursements(xero_tenant_id, page=page) pprint(api_response) except ApiException as e: @@ -3336,7 +3336,7 @@ Name | Type | Description | Notes # **get_settings** > Settings get_settings(xero_tenant_id) -searches settings +Retrieves settings ### Example @@ -3366,7 +3366,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant try: - # searches settings + # Retrieves settings api_response = api_instance.get_settings(xero_tenant_id) pprint(api_response) except ApiException as e: @@ -3397,7 +3397,7 @@ Name | Type | Description | Notes # **get_statutory_deduction** > StatutoryDeductionObject get_statutory_deduction(xero_tenant_id, id) -retrieve a single statutory deduction by id +Retrieves a specific statutory deduction by using a unique statutory deductions id ### Example @@ -3428,7 +3428,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant id = 'id_example' # str | Identifier for the statutory deduction try: - # retrieve a single statutory deduction by id + # Retrieves a specific statutory deduction by using a unique statutory deductions id api_response = api_instance.get_statutory_deduction(xero_tenant_id, id) pprint(api_response) except ApiException as e: @@ -3460,7 +3460,7 @@ Name | Type | Description | Notes # **get_statutory_deductions** > StatutoryDeductions get_statutory_deductions(xero_tenant_id, page=page) -searches statutory deductions +Retrieves statutory deductions ### Example @@ -3491,7 +3491,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches statutory deductions + # Retrieves statutory deductions api_response = api_instance.get_statutory_deductions(xero_tenant_id, page=page) pprint(api_response) except ApiException as e: @@ -3523,7 +3523,7 @@ Name | Type | Description | Notes # **get_superannuation** > SuperannuationObject get_superannuation(xero_tenant_id, superannuation_id) -searches for a unique superannuation +Retrieves a specific superannuation using a unique superannuation ID ### Example @@ -3554,7 +3554,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant superannuation_id = 'superannuation_id_example' # str | Identifier for the superannuation try: - # searches for a unique superannuation + # Retrieves a specific superannuation using a unique superannuation ID api_response = api_instance.get_superannuation(xero_tenant_id, superannuation_id) pprint(api_response) except ApiException as e: @@ -3586,7 +3586,7 @@ Name | Type | Description | Notes # **get_superannuations** > Superannuations get_superannuations(xero_tenant_id, page=page) -searches statutory deductions +Retrieves superannuations ### Example @@ -3617,7 +3617,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches statutory deductions + # Retrieves superannuations api_response = api_instance.get_superannuations(xero_tenant_id, page=page) pprint(api_response) except ApiException as e: @@ -3649,7 +3649,7 @@ Name | Type | Description | Notes # **get_timesheet** > TimesheetObject get_timesheet(xero_tenant_id, timesheet_id) -retrieve a single timesheet by id +Retrieves a specific timesheet by using a unique timesheet ID ### Example @@ -3680,7 +3680,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet try: - # retrieve a single timesheet by id + # Retrieves a specific timesheet by using a unique timesheet ID api_response = api_instance.get_timesheet(xero_tenant_id, timesheet_id) pprint(api_response) except ApiException as e: @@ -3712,7 +3712,7 @@ Name | Type | Description | Notes # **get_timesheets** > Timesheets get_timesheets(xero_tenant_id, page=page, employee_id=employee_id, payroll_calendar_id=payroll_calendar_id) -searches timesheets +Retrieves timesheets ### Example @@ -3742,10 +3742,10 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) -employee_id = 'employee_id_example' # str | By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeId} to get only the timesheets of a particular employee. (optional) +employee_id = 'employee_id_example' # str | By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeID} to get only the timesheets of a particular employee. (optional) payroll_calendar_id = 'payroll_calendar_id_example' # str | By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id (optional) try: - # searches timesheets + # Retrieves timesheets api_response = api_instance.get_timesheets(xero_tenant_id, page=page, employee_id=employee_id, payroll_calendar_id=payroll_calendar_id) pprint(api_response) except ApiException as e: @@ -3758,7 +3758,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] - **employee_id** | [**str**](.md)| By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeId} to get only the timesheets of a particular employee. | [optional] + **employee_id** | [**str**](.md)| By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeID} to get only the timesheets of a particular employee. | [optional] **payroll_calendar_id** | [**str**](.md)| By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id | [optional] ### Return type @@ -3779,7 +3779,7 @@ Name | Type | Description | Notes # **get_tracking_categories** > TrackingCategories get_tracking_categories(xero_tenant_id) -searches tracking categories +Retrieves tracking categories ### Example @@ -3809,7 +3809,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant try: - # searches tracking categories + # Retrieves tracking categories api_response = api_instance.get_tracking_categories(xero_tenant_id) pprint(api_response) except ApiException as e: @@ -3840,7 +3840,7 @@ Name | Type | Description | Notes # **revert_timesheet** > TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id) -revert a timesheet to draft +Reverts a timesheet to draft ### Example @@ -3871,7 +3871,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet try: - # revert a timesheet to draft + # Reverts a timesheet to draft api_response = api_instance.revert_timesheet(xero_tenant_id, timesheet_id) pprint(api_response) except ApiException as e: @@ -3903,7 +3903,7 @@ Name | Type | Description | Notes # **update_employee** > EmployeeObject update_employee(xero_tenant_id, employee_id, employee) -updates employee +Updates an existing employee ### Example @@ -3935,7 +3935,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object employee = { "title": "Mr", "firstName": "Tony", "lastName": "Starkgtrzgquusrson", "dateOfBirth": "1999-01-01", "address": { "addressLine1": "101 Green St", "city": "San Francisco", "postCode": "4432", "countryName": "United Kingdom" }, "email": "58315@starkindustries.com", "gender": "M" } # Employee | try: - # updates employee + # Updates an existing employee api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee) pprint(api_response) except ApiException as e: @@ -3968,7 +3968,7 @@ Name | Type | Description | Notes # **update_employee_earnings_template** > EarningsTemplateObject update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template) -updates employee earnings template records +Updates an earnings template records for an employee ### Example @@ -4001,7 +4001,7 @@ employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for sin pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object earnings_template = { "ratePerUnit": 25, "numberOfUnits": 4, "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5" } # EarningsTemplate | try: - # updates employee earnings template records + # Updates an earnings template records for an employee api_response = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template) pprint(api_response) except ApiException as e: @@ -4035,7 +4035,7 @@ Name | Type | Description | Notes # **update_employee_leave** > EmployeeLeaveObject update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave) -updates employee leave records +Updates leave records for a specific employee ### Example @@ -4066,9 +4066,9 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314' # str | Leave id for single object -employee_leave = { "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4", "description": "Creating a Desription", "startDate": "2020-04-24", "endDate": "2020-04-26", "periods": [ { "periodStartDate": "2020-04-20", "periodEndDate": "2020-04-26", "numberOfUnits": 1, "periodStatus": "Approved" } ] } # EmployeeLeave | +employee_leave = { "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4", "description": "Creating a Description", "startDate": "2020-04-24", "endDate": "2020-04-26", "periods": [ { "periodStartDate": "2020-04-20", "periodEndDate": "2020-04-26", "numberOfUnits": 1, "periodStatus": "Approved" } ] } # EmployeeLeave | try: - # updates employee leave records + # Updates leave records for a specific employee api_response = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave) pprint(api_response) except ApiException as e: @@ -4102,7 +4102,7 @@ Name | Type | Description | Notes # **update_employee_salary_and_wage** > SalaryAndWageObject update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage) -updates employee salary and wages record +Updates an employee's salary and wages record ### Example @@ -4135,7 +4135,7 @@ employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for sin salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object salary_and_wage = { "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnitsPerWeek": 3, "ratePerUnit": 11, "numberOfUnitsPerDay": 3, "daysPerWeek": 1, "effectiveFrom": "2020-05-15", "annualSalary": 101, "status": "Active", "paymentType": "Salary" } # SalaryAndWage | try: - # updates employee salary and wages record + # Updates an employee's salary and wages record api_response = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage) pprint(api_response) except ApiException as e: @@ -4169,7 +4169,7 @@ Name | Type | Description | Notes # **update_employee_tax** > EmployeeTaxObject update_employee_tax(xero_tenant_id, employee_id, employee_tax) -updates the tax records for an employee +Updates the tax records for a specific employee ### Example @@ -4201,7 +4201,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object employee_tax = xero_python.payrollnz.EmployeeTax() # EmployeeTax | try: - # updates the tax records for an employee + # Updates the tax records for a specific employee api_response = api_instance.update_employee_tax(xero_tenant_id, employee_id, employee_tax) pprint(api_response) except ApiException as e: @@ -4234,7 +4234,7 @@ Name | Type | Description | Notes # **update_pay_run** > PayRunObject update_pay_run(xero_tenant_id, pay_run_id, pay_run) -update a pay run +Updates a pay run ### Example @@ -4266,7 +4266,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_run_id = 'pay_run_id_example' # str | Identifier for the pay run pay_run = { "paymentDate": "2019-07-01" } # PayRun | try: - # update a pay run + # Updates a pay run api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run) pprint(api_response) except ApiException as e: @@ -4299,7 +4299,7 @@ Name | Type | Description | Notes # **update_pay_slip_line_items** > PaySlipObject update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip) -creates employee pay slip +Creates an employee pay slip ### Example @@ -4331,7 +4331,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_slip_id = 'pay_slip_id_example' # str | Identifier for the payslip pay_slip = { "earningsLines": [ { "earningsLineID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "displayName": "Ordinary Time", "ratePerUnit": 25, "numberOfUnits": 0, "amount": 0, "isLinkedToTimesheet": false, "isSystemGenerated": true }, { "earningsLineID": "65b83d94-f20f-45e1-85ae-387fcf460c26", "earningsRateID": "65b83d94-f20f-45e1-85ae-387fcf460c26", "displayName": "Salary", "ratePerUnit": 0, "numberOfUnits": 8, "amount": 0, "isLinkedToTimesheet": false, "isSystemGenerated": false } ], "leaveEarningsLines": [ { "earningsLineID": "0441497f-5dc7-4cd3-a90d-f2e07e21b2a6", "earningsRateID": "39b3560a-5d2f-4538-924a-4349dc86396e", "displayName": "Holiday Pay", "fixedAmount": 268.8, "amount": 268.8, "isLinkedToTimesheet": false, "isSystemGenerated": true } ], "deductionLines": [ { "deductionTypeID": "a3760fe4-68a4-4e38-8326-fe616af7dc74", "amount": 100 } ], "leaveAccrualLines": [ { "leaveTypeID": "0441497f-5dc7-4cd3-a90d-f2e07e21b2a6", "numberOfUnits": 268.8 }, { "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4", "numberOfUnits": 0 }, { "leaveTypeID": "f2f994cf-1899-46f3-ad4f-5d92d78c3719", "numberOfUnits": 0 }, { "leaveTypeID": "34129765-11cb-4d8c-b568-84a2219beda3", "numberOfUnits": 0 } ], "superannuationLines": [ { "superannuationTypeID": "563273ea-0dae-4f82-86a4-e0db77c008ea", "displayName": "KiwiSaver", "amount": 108.86, "fixedAmount": 3, "percentage": 3, "manualAdjustment": false } ], "employeeTaxLines": [ { "taxLineID": "1084146b-e890-489c-aed3-06de80f63d84", "amount": 1057.22, "globalTaxTypeID": "11", "manualAdjustment": false } ], "employerTaxLines": [ { "taxLineID": "6f9eb8cd-0f4a-440b-939c-bdb0f6ad694c", "amount": 18.9, "globalTaxTypeID": "10", "manualAdjustment": false } ], "statutoryDeductionLines": [ { "statutoryDeductionTypeID": "b5efd8d1-0c93-4a14-a314-b5cba4a4e6b3", "amount": 108.86 } ], "grossEarningsHistory": { "daysPaid": 3, "unpaidWeeks": 0 } } # PaySlip | try: - # creates employee pay slip + # Creates an employee pay slip api_response = api_instance.update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip) pprint(api_response) except ApiException as e: @@ -4364,7 +4364,7 @@ Name | Type | Description | Notes # **update_timesheet_line** > TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line) -update a timesheet line +Updates a timesheet line for a specific timesheet ### Example @@ -4397,7 +4397,7 @@ timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet timesheet_line_id = 'timesheet_line_id_example' # str | Identifier for the timesheet line timesheet_line = { "date": "2020-08-04", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 2 } # TimesheetLine | try: - # update a timesheet line + # Updates a timesheet line for a specific timesheet api_response = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line) pprint(api_response) except ApiException as e: diff --git a/xero_python/payrollnz/docs/SuperannuationLine.md b/xero_python/payrollnz/docs/SuperannuationLine.md index 404c88ee..ac28873f 100644 --- a/xero_python/payrollnz/docs/SuperannuationLine.md +++ b/xero_python/payrollnz/docs/SuperannuationLine.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**superannuation_type_id** | **str** | Xero identifier for payroll superannucation type | [optional] +**superannuation_type_id** | **str** | Xero identifier for payroll superannuation type | [optional] **display_name** | **str** | Benefit display name | [optional] **amount** | **float** | The amount of the superannuation line | [optional] **fixed_amount** | **float** | Superannuation fixed amount | [optional] diff --git a/xero_python/payrollnz/docs/Timesheet.md b/xero_python/payrollnz/docs/Timesheet.md index 5c21ef69..ee693b86 100644 --- a/xero_python/payrollnz/docs/Timesheet.md +++ b/xero_python/payrollnz/docs/Timesheet.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **timesheet_id** | **str** | The Xero identifier for a Timesheet | [optional] -**payroll_calendar_id** | **str** | The Xero identifier for the Payroll Calandar that the Timesheet applies to | +**payroll_calendar_id** | **str** | The Xero identifier for the Payroll Calendar that the Timesheet applies to | **employee_id** | **str** | The Xero identifier for the Employee that the Timesheet is for | **start_date** | **date** | The Start Date of the Timesheet period (YYYY-MM-DD) | **end_date** | **date** | The End Date of the Timesheet period (YYYY-MM-DD) | diff --git a/xero_python/payrollnz/docs/TimesheetEarningsLine.md b/xero_python/payrollnz/docs/TimesheetEarningsLine.md index 09c6e986..c7fe9c8b 100644 --- a/xero_python/payrollnz/docs/TimesheetEarningsLine.md +++ b/xero_python/payrollnz/docs/TimesheetEarningsLine.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **amount** | **float** | The amount of the earnings line. | [optional] **is_linked_to_timesheet** | **bool** | Identifies if the leave earnings is taken from the timesheet. False for leave earnings line | [optional] **is_average_daily_pay_rate** | **bool** | Identifies if the earnings is using an average daily pay rate | [optional] -**is_system_generated** | **bool** | Flag to indentify whether the earnings line is system generated or not. | [optional] +**is_system_generated** | **bool** | Flag to identify whether the earnings line is system generated or not. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/models/earnings_line.py b/xero_python/payrollnz/models/earnings_line.py index ed18cdd8..016bdb21 100644 --- a/xero_python/payrollnz/models/earnings_line.py +++ b/xero_python/payrollnz/models/earnings_line.py @@ -314,7 +314,7 @@ def is_average_daily_pay_rate(self, is_average_daily_pay_rate): def is_system_generated(self): """Gets the is_system_generated of this EarningsLine. # noqa: E501 - Flag to indentify whether the earnings line is system generated or not. # noqa: E501 + Flag to identify whether the earnings line is system generated or not. # noqa: E501 :return: The is_system_generated of this EarningsLine. # noqa: E501 :rtype: bool @@ -325,7 +325,7 @@ def is_system_generated(self): def is_system_generated(self, is_system_generated): """Sets the is_system_generated of this EarningsLine. - Flag to indentify whether the earnings line is system generated or not. # noqa: E501 + Flag to identify whether the earnings line is system generated or not. # noqa: E501 :param is_system_generated: The is_system_generated of this EarningsLine. # noqa: E501 :type: bool diff --git a/xero_python/payrollnz/models/employee_statutory_sick_leave.py b/xero_python/payrollnz/models/employee_statutory_sick_leave.py index f412317a..d9bd8f75 100644 --- a/xero_python/payrollnz/models/employee_statutory_sick_leave.py +++ b/xero_python/payrollnz/models/employee_statutory_sick_leave.py @@ -367,7 +367,7 @@ def is_pregnancy_related(self, is_pregnancy_related): def sufficient_notice(self): """Gets the sufficient_notice of this EmployeeStatutorySickLeave. # noqa: E501 - Whether the employee provided sufficent notice and documentation as required by the employer supporting the sick leave request # noqa: E501 + Whether the employee provided sufficient notice and documentation as required by the employer supporting the sick leave request # noqa: E501 :return: The sufficient_notice of this EmployeeStatutorySickLeave. # noqa: E501 :rtype: bool @@ -378,7 +378,7 @@ def sufficient_notice(self): def sufficient_notice(self, sufficient_notice): """Sets the sufficient_notice of this EmployeeStatutorySickLeave. - Whether the employee provided sufficent notice and documentation as required by the employer supporting the sick leave request # noqa: E501 + Whether the employee provided sufficient notice and documentation as required by the employer supporting the sick leave request # noqa: E501 :param sufficient_notice: The sufficient_notice of this EmployeeStatutorySickLeave. # noqa: E501 :type: bool diff --git a/xero_python/payrollnz/models/leave_earnings_line.py b/xero_python/payrollnz/models/leave_earnings_line.py index 3ca67730..c2c917e4 100644 --- a/xero_python/payrollnz/models/leave_earnings_line.py +++ b/xero_python/payrollnz/models/leave_earnings_line.py @@ -314,7 +314,7 @@ def is_average_daily_pay_rate(self, is_average_daily_pay_rate): def is_system_generated(self): """Gets the is_system_generated of this LeaveEarningsLine. # noqa: E501 - Flag to indentify whether the earnings line is system generated or not. # noqa: E501 + Flag to identify whether the earnings line is system generated or not. # noqa: E501 :return: The is_system_generated of this LeaveEarningsLine. # noqa: E501 :rtype: bool @@ -325,7 +325,7 @@ def is_system_generated(self): def is_system_generated(self, is_system_generated): """Sets the is_system_generated of this LeaveEarningsLine. - Flag to indentify whether the earnings line is system generated or not. # noqa: E501 + Flag to identify whether the earnings line is system generated or not. # noqa: E501 :param is_system_generated: The is_system_generated of this LeaveEarningsLine. # noqa: E501 :type: bool diff --git a/xero_python/payrollnz/models/superannuation_line.py b/xero_python/payrollnz/models/superannuation_line.py index 2321030a..5ab61bda 100644 --- a/xero_python/payrollnz/models/superannuation_line.py +++ b/xero_python/payrollnz/models/superannuation_line.py @@ -83,7 +83,7 @@ def __init__( def superannuation_type_id(self): """Gets the superannuation_type_id of this SuperannuationLine. # noqa: E501 - Xero identifier for payroll superannucation type # noqa: E501 + Xero identifier for payroll superannuation type # noqa: E501 :return: The superannuation_type_id of this SuperannuationLine. # noqa: E501 :rtype: str @@ -94,7 +94,7 @@ def superannuation_type_id(self): def superannuation_type_id(self, superannuation_type_id): """Sets the superannuation_type_id of this SuperannuationLine. - Xero identifier for payroll superannucation type # noqa: E501 + Xero identifier for payroll superannuation type # noqa: E501 :param superannuation_type_id: The superannuation_type_id of this SuperannuationLine. # noqa: E501 :type: str diff --git a/xero_python/payrollnz/models/timesheet.py b/xero_python/payrollnz/models/timesheet.py index cf22c4dd..03a54667 100644 --- a/xero_python/payrollnz/models/timesheet.py +++ b/xero_python/payrollnz/models/timesheet.py @@ -120,7 +120,7 @@ def timesheet_id(self, timesheet_id): def payroll_calendar_id(self): """Gets the payroll_calendar_id of this Timesheet. # noqa: E501 - The Xero identifier for the Payroll Calandar that the Timesheet applies to # noqa: E501 + The Xero identifier for the Payroll Calendar that the Timesheet applies to # noqa: E501 :return: The payroll_calendar_id of this Timesheet. # noqa: E501 :rtype: str @@ -131,7 +131,7 @@ def payroll_calendar_id(self): def payroll_calendar_id(self, payroll_calendar_id): """Sets the payroll_calendar_id of this Timesheet. - The Xero identifier for the Payroll Calandar that the Timesheet applies to # noqa: E501 + The Xero identifier for the Payroll Calendar that the Timesheet applies to # noqa: E501 :param payroll_calendar_id: The payroll_calendar_id of this Timesheet. # noqa: E501 :type: str diff --git a/xero_python/payrollnz/models/timesheet_earnings_line.py b/xero_python/payrollnz/models/timesheet_earnings_line.py index 26948929..107ccf53 100644 --- a/xero_python/payrollnz/models/timesheet_earnings_line.py +++ b/xero_python/payrollnz/models/timesheet_earnings_line.py @@ -314,7 +314,7 @@ def is_average_daily_pay_rate(self, is_average_daily_pay_rate): def is_system_generated(self): """Gets the is_system_generated of this TimesheetEarningsLine. # noqa: E501 - Flag to indentify whether the earnings line is system generated or not. # noqa: E501 + Flag to identify whether the earnings line is system generated or not. # noqa: E501 :return: The is_system_generated of this TimesheetEarningsLine. # noqa: E501 :rtype: bool @@ -325,7 +325,7 @@ def is_system_generated(self): def is_system_generated(self, is_system_generated): """Sets the is_system_generated of this TimesheetEarningsLine. - Flag to indentify whether the earnings line is system generated or not. # noqa: E501 + Flag to identify whether the earnings line is system generated or not. # noqa: E501 :param is_system_generated: The is_system_generated of this TimesheetEarningsLine. # noqa: E501 :type: bool diff --git a/xero_python/payrolluk/api/payroll_uk_api.py b/xero_python/payrolluk/api/payroll_uk_api.py index 77e10f0f..fe4edb83 100644 --- a/xero_python/payrolluk/api/payroll_uk_api.py +++ b/xero_python/payrolluk/api/payroll_uk_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.8.4 + OpenAPI spec version: 2.9.3 """ import importlib @@ -64,7 +64,7 @@ def approve_timesheet( _preload_content=True, _request_timeout=None, ): - """approve a timesheet # noqa: E501 + """Approves a specific timesheet # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) @@ -140,7 +140,7 @@ def create_benefit( _preload_content=True, _request_timeout=None, ): - """create a new benefit # noqa: E501 + """Creates a new employee benefit # noqa: E501 OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Benefit benefit: (required) @@ -219,7 +219,7 @@ def create_deduction( _preload_content=True, _request_timeout=None, ): - """create a new deduction # noqa: E501 + """Creates a new deduction # noqa: E501 OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Deduction deduction: (required) @@ -298,7 +298,7 @@ def create_earnings_rate( _preload_content=True, _request_timeout=None, ): - """create a new earnings rate # noqa: E501 + """Creates a new earnings rate # noqa: E501 OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param EarningsRate earnings_rate: (required) @@ -377,7 +377,7 @@ def create_employee( _preload_content=True, _request_timeout=None, ): - """creates employees # noqa: E501 + """Creates employees # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param Employee employee: (required) @@ -457,7 +457,7 @@ def create_employee_earnings_template( _preload_content=True, _request_timeout=None, ): - """creates employee earnings template records # noqa: E501 + """Creates an earnings template records for a specific employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -489,7 +489,7 @@ def create_employee_earnings_template( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -514,7 +514,7 @@ def create_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/PayTemplates/earnings") + url = self.get_resource_url("/Employees/{EmployeeID}/PayTemplates/earnings") try: return self.api_client.call_api( @@ -548,7 +548,7 @@ def create_employee_leave( _preload_content=True, _request_timeout=None, ): - """creates employee leave records # noqa: E501 + """Creates leave records for a specific employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -580,7 +580,7 @@ def create_employee_leave( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -605,7 +605,7 @@ def create_employee_leave( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/Leave") + url = self.get_resource_url("/Employees/{EmployeeID}/Leave") try: return self.api_client.call_api( @@ -637,7 +637,7 @@ def create_employee_leave_type( _preload_content=True, _request_timeout=None, ): - """creates employee leave type records # noqa: E501 + """Creates employee leave type records # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -669,7 +669,7 @@ def create_employee_leave_type( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -694,7 +694,7 @@ def create_employee_leave_type( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/LeaveTypes") + url = self.get_resource_url("/Employees/{EmployeeID}/LeaveTypes") try: return self.api_client.call_api( @@ -726,7 +726,7 @@ def create_employee_opening_balances( _preload_content=True, _request_timeout=None, ): - """creates employee opening balances # noqa: E501 + """Creates an opening balance for a specific employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -758,7 +758,7 @@ def create_employee_opening_balances( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -783,7 +783,7 @@ def create_employee_opening_balances( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/ukopeningbalances") + url = self.get_resource_url("/Employees/{EmployeeID}/ukopeningbalances") try: return self.api_client.call_api( @@ -817,7 +817,7 @@ def create_employee_payment_method( _preload_content=True, _request_timeout=None, ): - """creates employee payment method # noqa: E501 + """Creates an employee payment method # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -849,7 +849,7 @@ def create_employee_payment_method( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -874,7 +874,7 @@ def create_employee_payment_method( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/PaymentMethods") + url = self.get_resource_url("/Employees/{EmployeeID}/PaymentMethods") try: return self.api_client.call_api( @@ -908,7 +908,7 @@ def create_employee_salary_and_wage( _preload_content=True, _request_timeout=None, ): - """creates employee salary and wage record # noqa: E501 + """Creates a salary and wage record for a specific employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -940,7 +940,7 @@ def create_employee_salary_and_wage( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -965,7 +965,7 @@ def create_employee_salary_and_wage( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/SalaryAndWages") + url = self.get_resource_url("/Employees/{EmployeeID}/SalaryAndWages") try: return self.api_client.call_api( @@ -998,7 +998,7 @@ def create_employee_statutory_sick_leave( _preload_content=True, _request_timeout=None, ): - """creates employee statutory sick leave records # noqa: E501 + """Creates statutory sick leave records # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param EmployeeStatutorySickLeave employee_statutory_sick_leave: (required) @@ -1080,7 +1080,7 @@ def create_employment( _preload_content=True, _request_timeout=None, ): - """creates employment # noqa: E501 + """Creates employment detail for a specific employee using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -1112,7 +1112,7 @@ def create_employment( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -1137,7 +1137,7 @@ def create_employment( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/Employment") + url = self.get_resource_url("/Employees/{EmployeeID}/Employment") try: return self.api_client.call_api( @@ -1168,7 +1168,7 @@ def create_leave_type( _preload_content=True, _request_timeout=None, ): - """create a new leave type # noqa: E501 + """Creates a new leave type # noqa: E501 OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param LeaveType leave_type: (required) @@ -1248,7 +1248,7 @@ def create_multiple_employee_earnings_template( _preload_content=True, _request_timeout=None, ): - """creates multiple employee earnings template records # noqa: E501 + """Creates multiple earnings template records for a specific employee using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -1280,7 +1280,7 @@ def create_multiple_employee_earnings_template( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -1305,7 +1305,7 @@ def create_multiple_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/paytemplateearnings") + url = self.get_resource_url("/Employees/{EmployeeID}/paytemplateearnings") try: return self.api_client.call_api( @@ -1338,7 +1338,7 @@ def create_pay_run_calendar( _preload_content=True, _request_timeout=None, ): - """create a new payrun calendar # noqa: E501 + """Creates a new payrun calendar # noqa: E501 OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param PayRunCalendar pay_run_calendar: (required) @@ -1417,7 +1417,7 @@ def create_reimbursement( _preload_content=True, _request_timeout=None, ): - """create a new reimbursement # noqa: E501 + """Creates a new reimbursement # noqa: E501 OAuth2 scope: payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Reimbursement reimbursement: (required) @@ -1496,7 +1496,7 @@ def create_timesheet( _preload_content=True, _request_timeout=None, ): - """create a new timesheet # noqa: E501 + """Creates a new timesheet # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param Timesheet timesheet: (required) @@ -1576,7 +1576,7 @@ def create_timesheet_line( _preload_content=True, _request_timeout=None, ): - """create a new timesheet line # noqa: E501 + """Creates a new timesheet line for a specific timesheet using a unique timesheet ID # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) @@ -1665,7 +1665,7 @@ def delete_employee_earnings_template( _preload_content=True, _request_timeout=None, ): - """deletes an employee earnings template record # noqa: E501 + """Deletes a specific employee's earnings template record # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -1697,7 +1697,7 @@ def delete_employee_earnings_template( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "PayTemplateEarningID": pay_template_earning_id, } @@ -1714,7 +1714,7 @@ def delete_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url( - "/Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID}" + "/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}" ) try: @@ -1749,7 +1749,7 @@ def delete_employee_leave( _preload_content=True, _request_timeout=None, ): - """deletes an employee leave record # noqa: E501 + """Deletes a specific employee's leave record # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -1781,7 +1781,7 @@ def delete_employee_leave( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "LeaveID": leave_id, } @@ -1802,7 +1802,7 @@ def delete_employee_leave( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/Leave/{LeaveID}") + url = self.get_resource_url("/Employees/{EmployeeID}/Leave/{LeaveID}") try: return self.api_client.call_api( @@ -1834,7 +1834,7 @@ def delete_employee_salary_and_wage( _preload_content=True, _request_timeout=None, ): - """deletes an employee salary and wages record # noqa: E501 + """Deletes a salary and wages record for a specific employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -1866,7 +1866,7 @@ def delete_employee_salary_and_wage( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "SalaryAndWagesID": salary_and_wages_id, } @@ -1883,7 +1883,7 @@ def delete_employee_salary_and_wage( # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url( - "/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}" + "/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}" ) try: @@ -1917,7 +1917,7 @@ def delete_timesheet( _preload_content=True, _request_timeout=None, ): - """delete a timesheet # noqa: E501 + """Deletes a specific timesheet # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) @@ -1994,7 +1994,7 @@ def delete_timesheet_line( _preload_content=True, _request_timeout=None, ): - """delete a timesheet line # noqa: E501 + """Deletes a specific timesheet line # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) @@ -2078,7 +2078,7 @@ def get_benefit( _preload_content=True, _request_timeout=None, ): - """retrieve a single benefit by id # noqa: E501 + """Retrieves a specific benefit by using a unique benefit ID # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str id: Identifier for the benefit (required) @@ -2153,7 +2153,7 @@ def get_benefits( _preload_content=True, _request_timeout=None, ): - """searches benefits # noqa: E501 + """Retrieves employee benefits # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -2224,7 +2224,7 @@ def get_deduction( _preload_content=True, _request_timeout=None, ): - """retrieve a single deduction by id # noqa: E501 + """Retrieves a specific deduction by using a unique deduction ID # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str deduction_id: Identifier for the deduction (required) @@ -2300,7 +2300,7 @@ def get_deductions( _preload_content=True, _request_timeout=None, ): - """searches deductions # noqa: E501 + """Retrieves deductions # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -2371,7 +2371,7 @@ def get_earnings_order( _preload_content=True, _request_timeout=None, ): - """retrieve a single deduction by id # noqa: E501 + """Retrieves a specific earnings orders by using a unique earnings orders id # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str id: Identifier for the deduction (required) @@ -2447,7 +2447,7 @@ def get_earnings_orders( _preload_content=True, _request_timeout=None, ): - """searches earnings orders # noqa: E501 + """Retrieves earnings orders # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -2518,7 +2518,7 @@ def get_earnings_rate( _preload_content=True, _request_timeout=None, ): - """retrieve a single earnings rates by id # noqa: E501 + """Retrieves a specific earnings rates by using a unique earnings rate id # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str earnings_rate_id: Identifier for the earnings rate (required) @@ -2594,7 +2594,7 @@ def get_earnings_rates( _preload_content=True, _request_timeout=None, ): - """searches earnings rates # noqa: E501 + """Retrieves earnings rates # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -2665,7 +2665,7 @@ def get_employee( _preload_content=True, _request_timeout=None, ): - """searches employees # noqa: E501 + """Retrieves specific employees by using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -2690,7 +2690,7 @@ def get_employee( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -2710,7 +2710,7 @@ def get_employee( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}") + url = self.get_resource_url("/Employees/{EmployeeID}") try: return self.api_client.call_api( @@ -2742,7 +2742,7 @@ def get_employee_leave( _preload_content=True, _request_timeout=None, ): - """retrieve a single employee leave record # noqa: E501 + """Retrieves a specific employee's leave record using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -2774,7 +2774,7 @@ def get_employee_leave( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "LeaveID": leave_id, } @@ -2795,7 +2795,7 @@ def get_employee_leave( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/Leave/{LeaveID}") + url = self.get_resource_url("/Employees/{EmployeeID}/Leave/{LeaveID}") try: return self.api_client.call_api( @@ -2826,7 +2826,7 @@ def get_employee_leave_balances( _preload_content=True, _request_timeout=None, ): - """search employee leave balances # noqa: E501 + """Retrieves a specific employee's leave balances using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -2851,7 +2851,7 @@ def get_employee_leave_balances( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -2871,7 +2871,7 @@ def get_employee_leave_balances( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/LeaveBalances") + url = self.get_resource_url("/Employees/{EmployeeID}/LeaveBalances") try: return self.api_client.call_api( @@ -2904,7 +2904,7 @@ def get_employee_leave_periods( _preload_content=True, _request_timeout=None, ): - """searches employee leave periods # noqa: E501 + """Retrieves a specific employee's leave periods using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -2931,7 +2931,7 @@ def get_employee_leave_periods( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -2957,7 +2957,7 @@ def get_employee_leave_periods( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/LeavePeriods") + url = self.get_resource_url("/Employees/{EmployeeID}/LeavePeriods") try: return self.api_client.call_api( @@ -2988,7 +2988,7 @@ def get_employee_leave_types( _preload_content=True, _request_timeout=None, ): - """searches employee leave types # noqa: E501 + """Retrieves a specific employee's leave types using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -3013,7 +3013,7 @@ def get_employee_leave_types( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -3033,7 +3033,7 @@ def get_employee_leave_types( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/LeaveTypes") + url = self.get_resource_url("/Employees/{EmployeeID}/LeaveTypes") try: return self.api_client.call_api( @@ -3064,7 +3064,7 @@ def get_employee_leaves( _preload_content=True, _request_timeout=None, ): - """search employee leave records # noqa: E501 + """Retrieves a specific employee's leave records using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -3089,7 +3089,7 @@ def get_employee_leaves( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -3109,7 +3109,7 @@ def get_employee_leaves( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/Leave") + url = self.get_resource_url("/Employees/{EmployeeID}/Leave") try: return self.api_client.call_api( @@ -3140,7 +3140,7 @@ def get_employee_opening_balances( _preload_content=True, _request_timeout=None, ): - """retrieve employee openingbalances # noqa: E501 + """Retrieves a specific employee's openingbalances using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -3165,7 +3165,7 @@ def get_employee_opening_balances( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -3185,7 +3185,7 @@ def get_employee_opening_balances( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/ukopeningbalances") + url = self.get_resource_url("/Employees/{EmployeeID}/ukopeningbalances") try: return self.api_client.call_api( @@ -3218,7 +3218,7 @@ def get_employee_pay_template( _preload_content=True, _request_timeout=None, ): - """searches employee pay templates # noqa: E501 + """Retrieves a specific employee pay templates using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -3243,7 +3243,7 @@ def get_employee_pay_template( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -3263,7 +3263,7 @@ def get_employee_pay_template( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/PayTemplates") + url = self.get_resource_url("/Employees/{EmployeeID}/PayTemplates") try: return self.api_client.call_api( @@ -3294,7 +3294,7 @@ def get_employee_payment_method( _preload_content=True, _request_timeout=None, ): - """retrieves an employee's payment method # noqa: E501 + """Retrieves a specific employee's payment method using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -3319,7 +3319,7 @@ def get_employee_payment_method( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -3339,7 +3339,7 @@ def get_employee_payment_method( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/PaymentMethods") + url = self.get_resource_url("/Employees/{EmployeeID}/PaymentMethods") try: return self.api_client.call_api( @@ -3371,7 +3371,7 @@ def get_employee_salary_and_wage( _preload_content=True, _request_timeout=None, ): - """get employee salary and wages record by id # noqa: E501 + """Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id # noqa: E501 OAuth2 scope: payroll.employees, payroll.employees.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -3403,7 +3403,7 @@ def get_employee_salary_and_wage( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "SalaryAndWagesID": salary_and_wages_id, } @@ -3425,7 +3425,7 @@ def get_employee_salary_and_wage( # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url( - "/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}" + "/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}" ) try: @@ -3460,7 +3460,7 @@ def get_employee_salary_and_wages( _preload_content=True, _request_timeout=None, ): - """retrieves an employee's salary and wages # noqa: E501 + """Retrieves a specific employee's salary and wages by using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -3486,7 +3486,7 @@ def get_employee_salary_and_wages( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -3509,7 +3509,7 @@ def get_employee_salary_and_wages( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/SalaryAndWages") + url = self.get_resource_url("/Employees/{EmployeeID}/SalaryAndWages") try: return self.api_client.call_api( @@ -3544,7 +3544,7 @@ def get_employee_statutory_leave_balances( _preload_content=True, _request_timeout=None, ): - """search employee leave balances # noqa: E501 + """Retrieves a specific employee's leave balances using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -3571,7 +3571,7 @@ def get_employee_statutory_leave_balances( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -3597,7 +3597,7 @@ def get_employee_statutory_leave_balances( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/StatutoryLeaveBalance") + url = self.get_resource_url("/Employees/{EmployeeID}/StatutoryLeaveBalance") try: return self.api_client.call_api( @@ -3630,7 +3630,7 @@ def get_employee_statutory_sick_leave( _preload_content=True, _request_timeout=None, ): - """retrieve a statutory sick leave for an employee # noqa: E501 + """Retrieves a statutory sick leave for an employee # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str statutory_sick_leave_id: Statutory sick leave id for single object (required) @@ -3708,7 +3708,7 @@ def get_employee_tax( _preload_content=True, _request_timeout=None, ): - """searches tax records for an employee # noqa: E501 + """Retrieves tax records for a specific employee using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -3733,7 +3733,7 @@ def get_employee_tax( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -3753,7 +3753,7 @@ def get_employee_tax( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/Tax") + url = self.get_resource_url("/Employees/{EmployeeID}/Tax") try: return self.api_client.call_api( @@ -3786,7 +3786,7 @@ def get_employees( _preload_content=True, _request_timeout=None, ): - """searches employees # noqa: E501 + """Retrieves employees # noqa: E501 OAuth2 scope: payroll.employees.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str first_name: Filter by first name @@ -3865,7 +3865,7 @@ def get_leave_type( _preload_content=True, _request_timeout=None, ): - """retrieve a single leave type by id # noqa: E501 + """Retrieves a specific leave type by using a unique leave type ID # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str leave_type_id: Identifier for the leave type (required) @@ -3942,7 +3942,7 @@ def get_leave_types( _preload_content=True, _request_timeout=None, ): - """searches leave types # noqa: E501 + """Retrieves leave types # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -4017,7 +4017,7 @@ def get_pay_run( _preload_content=True, _request_timeout=None, ): - """retrieve a single pay run by id # noqa: E501 + """Retrieves a specific pay run by using a unique pay run ID # noqa: E501 OAuth2 scope: payroll.payruns.read, payroll.payruns :param str xero_tenant_id: Xero identifier for Tenant (required) :param str pay_run_id: Identifier for the pay run (required) @@ -4093,7 +4093,7 @@ def get_pay_run_calendar( _preload_content=True, _request_timeout=None, ): - """retrieve a single payrun calendar by id # noqa: E501 + """Retrieves a specific payrun calendar by using a unique payrun calendar ID # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str pay_run_calendar_id: Identifier for the payrun calendars (required) @@ -4169,7 +4169,7 @@ def get_pay_run_calendars( _preload_content=True, _request_timeout=None, ): - """searches payrun calendars # noqa: E501 + """Retrieves payrun calendars # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -4241,7 +4241,7 @@ def get_pay_runs( _preload_content=True, _request_timeout=None, ): - """searches pay runs # noqa: E501 + """Retrieves pay runs # noqa: E501 OAuth2 scope: payroll.payruns.read, payroll.payruns :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -4316,7 +4316,7 @@ def get_pay_slip( _preload_content=True, _request_timeout=None, ): - """retrieve a single payslip by id # noqa: E501 + """Retrieves a specific payslip by using a unique payslip ID # noqa: E501 OAuth2 scope: payroll.payslip.read, payroll.payslip :param str xero_tenant_id: Xero identifier for Tenant (required) :param str payslip_id: Identifier for the payslip (required) @@ -4393,7 +4393,7 @@ def get_pay_slips( _preload_content=True, _request_timeout=None, ): - """searches payslips # noqa: E501 + """Retrieves payslips # noqa: E501 OAuth2 scope: payroll.payslip.read, payroll.payslip :param str xero_tenant_id: Xero identifier for Tenant (required) :param str pay_run_id: PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun. (required) @@ -4473,7 +4473,7 @@ def get_reimbursement( _preload_content=True, _request_timeout=None, ): - """retrieve a single reimbursement by id # noqa: E501 + """Retrieves a specific reimbursement by using a unique reimbursement id # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str reimbursement_id: Identifier for the reimbursement (required) @@ -4549,7 +4549,7 @@ def get_reimbursements( _preload_content=True, _request_timeout=None, ): - """searches reimbursements # noqa: E501 + """Retrieves reimbursements # noqa: E501 OAuth2 scope: payroll.settings.read, payroll.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. @@ -4619,7 +4619,7 @@ def get_settings( _preload_content=True, _request_timeout=None, ): - """searches settings # noqa: E501 + """Retrieves payroll settings # noqa: E501 OAuth2 scope: payroll.settings.read, settings.payslip :param str xero_tenant_id: Xero identifier for Tenant (required) :param bool _return_http_data_only: return received data only @@ -4687,7 +4687,7 @@ def get_statutory_leave_summary( _preload_content=True, _request_timeout=None, ): - """retrieve a summary of statutory leaves for an employee # noqa: E501 + """Retrieves a specific employee's summary of statutory leaves using a unique employee ID # noqa: E501 OAuth2 scope: payroll.employees.read, payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -4713,7 +4713,7 @@ def get_statutory_leave_summary( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -4736,7 +4736,7 @@ def get_statutory_leave_summary( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/statutoryleaves/summary/{EmployeeId}") + url = self.get_resource_url("/StatutoryLeaves/Summary/{EmployeeID}") try: return self.api_client.call_api( @@ -4767,7 +4767,7 @@ def get_timesheet( _preload_content=True, _request_timeout=None, ): - """retrieve a single timesheet by id # noqa: E501 + """Retrieve a specific timesheet by using a unique timesheet ID # noqa: E501 OAuth2 scope: payroll.timesheets.read, timesheets.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) @@ -4845,11 +4845,11 @@ def get_timesheets( _preload_content=True, _request_timeout=None, ): - """searches timesheets # noqa: E501 + """Retrieves timesheets # noqa: E501 OAuth2 scope: payroll.timesheets.read, payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - :param str employee_id: By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeId} to get only the timesheets of a particular employee. + :param str employee_id: By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeID} to get only the timesheets of a particular employee. :param str payroll_calendar_id: By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models @@ -4923,7 +4923,7 @@ def get_tracking_categories( _preload_content=True, _request_timeout=None, ): - """searches tracking categories # noqa: E501 + """Retrieves tracking categories # noqa: E501 OAuth2 scope: payroll.settings.read, settings.payslip :param str xero_tenant_id: Xero identifier for Tenant (required) :param bool _return_http_data_only: return received data only @@ -4959,7 +4959,7 @@ def get_tracking_categories( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/settings/trackingCategories") + url = self.get_resource_url("/Settings/trackingCategories") try: return self.api_client.call_api( @@ -4990,7 +4990,7 @@ def revert_timesheet( _preload_content=True, _request_timeout=None, ): - """revert a timesheet to draft # noqa: E501 + """Reverts a specific timesheet to draft # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) @@ -5067,7 +5067,7 @@ def update_employee( _preload_content=True, _request_timeout=None, ): - """updates employee # noqa: E501 + """Updates a specific employee's detail # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -5099,7 +5099,7 @@ def update_employee( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -5124,7 +5124,7 @@ def update_employee( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}") + url = self.get_resource_url("/Employees/{EmployeeID}") try: return self.api_client.call_api( @@ -5157,7 +5157,7 @@ def update_employee_earnings_template( _preload_content=True, _request_timeout=None, ): - """updates employee earnings template records # noqa: E501 + """Updates a specific employee's earnings template records # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -5196,7 +5196,7 @@ def update_employee_earnings_template( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "PayTemplateEarningID": pay_template_earning_id, } @@ -5223,7 +5223,7 @@ def update_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url( - "/Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID}" + "/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}" ) try: @@ -5259,7 +5259,7 @@ def update_employee_leave( _preload_content=True, _request_timeout=None, ): - """updates employee leave records # noqa: E501 + """Updates a specific employee's leave records # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -5298,7 +5298,7 @@ def update_employee_leave( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "LeaveID": leave_id, } @@ -5324,7 +5324,7 @@ def update_employee_leave( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/Leave/{LeaveID}") + url = self.get_resource_url("/Employees/{EmployeeID}/Leave/{LeaveID}") try: return self.api_client.call_api( @@ -5356,7 +5356,7 @@ def update_employee_opening_balances( _preload_content=True, _request_timeout=None, ): - """updates employee opening balances # noqa: E501 + """Updates a specific employee's opening balances # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -5388,7 +5388,7 @@ def update_employee_opening_balances( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, } query_params = [] @@ -5413,7 +5413,7 @@ def update_employee_opening_balances( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeId}/ukopeningbalances") + url = self.get_resource_url("/Employees/{EmployeeID}/ukopeningbalances") try: return self.api_client.call_api( @@ -5448,7 +5448,7 @@ def update_employee_salary_and_wage( _preload_content=True, _request_timeout=None, ): - """updates employee salary and wages record # noqa: E501 + """Updates salary and wages record for a specific employee # noqa: E501 OAuth2 scope: payroll.employees :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) @@ -5487,7 +5487,7 @@ def update_employee_salary_and_wage( collection_formats = {} path_params = { - "EmployeeId": employee_id, + "EmployeeID": employee_id, "SalaryAndWagesID": salary_and_wages_id, } @@ -5514,7 +5514,7 @@ def update_employee_salary_and_wage( # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url( - "/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}" + "/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}" ) try: @@ -5549,7 +5549,7 @@ def update_pay_run( _preload_content=True, _request_timeout=None, ): - """update a pay run # noqa: E501 + """Updates a specific pay run # noqa: E501 OAuth2 scope: payroll.payruns :param str xero_tenant_id: Xero identifier for Tenant (required) :param str pay_run_id: Identifier for the pay run (required) @@ -5639,7 +5639,7 @@ def update_timesheet_line( _preload_content=True, _request_timeout=None, ): - """update a timesheet line # noqa: E501 + """Updates a specific timesheet line for a specific timesheet # noqa: E501 OAuth2 scope: payroll.timesheets :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Identifier for the timesheet (required) diff --git a/xero_python/payrolluk/docs/EmployeeStatutorySickLeave.md b/xero_python/payrolluk/docs/EmployeeStatutorySickLeave.md index 1b5443c0..9f346e67 100644 --- a/xero_python/payrolluk/docs/EmployeeStatutorySickLeave.md +++ b/xero_python/payrolluk/docs/EmployeeStatutorySickLeave.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **status** | **str** | the type of statutory leave | [optional] **work_pattern** | **list[str]** | The days of the work week the employee is scheduled to work at the time the leave is taken | **is_pregnancy_related** | **bool** | Whether the sick leave was pregnancy related | -**sufficient_notice** | **bool** | Whether the employee provided sufficent notice and documentation as required by the employer supporting the sick leave request | +**sufficient_notice** | **bool** | Whether the employee provided sufficient notice and documentation as required by the employer supporting the sick leave request | **is_entitled** | **bool** | Whether the leave was entitled to receive payment | [optional] **entitlement_weeks_requested** | **float** | The amount of requested time (in weeks) | [optional] **entitlement_weeks_qualified** | **float** | The amount of statutory sick leave time off (in weeks) that is available to take at the time the leave was requested | [optional] diff --git a/xero_python/payrolluk/docs/PayrollUkApi.md b/xero_python/payrolluk/docs/PayrollUkApi.md index 6dbd9b31..88f13116 100644 --- a/xero_python/payrolluk/docs/PayrollUkApi.md +++ b/xero_python/payrolluk/docs/PayrollUkApi.md @@ -4,82 +4,82 @@ All URIs are relative to *https://api.xero.com/payroll.xro/2.0* Method | HTTP request | Description ------------- | ------------- | ------------- -[**approve_timesheet**](PayrollUkApi.md#approve_timesheet) | **POST** /Timesheets/{TimesheetID}/Approve | approve a timesheet -[**create_benefit**](PayrollUkApi.md#create_benefit) | **POST** /Benefits | create a new benefit -[**create_deduction**](PayrollUkApi.md#create_deduction) | **POST** /Deductions | create a new deduction -[**create_earnings_rate**](PayrollUkApi.md#create_earnings_rate) | **POST** /EarningsRates | create a new earnings rate -[**create_employee**](PayrollUkApi.md#create_employee) | **POST** /Employees | creates employees -[**create_employee_earnings_template**](PayrollUkApi.md#create_employee_earnings_template) | **POST** /Employees/{EmployeeId}/PayTemplates/earnings | creates employee earnings template records -[**create_employee_leave**](PayrollUkApi.md#create_employee_leave) | **POST** /Employees/{EmployeeId}/Leave | creates employee leave records -[**create_employee_leave_type**](PayrollUkApi.md#create_employee_leave_type) | **POST** /Employees/{EmployeeId}/LeaveTypes | creates employee leave type records -[**create_employee_opening_balances**](PayrollUkApi.md#create_employee_opening_balances) | **POST** /Employees/{EmployeeId}/ukopeningbalances | creates employee opening balances -[**create_employee_payment_method**](PayrollUkApi.md#create_employee_payment_method) | **POST** /Employees/{EmployeeId}/PaymentMethods | creates employee payment method -[**create_employee_salary_and_wage**](PayrollUkApi.md#create_employee_salary_and_wage) | **POST** /Employees/{EmployeeId}/SalaryAndWages | creates employee salary and wage record -[**create_employee_statutory_sick_leave**](PayrollUkApi.md#create_employee_statutory_sick_leave) | **POST** /StatutoryLeaves/Sick | creates employee statutory sick leave records -[**create_employment**](PayrollUkApi.md#create_employment) | **POST** /Employees/{EmployeeId}/Employment | creates employment -[**create_leave_type**](PayrollUkApi.md#create_leave_type) | **POST** /LeaveTypes | create a new leave type -[**create_multiple_employee_earnings_template**](PayrollUkApi.md#create_multiple_employee_earnings_template) | **POST** /Employees/{EmployeeId}/paytemplateearnings | creates multiple employee earnings template records -[**create_pay_run_calendar**](PayrollUkApi.md#create_pay_run_calendar) | **POST** /PayRunCalendars | create a new payrun calendar -[**create_reimbursement**](PayrollUkApi.md#create_reimbursement) | **POST** /Reimbursements | create a new reimbursement -[**create_timesheet**](PayrollUkApi.md#create_timesheet) | **POST** /Timesheets | create a new timesheet -[**create_timesheet_line**](PayrollUkApi.md#create_timesheet_line) | **POST** /Timesheets/{TimesheetID}/Lines | create a new timesheet line -[**delete_employee_earnings_template**](PayrollUkApi.md#delete_employee_earnings_template) | **DELETE** /Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID} | deletes an employee earnings template record -[**delete_employee_leave**](PayrollUkApi.md#delete_employee_leave) | **DELETE** /Employees/{EmployeeId}/Leave/{LeaveID} | deletes an employee leave record -[**delete_employee_salary_and_wage**](PayrollUkApi.md#delete_employee_salary_and_wage) | **DELETE** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | deletes an employee salary and wages record -[**delete_timesheet**](PayrollUkApi.md#delete_timesheet) | **DELETE** /Timesheets/{TimesheetID} | delete a timesheet -[**delete_timesheet_line**](PayrollUkApi.md#delete_timesheet_line) | **DELETE** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | delete a timesheet line -[**get_benefit**](PayrollUkApi.md#get_benefit) | **GET** /Benefits/{id} | retrieve a single benefit by id -[**get_benefits**](PayrollUkApi.md#get_benefits) | **GET** /Benefits | searches benefits -[**get_deduction**](PayrollUkApi.md#get_deduction) | **GET** /Deductions/{deductionId} | retrieve a single deduction by id -[**get_deductions**](PayrollUkApi.md#get_deductions) | **GET** /Deductions | searches deductions -[**get_earnings_order**](PayrollUkApi.md#get_earnings_order) | **GET** /EarningsOrders/{id} | retrieve a single deduction by id -[**get_earnings_orders**](PayrollUkApi.md#get_earnings_orders) | **GET** /EarningsOrders | searches earnings orders -[**get_earnings_rate**](PayrollUkApi.md#get_earnings_rate) | **GET** /EarningsRates/{EarningsRateID} | retrieve a single earnings rates by id -[**get_earnings_rates**](PayrollUkApi.md#get_earnings_rates) | **GET** /EarningsRates | searches earnings rates -[**get_employee**](PayrollUkApi.md#get_employee) | **GET** /Employees/{EmployeeId} | searches employees -[**get_employee_leave**](PayrollUkApi.md#get_employee_leave) | **GET** /Employees/{EmployeeId}/Leave/{LeaveID} | retrieve a single employee leave record -[**get_employee_leave_balances**](PayrollUkApi.md#get_employee_leave_balances) | **GET** /Employees/{EmployeeId}/LeaveBalances | search employee leave balances -[**get_employee_leave_periods**](PayrollUkApi.md#get_employee_leave_periods) | **GET** /Employees/{EmployeeId}/LeavePeriods | searches employee leave periods -[**get_employee_leave_types**](PayrollUkApi.md#get_employee_leave_types) | **GET** /Employees/{EmployeeId}/LeaveTypes | searches employee leave types -[**get_employee_leaves**](PayrollUkApi.md#get_employee_leaves) | **GET** /Employees/{EmployeeId}/Leave | search employee leave records -[**get_employee_opening_balances**](PayrollUkApi.md#get_employee_opening_balances) | **GET** /Employees/{EmployeeId}/ukopeningbalances | retrieve employee openingbalances -[**get_employee_pay_template**](PayrollUkApi.md#get_employee_pay_template) | **GET** /Employees/{EmployeeId}/PayTemplates | searches employee pay templates -[**get_employee_payment_method**](PayrollUkApi.md#get_employee_payment_method) | **GET** /Employees/{EmployeeId}/PaymentMethods | retrieves an employee's payment method -[**get_employee_salary_and_wage**](PayrollUkApi.md#get_employee_salary_and_wage) | **GET** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | get employee salary and wages record by id -[**get_employee_salary_and_wages**](PayrollUkApi.md#get_employee_salary_and_wages) | **GET** /Employees/{EmployeeId}/SalaryAndWages | retrieves an employee's salary and wages -[**get_employee_statutory_leave_balances**](PayrollUkApi.md#get_employee_statutory_leave_balances) | **GET** /Employees/{EmployeeId}/StatutoryLeaveBalance | search employee leave balances -[**get_employee_statutory_sick_leave**](PayrollUkApi.md#get_employee_statutory_sick_leave) | **GET** /StatutoryLeaves/Sick/{StatutorySickLeaveID} | retrieve a statutory sick leave for an employee -[**get_employee_tax**](PayrollUkApi.md#get_employee_tax) | **GET** /Employees/{EmployeeId}/Tax | searches tax records for an employee -[**get_employees**](PayrollUkApi.md#get_employees) | **GET** /Employees | searches employees -[**get_leave_type**](PayrollUkApi.md#get_leave_type) | **GET** /LeaveTypes/{LeaveTypeID} | retrieve a single leave type by id -[**get_leave_types**](PayrollUkApi.md#get_leave_types) | **GET** /LeaveTypes | searches leave types -[**get_pay_run**](PayrollUkApi.md#get_pay_run) | **GET** /PayRuns/{PayRunID} | retrieve a single pay run by id -[**get_pay_run_calendar**](PayrollUkApi.md#get_pay_run_calendar) | **GET** /PayRunCalendars/{PayRunCalendarID} | retrieve a single payrun calendar by id -[**get_pay_run_calendars**](PayrollUkApi.md#get_pay_run_calendars) | **GET** /PayRunCalendars | searches payrun calendars -[**get_pay_runs**](PayrollUkApi.md#get_pay_runs) | **GET** /PayRuns | searches pay runs -[**get_pay_slip**](PayrollUkApi.md#get_pay_slip) | **GET** /Payslips/{PayslipID} | retrieve a single payslip by id -[**get_pay_slips**](PayrollUkApi.md#get_pay_slips) | **GET** /Payslips | searches payslips -[**get_reimbursement**](PayrollUkApi.md#get_reimbursement) | **GET** /Reimbursements/{ReimbursementID} | retrieve a single reimbursement by id -[**get_reimbursements**](PayrollUkApi.md#get_reimbursements) | **GET** /Reimbursements | searches reimbursements -[**get_settings**](PayrollUkApi.md#get_settings) | **GET** /Settings | searches settings -[**get_statutory_leave_summary**](PayrollUkApi.md#get_statutory_leave_summary) | **GET** /statutoryleaves/summary/{EmployeeId} | retrieve a summary of statutory leaves for an employee -[**get_timesheet**](PayrollUkApi.md#get_timesheet) | **GET** /Timesheets/{TimesheetID} | retrieve a single timesheet by id -[**get_timesheets**](PayrollUkApi.md#get_timesheets) | **GET** /Timesheets | searches timesheets -[**get_tracking_categories**](PayrollUkApi.md#get_tracking_categories) | **GET** /settings/trackingCategories | searches tracking categories -[**revert_timesheet**](PayrollUkApi.md#revert_timesheet) | **POST** /Timesheets/{TimesheetID}/RevertToDraft | revert a timesheet to draft -[**update_employee**](PayrollUkApi.md#update_employee) | **PUT** /Employees/{EmployeeId} | updates employee -[**update_employee_earnings_template**](PayrollUkApi.md#update_employee_earnings_template) | **PUT** /Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID} | updates employee earnings template records -[**update_employee_leave**](PayrollUkApi.md#update_employee_leave) | **PUT** /Employees/{EmployeeId}/Leave/{LeaveID} | updates employee leave records -[**update_employee_opening_balances**](PayrollUkApi.md#update_employee_opening_balances) | **PUT** /Employees/{EmployeeId}/ukopeningbalances | updates employee opening balances -[**update_employee_salary_and_wage**](PayrollUkApi.md#update_employee_salary_and_wage) | **PUT** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | updates employee salary and wages record -[**update_pay_run**](PayrollUkApi.md#update_pay_run) | **PUT** /PayRuns/{PayRunID} | update a pay run -[**update_timesheet_line**](PayrollUkApi.md#update_timesheet_line) | **PUT** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | update a timesheet line +[**approve_timesheet**](PayrollUkApi.md#approve_timesheet) | **POST** /Timesheets/{TimesheetID}/Approve | Approves a specific timesheet +[**create_benefit**](PayrollUkApi.md#create_benefit) | **POST** /Benefits | Creates a new employee benefit +[**create_deduction**](PayrollUkApi.md#create_deduction) | **POST** /Deductions | Creates a new deduction +[**create_earnings_rate**](PayrollUkApi.md#create_earnings_rate) | **POST** /EarningsRates | Creates a new earnings rate +[**create_employee**](PayrollUkApi.md#create_employee) | **POST** /Employees | Creates employees +[**create_employee_earnings_template**](PayrollUkApi.md#create_employee_earnings_template) | **POST** /Employees/{EmployeeID}/PayTemplates/earnings | Creates an earnings template records for a specific employee +[**create_employee_leave**](PayrollUkApi.md#create_employee_leave) | **POST** /Employees/{EmployeeID}/Leave | Creates leave records for a specific employee +[**create_employee_leave_type**](PayrollUkApi.md#create_employee_leave_type) | **POST** /Employees/{EmployeeID}/LeaveTypes | Creates employee leave type records +[**create_employee_opening_balances**](PayrollUkApi.md#create_employee_opening_balances) | **POST** /Employees/{EmployeeID}/ukopeningbalances | Creates an opening balance for a specific employee +[**create_employee_payment_method**](PayrollUkApi.md#create_employee_payment_method) | **POST** /Employees/{EmployeeID}/PaymentMethods | Creates an employee payment method +[**create_employee_salary_and_wage**](PayrollUkApi.md#create_employee_salary_and_wage) | **POST** /Employees/{EmployeeID}/SalaryAndWages | Creates a salary and wage record for a specific employee +[**create_employee_statutory_sick_leave**](PayrollUkApi.md#create_employee_statutory_sick_leave) | **POST** /StatutoryLeaves/Sick | Creates statutory sick leave records +[**create_employment**](PayrollUkApi.md#create_employment) | **POST** /Employees/{EmployeeID}/Employment | Creates employment detail for a specific employee using a unique employee ID +[**create_leave_type**](PayrollUkApi.md#create_leave_type) | **POST** /LeaveTypes | Creates a new leave type +[**create_multiple_employee_earnings_template**](PayrollUkApi.md#create_multiple_employee_earnings_template) | **POST** /Employees/{EmployeeID}/paytemplateearnings | Creates multiple earnings template records for a specific employee using a unique employee ID +[**create_pay_run_calendar**](PayrollUkApi.md#create_pay_run_calendar) | **POST** /PayRunCalendars | Creates a new payrun calendar +[**create_reimbursement**](PayrollUkApi.md#create_reimbursement) | **POST** /Reimbursements | Creates a new reimbursement +[**create_timesheet**](PayrollUkApi.md#create_timesheet) | **POST** /Timesheets | Creates a new timesheet +[**create_timesheet_line**](PayrollUkApi.md#create_timesheet_line) | **POST** /Timesheets/{TimesheetID}/Lines | Creates a new timesheet line for a specific timesheet using a unique timesheet ID +[**delete_employee_earnings_template**](PayrollUkApi.md#delete_employee_earnings_template) | **DELETE** /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID} | Deletes a specific employee's earnings template record +[**delete_employee_leave**](PayrollUkApi.md#delete_employee_leave) | **DELETE** /Employees/{EmployeeID}/Leave/{LeaveID} | Deletes a specific employee's leave record +[**delete_employee_salary_and_wage**](PayrollUkApi.md#delete_employee_salary_and_wage) | **DELETE** /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} | Deletes a salary and wages record for a specific employee +[**delete_timesheet**](PayrollUkApi.md#delete_timesheet) | **DELETE** /Timesheets/{TimesheetID} | Deletes a specific timesheet +[**delete_timesheet_line**](PayrollUkApi.md#delete_timesheet_line) | **DELETE** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | Deletes a specific timesheet line +[**get_benefit**](PayrollUkApi.md#get_benefit) | **GET** /Benefits/{id} | Retrieves a specific benefit by using a unique benefit ID +[**get_benefits**](PayrollUkApi.md#get_benefits) | **GET** /Benefits | Retrieves employee benefits +[**get_deduction**](PayrollUkApi.md#get_deduction) | **GET** /Deductions/{deductionId} | Retrieves a specific deduction by using a unique deduction ID +[**get_deductions**](PayrollUkApi.md#get_deductions) | **GET** /Deductions | Retrieves deductions +[**get_earnings_order**](PayrollUkApi.md#get_earnings_order) | **GET** /EarningsOrders/{id} | Retrieves a specific earnings orders by using a unique earnings orders id +[**get_earnings_orders**](PayrollUkApi.md#get_earnings_orders) | **GET** /EarningsOrders | Retrieves earnings orders +[**get_earnings_rate**](PayrollUkApi.md#get_earnings_rate) | **GET** /EarningsRates/{EarningsRateID} | Retrieves a specific earnings rates by using a unique earnings rate id +[**get_earnings_rates**](PayrollUkApi.md#get_earnings_rates) | **GET** /EarningsRates | Retrieves earnings rates +[**get_employee**](PayrollUkApi.md#get_employee) | **GET** /Employees/{EmployeeID} | Retrieves specific employees by using a unique employee ID +[**get_employee_leave**](PayrollUkApi.md#get_employee_leave) | **GET** /Employees/{EmployeeID}/Leave/{LeaveID} | Retrieves a specific employee's leave record using a unique employee ID +[**get_employee_leave_balances**](PayrollUkApi.md#get_employee_leave_balances) | **GET** /Employees/{EmployeeID}/LeaveBalances | Retrieves a specific employee's leave balances using a unique employee ID +[**get_employee_leave_periods**](PayrollUkApi.md#get_employee_leave_periods) | **GET** /Employees/{EmployeeID}/LeavePeriods | Retrieves a specific employee's leave periods using a unique employee ID +[**get_employee_leave_types**](PayrollUkApi.md#get_employee_leave_types) | **GET** /Employees/{EmployeeID}/LeaveTypes | Retrieves a specific employee's leave types using a unique employee ID +[**get_employee_leaves**](PayrollUkApi.md#get_employee_leaves) | **GET** /Employees/{EmployeeID}/Leave | Retrieves a specific employee's leave records using a unique employee ID +[**get_employee_opening_balances**](PayrollUkApi.md#get_employee_opening_balances) | **GET** /Employees/{EmployeeID}/ukopeningbalances | Retrieves a specific employee's openingbalances using a unique employee ID +[**get_employee_pay_template**](PayrollUkApi.md#get_employee_pay_template) | **GET** /Employees/{EmployeeID}/PayTemplates | Retrieves a specific employee pay templates using a unique employee ID +[**get_employee_payment_method**](PayrollUkApi.md#get_employee_payment_method) | **GET** /Employees/{EmployeeID}/PaymentMethods | Retrieves a specific employee's payment method using a unique employee ID +[**get_employee_salary_and_wage**](PayrollUkApi.md#get_employee_salary_and_wage) | **GET** /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} | Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id +[**get_employee_salary_and_wages**](PayrollUkApi.md#get_employee_salary_and_wages) | **GET** /Employees/{EmployeeID}/SalaryAndWages | Retrieves a specific employee's salary and wages by using a unique employee ID +[**get_employee_statutory_leave_balances**](PayrollUkApi.md#get_employee_statutory_leave_balances) | **GET** /Employees/{EmployeeID}/StatutoryLeaveBalance | Retrieves a specific employee's leave balances using a unique employee ID +[**get_employee_statutory_sick_leave**](PayrollUkApi.md#get_employee_statutory_sick_leave) | **GET** /StatutoryLeaves/Sick/{StatutorySickLeaveID} | Retrieves a statutory sick leave for an employee +[**get_employee_tax**](PayrollUkApi.md#get_employee_tax) | **GET** /Employees/{EmployeeID}/Tax | Retrieves tax records for a specific employee using a unique employee ID +[**get_employees**](PayrollUkApi.md#get_employees) | **GET** /Employees | Retrieves employees +[**get_leave_type**](PayrollUkApi.md#get_leave_type) | **GET** /LeaveTypes/{LeaveTypeID} | Retrieves a specific leave type by using a unique leave type ID +[**get_leave_types**](PayrollUkApi.md#get_leave_types) | **GET** /LeaveTypes | Retrieves leave types +[**get_pay_run**](PayrollUkApi.md#get_pay_run) | **GET** /PayRuns/{PayRunID} | Retrieves a specific pay run by using a unique pay run ID +[**get_pay_run_calendar**](PayrollUkApi.md#get_pay_run_calendar) | **GET** /PayRunCalendars/{PayRunCalendarID} | Retrieves a specific payrun calendar by using a unique payrun calendar ID +[**get_pay_run_calendars**](PayrollUkApi.md#get_pay_run_calendars) | **GET** /PayRunCalendars | Retrieves payrun calendars +[**get_pay_runs**](PayrollUkApi.md#get_pay_runs) | **GET** /PayRuns | Retrieves pay runs +[**get_pay_slip**](PayrollUkApi.md#get_pay_slip) | **GET** /Payslips/{PayslipID} | Retrieves a specific payslip by using a unique payslip ID +[**get_pay_slips**](PayrollUkApi.md#get_pay_slips) | **GET** /Payslips | Retrieves payslips +[**get_reimbursement**](PayrollUkApi.md#get_reimbursement) | **GET** /Reimbursements/{ReimbursementID} | Retrieves a specific reimbursement by using a unique reimbursement id +[**get_reimbursements**](PayrollUkApi.md#get_reimbursements) | **GET** /Reimbursements | Retrieves reimbursements +[**get_settings**](PayrollUkApi.md#get_settings) | **GET** /Settings | Retrieves payroll settings +[**get_statutory_leave_summary**](PayrollUkApi.md#get_statutory_leave_summary) | **GET** /StatutoryLeaves/Summary/{EmployeeID} | Retrieves a specific employee's summary of statutory leaves using a unique employee ID +[**get_timesheet**](PayrollUkApi.md#get_timesheet) | **GET** /Timesheets/{TimesheetID} | Retrieve a specific timesheet by using a unique timesheet ID +[**get_timesheets**](PayrollUkApi.md#get_timesheets) | **GET** /Timesheets | Retrieves timesheets +[**get_tracking_categories**](PayrollUkApi.md#get_tracking_categories) | **GET** /Settings/trackingCategories | Retrieves tracking categories +[**revert_timesheet**](PayrollUkApi.md#revert_timesheet) | **POST** /Timesheets/{TimesheetID}/RevertToDraft | Reverts a specific timesheet to draft +[**update_employee**](PayrollUkApi.md#update_employee) | **PUT** /Employees/{EmployeeID} | Updates a specific employee's detail +[**update_employee_earnings_template**](PayrollUkApi.md#update_employee_earnings_template) | **PUT** /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID} | Updates a specific employee's earnings template records +[**update_employee_leave**](PayrollUkApi.md#update_employee_leave) | **PUT** /Employees/{EmployeeID}/Leave/{LeaveID} | Updates a specific employee's leave records +[**update_employee_opening_balances**](PayrollUkApi.md#update_employee_opening_balances) | **PUT** /Employees/{EmployeeID}/ukopeningbalances | Updates a specific employee's opening balances +[**update_employee_salary_and_wage**](PayrollUkApi.md#update_employee_salary_and_wage) | **PUT** /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} | Updates salary and wages record for a specific employee +[**update_pay_run**](PayrollUkApi.md#update_pay_run) | **PUT** /PayRuns/{PayRunID} | Updates a specific pay run +[**update_timesheet_line**](PayrollUkApi.md#update_timesheet_line) | **PUT** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | Updates a specific timesheet line for a specific timesheet # **approve_timesheet** > TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id) -approve a timesheet +Approves a specific timesheet ### Example @@ -110,7 +110,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet try: - # approve a timesheet + # Approves a specific timesheet api_response = api_instance.approve_timesheet(xero_tenant_id, timesheet_id) pprint(api_response) except ApiException as e: @@ -142,7 +142,7 @@ Name | Type | Description | Notes # **create_benefit** > BenefitObject create_benefit(xero_tenant_id, benefit) -create a new benefit +Creates a new employee benefit ### Example @@ -173,7 +173,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant benefit = { "name": "My Big Bennie", "category": "StakeholderPension", "liabilityAccountId": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "expenseAccountId": "4b03500d-32fd-4616-8d70-e1e56e0519c6", "standardAmount": 50, "percentage": 25, "calculationType": "PercentageOfGross" } # Benefit | try: - # create a new benefit + # Creates a new employee benefit api_response = api_instance.create_benefit(xero_tenant_id, benefit) pprint(api_response) except ApiException as e: @@ -205,7 +205,7 @@ Name | Type | Description | Notes # **create_deduction** > DeductionObject create_deduction(xero_tenant_id, deduction) -create a new deduction +Creates a new deduction ### Example @@ -234,9 +234,9 @@ api_client = ApiClient( api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -deduction = { "deductionName": "My new deducation", "deductionCategory": "SalarySacrifice", "liabilityAccountId": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "calculationType": "FixedAmount" } # Deduction | +deduction = { "deductionName": "My new deduction", "deductionCategory": "SalarySacrifice", "liabilityAccountId": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "calculationType": "FixedAmount" } # Deduction | try: - # create a new deduction + # Creates a new deduction api_response = api_instance.create_deduction(xero_tenant_id, deduction) pprint(api_response) except ApiException as e: @@ -268,7 +268,7 @@ Name | Type | Description | Notes # **create_earnings_rate** > EarningsRateObject create_earnings_rate(xero_tenant_id, earnings_rate) -create a new earnings rate +Creates a new earnings rate ### Example @@ -299,7 +299,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant earnings_rate = { "name": "My Earnings Rate", "earningsType": "RegularEarnings", "rateType": "RatePerUnit", "typeOfUnits": "hours", "expenseAccountID": "4b03500d-32fd-4616-8d70-e1e56e0519c6" } # EarningsRate | try: - # create a new earnings rate + # Creates a new earnings rate api_response = api_instance.create_earnings_rate(xero_tenant_id, earnings_rate) pprint(api_response) except ApiException as e: @@ -331,7 +331,7 @@ Name | Type | Description | Notes # **create_employee** > EmployeeObject create_employee(xero_tenant_id, employee) -creates employees +Creates employees ### Example @@ -362,7 +362,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee = { "title":"Mr", "firstName":"Mike", "lastName":"Fancy", "dateOfBirth":"1999-01-01", "address":{ "addressLine1":"101 Green St", "city":"San Francisco", "postCode":"6TGR4F", "country":"UK" }, "email":"mike@starkindustries.com", "gender":"M" } # Employee | try: - # creates employees + # Creates employees api_response = api_instance.create_employee(xero_tenant_id, employee) pprint(api_response) except ApiException as e: @@ -394,7 +394,7 @@ Name | Type | Description | Notes # **create_employee_earnings_template** > EarningsTemplateObject create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) -creates employee earnings template records +Creates an earnings template records for a specific employee ### Example @@ -426,7 +426,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object earnings_template = xero_python.payrolluk.EarningsTemplate() # EarningsTemplate | try: - # creates employee earnings template records + # Creates an earnings template records for a specific employee api_response = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) pprint(api_response) except ApiException as e: @@ -459,7 +459,7 @@ Name | Type | Description | Notes # **create_employee_leave** > EmployeeLeaveObject create_employee_leave(xero_tenant_id, employee_id, employee_leave) -creates employee leave records +Creates leave records for a specific employee ### Example @@ -489,9 +489,9 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee_leave = { "leaveTypeID": "1d2778ee-86ea-45c0-bbf8-1045485f6b3f", "description": "Creating a Desription", "startDate": "2020-03-24", "endDate": "2020-03-26" } # EmployeeLeave | +employee_leave = { "leaveTypeID": "1d2778ee-86ea-45c0-bbf8-1045485f6b3f", "description": "Creating a Description", "startDate": "2020-03-24", "endDate": "2020-03-26" } # EmployeeLeave | try: - # creates employee leave records + # Creates leave records for a specific employee api_response = api_instance.create_employee_leave(xero_tenant_id, employee_id, employee_leave) pprint(api_response) except ApiException as e: @@ -524,7 +524,7 @@ Name | Type | Description | Notes # **create_employee_leave_type** > EmployeeLeaveTypeObject create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type) -creates employee leave type records +Creates employee leave type records ### Example @@ -556,7 +556,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object employee_leave_type = { "leaveTypeID": "4918f233-bd31-43f9-9633-bcc6de1178f2", "scheduleOfAccrual": "BeginningOfCalendarYear", "hoursAccruedAnnually": 10 } # EmployeeLeaveType | try: - # creates employee leave type records + # Creates employee leave type records api_response = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type) pprint(api_response) except ApiException as e: @@ -589,7 +589,7 @@ Name | Type | Description | Notes # **create_employee_opening_balances** > EmployeeOpeningBalancesObject create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances) -creates employee opening balances +Creates an opening balance for a specific employee ### Example @@ -621,7 +621,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object employee_opening_balances = { "statutoryAdoptionPay": 10, "statutoryMaternityPay": 10, "statutoryPaternityPay": 10, "statutorySharedParentalPay": 10, "statutorySickPay": 10, "priorEmployeeNumber": 10 } # EmployeeOpeningBalances | try: - # creates employee opening balances + # Creates an opening balance for a specific employee api_response = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances) pprint(api_response) except ApiException as e: @@ -654,7 +654,7 @@ Name | Type | Description | Notes # **create_employee_payment_method** > PaymentMethodObject create_employee_payment_method(xero_tenant_id, employee_id, payment_method) -creates employee payment method +Creates an employee payment method ### Example @@ -686,7 +686,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object payment_method = { "paymentMethod": "Electronically", "bankAccounts": [ { "accountName": "Sid BofA", "accountNumber": "24987654", "sortCode": "287654" } ] } # PaymentMethod | try: - # creates employee payment method + # Creates an employee payment method api_response = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, payment_method) pprint(api_response) except ApiException as e: @@ -719,7 +719,7 @@ Name | Type | Description | Notes # **create_employee_salary_and_wage** > SalaryAndWageObject create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage) -creates employee salary and wage record +Creates a salary and wage record for a specific employee ### Example @@ -751,7 +751,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object salary_and_wage = { "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnitsPerWeek": 2, "ratePerUnit": 10, "numberOfUnitsPerDay": 2, "effectiveFrom": "2020-05-01", "annualSalary": 100, "status": "ACTIVE", "paymentType": "Salary" } # SalaryAndWage | try: - # creates employee salary and wage record + # Creates a salary and wage record for a specific employee api_response = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage) pprint(api_response) except ApiException as e: @@ -784,7 +784,7 @@ Name | Type | Description | Notes # **create_employee_statutory_sick_leave** > EmployeeStatutorySickLeaveObject create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave) -creates employee statutory sick leave records +Creates statutory sick leave records ### Example @@ -815,7 +815,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_statutory_sick_leave = { "employeeID": "aad6b292-7b94-408b-93f6-e489867e3fb0", "leaveTypeID": "aab78802-e9d3-4bbd-bc87-df858054988f", "startDate": "2020-04-21", "endDate": "2020-04-24", "workPattern": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "isPregnancyRelated": false, "sufficientNotice": true } # EmployeeStatutorySickLeave | try: - # creates employee statutory sick leave records + # Creates statutory sick leave records api_response = api_instance.create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave) pprint(api_response) except ApiException as e: @@ -847,7 +847,7 @@ Name | Type | Description | Notes # **create_employment** > EmploymentObject create_employment(xero_tenant_id, employee_id, employment) -creates employment +Creates employment detail for a specific employee using a unique employee ID ### Example @@ -879,7 +879,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object employment = { "PayrollCalendarID": "216d80e6-af55-47b1-b718-9457c3f5d2fe", "StartDate": "2020-04-01", "EmployeeNumber": "123ABC", "NICategory": "A" } # Employment | try: - # creates employment + # Creates employment detail for a specific employee using a unique employee ID api_response = api_instance.create_employment(xero_tenant_id, employee_id, employment) pprint(api_response) except ApiException as e: @@ -912,7 +912,7 @@ Name | Type | Description | Notes # **create_leave_type** > LeaveTypeObject create_leave_type(xero_tenant_id, leave_type) -create a new leave type +Creates a new leave type ### Example @@ -943,7 +943,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant leave_type = { "name": "My opebvwbfxf Leave", "isPaidLeave": false, "showOnPayslip": true } # LeaveType | try: - # create a new leave type + # Creates a new leave type api_response = api_instance.create_leave_type(xero_tenant_id, leave_type) pprint(api_response) except ApiException as e: @@ -975,7 +975,7 @@ Name | Type | Description | Notes # **create_multiple_employee_earnings_template** > EmployeePayTemplates create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) -creates multiple employee earnings template records +Creates multiple earnings template records for a specific employee using a unique employee ID ### Example @@ -1007,7 +1007,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object earnings_template = [ { "ratePerUnit":20.0, "numberOfUnits":8.0, "earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27" }, { "ratePerUnit":20.0, "numberOfUnits":8.0, "earningsRateID":"973365f3-66b2-4c33-8ae6-14b75f78f68b" } ] # list[EarningsTemplate] | try: - # creates multiple employee earnings template records + # Creates multiple earnings template records for a specific employee using a unique employee ID api_response = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) pprint(api_response) except ApiException as e: @@ -1040,7 +1040,7 @@ Name | Type | Description | Notes # **create_pay_run_calendar** > PayRunCalendarObject create_pay_run_calendar(xero_tenant_id, pay_run_calendar) -create a new payrun calendar +Creates a new payrun calendar ### Example @@ -1071,7 +1071,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_run_calendar = { "name": "My Weekly Cal", "calendarType": "Weekly", "periodStartDate": "2020-05-01", "paymentDate": "2020-05-15" } # PayRunCalendar | try: - # create a new payrun calendar + # Creates a new payrun calendar api_response = api_instance.create_pay_run_calendar(xero_tenant_id, pay_run_calendar) pprint(api_response) except ApiException as e: @@ -1103,7 +1103,7 @@ Name | Type | Description | Notes # **create_reimbursement** > ReimbursementObject create_reimbursement(xero_tenant_id, reimbursement) -create a new reimbursement +Creates a new reimbursement ### Example @@ -1134,7 +1134,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant reimbursement = { "name": "My new Reimburse", "accountID": "9ee28149-32a9-4661-8eab-a28738696983" } # Reimbursement | try: - # create a new reimbursement + # Creates a new reimbursement api_response = api_instance.create_reimbursement(xero_tenant_id, reimbursement) pprint(api_response) except ApiException as e: @@ -1166,7 +1166,7 @@ Name | Type | Description | Notes # **create_timesheet** > TimesheetObject create_timesheet(xero_tenant_id, timesheet) -create a new timesheet +Creates a new timesheet ### Example @@ -1197,7 +1197,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet = { "payrollCalendarID": "216d80e6-af55-47b1-b718-9457c3f5d2fe", "employeeID": "aad6b292-7b94-408b-93f6-e489867e3fb0", "startDate": "2020-04-13", "endDate": "2020-04-19", "timesheetLines": [ { "date": "2020-04-13", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 8 }, { "date": "2020-04-15", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 6 } ] } # Timesheet | try: - # create a new timesheet + # Creates a new timesheet api_response = api_instance.create_timesheet(xero_tenant_id, timesheet) pprint(api_response) except ApiException as e: @@ -1229,7 +1229,7 @@ Name | Type | Description | Notes # **create_timesheet_line** > TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line) -create a new timesheet line +Creates a new timesheet line for a specific timesheet using a unique timesheet ID ### Example @@ -1261,7 +1261,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet timesheet_line = { "date": "2020-04-14", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 1 } # TimesheetLine | try: - # create a new timesheet line + # Creates a new timesheet line for a specific timesheet using a unique timesheet ID api_response = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line) pprint(api_response) except ApiException as e: @@ -1294,7 +1294,7 @@ Name | Type | Description | Notes # **delete_employee_earnings_template** > delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id) -deletes an employee earnings template record +Deletes a specific employee's earnings template record ### Example @@ -1326,7 +1326,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object try: - # deletes an employee earnings template record + # Deletes a specific employee's earnings template record api_instance.delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id) except ApiException as e: print("Exception when calling PayrollUkApi->delete_employee_earnings_template: %s\n" % e) @@ -1358,7 +1358,7 @@ void (empty response body) # **delete_employee_leave** > EmployeeLeaveObject delete_employee_leave(xero_tenant_id, employee_id, leave_id) -deletes an employee leave record +Deletes a specific employee's leave record ### Example @@ -1390,7 +1390,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314' # str | Leave id for single object try: - # deletes an employee leave record + # Deletes a specific employee's leave record api_response = api_instance.delete_employee_leave(xero_tenant_id, employee_id, leave_id) pprint(api_response) except ApiException as e: @@ -1423,7 +1423,7 @@ Name | Type | Description | Notes # **delete_employee_salary_and_wage** > delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) -deletes an employee salary and wages record +Deletes a salary and wages record for a specific employee ### Example @@ -1455,7 +1455,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single salary and wages object try: - # deletes an employee salary and wages record + # Deletes a salary and wages record for a specific employee api_instance.delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) except ApiException as e: print("Exception when calling PayrollUkApi->delete_employee_salary_and_wage: %s\n" % e) @@ -1487,7 +1487,7 @@ void (empty response body) # **delete_timesheet** > TimesheetLine delete_timesheet(xero_tenant_id, timesheet_id) -delete a timesheet +Deletes a specific timesheet ### Example @@ -1518,7 +1518,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet try: - # delete a timesheet + # Deletes a specific timesheet api_response = api_instance.delete_timesheet(xero_tenant_id, timesheet_id) pprint(api_response) except ApiException as e: @@ -1550,7 +1550,7 @@ Name | Type | Description | Notes # **delete_timesheet_line** > TimesheetLine delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id) -delete a timesheet line +Deletes a specific timesheet line ### Example @@ -1582,7 +1582,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet timesheet_line_id = 'timesheet_line_id_example' # str | Identifier for the timesheet line try: - # delete a timesheet line + # Deletes a specific timesheet line api_response = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id) pprint(api_response) except ApiException as e: @@ -1615,7 +1615,7 @@ Name | Type | Description | Notes # **get_benefit** > BenefitObject get_benefit(xero_tenant_id, id) -retrieve a single benefit by id +Retrieves a specific benefit by using a unique benefit ID ### Example @@ -1646,7 +1646,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant id = 'id_example' # str | Identifier for the benefit try: - # retrieve a single benefit by id + # Retrieves a specific benefit by using a unique benefit ID api_response = api_instance.get_benefit(xero_tenant_id, id) pprint(api_response) except ApiException as e: @@ -1678,7 +1678,7 @@ Name | Type | Description | Notes # **get_benefits** > Benefits get_benefits(xero_tenant_id, page=page) -searches benefits +Retrieves employee benefits ### Example @@ -1709,7 +1709,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches benefits + # Retrieves employee benefits api_response = api_instance.get_benefits(xero_tenant_id, page=page) pprint(api_response) except ApiException as e: @@ -1741,7 +1741,7 @@ Name | Type | Description | Notes # **get_deduction** > DeductionObject get_deduction(xero_tenant_id, deduction_id) -retrieve a single deduction by id +Retrieves a specific deduction by using a unique deduction ID ### Example @@ -1772,7 +1772,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant deduction_id = 'deduction_id_example' # str | Identifier for the deduction try: - # retrieve a single deduction by id + # Retrieves a specific deduction by using a unique deduction ID api_response = api_instance.get_deduction(xero_tenant_id, deduction_id) pprint(api_response) except ApiException as e: @@ -1804,7 +1804,7 @@ Name | Type | Description | Notes # **get_deductions** > Deductions get_deductions(xero_tenant_id, page=page) -searches deductions +Retrieves deductions ### Example @@ -1835,7 +1835,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches deductions + # Retrieves deductions api_response = api_instance.get_deductions(xero_tenant_id, page=page) pprint(api_response) except ApiException as e: @@ -1867,7 +1867,7 @@ Name | Type | Description | Notes # **get_earnings_order** > EarningsOrderObject get_earnings_order(xero_tenant_id, id) -retrieve a single deduction by id +Retrieves a specific earnings orders by using a unique earnings orders id ### Example @@ -1898,7 +1898,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant id = 'id_example' # str | Identifier for the deduction try: - # retrieve a single deduction by id + # Retrieves a specific earnings orders by using a unique earnings orders id api_response = api_instance.get_earnings_order(xero_tenant_id, id) pprint(api_response) except ApiException as e: @@ -1930,7 +1930,7 @@ Name | Type | Description | Notes # **get_earnings_orders** > EarningsOrders get_earnings_orders(xero_tenant_id, page=page) -searches earnings orders +Retrieves earnings orders ### Example @@ -1961,7 +1961,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches earnings orders + # Retrieves earnings orders api_response = api_instance.get_earnings_orders(xero_tenant_id, page=page) pprint(api_response) except ApiException as e: @@ -1993,7 +1993,7 @@ Name | Type | Description | Notes # **get_earnings_rate** > EarningsRateObject get_earnings_rate(xero_tenant_id, earnings_rate_id) -retrieve a single earnings rates by id +Retrieves a specific earnings rates by using a unique earnings rate id ### Example @@ -2024,7 +2024,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant earnings_rate_id = 'earnings_rate_id_example' # str | Identifier for the earnings rate try: - # retrieve a single earnings rates by id + # Retrieves a specific earnings rates by using a unique earnings rate id api_response = api_instance.get_earnings_rate(xero_tenant_id, earnings_rate_id) pprint(api_response) except ApiException as e: @@ -2056,7 +2056,7 @@ Name | Type | Description | Notes # **get_earnings_rates** > EarningsRates get_earnings_rates(xero_tenant_id, page=page) -searches earnings rates +Retrieves earnings rates ### Example @@ -2087,7 +2087,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches earnings rates + # Retrieves earnings rates api_response = api_instance.get_earnings_rates(xero_tenant_id, page=page) pprint(api_response) except ApiException as e: @@ -2119,7 +2119,7 @@ Name | Type | Description | Notes # **get_employee** > EmployeeObject get_employee(xero_tenant_id, employee_id) -searches employees +Retrieves specific employees by using a unique employee ID ### Example @@ -2150,7 +2150,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # searches employees + # Retrieves specific employees by using a unique employee ID api_response = api_instance.get_employee(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -2182,7 +2182,7 @@ Name | Type | Description | Notes # **get_employee_leave** > EmployeeLeaveObject get_employee_leave(xero_tenant_id, employee_id, leave_id) -retrieve a single employee leave record +Retrieves a specific employee's leave record using a unique employee ID ### Example @@ -2214,7 +2214,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314' # str | Leave id for single object try: - # retrieve a single employee leave record + # Retrieves a specific employee's leave record using a unique employee ID api_response = api_instance.get_employee_leave(xero_tenant_id, employee_id, leave_id) pprint(api_response) except ApiException as e: @@ -2247,7 +2247,7 @@ Name | Type | Description | Notes # **get_employee_leave_balances** > EmployeeLeaveBalances get_employee_leave_balances(xero_tenant_id, employee_id) -search employee leave balances +Retrieves a specific employee's leave balances using a unique employee ID ### Example @@ -2278,7 +2278,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # search employee leave balances + # Retrieves a specific employee's leave balances using a unique employee ID api_response = api_instance.get_employee_leave_balances(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -2310,7 +2310,7 @@ Name | Type | Description | Notes # **get_employee_leave_periods** > LeavePeriods get_employee_leave_periods(xero_tenant_id, employee_id, start_date=start_date, end_date=end_date) -searches employee leave periods +Retrieves a specific employee's leave periods using a unique employee ID ### Example @@ -2343,7 +2343,7 @@ employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for sin start_date = '2013-10-20' # date | Filter by start date (optional) end_date = 'Johnson' # date | Filter by end date (optional) try: - # searches employee leave periods + # Retrieves a specific employee's leave periods using a unique employee ID api_response = api_instance.get_employee_leave_periods(xero_tenant_id, employee_id, start_date=start_date, end_date=end_date) pprint(api_response) except ApiException as e: @@ -2377,7 +2377,7 @@ Name | Type | Description | Notes # **get_employee_leave_types** > EmployeeLeaveTypes get_employee_leave_types(xero_tenant_id, employee_id) -searches employee leave types +Retrieves a specific employee's leave types using a unique employee ID ### Example @@ -2408,7 +2408,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # searches employee leave types + # Retrieves a specific employee's leave types using a unique employee ID api_response = api_instance.get_employee_leave_types(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -2440,7 +2440,7 @@ Name | Type | Description | Notes # **get_employee_leaves** > EmployeeLeaves get_employee_leaves(xero_tenant_id, employee_id) -search employee leave records +Retrieves a specific employee's leave records using a unique employee ID ### Example @@ -2471,7 +2471,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # search employee leave records + # Retrieves a specific employee's leave records using a unique employee ID api_response = api_instance.get_employee_leaves(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -2503,7 +2503,7 @@ Name | Type | Description | Notes # **get_employee_opening_balances** > EmployeeOpeningBalancesObject get_employee_opening_balances(xero_tenant_id, employee_id) -retrieve employee openingbalances +Retrieves a specific employee's openingbalances using a unique employee ID ### Example @@ -2534,7 +2534,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # retrieve employee openingbalances + # Retrieves a specific employee's openingbalances using a unique employee ID api_response = api_instance.get_employee_opening_balances(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -2566,7 +2566,7 @@ Name | Type | Description | Notes # **get_employee_pay_template** > EmployeePayTemplateObject get_employee_pay_template(xero_tenant_id, employee_id) -searches employee pay templates +Retrieves a specific employee pay templates using a unique employee ID ### Example @@ -2597,7 +2597,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # searches employee pay templates + # Retrieves a specific employee pay templates using a unique employee ID api_response = api_instance.get_employee_pay_template(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -2629,7 +2629,7 @@ Name | Type | Description | Notes # **get_employee_payment_method** > PaymentMethodObject get_employee_payment_method(xero_tenant_id, employee_id) -retrieves an employee's payment method +Retrieves a specific employee's payment method using a unique employee ID ### Example @@ -2660,7 +2660,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # retrieves an employee's payment method + # Retrieves a specific employee's payment method using a unique employee ID api_response = api_instance.get_employee_payment_method(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -2692,7 +2692,7 @@ Name | Type | Description | Notes # **get_employee_salary_and_wage** > SalaryAndWages get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) -get employee salary and wages record by id +Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id ### Example @@ -2724,7 +2724,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object try: - # get employee salary and wages record by id + # Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id api_response = api_instance.get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) pprint(api_response) except ApiException as e: @@ -2757,7 +2757,7 @@ Name | Type | Description | Notes # **get_employee_salary_and_wages** > SalaryAndWages get_employee_salary_and_wages(xero_tenant_id, employee_id, page=page) -retrieves an employee's salary and wages +Retrieves a specific employee's salary and wages by using a unique employee ID ### Example @@ -2789,7 +2789,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # retrieves an employee's salary and wages + # Retrieves a specific employee's salary and wages by using a unique employee ID api_response = api_instance.get_employee_salary_and_wages(xero_tenant_id, employee_id, page=page) pprint(api_response) except ApiException as e: @@ -2822,7 +2822,7 @@ Name | Type | Description | Notes # **get_employee_statutory_leave_balances** > EmployeeStatutoryLeaveBalanceObject get_employee_statutory_leave_balances(xero_tenant_id, employee_id, leave_type=leave_type, as_of_date=as_of_date) -search employee leave balances +Retrieves a specific employee's leave balances using a unique employee ID ### Example @@ -2855,7 +2855,7 @@ employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for sin leave_type = 'sick' # str | Filter by the type of statutory leave (optional) as_of_date = '2013-10-20' # date | The date from which to calculate balance remaining. If not specified, current date UTC is used. (optional) try: - # search employee leave balances + # Retrieves a specific employee's leave balances using a unique employee ID api_response = api_instance.get_employee_statutory_leave_balances(xero_tenant_id, employee_id, leave_type=leave_type, as_of_date=as_of_date) pprint(api_response) except ApiException as e: @@ -2889,7 +2889,7 @@ Name | Type | Description | Notes # **get_employee_statutory_sick_leave** > EmployeeStatutorySickLeaveObject get_employee_statutory_sick_leave(xero_tenant_id, statutory_sick_leave_id) -retrieve a statutory sick leave for an employee +Retrieves a statutory sick leave for an employee ### Example @@ -2920,7 +2920,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant statutory_sick_leave_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Statutory sick leave id for single object try: - # retrieve a statutory sick leave for an employee + # Retrieves a statutory sick leave for an employee api_response = api_instance.get_employee_statutory_sick_leave(xero_tenant_id, statutory_sick_leave_id) pprint(api_response) except ApiException as e: @@ -2952,7 +2952,7 @@ Name | Type | Description | Notes # **get_employee_tax** > EmployeeTaxObject get_employee_tax(xero_tenant_id, employee_id) -searches tax records for an employee +Retrieves tax records for a specific employee using a unique employee ID ### Example @@ -2983,7 +2983,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object try: - # searches tax records for an employee + # Retrieves tax records for a specific employee using a unique employee ID api_response = api_instance.get_employee_tax(xero_tenant_id, employee_id) pprint(api_response) except ApiException as e: @@ -3015,7 +3015,7 @@ Name | Type | Description | Notes # **get_employees** > Employees get_employees(xero_tenant_id, first_name=first_name, last_name=last_name, page=page) -searches employees +Retrieves employees ### Example @@ -3048,7 +3048,7 @@ first_name = 'John' # str | Filter by first name (optional) last_name = 'Johnson' # str | Filter by last name (optional) page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches employees + # Retrieves employees api_response = api_instance.get_employees(xero_tenant_id, first_name=first_name, last_name=last_name, page=page) pprint(api_response) except ApiException as e: @@ -3082,7 +3082,7 @@ Name | Type | Description | Notes # **get_leave_type** > LeaveTypeObject get_leave_type(xero_tenant_id, leave_type_id) -retrieve a single leave type by id +Retrieves a specific leave type by using a unique leave type ID ### Example @@ -3113,7 +3113,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant leave_type_id = 'leave_type_id_example' # str | Identifier for the leave type try: - # retrieve a single leave type by id + # Retrieves a specific leave type by using a unique leave type ID api_response = api_instance.get_leave_type(xero_tenant_id, leave_type_id) pprint(api_response) except ApiException as e: @@ -3145,7 +3145,7 @@ Name | Type | Description | Notes # **get_leave_types** > LeaveTypes get_leave_types(xero_tenant_id, page=page, active_only=active_only) -searches leave types +Retrieves leave types ### Example @@ -3177,7 +3177,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) active_only = True # bool | Filters leave types by active status. By default the API returns all leave types. (optional) try: - # searches leave types + # Retrieves leave types api_response = api_instance.get_leave_types(xero_tenant_id, page=page, active_only=active_only) pprint(api_response) except ApiException as e: @@ -3210,7 +3210,7 @@ Name | Type | Description | Notes # **get_pay_run** > PayRunObject get_pay_run(xero_tenant_id, pay_run_id) -retrieve a single pay run by id +Retrieves a specific pay run by using a unique pay run ID ### Example @@ -3241,7 +3241,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_run_id = 'pay_run_id_example' # str | Identifier for the pay run try: - # retrieve a single pay run by id + # Retrieves a specific pay run by using a unique pay run ID api_response = api_instance.get_pay_run(xero_tenant_id, pay_run_id) pprint(api_response) except ApiException as e: @@ -3273,7 +3273,7 @@ Name | Type | Description | Notes # **get_pay_run_calendar** > PayRunCalendarObject get_pay_run_calendar(xero_tenant_id, pay_run_calendar_id) -retrieve a single payrun calendar by id +Retrieves a specific payrun calendar by using a unique payrun calendar ID ### Example @@ -3304,7 +3304,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_run_calendar_id = 'pay_run_calendar_id_example' # str | Identifier for the payrun calendars try: - # retrieve a single payrun calendar by id + # Retrieves a specific payrun calendar by using a unique payrun calendar ID api_response = api_instance.get_pay_run_calendar(xero_tenant_id, pay_run_calendar_id) pprint(api_response) except ApiException as e: @@ -3336,7 +3336,7 @@ Name | Type | Description | Notes # **get_pay_run_calendars** > PayRunCalendars get_pay_run_calendars(xero_tenant_id, page=page) -searches payrun calendars +Retrieves payrun calendars ### Example @@ -3367,7 +3367,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches payrun calendars + # Retrieves payrun calendars api_response = api_instance.get_pay_run_calendars(xero_tenant_id, page=page) pprint(api_response) except ApiException as e: @@ -3399,7 +3399,7 @@ Name | Type | Description | Notes # **get_pay_runs** > PayRuns get_pay_runs(xero_tenant_id, page=page, status=status) -searches pay runs +Retrieves pay runs ### Example @@ -3431,7 +3431,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) status = 'status_example' # str | By default get payruns will return all the payruns for an organization. You can add GET https://api.xero.com/payroll.xro/2.0/payRuns?statu={PayRunStatus} to filter the payruns by status. (optional) try: - # searches pay runs + # Retrieves pay runs api_response = api_instance.get_pay_runs(xero_tenant_id, page=page, status=status) pprint(api_response) except ApiException as e: @@ -3464,7 +3464,7 @@ Name | Type | Description | Notes # **get_pay_slip** > PayslipObject get_pay_slip(xero_tenant_id, payslip_id) -retrieve a single payslip by id +Retrieves a specific payslip by using a unique payslip ID ### Example @@ -3495,7 +3495,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant payslip_id = 'payslip_id_example' # str | Identifier for the payslip try: - # retrieve a single payslip by id + # Retrieves a specific payslip by using a unique payslip ID api_response = api_instance.get_pay_slip(xero_tenant_id, payslip_id) pprint(api_response) except ApiException as e: @@ -3527,7 +3527,7 @@ Name | Type | Description | Notes # **get_pay_slips** > Payslips get_pay_slips(xero_tenant_id, pay_run_id, page=page) -searches payslips +Retrieves payslips ### Example @@ -3559,7 +3559,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_run_id = 'pay_run_id_example' # str | PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun. page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches payslips + # Retrieves payslips api_response = api_instance.get_pay_slips(xero_tenant_id, pay_run_id, page=page) pprint(api_response) except ApiException as e: @@ -3592,7 +3592,7 @@ Name | Type | Description | Notes # **get_reimbursement** > ReimbursementObject get_reimbursement(xero_tenant_id, reimbursement_id) -retrieve a single reimbursement by id +Retrieves a specific reimbursement by using a unique reimbursement id ### Example @@ -3623,7 +3623,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant reimbursement_id = 'reimbursement_id_example' # str | Identifier for the reimbursement try: - # retrieve a single reimbursement by id + # Retrieves a specific reimbursement by using a unique reimbursement id api_response = api_instance.get_reimbursement(xero_tenant_id, reimbursement_id) pprint(api_response) except ApiException as e: @@ -3655,7 +3655,7 @@ Name | Type | Description | Notes # **get_reimbursements** > Reimbursements get_reimbursements(xero_tenant_id, page=page) -searches reimbursements +Retrieves reimbursements ### Example @@ -3686,7 +3686,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) try: - # searches reimbursements + # Retrieves reimbursements api_response = api_instance.get_reimbursements(xero_tenant_id, page=page) pprint(api_response) except ApiException as e: @@ -3718,7 +3718,7 @@ Name | Type | Description | Notes # **get_settings** > Settings get_settings(xero_tenant_id) -searches settings +Retrieves payroll settings ### Example @@ -3748,7 +3748,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant try: - # searches settings + # Retrieves payroll settings api_response = api_instance.get_settings(xero_tenant_id) pprint(api_response) except ApiException as e: @@ -3779,7 +3779,7 @@ Name | Type | Description | Notes # **get_statutory_leave_summary** > EmployeeStatutoryLeavesSummaries get_statutory_leave_summary(xero_tenant_id, employee_id, active_only=active_only) -retrieve a summary of statutory leaves for an employee +Retrieves a specific employee's summary of statutory leaves using a unique employee ID ### Example @@ -3811,7 +3811,7 @@ 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 active_only = True # bool | Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future scheduled) are returned (optional) try: - # retrieve a summary of statutory leaves for an employee + # Retrieves a specific employee's summary of statutory leaves using a unique employee ID api_response = api_instance.get_statutory_leave_summary(xero_tenant_id, employee_id, active_only=active_only) pprint(api_response) except ApiException as e: @@ -3844,7 +3844,7 @@ Name | Type | Description | Notes # **get_timesheet** > TimesheetObject get_timesheet(xero_tenant_id, timesheet_id) -retrieve a single timesheet by id +Retrieve a specific timesheet by using a unique timesheet ID ### Example @@ -3875,7 +3875,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet try: - # retrieve a single timesheet by id + # Retrieve a specific timesheet by using a unique timesheet ID api_response = api_instance.get_timesheet(xero_tenant_id, timesheet_id) pprint(api_response) except ApiException as e: @@ -3907,7 +3907,7 @@ Name | Type | Description | Notes # **get_timesheets** > Timesheets get_timesheets(xero_tenant_id, page=page, employee_id=employee_id, payroll_calendar_id=payroll_calendar_id) -searches timesheets +Retrieves timesheets ### Example @@ -3937,10 +3937,10 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) -employee_id = 'employee_id_example' # str | By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeId} to get only the timesheets of a particular employee. (optional) +employee_id = 'employee_id_example' # str | By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeID} to get only the timesheets of a particular employee. (optional) payroll_calendar_id = 'payroll_calendar_id_example' # str | By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id (optional) try: - # searches timesheets + # Retrieves timesheets api_response = api_instance.get_timesheets(xero_tenant_id, page=page, employee_id=employee_id, payroll_calendar_id=payroll_calendar_id) pprint(api_response) except ApiException as e: @@ -3953,7 +3953,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] - **employee_id** | [**str**](.md)| By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeId} to get only the timesheets of a particular employee. | [optional] + **employee_id** | [**str**](.md)| By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeID} to get only the timesheets of a particular employee. | [optional] **payroll_calendar_id** | [**str**](.md)| By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id | [optional] ### Return type @@ -3974,7 +3974,7 @@ Name | Type | Description | Notes # **get_tracking_categories** > TrackingCategories get_tracking_categories(xero_tenant_id) -searches tracking categories +Retrieves tracking categories ### Example @@ -4004,7 +4004,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant try: - # searches tracking categories + # Retrieves tracking categories api_response = api_instance.get_tracking_categories(xero_tenant_id) pprint(api_response) except ApiException as e: @@ -4035,7 +4035,7 @@ Name | Type | Description | Notes # **revert_timesheet** > TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id) -revert a timesheet to draft +Reverts a specific timesheet to draft ### Example @@ -4066,7 +4066,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet try: - # revert a timesheet to draft + # Reverts a specific timesheet to draft api_response = api_instance.revert_timesheet(xero_tenant_id, timesheet_id) pprint(api_response) except ApiException as e: @@ -4098,7 +4098,7 @@ Name | Type | Description | Notes # **update_employee** > EmployeeObject update_employee(xero_tenant_id, employee_id, employee) -updates employee +Updates a specific employee's detail ### Example @@ -4130,7 +4130,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object employee = { "title":"Mr", "firstName":"Mike", "lastName":"Johnllsbkrhwopson", "dateOfBirth":"1999-01-01", "address":{ "addressLine1":"101 Green St", "city":"San Francisco", "postCode":"6TGR4F", "country":"UK" }, "email":"84044@starkindustries.com", "gender":"M" } # Employee | try: - # updates employee + # Updates a specific employee's detail api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee) pprint(api_response) except ApiException as e: @@ -4163,7 +4163,7 @@ Name | Type | Description | Notes # **update_employee_earnings_template** > EarningsTemplateObject update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template) -updates employee earnings template records +Updates a specific employee's earnings template records ### Example @@ -4196,7 +4196,7 @@ employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for sin pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object earnings_template = { "ratePerUnit": 30, "numberOfUnits": 4, "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27" } # EarningsTemplate | try: - # updates employee earnings template records + # Updates a specific employee's earnings template records api_response = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template) pprint(api_response) except ApiException as e: @@ -4230,7 +4230,7 @@ Name | Type | Description | Notes # **update_employee_leave** > EmployeeLeaveObject update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave) -updates employee leave records +Updates a specific employee's leave records ### Example @@ -4263,7 +4263,7 @@ employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for sin leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314' # str | Leave id for single object employee_leave = { "leaveTypeID": "ed08dffe-788e-4b24-9630-f0fa2f4d164c", "description": "Creating a Description", "startDate": "2020-04-24", "endDate": "2020-04-26", "periods": [ { "periodStartDate": "2020-04-20", "periodEndDate": "2020-04-26", "numberOfUnits": 1, "periodStatus": "Approved" } ] } # EmployeeLeave | try: - # updates employee leave records + # Updates a specific employee's leave records api_response = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave) pprint(api_response) except ApiException as e: @@ -4297,7 +4297,7 @@ Name | Type | Description | Notes # **update_employee_opening_balances** > EmployeeOpeningBalancesObject update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances) -updates employee opening balances +Updates a specific employee's opening balances ### Example @@ -4329,7 +4329,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object employee_opening_balances = { "statutoryAdoptionPay": 20, "statutoryMaternityPay": 20, "statutoryPaternityPay": 20, "statutorySharedParentalPay": 20, "statutorySickPay": 20, "priorEmployeeNumber": 20 } # EmployeeOpeningBalances | try: - # updates employee opening balances + # Updates a specific employee's opening balances api_response = api_instance.update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances) pprint(api_response) except ApiException as e: @@ -4362,7 +4362,7 @@ Name | Type | Description | Notes # **update_employee_salary_and_wage** > SalaryAndWageObject update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage) -updates employee salary and wages record +Updates salary and wages record for a specific employee ### Example @@ -4395,7 +4395,7 @@ employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for sin salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Id for single pay template earnings object salary_and_wage = { "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnitsPerWeek": 3, "ratePerUnit": 11, "effectiveFrom": "2020-05-15", "annualSalary": 101, "status": "ACTIVE", "paymentType": "Salary" } # SalaryAndWage | try: - # updates employee salary and wages record + # Updates salary and wages record for a specific employee api_response = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage) pprint(api_response) except ApiException as e: @@ -4429,7 +4429,7 @@ Name | Type | Description | Notes # **update_pay_run** > PayRunObject update_pay_run(xero_tenant_id, pay_run_id, pay_run) -update a pay run +Updates a specific pay run ### Example @@ -4461,7 +4461,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_run_id = 'pay_run_id_example' # str | Identifier for the pay run pay_run = { "paymentDate": "2020-05-01" } # PayRun | try: - # update a pay run + # Updates a specific pay run api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run) pprint(api_response) except ApiException as e: @@ -4494,7 +4494,7 @@ Name | Type | Description | Notes # **update_timesheet_line** > TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line) -update a timesheet line +Updates a specific timesheet line for a specific timesheet ### Example @@ -4527,7 +4527,7 @@ timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet timesheet_line_id = 'timesheet_line_id_example' # str | Identifier for the timesheet line timesheet_line = { "date": "2020-04-14", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 2 } # TimesheetLine | try: - # update a timesheet line + # Updates a specific timesheet line for a specific timesheet api_response = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line) pprint(api_response) except ApiException as e: diff --git a/xero_python/payrolluk/docs/Timesheet.md b/xero_python/payrolluk/docs/Timesheet.md index 5c21ef69..ee693b86 100644 --- a/xero_python/payrolluk/docs/Timesheet.md +++ b/xero_python/payrolluk/docs/Timesheet.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **timesheet_id** | **str** | The Xero identifier for a Timesheet | [optional] -**payroll_calendar_id** | **str** | The Xero identifier for the Payroll Calandar that the Timesheet applies to | +**payroll_calendar_id** | **str** | The Xero identifier for the Payroll Calendar that the Timesheet applies to | **employee_id** | **str** | The Xero identifier for the Employee that the Timesheet is for | **start_date** | **date** | The Start Date of the Timesheet period (YYYY-MM-DD) | **end_date** | **date** | The End Date of the Timesheet period (YYYY-MM-DD) | diff --git a/xero_python/payrolluk/models/employee_statutory_sick_leave.py b/xero_python/payrolluk/models/employee_statutory_sick_leave.py index e23e726d..98306902 100644 --- a/xero_python/payrolluk/models/employee_statutory_sick_leave.py +++ b/xero_python/payrolluk/models/employee_statutory_sick_leave.py @@ -367,7 +367,7 @@ def is_pregnancy_related(self, is_pregnancy_related): def sufficient_notice(self): """Gets the sufficient_notice of this EmployeeStatutorySickLeave. # noqa: E501 - Whether the employee provided sufficent notice and documentation as required by the employer supporting the sick leave request # noqa: E501 + Whether the employee provided sufficient notice and documentation as required by the employer supporting the sick leave request # noqa: E501 :return: The sufficient_notice of this EmployeeStatutorySickLeave. # noqa: E501 :rtype: bool @@ -378,7 +378,7 @@ def sufficient_notice(self): def sufficient_notice(self, sufficient_notice): """Sets the sufficient_notice of this EmployeeStatutorySickLeave. - Whether the employee provided sufficent notice and documentation as required by the employer supporting the sick leave request # noqa: E501 + Whether the employee provided sufficient notice and documentation as required by the employer supporting the sick leave request # noqa: E501 :param sufficient_notice: The sufficient_notice of this EmployeeStatutorySickLeave. # noqa: E501 :type: bool diff --git a/xero_python/payrolluk/models/timesheet.py b/xero_python/payrolluk/models/timesheet.py index 93da4472..ae711971 100644 --- a/xero_python/payrolluk/models/timesheet.py +++ b/xero_python/payrolluk/models/timesheet.py @@ -120,7 +120,7 @@ def timesheet_id(self, timesheet_id): def payroll_calendar_id(self): """Gets the payroll_calendar_id of this Timesheet. # noqa: E501 - The Xero identifier for the Payroll Calandar that the Timesheet applies to # noqa: E501 + The Xero identifier for the Payroll Calendar that the Timesheet applies to # noqa: E501 :return: The payroll_calendar_id of this Timesheet. # noqa: E501 :rtype: str @@ -131,7 +131,7 @@ def payroll_calendar_id(self): def payroll_calendar_id(self, payroll_calendar_id): """Sets the payroll_calendar_id of this Timesheet. - The Xero identifier for the Payroll Calandar that the Timesheet applies to # noqa: E501 + The Xero identifier for the Payroll Calendar that the Timesheet applies to # noqa: E501 :param payroll_calendar_id: The payroll_calendar_id of this Timesheet. # noqa: E501 :type: str diff --git a/xero_python/project/api/project_api.py b/xero_python/project/api/project_api.py index 4bfda777..bc3a4cfd 100644 --- a/xero_python/project/api/project_api.py +++ b/xero_python/project/api/project_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.8.4 + OpenAPI spec version: 2.9.3 """ import importlib @@ -64,7 +64,7 @@ def create_project( _preload_content=True, _request_timeout=None, ): - """create one or more new projects # noqa: E501 + """Create one or more new projects # noqa: E501 OAuth2 scope: projects.create :param str xero_tenant_id: Xero identifier for Tenant (required) :param ProjectCreateOrUpdate project_create_or_update: Create a new project with ProjectCreateOrUpdate object (required) @@ -112,7 +112,7 @@ def create_project( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/projects") + url = self.get_resource_url("/Projects") try: return self.api_client.call_api( @@ -144,7 +144,7 @@ def create_time_entry( _preload_content=True, _request_timeout=None, ): - """Allows you to create a task # noqa: E501 + """Creates a time entry for a specific project # noqa: E501 OAuth2 scope: projects, projects.read Allows you to create a specific task # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) @@ -202,7 +202,7 @@ def create_time_entry( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/projects/{projectId}/time") + url = self.get_resource_url("/Projects/{projectId}/Time") try: return self.api_client.call_api( @@ -234,7 +234,7 @@ def delete_time_entry( _preload_content=True, _request_timeout=None, ): - """Allows you to delete a time entry # noqa: E501 + """Deletes a time entry for a specific project # noqa: E501 OAuth2 scope: projects, projects.read Allows you to delete a specific time entry # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) @@ -283,7 +283,7 @@ def delete_time_entry( body_params = None # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/projects/{projectId}/time/{timeEntryId}") + url = self.get_resource_url("/Projects/{projectId}/Time/{timeEntryId}") try: return self.api_client.call_api( @@ -314,9 +314,9 @@ def get_project( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a single project # noqa: E501 + """Retrieves a single project # noqa: E501 OAuth2 scope: projects, projects.read - Allows you to retrieve a specific project # noqa: E501 + Allows you to retrieve a specific project using the projectId # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str project_id: You can specify an individual project by appending the projectId to the endpoint (required) :param bool _return_http_data_only: return received data only @@ -360,7 +360,7 @@ def get_project( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/projects/{projectId}") + url = self.get_resource_url("/Projects/{projectId}") try: return self.api_client.call_api( @@ -392,7 +392,7 @@ def get_project_users( _preload_content=True, _request_timeout=None, ): - """list all project users # noqa: E501 + """Retrieves a list of all project users # noqa: E501 OAuth2 scope: projects.read Allows you to retrieve the users on a projects. # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) @@ -451,7 +451,7 @@ def get_project_users( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/projectsusers") + url = self.get_resource_url("/ProjectsUsers") try: return self.api_client.call_api( @@ -486,7 +486,7 @@ def get_projects( _preload_content=True, _request_timeout=None, ): - """list all projects # noqa: E501 + """Retrieves all projects # noqa: E501 OAuth2 scope: projects, projects.read Allows you to retrieve, create and update projects. # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) @@ -559,7 +559,7 @@ def get_projects( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/projects") + url = self.get_resource_url("/Projects") try: return self.api_client.call_api( @@ -591,12 +591,12 @@ def get_task( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a single project # noqa: E501 + """Retrieves a single project task # noqa: E501 OAuth2 scope: projects, projects.read Allows you to retrieve a specific project # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str project_id: You can specify an individual project by appending the projectId to the endpoint (required) - :param str task_id: You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskId} (required) + :param str task_id: You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskID} (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 @@ -643,7 +643,7 @@ def get_task( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/projects/{projectId}/tasks/{taskId}") + url = self.get_resource_url("/Projects/{projectId}/Tasks/{taskId}") try: return self.api_client.call_api( @@ -678,14 +678,14 @@ def get_tasks( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve a single project # noqa: E501 + """Retrieves all project tasks # noqa: E501 OAuth2 scope: projects, projects.read Allows you to retrieve a specific project # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str project_id: You can specify an individual project by appending the projectId to the endpoint (required) :param int page: Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. :param int page_size: Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. - :param str task_ids: taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskId},{taskId} + :param str task_ids: taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID} :param ChargeType charge_type: :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models @@ -740,7 +740,7 @@ def get_tasks( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/projects/{projectId}/tasks") + url = self.get_resource_url("/Projects/{projectId}/Tasks") try: return self.api_client.call_api( @@ -781,7 +781,7 @@ def get_time_entries( _preload_content=True, _request_timeout=None, ): - """Allows you to retrieve the time entries associated with a specific project # noqa: E501 + """Retrieves all time entries associated with a specific project # noqa: E501 OAuth2 scope: projects, projects.read Allows you to retrieve the time entries associated with a specific project # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) @@ -792,7 +792,7 @@ def get_time_entries( :param str contact_id: Finds all time entries for this contact identifier. :param int page: Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. :param int page_size: Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. - :param list[str] states: Comma-separated list of states to find. Will find all time entries that are in the status of whatever’s specified. + :param list[str] states: Comma-separated list of states to find. Will find all time entries that are in the status of whatever is specified. :param bool is_chargeable: Finds all time entries which relate to tasks with the charge type `TIME` or `FIXED`. :param datetime date_after_utc: ISO 8601 UTC date. Finds all time entries on or after this date filtered on the `dateUtc` field. :param datetime date_before_utc: ISO 8601 UTC date. Finds all time entries on or before this date filtered on the `dateUtc` field. @@ -869,7 +869,7 @@ def get_time_entries( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/projects/{projectId}/time") + url = self.get_resource_url("/Projects/{projectId}/Time") try: return self.api_client.call_api( @@ -901,9 +901,9 @@ def get_time_entry( _preload_content=True, _request_timeout=None, ): - """Allows you to get a single time entry in a project # noqa: E501 + """Retrieves a single time entry for a specific project # noqa: E501 OAuth2 scope: projects, projects.read - Allows you to upget a single time entry in a project # noqa: E501 + Allows you to get a single time entry in a project # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str project_id: You can specify an individual project by appending the projectId to the endpoint (required) :param str time_entry_id: You can specify an individual time entry by appending the id to the endpoint (required) @@ -955,7 +955,7 @@ def get_time_entry( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/projects/{projectId}/time/{timeEntryId}") + url = self.get_resource_url("/Projects/{projectId}/Time/{timeEntryId}") try: return self.api_client.call_api( @@ -1045,7 +1045,7 @@ def patch_project( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/projects/{projectId}") + url = self.get_resource_url("/Projects/{projectId}") try: return self.api_client.call_api( @@ -1077,7 +1077,7 @@ def update_project( _preload_content=True, _request_timeout=None, ): - """update a specific project # noqa: E501 + """Updates a specific project # noqa: E501 OAuth2 scope: projects.create Allows you to update a specific projects. # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) @@ -1135,7 +1135,7 @@ def update_project( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/projects/{projectId}") + url = self.get_resource_url("/Projects/{projectId}") try: return self.api_client.call_api( @@ -1168,7 +1168,7 @@ def update_time_entry( _preload_content=True, _request_timeout=None, ): - """Allows you to update time entry in a project # noqa: E501 + """Updates a time entry for a specific project # noqa: E501 OAuth2 scope: projects, projects.read Allows you to update time entry in a project # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) @@ -1229,7 +1229,7 @@ def update_time_entry( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/projects/{projectId}/time/{timeEntryId}") + url = self.get_resource_url("/Projects/{projectId}/Time/{timeEntryId}") try: return self.api_client.call_api( diff --git a/xero_python/project/docs/ProjectApi.md b/xero_python/project/docs/ProjectApi.md index 336d4b64..b94d98fc 100644 --- a/xero_python/project/docs/ProjectApi.md +++ b/xero_python/project/docs/ProjectApi.md @@ -4,25 +4,25 @@ All URIs are relative to *https://api.xero.com/projects.xro/2.0* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_project**](ProjectApi.md#create_project) | **POST** /projects | create one or more new projects -[**create_time_entry**](ProjectApi.md#create_time_entry) | **POST** /projects/{projectId}/time | Allows you to create a task -[**delete_time_entry**](ProjectApi.md#delete_time_entry) | **DELETE** /projects/{projectId}/time/{timeEntryId} | Allows you to delete a time entry -[**get_project**](ProjectApi.md#get_project) | **GET** /projects/{projectId} | Allows you to retrieve a single project -[**get_project_users**](ProjectApi.md#get_project_users) | **GET** /projectsusers | list all project users -[**get_projects**](ProjectApi.md#get_projects) | **GET** /projects | list all projects -[**get_task**](ProjectApi.md#get_task) | **GET** /projects/{projectId}/tasks/{taskId} | Allows you to retrieve a single project -[**get_tasks**](ProjectApi.md#get_tasks) | **GET** /projects/{projectId}/tasks | Allows you to retrieve a single project -[**get_time_entries**](ProjectApi.md#get_time_entries) | **GET** /projects/{projectId}/time | Allows you to retrieve the time entries associated with a specific project -[**get_time_entry**](ProjectApi.md#get_time_entry) | **GET** /projects/{projectId}/time/{timeEntryId} | Allows you to get a single time entry in a project -[**patch_project**](ProjectApi.md#patch_project) | **PATCH** /projects/{projectId} | creates a project for the specified contact -[**update_project**](ProjectApi.md#update_project) | **PUT** /projects/{projectId} | update a specific project -[**update_time_entry**](ProjectApi.md#update_time_entry) | **PUT** /projects/{projectId}/time/{timeEntryId} | Allows you to update time entry in a project +[**create_project**](ProjectApi.md#create_project) | **POST** /Projects | Create one or more new projects +[**create_time_entry**](ProjectApi.md#create_time_entry) | **POST** /Projects/{projectId}/Time | Creates a time entry for a specific project +[**delete_time_entry**](ProjectApi.md#delete_time_entry) | **DELETE** /Projects/{projectId}/Time/{timeEntryId} | Deletes a time entry for a specific project +[**get_project**](ProjectApi.md#get_project) | **GET** /Projects/{projectId} | Retrieves a single project +[**get_project_users**](ProjectApi.md#get_project_users) | **GET** /ProjectsUsers | Retrieves a list of all project users +[**get_projects**](ProjectApi.md#get_projects) | **GET** /Projects | Retrieves all projects +[**get_task**](ProjectApi.md#get_task) | **GET** /Projects/{projectId}/Tasks/{taskId} | Retrieves a single project task +[**get_tasks**](ProjectApi.md#get_tasks) | **GET** /Projects/{projectId}/Tasks | Retrieves all project tasks +[**get_time_entries**](ProjectApi.md#get_time_entries) | **GET** /Projects/{projectId}/Time | Retrieves all time entries associated with a specific project +[**get_time_entry**](ProjectApi.md#get_time_entry) | **GET** /Projects/{projectId}/Time/{timeEntryId} | Retrieves a single time entry for a specific project +[**patch_project**](ProjectApi.md#patch_project) | **PATCH** /Projects/{projectId} | creates a project for the specified contact +[**update_project**](ProjectApi.md#update_project) | **PUT** /Projects/{projectId} | Updates a specific project +[**update_time_entry**](ProjectApi.md#update_time_entry) | **PUT** /Projects/{projectId}/Time/{timeEntryId} | Updates a time entry for a specific project # **create_project** > Project create_project(xero_tenant_id, project_create_or_update) -create one or more new projects +Create one or more new projects ### Example @@ -53,7 +53,7 @@ api_instance = ProjectApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant project_create_or_update = { "contactId":"00000000-0000-0000-000-000000000000", "name":"New Kitchen", "deadlineUtc":"2019-12-10T12:59:59Z", "estimateAmount":"99.99" } # ProjectCreateOrUpdate | Create a new project with ProjectCreateOrUpdate object try: - # create one or more new projects + # Create one or more new projects api_response = api_instance.create_project(xero_tenant_id, project_create_or_update) pprint(api_response) except ApiException as e: @@ -85,7 +85,7 @@ Name | Type | Description | Notes # **create_time_entry** > TimeEntry create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update) -Allows you to create a task +Creates a time entry for a specific project Allows you to create a specific task @@ -119,7 +119,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant project_id = 'project_id_example' # str | You can specify an individual project by appending the projectId to the endpoint time_entry_create_or_update = { "userId":"740add2a-a703-4b8a-a670-1093919c2040", "taskId":"7be77337-feec-4458-bb1b-dbaa5a4aafce", "dateUtc":"2020-02-26T15:00:00Z", "duration":30, "description":"My description" } # TimeEntryCreateOrUpdate | The time entry object you are creating try: - # Allows you to create a task + # Creates a time entry for a specific project api_response = api_instance.create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update) pprint(api_response) except ApiException as e: @@ -152,7 +152,7 @@ Name | Type | Description | Notes # **delete_time_entry** > delete_time_entry(xero_tenant_id, project_id, time_entry_id) -Allows you to delete a time entry +Deletes a time entry for a specific project Allows you to delete a specific time entry @@ -186,7 +186,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant project_id = 'project_id_example' # str | You can specify an individual project by appending the projectId to the endpoint time_entry_id = 'time_entry_id_example' # str | You can specify an individual task by appending the id to the endpoint try: - # Allows you to delete a time entry + # Deletes a time entry for a specific project api_instance.delete_time_entry(xero_tenant_id, project_id, time_entry_id) except ApiException as e: print("Exception when calling ProjectApi->delete_time_entry: %s\n" % e) @@ -218,9 +218,9 @@ void (empty response body) # **get_project** > Project get_project(xero_tenant_id, project_id) -Allows you to retrieve a single project +Retrieves a single project -Allows you to retrieve a specific project +Allows you to retrieve a specific project using the projectId ### Example @@ -251,7 +251,7 @@ api_instance = ProjectApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant project_id = 'project_id_example' # str | You can specify an individual project by appending the projectId to the endpoint try: - # Allows you to retrieve a single project + # Retrieves a single project api_response = api_instance.get_project(xero_tenant_id, project_id) pprint(api_response) except ApiException as e: @@ -283,7 +283,7 @@ Name | Type | Description | Notes # **get_project_users** > ProjectUsers get_project_users(xero_tenant_id, page=page, page_size=page_size) -list all project users +Retrieves a list of all project users Allows you to retrieve the users on a projects. @@ -317,7 +317,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant page = 1 # int | set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. (optional) (default to 1) page_size = 50 # int | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. (optional) (default to 50) try: - # list all project users + # Retrieves a list of all project users api_response = api_instance.get_project_users(xero_tenant_id, page=page, page_size=page_size) pprint(api_response) except ApiException as e: @@ -350,7 +350,7 @@ Name | Type | Description | Notes # **get_projects** > Projects get_projects(xero_tenant_id, project_ids=project_ids, contact_id=contact_id, states=states, page=page, page_size=page_size) -list all projects +Retrieves all projects Allows you to retrieve, create and update projects. @@ -387,7 +387,7 @@ states = 'states_example' # str | Filter for projects in a particular state (INP page = 1 # int | set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. (optional) (default to 1) page_size = 50 # int | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. (optional) (default to 50) try: - # list all projects + # Retrieves all projects api_response = api_instance.get_projects(xero_tenant_id, project_ids=project_ids, contact_id=contact_id, states=states, page=page, page_size=page_size) pprint(api_response) except ApiException as e: @@ -423,7 +423,7 @@ Name | Type | Description | Notes # **get_task** > Task get_task(xero_tenant_id, project_id, task_id) -Allows you to retrieve a single project +Retrieves a single project task Allows you to retrieve a specific project @@ -455,9 +455,9 @@ api_instance = ProjectApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant project_id = 'project_id_example' # str | You can specify an individual project by appending the projectId to the endpoint -task_id = 'task_id_example' # str | You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskId} +task_id = 'task_id_example' # str | You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskID} try: - # Allows you to retrieve a single project + # Retrieves a single project task api_response = api_instance.get_task(xero_tenant_id, project_id, task_id) pprint(api_response) except ApiException as e: @@ -470,7 +470,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **project_id** | [**str**](.md)| You can specify an individual project by appending the projectId to the endpoint | - **task_id** | [**str**](.md)| You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskId} | + **task_id** | [**str**](.md)| You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskID} | ### Return type @@ -490,7 +490,7 @@ Name | Type | Description | Notes # **get_tasks** > Tasks get_tasks(xero_tenant_id, project_id, page=page, page_size=page_size, task_ids=task_ids, charge_type=charge_type) -Allows you to retrieve a single project +Retrieves all project tasks Allows you to retrieve a specific project @@ -524,10 +524,10 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant project_id = 'project_id_example' # str | You can specify an individual project by appending the projectId to the endpoint page = 1 # int | Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. (optional) page_size = 10 # int | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. (optional) -task_ids = 'task_ids_example' # str | taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskId},{taskId} (optional) +task_ids = 'task_ids_example' # str | taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID} (optional) charge_type = xero_python.project.ChargeType() # ChargeType | (optional) try: - # Allows you to retrieve a single project + # Retrieves all project tasks api_response = api_instance.get_tasks(xero_tenant_id, project_id, page=page, page_size=page_size, task_ids=task_ids, charge_type=charge_type) pprint(api_response) except ApiException as e: @@ -542,7 +542,7 @@ Name | Type | Description | Notes **project_id** | [**str**](.md)| You can specify an individual project by appending the projectId to the endpoint | **page** | **int**| Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional] **page_size** | **int**| Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. | [optional] - **task_ids** | **str**| taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskId},{taskId} | [optional] + **task_ids** | **str**| taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID} | [optional] **charge_type** | [**ChargeType**](.md)| | [optional] ### Return type @@ -563,7 +563,7 @@ Name | Type | Description | Notes # **get_time_entries** > TimeEntries get_time_entries(xero_tenant_id, project_id, user_id=user_id, task_id=task_id, invoice_id=invoice_id, contact_id=contact_id, page=page, page_size=page_size, states=states, is_chargeable=is_chargeable, date_after_utc=date_after_utc, date_before_utc=date_before_utc) -Allows you to retrieve the time entries associated with a specific project +Retrieves all time entries associated with a specific project Allows you to retrieve the time entries associated with a specific project @@ -601,12 +601,12 @@ invoice_id = 'invoice_id_example' # str | Finds all time entries for this invoic contact_id = 'contact_id_example' # str | Finds all time entries for this contact identifier. (optional) page = 1 # int | Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. (optional) page_size = 10 # int | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. (optional) -states = ['states_example'] # list[str] | Comma-separated list of states to find. Will find all time entries that are in the status of whatever’s specified. (optional) +states = ['states_example'] # list[str] | Comma-separated list of states to find. Will find all time entries that are in the status of whatever is specified. (optional) is_chargeable = True # bool | Finds all time entries which relate to tasks with the charge type `TIME` or `FIXED`. (optional) date_after_utc = '2013-10-20T19:20:30+01:00' # datetime | ISO 8601 UTC date. Finds all time entries on or after this date filtered on the `dateUtc` field. (optional) date_before_utc = '2013-10-20T19:20:30+01:00' # datetime | ISO 8601 UTC date. Finds all time entries on or before this date filtered on the `dateUtc` field. (optional) try: - # Allows you to retrieve the time entries associated with a specific project + # Retrieves all time entries associated with a specific project api_response = api_instance.get_time_entries(xero_tenant_id, project_id, user_id=user_id, task_id=task_id, invoice_id=invoice_id, contact_id=contact_id, page=page, page_size=page_size, states=states, is_chargeable=is_chargeable, date_after_utc=date_after_utc, date_before_utc=date_before_utc) pprint(api_response) except ApiException as e: @@ -625,7 +625,7 @@ Name | Type | Description | Notes **contact_id** | [**str**](.md)| Finds all time entries for this contact identifier. | [optional] **page** | **int**| Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional] **page_size** | **int**| Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. | [optional] - **states** | [**list[str]**](str.md)| Comma-separated list of states to find. Will find all time entries that are in the status of whatever’s specified. | [optional] + **states** | [**list[str]**](str.md)| Comma-separated list of states to find. Will find all time entries that are in the status of whatever is specified. | [optional] **is_chargeable** | **bool**| Finds all time entries which relate to tasks with the charge type `TIME` or `FIXED`. | [optional] **date_after_utc** | **datetime**| ISO 8601 UTC date. Finds all time entries on or after this date filtered on the `dateUtc` field. | [optional] **date_before_utc** | **datetime**| ISO 8601 UTC date. Finds all time entries on or before this date filtered on the `dateUtc` field. | [optional] @@ -648,9 +648,9 @@ Name | Type | Description | Notes # **get_time_entry** > TimeEntry get_time_entry(xero_tenant_id, project_id, time_entry_id) -Allows you to get a single time entry in a project +Retrieves a single time entry for a specific project -Allows you to upget a single time entry in a project +Allows you to get a single time entry in a project ### Example @@ -682,7 +682,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant project_id = 'project_id_example' # str | You can specify an individual project by appending the projectId to the endpoint time_entry_id = 'time_entry_id_example' # str | You can specify an individual time entry by appending the id to the endpoint try: - # Allows you to get a single time entry in a project + # Retrieves a single time entry for a specific project api_response = api_instance.get_time_entry(xero_tenant_id, project_id, time_entry_id) pprint(api_response) except ApiException as e: @@ -781,7 +781,7 @@ void (empty response body) # **update_project** > update_project(xero_tenant_id, project_id, project_create_or_update) -update a specific project +Updates a specific project Allows you to update a specific projects. @@ -815,7 +815,7 @@ xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant project_id = 'project_id_example' # str | You can specify an individual project by appending the projectId to the endpoint project_create_or_update = { "name": "New Kitchen", "deadlineUtc": "2017-04-23T18:25:43.511Z", "estimateAmount": 99.99 } # ProjectCreateOrUpdate | Request of type ProjectCreateOrUpdate try: - # update a specific project + # Updates a specific project api_instance.update_project(xero_tenant_id, project_id, project_create_or_update) except ApiException as e: print("Exception when calling ProjectApi->update_project: %s\n" % e) @@ -847,7 +847,7 @@ void (empty response body) # **update_time_entry** > update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update) -Allows you to update time entry in a project +Updates a time entry for a specific project Allows you to update time entry in a project @@ -882,7 +882,7 @@ project_id = 'project_id_example' # str | You can specify an individual project time_entry_id = 'time_entry_id_example' # str | You can specify an individual time entry by appending the id to the endpoint time_entry_create_or_update = { "userId":"740add2a-a703-4b8a-a670-1093919c2040", "taskId":"7be77337-feec-4458-bb1b-dbaa5a4aafce", "dateUtc":"2020-02-27T15:00:00Z", "duration":45, "description":"My UPDATED description" } # TimeEntryCreateOrUpdate | The time entry object you are updating try: - # Allows you to update time entry in a project + # Updates a time entry for a specific project api_instance.update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update) except ApiException as e: print("Exception when calling ProjectApi->update_time_entry: %s\n" % e) diff --git a/xero_python/rest.py b/xero_python/rest.py index 6cd82f0a..e87fe089 100644 --- a/xero_python/rest.py +++ b/xero_python/rest.py @@ -1,9 +1,9 @@ # coding: utf-8 """ - Xero oAuth 2 identity service + Xero OAuth 2 Identity Service API - This specifing endpoints related to managing authentication tokens and identity for Xero API # noqa: E501 + These endpoints are related to managing authentication tokens and identity for Xero API # noqa: E501 Contact: api@xero.com Generated by: https://openapi-generator.tech