getBudget - Retrieves a specific budgets, which includes budget lines + Retrieves a specific budget, which includes budget lines @@ -20695,9 +20715,11 @@ Usage and SDK Samples api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' budget_id = '00000000-0000-0000-0000-000000000000' + date_to = dateutil.parser.parse("2019-10-31") + date_from = dateutil.parser.parse("2019-10-31") try: - api_response = api_instance.get_budget(xero_tenant_id, budget_id) + api_response = api_instance.get_budget(xero_tenant_id, budget_id, date_to, date_from) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getBudget: %s\n" % e) @@ -20773,6 +20795,59 @@ Parameters + + + + Query parameters + + + Name + Description + + DateTo + + + + + + + + date + + + (date) + + + +Filter by start date + + + + + + + + DateFrom + + + + + + + + date + + + (date) + + + +Filter by end date + + + + + @@ -20819,11 +20894,11 @@ Usage and SDK Samples api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' ids = ["00000000-0000-0000-0000-000000000000"] - dateTo = dateutil.parser.parse("2013-10-20") - dateFrom = dateutil.parser.parse("2013-10-20") + date_to = dateutil.parser.parse("2019-10-31") + date_from = dateutil.parser.parse("2019-10-31") try: - api_response = api_instance.get_budgets(xero_tenant_id, ids, dateTo, dateFrom) + api_response = api_instance.get_budgets(xero_tenant_id, ids, date_to, date_from) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getBudgets: %s\n" % e) @@ -22265,9 +22340,10 @@ Usage and SDK Samples ids = ["00000000-0000-0000-0000-000000000000"] include_archived = 'true' summary_only = 'true' + search_term = 'searchTerm=Joe Bloggs' try: - api_response = api_instance.get_contacts(xero_tenant_id, if_modified_since, where, order, ids, page, include_archived, summary_only) + api_response = api_instance.get_contacts(xero_tenant_id, if_modified_since, where, order, ids, page, include_archived, summary_only, search_term) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getContacts: %s\n" % e) @@ -22468,6 +22544,26 @@ Parameters + + + searchTerm + + + + + + + + String + + + +Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. + + + + + @@ -26442,10 +26538,10 @@ Usage and SDK Samples api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00") - paymentsOnly = 'true' + payments_only = 'true' try: - api_response = api_instance.get_journals(xero_tenant_id, if_modified_since, offset, paymentsOnly) + api_response = api_instance.get_journals(xero_tenant_id, if_modified_since, offset, payments_only) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getJournals: %s\n" % e) @@ -30643,12 +30739,12 @@ Usage and SDK Samples xero_tenant_id = 'YOUR_XERO_TENANT_ID' if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00") status = 'SUBMITTED' - dateFrom = '2019-12-01' - dateTo = '2019-12-31' + date_from = '2019-12-01' + date_to = '2019-12-31' order = 'PurchaseOrderNumber ASC' try: - api_response = api_instance.get_purchase_orders(xero_tenant_id, if_modified_since, status, dateFrom, dateTo, order, page) + api_response = api_instance.get_purchase_orders(xero_tenant_id, if_modified_since, status, date_from, date_to, order, page) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getPurchaseOrders: %s\n" % e) @@ -31922,10 +32018,10 @@ Usage and SDK Samples api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00") - date_from = dateutil.parser.parse("2013-10-20") - date_to = dateutil.parser.parse("2013-10-20") - expiry_date_from = dateutil.parser.parse("2013-10-20") - expiry_date_to = dateutil.parser.parse("2013-10-20") + date_from = dateutil.parser.parse("2019-10-31") + date_to = dateutil.parser.parse("2019-10-31") + expiry_date_from = dateutil.parser.parse("2019-10-31") + expiry_date_to = dateutil.parser.parse("2019-10-31") contact_id = '00000000-0000-0000-0000-000000000000' status = 'DRAFT' order = 'Status ASC' @@ -34098,9 +34194,9 @@ Usage and SDK Samples api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' contact_id = '00000000-0000-0000-0000-000000000000' - date = dateutil.parser.parse("2013-10-20") - from_date = dateutil.parser.parse("2013-10-20") - to_date = dateutil.parser.parse("2013-10-20") + date = dateutil.parser.parse("2019-10-31") + from_date = dateutil.parser.parse("2019-10-31") + to_date = dateutil.parser.parse("2019-10-31") try: api_response = api_instance.get_report_aged_payables_by_contact(xero_tenant_id, contact_id, date, from_date, to_date) @@ -34294,9 +34390,9 @@ Usage and SDK Samples api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' contact_id = '00000000-0000-0000-0000-000000000000' - date = dateutil.parser.parse("2013-10-20") - from_date = dateutil.parser.parse("2013-10-20") - to_date = dateutil.parser.parse("2013-10-20") + date = dateutil.parser.parse("2019-10-31") + from_date = dateutil.parser.parse("2019-10-31") + to_date = dateutil.parser.parse("2019-10-31") try: api_response = api_instance.get_report_aged_receivables_by_contact(xero_tenant_id, contact_id, date, from_date, to_date) @@ -34490,14 +34586,14 @@ Usage and SDK Samples api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' date = dateutil.parser.parse("2019-11-01") - time_frame = 'MONTH' + timeframe = 'MONTH' tracking_option_id_1 = '00000000-0000-0000-0000-000000000000' tracking_option_id_2 = '00000000-0000-0000-0000-000000000000' standard_layout = 'true' payments_only = 'false' try: - api_response = api_instance.get_report_balance_sheet(xero_tenant_id, date, periods, time_frame, tracking_option_id_1, tracking_option_id_2, standard_layout, payments_only) + api_response = api_instance.get_report_balance_sheet(xero_tenant_id, date, periods, timeframe, tracking_option_id_1, tracking_option_id_2, standard_layout, payments_only) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getReportBalanceSheet: %s\n" % e) @@ -34735,8 +34831,8 @@ Usage and SDK Samples def accounting_get_report_bank_summary(): api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' - from_date = dateutil.parser.parse("2013-10-20") - to_date = dateutil.parser.parse("2013-10-20") + from_date = dateutil.parser.parse("2019-10-31") + to_date = dateutil.parser.parse("2019-10-31") try: api_response = api_instance.get_report_bank_summary(xero_tenant_id, from_date, to_date) @@ -34883,7 +34979,7 @@ Usage and SDK Samples date = dateutil.parser.parse("2019-03-31") try: - api_response = api_instance.get_report_budget_summary(xero_tenant_id, date, periods, time_frame) + api_response = api_instance.get_report_budget_summary(xero_tenant_id, date, periods, timeframe) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getReportBudgetSummary: %s\n" % e) @@ -35283,9 +35379,9 @@ Usage and SDK Samples def accounting_get_report_profit_and_loss(): api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' - from_date = dateutil.parser.parse("2013-10-20") - to_date = dateutil.parser.parse("2013-10-20") - time_frame = 'MONTH' + from_date = dateutil.parser.parse("2019-10-31") + to_date = dateutil.parser.parse("2019-10-31") + timeframe = 'MONTH' tracking_category_id = '00000000-0000-0000-0000-000000000000' tracking_category_id_2 = '00000000-0000-0000-0000-000000000000' tracking_option_id = '00000000-0000-0000-0000-000000000000' @@ -35294,7 +35390,7 @@ Usage and SDK Samples payments_only = 'false' try: - api_response = api_instance.get_report_profit_and_loss(xero_tenant_id, from_date, to_date, periods, time_frame, tracking_category_id, tracking_category_id_2, tracking_option_id, tracking_option_id_2, standard_layout, payments_only) + api_response = api_instance.get_report_profit_and_loss(xero_tenant_id, from_date, to_date, periods, timeframe, tracking_category_id, tracking_category_id_2, tracking_option_id, tracking_option_id_2, standard_layout, payments_only) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getReportProfitAndLoss: %s\n" % e) diff --git a/setup.py b/setup.py index 95cce61b..05834fb4 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.9.0", + version="1.10.0", ) diff --git a/xero_python/__init__.py b/xero_python/__init__.py index acbda3fd..0f4d5e56 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.9.0" +__version__ = "1.10.0" diff --git a/xero_python/accounting/api/accounting_api.py b/xero_python/accounting/api/accounting_api.py index 4c65c424..e0d1b561 100644 --- a/xero_python/accounting/api/accounting_api.py +++ b/xero_python/accounting/api/accounting_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.16.1 + OpenAPI spec version: 2.17.1 """ import importlib @@ -7559,14 +7559,18 @@ def get_budget( self, xero_tenant_id, budget_id, + date_to=empty, + date_from=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, ): - """Retrieves a specific budgets, which includes budget lines # noqa: E501 + """Retrieves a specific budget, which includes budget lines # noqa: E501 OAuth2 scope: accounting.budgets.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param str budget_id: Unique identifier for Budgets (required) + :param date date_to: Filter by start date + :param date date_from: Filter by end date :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -7593,6 +7597,12 @@ def get_budget( query_params = [] + if date_to is not empty: + query_params.append(("DateTo", date_to)) + + if date_from is not empty: + query_params.append(("DateFrom", date_from)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -8450,6 +8460,7 @@ def get_contacts( page=empty, include_archived=empty, summary_only=empty, + search_term=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -8464,6 +8475,7 @@ def get_contacts( :param int page: e.g. page=1 - Up to 100 contacts will be returned in a single API call. :param bool include_archived: e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response :param bool summary_only: Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. + :param str search_term: Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. :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 @@ -8502,6 +8514,9 @@ def get_contacts( if summary_only is not empty: query_params.append(("summaryOnly", summary_only)) + if search_term is not empty: + query_params.append(("searchTerm", search_term)) + header_params = { "xero-tenant-id": xero_tenant_id, } diff --git a/xero_python/accounting/docs/AccountingApi.md b/xero_python/accounting/docs/AccountingApi.md index dbe08668..6a3d6689 100644 --- a/xero_python/accounting/docs/AccountingApi.md +++ b/xero_python/accounting/docs/AccountingApi.md @@ -90,7 +90,7 @@ Method | HTTP request | Description [**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_budget**](AccountingApi.md#get_budget) | **GET** /Budgets/{BudgetID} | Retrieves a specific budgets, which includes budget lines +[**get_budget**](AccountingApi.md#get_budget) | **GET** /Budgets/{BudgetID} | Retrieves a specific budget, which includes budget lines [**get_budgets**](AccountingApi.md#get_budgets) | **GET** /Budgets | Retrieve a list of budgets [**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 @@ -593,7 +593,7 @@ 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-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 +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", "FromIsReconciled": true, "ToIsReconciled": true, "Reference": "Sub 098801" } ] } # BankTransfers | BankTransfers with array of BankTransfer objects in request body try: # Creates a bank transfer api_response = api_instance.create_bank_transfer(xero_tenant_id, bank_transfers) @@ -5826,9 +5826,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_budget** -> Budgets get_budget(xero_tenant_id, budget_id) +> Budgets get_budget(xero_tenant_id, budget_id, date_to=date_to, date_from=date_from) -Retrieves a specific budgets, which includes budget lines +Retrieves a specific budget, which includes budget lines ### Example @@ -5858,9 +5858,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant budget_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for Budgets +date_to = '2019-10-31' # date | Filter by start date (optional) +date_from = '2019-10-31' # date | Filter by end date (optional) try: - # Retrieves a specific budgets, which includes budget lines - api_response = api_instance.get_budget(xero_tenant_id, budget_id) + # Retrieves a specific budget, which includes budget lines + api_response = api_instance.get_budget(xero_tenant_id, budget_id, date_to=date_to, date_from=date_from) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_budget: %s\n" % e) @@ -5872,6 +5874,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **budget_id** | [**str**](.md)| Unique identifier for Budgets | + **date_to** | **date**| Filter by start date | [optional] + **date_from** | **date**| Filter by end date | [optional] ### Return type @@ -5921,8 +5925,8 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant i_ds = ['"00000000-0000-0000-0000-000000000000"'] # list[str] | Filter by BudgetID. Allows you to retrieve a specific individual budget. (optional) -date_to = '2013-10-20' # date | Filter by start date (optional) -date_from = '2013-10-20' # date | Filter by end date (optional) +date_to = '2019-10-31' # date | Filter by start date (optional) +date_from = '2019-10-31' # date | Filter by end date (optional) try: # Retrieve a list of budgets api_response = api_instance.get_budgets(xero_tenant_id, i_ds=i_ds, date_to=date_to, date_from=date_from) @@ -6533,7 +6537,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_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, summary_only=summary_only) +> 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, summary_only=summary_only, search_term=search_term) Retrieves all contacts in a Xero organisation @@ -6571,9 +6575,10 @@ i_ds = ['"00000000-0000-0000-0000-000000000000"'] # list[str] | Filter 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) summary_only = False # bool | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional) (default to False) +search_term = 'searchTerm=Joe Bloggs' # str | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. (optional) try: # 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, summary_only=summary_only) + 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, summary_only=summary_only, search_term=search_term) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_contacts: %s\n" % e) @@ -6591,6 +6596,7 @@ Name | Type | Description | Notes **page** | **int**| e.g. page=1 - Up to 100 contacts will be returned in a single API call. | [optional] **include_archived** | **bool**| e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response | [optional] **summary_only** | **bool**| Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. | [optional] [default to False] + **search_term** | **str**| Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. | [optional] ### Return type @@ -10682,10 +10688,10 @@ api_instance = AccountingApi(api_client) 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) -date_from = '2013-10-20' # date | Filter for quotes after a particular date (optional) -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) +date_from = '2019-10-31' # date | Filter for quotes after a particular date (optional) +date_to = '2019-10-31' # date | Filter for quotes before a particular date (optional) +expiry_date_from = '2019-10-31' # date | Filter for quotes expiring after a particular date (optional) +expiry_date_to = '2019-10-31' # date | Filter for quotes before a particular date (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) @@ -11545,9 +11551,9 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant 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 | filter by the from date of the report e.g. 2021-02-01 (optional) -to_date = '2013-10-20' # date | filter by the to date of the report e.g. 2021-02-28 (optional) +date = '2019-10-31' # date | The date of the Aged Payables By Contact report (optional) +from_date = '2019-10-31' # date | filter by the from date of the report e.g. 2021-02-01 (optional) +to_date = '2019-10-31' # date | filter by the to date of the report e.g. 2021-02-28 (optional) try: # 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) @@ -11614,9 +11620,9 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant 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 | filter by the from date of the report e.g. 2021-02-01 (optional) -to_date = '2013-10-20' # date | filter by the to date of the report e.g. 2021-02-28 (optional) +date = '2019-10-31' # date | The date of the Aged Receivables By Contact report (optional) +from_date = '2019-10-31' # date | filter by the from date of the report e.g. 2021-02-01 (optional) +to_date = '2019-10-31' # date | filter by the to date of the report e.g. 2021-02-28 (optional) try: # 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) @@ -11757,8 +11763,8 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -from_date = '2013-10-20' # date | filter by the from date of the report e.g. 2021-02-01 (optional) -to_date = '2013-10-20' # date | filter by the to date of the report e.g. 2021-02-28 (optional) +from_date = '2019-10-31' # date | filter by the from date of the report e.g. 2021-02-01 (optional) +to_date = '2019-10-31' # date | filter by the to date of the report e.g. 2021-02-28 (optional) try: # Retrieves report for bank summary api_response = api_instance.get_report_bank_summary(xero_tenant_id, from_date=from_date, to_date=to_date) @@ -12015,8 +12021,8 @@ api_client = ApiClient( api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -from_date = '2013-10-20' # date | filter by the from date of the report e.g. 2021-02-01 (optional) -to_date = '2013-10-20' # date | filter by the to date of the report e.g. 2021-02-28 (optional) +from_date = '2019-10-31' # date | filter by the from date of the report e.g. 2021-02-01 (optional) +to_date = '2019-10-31' # date | filter by the to date of the report e.g. 2021-02-28 (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-0000-000000000000' # str | The trackingCategory 1 for the ProfitAndLoss report (optional) diff --git a/xero_python/accounting/docs/BankTransfer.md b/xero_python/accounting/docs/BankTransfer.md index 5e7a7546..e91569c5 100644 --- a/xero_python/accounting/docs/BankTransfer.md +++ b/xero_python/accounting/docs/BankTransfer.md @@ -11,6 +11,9 @@ Name | Type | Description | Notes **currency_rate** | **float** | The currency rate | [optional] **from_bank_transaction_id** | **str** | The Bank Transaction ID for the source account | [optional] **to_bank_transaction_id** | **str** | The Bank Transaction ID for the destination account | [optional] +**from_is_reconciled** | **bool** | The Bank Transaction boolean to show if it is reconciled for the source account | [optional] [default to False] +**to_is_reconciled** | **bool** | The Bank Transaction boolean to show if it is reconciled for the destination account | [optional] [default to False] +**reference** | **str** | Reference for the transactions. | [optional] **has_attachments** | **bool** | Boolean to indicate if a Bank Transfer has an attachment | [optional] [default to False] **created_date_utc** | **datetime** | UTC timestamp of creation date of bank transfer | [optional] **validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [optional] diff --git a/xero_python/accounting/docs/BudgetBalance.md b/xero_python/accounting/docs/BudgetBalance.md index 74b082ea..42bdc971 100644 --- a/xero_python/accounting/docs/BudgetBalance.md +++ b/xero_python/accounting/docs/BudgetBalance.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **period** | **date** | Period the amount applies to (e.g. “2019-08”) | [optional] -**amount** | **int** | LineItem Quantity | [optional] -**unit_amount** | **int** | Budgeted amount | [optional] +**amount** | **float** | LineItem Quantity | [optional] +**unit_amount** | **float** | Budgeted amount | [optional] **notes** | **str** | Any footnotes associated with this balance | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/models/bank_transfer.py b/xero_python/accounting/models/bank_transfer.py index f9d8ba4e..ff1fe8e5 100644 --- a/xero_python/accounting/models/bank_transfer.py +++ b/xero_python/accounting/models/bank_transfer.py @@ -38,6 +38,9 @@ class BankTransfer(BaseModel): "currency_rate": "float", "from_bank_transaction_id": "str", "to_bank_transaction_id": "str", + "from_is_reconciled": "bool", + "to_is_reconciled": "bool", + "reference": "str", "has_attachments": "bool", "created_date_utc": "datetime[ms-format]", "validation_errors": "list[ValidationError]", @@ -52,6 +55,9 @@ class BankTransfer(BaseModel): "currency_rate": "CurrencyRate", "from_bank_transaction_id": "FromBankTransactionID", "to_bank_transaction_id": "ToBankTransactionID", + "from_is_reconciled": "FromIsReconciled", + "to_is_reconciled": "ToIsReconciled", + "reference": "Reference", "has_attachments": "HasAttachments", "created_date_utc": "CreatedDateUTC", "validation_errors": "ValidationErrors", @@ -67,6 +73,9 @@ def __init__( currency_rate=None, from_bank_transaction_id=None, to_bank_transaction_id=None, + from_is_reconciled=False, + to_is_reconciled=False, + reference=None, has_attachments=False, created_date_utc=None, validation_errors=None, @@ -81,6 +90,9 @@ def __init__( self._currency_rate = None self._from_bank_transaction_id = None self._to_bank_transaction_id = None + self._from_is_reconciled = None + self._to_is_reconciled = None + self._reference = None self._has_attachments = None self._created_date_utc = None self._validation_errors = None @@ -99,6 +111,12 @@ def __init__( self.from_bank_transaction_id = from_bank_transaction_id if to_bank_transaction_id is not None: self.to_bank_transaction_id = to_bank_transaction_id + if from_is_reconciled is not None: + self.from_is_reconciled = from_is_reconciled + if to_is_reconciled is not None: + self.to_is_reconciled = to_is_reconciled + if reference is not None: + self.reference = reference if has_attachments is not None: self.has_attachments = has_attachments if created_date_utc is not None: @@ -298,6 +316,75 @@ def to_bank_transaction_id(self, to_bank_transaction_id): self._to_bank_transaction_id = to_bank_transaction_id + @property + def from_is_reconciled(self): + """Gets the from_is_reconciled of this BankTransfer. # noqa: E501 + + The Bank Transaction boolean to show if it is reconciled for the source account # noqa: E501 + + :return: The from_is_reconciled of this BankTransfer. # noqa: E501 + :rtype: bool + """ + return self._from_is_reconciled + + @from_is_reconciled.setter + def from_is_reconciled(self, from_is_reconciled): + """Sets the from_is_reconciled of this BankTransfer. + + The Bank Transaction boolean to show if it is reconciled for the source account # noqa: E501 + + :param from_is_reconciled: The from_is_reconciled of this BankTransfer. # noqa: E501 + :type: bool + """ + + self._from_is_reconciled = from_is_reconciled + + @property + def to_is_reconciled(self): + """Gets the to_is_reconciled of this BankTransfer. # noqa: E501 + + The Bank Transaction boolean to show if it is reconciled for the destination account # noqa: E501 + + :return: The to_is_reconciled of this BankTransfer. # noqa: E501 + :rtype: bool + """ + return self._to_is_reconciled + + @to_is_reconciled.setter + def to_is_reconciled(self, to_is_reconciled): + """Sets the to_is_reconciled of this BankTransfer. + + The Bank Transaction boolean to show if it is reconciled for the destination account # noqa: E501 + + :param to_is_reconciled: The to_is_reconciled of this BankTransfer. # noqa: E501 + :type: bool + """ + + self._to_is_reconciled = to_is_reconciled + + @property + def reference(self): + """Gets the reference of this BankTransfer. # noqa: E501 + + Reference for the transactions. # noqa: E501 + + :return: The reference of this BankTransfer. # noqa: E501 + :rtype: str + """ + return self._reference + + @reference.setter + def reference(self, reference): + """Sets the reference of this BankTransfer. + + Reference for the transactions. # noqa: E501 + + :param reference: The reference of this BankTransfer. # noqa: E501 + :type: str + """ + + self._reference = reference + @property def has_attachments(self): """Gets the has_attachments of this BankTransfer. # noqa: E501 diff --git a/xero_python/accounting/models/budget_balance.py b/xero_python/accounting/models/budget_balance.py index af7b2056..e139a42b 100644 --- a/xero_python/accounting/models/budget_balance.py +++ b/xero_python/accounting/models/budget_balance.py @@ -31,8 +31,8 @@ class BudgetBalance(BaseModel): """ openapi_types = { "period": "date[ms-format]", - "amount": "int", - "unit_amount": "int", + "amount": "float", + "unit_amount": "float", "notes": "str", } @@ -93,7 +93,7 @@ def amount(self): LineItem Quantity # noqa: E501 :return: The amount of this BudgetBalance. # noqa: E501 - :rtype: int + :rtype: float """ return self._amount @@ -104,7 +104,7 @@ def amount(self, amount): LineItem Quantity # noqa: E501 :param amount: The amount of this BudgetBalance. # noqa: E501 - :type: int + :type: float """ self._amount = amount @@ -116,7 +116,7 @@ def unit_amount(self): Budgeted amount # noqa: E501 :return: The unit_amount of this BudgetBalance. # noqa: E501 - :rtype: int + :rtype: float """ return self._unit_amount @@ -127,7 +127,7 @@ def unit_amount(self, unit_amount): Budgeted amount # noqa: E501 :param unit_amount: The unit_amount of this BudgetBalance. # noqa: E501 - :type: int + :type: float """ self._unit_amount = unit_amount diff --git a/xero_python/appstore/api/app_store_api.py b/xero_python/appstore/api/app_store_api.py index 46b8c699..fc78d400 100644 --- a/xero_python/appstore/api/app_store_api.py +++ b/xero_python/appstore/api/app_store_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.16.1 + OpenAPI spec version: 2.17.1 """ import importlib diff --git a/xero_python/assets/api/asset_api.py b/xero_python/assets/api/asset_api.py index ecd83430..f1c27a71 100644 --- a/xero_python/assets/api/asset_api.py +++ b/xero_python/assets/api/asset_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.16.1 + OpenAPI spec version: 2.17.1 """ import importlib diff --git a/xero_python/docs/README.md b/xero_python/docs/README.md index bbfcf0f0..194a3445 100644 --- a/xero_python/docs/README.md +++ b/xero_python/docs/README.md @@ -3,8 +3,8 @@ These endpoints are related to managing authentication tokens and identity for X The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project: -- API version: 2.16.1 -- Package version: 1.9.0 +- API version: 2.17.1 +- Package version: 1.10.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/file/api/files_api.py b/xero_python/file/api/files_api.py index 315c2966..053849f5 100644 --- a/xero_python/file/api/files_api.py +++ b/xero_python/file/api/files_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.16.1 + OpenAPI spec version: 2.17.1 """ import importlib diff --git a/xero_python/identity/api/identity_api.py b/xero_python/identity/api/identity_api.py index 6f85fc03..6fcefe7c 100644 --- a/xero_python/identity/api/identity_api.py +++ b/xero_python/identity/api/identity_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.16.1 + OpenAPI spec version: 2.17.1 """ import importlib diff --git a/xero_python/payrollau/api/payroll_au_api.py b/xero_python/payrollau/api/payroll_au_api.py index baafb7c3..d36ccca8 100644 --- a/xero_python/payrollau/api/payroll_au_api.py +++ b/xero_python/payrollau/api/payroll_au_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.16.1 + OpenAPI spec version: 2.17.1 """ import importlib @@ -861,7 +861,7 @@ def get_leave_applications( """Retrieves leave applications # noqa: E501 OAuth2 scope: payroll.employees, payroll.employees.read :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str if_modified_since: Only records created or modified since this timestamp will be returned + :param datetime if_modified_since: Only records created or modified since this timestamp will be returned :param str where: Filter by an any element :param str order: Order by an any element :param int page: e.g. page=1 – Up to 100 objects will be returned in a single API call @@ -947,7 +947,7 @@ def get_pay_items( """Retrieves pay items # noqa: E501 OAuth2 scope: payroll.settings, payroll.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str if_modified_since: Only records created or modified since this timestamp will be returned + :param datetime if_modified_since: Only records created or modified since this timestamp will be returned :param str where: Filter by an any element :param str order: Order by an any element :param int page: e.g. page=1 – Up to 100 objects will be returned in a single API call @@ -1109,7 +1109,7 @@ def get_pay_runs( """Retrieves pay runs # noqa: E501 OAuth2 scope: payroll.payruns, payroll.payruns.read :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str if_modified_since: Only records created or modified since this timestamp will be returned + :param datetime if_modified_since: Only records created or modified since this timestamp will be returned :param str where: Filter by an any element :param str order: Order by an any element :param int page: e.g. page=1 – Up to 100 PayRuns will be returned in a single API call @@ -1271,7 +1271,7 @@ def get_payroll_calendars( """Retrieves payroll calendars # noqa: E501 OAuth2 scope: payroll.settings, payroll.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str if_modified_since: Only records created or modified since this timestamp will be returned + :param datetime if_modified_since: Only records created or modified since this timestamp will be returned :param str where: Filter by an any element :param str order: Order by an any element :param int page: e.g. page=1 – Up to 100 objects will be returned in a single API call @@ -1651,7 +1651,7 @@ def get_superfunds( """Retrieves superfunds # noqa: E501 OAuth2 scope: payroll.settings, payroll.settings.read :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str if_modified_since: Only records created or modified since this timestamp will be returned + :param datetime if_modified_since: Only records created or modified since this timestamp will be returned :param str where: Filter by an any element :param str order: Order by an any element :param int page: e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call @@ -1813,7 +1813,7 @@ def get_timesheets( """Retrieves timesheets # noqa: E501 OAuth2 scope: payroll.timesheets, payroll.timesheets.read :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str if_modified_since: Only records created or modified since this timestamp will be returned + :param datetime if_modified_since: Only records created or modified since this timestamp will be returned :param str where: Filter by an any element :param str order: Order by an any element :param int page: e.g. page=1 – Up to 100 timesheets will be returned in a single API call diff --git a/xero_python/payrollau/docs/PayrollAuApi.md b/xero_python/payrollau/docs/PayrollAuApi.md index e392752d..3b4a2dd3 100644 --- a/xero_python/payrollau/docs/PayrollAuApi.md +++ b/xero_python/payrollau/docs/PayrollAuApi.md @@ -571,7 +571,7 @@ api_client = ApiClient( api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -if_modified_since = '2013-10-20T19:20:30+01:00' # datetime | Only records created or modified since this timestamp will be returned (optional) +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==\"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) @@ -703,7 +703,7 @@ api_client = ApiClient( api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -if_modified_since = 'if_modified_since_example' # str | Only records created or modified since this timestamp will be returned (optional) +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==\"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) @@ -720,7 +720,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **if_modified_since** | **str**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **datetime**| Only records created or modified since this timestamp will be returned | [optional] **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] **page** | **int**| e.g. page=1 – Up to 100 objects will be returned in a single API call | [optional] @@ -772,7 +772,7 @@ api_client = ApiClient( api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -if_modified_since = 'if_modified_since_example' # str | Only records created or modified since this timestamp will be returned (optional) +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==\"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) @@ -789,7 +789,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **if_modified_since** | **str**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **datetime**| Only records created or modified since this timestamp will be returned | [optional] **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] **page** | **int**| e.g. page=1 – Up to 100 objects will be returned in a single API call | [optional] @@ -904,7 +904,7 @@ api_client = ApiClient( api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -if_modified_since = 'if_modified_since_example' # str | Only records created or modified since this timestamp will be returned (optional) +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==\"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) @@ -921,7 +921,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **if_modified_since** | **str**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **datetime**| Only records created or modified since this timestamp will be returned | [optional] **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] **page** | **int**| e.g. page=1 – Up to 100 PayRuns will be returned in a single API call | [optional] @@ -1036,7 +1036,7 @@ api_client = ApiClient( api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -if_modified_since = 'if_modified_since_example' # str | Only records created or modified since this timestamp will be returned (optional) +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==\"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) @@ -1053,7 +1053,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **if_modified_since** | **str**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **datetime**| Only records created or modified since this timestamp will be returned | [optional] **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] **page** | **int**| e.g. page=1 – Up to 100 objects will be returned in a single API call | [optional] @@ -1357,7 +1357,7 @@ api_client = ApiClient( api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -if_modified_since = 'if_modified_since_example' # str | Only records created or modified since this timestamp will be returned (optional) +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==\"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) @@ -1374,7 +1374,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **if_modified_since** | **str**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **datetime**| Only records created or modified since this timestamp will be returned | [optional] **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] **page** | **int**| e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call | [optional] @@ -1489,7 +1489,7 @@ api_client = ApiClient( api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -if_modified_since = 'if_modified_since_example' # str | Only records created or modified since this timestamp will be returned (optional) +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==\"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) @@ -1506,7 +1506,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **if_modified_since** | **str**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **datetime**| Only records created or modified since this timestamp will be returned | [optional] **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] **page** | **int**| e.g. page=1 – Up to 100 timesheets will be returned in a single API call | [optional] diff --git a/xero_python/payrollau/models/earnings_type.py b/xero_python/payrollau/models/earnings_type.py index c3a3ecb4..64bf9fa9 100644 --- a/xero_python/payrollau/models/earnings_type.py +++ b/xero_python/payrollau/models/earnings_type.py @@ -34,3 +34,5 @@ class EarningsType(Enum): LUMPSUMB = "LUMPSUMB" BONUSESANDCOMMISSIONS = "BONUSESANDCOMMISSIONS" LUMPSUME = "LUMPSUME" + LUMPSUMW = "LUMPSUMW" + DIRECTORSFEES = "DIRECTORSFEES" diff --git a/xero_python/payrollau/models/manual_tax_type.py b/xero_python/payrollau/models/manual_tax_type.py index 223fd338..af18735a 100644 --- a/xero_python/payrollau/models/manual_tax_type.py +++ b/xero_python/payrollau/models/manual_tax_type.py @@ -29,3 +29,4 @@ class ManualTaxType(Enum): ETPRMANUAL = "ETPRMANUAL" SCHEDULE5MANUAL = "SCHEDULE5MANUAL" SCHEDULE5STSLMANUAL = "SCHEDULE5STSLMANUAL" + SCHEDULE4MANUAL = "SCHEDULE4MANUAL" diff --git a/xero_python/payrollnz/api/payroll_nz_api.py b/xero_python/payrollnz/api/payroll_nz_api.py index 72a1402a..4b835a22 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.16.1 + OpenAPI spec version: 2.17.1 """ import importlib @@ -3332,8 +3332,7 @@ def get_employee_tax( def get_employees( self, xero_tenant_id, - first_name=empty, - last_name=empty, + filter=empty, page=empty, _return_http_data_only=True, _preload_content=True, @@ -3342,8 +3341,7 @@ def get_employees( """Retrieves employees # noqa: E501 OAuth2 scope: payroll.employees, payroll.employees.read :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str first_name: Filter by first name - :param str last_name: Filter by last name + :param str filter: Filter by first name and/or lastname :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models @@ -3363,11 +3361,8 @@ def get_employees( query_params = [] - if first_name is not empty: - query_params.append(("firstName", first_name)) - - if last_name is not empty: - query_params.append(("lastName", last_name)) + if filter is not empty: + query_params.append(("filter", filter)) if page is not empty: query_params.append(("page", page)) @@ -4605,8 +4600,11 @@ def get_timesheets( self, xero_tenant_id, page=empty, - employee_id=empty, - payroll_calendar_id=empty, + filter=empty, + status=empty, + start_date=empty, + end_date=empty, + sort=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4615,8 +4613,11 @@ def get_timesheets( OAuth2 scope: payroll.timesheets, payroll.timesheets.read :param str xero_tenant_id: Xero identifier for Tenant (required) :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - :param str employee_id: By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeID} to get only the timesheets of a particular employee. - :param str payroll_calendar_id: By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id + :param str filter: Filter by employeeId and/or payrollCalendarId + :param str status: filter results by any timesheets with a matching timesheet status + :param str start_date: filter results by any timesheets with a startDate on or after the provided date + :param str end_date: filter results by any timesheets with a endDate on or before the provided date + :param str sort: sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. :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 @@ -4638,11 +4639,20 @@ def get_timesheets( if page is not empty: query_params.append(("page", page)) - if employee_id is not empty: - query_params.append(("employeeId", employee_id)) + if filter is not empty: + query_params.append(("filter", filter)) + + if status is not empty: + query_params.append(("status", status)) + + if start_date is not empty: + query_params.append(("startDate", start_date)) + + if end_date is not empty: + query_params.append(("endDate", end_date)) - if payroll_calendar_id is not empty: - query_params.append(("payrollCalendarId", payroll_calendar_id)) + if sort is not empty: + query_params.append(("sort", sort)) header_params = { "Xero-Tenant-Id": xero_tenant_id, diff --git a/xero_python/payrollnz/docs/PayrollNZApi.md b/xero_python/payrollnz/docs/PayrollNZApi.md index 3f6f2d60..0fe0d25e 100644 --- a/xero_python/payrollnz/docs/PayrollNZApi.md +++ b/xero_python/payrollnz/docs/PayrollNZApi.md @@ -2631,7 +2631,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_employees** -> Employees get_employees(xero_tenant_id, first_name=first_name, last_name=last_name, page=page) +> Employees get_employees(xero_tenant_id, filter=filter, page=page) Retrieves employees @@ -2662,12 +2662,11 @@ api_client = ApiClient( api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -first_name = 'John' # str | Filter by first name (optional) -last_name = 'Johnson' # str | Filter by last name (optional) -page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +filter = 'firstName==John,lastName==Smith' # str | Filter by first name and/or lastname (optional) +page = 5 # 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 employees - api_response = api_instance.get_employees(xero_tenant_id, first_name=first_name, last_name=last_name, page=page) + api_response = api_instance.get_employees(xero_tenant_id, filter=filter, page=page) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->get_employees: %s\n" % e) @@ -2678,8 +2677,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | - **first_name** | **str**| Filter by first name | [optional] - **last_name** | **str**| Filter by last name | [optional] + **filter** | **str**| Filter by first name and/or lastname | [optional] **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] ### Return type @@ -3710,7 +3708,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_timesheets** -> Timesheets get_timesheets(xero_tenant_id, page=page, employee_id=employee_id, payroll_calendar_id=payroll_calendar_id) +> Timesheets get_timesheets(xero_tenant_id, page=page, filter=filter, status=status, start_date=start_date, end_date=end_date, sort=sort) Retrieves timesheets @@ -3741,12 +3739,15 @@ api_client = ApiClient( api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -page = 56 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) -employee_id = 'employee_id_example' # str | By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeID} to get only the timesheets of a particular employee. (optional) -payroll_calendar_id = 'payroll_calendar_id_example' # str | By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id (optional) +page = 5 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +filter = 'employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000' # str | Filter by employeeId and/or payrollCalendarId (optional) +status = 'Draft' # str | filter results by any timesheets with a matching timesheet status (optional) +start_date = '2019-01-02' # str | filter results by any timesheets with a startDate on or after the provided date (optional) +end_date = '2020-01-02' # str | filter results by any timesheets with a endDate on or before the provided date (optional) +sort = 'startDate' # str | sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. (optional) try: # Retrieves timesheets - api_response = api_instance.get_timesheets(xero_tenant_id, page=page, employee_id=employee_id, payroll_calendar_id=payroll_calendar_id) + api_response = api_instance.get_timesheets(xero_tenant_id, page=page, filter=filter, status=status, start_date=start_date, end_date=end_date, sort=sort) pprint(api_response) except ApiException as e: print("Exception when calling PayrollNzApi->get_timesheets: %s\n" % e) @@ -3758,8 +3759,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] - **employee_id** | [**str**](.md)| By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeID} to get only the timesheets of a particular employee. | [optional] - **payroll_calendar_id** | [**str**](.md)| By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id | [optional] + **filter** | **str**| Filter by employeeId and/or payrollCalendarId | [optional] + **status** | **str**| filter results by any timesheets with a matching timesheet status | [optional] + **start_date** | **str**| filter results by any timesheets with a startDate on or after the provided date | [optional] + **end_date** | **str**| filter results by any timesheets with a endDate on or before the provided date | [optional] + **sort** | **str**| sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. | [optional] ### Return type diff --git a/xero_python/payrolluk/api/payroll_uk_api.py b/xero_python/payrolluk/api/payroll_uk_api.py index 1cc9c1c1..c91142f7 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.16.1 + OpenAPI spec version: 2.17.1 """ import importlib @@ -4835,6 +4835,10 @@ def get_timesheets( xero_tenant_id, page=empty, filter=empty, + status=empty, + start_date=empty, + end_date=empty, + sort=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4843,7 +4847,11 @@ def get_timesheets( OAuth2 scope: payroll.timesheets, payroll.timesheets.read :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 filter: Filter by first name and/or lastname + :param str filter: Filter by employeeId and/or payrollCalendarId + :param str status: filter results by any timesheets with a matching timesheet status + :param str start_date: filter results by any timesheets with a startDate on or after the provided date + :param str end_date: filter results by any timesheets with a endDate on or before the provided date + :param str sort: sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. :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 @@ -4868,6 +4876,18 @@ def get_timesheets( if filter is not empty: query_params.append(("filter", filter)) + if status is not empty: + query_params.append(("status", status)) + + if start_date is not empty: + query_params.append(("startDate", start_date)) + + if end_date is not empty: + query_params.append(("endDate", end_date)) + + if sort is not empty: + query_params.append(("sort", sort)) + header_params = { "Xero-Tenant-Id": xero_tenant_id, } diff --git a/xero_python/payrolluk/docs/PayrollUkApi.md b/xero_python/payrolluk/docs/PayrollUkApi.md index 8829494f..2079748a 100644 --- a/xero_python/payrolluk/docs/PayrollUkApi.md +++ b/xero_python/payrolluk/docs/PayrollUkApi.md @@ -3045,7 +3045,7 @@ api_instance = PayrollUkApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant filter = 'firstName==John,lastName==Smith' # str | Filter by first name and/or lastname (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) +page = 5 # 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 employees api_response = api_instance.get_employees(xero_tenant_id, filter=filter, page=page) @@ -3903,7 +3903,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_timesheets** -> Timesheets get_timesheets(xero_tenant_id, page=page, filter=filter) +> Timesheets get_timesheets(xero_tenant_id, page=page, filter=filter, status=status, start_date=start_date, end_date=end_date, sort=sort) Retrieves timesheets @@ -3934,11 +3934,15 @@ api_client = ApiClient( 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) -filter = 'employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000' # str | Filter by first name and/or lastname (optional) +page = 5 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +filter = 'employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000' # str | Filter by employeeId and/or payrollCalendarId (optional) +status = 'Draft' # str | filter results by any timesheets with a matching timesheet status (optional) +start_date = '2019-01-02' # str | filter results by any timesheets with a startDate on or after the provided date (optional) +end_date = '2020-01-02' # str | filter results by any timesheets with a endDate on or before the provided date (optional) +sort = 'startDate' # str | sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. (optional) try: # Retrieves timesheets - api_response = api_instance.get_timesheets(xero_tenant_id, page=page, filter=filter) + api_response = api_instance.get_timesheets(xero_tenant_id, page=page, filter=filter, status=status, start_date=start_date, end_date=end_date, sort=sort) pprint(api_response) except ApiException as e: print("Exception when calling PayrollUkApi->get_timesheets: %s\n" % e) @@ -3950,7 +3954,11 @@ 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] - **filter** | **str**| Filter by first name and/or lastname | [optional] + **filter** | **str**| Filter by employeeId and/or payrollCalendarId | [optional] + **status** | **str**| filter results by any timesheets with a matching timesheet status | [optional] + **start_date** | **str**| filter results by any timesheets with a startDate on or after the provided date | [optional] + **end_date** | **str**| filter results by any timesheets with a endDate on or before the provided date | [optional] + **sort** | **str**| sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. | [optional] ### Return type diff --git a/xero_python/payrolluk/models/earnings_rate.py b/xero_python/payrolluk/models/earnings_rate.py index a2fe7fad..f88b9b81 100644 --- a/xero_python/payrolluk/models/earnings_rate.py +++ b/xero_python/payrolluk/models/earnings_rate.py @@ -193,8 +193,8 @@ def earnings_type(self, earnings_type): "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", - "Tips(Direct)", - "Tips(Non-Direct)", + "TipsNonDirect", + "TipsDirect", "TerminationPay", "None", ] # noqa: E501 diff --git a/xero_python/project/api/project_api.py b/xero_python/project/api/project_api.py index 1f85b80e..888d63aa 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.16.1 + OpenAPI spec version: 2.17.1 """ import importlib