From 4a8e21cd89a1e980caa83a6785fede282f1115c4 Mon Sep 17 00:00:00 2001 From: JesseZeng2 Date: Mon, 9 Feb 2026 15:51:54 +1300 Subject: [PATCH] EB-2551 Remove Accounting Activities finance API fix --- docs/finance/FinanceApi.md | 283 ---------- docs/finance/index.html | 764 +-------------------------- lib/xero-ruby/api/finance_api.rb | 298 ----------- spec/finance/api/finance_api_spec.rb | 53 -- 4 files changed, 1 insertion(+), 1397 deletions(-) diff --git a/docs/finance/FinanceApi.md b/docs/finance/FinanceApi.md index 26f0c978..6df670dd 100644 --- a/docs/finance/FinanceApi.md +++ b/docs/finance/FinanceApi.md @@ -4,10 +4,6 @@ All URIs are relative to *https://api.xero.com/finance.xro/1.0* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_accounting_activity_account_usage**](FinanceApi.md#get_accounting_activity_account_usage) | **GET** /AccountingActivities/AccountUsage | Get account usage -[**get_accounting_activity_lock_history**](FinanceApi.md#get_accounting_activity_lock_history) | **GET** /AccountingActivities/LockHistory | Get lock history -[**get_accounting_activity_report_history**](FinanceApi.md#get_accounting_activity_report_history) | **GET** /AccountingActivities/ReportHistory | Get report history -[**get_accounting_activity_user_activities**](FinanceApi.md#get_accounting_activity_user_activities) | **GET** /AccountingActivities/UserActivities | Get user activities [**get_bank_statement_accounting**](FinanceApi.md#get_bank_statement_accounting) | **GET** /BankStatementsPlus/statements | Get Bank Statement Accounting [**get_cash_validation**](FinanceApi.md#get_cash_validation) | **GET** /CashValidation | Get cash validation [**get_financial_statement_balance_sheet**](FinanceApi.md#get_financial_statement_balance_sheet) | **GET** /FinancialStatements/BalanceSheet | Get Balance Sheet report @@ -19,285 +15,6 @@ Method | HTTP request | Description -## get_accounting_activity_account_usage - -> AccountUsageResponse get_accounting_activity_account_usage(xero_tenant_id, opts) - -Get account usage - -A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments. - -### Example - -```ruby -# load the gem -require 'xero-ruby' - -creds = { - client_id: ENV['CLIENT_ID'], - client_secret: ENV['CLIENT_SECRET'], - redirect_uri: ENV['REDIRECT_URI'], - scopes: ENV['SCOPES'] -} -xero_client = XeroRuby::ApiClient.new(credentials: creds) - -token_set = fetch_valid_token_set(user) # example - -xero_client.refresh_token_set(token_set) - -# You need to namespace your api method call to one of the following api sets -# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api] - -api_instance = xero_client. - - - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -opts = { - start_month: '2020-09', # String | date, yyyy-MM If no parameter is provided, the month 12 months prior to the end month will be used. Account usage for up to 12 months from this date will be returned. - - end_month: '2021-09' # String | date, yyyy-MM If no parameter is provided, the current month will be used. Account usage for up to 12 months prior to this date will be returned. -} - -begin - #Get account usage - result = api_instance.get_accounting_activity_account_usage(xero_tenant_id, opts) - p result -rescue XeroRuby::Finance::ApiError => e - puts "Exception when calling FinanceApi->get_accounting_activity_account_usage: #{e}" -end -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **String**| Xero identifier for Tenant | - **start_month** | **String**| date, yyyy-MM If no parameter is provided, the month 12 months prior to the end month will be used. Account usage for up to 12 months from this date will be returned. | [optional] - **end_month** | **String**| date, yyyy-MM If no parameter is provided, the current month will be used. Account usage for up to 12 months prior to this date will be returned. | [optional] - -### Return type - -[**AccountUsageResponse**](AccountUsageResponse.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -## get_accounting_activity_lock_history - -> LockHistoryResponse get_accounting_activity_lock_history(xero_tenant_id, opts) - -Get lock history - -Provides a history of locking of accounting books. Locking may be an indicator of good accounting practices that could reduce the risk of changes to accounting records in prior periods. - -### Example - -```ruby -# load the gem -require 'xero-ruby' - -creds = { - client_id: ENV['CLIENT_ID'], - client_secret: ENV['CLIENT_SECRET'], - redirect_uri: ENV['REDIRECT_URI'], - scopes: ENV['SCOPES'] -} -xero_client = XeroRuby::ApiClient.new(credentials: creds) - -token_set = fetch_valid_token_set(user) # example - -xero_client.refresh_token_set(token_set) - -# You need to namespace your api method call to one of the following api sets -# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api] - -api_instance = xero_client. - - - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -opts = { - end_date: '2021-09-15' # String | date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a change is visible from this API. -} - -begin - #Get lock history - result = api_instance.get_accounting_activity_lock_history(xero_tenant_id, opts) - p result -rescue XeroRuby::Finance::ApiError => e - puts "Exception when calling FinanceApi->get_accounting_activity_lock_history: #{e}" -end -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **String**| Xero identifier for Tenant | - **end_date** | **String**| date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a change is visible from this API. | [optional] - -### Return type - -[**LockHistoryResponse**](LockHistoryResponse.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -## get_accounting_activity_report_history - -> ReportHistoryResponse get_accounting_activity_report_history(xero_tenant_id, opts) - -Get report history - -For a specified organisation, provides a summary of all the reports published within a given period, which may be an indicator for good business management and oversight. - -### Example - -```ruby -# load the gem -require 'xero-ruby' - -creds = { - client_id: ENV['CLIENT_ID'], - client_secret: ENV['CLIENT_SECRET'], - redirect_uri: ENV['REDIRECT_URI'], - scopes: ENV['SCOPES'] -} -xero_client = XeroRuby::ApiClient.new(credentials: creds) - -token_set = fetch_valid_token_set(user) # example - -xero_client.refresh_token_set(token_set) - -# You need to namespace your api method call to one of the following api sets -# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api] - -api_instance = xero_client. - - - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -opts = { - end_date: '2021-09-15' # String | date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any reports that were published within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a published report is visible from this API. -} - -begin - #Get report history - result = api_instance.get_accounting_activity_report_history(xero_tenant_id, opts) - p result -rescue XeroRuby::Finance::ApiError => e - puts "Exception when calling FinanceApi->get_accounting_activity_report_history: #{e}" -end -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **String**| Xero identifier for Tenant | - **end_date** | **String**| date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any reports that were published within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a published report is visible from this API. | [optional] - -### Return type - -[**ReportHistoryResponse**](ReportHistoryResponse.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -## get_accounting_activity_user_activities - -> UserActivitiesResponse get_accounting_activity_user_activities(xero_tenant_id, opts) - -Get user activities - -For a specified organisation, provides a list of all the users registered, and a history of their accounting transactions. Also identifies the existence of an external accounting advisor and the level of interaction. - -### Example - -```ruby -# load the gem -require 'xero-ruby' - -creds = { - client_id: ENV['CLIENT_ID'], - client_secret: ENV['CLIENT_SECRET'], - redirect_uri: ENV['REDIRECT_URI'], - scopes: ENV['SCOPES'] -} -xero_client = XeroRuby::ApiClient.new(credentials: creds) - -token_set = fetch_valid_token_set(user) # example - -xero_client.refresh_token_set(token_set) - -# You need to namespace your api method call to one of the following api sets -# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api] - -api_instance = xero_client. - - - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -opts = { - data_month: '2021-09' # String | date, yyyy-MM The specified month must be complete (in the past); The current month cannot be specified since it is not complete. If no parameter is provided, the month immediately previous to the current month will be used. Any user activities occurring within the specified month will be returned. Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API. -} - -begin - #Get user activities - result = api_instance.get_accounting_activity_user_activities(xero_tenant_id, opts) - p result -rescue XeroRuby::Finance::ApiError => e - puts "Exception when calling FinanceApi->get_accounting_activity_user_activities: #{e}" -end -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **String**| Xero identifier for Tenant | - **data_month** | **String**| date, yyyy-MM The specified month must be complete (in the past); The current month cannot be specified since it is not complete. If no parameter is provided, the month immediately previous to the current month will be used. Any user activities occurring within the specified month will be returned. Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API. | [optional] - -### Return type - -[**UserActivitiesResponse**](UserActivitiesResponse.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - ## get_bank_statement_accounting > BankStatementAccountingResponse get_bank_statement_accounting(xero_tenant_id, bank_account_id, from_date, to_date, opts) diff --git a/docs/finance/index.html b/docs/finance/index.html index 2e21bdb3..150f6786 100644 --- a/docs/finance/index.html +++ b/docs/finance/index.html @@ -862,104 +862,6 @@