Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body. API Documentation is at https://api.youneedabudget.com
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
Put the package under your project folder and add the following to Cargo.toml under [dependencies]:
openapi = { path = "./generated" }
All URIs are relative to https://api.youneedabudget.com/v1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AccountsApi | getaccountbyid | get /budgets/{budgetid}/accounts/{accountid} | Single account *AccountsApi* | getaccounts | get /budgets/{budgetid}/accounts | Account list *BudgetsApi* | getbudgetbyid | get /budgets/{budgetid} | Single budget *BudgetsApi* | getbudgetsettingsbyid | get /budgets/{budgetid}/settings | Budget Settings BudgetsApi | getbudgets | get /budgets | List budgets *CategoriesApi* | getcategories | get /budgets/{budgetid}/categories | List categories *CategoriesApi* | getcategorybyid | get /budgets/{budgetid}/categories/{categoryid} | Single category CategoriesApi | getmonthcategorybyid | get /budgets/{budgetid}/months/{month}/categories/{categoryid} | Single category for a specific budget month CategoriesApi | updatemonthcategory | patch /budgets/{budgetid}/months/{month}/categories/{categoryid} | Update a category for a specific month DeprecatedApi | bulkcreatetransactions | post /budgets/{budgetid}/transactions/bulk | Bulk create transactions *MonthsApi* | getbudgetmonth | get /budgets/{budgetid}/months/{month} | Single budget month MonthsApi | getbudgetmonths | get /budgets/{budgetid}/months | List budget months *PayeeLocationsApi* | getpayeelocationbyid | get /budgets/{budgetid}/payeelocations/{payeelocationid} | Single payee location *PayeeLocationsApi* | getpayeelocations | get /budgets/{budgetid}/payeelocations | List payee locations *PayeeLocationsApi* | getpayeelocationsbypayee | get /budgets/{budgetid}/payees/{payeeid}/payeelocations | List locations for a payee PayeesApi | getpayeebyid | get /budgets/{budgetid}/payees/{payeeid} | Single payee *PayeesApi* | getpayees | get /budgets/{budgetid}/payees | List payees *ScheduledTransactionsApi* | getscheduledtransactionbyid | get /budgets/{budgetid}/scheduledtransactions/{scheduledtransactionid} | Single scheduled transaction *ScheduledTransactionsApi* | getscheduledtransactions | get /budgets/{budgetid}/scheduledtransactions | List scheduled transactions *TransactionsApi* | createtransaction | post /budgets/{budgetid}/transactions | Create a single transaction or multiple transactions *TransactionsApi* | gettransactionbyid | get /budgets/{budgetid}/transactions/{transactionid} | Single transaction TransactionsApi | gettransactions | get /budgets/{budgetid}/transactions | List transactions TransactionsApi | gettransactionsbyaccount | get /budgets/{budgetid}/accounts/{accountid}/transactions | List account transactions *TransactionsApi* | gettransactionsbycategory | get /budgets/{budgetid}/categories/{categoryid}/transactions | List category transactions TransactionsApi | gettransactionsbypayee | get /budgets/{budgetid}/payees/{payeeid}/transactions | List payee transactions *TransactionsApi* | updatetransaction | put /budgets/{budgetid}/transactions/{transactionid} | Updates an existing transaction TransactionsApi | updatetransactions | patch /budgets/{budgetid}/transactions | Update multiple transactions UserApi | get_user | get /user | User info
To get access to the crate's generated documentation, use:
cargo doc --open
Jesse Luehrs doy@tozt.net
Based on the OpenAPI spec found at https://github.com/ynab/ynab-sdk-js/blob/master/spec-v1-swagger.json by You Need A Budget, LLC