chore(app): сгенерированный Dart-клиент
just gen-client — покрывает links, cashflow-broker, ручные цены, imports/pending, goals/income/rebalance/tax/benchmarks.
This commit is contained in:
Dmitry
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.AccountSuggestion
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**broker** | **String** | |
|
||||
**id** | **int** | |
|
||||
**name** | **String** | |
|
||||
**sourceId** | **String** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -10,6 +10,7 @@ All URIs are relative to *http://localhost*
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**analyticsAllocation**](AnalyticsApi.md#analyticsallocation) | **GET** /api/v1/analytics/allocation | Allocation
|
||||
[**analyticsCashflowBroker**](AnalyticsApi.md#analyticscashflowbroker) | **GET** /api/v1/analytics/cashflow-broker | Cashflow Broker
|
||||
[**analyticsHoldings**](AnalyticsApi.md#analyticsholdings) | **GET** /api/v1/analytics/holdings | Holdings
|
||||
[**analyticsReturns**](AnalyticsApi.md#analyticsreturns) | **GET** /api/v1/analytics/returns | Returns
|
||||
[**analyticsScopes**](AnalyticsApi.md#analyticsscopes) | **GET** /api/v1/analytics/scopes | Scopes
|
||||
@@ -62,6 +63,49 @@ 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)
|
||||
|
||||
# **analyticsCashflowBroker**
|
||||
> List<CashFlowBrokerMonth> analyticsCashflowBroker(scope)
|
||||
|
||||
Cashflow Broker
|
||||
|
||||
Money moved across the brokerage boundary, by month: the other half of cash flow that `metric_cash_flow_monthly` (ZenMoney spending) does not cover.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAnalyticsApi();
|
||||
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>
|
||||
|
||||
try {
|
||||
final response = api.analyticsCashflowBroker(scope);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AnalyticsApi->analyticsCashflowBroker: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<CashFlowBrokerMonth>**](CashFlowBrokerMonth.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **analyticsHoldings**
|
||||
> List<HoldingOut> analyticsHoldings(scope)
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
# fintracker_api.model.BenchmarkComparison
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**rows** | [**List<BenchmarkComparisonOut>**](BenchmarkComparisonOut.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
# fintracker_api.model.BenchmarkComparisonOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**benchmarks** | [**List<BenchmarkReturnOut>**](BenchmarkReturnOut.md) | |
|
||||
**dateFrom** | [**DateTime**](DateTime.md) | |
|
||||
**dateTo** | [**DateTime**](DateTime.md) | |
|
||||
**period** | **String** | |
|
||||
**portfolioDaysSkipped** | **int** | |
|
||||
**portfolioTwr** | **String** | decimal as string |
|
||||
**portfolioTwrAnnualized** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# fintracker_api.model.BenchmarkCreate
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | **String** | |
|
||||
**currency** | **String** | | [optional] [default to 'RUB']
|
||||
**instrumentId** | **int** | | [optional]
|
||||
**isActive** | **bool** | | [optional] [default to true]
|
||||
**isDefault** | **bool** | | [optional] [default to false]
|
||||
**kind** | **String** | |
|
||||
**name** | **String** | |
|
||||
**source_** | **String** | | [optional] [default to 'moex']
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
# fintracker_api.model.BenchmarkOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | **String** | |
|
||||
**currency** | **String** | |
|
||||
**historyFrom** | [**DateTime**](DateTime.md) | |
|
||||
**historyTo** | [**DateTime**](DateTime.md) | |
|
||||
**id** | **int** | |
|
||||
**instrumentId** | **int** | |
|
||||
**isActive** | **bool** | |
|
||||
**isDefault** | **bool** | |
|
||||
**kind** | **String** | |
|
||||
**name** | **String** | |
|
||||
**source_** | **String** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# fintracker_api.model.BenchmarkPatch
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | **String** | | [optional]
|
||||
**currency** | **String** | | [optional]
|
||||
**instrumentId** | **int** | | [optional]
|
||||
**isActive** | **bool** | | [optional]
|
||||
**isDefault** | **bool** | | [optional]
|
||||
**kind** | **String** | | [optional]
|
||||
**name** | **String** | | [optional]
|
||||
**source_** | **String** | | [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)
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# fintracker_api.model.BenchmarkReturnOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**benchmarkId** | **int** | |
|
||||
**code** | **String** | |
|
||||
**daysSkipped** | **int** | |
|
||||
**excess** | **String** | decimal as string |
|
||||
**kind** | **String** | |
|
||||
**name** | **String** | |
|
||||
**twr** | **String** | decimal as string |
|
||||
**twrAnnualized** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,226 @@
|
||||
# fintracker_api.api.BenchmarksApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**benchmarksBenchmarks**](BenchmarksApi.md#benchmarksbenchmarks) | **GET** /api/v1/analytics/benchmarks | Benchmarks
|
||||
[**benchmarksCreate**](BenchmarksApi.md#benchmarkscreate) | **POST** /api/v1/benchmarks | Create
|
||||
[**benchmarksDelete**](BenchmarksApi.md#benchmarksdelete) | **DELETE** /api/v1/benchmarks/{benchmark_id} | Delete
|
||||
[**benchmarksList**](BenchmarksApi.md#benchmarkslist) | **GET** /api/v1/benchmarks | List
|
||||
[**benchmarksPatch**](BenchmarksApi.md#benchmarkspatch) | **PATCH** /api/v1/benchmarks/{benchmark_id} | Patch
|
||||
|
||||
|
||||
# **benchmarksBenchmarks**
|
||||
> BenchmarkComparison benchmarksBenchmarks(scope, period)
|
||||
|
||||
Benchmarks
|
||||
|
||||
The portfolio's TWR beside each benchmark's, on the same grid of days. `days_skipped` is returned on both sides and is not cosmetic: a non-zero value on either means the two chains did not cover the same days, and the difference is then an approximation of an excess return rather than one.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getBenchmarksApi();
|
||||
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>
|
||||
final List<String?> period = ; // List<String?> | repeatable: 1m 3m 6m ytd 1y 3y all
|
||||
|
||||
try {
|
||||
final response = api.benchmarksBenchmarks(scope, period);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling BenchmarksApi->benchmarksBenchmarks: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']
|
||||
**period** | [**List<String?>**](String.md)| repeatable: 1m 3m 6m ytd 1y 3y all | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**BenchmarkComparison**](BenchmarkComparison.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **benchmarksCreate**
|
||||
> BenchmarkOut benchmarksCreate(benchmarkCreate)
|
||||
|
||||
Create
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getBenchmarksApi();
|
||||
final BenchmarkCreate benchmarkCreate = ; // BenchmarkCreate |
|
||||
|
||||
try {
|
||||
final response = api.benchmarksCreate(benchmarkCreate);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling BenchmarksApi->benchmarksCreate: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**benchmarkCreate** | [**BenchmarkCreate**](BenchmarkCreate.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**BenchmarkOut**](BenchmarkOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **benchmarksDelete**
|
||||
> benchmarksDelete(benchmarkId)
|
||||
|
||||
Delete
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getBenchmarksApi();
|
||||
final int benchmarkId = 56; // int |
|
||||
|
||||
try {
|
||||
api.benchmarksDelete(benchmarkId);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling BenchmarksApi->benchmarksDelete: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**benchmarkId** | **int**| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **benchmarksList**
|
||||
> List<BenchmarkOut> benchmarksList()
|
||||
|
||||
List
|
||||
|
||||
Every benchmark, defaults first — the order the comparison block shows them in.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getBenchmarksApi();
|
||||
|
||||
try {
|
||||
final response = api.benchmarksList();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling BenchmarksApi->benchmarksList: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<BenchmarkOut>**](BenchmarkOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **benchmarksPatch**
|
||||
> BenchmarkOut benchmarksPatch(benchmarkId, benchmarkPatch)
|
||||
|
||||
Patch
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getBenchmarksApi();
|
||||
final int benchmarkId = 56; // int |
|
||||
final BenchmarkPatch benchmarkPatch = ; // BenchmarkPatch |
|
||||
|
||||
try {
|
||||
final response = api.benchmarksPatch(benchmarkId, benchmarkPatch);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling BenchmarksApi->benchmarksPatch: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**benchmarkId** | **int**| |
|
||||
**benchmarkPatch** | [**BenchmarkPatch**](BenchmarkPatch.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**BenchmarkOut**](BenchmarkOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
# fintracker_api.model.CalendarEntry
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**amount** | **String** | decimal as string |
|
||||
**amountRub** | **String** | decimal as string |
|
||||
**basis** | **String** | |
|
||||
**currency** | **String** | |
|
||||
**expectedDate** | [**DateTime**](DateTime.md) | |
|
||||
**instrumentId** | **int** | |
|
||||
**kind** | **String** | |
|
||||
**name** | **String** | |
|
||||
**perUnit** | **String** | decimal as string |
|
||||
**qty** | **String** | decimal as string |
|
||||
**recordDate** | [**DateTime**](DateTime.md) | |
|
||||
**taxWithheld** | **String** | decimal as string |
|
||||
**ticker** | **String** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# fintracker_api.model.CalendarOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asOf** | [**DateTime**](DateTime.md) | |
|
||||
**byBasis** | **Map<String, String>** | |
|
||||
**currency** | **String** | |
|
||||
**entries** | [**List<CalendarEntry>**](CalendarEntry.md) | |
|
||||
**totalExpectedRub** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# fintracker_api.model.CashAvailable
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# fintracker_api.model.CashFlowBrokerMonth
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**depositsRub** | **String** | decimal as string |
|
||||
**eventCount** | **int** | |
|
||||
**month** | [**DateTime**](DateTime.md) | |
|
||||
**netRub** | **String** | decimal as string |
|
||||
**withdrawalsRub** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# fintracker_api.model.CommitRequest
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountId** | **int** | | [optional]
|
||||
**confirmDuplicates** | **bool** | | [optional] [default to false]
|
||||
**dryRun** | **bool** | | [optional] [default to false]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# fintracker_api.model.ForecastMonth
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**amountRub** | **String** | decimal as string |
|
||||
**byBasis** | **Map<String, String>** | |
|
||||
**month** | [**DateTime**](DateTime.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.ForecastOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**annualYieldOnValue** | **String** | decimal as string |
|
||||
**months** | [**List<ForecastMonth>**](ForecastMonth.md) | |
|
||||
**totalRub** | **String** | decimal as string |
|
||||
**warnings** | **List<String>** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# fintracker_api.model.GoalCreate
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**archived** | **bool** | | [optional] [default to false]
|
||||
**currency** | **String** | | [optional] [default to 'RUB']
|
||||
**monthlyContribution** | **String** | decimal as string | [optional]
|
||||
**name** | **String** | |
|
||||
**note** | **String** | | [optional]
|
||||
**scope** | **String** | | [optional] [default to 'all']
|
||||
**targetAmount** | **String** | decimal as string |
|
||||
**targetDate** | [**DateTime**](DateTime.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# fintracker_api.model.GoalOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**archived** | **bool** | |
|
||||
**currency** | **String** | |
|
||||
**id** | **int** | |
|
||||
**monthlyContribution** | **String** | decimal as string |
|
||||
**name** | **String** | |
|
||||
**note** | **String** | |
|
||||
**scope** | **String** | |
|
||||
**targetAmount** | **String** | decimal as string |
|
||||
**targetDate** | [**DateTime**](DateTime.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# fintracker_api.model.GoalPatch
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**archived** | **bool** | | [optional]
|
||||
**currency** | **String** | | [optional]
|
||||
**monthlyContribution** | **String** | decimal as string | [optional]
|
||||
**name** | **String** | | [optional]
|
||||
**note** | **String** | | [optional]
|
||||
**scope** | **String** | | [optional]
|
||||
**targetAmount** | **String** | decimal as string | [optional]
|
||||
**targetDate** | [**DateTime**](DateTime.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
# fintracker_api.model.GoalProgressOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asOf** | [**DateTime**](DateTime.md) | |
|
||||
**assumedRate** | **String** | decimal as string |
|
||||
**basis** | **String** | |
|
||||
**currentValueRub** | **String** | decimal as string |
|
||||
**goalId** | **int** | |
|
||||
**monthlyNeededRub** | **String** | decimal as string |
|
||||
**onTrack** | **bool** | |
|
||||
**progress** | **String** | decimal as string |
|
||||
**projectedDate** | [**DateTime**](DateTime.md) | |
|
||||
**targetAmountRub** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,224 @@
|
||||
# fintracker_api.api.GoalsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**goalsCreate**](GoalsApi.md#goalscreate) | **POST** /api/v1/goals | Create
|
||||
[**goalsDelete**](GoalsApi.md#goalsdelete) | **DELETE** /api/v1/goals/{goal_id} | Delete
|
||||
[**goalsList**](GoalsApi.md#goalslist) | **GET** /api/v1/goals | List
|
||||
[**goalsPatch**](GoalsApi.md#goalspatch) | **PATCH** /api/v1/goals/{goal_id} | Patch
|
||||
[**goalsProgress**](GoalsApi.md#goalsprogress) | **GET** /api/v1/goals/{goal_id}/progress | Progress
|
||||
|
||||
|
||||
# **goalsCreate**
|
||||
> GoalOut goalsCreate(goalCreate)
|
||||
|
||||
Create
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getGoalsApi();
|
||||
final GoalCreate goalCreate = ; // GoalCreate |
|
||||
|
||||
try {
|
||||
final response = api.goalsCreate(goalCreate);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling GoalsApi->goalsCreate: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**goalCreate** | [**GoalCreate**](GoalCreate.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**GoalOut**](GoalOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **goalsDelete**
|
||||
> goalsDelete(goalId)
|
||||
|
||||
Delete
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getGoalsApi();
|
||||
final int goalId = 56; // int |
|
||||
|
||||
try {
|
||||
api.goalsDelete(goalId);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling GoalsApi->goalsDelete: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**goalId** | **int**| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **goalsList**
|
||||
> List<GoalOut> goalsList(includeArchived)
|
||||
|
||||
List
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getGoalsApi();
|
||||
final bool includeArchived = true; // bool |
|
||||
|
||||
try {
|
||||
final response = api.goalsList(includeArchived);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling GoalsApi->goalsList: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**includeArchived** | **bool**| | [optional] [default to false]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<GoalOut>**](GoalOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **goalsPatch**
|
||||
> GoalOut goalsPatch(goalId, goalPatch)
|
||||
|
||||
Patch
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getGoalsApi();
|
||||
final int goalId = 56; // int |
|
||||
final GoalPatch goalPatch = ; // GoalPatch |
|
||||
|
||||
try {
|
||||
final response = api.goalsPatch(goalId, goalPatch);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling GoalsApi->goalsPatch: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**goalId** | **int**| |
|
||||
**goalPatch** | [**GoalPatch**](GoalPatch.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**GoalOut**](GoalOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **goalsProgress**
|
||||
> GoalProgressOut goalsProgress(goalId)
|
||||
|
||||
Progress
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getGoalsApi();
|
||||
final int goalId = 56; // int |
|
||||
|
||||
try {
|
||||
final response = api.goalsProgress(goalId);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling GoalsApi->goalsProgress: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**goalId** | **int**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**GoalProgressOut**](GoalProgressOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
# fintracker_api.model.HistoryOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**rows** | [**List<HistoryRow>**](HistoryRow.md) | |
|
||||
**totals** | [**HistoryTotals**](HistoryTotals.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
# fintracker_api.model.HistoryRow
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**amount** | **String** | decimal as string |
|
||||
**amountRub** | **String** | decimal as string |
|
||||
**currency** | **String** | |
|
||||
**kind** | **String** | |
|
||||
**month** | [**DateTime**](DateTime.md) | |
|
||||
**paymentCount** | **int** | |
|
||||
**taxWithheld** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
# fintracker_api.model.HistoryTotals
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**amountRub** | **String** | decimal as string |
|
||||
**taxWithheldRub** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
# fintracker_api.model.ImportCounts
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**byKind** | **Map<String, int>** | |
|
||||
**eventsDuplicate** | **int** | |
|
||||
**eventsNew** | **int** | |
|
||||
**eventsPending** | **int** | |
|
||||
**eventsShadow** | **int** | |
|
||||
**eventsTotal** | **int** | |
|
||||
**lines** | **int** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
# fintracker_api.model.ImportPreview
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountExternalId** | **String** | | [optional]
|
||||
**accountId** | **int** | | [optional]
|
||||
**accountName** | **String** | | [optional]
|
||||
**accountSuggestions** | [**List<AccountSuggestion>**](AccountSuggestion.md) | | [optional]
|
||||
**broker** | **String** | |
|
||||
**committedAt** | [**DateTime**](DateTime.md) | | [optional]
|
||||
**counts** | [**ImportCounts**](ImportCounts.md) | |
|
||||
**duplicateOfId** | **int** | | [optional]
|
||||
**error** | **String** | | [optional]
|
||||
**filename** | **String** | |
|
||||
**id** | **int** | |
|
||||
**parseStatus** | **String** | |
|
||||
**parserName** | **String** | | [optional]
|
||||
**parserVersion** | **String** | | [optional]
|
||||
**pendingInstruments** | [**List<PendingInstrumentOut>**](PendingInstrumentOut.md) | | [optional]
|
||||
**periodFrom** | [**DateTime**](DateTime.md) | | [optional]
|
||||
**periodTo** | [**DateTime**](DateTime.md) | | [optional]
|
||||
**reconciliation** | [**ReconciliationOut**](ReconciliationOut.md) | |
|
||||
**sampleEvents** | [**List<SampleEventOut>**](SampleEventOut.md) | | [optional]
|
||||
**sha256** | **String** | |
|
||||
**sizeBytes** | **int** | |
|
||||
**uploadedAt** | [**DateTime**](DateTime.md) | | [optional]
|
||||
**warnings** | **List<String>** | | [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)
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# fintracker_api.model.ImportResult
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**committed** | **bool** | |
|
||||
**eventsCreated** | **int** | |
|
||||
**eventsShadow** | **int** | |
|
||||
**eventsSkipped** | **int** | |
|
||||
**eventsUpdated** | **int** | |
|
||||
**importId** | **int** | |
|
||||
**metricsRefreshed** | **bool** | |
|
||||
**pendingInstruments** | **int** | |
|
||||
**reconciliation** | [**ReconciliationOut**](ReconciliationOut.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
# fintracker_api.model.ImportSummary
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountExternalId** | **String** | | [optional]
|
||||
**accountId** | **int** | | [optional]
|
||||
**accountName** | **String** | | [optional]
|
||||
**broker** | **String** | |
|
||||
**committedAt** | [**DateTime**](DateTime.md) | | [optional]
|
||||
**counts** | [**ImportCounts**](ImportCounts.md) | |
|
||||
**duplicateOfId** | **int** | | [optional]
|
||||
**error** | **String** | | [optional]
|
||||
**filename** | **String** | |
|
||||
**id** | **int** | |
|
||||
**parseStatus** | **String** | |
|
||||
**parserName** | **String** | | [optional]
|
||||
**parserVersion** | **String** | | [optional]
|
||||
**periodFrom** | [**DateTime**](DateTime.md) | | [optional]
|
||||
**periodTo** | [**DateTime**](DateTime.md) | | [optional]
|
||||
**sha256** | **String** | |
|
||||
**sizeBytes** | **int** | |
|
||||
**uploadedAt** | [**DateTime**](DateTime.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,242 @@
|
||||
# fintracker_api.api.ImportsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**importsCommit**](ImportsApi.md#importscommit) | **POST** /api/v1/imports/{import_id}/commit | Commit
|
||||
[**importsCreate**](ImportsApi.md#importscreate) | **POST** /api/v1/imports | Create
|
||||
[**importsDelete**](ImportsApi.md#importsdelete) | **DELETE** /api/v1/imports/{import_id} | Delete
|
||||
[**importsGet**](ImportsApi.md#importsget) | **GET** /api/v1/imports/{import_id} | Get
|
||||
[**importsList**](ImportsApi.md#importslist) | **GET** /api/v1/imports | List
|
||||
|
||||
|
||||
# **importsCommit**
|
||||
> ImportResult importsCommit(importId, commitRequest)
|
||||
|
||||
Commit
|
||||
|
||||
Write the file's events into the ledger and rebuild every metric.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getImportsApi();
|
||||
final int importId = 56; // int |
|
||||
final CommitRequest commitRequest = ; // CommitRequest |
|
||||
|
||||
try {
|
||||
final response = api.importsCommit(importId, commitRequest);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling ImportsApi->importsCommit: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**importId** | **int**| |
|
||||
**commitRequest** | [**CommitRequest**](CommitRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ImportResult**](ImportResult.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **importsCreate**
|
||||
> ImportPreview importsCreate(file, accountId, parser)
|
||||
|
||||
Create
|
||||
|
||||
Upload a report, parse it and show what committing it would do. Writes no event.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getImportsApi();
|
||||
final MultipartFile file = BINARY_DATA_HERE; // MultipartFile | the report itself
|
||||
final int accountId = 56; // int | target account, if known
|
||||
final String parser = parser_example; // String | force a parser from registry.names()
|
||||
|
||||
try {
|
||||
final response = api.importsCreate(file, accountId, parser);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling ImportsApi->importsCreate: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**file** | **MultipartFile**| the report itself |
|
||||
**accountId** | **int**| target account, if known | [optional]
|
||||
**parser** | **String**| force a parser from registry.names() | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ImportPreview**](ImportPreview.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: multipart/form-data
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **importsDelete**
|
||||
> importsDelete(importId)
|
||||
|
||||
Delete
|
||||
|
||||
Drop an uncommitted import. A committed one stays: `raw_*` is append-only.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getImportsApi();
|
||||
final int importId = 56; // int |
|
||||
|
||||
try {
|
||||
api.importsDelete(importId);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling ImportsApi->importsDelete: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**importId** | **int**| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **importsGet**
|
||||
> ImportPreview importsGet(importId)
|
||||
|
||||
Get
|
||||
|
||||
The preview again — recomputed for an uncommitted import, replayed for a committed one.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getImportsApi();
|
||||
final int importId = 56; // int |
|
||||
|
||||
try {
|
||||
final response = api.importsGet(importId);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling ImportsApi->importsGet: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**importId** | **int**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ImportPreview**](ImportPreview.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **importsList**
|
||||
> List<ImportSummary> importsList(status, limit, offset)
|
||||
|
||||
List
|
||||
|
||||
Newest imports first, with the counters each was committed with.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getImportsApi();
|
||||
final String status = status_example; // String | uploaded | parsed | committed | failed
|
||||
final int limit = 56; // int |
|
||||
final int offset = 56; // int |
|
||||
|
||||
try {
|
||||
final response = api.importsList(status, limit, offset);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling ImportsApi->importsList: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**status** | **String**| uploaded | parsed | committed | failed | [optional]
|
||||
**limit** | **int**| | [optional] [default to 50]
|
||||
**offset** | **int**| | [optional] [default to 0]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<ImportSummary>**](ImportSummary.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,161 @@
|
||||
# fintracker_api.api.IncomeApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**incomeCalendar**](IncomeApi.md#incomecalendar) | **GET** /api/v1/income/calendar | Calendar
|
||||
[**incomeForecast**](IncomeApi.md#incomeforecast) | **GET** /api/v1/income/forecast | Forecast
|
||||
[**incomeHistory**](IncomeApi.md#incomehistory) | **GET** /api/v1/income/history | History
|
||||
|
||||
|
||||
# **incomeCalendar**
|
||||
> CalendarOut incomeCalendar(scope, dateFrom, dateTo, includePaid)
|
||||
|
||||
Calendar
|
||||
|
||||
Payments in a window, one row each; defaults to the next 12 months, forecast only.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getIncomeApi();
|
||||
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>
|
||||
final DateTime dateFrom = 2013-10-20; // DateTime |
|
||||
final DateTime dateTo = 2013-10-20; // DateTime |
|
||||
final bool includePaid = true; // bool |
|
||||
|
||||
try {
|
||||
final response = api.incomeCalendar(scope, dateFrom, dateTo, includePaid);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling IncomeApi->incomeCalendar: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']
|
||||
**dateFrom** | **DateTime**| | [optional]
|
||||
**dateTo** | **DateTime**| | [optional]
|
||||
**includePaid** | **bool**| | [optional] [default to false]
|
||||
|
||||
### Return type
|
||||
|
||||
[**CalendarOut**](CalendarOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **incomeForecast**
|
||||
> ForecastOut incomeForecast(scope, months)
|
||||
|
||||
Forecast
|
||||
|
||||
Expected income per month, split by basis, plus the yield it implies.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getIncomeApi();
|
||||
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>
|
||||
final int months = 56; // int |
|
||||
|
||||
try {
|
||||
final response = api.incomeForecast(scope, months);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling IncomeApi->incomeForecast: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']
|
||||
**months** | **int**| | [optional] [default to 12]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ForecastOut**](ForecastOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **incomeHistory**
|
||||
> HistoryOut incomeHistory(scope, group, dateFrom, dateTo, kind)
|
||||
|
||||
History
|
||||
|
||||
Income actually received, grouped by month, kind and currency. `group` exists for the contract's sake and accepts only `month`: the table is stored monthly, and a finer grouping would have to re-read the ledger, which is what the calendar's `paid` rows already do per payment.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getIncomeApi();
|
||||
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>
|
||||
final String group = group_example; // String | month
|
||||
final DateTime dateFrom = 2013-10-20; // DateTime |
|
||||
final DateTime dateTo = 2013-10-20; // DateTime |
|
||||
final String kind = kind_example; // String | dividend | coupon | …
|
||||
|
||||
try {
|
||||
final response = api.incomeHistory(scope, group, dateFrom, dateTo, kind);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling IncomeApi->incomeHistory: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']
|
||||
**group** | **String**| month | [optional] [default to 'month']
|
||||
**dateFrom** | **DateTime**| | [optional]
|
||||
**dateTo** | **DateTime**| | [optional]
|
||||
**kind** | **String**| dividend | coupon | … | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**HistoryOut**](HistoryOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -11,6 +11,9 @@ Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**instrumentsGet**](InstrumentsApi.md#instrumentsget) | **GET** /api/v1/instruments/{instrument_id} | Get
|
||||
[**instrumentsList**](InstrumentsApi.md#instrumentslist) | **GET** /api/v1/instruments | List
|
||||
[**instrumentsPending**](InstrumentsApi.md#instrumentspending) | **GET** /api/v1/instruments/pending | Pending
|
||||
[**instrumentsPendingResolve**](InstrumentsApi.md#instrumentspendingresolve) | **POST** /api/v1/instruments/pending/{pending_id}/resolve | Pending Resolve
|
||||
[**instrumentsSetManualPrice**](InstrumentsApi.md#instrumentssetmanualprice) | **POST** /api/v1/instruments/{instrument_id}/prices | Set Manual Price
|
||||
|
||||
|
||||
# **instrumentsGet**
|
||||
@@ -107,3 +110,140 @@ 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)
|
||||
|
||||
# **instrumentsPending**
|
||||
> List<PendingInstrumentOut> instrumentsPending(status, limit, offset)
|
||||
|
||||
Pending
|
||||
|
||||
Instruments a report named that nothing in the master resolves to.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getInstrumentsApi();
|
||||
final String status = status_example; // String | pending | resolved | ignored | all
|
||||
final int limit = 56; // int |
|
||||
final int offset = 56; // int |
|
||||
|
||||
try {
|
||||
final response = api.instrumentsPending(status, limit, offset);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling InstrumentsApi->instrumentsPending: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**status** | **String**| pending | resolved | ignored | all | [optional] [default to 'pending']
|
||||
**limit** | **int**| | [optional] [default to 100]
|
||||
**offset** | **int**| | [optional] [default to 0]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<PendingInstrumentOut>**](PendingInstrumentOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **instrumentsPendingResolve**
|
||||
> PendingResolveResult instrumentsPendingResolve(pendingId, pendingResolveRequest)
|
||||
|
||||
Pending Resolve
|
||||
|
||||
Link, create or ignore — then bind the events that were waiting and rebuild the lots.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getInstrumentsApi();
|
||||
final int pendingId = 56; // int |
|
||||
final PendingResolveRequest pendingResolveRequest = ; // PendingResolveRequest |
|
||||
|
||||
try {
|
||||
final response = api.instrumentsPendingResolve(pendingId, pendingResolveRequest);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling InstrumentsApi->instrumentsPendingResolve: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pendingId** | **int**| |
|
||||
**pendingResolveRequest** | [**PendingResolveRequest**](PendingResolveRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PendingResolveResult**](PendingResolveResult.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **instrumentsSetManualPrice**
|
||||
> PriceManualOut instrumentsSetManualPrice(instrumentId, priceManualIn)
|
||||
|
||||
Set Manual Price
|
||||
|
||||
Set (or replace) the manual price of `instrument_id` on `body.d`. For what no exchange quotes: real estate, crypto, a custom holding, an OTC bond nobody lists. One row per (instrument, day) — a second call for the same day replaces it rather than piling up duplicates the price series would then have to pick between. Does not itself refresh `metric_*`; call `POST /metrics/refresh` after, same as `/rules/apply`.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getInstrumentsApi();
|
||||
final int instrumentId = 56; // int |
|
||||
final PriceManualIn priceManualIn = ; // PriceManualIn |
|
||||
|
||||
try {
|
||||
final response = api.instrumentsSetManualPrice(instrumentId, priceManualIn);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling InstrumentsApi->instrumentsSetManualPrice: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**instrumentId** | **int**| |
|
||||
**priceManualIn** | [**PriceManualIn**](PriceManualIn.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PriceManualOut**](PriceManualOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
# fintracker_api.model.LinkCreate
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**cashTxnId** | **int** | |
|
||||
**eventId** | **int** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# fintracker_api.model.LinkOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**amountDelta** | **String** | decimal as string |
|
||||
**cashTxnId** | **int** | |
|
||||
**confidence** | **String** | decimal as string |
|
||||
**currency** | **String** | |
|
||||
**dayGap** | **int** | |
|
||||
**eventId** | **int** | |
|
||||
**id** | **int** | |
|
||||
**kind** | **String** | |
|
||||
**note** | **String** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,140 @@
|
||||
# fintracker_api.api.LinksApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**linksCreate**](LinksApi.md#linkscreate) | **POST** /api/v1/links | Create
|
||||
[**linksDelete**](LinksApi.md#linksdelete) | **DELETE** /api/v1/links/{link_id} | Delete
|
||||
[**linksUnmatched**](LinksApi.md#linksunmatched) | **GET** /api/v1/links/unmatched | Unmatched
|
||||
|
||||
|
||||
# **linksCreate**
|
||||
> LinkOut linksCreate(linkCreate)
|
||||
|
||||
Create
|
||||
|
||||
Confirm a pairing the matcher missed. Never touched by the automatic rebuild afterwards.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getLinksApi();
|
||||
final LinkCreate linkCreate = ; // LinkCreate |
|
||||
|
||||
try {
|
||||
final response = api.linksCreate(linkCreate);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling LinksApi->linksCreate: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**linkCreate** | [**LinkCreate**](LinkCreate.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**LinkOut**](LinkOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **linksDelete**
|
||||
> linksDelete(linkId)
|
||||
|
||||
Delete
|
||||
|
||||
Undo a link, manual or automatic. `flow_type` reverts on the next `POST /metrics/refresh`, when `classify` rebuilds it from the rules and `matching` no longer overwrites it.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getLinksApi();
|
||||
final int linkId = 56; // int |
|
||||
|
||||
try {
|
||||
api.linksDelete(linkId);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling LinksApi->linksDelete: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**linkId** | **int**| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **linksUnmatched**
|
||||
> UnmatchedOut linksUnmatched()
|
||||
|
||||
Unmatched
|
||||
|
||||
Every candidate that survives matching without a link, on either side.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getLinksApi();
|
||||
|
||||
try {
|
||||
final response = api.linksUnmatched();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling LinksApi->linksUnmatched: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**UnmatchedOut**](UnmatchedOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
# fintracker_api.model.NewInstrument
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**assetClass** | **String** | |
|
||||
**board** | **String** | | [optional]
|
||||
**currency** | **String** | | [optional] [default to 'RUB']
|
||||
**isin** | **String** | | [optional]
|
||||
**lot** | **int** | | [optional] [default to 1]
|
||||
**name** | **String** | |
|
||||
**ticker** | **String** | | [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)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# fintracker_api.model.PendingInstrumentOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**assetClassHint** | **String** | | [optional]
|
||||
**board** | **String** | | [optional]
|
||||
**createdAt** | [**DateTime**](DateTime.md) | | [optional]
|
||||
**currency** | **String** | | [optional]
|
||||
**firstSeenFileId** | **int** | | [optional]
|
||||
**id** | **int** | |
|
||||
**instrumentId** | **int** | | [optional]
|
||||
**isin** | **String** | | [optional]
|
||||
**name** | **String** | | [optional]
|
||||
**occurrences** | **int** | |
|
||||
**samplePrice** | **String** | decimal as string | [optional]
|
||||
**sampleQuantity** | **String** | decimal as string | [optional]
|
||||
**source_** | **String** | |
|
||||
**sourceKey** | **String** | |
|
||||
**status** | **String** | |
|
||||
**ticker** | **String** | | [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)
|
||||
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# fintracker_api.model.PendingResolveRequest
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**action** | **String** | |
|
||||
**instrument** | [**NewInstrument**](NewInstrument.md) | | [optional]
|
||||
**instrumentId** | **int** | | [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)
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# fintracker_api.model.PendingResolveResult
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**aliasCreated** | **bool** | |
|
||||
**eventsBound** | **int** | |
|
||||
**id** | **int** | |
|
||||
**instrumentId** | **int** | | [optional]
|
||||
**metricsRefreshed** | **bool** | |
|
||||
**status** | **String** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.PriceManualIn
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**currency** | **String** | |
|
||||
**d** | [**DateTime**](DateTime.md) | |
|
||||
**note** | **String** | | [optional]
|
||||
**price** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# fintracker_api.model.PriceManualOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**currency** | **String** | |
|
||||
**d** | [**DateTime**](DateTime.md) | |
|
||||
**id** | **int** | |
|
||||
**instrumentId** | **int** | |
|
||||
**note** | **String** | |
|
||||
**price** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
||||
**close** | **String** | decimal as string |
|
||||
**currency** | **String** | |
|
||||
**d** | [**DateTime**](DateTime.md) | |
|
||||
**source_** | **String** | | [optional] [default to 'daily']
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,149 @@
|
||||
# fintracker_api.api.RebalanceApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**rebalanceRebalance**](RebalanceApi.md#rebalancerebalance) | **GET** /api/v1/portfolios/{portfolio_id}/rebalance | Rebalance
|
||||
[**rebalanceSetTargets**](RebalanceApi.md#rebalancesettargets) | **PUT** /api/v1/portfolios/{portfolio_id}/targets | Set Targets
|
||||
[**rebalanceTargets**](RebalanceApi.md#rebalancetargets) | **GET** /api/v1/portfolios/{portfolio_id}/targets | Targets
|
||||
|
||||
|
||||
# **rebalanceRebalance**
|
||||
> RebalanceOut rebalanceRebalance(portfolioId, dimension, cashAvailable)
|
||||
|
||||
Rebalance
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getRebalanceApi();
|
||||
final int portfolioId = 56; // int |
|
||||
final String dimension = dimension_example; // String | asset_class | sector | country | currency
|
||||
final CashAvailable cashAvailable = ; // CashAvailable | переопределяет остаток на счетах для what-if
|
||||
|
||||
try {
|
||||
final response = api.rebalanceRebalance(portfolioId, dimension, cashAvailable);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling RebalanceApi->rebalanceRebalance: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**portfolioId** | **int**| |
|
||||
**dimension** | **String**| asset_class | sector | country | currency | [optional] [default to 'asset_class']
|
||||
**cashAvailable** | [**CashAvailable**](.md)| переопределяет остаток на счетах для what-if | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**RebalanceOut**](RebalanceOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **rebalanceSetTargets**
|
||||
> TargetsOut rebalanceSetTargets(portfolioId, targetsIn)
|
||||
|
||||
Set Targets
|
||||
|
||||
Replace the whole set for one dimension. The weights must add up to 1 within `WEIGHT_TOLERANCE`; otherwise the request is refused with the actual sum in the message, so the user can see by how much the plan misses rather than being handed a silently rescaled one.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getRebalanceApi();
|
||||
final int portfolioId = 56; // int |
|
||||
final TargetsIn targetsIn = ; // TargetsIn |
|
||||
|
||||
try {
|
||||
final response = api.rebalanceSetTargets(portfolioId, targetsIn);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling RebalanceApi->rebalanceSetTargets: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**portfolioId** | **int**| |
|
||||
**targetsIn** | [**TargetsIn**](TargetsIn.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**TargetsOut**](TargetsOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **rebalanceTargets**
|
||||
> TargetsOut rebalanceTargets(portfolioId, dimension)
|
||||
|
||||
Targets
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getRebalanceApi();
|
||||
final int portfolioId = 56; // int |
|
||||
final String dimension = dimension_example; // String | asset_class | sector | country | currency
|
||||
|
||||
try {
|
||||
final response = api.rebalanceTargets(portfolioId, dimension);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling RebalanceApi->rebalanceTargets: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**portfolioId** | **int**| |
|
||||
**dimension** | **String**| asset_class | sector | country | currency | [optional] [default to 'asset_class']
|
||||
|
||||
### Return type
|
||||
|
||||
[**TargetsOut**](TargetsOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# fintracker_api.model.RebalanceBucketOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**bucket** | **String** | |
|
||||
**currentValueRub** | **String** | decimal as string |
|
||||
**currentWeight** | **String** | decimal as string |
|
||||
**deltaValueRub** | **String** | decimal as string |
|
||||
**drift** | **String** | decimal as string |
|
||||
**targetWeight** | **String** | decimal as string |
|
||||
**trades** | [**List<TradeOut>**](TradeOut.md) | |
|
||||
**withinBand** | **bool** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
# fintracker_api.model.RebalanceOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asOf** | [**DateTime**](DateTime.md) | |
|
||||
**buckets** | [**List<RebalanceBucketOut>**](RebalanceBucketOut.md) | |
|
||||
**cashAvailableRub** | **String** | decimal as string |
|
||||
**dimension** | **String** | |
|
||||
**portfolioId** | **int** | |
|
||||
**totalValueRub** | **String** | decimal as string |
|
||||
**warnings** | **List<String>** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# fintracker_api.model.ReconciliationCash
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**balanceDerived** | **String** | decimal as string |
|
||||
**balanceReport** | **String** | decimal as string |
|
||||
**currency** | **String** | |
|
||||
**delta** | **String** | decimal as string |
|
||||
**matches** | **bool** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.ReconciliationOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asOf** | [**DateTime**](DateTime.md) | |
|
||||
**cash** | [**List<ReconciliationCash>**](ReconciliationCash.md) | | [optional]
|
||||
**matches** | **bool** | | [optional] [default to true]
|
||||
**positions** | [**List<ReconciliationPosition>**](ReconciliationPosition.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# fintracker_api.model.ReconciliationPosition
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**instrumentId** | **int** | |
|
||||
**instrumentName** | **String** | |
|
||||
**isin** | **String** | |
|
||||
**matches** | **bool** | |
|
||||
**qtyDelta** | **String** | decimal as string |
|
||||
**qtyDerived** | **String** | decimal as string |
|
||||
**qtyReport** | **String** | decimal as string |
|
||||
**ticker** | **String** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# fintracker_api.model.SampleEventOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**amount** | **String** | decimal as string |
|
||||
**currency** | **String** | |
|
||||
**dedupeKey** | **String** | |
|
||||
**description** | **String** | | [optional]
|
||||
**fee** | **String** | decimal as string | [optional]
|
||||
**instrumentId** | **int** | | [optional]
|
||||
**instrumentKey** | **String** | | [optional]
|
||||
**instrumentName** | **String** | | [optional]
|
||||
**isDuplicate** | **bool** | |
|
||||
**kind** | **String** | |
|
||||
**lineNo** | **int** | |
|
||||
**price** | **String** | decimal as string | [optional]
|
||||
**quantity** | **String** | decimal as string | [optional]
|
||||
**settleDate** | [**DateTime**](DateTime.md) | | [optional]
|
||||
**tradeDate** | [**DateTime**](DateTime.md) | |
|
||||
**tradeNo** | **String** | | [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)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.TargetIn
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**band** | **String** | decimal as string | [optional]
|
||||
**bucket** | **String** | |
|
||||
**note** | **String** | | [optional]
|
||||
**targetWeight** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.TargetOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**band** | **String** | decimal as string |
|
||||
**bucket** | **String** | |
|
||||
**note** | **String** | |
|
||||
**targetWeight** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
# fintracker_api.model.TargetsIn
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dimension** | **String** | asset_class | sector | country | currency |
|
||||
**targets** | [**List<TargetIn>**](TargetIn.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.TargetsOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**dimension** | **String** | |
|
||||
**portfolioId** | **int** | |
|
||||
**targets** | [**List<TargetOut>**](TargetOut.md) | |
|
||||
**weightsSum** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
# fintracker_api.model.TaxAccountOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountId** | **int** | |
|
||||
**accountName** | **String** | |
|
||||
**couponsGrossRub** | **String** | decimal as string |
|
||||
**dividendsGrossRub** | **String** | decimal as string |
|
||||
**estimatedTaxRub** | **String** | decimal as string |
|
||||
**ldvExemptRub** | **String** | decimal as string |
|
||||
**realizedGainRub** | **String** | decimal as string |
|
||||
**realizedLossRub** | **String** | decimal as string |
|
||||
**taxWithheldRub** | **String** | decimal as string |
|
||||
**taxableBaseRub** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,105 @@
|
||||
# fintracker_api.api.TaxApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**taxLots**](TaxApi.md#taxlots) | **GET** /api/v1/tax/lots | Lots
|
||||
[**taxSummary**](TaxApi.md#taxsummary) | **GET** /api/v1/tax | Summary
|
||||
|
||||
|
||||
# **taxLots**
|
||||
> TaxLotsOut taxLots(year, accountId)
|
||||
|
||||
Lots
|
||||
|
||||
Open lots with the date after which a sale falls under the long-term exemption. `year` selects the rate the \"what if I sold today\" figure is computed at; the lots themselves are always the ones open right now. `lot` is rebuilt from the ledger on every refresh and holds today's state only, so there is no honest way to answer \"which lots were open on 31 December two years ago\" — and inventing one would be worse than the limitation.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getTaxApi();
|
||||
final int year = 56; // int |
|
||||
final int accountId = 56; // int |
|
||||
|
||||
try {
|
||||
final response = api.taxLots(year, accountId);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling TaxApi->taxLots: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**year** | **int**| | [optional]
|
||||
**accountId** | **int**| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**TaxLotsOut**](TaxLotsOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **taxSummary**
|
||||
> TaxYearOut taxSummary(year, accountId)
|
||||
|
||||
Summary
|
||||
|
||||
The year's estimated tax position, per account and in total.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getTaxApi();
|
||||
final int year = 56; // int |
|
||||
final int accountId = 56; // int |
|
||||
|
||||
try {
|
||||
final response = api.taxSummary(year, accountId);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling TaxApi->taxSummary: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**year** | **int**| | [optional]
|
||||
**accountId** | **int**| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**TaxYearOut**](TaxYearOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# fintracker_api.model.TaxLotOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountId** | **int** | |
|
||||
**accountName** | **String** | |
|
||||
**costRub** | **String** | decimal as string |
|
||||
**daysToLdv** | **int** | |
|
||||
**instrumentId** | **int** | |
|
||||
**ldvDate** | [**DateTime**](DateTime.md) | |
|
||||
**ldvEligible** | **bool** | |
|
||||
**lotId** | **int** | |
|
||||
**marketValueRub** | **String** | decimal as string |
|
||||
**name** | **String** | |
|
||||
**openDate** | [**DateTime**](DateTime.md) | |
|
||||
**qtyRemaining** | **String** | decimal as string |
|
||||
**taxIfSoldNowRub** | **String** | decimal as string |
|
||||
**ticker** | **String** | |
|
||||
**unrealizedGainRub** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# fintracker_api.model.TaxLotsOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asOf** | [**DateTime**](DateTime.md) | |
|
||||
**disclaimer** | **String** | |
|
||||
**estimated** | **bool** | | [optional] [default to true]
|
||||
**lots** | [**List<TaxLotOut>**](TaxLotOut.md) | |
|
||||
**taxRate** | **String** | decimal as string |
|
||||
**year** | **int** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# fintracker_api.model.TaxTotals
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**couponsGrossRub** | **String** | decimal as string |
|
||||
**dividendsGrossRub** | **String** | decimal as string |
|
||||
**estimatedTaxRub** | **String** | decimal as string |
|
||||
**ldvExemptRub** | **String** | decimal as string |
|
||||
**realizedGainRub** | **String** | decimal as string |
|
||||
**realizedLossRub** | **String** | decimal as string |
|
||||
**taxWithheldRub** | **String** | decimal as string |
|
||||
**taxableBaseRub** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# fintracker_api.model.TaxYearOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accounts** | [**List<TaxAccountOut>**](TaxAccountOut.md) | |
|
||||
**disclaimer** | **String** | |
|
||||
**estimated** | **bool** | | [optional] [default to true]
|
||||
**taxRate** | **String** | decimal as string |
|
||||
**totals** | [**TaxTotals**](TaxTotals.md) | |
|
||||
**year** | **int** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
# fintracker_api.model.TradeOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**action** | **String** | |
|
||||
**amountRub** | **String** | decimal as string |
|
||||
**blockedByCash** | **bool** | |
|
||||
**instrumentId** | **int** | |
|
||||
**lot** | **int** | |
|
||||
**name** | **String** | |
|
||||
**price** | **String** | decimal as string |
|
||||
**priceCurrency** | **String** | |
|
||||
**suggestedQty** | **String** | decimal as string |
|
||||
**ticker** | **String** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# fintracker_api.model.UnmatchedBrokerOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountId** | **int** | |
|
||||
**amount** | **String** | decimal as string |
|
||||
**currency** | **String** | |
|
||||
**date** | [**DateTime**](DateTime.md) | |
|
||||
**direction** | **String** | |
|
||||
**eventId** | **int** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
# fintracker_api.model.UnmatchedOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**broker** | [**List<UnmatchedBrokerOut>**](UnmatchedBrokerOut.md) | |
|
||||
**zm** | [**List<UnmatchedZmOut>**](UnmatchedZmOut.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# fintracker_api.model.UnmatchedZmOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**amount** | **String** | decimal as string |
|
||||
**brokerAccountId** | **int** | |
|
||||
**cashTxnId** | **int** | |
|
||||
**comment** | **String** | |
|
||||
**currency** | **String** | |
|
||||
**date** | [**DateTime**](DateTime.md) | |
|
||||
**direction** | **String** | |
|
||||
**payee** | **String** | |
|
||||
**route** | **String** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user