fin-tracker/app/packages/api_client/doc/TaxApi.md

fintracker_api.api.TaxApi

Load the API package

import 'package:fintracker_api/api.dart';

All URIs are relative to http://localhost

Method	HTTP request	Description
taxLots	GET /api/v1/tax/lots	Lots
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

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

Authorization

HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

taxSummary

TaxYearOut taxSummary(year, accountId)

Summary

The year's estimated tax position, per account and in total.

Example

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

Authorization

HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]