### GET /bucket/ Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Retrieves budget buckets with options to filter by system status or date. ```APIDOC ## GET /bucket/ ### Description Retrieve all budget buckets including system buckets. Supports filtering for user-created buckets or active buckets for a specific date. ### Method GET ### Endpoint /bucket/ ### Query Parameters - **validFrom** (string) - Optional - Date to filter active buckets. ### Response #### Success Response (200) - **id** (string) - Bucket ID - **name** (string) - Bucket name - **isInactive** (boolean) - Status of the bucket ``` -------------------------------- ### OpenBudgeteer API - Account Management Source: https://context7.com/theaxelander/openbudgeteer/llms.txt These examples demonstrate how to interact with the OpenBudgeteer REST API for managing financial accounts. You can retrieve all accounts, create new ones, or close existing ones. Ensure the account balance is zero before closing an account. ```bash # Get all accounts curl -X GET "http://localhost:8080/account/" -H "Accept: application/json" # Response [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "Checking Account", "isActive": 1 }, { "id": "7bc91a21-8923-4721-a912-1d823f55bfa7", "name": "Savings Account", "isActive": 1 } ] ``` ```bash # Create a new account curl -X POST "http://localhost:8080/account/" -H "Content-Type: application/json" -d '{ "name": "Investment Account", "isActive": 1 }' # Response { "id": "9de42b15-3456-4890-bc12-3e567f89ab01", "name": "Investment Account", "isActive": 1 } ``` ```bash # Close an account curl -X DELETE "http://localhost:8080/account/close/3fa85f64-5717-4562-b3fc-2c963f66afa6" # Response - returns the closed account with isActive = 0 { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "Old Account", "isActive": 0 } ``` -------------------------------- ### GET /account/ Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Retrieves a list of all bank and financial accounts configured in the OpenBudgeteer system. ```APIDOC ## GET /account/ ### Description Retrieve all bank/financial accounts configured in the system. Returns a list of accounts with their IDs, names, and active status. ### Method GET ### Endpoint /account/ ### Response #### Success Response (200) - **id** (string) - Unique identifier of the account - **name** (string) - Name of the account - **isActive** (integer) - Status of the account (1 for active, 0 for closed) #### Response Example [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "Checking Account", "isActive": 1 } ] ``` -------------------------------- ### OpenBudgeteer API - Transaction Management Source: https://context7.com/theaxelander/openbudgeteer/llms.txt These examples illustrate how to manage transactions using the OpenBudgeteer REST API. You can retrieve transactions with date filters and pagination, or create new transactions, optionally assigning them to budget buckets. ```bash # Get all transactions with date filter curl -X GET "http://localhost:8080/transaction/?start=2024-01-01&end=2024-12-31&limit=100" -H "Accept: application/json" # Get transactions from specific account curl -X GET "http://localhost:8080/transaction/fromAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6?start=2024-01-01&end=2024-12-31" -H "Accept: application/json" # Response [ { "id": "abc12345-6789-0abc-def1-234567890abc", "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "transactionDate": "2024-03-15", "payee": "Grocery Store", "memo": "Weekly groceries", "amount": -125.50 } ] ``` ```bash # Create transaction with bucket assignment curl -X POST "http://localhost:8080/transaction/withBucket" -H "Content-Type: application/json" -d '{ "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "transactionDate": "2024-03-15", "payee": "Electric Company", "memo": "Monthly utility bill", "amount": -150.00, "budgetedTransactions": [ { "bucketId": "bucket-id-for-utilities", "amount": -150.00 } ] }' ``` -------------------------------- ### GET /recurring/ Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Retrieves a list of all recurring transactions configured in the system. ```APIDOC ## GET /recurring/ ### Description Retrieves all recurring transactions. ### Method GET ### Endpoint /recurring/ ### Response #### Success Response (200) - **id** (string) - Transaction ID - **accountId** (string) - Associated account ID - **recurrenceType** (int) - 1=Weekly, 2=Monthly, 3=Quarterly, 4=Yearly - **amount** (float) - Transaction amount #### Response Example [ { "id": "recurring-rent-id", "accountId": "checking-account-id", "recurrenceType": 2, "amount": -1500.00 } ] ``` -------------------------------- ### GET /transaction/ Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Retrieves transactions with optional filtering by date range and account. ```APIDOC ## GET /transaction/ ### Description Retrieve bank transactions with optional date filtering and pagination. ### Method GET ### Endpoint /transaction/ ### Parameters #### Query Parameters - **start** (string) - Optional - Start date (YYYY-MM-DD) - **end** (string) - Optional - End date (YYYY-MM-DD) - **limit** (integer) - Optional - Maximum number of results ### Response #### Success Response (200) - **id** (string) - Transaction ID - **accountId** (string) - Associated account ID - **transactionDate** (string) - Date of transaction - **payee** (string) - Payee name - **amount** (number) - Transaction amount ``` -------------------------------- ### GET /api/v1.1/transactions Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Retrieve a list of financial transactions with support for filtering and pagination. ```APIDOC ## GET /api/v1.1/transactions ### Description Fetch a list of transactions from the user's accounts. Supports date filtering and pagination to manage large datasets. ### Method GET ### Endpoint /api/v1.1/transactions ### Parameters #### Query Parameters - **page** (integer) - Optional - Page number for pagination - **start_date** (string) - Optional - Filter transactions from this date (YYYY-MM-DD) - **end_date** (string) - Optional - Filter transactions up to this date (YYYY-MM-DD) ### Request Example GET /api/v1.1/transactions?start_date=2023-01-01 ### Response #### Success Response (200) - **transactions** (array) - List of transaction objects #### Response Example { "transactions": [ { "id": 101, "amount": -50.00, "date": "2023-01-05", "bucket_id": 5 } ] } ``` -------------------------------- ### POST /account/ Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Creates a new bank account in the system for tracking financial transactions. ```APIDOC ## POST /account/ ### Description Create a new bank account for tracking transactions. ### Method POST ### Endpoint /account/ ### Request Body - **name** (string) - Required - Name of the account - **isActive** (integer) - Required - Account status (1 for active) ### Request Example { "name": "Investment Account", "isActive": 1 } ### Response #### Success Response (200) - **id** (string) - Generated ID of the new account - **name** (string) - Name of the account - **isActive** (integer) - Status of the account ``` -------------------------------- ### POST /bucket/ Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Creates a new budget bucket within a specific bucket group. ```APIDOC ## POST /bucket/ ### Description Creates a new budget bucket within a bucket group. ### Method POST ### Endpoint /bucket/ ### Request Body - **name** (string) - Required - Name of the bucket. - **bucketGroupId** (string) - Required - Parent group ID. - **colorCode** (string) - Optional - Hex color code. ### Response #### Success Response (200) - **id** (string) - Generated bucket ID ``` -------------------------------- ### Environment Configuration for OpenBudgeteer Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Configuration settings for OpenBudgeteer using environment variables. Covers database connection details (provider, server, credentials), Redis configuration for session management, application settings like culture and demo data, and authentication parameters. Logging levels can also be set. ```bash # Database Configuration CONNECTION_PROVIDER=mariadb # mariadb, mysql, postgres, postgresql CONNECTION_SERVER=localhost CONNECTION_PORT=3306 CONNECTION_DATABASE=openbudgeteer CONNECTION_USER=openbudgeteer CONNECTION_PASSWORD=securepassword CONNECTION_ROOT_PASSWORD=rootpassword # For auto database/user creation # Redis Configuration (required for session management) CONNECTION_REDIS_SERVER=localhost CONNECTION_REDIS_PORT=6379 CONNECTION_REDIS_USER= # Optional CONNECTION_REDIS_PASSWORD= # Optional CONNECTION_REDIS_PREFIX=openbudgeteer # Optional prefix for keys # Application Settings APPSETTINGS_CULTURE=en-US # Localization (en-US, de-DE, etc.) APPSETTINGS_DEMO_DATA=false # Load demo data on empty database # Authentication (optional but recommended) APPSETTINGS_AUTH_ENABLED=true APPSETTINGS_AUTH_USERNAME=admin APPSETTINGS_AUTH_PASSWORD=securepassword APPSETTINGS_AUTH_SESSION_DAYS=7 # Logging Logging__LogLevel__Default=Information ``` -------------------------------- ### POST /rules/ Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Creates a new rule set for automatic bucket assignment based on transaction criteria. ```APIDOC ## POST /rules/ ### Description Creates a rule set to automatically assign transactions to buckets. ### Method POST ### Endpoint /rules/ ### Request Body - **priority** (int) - Rule priority - **name** (string) - Rule name - **targetBucketId** (string) - Target bucket identifier - **mappingRules** (array) - List of conditions for the rule ### Request Example { "priority": 1, "name": "Grocery Store Rule", "targetBucketId": "groceries-bucket-id", "mappingRules": [] } ``` -------------------------------- ### POST /import/ Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Creates a new import profile to define how CSV files from specific banks should be parsed. ```APIDOC ## POST /import/ ### Description Configures a new CSV import profile for automated bank statement processing. ### Method POST ### Endpoint /import/ ### Request Body - **profileName** (string) - Name of the profile - **accountId** (string) - Target account ID - **delimiter** (string) - CSV delimiter - **dateFormat** (string) - Date format string ### Request Example { "profileName": "Chase Bank Export", "accountId": "chase-account-id", "delimiter": ",", "dateFormat": "MM/dd/yyyy" } ``` -------------------------------- ### POST /movement/ Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Records a budget movement or transfer between buckets. ```APIDOC ## POST /movement/ ### Description Creates a budget movement to add or transfer money to a bucket. ### Method POST ### Endpoint /movement/ ### Request Body - **bucketId** (string) - Required - Target bucket ID. - **amount** (number) - Required - Amount to move. - **movementDate** (string) - Required - Date of movement. ``` -------------------------------- ### Retrieve and Manage Budget Buckets Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Endpoints to retrieve all buckets, filter by type or date, and create new budget buckets. These operations are essential for organizing financial categories. ```bash curl -X GET "http://localhost:8080/bucket/" -H "Accept: application/json" curl -X GET "http://localhost:8080/bucket/withoutSystemBuckets" -H "Accept: application/json" curl -X GET "http://localhost:8080/bucket/activeBuckets?validFrom=2024-03-01" -H "Accept: application/json" curl -X POST "http://localhost:8080/bucket/" -H "Content-Type: application/json" -d '{"name": "Emergency Fund", "bucketGroupId": "savings-group-id", "colorCode": "#2196F3", "textColorCode": "#FFFFFF", "validFrom": "2024-01-01", "isInactive": false, "isHiddenFromSummaries": false}' ``` -------------------------------- ### Retrieve Bucket Financial Figures Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Retrieve balance, activity, and in/out flow figures for a specific bucket for a given month. Useful for monitoring budget performance. ```bash curl -X GET "http://localhost:8080/bucket/balance/bucket-groceries-id?yearMonth=2024-03-01" -H "Accept: application/json" curl -X GET "http://localhost:8080/bucket/figures/bucket-groceries-id?yearMonth=2024-03-01" -H "Accept: application/json" curl -X GET "http://localhost:8080/bucket/inOut/bucket-groceries-id?yearMonth=2024-03-01" -H "Accept: application/json" ``` -------------------------------- ### Docker Compose for MariaDB Deployment Source: https://context7.com/theaxelander/openbudgeteer/llms.txt This Docker Compose configuration sets up OpenBudgeteer with a MariaDB database and Redis for session management. It specifies environment variables for database connection details, authentication, and localization. Ensure to change default passwords for production environments. ```yaml version: "3" services: openbudgeteer: image: axelander/openbudgeteer:latest container_name: openbudgeteer ports: - 8080:8080 environment: - CONNECTION_PROVIDER=mariadb - CONNECTION_SERVER=openbudgeteer-mysql - CONNECTION_PORT=3306 - CONNECTION_DATABASE=openbudgeteer - CONNECTION_USER=openbudgeteer - CONNECTION_PASSWORD=openbudgeteer - CONNECTION_ROOT_PASSWORD=myRootPassword - CONNECTION_REDIS_SERVER=redis - CONNECTION_REDIS_PORT=6379 - APPSETTINGS_CULTURE=en-US - APPSETTINGS_AUTH_ENABLED=true - APPSETTINGS_AUTH_USERNAME=admin - APPSETTINGS_AUTH_PASSWORD=changeme - APPSETTINGS_AUTH_SESSION_DAYS=7 depends_on: - mysql - redis mysql: image: mariadb container_name: openbudgeteer-mysql environment: MARIADB_ROOT_PASSWORD: myRootPassword volumes: - data:/var/lib/mysql redis: image: redis:alpine container_name: openbudgeteer-redis volumes: data: ``` -------------------------------- ### Manage Rules for Automatic Bucket Assignment (API) Source: https://context7.com/theaxelander/openbudgeteer/llms.txt APIs for managing rule sets that automatically assign transactions to buckets based on various criteria like payee, memo, or amount. Supports retrieving all rule sets, specific mapping rules, and creating new rule sets with associated mapping rules. Rules use comparison fields and types to match transactions. ```bash curl -X GET "http://localhost:8080/rules/" -H "Accept: application/json" ``` ```bash curl -X GET "http://localhost:8080/rules/mappings/ruleset-id" -H "Accept: application/json" ``` ```bash curl -X POST "http://localhost:8080/rules/" -H "Content-Type: application/json" -d '{ "priority": 1, "name": "Grocery Store Rule", "targetBucketId": "groceries-bucket-id", "mappingRules": [ { "comparisonField": 2, "comparisonType": 3, "comparisonValue": "Grocery" }, { "comparisonField": 3, "comparisonType": 3, "comparisonValue": "food" } ] }' ``` -------------------------------- ### POST /transaction/withBucket Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Creates a new transaction and splits the total amount across multiple specified budget buckets. ```APIDOC ## POST /transaction/withBucket ### Description Creates a new transaction and splits the total amount across multiple specified budget buckets. ### Method POST ### Endpoint /transaction/withBucket ### Request Body - **accountId** (string) - Required - The ID of the account. - **transactionDate** (string) - Required - Date of the transaction (YYYY-MM-DD). - **payee** (string) - Required - Name of the payee. - **memo** (string) - Optional - Transaction memo. - **amount** (number) - Required - Total transaction amount. - **budgetedTransactions** (array) - Required - List of bucket allocations. ### Request Example { "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "transactionDate": "2024-03-20", "payee": "Department Store", "memo": "Household items and groceries", "amount": -200.00, "budgetedTransactions": [ {"bucketId": "bucket-id-for-groceries", "amount": -120.00}, {"bucketId": "bucket-id-for-household", "amount": -80.00} ] } ``` -------------------------------- ### Manage Recurring Transactions (API) Source: https://context7.com/theaxelander/openbudgeteer/llms.txt APIs for retrieving, creating, and managing recurring financial transactions. Supports operations like fetching all recurring transactions, creating new ones, and generating pending transactions for a specific month. Dependencies include a running OpenBudgeteer instance. ```bash curl -X GET "http://localhost:8080/recurring/" -H "Accept: application/json" ``` ```bash curl -X POST "http://localhost:8080/recurring/" -H "Content-Type: application/json" -d '{ "accountId": "checking-account-id", "recurrenceType": 2, "recurrenceAmount": 1, "firstOccurrenceDate": "2024-04-01", "payee": "Insurance Company", "memo": "Monthly insurance premium", "amount": -200.00 }' ``` ```bash curl -X GET "http://localhost:8080/recurring/pendingTransactions?yearMonth=2024-04-01" -H "Accept: application/json" ``` ```bash curl -X POST "http://localhost:8080/recurring/pendingTransactions?yearMonth=2024-04-01" ``` -------------------------------- ### POST /api/v1.1/transactions Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Create a new transaction record within the OpenBudgeteer system. ```APIDOC ## POST /api/v1.1/transactions ### Description Create a new transaction, optionally assigning it to a specific budget bucket. ### Method POST ### Endpoint /api/v1.1/transactions ### Parameters #### Request Body - **account_id** (integer) - Required - The ID of the account - **amount** (decimal) - Required - Transaction amount - **date** (string) - Required - Transaction date (YYYY-MM-DD) - **bucket_id** (integer) - Optional - Bucket to assign the transaction to ### Request Example { "account_id": 1, "amount": -25.50, "date": "2023-02-01", "bucket_id": 12 } ### Response #### Success Response (201) - **id** (integer) - The ID of the newly created transaction #### Response Example { "id": 102, "status": "created" } ``` -------------------------------- ### Split Transaction Across Multiple Buckets Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Creates a new transaction that is split across multiple budget buckets. Requires a JSON payload containing the account ID, transaction details, and an array of budgeted transactions. ```bash curl -X POST "http://localhost:8080/transaction/withBucket" \ -H "Content-Type: application/json" \ -d '{ "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "transactionDate": "2024-03-20", "payee": "Department Store", "memo": "Household items and groceries", "amount": -200.00, "budgetedTransactions": [ { "bucketId": "bucket-id-for-groceries", "amount": -120.00 }, { "bucketId": "bucket-id-for-household", "amount": -80.00 } ] }' ``` -------------------------------- ### Manage Import Profiles for CSV Import (API) Source: https://context7.com/theaxelander/openbudgeteer/llms.txt APIs for managing import profiles used for automated CSV file imports from banks. Profiles define how CSV columns map to transaction fields, along with delimiters, date formats, and number formats. Supports retrieving all import profiles and creating new ones. ```bash curl -X GET "http://localhost:8080/import/" -H "Accept: application/json" ``` ```bash curl -X POST "http://localhost:8080/import/" -H "Content-Type: application/json" -d '{ "profileName": "Chase Bank Export", "accountId": "chase-account-id", "headerRow": 1, "delimiter": ",", "textQualifier": "\"", "dateFormat": "MM/dd/yyyy", "numberFormat": "en-US", "transactionDateColumnName": "Posting Date", "payeeColumnName": "Description", "memoColumnName": "Details", "amountColumnName": "Amount", "additionalSettingCreditValue": 0, "additionalSettingAmountCleanup": true, "additionalSettingAmountCleanupValue": "$" }' ``` -------------------------------- ### Manage Budget Movements Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Track money transfers between buckets or record budget allocations. Supports filtering by date range or specific bucket. ```bash curl -X GET "http://localhost:8080/movement/?periodStart=2024-01-01&periodEnd=2024-03-31" -H "Accept: application/json" curl -X GET "http://localhost:8080/movement/fromBucket/bucket-id?periodStart=2024-03-01&periodEnd=2024-03-31" -H "Accept: application/json" curl -X POST "http://localhost:8080/movement/" -H "Content-Type: application/json" -d '{"bucketId": "emergency-fund-bucket-id", "amount": 500.00, "movementDate": "2024-03-15"}' ``` -------------------------------- ### Manage Bucket Groups Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Operations to retrieve, create, and reorder bucket groups. Bucket groups help categorize related buckets for better financial organization. ```bash curl -X GET "http://localhost:8080/group/?full=true" -H "Accept: application/json" curl -X POST "http://localhost:8080/group/" -H "Content-Type: application/json" -d '{"name": "Vacation Savings", "position": 5}' curl -X PATCH "http://localhost:8080/group/move/group-id?positions=-2" ``` -------------------------------- ### DELETE /account/close/{id} Source: https://context7.com/theaxelander/openbudgeteer/llms.txt Closes an existing account. The account balance must be zero before it can be closed. ```APIDOC ## DELETE /account/close/{id} ### Description Close an account that is no longer in use. The account balance must be zero before closing. ### Method DELETE ### Endpoint /account/close/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the account to close ### Response #### Success Response (200) - **id** (string) - ID of the closed account - **isActive** (integer) - Returns 0 indicating the account is now closed ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.