# Cashboard API

## Docs

- [Introduction](https://mitchsorg.mintlify.app/introduction.md): Welcome to the home of the Cashboard documentation
- [Quickstart](https://mitchsorg.mintlify.app/quickstart.md): Use Cashboard App locally in under 5 minutes
- [Cashboard API Reference](https://mitchsorg.mintlify.app/api-reference/introduction.md): API Reference that describes all the available endpoints at Cashboard
- [Introduction](https://mitchsorg.mintlify.app/api-reference/user/introduction.md)
- [User Details](https://mitchsorg.mintlify.app/api-reference/user/user-details.md): This endpoint gets a user's details.
- [Creating a new user](https://mitchsorg.mintlify.app/api-reference/user/create-a-new-user.md): This endpoint creates a new user.
- [Update user](https://mitchsorg.mintlify.app/api-reference/user/update-user.md): This endpoint is used to update the user's details.
- [Introduction](https://mitchsorg.mintlify.app/api-reference/account/introduction.md)
- [Account](https://mitchsorg.mintlify.app/api-reference/account/account.md): This endpoint returns the account for the specified user
- [All Accounts](https://mitchsorg.mintlify.app/api-reference/account/all-accounts.md): This endpoint returns all the specified user's accounts
- [Create an Account](https://mitchsorg.mintlify.app/api-reference/account/create-an-account.md): This endpoint creates an account for the specified user.
- [Update Account](https://mitchsorg.mintlify.app/api-reference/account/update-account.md): This endpoint updates the user's account by incrementing the user's balance
- [Account](https://mitchsorg.mintlify.app/api-reference/account/delete-account.md): This endpoint deletes the specified account for the user
- [Introduction](https://mitchsorg.mintlify.app/api-reference/income/introduction.md)
- [Income Source](https://mitchsorg.mintlify.app/api-reference/income/income-source.md): This endpoint gets the details of the specified income source.
- [All income sources](https://mitchsorg.mintlify.app/api-reference/income/all-income-sources.md): This endpoint gets all the income sources for the specified user.
- [Create an Income Source](https://mitchsorg.mintlify.app/api-reference/income/create-an-income-source.md): This endpoint creates an income source for the specified user.
- [Income](https://mitchsorg.mintlify.app/api-reference/income/delete-income.md): This endpoint deletes the specified income source
- [Introduction](https://mitchsorg.mintlify.app/api-reference/expenses/introduction.md)
- [Expense](https://mitchsorg.mintlify.app/api-reference/expenses/expense.md): This endpoint is used to get an expense for a specific user.
- [All Expenses](https://mitchsorg.mintlify.app/api-reference/expenses/all-expenses.md): This endpoint is used to get all expenses for a specific user.
- [Create an Expense](https://mitchsorg.mintlify.app/api-reference/expenses/create-an-expense.md): This endpoint is used to add an expense for a specific user.
- [Expense](https://mitchsorg.mintlify.app/api-reference/expenses/delete-expense.md): This endpoint is used to delete an expense for a specific user.
- [Introduction](https://mitchsorg.mintlify.app/api-reference/investments/introduction.md)
- [Investment](https://mitchsorg.mintlify.app/api-reference/investments/investment.md): This endpoint returns the specified investment.
- [All Investments](https://mitchsorg.mintlify.app/api-reference/investments/all-investments.md): This endpoint gets all the investments for the specified user.
- [Create an Investment](https://mitchsorg.mintlify.app/api-reference/investments/create-an-investment.md): This endpoint is used to create an investment.
- [Update Investment](https://mitchsorg.mintlify.app/api-reference/investments/update-investment.md): This endpoint updates an investment's balance by incrementing its value. It can be used for crediting an investment account.
- [Investment](https://mitchsorg.mintlify.app/api-reference/investments/delete-investment.md): This endpoint deletes the specified investment for a user. All the associated transactions will also be deleted.
- [Introduction](https://mitchsorg.mintlify.app/api-reference/savings/introduction.md)
- [Saving](https://mitchsorg.mintlify.app/api-reference/savings/saving.md): This endpoint returns all the saving for the specified user.
- [All Savings](https://mitchsorg.mintlify.app/api-reference/savings/all-savings.md): This endpoint returns all the saving for the specified user.
- [Create a Saving](https://mitchsorg.mintlify.app/api-reference/savings/create-a-saving.md): This endpoint creates a new saving for the specified user.
- [Update Saving](https://mitchsorg.mintlify.app/api-reference/savings/update-saving.md): This endpoint updates the specified saving.
- [Saving](https://mitchsorg.mintlify.app/api-reference/savings/delete-saving.md): This endpoint is used to deletes the saving for a specific user.

## OpenAPI Specs

- [openapi](https://mitchsorg.mintlify.app/api-reference/openapi.yml)

## Optional

- [Demo](https://cashboard-ucpq.onrender.com/)
- [GitHub Repository](https://github.com/MuthoniMN/cashboard/)