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

fintracker_api.api.AccountsApi

Load the API package

import 'package:fintracker_api/api.dart';

All URIs are relative to http://localhost

Method	HTTP request	Description
accountsCreate	POST /api/v1/accounts	Create
accountsList	GET /api/v1/accounts	List
accountsPatch	PATCH /api/v1/accounts/{account_id}	Patch

accountsCreate

AccountOut accountsCreate(accountCreate)

Create

Create the broker account a report import will write into. source_id is the agreement number the report prints: it is how the import finds the account on its own the next time.

Example

import 'package:fintracker_api/api.dart';

final api = FintrackerApi().getAccountsApi();
final AccountCreate accountCreate = ; // AccountCreate | 

try {
    final response = api.accountsCreate(accountCreate);
    print(response);
} on DioException catch (e) {
    print('Exception when calling AccountsApi->accountsCreate: $e\n');
}

Parameters

Name	Type	Description	Notes
accountCreate	AccountCreate

Return type

AccountOut

Authorization

HTTPBearer

HTTP request headers

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

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

accountsList

List accountsList()

List

Every account, archived ones included — the client decides what to show.

Example

import 'package:fintracker_api/api.dart';

final api = FintrackerApi().getAccountsApi();

try {
    final response = api.accountsList();
    print(response);
} on DioException catch (e) {
    print('Exception when calling AccountsApi->accountsList: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

List<AccountOut>

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]

accountsPatch

AccountOut accountsPatch(accountId, accountPatch)

Patch

Update the user-owned fields. Everything else is overwritten by the next sync.

Example

import 'package:fintracker_api/api.dart';

final api = FintrackerApi().getAccountsApi();
final int accountId = 56; // int | 
final AccountPatch accountPatch = ; // AccountPatch | 

try {
    final response = api.accountsPatch(accountId, accountPatch);
    print(response);
} on DioException catch (e) {
    print('Exception when calling AccountsApi->accountsPatch: $e\n');
}

Parameters

Name	Type	Description	Notes
accountId	int
accountPatch	AccountPatch

Return type

AccountOut

Authorization

HTTPBearer

HTTP request headers

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

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