swagger-client

finAPI RESTful Services

This Python package is automatically generated by the Swagger Codegen project:

• API version: v1.42.1
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import swagger_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: finapi_auth
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountsApi()
id = 789 # int | Identifier of the account to delete

try:
    # Delete an account
    api_instance.delete_account(id)
except ApiException as e:
    print("Exception when calling AccountsApi->delete_account: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://localhost

Class	Method	HTTP request	Description
AccountsApi	delete_account	DELETE /api/v1/accounts/{id}	Delete an account
AccountsApi	delete_all_accounts	DELETE /api/v1/accounts	Delete all accounts
AccountsApi	edit_account	PATCH /api/v1/accounts/{id}	Edit an account
AccountsApi	execute_sepa_direct_debit	POST /api/v1/accounts/executeSepaDirectDebit	Execute SEPA Direct Debit
AccountsApi	execute_sepa_money_transfer	POST /api/v1/accounts/executeSepaMoneyTransfer	Execute SEPA Money Transfer
AccountsApi	get_account	GET /api/v1/accounts/{id}	Get an account
AccountsApi	get_and_search_all_accounts	GET /api/v1/accounts	Get and search all accounts
AccountsApi	get_daily_balances	GET /api/v1/accounts/dailyBalances	Get daily balances
AccountsApi	get_multiple_accounts	GET /api/v1/accounts/{ids}	Get multiple accounts
AccountsApi	request_sepa_direct_debit	POST /api/v1/accounts/requestSepaDirectDebit	Request SEPA Direct Debit
AccountsApi	request_sepa_money_transfer	POST /api/v1/accounts/requestSepaMoneyTransfer	Request SEPA Money Transfer
AuthorizationApi	get_token	POST /oauth/token	Get tokens
AuthorizationApi	revoke_token	POST /oauth/revoke	Revoke a token
BankConnectionsApi	delete_all_bank_connections	DELETE /api/v1/bankConnections	Delete all bank connections
BankConnectionsApi	delete_bank_connection	DELETE /api/v1/bankConnections/{id}	Delete a bank connection
BankConnectionsApi	edit_bank_connection	PATCH /api/v1/bankConnections/{id}	Edit a bank connection
BankConnectionsApi	get_all_bank_connections	GET /api/v1/bankConnections	Get all bank connections
BankConnectionsApi	get_bank_connection	GET /api/v1/bankConnections/{id}	Get a bank connection
BankConnectionsApi	get_multiple_bank_connections	GET /api/v1/bankConnections/{ids}	Get multiple bank connections
BankConnectionsApi	import_bank_connection	POST /api/v1/bankConnections/import	Import a new bank connection
BankConnectionsApi	update_bank_connection	POST /api/v1/bankConnections/update	Update a bank connection
BanksApi	get_and_search_all_banks	GET /api/v1/banks	Get and search all banks
BanksApi	get_bank	GET /api/v1/banks/{id}	Get a bank
BanksApi	get_multiple_banks	GET /api/v1/banks/{ids}	Get multiple banks
CategoriesApi	create_category	POST /api/v1/categories	Create a new category
CategoriesApi	delete_all_categories	DELETE /api/v1/categories	Delete all categories
CategoriesApi	delete_category	DELETE /api/v1/categories/{id}	Delete a category
CategoriesApi	get_and_search_all_categories	GET /api/v1/categories	Get and search all categories
CategoriesApi	get_cash_flows	GET /api/v1/categories/cashFlows	Get cash flows
CategoriesApi	get_category	GET /api/v1/categories/{id}	Get a category
CategoriesApi	get_multiple_categories	GET /api/v1/categories/{ids}	Get multiple categories
CategoriesApi	train_categorization	POST /api/v1/categories/trainCategorization	Train categorization
ClientConfigurationApi	edit_client_configuration	PATCH /api/v1/clientConfiguration	Edit client configuration
ClientConfigurationApi	get_client_configuration	GET /api/v1/clientConfiguration	Get client configuration
LabelsApi	create_label	POST /api/v1/labels	Create a new label
LabelsApi	delete_all_labels	DELETE /api/v1/labels	Delete all labels
LabelsApi	delete_label	DELETE /api/v1/labels/{id}	Delete a label
LabelsApi	edit_label	PATCH /api/v1/labels/{id}	Edit a label
LabelsApi	get_and_search_all_labels	GET /api/v1/labels	Get and search all labels
LabelsApi	get_label	GET /api/v1/labels/{id}	Get a label
LabelsApi	get_multiple_labels	GET /api/v1/labels/{ids}	Get multiple labels
MandatorAdministrationApi	change_client_credentials	POST /api/v1/mandatorAdmin/changeClientCredentials	Change client credentials
MandatorAdministrationApi	delete_users	POST /api/v1/mandatorAdmin/deleteUsers	Delete users
MandatorAdministrationApi	get_user_list	GET /api/v1/mandatorAdmin/getUserList	Get user list
MocksAndTestsApi	check_categorization	POST /api/v1/tests/checkCategorization	Check categorization
MocksAndTestsApi	mock_batch_update	POST /api/v1/tests/mockBatchUpdate	Mock batch update
NotificationRulesApi	create_notification_rule	POST /api/v1/notificationRules	Create a new notification rule
NotificationRulesApi	delete_all_notification_rules	DELETE /api/v1/notificationRules	Delete all notification rules
NotificationRulesApi	delete_notification_rule	DELETE /api/v1/notificationRules/{id}	Delete a notification rule
NotificationRulesApi	get_and_search_all_notification_rules	GET /api/v1/notificationRules	Get and search all notification rules
NotificationRulesApi	get_notification_rule	GET /api/v1/notificationRules/{id}	Get a notification rule
SecuritiesApi	get_and_search_all_securities	GET /api/v1/securities	Get and search all securities
SecuritiesApi	get_multiple_securities	GET /api/v1/securities/{ids}	Get multiple securities
SecuritiesApi	get_security	GET /api/v1/securities/{id}	Get a security
TransactionsApi	delete_all_transactions	DELETE /api/v1/transactions	Delete all transactions
TransactionsApi	delete_transaction	DELETE /api/v1/transactions/{id}	Delete a transaction
TransactionsApi	edit_multiple_transactions	PATCH /api/v1/transactions	Edit multiple transactions
TransactionsApi	edit_multiple_transactions_deprecated	PATCH /api/v1/transactions/{ids}	Edit multiple transactions (DEPRECATED)
TransactionsApi	edit_transaction	PATCH /api/v1/transactions/{id}	Edit a transaction
TransactionsApi	get_and_search_all_transactions	GET /api/v1/transactions	Get and search all transactions
TransactionsApi	get_multiple_transactions	GET /api/v1/transactions/{ids}	Get multiple transactions
TransactionsApi	get_transaction	GET /api/v1/transactions/{id}	Get a transaction
TransactionsApi	restore_transaction	POST /api/v1/transactions/{id}/restore	Restore a transaction
TransactionsApi	split_transaction	POST /api/v1/transactions/{id}/split	Split a transaction
TransactionsApi	trigger_categorization	POST /api/v1/transactions/triggerCategorization	Trigger categorization
UsersApi	create_user	POST /api/v1/users	Create a new user
UsersApi	delete_authorized_user	DELETE /api/v1/users	Delete the authorized user
UsersApi	delete_unverified_user	DELETE /api/v1/users/{userId}	Delete an unverified user
UsersApi	edit_authorized_user	PATCH /api/v1/users	Edit the authorized user
UsersApi	execute_password_change	POST /api/v1/users/executePasswordChange	Execute password change
UsersApi	get_authorized_user	GET /api/v1/users	Get the authorized user
UsersApi	get_verification_status	GET /api/v1/users/verificationStatus	Get a user's verification status
UsersApi	request_password_change	POST /api/v1/users/requestPasswordChange	Request password change
UsersApi	verify_user	POST /api/v1/users/verify/{userId}	Verify a user

Documentation For Models

• AccessToken
• Account
• AccountList
• AccountParams
• BadCredentialsError
• Bank
• BankConnection
• BankConnectionList
• BankList
• BankResponse
• CashFlow
• CashFlowList
• CategorizationCheckResult
• CategorizationCheckResults
• CategorizationSample
• Category
• CategoryList
• CategoryParams
• ChangeClientCredentialsParams
• ClearingAccountData
• ClientConfiguration
• ClientConfigurationParams
• DailyBalance
• DailyBalanceList
• DirectDebitOrderingResponse
• EditBankConnectionParams
• ErrorDetails
• ErrorMessage
• ExecutePasswordChangeParams
• ExecuteSepaDirectDebitParams
• ExecuteSepaMoneyTransferParams
• IdentifierList
• ImportBankConnectionParams
• Label
• LabelList
• LabelParams
• MockAccountData
• MockBankConnectionUpdate
• MockBatchUpdateParams
• MoneyTransferOrderingResponse
• MonthlyUserStats
• NewTransaction
• NotificationRule
• NotificationRuleList
• NotificationRuleParams
• PageableBankList
• PageableCategoryList
• PageableLabelList
• PageableSecurityList
• PageableTransactionList
• PageableUserInfoList
• Paging
• PasswordChangingResource
• PaypalTransactionData
• RequestPasswordChangeParameters
• RequestSepaDirectDebitParams
• RequestSepaMoneyTransferParams
• Security
• SecurityList
• SingleDirectDebitData
• SingleMoneyTransferRecipientData
• SplitTransactionsParams
• SubTransactionParams
• Transaction
• TransactionData
• TransactionDataWithIdentifier
• TransactionList
• TransactionsData
• TriggerCategorizationParams
• TwoStepProcedure
• UpdateBankConnectionParams
• UpdateMultipleTransactionsParams
• UpdateResult
• UpdateTransactionsParams
• User
• UserCreateParamsImpl
• UserIdentifiersList
• UserIdentifiersParams
• UserInfo
• UserUpdateParamsImpl
• VerificationStatusResource

Documentation For Authorization

finapi_auth

• Type: OAuth
• Flow: accessCode
• Authorization URL: /oauth/authorize
• Scopes:
• all: modify any sources

Author