Skip to content

Commit c8ffb1f

Browse files
yangb-xeroyangb-xero
authored
Merge pull request #355 from JesseZeng2/master
EB-2551 Remove Accounting Activities finance API
2 parents 7ce3b1e + 24c8882 commit c8ffb1f

File tree

4 files changed

+1
-1397
lines changed

4 files changed

+1
-1397
lines changed

‎docs/finance/FinanceApi.md‎

Lines changed: 0 additions & 283 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ All URIs are relative to *https://api.xero.com/finance.xro/1.0*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**get_accounting_activity_account_usage**](FinanceApi.md#get_accounting_activity_account_usage) | **GET** /AccountingActivities/AccountUsage | Get account usage
8-
[**get_accounting_activity_lock_history**](FinanceApi.md#get_accounting_activity_lock_history) | **GET** /AccountingActivities/LockHistory | Get lock history
9-
[**get_accounting_activity_report_history**](FinanceApi.md#get_accounting_activity_report_history) | **GET** /AccountingActivities/ReportHistory | Get report history
10-
[**get_accounting_activity_user_activities**](FinanceApi.md#get_accounting_activity_user_activities) | **GET** /AccountingActivities/UserActivities | Get user activities
117
[**get_bank_statement_accounting**](FinanceApi.md#get_bank_statement_accounting) | **GET** /BankStatementsPlus/statements | Get Bank Statement Accounting
128
[**get_cash_validation**](FinanceApi.md#get_cash_validation) | **GET** /CashValidation | Get cash validation
139
[**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
1915

2016

2117

22-
## get_accounting_activity_account_usage
23-
24-
> AccountUsageResponse get_accounting_activity_account_usage(xero_tenant_id, opts)
25-
26-
Get account usage
27-
28-
A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments.
29-
30-
### Example
31-
32-
```ruby
33-
# load the gem
34-
require 'xero-ruby'
35-
36-
creds = {
37-
client_id: ENV['CLIENT_ID'],
38-
client_secret: ENV['CLIENT_SECRET'],
39-
redirect_uri: ENV['REDIRECT_URI'],
40-
scopes: ENV['SCOPES']
41-
}
42-
xero_client = XeroRuby::ApiClient.new(credentials: creds)
43-
44-
token_set = fetch_valid_token_set(user) # example
45-
46-
xero_client.refresh_token_set(token_set)
47-
48-
# You need to namespace your api method call to one of the following api sets
49-
# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api]
50-
51-
api_instance = xero_client.<api_set>
52-
53-
54-
55-
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
56-
opts = {
57-
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.
58-
59-
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.
60-
}
61-
62-
begin
63-
#Get account usage
64-
result = api_instance.get_accounting_activity_account_usage(xero_tenant_id, opts)
65-
p result
66-
rescue XeroRuby::Finance::ApiError => e
67-
puts "Exception when calling FinanceApi->get_accounting_activity_account_usage: #{e}"
68-
end
69-
```
70-
71-
### Parameters
72-
73-
74-
Name | Type | Description | Notes
75-
------------- | ------------- | ------------- | -------------
76-
**xero_tenant_id** | **String**| Xero identifier for Tenant |
77-
**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]
78-
**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]
79-
80-
### Return type
81-
82-
[**AccountUsageResponse**](AccountUsageResponse.md)
83-
84-
### Authorization
85-
86-
[OAuth2](../README.md#OAuth2)
87-
88-
### HTTP request headers
89-
90-
- **Content-Type**: Not defined
91-
- **Accept**: application/json
92-
93-
94-
## get_accounting_activity_lock_history
95-
96-
> LockHistoryResponse get_accounting_activity_lock_history(xero_tenant_id, opts)
97-
98-
Get lock history
99-
100-
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.
101-
102-
### Example
103-
104-
```ruby
105-
# load the gem
106-
require 'xero-ruby'
107-
108-
creds = {
109-
client_id: ENV['CLIENT_ID'],
110-
client_secret: ENV['CLIENT_SECRET'],
111-
redirect_uri: ENV['REDIRECT_URI'],
112-
scopes: ENV['SCOPES']
113-
}
114-
xero_client = XeroRuby::ApiClient.new(credentials: creds)
115-
116-
token_set = fetch_valid_token_set(user) # example
117-
118-
xero_client.refresh_token_set(token_set)
119-
120-
# You need to namespace your api method call to one of the following api sets
121-
# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api]
122-
123-
api_instance = xero_client.<api_set>
124-
125-
126-
127-
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
128-
opts = {
129-
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.
130-
}
131-
132-
begin
133-
#Get lock history
134-
result = api_instance.get_accounting_activity_lock_history(xero_tenant_id, opts)
135-
p result
136-
rescue XeroRuby::Finance::ApiError => e
137-
puts "Exception when calling FinanceApi->get_accounting_activity_lock_history: #{e}"
138-
end
139-
```
140-
141-
### Parameters
142-
143-
144-
Name | Type | Description | Notes
145-
------------- | ------------- | ------------- | -------------
146-
**xero_tenant_id** | **String**| Xero identifier for Tenant |
147-
**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]
148-
149-
### Return type
150-
151-
[**LockHistoryResponse**](LockHistoryResponse.md)
152-
153-
### Authorization
154-
155-
[OAuth2](../README.md#OAuth2)
156-
157-
### HTTP request headers
158-
159-
- **Content-Type**: Not defined
160-
- **Accept**: application/json
161-
162-
163-
## get_accounting_activity_report_history
164-
165-
> ReportHistoryResponse get_accounting_activity_report_history(xero_tenant_id, opts)
166-
167-
Get report history
168-
169-
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.
170-
171-
### Example
172-
173-
```ruby
174-
# load the gem
175-
require 'xero-ruby'
176-
177-
creds = {
178-
client_id: ENV['CLIENT_ID'],
179-
client_secret: ENV['CLIENT_SECRET'],
180-
redirect_uri: ENV['REDIRECT_URI'],
181-
scopes: ENV['SCOPES']
182-
}
183-
xero_client = XeroRuby::ApiClient.new(credentials: creds)
184-
185-
token_set = fetch_valid_token_set(user) # example
186-
187-
xero_client.refresh_token_set(token_set)
188-
189-
# You need to namespace your api method call to one of the following api sets
190-
# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api]
191-
192-
api_instance = xero_client.<api_set>
193-
194-
195-
196-
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
197-
opts = {
198-
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.
199-
}
200-
201-
begin
202-
#Get report history
203-
result = api_instance.get_accounting_activity_report_history(xero_tenant_id, opts)
204-
p result
205-
rescue XeroRuby::Finance::ApiError => e
206-
puts "Exception when calling FinanceApi->get_accounting_activity_report_history: #{e}"
207-
end
208-
```
209-
210-
### Parameters
211-
212-
213-
Name | Type | Description | Notes
214-
------------- | ------------- | ------------- | -------------
215-
**xero_tenant_id** | **String**| Xero identifier for Tenant |
216-
**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]
217-
218-
### Return type
219-
220-
[**ReportHistoryResponse**](ReportHistoryResponse.md)
221-
222-
### Authorization
223-
224-
[OAuth2](../README.md#OAuth2)
225-
226-
### HTTP request headers
227-
228-
- **Content-Type**: Not defined
229-
- **Accept**: application/json
230-
231-
232-
## get_accounting_activity_user_activities
233-
234-
> UserActivitiesResponse get_accounting_activity_user_activities(xero_tenant_id, opts)
235-
236-
Get user activities
237-
238-
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.
239-
240-
### Example
241-
242-
```ruby
243-
# load the gem
244-
require 'xero-ruby'
245-
246-
creds = {
247-
client_id: ENV['CLIENT_ID'],
248-
client_secret: ENV['CLIENT_SECRET'],
249-
redirect_uri: ENV['REDIRECT_URI'],
250-
scopes: ENV['SCOPES']
251-
}
252-
xero_client = XeroRuby::ApiClient.new(credentials: creds)
253-
254-
token_set = fetch_valid_token_set(user) # example
255-
256-
xero_client.refresh_token_set(token_set)
257-
258-
# You need to namespace your api method call to one of the following api sets
259-
# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api]
260-
261-
api_instance = xero_client.<api_set>
262-
263-
264-
265-
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
266-
opts = {
267-
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.
268-
}
269-
270-
begin
271-
#Get user activities
272-
result = api_instance.get_accounting_activity_user_activities(xero_tenant_id, opts)
273-
p result
274-
rescue XeroRuby::Finance::ApiError => e
275-
puts "Exception when calling FinanceApi->get_accounting_activity_user_activities: #{e}"
276-
end
277-
```
278-
279-
### Parameters
280-
281-
282-
Name | Type | Description | Notes
283-
------------- | ------------- | ------------- | -------------
284-
**xero_tenant_id** | **String**| Xero identifier for Tenant |
285-
**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]
286-
287-
### Return type
288-
289-
[**UserActivitiesResponse**](UserActivitiesResponse.md)
290-
291-
### Authorization
292-
293-
[OAuth2](../README.md#OAuth2)
294-
295-
### HTTP request headers
296-
297-
- **Content-Type**: Not defined
298-
- **Accept**: application/json
299-
300-
30118
## get_bank_statement_accounting
30219

30320
> BankStatementAccountingResponse get_bank_statement_accounting(xero_tenant_id, bank_account_id, from_date, to_date, opts)

0 commit comments

Comments
 (0)