organizze_api 1.0.3

SDK to interface with the Organizze REST API

organizze_api

Python client library for the Organizze API.

This Python package is automatically generated by the OpenAPI Generator project.

Requirements

Python 3.9+

Installation

From PyPI (Recommended)

pip install organizze_api

From Source

# Clone the repository
git clone https://github.com/BarretoTech/organizze-api-sdk.git
cd organizze-api-sdk/clients/python

# Install
pip install -e .

From Git

pip install git+https://github.com/BarretoTech/organizze-api-sdk.git#subdirectory=clients/python

Quick Start

import organizze_api
from organizze_api.rest import ApiException

# Configure authentication
configuration = organizze_api.Configuration(
    host="https://api.organizze.com.br/rest/v2",
    username="[e-mail]",
    password="your_api_token"
)

# Set required User-Agent header
configuration.api_key['userAgent'] = 'MyApp ([e-mail])'

# Use the API
with organizze_api.ApiClient(configuration) as api_client:
    # List bank accounts
    bank_accounts_api = organizze_api.BankAccountsApi(api_client)
    accounts = bank_accounts_api.list_bank_accounts()
    print(accounts)

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import organizze_api
from organizze_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.organizze.com.br/rest/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = organizze_api.Configuration(
    host = "https://api.organizze.com.br/rest/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = organizze_api.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: userAgent
configuration.api_key['userAgent'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['userAgent'] = 'Bearer'


# Enter a context with an instance of the API client
with organizze_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = organizze_api.BankAccountsApi(api_client)
    bank_account = organizze_api.BankAccount() # BankAccount |

    try:
        # Create Bank Account
        api_response = api_instance.create_bank_account(bank_account)
        print("The response of BankAccountsApi->create_bank_account:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BankAccountsApi->create_bank_account: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.organizze.com.br/rest/v2

Class	Method	HTTP request	Description
BankAccountsApi	create_bank_account	POST /accounts	Create Bank Account
BankAccountsApi	delete_bank_account	DELETE /accounts/{bankAccountID}	Delete Bank Account
BankAccountsApi	list_bank_accounts	GET /accounts	List Bank Accounts
BankAccountsApi	read_bank_account	GET /accounts/{bankAccountID}	Read Account
BankAccountsApi	update_bank_account	PUT /accounts/{bankAccountID}	Update Bank Account
BudgetsApi	list_annual_budgets	GET /budgets/{year}	Get Annual Budgets
BudgetsApi	list_current_month_budgets	GET /budgets	Get Current Month Budgets
BudgetsApi	list_monthly_budgets	GET /budgets/{year}/{month}	Get Monthly Budgets
CategoriesApi	create_category	POST /categories	Create Category
CategoriesApi	delete_category	DELETE /categories/{categoryID}	Delete Category
CategoriesApi	list_categories	GET /categories	List Categories
CategoriesApi	read_category	GET /categories/{categoryID}	Read Category
CategoriesApi	update_category	PUT /categories/{categoryID}	Update Category
CreditCardsApi	create_credit_card	POST /credit_cards	Create Credit Card
CreditCardsApi	delete_credit_card	DELETE /credit_cards/{creditCardID}	Delete Credit Card
CreditCardsApi	list_credit_card_invoice_payments	GET /credit_cards/{creditCardID}/invoices/{creditCardInvoiceID}/payments	List Credit Card Invoice Payments
CreditCardsApi	list_credit_card_invoices	GET /credit_cards/{creditCardID}/invoices	List Credit Card Invoices
CreditCardsApi	list_credit_cards	GET /credit_cards	List Credit Cards
CreditCardsApi	read_credit_card	GET /credit_cards/{creditCardID}	Read Credit Card
CreditCardsApi	read_credit_card_invoice	GET /credit_cards/{creditCardID}/invoices/{creditCardInvoiceID}	Read Credit Card Invoice
CreditCardsApi	update_credit_card	PUT /credit_cards/{creditCardID}	Update Credit Card
TransactionsApi	create_transaction	POST /transactions	Create Transaction
TransactionsApi	delete_transaction	DELETE /transactions/{transactionID}	Delete Transaction
TransactionsApi	list_transactions	GET /transactions	List Transactions
TransactionsApi	read_transaction	GET /transactions/{transactionID}	Read Transaction
TransactionsApi	update_transaction	PUT /transactions/{transactionID}	Update Transaction
UsersApi	list_users	GET /users	List Users
UsersApi	read_user	GET /users/{userID}	Read User

Documentation For Models

• BankAccount
• Budget
• Category
• CreateTransactionRequest
• CreditCard
• CreditCardInvoice
• CreditCardInvoiceFull
• DeleteTransactionRequest
• FailedAuthentication
• InstallmentTransaction
• InstallmentTransactionAllOfInstallmentsAttributes
• NotFound
• RecurringTransaction
• RecurringTransactionAllOfRecurrenceAttributes
• Transaction
• UpdateTransactionRequest
• User
• ValidationError

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

userAgent

• Type: API key
• API key parameter name: User-Agent
• Location: HTTP header