controllers

func (AccountCreateV3) ToCreate ¶ added in v3.19.1

func (a AccountCreateV3) ToCreate() models.AccountCreate

ToCreate transforms the API representation into the model representation

func (AccountQueryFilter) ToCreate ¶

func (f AccountQueryFilter) ToCreate(c *gin.Context) (models.AccountCreate, bool)

func (AccountQueryFilterV3) ToCreate ¶ added in v3.14.0

func (f AccountQueryFilterV3) ToCreate() (models.AccountCreate, httperrors.Error)

func (AllocationQueryFilter) Parse ¶

func (f AllocationQueryFilter) Parse(c *gin.Context) (models.AllocationCreate, bool)

func (CategoryCreateV3) ToCreate ¶ added in v3.19.1

func (c CategoryCreateV3) ToCreate() models.CategoryCreate

ToCreate transforms the API representation into the model representation

func (CategoryQueryFilter) ToCreate ¶

func (f CategoryQueryFilter) ToCreate(c *gin.Context) (models.CategoryCreate, bool)

func (CategoryQueryFilterV3) ToCreate ¶ added in v3.16.0

func (f CategoryQueryFilterV3) ToCreate() (models.CategoryCreate, httperrors.Error)

func (Controller) CleanupV3 ¶ added in v3.13.0

func (co Controller) CleanupV3(c *gin.Context)

@Summary Delete everything @Description Permanently deletes all resources @Tags v3 @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param confirm query string false "Confirmation to delete all resources. Must have the value 'yes-please-delete-everything'" @Router /v3 [delete]

func (Controller) CreateAccount ¶

func (co Controller) CreateAccount(c *gin.Context)

CreateAccount creates a new account

@Summary		Create account
@Description	Creates a new account
@Tags			Accounts
@Produce		json
@Success		201		{object}	AccountResponse
@Failure		400		{object}	httperrors.HTTPError
@Failure		404		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			account	body		models.AccountCreate	true	"Account"
@Router			/v1/accounts [post]
@Deprecated		true

func (Controller) CreateAccountsV3 ¶ added in v3.14.0

func (co Controller) CreateAccountsV3(c *gin.Context)

@Summary Creates accounts @Description Creates new accounts @Tags Accounts @Produce json @Success 201 {object} AccountCreateResponseV3 @Failure 400 {object} AccountCreateResponseV3 @Failure 404 {object} AccountCreateResponseV3 @Failure 500 {object} AccountCreateResponseV3 @Param accounts body []AccountCreateV3 true "Accounts" @Router /v3/accounts [post]

func (Controller) CreateAllocation ¶

func (co Controller) CreateAllocation(c *gin.Context)

CreateAllocation creates a new allocation

@Summary		Create allocations
@Description	Create a new allocation of funds to an envelope for a specific month
@Tags			Allocations
@Produce		json
@Success		201			{object}	AllocationResponse
@Failure		400			{object}	httperrors.HTTPError
@Failure		404			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			allocation	body		models.AllocationCreate	true	"Allocation"
@Router			/v1/allocations [post]
@Deprecated		true

func (Controller) CreateBudget ¶

func (co Controller) CreateBudget(c *gin.Context)

CreateBudget creates a new budget

@Summary		Create budget
@Description	Creates a new budget
@Tags			Budgets
@Accept			json
@Produce		json
@Success		201		{object}	BudgetResponse
@Failure		400		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			budget	body		models.BudgetCreate	true	"Budget"
@Router			/v1/budgets [post]
@Deprecated		true

func (Controller) CreateBudgetsV3 ¶ added in v3.12.0

func (co Controller) CreateBudgetsV3(c *gin.Context)

@Summary Create budget @Description Creates a new budget @Tags Budgets @Accept json @Produce json @Success 201 {object} BudgetCreateResponseV3 @Failure 400 {object} BudgetCreateResponseV3 @Failure 500 {object} BudgetCreateResponseV3 @Param budget body models.BudgetCreate true "Budget" @Router /v3/budgets [post]

func (Controller) CreateCategoriesV3 ¶ added in v3.16.0

func (co Controller) CreateCategoriesV3(c *gin.Context)

@Summary Create category @Description Creates a new category @Tags Categories @Produce json @Success 201 {object} CategoryCreateResponseV3 @Failure 400 {object} CategoryCreateResponseV3 @Failure 404 {object} CategoryCreateResponseV3 @Failure 500 {object} CategoryCreateResponseV3 @Param categories body []CategoryCreateV3 true "Categories" @Router /v3/categories [post]

func (Controller) CreateCategory ¶

func (co Controller) CreateCategory(c *gin.Context)

CreateCategory creates a new category

@Summary		Create category
@Description	Creates a new category
@Tags			Categories
@Produce		json
@Success		201			{object}	CategoryResponse
@Failure		400			{object}	httperrors.HTTPError
@Failure		404			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			category	body		models.CategoryCreate	true	"Category"
@Router			/v1/categories [post]
@Deprecated		true

func (Controller) CreateEnvelope ¶

func (co Controller) CreateEnvelope(c *gin.Context)

@Summary Create envelope @Description Creates a new envelope @Tags Envelopes @Produce json @Success 201 {object} EnvelopeResponse @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param envelope body models.EnvelopeCreate true "Envelope" @Router /v1/envelopes [post] @Deprecated true

func (Controller) CreateEnvelopesV3 ¶ added in v3.15.0

func (co Controller) CreateEnvelopesV3(c *gin.Context)

@Summary Create envelope @Description Creates a new envelope @Tags Envelopes @Produce json @Success 201 {object} EnvelopeCreateResponseV3 @Failure 400 {object} EnvelopeCreateResponseV3 @Failure 404 {object} EnvelopeCreateResponseV3 @Failure 500 {object} EnvelopeCreateResponseV3 @Param envelope body []controllers.EnvelopeCreateV3 true "Envelopes" @Router /v3/envelopes [post]

func (Controller) CreateGoalsV3 ¶ added in v3.21.0

func (co Controller) CreateGoalsV3(c *gin.Context)

@Summary Create goals @Description Creates new goals @Tags Goals @Produce json @Success 201 {object} GoalCreateResponseV3 @Failure 400 {object} GoalCreateResponseV3 @Failure 404 {object} GoalCreateResponseV3 @Failure 500 {object} GoalCreateResponseV3 @Param goals body []GoalV3Editable true "Goals" @Router /v3/goals [post]

func (Controller) CreateMatchRules ¶ added in v3.1.2

func (co Controller) CreateMatchRules(c *gin.Context)

CreateMatchRulesV2 creates matchRules

@Summary		Create matchRules
@Description	Creates matchRules from the list of submitted matchRule data. The response code is the highest response code number that a single matchRule creation would have caused. If it is not equal to 201, at least one matchRule has an error.
@Tags			MatchRules
@Produce		json
@Success		201			{object}	[]ResponseMatchRule
@Failure		400			{object}	[]ResponseMatchRule
@Failure		404			{object}	httperrors.HTTPError
@Failure		500			{object}	[]ResponseMatchRule
@Param			matchRules	body		[]models.MatchRuleCreate	true	"MatchRules"
@Router			/v2/match-rules [post]
@Deprecated		true

func (Controller) CreateMatchRulesV3 ¶ added in v3.10.0

func (co Controller) CreateMatchRulesV3(c *gin.Context)

@Summary Create matchRules @Description Creates matchRules from the list of submitted matchRule data. The response code is the highest response code number that a single matchRule creation would have caused. If it is not equal to 201, at least one matchRule has an error. @Tags MatchRules @Produce json @Success 201 {object} MatchRuleCreateResponseV3 @Failure 400 {object} MatchRuleCreateResponseV3 @Failure 404 {object} MatchRuleCreateResponseV3 @Failure 500 {object} MatchRuleCreateResponseV3 @Param matchRules body []models.MatchRuleCreate true "MatchRules" @Router /v3/match-rules [post]

func (Controller) CreateMonthConfig ¶

func (co Controller) CreateMonthConfig(c *gin.Context)

CreateMonthConfig creates a new month config

@Summary		Create MonthConfig
@Description	Creates a new MonthConfig
@Tags			MonthConfigs
@Produce		json
@Success		201			{object}	MonthConfigResponse
@Failure		400			{object}	httperrors.HTTPError
@Failure		404			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			id			path		string						true	"ID of the Envelope"
@Param			month		path		string						true	"The month in YYYY-MM format"
@Param			monthConfig	body		models.MonthConfigCreate	true	"MonthConfig"
@Router			/v1/month-configs/{id}/{month} [post]
@Deprecated		true

func (Controller) CreateRenameRules ¶

func (co Controller) CreateRenameRules(c *gin.Context)

CreateRenameRulesV2 creates renameRules

@Summary		Create renameRules
@Description	Creates renameRules from the list of submitted renameRule data. The response code is the highest response code number that a single renameRule creation would have caused. If it is not equal to 201, at least one renameRule has an error.
@Tags			RenameRules
@Produce		json
@Success		201			{object}	[]ResponseMatchRule
@Failure		400			{object}	[]ResponseMatchRule
@Failure		404			{object}	httperrors.HTTPError
@Failure		500			{object}	[]ResponseMatchRule
@Param			renameRules	body		[]models.MatchRuleCreate	true	"RenameRules"
@Router			/v2/rename-rules [post]
@Deprecated		true

func (Controller) CreateTransaction ¶

func (co Controller) CreateTransaction(c *gin.Context)

CreateTransaction creates a new transaction

@Summary		Create transaction
@Description	Creates a new transaction
@Tags			Transactions
@Produce		json
@Success		201			{object}	TransactionResponse
@Failure		400			{object}	httperrors.HTTPError
@Failure		404			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			transaction	body		models.TransactionCreate	true	"Transaction"
@Router			/v1/transactions [post]
@Deprecated		true

func (Controller) CreateTransactionsV2 ¶

func (co Controller) CreateTransactionsV2(c *gin.Context)

CreateTransactionsV2 creates transactions

@Summary		Create transactions
@Description	Creates transactions from the list of submitted transaction data. The response code is the highest response code number that a single transaction creation would have caused. If it is not equal to 201, at least one transaction has an error.
@Tags			Transactions
@Produce		json
@Success		201				{object}	[]ResponseTransactionV2
@Failure		400				{object}	httperrors.HTTPError
@Failure		404				{object}	[]ResponseTransactionV2
@Failure		500				{object}	[]ResponseTransactionV2
@Param			transactions	body		[]models.TransactionCreate	true	"Transactions"
@Router			/v2/transactions [post]
@Deprecated		true

func (Controller) CreateTransactionsV3 ¶ added in v3.6.0

func (co Controller) CreateTransactionsV3(c *gin.Context)

@Summary Create transactions @Description Creates transactions from the list of submitted transaction data. The response code is the highest response code number that a single transaction creation would have caused. If it is not equal to 201, at least one transaction has an error. @Tags Transactions @Produce json @Success 201 {object} TransactionCreateResponseV3 @Failure 400 {object} TransactionCreateResponseV3 @Failure 404 {object} TransactionCreateResponseV3 @Failure 500 {object} TransactionCreateResponseV3 @Param transactions body []models.TransactionCreate true "Transactions" @Router /v3/transactions [post]

func (Controller) DeleteAccount ¶

func (co Controller) DeleteAccount(c *gin.Context)

DeleteAccount deletes an account

@Summary		Delete account
@Description	Deletes an account
@Tags			Accounts
@Produce		json
@Success		204
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/accounts/{id} [delete]
@Deprecated		true

func (Controller) DeleteAccountV3 ¶ added in v3.14.0

func (co Controller) DeleteAccountV3(c *gin.Context)

@Summary Delete account @Description Deletes an account @Tags Accounts @Produce json @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v3/accounts/{id} [delete]

func (Controller) DeleteAll ¶

func (co Controller) DeleteAll(c *gin.Context)

DeleteAll permanently deletes all resources in the database

@Summary		Delete everything
@Description	Permanently deletes all resources
@Tags			v1
@Success		204
@Failure		500	{object}	httperrors.HTTPError
@Router			/v1 [delete]
@Deprecated		true

func (Controller) DeleteAllocation ¶

func (co Controller) DeleteAllocation(c *gin.Context)

DeleteAllocation deletes an allocation

@Summary		Delete allocation
@Description	Deletes an allocation
@Tags			Allocations
@Success		204
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/allocations/{id} [delete]
@Deprecated		true

func (Controller) DeleteAllocations ¶

func (co Controller) DeleteAllocations(c *gin.Context)

DeleteAllocations deletes all allocations for a month

@Summary		Delete allocations for a month
@Description	Deletes all allocation for the specified month
@Tags			Months
@Success		204
@Failure		400		{object}	httperrors.HTTPError
@Failure		404		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			budget	query		string	true	"ID formatted as string"
@Param			month	query		string	true	"The month in YYYY-MM format"
@Router			/v1/months [delete]
@Deprecated		true

func (Controller) DeleteAllocationsMonth ¶

func (co Controller) DeleteAllocationsMonth(c *gin.Context)

DeleteAllocationsMonth deletes all allocations for a specific month

@Summary		Delete allocations for a month
@Description	Deletes all allocation for the specified month. **Use DELETE /month endpoint with month and budgetId query parameters instead.**
@Tags			Budgets
@Success		204
@Failure		400		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			month	path		string	true	"The month in YYYY-MM format"
@Param			id		path		string	true	"Budget ID formatted as string"
@Router			/v1/budgets/{id}/{month}/allocations [delete]
@Deprecated		true

func (Controller) DeleteAllocationsV3 ¶ added in v3.19.0

func (co Controller) DeleteAllocationsV3(c *gin.Context)

@Summary Delete allocations for a month @Description Deletes all allocation for the specified month @Tags Months @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param budget query string true "ID formatted as string" @Param month query string true "The month in YYYY-MM format" @Router /v3/months [delete]

func (Controller) DeleteBudget ¶

func (co Controller) DeleteBudget(c *gin.Context)

Do stuff

@Summary		Delete budget
@Description	Deletes a budget
@Tags			Budgets
@Success		204
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/budgets/{id} [delete]
@Deprecated		true

func (Controller) DeleteBudgetV3 ¶ added in v3.12.0

func (co Controller) DeleteBudgetV3(c *gin.Context)

@Summary Delete budget @Description Deletes a budget @Tags Budgets @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v3/budgets/{id} [delete]

func (Controller) DeleteCategory ¶

func (co Controller) DeleteCategory(c *gin.Context)

DeleteCategory deletes a specific category

@Summary		Delete category
@Description	Deletes a category
@Tags			Categories
@Success		204
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/categories/{id} [delete]
@Deprecated		true

func (Controller) DeleteCategoryV3 ¶ added in v3.16.0

func (co Controller) DeleteCategoryV3(c *gin.Context)

@Summary Delete category @Description Deletes a category @Tags Categories @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v3/categories/{id} [delete]

func (Controller) DeleteEnvelope ¶

func (co Controller) DeleteEnvelope(c *gin.Context)

@Summary Delete envelope @Description Deletes an envelope @Tags Envelopes @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v1/envelopes/{id} [delete] @Deprecated true

func (Controller) DeleteEnvelopeV3 ¶ added in v3.15.0

func (co Controller) DeleteEnvelopeV3(c *gin.Context)

@Summary Delete envelope @Description Deletes an envelope @Tags Envelopes @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v3/envelopes/{id} [delete]

func (Controller) DeleteGoalV3 ¶ added in v3.21.0

func (co Controller) DeleteGoalV3(c *gin.Context)

@Summary Delete goal @Description Deletes a goal @Tags Goals @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v3/goals/{id} [delete]

func (Controller) DeleteMatchRule ¶ added in v3.1.2

func (co Controller) DeleteMatchRule(c *gin.Context)

DeleteMatchRule deletes an matchRule

@Summary		Delete matchRule
@Description	Deletes an matchRule
@Tags			MatchRules
@Success		204
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v2/match-rules/{id} [delete]
@Deprecated		true

func (Controller) DeleteMatchRuleV3 ¶ added in v3.10.0

func (co Controller) DeleteMatchRuleV3(c *gin.Context)

@Summary Delete matchRule @Description Deletes an matchRule @Tags MatchRules @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v3/match-rules/{id} [delete]

func (Controller) DeleteMonthConfig ¶

func (co Controller) DeleteMonthConfig(c *gin.Context)

DeleteMonthConfig deletes configuration data for a specific envelope and month

@Summary		Delete MonthConfig
@Description	Deletes configuration settings for a specific month
@Tags			MonthConfigs
@Produce		json
@Success		204
@Failure		400		{object}	httperrors.HTTPError
@Failure		404		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			id		path		string	true	"ID of the Envelope"
@Param			month	path		string	true	"The month in YYYY-MM format"
@Router			/v1/month-configs/{id}/{month} [delete]
@Deprecated		true

func (Controller) DeleteRenameRule ¶

func (co Controller) DeleteRenameRule(c *gin.Context)

DeleteRenameRule deletes an renameRule

@Summary		Delete renameRule
@Description	Deletes an renameRule
@Tags			RenameRules
@Success		204
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v2/rename-rules/{id} [delete]
@Deprecated		true

func (Controller) DeleteTransaction ¶

func (co Controller) DeleteTransaction(c *gin.Context)

DeleteTransaction deletes a specific transaction

@Summary		Delete transaction
@Description	Deletes a transaction
@Tags			Transactions
@Success		204
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/transactions/{id} [delete]
@Deprecated		true

func (Controller) DeleteTransactionV3 ¶ added in v3.8.0

func (co Controller) DeleteTransactionV3(c *gin.Context)

@Summary Delete transaction @Description Deletes a transaction @Tags Transactions @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v3/transactions/{id} [delete]

func (Controller) GetAccount ¶

func (co Controller) GetAccount(c *gin.Context)

GetAccount returns data for a specific account

@Summary		Get account
@Description	Returns a specific account
@Tags			Accounts
@Produce		json
@Success		200	{object}	AccountResponse
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/accounts/{id} [get]
@Deprecated		true

func (Controller) GetAccountV3 ¶ added in v3.14.0

func (co Controller) GetAccountV3(c *gin.Context)

@Summary Get account @Description Returns a specific account @Tags Accounts @Produce json @Success 200 {object} AccountResponseV3 @Failure 400 {object} AccountResponseV3 @Failure 404 {object} AccountResponseV3 @Failure 500 {object} AccountResponseV3 @Param id path string true "ID formatted as string" @Router /v3/accounts/{id} [get]

func (Controller) GetAccounts ¶

func (co Controller) GetAccounts(c *gin.Context)

GetAccounts returns a list of all accounts matching the filter parameters

@Summary		List accounts
@Description	Returns a list of accounts
@Tags			Accounts
@Produce		json
@Success		200	{object}	AccountListResponse
@Failure		400	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Router			/v1/accounts [get]
@Param			name		query	string	false	"Filter by name"
@Param			note		query	string	false	"Filter by note"
@Param			budget		query	string	false	"Filter by budget ID"
@Param			onBudget	query	bool	false	"Is the account on-budget?"
@Param			external	query	bool	false	"Is the account external?"
@Param			hidden		query	bool	false	"Is the account hidden?"
@Param			search		query	string	false	"Search for this text in name and note"
@Deprecated		true

func (Controller) GetAccountsV2 ¶ added in v3.2.0

func (co Controller) GetAccountsV2(c *gin.Context)

GetAccounts returns a list of all accounts matching the filter parameters

@Summary		List accounts
@Description	Returns a list of accounts
@Tags			Accounts
@Produce		json
@Success		200	{object}	AccountListResponse
@Failure		400	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Router			/v2/accounts [get]
@Param			name		query	string	false	"Filter by name"
@Param			note		query	string	false	"Filter by note"
@Param			budget		query	string	false	"Filter by budget ID"
@Param			onBudget	query	bool	false	"Is the account on-budget?"
@Param			external	query	bool	false	"Is the account external?"
@Param			hidden		query	bool	false	"Is the account hidden?"
@Param			search		query	string	false	"Search for this text in name and note"
@Deprecated		true

func (Controller) GetAccountsV3 ¶ added in v3.14.0

func (co Controller) GetAccountsV3(c *gin.Context)

@Summary List accounts @Description Returns a list of accounts @Tags Accounts @Produce json @Success 200 {object} AccountListResponseV3 @Failure 400 {object} AccountListResponseV3 @Failure 500 {object} AccountListResponseV3 @Router /v3/accounts [get] @Param name query string false "Filter by name" @Param note query string false "Filter by note" @Param budget query string false "Filter by budget ID" @Param onBudget query bool false "Is the account on-budget?" @Param external query bool false "Is the account external?" @Param archived query bool false "Is the account archived?" @Param search query string false "Search for this text in name and note" @Param offset query uint false "The offset of the first Account returned. Defaults to 0." @Param limit query int false "Maximum number of Accounts to return. Defaults to 50."

func (Controller) GetAllocation ¶

func (co Controller) GetAllocation(c *gin.Context)

GetAllocation returns data about a specific allocation

@Summary		Get allocation
@Description	Returns a specific allocation
@Tags			Allocations
@Produce		json
@Success		200	{object}	AllocationResponse
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/allocations/{id} [get]
@Deprecated		true

func (Controller) GetAllocations ¶

func (co Controller) GetAllocations(c *gin.Context)

GetAllocations returns a list of allocations matching the search parameters

@Summary		Get allocations
@Description	Returns a list of allocations
@Tags			Allocations
@Produce		json
@Success		200	{object}	AllocationListResponse
@Failure		400	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Router			/v1/allocations [get]
@Param			month		query	string	false	"Filter by month"
@Param			amount		query	string	false	"Filter by amount"
@Param			envelope	query	string	false	"Filter by envelope ID"
@Deprecated		true

func (Controller) GetBudget ¶

func (co Controller) GetBudget(c *gin.Context)

GetBudget returns data for a single budget

@Summary		Get budget
@Description	Returns a specific budget
@Tags			Budgets
@Produce		json
@Success		200	{object}	BudgetResponse
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/budgets/{id} [get]
@Deprecated		true

func (Controller) GetBudgetMonth ¶

func (co Controller) GetBudgetMonth(c *gin.Context)

GetBudgetMonth returns data for a month for a specific budget

@Summary		Get Budget month data
@Description	Returns data about a budget for a for a specific month. **Use GET /month endpoint with month and budgetId query parameters instead.**
@Tags			Budgets
@Produce		json
@Success		200		{object}	BudgetMonthResponse
@Failure		400		{object}	httperrors.HTTPError
@Failure		404		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			id		path		string	true	"ID formatted as string"
@Param			month	path		string	true	"The month in YYYY-MM format"
@Router			/v1/budgets/{id}/{month} [get]
@Deprecated		true

func (Controller) GetBudgetV3 ¶ added in v3.12.0

func (co Controller) GetBudgetV3(c *gin.Context)

@Summary Get budget @Description Returns a specific budget @Tags Budgets @Produce json @Success 200 {object} BudgetResponseV3 @Failure 400 {object} BudgetResponseV3 @Failure 404 {object} BudgetResponseV3 @Failure 500 {object} BudgetResponseV3 @Param id path string true "ID formatted as string" @Router /v3/budgets/{id} [get]

func (Controller) GetBudgets ¶

func (co Controller) GetBudgets(c *gin.Context)

GetBudgets returns data for all budgets filtered by the query parameters

@Summary		List budgets
@Description	Returns a list of budgets
@Tags			Budgets
@Produce		json
@Success		200	{object}	BudgetListResponse
@Failure		500	{object}	httperrors.HTTPError
@Router			/v1/budgets [get]
@Param			name		query	string	false	"Filter by name"
@Param			note		query	string	false	"Filter by note"
@Param			currency	query	string	false	"Filter by currency"
@Param			search		query	string	false	"Search for this text in name and note"
@Deprecated		true

func (Controller) GetBudgetsV3 ¶ added in v3.12.0

func (co Controller) GetBudgetsV3(c *gin.Context)

@Summary List budgets @Description Returns a list of budgets @Tags Budgets @Produce json @Success 200 {object} BudgetListResponseV3 @Failure 500 {object} BudgetListResponseV3 @Router /v3/budgets [get] @Param name query string false "Filter by name" @Param note query string false "Filter by note" @Param currency query string false "Filter by currency" @Param search query string false "Search for this text in name and note" @Param offset query uint false "The offset of the first Budget returned. Defaults to 0." @Param limit query int false "Maximum number of Budgets to return. Defaults to 50."

func (Controller) GetCategories ¶

func (co Controller) GetCategories(c *gin.Context)

GetCategories returns a list of categories filtered by the query parameters

@Summary		Get categories
@Description	Returns a list of categories
@Tags			Categories
@Produce		json
@Success		200	{object}	CategoryListResponse
@Failure		400	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Router			/v1/categories [get]
@Param			name	query	string	false	"Filter by name"
@Param			note	query	string	false	"Filter by note"
@Param			budget	query	string	false	"Filter by budget ID"
@Param			hidden	query	bool	false	"Is the category hidden?"
@Param			search	query	string	false	"Search for this text in name and note"
@Deprecated		true

func (Controller) GetCategoriesV3 ¶ added in v3.16.0

func (co Controller) GetCategoriesV3(c *gin.Context)

@Summary Get categories @Description Returns a list of categories @Tags Categories @Produce json @Success 200 {object} CategoryListResponseV3 @Failure 400 {object} CategoryListResponseV3 @Failure 500 {object} CategoryListResponseV3 @Router /v3/categories [get] @Param name query string false "Filter by name" @Param note query string false "Filter by note" @Param budget query string false "Filter by budget ID" @Param hidden query bool false "Is the category hidden?" @Param search query string false "Search for this text in name and note" @Param offset query uint false "The offset of the first Category returned. Defaults to 0." @Param limit query int false "Maximum number of Categories to return. Defaults to 50."

func (Controller) GetCategory ¶

func (co Controller) GetCategory(c *gin.Context)

GetCategory returns data for a specific category

@Summary		Get category
@Description	Returns a specific category
@Tags			Categories
@Produce		json
@Success		200	{object}	CategoryResponse
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/categories/{id} [get]
@Deprecated		true

func (Controller) GetCategoryV3 ¶ added in v3.16.0

func (co Controller) GetCategoryV3(c *gin.Context)

@Summary Get category @Description Returns a specific category @Tags Categories @Produce json @Success 200 {object} CategoryResponseV3 @Failure 400 {object} CategoryResponseV3 @Failure 404 {object} CategoryResponseV3 @Failure 500 {object} CategoryResponseV3 @Param id path string true "ID formatted as string" @Router /v3/categories/{id} [get]

func (Controller) GetEnvelope ¶

func (co Controller) GetEnvelope(c *gin.Context)

@Summary Get envelope @Description Returns a specific envelope @Tags Envelopes @Produce json @Success 200 {object} EnvelopeResponse @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v1/envelopes/{id} [get] @Deprecated true

func (Controller) GetEnvelopeMonth ¶

func (co Controller) GetEnvelopeMonth(c *gin.Context)

@Summary Get Envelope month data @Description Returns data about an envelope for a for a specific month. **Use GET /month endpoint with month and budgetId query parameters instead.** @Tags Envelopes @Produce json @Success 200 {object} EnvelopeMonthResponse @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Param month path string true "The month in YYYY-MM format" @Router /v1/envelopes/{id}/{month} [get] @Deprecated true

func (Controller) GetEnvelopeV3 ¶ added in v3.15.0

func (co Controller) GetEnvelopeV3(c *gin.Context)

@Summary Get Envelope @Description Returns a specific Envelope @Tags Envelopes @Produce json @Success 200 {object} EnvelopeResponseV3 @Failure 400 {object} EnvelopeResponseV3 @Failure 404 {object} EnvelopeResponseV3 @Failure 500 {object} EnvelopeResponseV3 @Param id path string true "ID formatted as string" @Router /v3/envelopes/{id} [get]

func (Controller) GetEnvelopes ¶

func (co Controller) GetEnvelopes(c *gin.Context)

@Summary Get envelopes @Description Returns a list of envelopes @Tags Envelopes @Produce json @Success 200 {object} EnvelopeListResponse @Failure 400 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Router /v1/envelopes [get] @Param name query string false "Filter by name" @Param note query string false "Filter by note" @Param category query string false "Filter by category ID" @Param hidden query bool false "Is the envelope hidden?" @Param search query string false "Search for this text in name and note" @Deprecated true

func (Controller) GetEnvelopesV3 ¶ added in v3.15.0

func (co Controller) GetEnvelopesV3(c *gin.Context)

@Summary Get envelopes @Description Returns a list of envelopes @Tags Envelopes @Produce json @Success 200 {object} EnvelopeListResponseV3 @Failure 400 {object} EnvelopeListResponseV3 @Failure 500 {object} EnvelopeListResponseV3 @Router /v3/envelopes [get] @Param name query string false "Filter by name" @Param note query string false "Filter by note" @Param category query string false "Filter by category ID" @Param archived query bool false "Is the envelope archived?" @Param search query string false "Search for this text in name and note" @Param offset query uint false "The offset of the first Envelope returned. Defaults to 0." @Param limit query int false "Maximum number of Envelopes to return. Defaults to 50."

func (Controller) GetGoalV3 ¶ added in v3.21.0

func (co Controller) GetGoalV3(c *gin.Context)

@Summary Get goal @Description Returns a specific goal @Tags Goals @Produce json @Success 200 {object} GoalResponseV3 @Failure 400 {object} GoalResponseV3 @Failure 404 {object} GoalResponseV3 @Failure 500 {object} GoalResponseV3 @Param id path string true "ID formatted as string" @Router /v3/goals/{id} [get]

func (Controller) GetGoalsV3 ¶ added in v3.21.0

func (co Controller) GetGoalsV3(c *gin.Context)

@Summary Get goals @Description Returns a list of goals @Tags Goals @Produce json @Success 200 {object} GoalListResponseV3 @Failure 400 {object} GoalListResponseV3 @Failure 500 {object} GoalListResponseV3 @Router /v3/goals [get] @Param name query string false "Filter by name" @Param note query string false "Filter by note" @Param search query string false "Search for this text in name and note" @Param archived query bool false "Is the goal archived?" @Param envelope query string false "Filter by envelope ID" @Param month query string false "Month of the goal. Ignores exact time, matches on the month of the RFC3339 timestamp provided." @Param fromMonth query string false "Goals for this and later months. Ignores exact time, matches on the month of the RFC3339 timestamp provided." @Param untilMonth query string false "Goals for this and earlier months. Ignores exact time, matches on the month of the RFC3339 timestamp provided." @Param amount query string false "Filter by amount" @Param amountLessOrEqual query string false "Amount less than or equal to this" @Param amountMoreOrEqual query string false "Amount more than or equal to this" @Param offset query uint false "The offset of the first goal returned. Defaults to 0." @Param limit query int false "Maximum number of goal to return. Defaults to 50."

func (Controller) GetHealthz ¶ added in v3.3.0

func (co Controller) GetHealthz(c *gin.Context)

GetHealthz returns data about the application health

@Summary		Get health
@Description	Returns the application health and, if not healthy, an error
@Tags			General
@Produce		json
@Success		204
@Failure		500	{object} httperrors.HTTPError
@Router			/healthz [get]

func (Controller) GetImportV3 ¶ added in v3.11.0

func (Controller) GetImportV3(c *gin.Context)

@Summary Import API overview @Description Returns general information about the v3 API @Tags Import @Success 200 {object} ImportV3Response @Router /v3/import [get]

func (Controller) GetMatchRule ¶ added in v3.1.2

func (co Controller) GetMatchRule(c *gin.Context)

GetMatchRule returns data about a specific matchRule

@Summary		Get matchRule
@Description	Returns a specific matchRule
@Tags			MatchRules
@Produce		json
@Success		200	{object}	models.MatchRule
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v2/match-rules/{id} [get]
@Deprecated		true

func (Controller) GetMatchRuleV3 ¶ added in v3.10.0

func (co Controller) GetMatchRuleV3(c *gin.Context)

@Summary Get matchRule @Description Returns a specific matchRule @Tags MatchRules @Produce json @Success 200 {object} MatchRuleResponseV3 @Failure 400 {object} MatchRuleResponseV3 @Failure 404 {object} MatchRuleResponseV3 @Failure 500 {object} MatchRuleResponseV3 @Param id path string true "ID formatted as string" @Router /v3/match-rules/{id} [get]

func (Controller) GetMatchRules ¶ added in v3.1.2

func (co Controller) GetMatchRules(c *gin.Context)

GetMatchRules returns a list of matchRules matching the search parameters

@Summary		Get matchRules
@Description	Returns a list of matchRules
@Tags			MatchRules
@Produce		json
@Success		200			{object}	[]models.MatchRule
@Failure		400			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			priority	query		uint	false	"Filter by priority"
@Param			match		query		string	false	"Filter by match"
@Param			account		query		string	false	"Filter by account ID"
@Router			/v2/match-rules [get]
@Deprecated		true

func (Controller) GetMatchRulesV3 ¶ added in v3.10.0

func (co Controller) GetMatchRulesV3(c *gin.Context)

@Summary Get matchRules @Description Returns a list of matchRules @Tags MatchRules @Produce json @Success 200 {object} MatchRuleListResponseV3 @Failure 400 {object} MatchRuleListResponseV3 @Failure 500 {object} MatchRuleListResponseV3 @Param priority query uint false "Filter by priority" @Param match query string false "Filter by match" @Param account query string false "Filter by account ID" @Param offset query uint false "The offset of the first Match Rule returned. Defaults to 0." @Param limit query int false "Maximum number of Match Rules to return. Defaults to 50.". @Router /v3/match-rules [get]

func (Controller) GetMonth ¶

func (co Controller) GetMonth(c *gin.Context)

GetMonth returns data for a specific budget and month

@Summary		Get data about a month
@Description	Returns data about a specific month.
@Tags			Months
@Produce		json
@Success		200		{object}	MonthResponse
@Failure		400		{object}	httperrors.HTTPError
@Failure		404		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			budget	query		string	true	"ID formatted as string"
@Param			month	query		string	true	"The month in YYYY-MM format"
@Router			/v1/months [get]
@Deprecated		true

func (Controller) GetMonthConfig ¶

func (co Controller) GetMonthConfig(c *gin.Context)

GetMonthConfig returns config for a specific envelope and month

@Summary		Get MonthConfig
@Description	Returns configuration for a specific month
@Tags			MonthConfigs
@Produce		json
@Success		200		{object}	MonthConfigResponse
@Failure		400		{object}	httperrors.HTTPError
@Failure		404		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			id		path		string	true	"ID of the Envelope"
@Param			month	path		string	true	"The month in YYYY-MM format"
@Router			/v1/month-configs/{id}/{month} [get]
@Deprecated		true

func (Controller) GetMonthConfigV3 ¶ added in v3.17.0

func (co Controller) GetMonthConfigV3(c *gin.Context)

@Summary Get MonthConfig @Description Returns configuration for a specific month @Tags Envelopes @Produce json @Success 200 {object} MonthConfigResponseV3 @Failure 400 {object} MonthConfigResponseV3 @Failure 404 {object} MonthConfigResponseV3 @Failure 500 {object} MonthConfigResponseV3 @Param id path string true "ID of the Envelope" @Param month path string true "The month in YYYY-MM format" @Router /v3/envelopes/{id}/{month} [get]

func (Controller) GetMonthConfigs ¶

func (co Controller) GetMonthConfigs(c *gin.Context)

GetMonthConfigs returns all month configs filtered by the query parameters

@Summary		List MonthConfigs
@Description	Returns a list of MonthConfigs
@Tags			MonthConfigs
@Produce		json
@Success		200			{object}	MonthConfigListResponse
@Failure		400			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			envelope	query		string	false	"Filter by name"
@Param			month		query		string	false	"Filter by month"
@Router			/v1/month-configs [get]
@Deprecated		true

func (Controller) GetMonthV3 ¶ added in v3.19.0

func (co Controller) GetMonthV3(c *gin.Context)

@Summary Get data about a month @Description Returns data about a specific month. @Tags Months @Produce json @Success 200 {object} MonthResponseV3 @Failure 400 {object} MonthResponseV3 @Failure 404 {object} MonthResponseV3 @Failure 500 {object} MonthResponseV3 @Param budget query string true "ID formatted as string" @Param month query string true "The month in YYYY-MM format" @Router /v3/months [get]

func (Controller) GetRenameRule ¶

func (co Controller) GetRenameRule(c *gin.Context)

GetRenameRule returns data about a specific renameRule

@Summary		Get renameRule
@Description	Returns a specific renameRule
@Tags			RenameRules
@Produce		json
@Success		200	{object}	RenameRuleResponse
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v2/rename-rules/{id} [get]
@Deprecated		true

func (Controller) GetRenameRules ¶

func (co Controller) GetRenameRules(c *gin.Context)

GetRenameRules returns a list of renameRules matching the search parameters

@Summary		Get renameRules
@Description	Returns a list of renameRules
@Tags			RenameRules
@Produce		json
@Success		200			{object}	RenameRuleListResponse
@Failure		400			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			priority	query		uint	false	"Filter by priority"
@Param			match		query		string	false	"Filter by match"
@Param			account		query		string	false	"Filter by account ID"
@Router			/v2/rename-rules [get]
@Deprecated		true

func (Controller) GetTransaction ¶

func (co Controller) GetTransaction(c *gin.Context)

GetTransaction returns a specific transaction

@Summary		Get transaction
@Description	Returns a specific transaction
@Tags			Transactions
@Produce		json
@Success		200	{object}	TransactionResponse
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/transactions/{id} [get]
@Deprecated		true

func (Controller) GetTransactionV3 ¶ added in v3.7.0

func (co Controller) GetTransactionV3(c *gin.Context)

@Summary Get transaction @Description Returns a specific transaction @Tags Transactions @Produce json @Success 200 {object} TransactionResponseV3 @Failure 400 {object} TransactionResponseV3 @Failure 404 {object} TransactionResponseV3 @Failure 500 {object} TransactionResponseV3 @Param id path string true "ID formatted as string" @Router /v3/transactions/{id} [get]

func (Controller) GetTransactions ¶

func (co Controller) GetTransactions(c *gin.Context)

GetTransactions returns transactions filtered by the query parameters

@Summary		Get transactions
@Description	Returns a list of transactions
@Tags			Transactions
@Produce		json
@Success		200	{object}	TransactionListResponse
@Failure		400	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Router			/v1/transactions [get]
@Param			date					query	string	false	"Date of the transaction. Ignores exact time, matches on the day of the RFC3339 timestamp provided."
@Param			fromDate				query	string	false	"Transactions at and after this date. Ignores exact time, matches on the day of the RFC3339 timestamp provided."
@Param			untilDate				query	string	false	"Transactions before and at this date. Ignores exact time, matches on the day of the RFC3339 timestamp provided."
@Param			amount					query	string	false	"Filter by amount"
@Param			amountLessOrEqual		query	string	false	"Amount less than or equal to this"
@Param			amountMoreOrEqual		query	string	false	"Amount more than or equal to this"
@Param			note					query	string	false	"Filter by note"
@Param			budget					query	string	false	"Filter by budget ID"
@Param			account					query	string	false	"Filter by ID of associated account, regardeless of source or destination"
@Param			source					query	string	false	"Filter by source account ID"
@Param			destination				query	string	false	"Filter by destination account ID"
@Param			envelope				query	string	false	"Filter by envelope ID"
@Param			reconciled				query	bool	false	"DEPRECATED. Filter by reconcilication state"
@Param			reconciledSource		query	bool	false	"Reconcilication state in source account"
@Param			reconciledDestination	query	bool	false	"Reconcilication state in destination account"
@Deprecated		true

func (Controller) GetTransactionsV3 ¶ added in v3.5.0

func (co Controller) GetTransactionsV3(c *gin.Context)

@Summary Get transactions @Description Returns a list of transactions @Tags Transactions @Produce json @Success 200 {object} TransactionListResponseV3 @Failure 400 {object} TransactionListResponseV3 @Failure 500 {object} TransactionListResponseV3 @Router /v3/transactions [get] @Param date query string false "Date of the transaction. Ignores exact time, matches on the day of the RFC3339 timestamp provided." @Param fromDate query string false "Transactions at and after this date. Ignores exact time, matches on the day of the RFC3339 timestamp provided." @Param untilDate query string false "Transactions before and at this date. Ignores exact time, matches on the day of the RFC3339 timestamp provided." @Param amount query string false "Filter by amount" @Param amountLessOrEqual query string false "Amount less than or equal to this" @Param amountMoreOrEqual query string false "Amount more than or equal to this" @Param note query string false "Filter by note" @Param budget query string false "Filter by budget ID" @Param account query string false "Filter by ID of associated account, regardeless of source or destination" @Param source query string false "Filter by source account ID" @Param destination query string false "Filter by destination account ID" @Param envelope query string false "Filter by envelope ID" @Param reconciledSource query bool false "Reconcilication state in source account" @Param reconciledDestination query bool false "Reconcilication state in destination account" @Param offset query uint false "The offset of the first Transaction returned. Defaults to 0." @Param limit query int false "Maximum number of Transactions to return. Defaults to 50."

func (Controller) Import ¶

func (co Controller) Import(c *gin.Context)

Import imports a YNAB 4 budget

@Summary		Import
@Description	Imports budgets from YNAB 4. **Please use /v1/import/ynab4, which works exactly the same.**
@Tags			Import
@Accept			multipart/form-data
@Produce		json
@Success		204
@Failure		400			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			file		formData	file	true	"File to import"
@Param			budgetName	query		string	false	"Name of the Budget to create"
@Router			/v1/import [post]
@Deprecated		true

func (Controller) ImportYnab4 ¶

func (co Controller) ImportYnab4(c *gin.Context)

ImportYnab4 imports a YNAB 4 budget

@Summary		Import YNAB 4 budget
@Description	Imports budgets from YNAB 4
@Tags			Import
@Accept			multipart/form-data
@Produce		json
@Success		201			{object}	BudgetResponse
@Failure		400			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			file		formData	file	true	"File to import"
@Param			budgetName	query		string	false	"Name of the Budget to create"
@Router			/v1/import/ynab4 [post]
@Deprecated		true

func (Controller) ImportYnab4V3 ¶ added in v3.11.0

func (co Controller) ImportYnab4V3(c *gin.Context)

@Summary Import YNAB 4 budget @Description Imports budgets from YNAB 4 @Tags Import @Accept multipart/form-data @Produce json @Success 201 {object} BudgetResponseV3 @Failure 400 {object} BudgetResponseV3 @Failure 500 {object} BudgetResponseV3 @Param file formData file true "File to import" @Param budgetName query string false "Name of the Budget to create" @Router /v3/import/ynab4 [post]

func (Controller) ImportYnabImportPreview ¶

func (co Controller) ImportYnabImportPreview(c *gin.Context)

ImportYnabImportPreview parses a YNAB import format CSV and returns a preview of transactions to be imported into Envelope Zero.

@Summary		Transaction Import Preview
@Description	Returns a preview of transactions to be imported after parsing a YNAB Import format csv file
@Tags			Import
@Accept			multipart/form-data
@Produce		json
@Success		200			{object}	ImportPreviewList
@Failure		400			{object}	httperrors.HTTPError
@Failure		404			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			file		formData	file	true	"File to import"
@Param			accountId	query		string	false	"ID of the account to import transactions for"
@Router			/v1/import/ynab-import-preview [post]
@Deprecated		true

func (Controller) ImportYnabImportPreviewV3 ¶ added in v3.11.0

func (co Controller) ImportYnabImportPreviewV3(c *gin.Context)

@Summary Transaction Import Preview @Description Returns a preview of transactions to be imported after parsing a YNAB Import format csv file @Tags Import @Accept multipart/form-data @Produce json @Success 200 {object} ImportPreviewListV3 @Failure 400 {object} ImportPreviewListV3 @Failure 404 {object} ImportPreviewListV3 @Failure 500 {object} ImportPreviewListV3 @Param file formData file true "File to import" @Param accountId query string false "ID of the account to import transactions for" @Router /v3/import/ynab-import-preview [post]

func (Controller) OptionsAccountDetail ¶

func (co Controller) OptionsAccountDetail(c *gin.Context)

OptionsAccountDetail returns the allowed HTTP verbs

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			Accounts
@Success		204
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/accounts/{id} [options]
@Deprecated		true

func (Controller) OptionsAccountDetailV3 ¶ added in v3.14.0

func (co Controller) OptionsAccountDetailV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Accounts @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v3/accounts/{id} [options].

func (Controller) OptionsAccountList ¶

func (co Controller) OptionsAccountList(c *gin.Context)

OptionsAccountList returns the allowed HTTP verbs

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			Accounts
@Success		204
@Router			/v1/accounts [options]
@Deprecated		true

func (Controller) OptionsAccountListV2 ¶ added in v3.2.0

func (co Controller) OptionsAccountListV2(c *gin.Context)

OptionsAccountList returns the allowed HTTP verbs

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			Accounts
@Success		204
@Router			/v2/accounts [options]
@Deprecated		true

func (Controller) OptionsAccountListV3 ¶ added in v3.14.0

func (co Controller) OptionsAccountListV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Accounts @Success 204 @Router /v3/accounts [options].

func (Controller) OptionsAllocationDetail ¶

func (co Controller) OptionsAllocationDetail(c *gin.Context)

OptionsAllocationDetail returns the allowed HTTP verbs

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			Allocations
@Success		204
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/allocations/{id} [options]
@Deprecated		true

func (Controller) OptionsAllocationList ¶

func (co Controller) OptionsAllocationList(c *gin.Context)

OptionsAllocationList returns the allowed HTTP verbs

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			Allocations
@Success		204
@Router			/v1/allocations [options]
@Deprecated		true

func (Controller) OptionsBudgetDetail ¶

func (co Controller) OptionsBudgetDetail(c *gin.Context)

OptionsBudgetDetail returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			Budgets
@Success		204
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/budgets/{id} [options]
@Deprecated		true

func (Controller) OptionsBudgetDetailV3 ¶ added in v3.12.0

func (co Controller) OptionsBudgetDetailV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Budgets @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v3/budgets/{id} [options]

func (Controller) OptionsBudgetList ¶

func (co Controller) OptionsBudgetList(c *gin.Context)

OptionsBudgetList returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			Budgets
@Success		204
@Router			/v1/budgets [options]
@Deprecated		true

func (Controller) OptionsBudgetListV3 ¶ added in v3.12.0

func (co Controller) OptionsBudgetListV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Budgets @Success 204 @Router /v3/budgets [options]

func (Controller) OptionsBudgetMonth ¶

func (co Controller) OptionsBudgetMonth(c *gin.Context)

OptionsBudgetMonth returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs. **Use OPTIONS /month endpoint with month and budgetId query parameters instead.**
@Tags			Budgets
@Success		204
@Failure		400		{object}	httperrors.HTTPError
@Failure		404		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			id		path		string	true	"ID formatted as string"
@Param			month	path		string	true	"The month in YYYY-MM format"
@Router			/v1/budgets/{id}/{month} [options]
@Deprecated		true

func (Controller) OptionsBudgetMonthAllocations ¶

func (co Controller) OptionsBudgetMonthAllocations(c *gin.Context)

OptionsBudgetMonthAllocations returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs. **Use OPTIONS /month endpoint with month and budgetId query parameters instead.**
@Tags			Budgets
@Success		204
@Failure		400		{object}	httperrors.HTTPError
@Failure		404		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			id		path		string	true	"ID formatted as string"
@Param			month	path		string	true	"The month in YYYY-MM format"
@Router			/v1/budgets/{id}/{month}/allocations [options]
@Deprecated		true

func (Controller) OptionsCategoryDetail ¶

func (co Controller) OptionsCategoryDetail(c *gin.Context)

OptionsCategoryDetail returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			Categories
@Success		204
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/categories/{id} [options]
@Deprecated		true

func (Controller) OptionsCategoryDetailV3 ¶ added in v3.16.0

func (co Controller) OptionsCategoryDetailV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Categories @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v3/categories/{id} [options]

func (Controller) OptionsCategoryList ¶

func (co Controller) OptionsCategoryList(c *gin.Context)

OptionsCategoryList returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			Categories
@Success		204
@Router			/v1/categories [options]
@Deprecated		true

func (Controller) OptionsCategoryListV3 ¶ added in v3.16.0

func (co Controller) OptionsCategoryListV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Categories @Success 204 @Router /v3/categories [options]

func (Controller) OptionsEnvelopeDetail ¶

func (co Controller) OptionsEnvelopeDetail(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Envelopes @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v1/envelopes/{id} [options] @Deprecated true

func (Controller) OptionsEnvelopeDetailV3 ¶ added in v3.15.0

func (co Controller) OptionsEnvelopeDetailV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Envelopes @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v3/envelopes/{id} [options]

func (Controller) OptionsEnvelopeList ¶

func (co Controller) OptionsEnvelopeList(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Envelopes @Success 204 @Router /v1/envelopes [options] @Deprecated true

func (Controller) OptionsEnvelopeListV3 ¶ added in v3.15.0

func (co Controller) OptionsEnvelopeListV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Envelopes @Success 204 @Router /v3/envelopes [options]

func (Controller) OptionsGoalDetailV3 ¶ added in v3.21.0

func (co Controller) OptionsGoalDetailV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Goals @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v3/goals/{id} [options]

func (Controller) OptionsGoalsV3 ¶ added in v3.21.0

func (co Controller) OptionsGoalsV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Goals @Success 204 @Router /v3/goals [options]

func (Controller) OptionsHealthz ¶ added in v3.3.0

func (co Controller) OptionsHealthz(c *gin.Context)

OptionsHealthz returns the allowed HTTP verbs

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			General
@Success		204
@Router			/healthz [options]

func (Controller) OptionsImport ¶

func (co Controller) OptionsImport(c *gin.Context)

OptionsImport returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs. **Please use /v1/import/ynab4, which works exactly the same.**
@Tags			Import
@Success		204
@Router			/v1/import [options]
@Deprecated		true

func (Controller) OptionsImportV3 ¶ added in v3.11.0

func (co Controller) OptionsImportV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs. @Tags Import @Success 204 @Router /v3/import [options]

func (Controller) OptionsImportYnab4 ¶

func (co Controller) OptionsImportYnab4(c *gin.Context)

OptionsImportYnab4 returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			Import
@Success		204
@Router			/v1/import/ynab4 [options]
@Deprecated		true

func (Controller) OptionsImportYnab4V3 ¶ added in v3.11.0

func (co Controller) OptionsImportYnab4V3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Import @Success 204 @Router /v3/import/ynab4 [options]

func (Controller) OptionsImportYnabImportPreview ¶

func (co Controller) OptionsImportYnabImportPreview(c *gin.Context)

OptionsImportYnab4 returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			Import
@Success		204
@Router			/v1/import/ynab-import-preview [options]
@Deprecated		true

func (Controller) OptionsImportYnabImportPreviewV3 ¶ added in v3.11.0

func (co Controller) OptionsImportYnabImportPreviewV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Import @Success 204 @Router /v3/import/ynab-import-preview [options]

func (Controller) OptionsMatchRuleDetail ¶ added in v3.1.2

func (co Controller) OptionsMatchRuleDetail(c *gin.Context)

OptionsMatchRuleDetail returns the allowed HTTP verbs

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			MatchRules
@Success		204
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v2/match-rules/{id} [options]
@Deprecated		true

func (Controller) OptionsMatchRuleDetailV3 ¶ added in v3.10.0

func (co Controller) OptionsMatchRuleDetailV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags MatchRules @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v3/match-rules/{id} [options]

func (Controller) OptionsMatchRuleList ¶ added in v3.1.2

func (co Controller) OptionsMatchRuleList(c *gin.Context)

OptionsMatchRuleList returns the allowed HTTP verbs

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			MatchRules
@Success		204
@Router			/v2/match-rules [options]
@Deprecated		true

func (Controller) OptionsMatchRuleListV3 ¶ added in v3.10.0

func (co Controller) OptionsMatchRuleListV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags MatchRules @Success 204 @Router /v3/match-rules [options]

func (Controller) OptionsMonth ¶

func (co Controller) OptionsMonth(c *gin.Context)

OptionsMonth returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs.
@Tags			Months
@Success		204
@Router			/v1/months [options]
@Deprecated		true

func (Controller) OptionsMonthConfigDetail ¶

func (co Controller) OptionsMonthConfigDetail(c *gin.Context)

OptionsMonthConfigDetail returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			MonthConfigs
@Success		204
@Failure		400		{object}	httperrors.HTTPError
@Failure		404		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			id		path		string	true	"ID of the Envelope"
@Param			month	path		string	true	"The month in YYYY-MM format"
@Router			/v1/month-configs/{id}/{month} [options]
@Deprecated		true

func (Controller) OptionsMonthConfigDetailV3 ¶ added in v3.17.0

func (co Controller) OptionsMonthConfigDetailV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Envelopes @Success 204 @Failure 400 {object} httperrors.HTTPError @Param id path string true "ID of the Envelope" @Param month path string true "The month in YYYY-MM format" @Router /v3/envelopes/{id}/{month} [options]

func (Controller) OptionsMonthConfigList ¶

func (co Controller) OptionsMonthConfigList(c *gin.Context)

OptionsMonthConfigList returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs.
@Tags			MonthConfigs
@Success		204
@Router			/v1/month-configs [options]
@Deprecated		true

func (Controller) OptionsMonthV3 ¶ added in v3.19.0

func (co Controller) OptionsMonthV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs. @Tags Months @Success 204 @Router /v3/months [options]

func (Controller) OptionsRenameRuleDetail ¶

func (co Controller) OptionsRenameRuleDetail(c *gin.Context)

OptionsRenameRuleDetail returns the allowed HTTP verbs

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			RenameRules
@Success		204
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v2/rename-rules/{id} [options]
@Deprecated		true

func (Controller) OptionsRenameRuleList ¶

func (co Controller) OptionsRenameRuleList(c *gin.Context)

OptionsRenameRuleList returns the allowed HTTP verbs

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			RenameRules
@Success		204
@Router			/v2/rename-rules [options]
@Deprecated		true

func (Controller) OptionsTransactionDetail ¶

func (co Controller) OptionsTransactionDetail(c *gin.Context)

OptionsTransactionDetail returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			Transactions
@Success		204
@Failure		400	{object}	httperrors.HTTPError
@Failure		404	{object}	httperrors.HTTPError
@Failure		500	{object}	httperrors.HTTPError
@Param			id	path		string	true	"ID formatted as string"
@Router			/v1/transactions/{id} [options]
@Deprecated		true

func (Controller) OptionsTransactionDetailV3 ¶ added in v3.7.0

func (co Controller) OptionsTransactionDetailV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Transactions @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Router /v3/transactions/{id} [options]

func (Controller) OptionsTransactionList ¶

func (co Controller) OptionsTransactionList(c *gin.Context)

OptionsTransactionList returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			Transactions
@Success		204
@Router			/v1/transactions [options]
@Deprecated		true

func (Controller) OptionsTransactionsV2 ¶

func (co Controller) OptionsTransactionsV2(c *gin.Context)

OptionsTransactionsV2 returns the allowed HTTP methods

@Summary		Allowed HTTP verbs
@Description	Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
@Tags			Transactions
@Success		204
@Router			/v2/transactions [options]
@Deprecated		true

func (Controller) OptionsTransactionsV3 ¶ added in v3.5.0

func (co Controller) OptionsTransactionsV3(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags Transactions @Success 204 @Router /v3/transactions [options]

func (Controller) RegisterAccountRoutes ¶

func (co Controller) RegisterAccountRoutes(r *gin.RouterGroup)

RegisterAccountRoutes registers the routes for accounts with the RouterGroup that is passed.

func (Controller) RegisterAccountRoutesV2 ¶ added in v3.2.0

func (co Controller) RegisterAccountRoutesV2(r *gin.RouterGroup)

RegisterAccountRoutes registers the routes for accounts with the RouterGroup that is passed.

func (Controller) RegisterAccountRoutesV3 ¶ added in v3.14.0

func (co Controller) RegisterAccountRoutesV3(r *gin.RouterGroup)

RegisterAccountRoutesV3 registers the routes for accounts with the RouterGroup that is passed.

func (Controller) RegisterAllocationRoutes ¶

func (co Controller) RegisterAllocationRoutes(r *gin.RouterGroup)

RegisterAllocationRoutes registers the routes for allocations with the RouterGroup that is passed.

func (Controller) RegisterBudgetRoutes ¶

func (co Controller) RegisterBudgetRoutes(r *gin.RouterGroup)

RegisterBudgetRoutes registers the routes for budgets with the RouterGroup that is passed.

func (Controller) RegisterBudgetRoutesV3 ¶ added in v3.12.0

func (co Controller) RegisterBudgetRoutesV3(r *gin.RouterGroup)

RegisterBudgetRoutesV3 registers the routes for Budgets with the RouterGroup that is passed.

func (Controller) RegisterCategoryRoutes ¶

func (co Controller) RegisterCategoryRoutes(r *gin.RouterGroup)

RegisterCategoryRoutes registers the routes for categories with the RouterGroup that is passed.

func (Controller) RegisterCategoryRoutesV3 ¶ added in v3.16.0

func (co Controller) RegisterCategoryRoutesV3(r *gin.RouterGroup)

RegisterCategoryRoutesV3 registers the routes for categories with the RouterGroup that is passed.

func (Controller) RegisterEnvelopeRoutes ¶

func (co Controller) RegisterEnvelopeRoutes(r *gin.RouterGroup)

RegisterEnvelopeRoutes registers the routes for envelopes with the RouterGroup that is passed.

func (Controller) RegisterEnvelopeRoutesV3 ¶ added in v3.15.0

func (co Controller) RegisterEnvelopeRoutesV3(r *gin.RouterGroup)

RegisterEnvelopeRoutes registers the routes for envelopes with the RouterGroup that is passed.

func (Controller) RegisterGoalRoutesV3 ¶ added in v3.21.0

func (co Controller) RegisterGoalRoutesV3(r *gin.RouterGroup)

func (Controller) RegisterHealthzRoutes ¶ added in v3.3.0

func (co Controller) RegisterHealthzRoutes(r *gin.RouterGroup)

RegisterHealthzRoutes registers the routes for the healthz endpoint.

func (Controller) RegisterImportRoutes ¶

func (co Controller) RegisterImportRoutes(r *gin.RouterGroup)

RegisterImportRoutes registers the routes for imports.

func (Controller) RegisterImportRoutesV3 ¶ added in v3.11.0

func (co Controller) RegisterImportRoutesV3(r *gin.RouterGroup)

RegisterImportRoutes registers the routes for imports.

func (Controller) RegisterMatchRuleRoutes ¶ added in v3.1.2

func (co Controller) RegisterMatchRuleRoutes(r *gin.RouterGroup)

RegisterMatchRuleRoutes registers the routes for matchRules with the RouterGroup that is passed.

func (Controller) RegisterMatchRuleRoutesV3 ¶ added in v3.10.0

func (co Controller) RegisterMatchRuleRoutesV3(r *gin.RouterGroup)

RegisterMatchRuleRoutesV3 registers the routes for matchRules with the RouterGroup that is passed.

func (Controller) RegisterMonthConfigRoutes ¶

func (co Controller) RegisterMonthConfigRoutes(r *gin.RouterGroup)

RegisterMonthConfigRoutes registers the routes for transactions with the RouterGroup that is passed.

func (Controller) RegisterMonthConfigRoutesV3 ¶ added in v3.17.0

func (co Controller) RegisterMonthConfigRoutesV3(r *gin.RouterGroup)

RegisterMonthConfigRoutesV3 registers the routes for transactions with the RouterGroup that is passed.

func (Controller) RegisterMonthRoutes ¶

func (co Controller) RegisterMonthRoutes(r *gin.RouterGroup)

RegisterMonthRoutes registers the routes for months with the RouterGroup that is passed.

func (Controller) RegisterMonthRoutesV3 ¶ added in v3.19.0

func (co Controller) RegisterMonthRoutesV3(r *gin.RouterGroup)

RegisterMonthRoutesV3 registers the routes for months with the RouterGroup that is passed.

func (Controller) RegisterRenameRuleRoutes ¶

func (co Controller) RegisterRenameRuleRoutes(r *gin.RouterGroup)

RegisterRenameRuleRoutes registers the routes for renameRules with the RouterGroup that is passed.

func (Controller) RegisterTransactionRoutes ¶

func (co Controller) RegisterTransactionRoutes(r *gin.RouterGroup)

RegisterTransactionRoutes registers the routes for transactions with the RouterGroup that is passed.

func (Controller) RegisterTransactionRoutesV2 ¶

func (co Controller) RegisterTransactionRoutesV2(r *gin.RouterGroup)

RegisterTransactionRoutesV2 registers the routes for transactions with the RouterGroup that is passed.

func (Controller) RegisterTransactionRoutesV3 ¶ added in v3.5.0

func (co Controller) RegisterTransactionRoutesV3(r *gin.RouterGroup)

RegisterTransactionRoutesV3 registers the routes for transactions with the RouterGroup that is passed.

func (Controller) SetAllocations ¶

func (co Controller) SetAllocations(c *gin.Context)

SetAllocations sets all allocations for a month

@Summary		Set allocations for a month
@Description	Sets allocations for a month for all envelopes that do not have an allocation yet
@Tags			Months
@Success		204
@Failure		400		{object}	httperrors.HTTPError
@Failure		404		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			budget	query		string					true	"ID formatted as string"
@Param			month	query		string					true	"The month in YYYY-MM format"
@Param			mode	body		BudgetAllocationMode	true	"Budget"
@Router			/v1/months [post]
@Deprecated		true

func (Controller) SetAllocationsMonth ¶

func (co Controller) SetAllocationsMonth(c *gin.Context)

SetAllocationsMonth sets all allocations for a specific month

@Summary		Set allocations for a month
@Description	Sets allocations for a month for all envelopes that do not have an allocation yet. **Deprecated. Use POST /month endpoint with month and budgetId query parameters instead.**
@Tags			Budgets
@Success		204
@Failure		400		{object}	httperrors.HTTPError
@Failure		404		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			month	path		string					true	"The month in YYYY-MM format"
@Param			id		path		string					true	"Budget ID formatted as string"
@Param			mode	body		BudgetAllocationMode	true	"Budget"
@Router			/v1/budgets/{id}/{month}/allocations [post]
@Deprecated		true

func (Controller) SetAllocationsV3 ¶ added in v3.19.0

func (co Controller) SetAllocationsV3(c *gin.Context)

@Summary Set allocations for a month @Description Sets allocations for a month for all envelopes that do not have an allocation yet @Tags Months @Success 204 @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param budget query string true "ID formatted as string" @Param month query string true "The month in YYYY-MM format" @Param mode body BudgetAllocationMode true "Budget" @Router /v3/months [post]

func (Controller) UpdateAccount ¶

func (co Controller) UpdateAccount(c *gin.Context)

UpdateAccount updates data for a specific account

@Summary		Update account
@Description	Updates an account. Only values to be updated need to be specified.
@Tags			Accounts
@Produce		json
@Success		200		{object}	AccountResponse
@Failure		400		{object}	httperrors.HTTPError
@Failure		404		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			id		path		string					true	"ID formatted as string"
@Param			account	body		models.AccountCreate	true	"Account"
@Router			/v1/accounts/{id} [patch]
@Deprecated		true

func (Controller) UpdateAccountV3 ¶ added in v3.14.0

func (co Controller) UpdateAccountV3(c *gin.Context)

@Summary Update account @Description Updates an account. Only values to be updated need to be specified. @Tags Accounts @Produce json @Success 200 {object} AccountResponseV3 @Failure 400 {object} AccountResponseV3 @Failure 404 {object} AccountResponseV3 @Failure 500 {object} AccountResponseV3 @Param id path string true "ID formatted as string" @Param account body AccountCreateV3 true "Account" @Router /v3/accounts/{id} [patch]

func (Controller) UpdateAllocation ¶

func (co Controller) UpdateAllocation(c *gin.Context)

UpdateAllocation updates allocation data

@Summary		Update allocation
@Description	Update an allocation. Only values to be updated need to be specified.
@Tags			Allocations
@Accept			json
@Produce		json
@Success		200			{object}	AllocationResponse
@Failure		400			{object}	httperrors.HTTPError
@Failure		404			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			id			path		string					true	"ID formatted as string"
@Param			allocation	body		models.AllocationCreate	true	"Allocation"
@Router			/v1/allocations/{id} [patch]
@Deprecated		true

func (Controller) UpdateBudget ¶

func (co Controller) UpdateBudget(c *gin.Context)

UpdateBudget updates data for a budget

@Summary		Update budget
@Description	Update an existing budget. Only values to be updated need to be specified.
@Tags			Budgets
@Accept			json
@Produce		json
@Success		200		{object}	BudgetResponse
@Failure		400		{object}	httperrors.HTTPError
@Failure		404		{object}	httperrors.HTTPError
@Failure		500		{object}	httperrors.HTTPError
@Param			id		path		string				true	"ID formatted as string"
@Param			budget	body		models.BudgetCreate	true	"Budget"
@Router			/v1/budgets/{id} [patch]
@Deprecated		true

func (Controller) UpdateBudgetV3 ¶ added in v3.12.0

func (co Controller) UpdateBudgetV3(c *gin.Context)

@Summary Update budget @Description Update an existing budget. Only values to be updated need to be specified. @Tags Budgets @Accept json @Produce json @Success 200 {object} BudgetResponseV3 @Failure 400 {object} BudgetResponseV3 @Failure 404 {object} BudgetResponseV3 @Failure 500 {object} BudgetResponseV3 @Param id path string true "ID formatted as string" @Param budget body models.BudgetCreate true "Budget" @Router /v3/budgets/{id} [patch]

func (Controller) UpdateCategory ¶

func (co Controller) UpdateCategory(c *gin.Context)

UpdateCategory updates data for a specific category

@Summary		Update category
@Description	Update an existing category. Only values to be updated need to be specified.
@Tags			Categories
@Accept			json
@Produce		json
@Success		200			{object}	CategoryResponse
@Failure		400			{object}	httperrors.HTTPError
@Failure		404			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			id			path		string					true	"ID formatted as string"
@Param			category	body		models.CategoryCreate	true	"Category"
@Router			/v1/categories/{id} [patch]
@Deprecated		true

func (Controller) UpdateCategoryV3 ¶ added in v3.16.0

func (co Controller) UpdateCategoryV3(c *gin.Context)

@Summary Update category @Description Update an existing category. Only values to be updated need to be specified. @Tags Categories @Accept json @Produce json @Success 200 {object} CategoryResponseV3 @Failure 400 {object} CategoryResponseV3 @Failure 404 {object} CategoryResponseV3 @Failure 500 {object} CategoryResponseV3 @Param id path string true "ID formatted as string" @Param category body CategoryCreateV3 true "Category" @Router /v3/categories/{id} [patch]

func (Controller) UpdateEnvelope ¶

func (co Controller) UpdateEnvelope(c *gin.Context)

@Summary Update envelope @Description Updates an existing envelope. Only values to be updated need to be specified. @Tags Envelopes @Accept json @Produce json @Success 200 {object} EnvelopeResponse @Failure 400 {object} httperrors.HTTPError @Failure 404 {object} httperrors.HTTPError @Failure 500 {object} httperrors.HTTPError @Param id path string true "ID formatted as string" @Param envelope body models.EnvelopeCreate true "Envelope" @Router /v1/envelopes/{id} [patch] @Deprecated true

func (Controller) UpdateEnvelopeV3 ¶ added in v3.15.0

func (co Controller) UpdateEnvelopeV3(c *gin.Context)

@Summary Update envelope @Description Updates an existing envelope. Only values to be updated need to be specified. @Tags Envelopes @Accept json @Produce json @Success 200 {object} EnvelopeResponseV3 @Failure 400 {object} EnvelopeResponseV3 @Failure 404 {object} EnvelopeResponseV3 @Failure 500 {object} EnvelopeResponseV3 @Param id path string true "ID formatted as string" @Param envelope body controllers.EnvelopeCreateV3 true "Envelope" @Router /v3/envelopes/{id} [patch]

func (Controller) UpdateGoalV3 ¶ added in v3.21.0

func (co Controller) UpdateGoalV3(c *gin.Context)

@Summary Update goal @Description Updates an existing goal. Only values to be updated need to be specified. @Tags Goals @Accept json @Produce json @Success 200 {object} GoalResponseV3 @Failure 400 {object} GoalResponseV3 @Failure 404 {object} GoalResponseV3 @Failure 500 {object} GoalResponseV3 @Param id path string true "ID formatted as string" @Param goal body GoalV3Editable true "Goal" @Router /v3/goals/{id} [patch]

func (Controller) UpdateMatchRule ¶ added in v3.1.2

func (co Controller) UpdateMatchRule(c *gin.Context)

UpdateMatchRule updates matchRule data

@Summary		Update matchRule
@Description	Update an matchRule. Only values to be updated need to be specified.
@Tags			MatchRules
@Accept			json
@Produce		json
@Success		200			{object}	models.MatchRule
@Failure		400			{object}	httperrors.HTTPError
@Failure		404			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			id			path		string					true	"ID formatted as string"
@Param			matchRule	body		models.MatchRuleCreate	true	"MatchRule"
@Router			/v2/match-rules/{id} [patch]
@Deprecated		true

func (Controller) UpdateMatchRuleV3 ¶ added in v3.10.0

func (co Controller) UpdateMatchRuleV3(c *gin.Context)

@Summary Update matchRule @Description Update a matchRule. Only values to be updated need to be specified. @Tags MatchRules @Accept json @Produce json @Success 200 {object} MatchRuleResponseV3 @Failure 400 {object} MatchRuleResponseV3 @Failure 404 {object} MatchRuleResponseV3 @Failure 500 {object} MatchRuleResponseV3 @Param id path string true "ID formatted as string" @Param matchRule body models.MatchRuleCreate true "MatchRule" @Router /v3/match-rules/{id} [patch]

func (Controller) UpdateMonthConfig ¶

func (co Controller) UpdateMonthConfig(c *gin.Context)

UpdateMonthConfig updates configuration data for a specific envelope and month

@Summary		Update MonthConfig
@Description	Changes settings of an existing MonthConfig
@Tags			MonthConfigs
@Produce		json
@Success		201			{object}	MonthConfigResponse
@Failure		400			{object}	httperrors.HTTPError
@Failure		404			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			id			path		string						true	"ID of the Envelope"
@Param			month		path		string						true	"The month in YYYY-MM format"
@Param			monthConfig	body		models.MonthConfigCreate	true	"MonthConfig"
@Router			/v1/month-configs/{id}/{month} [patch]
@Deprecated		true

func (Controller) UpdateMonthConfigV3 ¶ added in v3.17.0

func (co Controller) UpdateMonthConfigV3(c *gin.Context)

@Summary Update MonthConfig @Description Changes configuration for a Month. If there is no configuration for the month yet, this endpoint transparently creates a configuration resource. @Tags Envelopes @Produce json @Success 201 {object} MonthConfigResponseV3 @Failure 400 {object} MonthConfigResponseV3 @Failure 404 {object} MonthConfigResponseV3 @Failure 500 {object} MonthConfigResponseV3 @Param id path string true "ID of the Envelope" @Param month path string true "The month in YYYY-MM format" @Param monthConfig body MonthConfigCreateV3 true "MonthConfig" @Router /v3/envelopes/{id}/{month} [patch]

func (Controller) UpdateRenameRule ¶

func (co Controller) UpdateRenameRule(c *gin.Context)

UpdateRenameRule updates renameRule data

@Summary		Update renameRule
@Description	Update an renameRule. Only values to be updated need to be specified.
@Tags			RenameRules
@Accept			json
@Produce		json
@Success		200	{object}	RenameRuleResponse
@Failure		400	{object}	httperrors.HTTPError
@Failure		404
@Failure		500			{object}	httperrors.HTTPError
@Param			id			path		string					true	"ID formatted as string"
@Param			renameRule	body		models.MatchRuleCreate	true	"RenameRule"
@Router			/v2/rename-rules/{id} [patch]
@Deprecated		true

func (Controller) UpdateTransaction ¶

func (co Controller) UpdateTransaction(c *gin.Context)

UpdateTransaction updates a specific transaction

@Summary		Update transaction
@Description	Updates an existing transaction. Only values to be updated need to be specified.
@Tags			Transactions
@Accept			json
@Produce		json
@Success		200			{object}	TransactionResponse
@Failure		400			{object}	httperrors.HTTPError
@Failure		404			{object}	httperrors.HTTPError
@Failure		500			{object}	httperrors.HTTPError
@Param			id			path		string						true	"ID formatted as string"
@Param			transaction	body		models.TransactionCreate	true	"Transaction"
@Router			/v1/transactions/{id} [patch]
@Deprecated		true

func (Controller) UpdateTransactionV3 ¶ added in v3.8.0

func (co Controller) UpdateTransactionV3(c *gin.Context)

@Summary Update transaction @Description Updates an existing transaction. Only values to be updated need to be specified. @Tags Transactions @Accept json @Produce json @Success 200 {object} TransactionResponseV3 @Failure 400 {object} TransactionResponseV3 @Failure 404 {object} TransactionResponseV3 @Failure 500 {object} TransactionResponseV3 @Param id path string true "ID formatted as string" @Param transaction body models.TransactionCreate true "Transaction" @Router /v3/transactions/{id} [patch]

func (EnvelopeCreateV3) ToCreate ¶ added in v3.19.1

func (e EnvelopeCreateV3) ToCreate() models.EnvelopeCreate

ToCreate transforms the API representation into the model representation

func (EnvelopeQueryFilter) ToCreate ¶

func (f EnvelopeQueryFilter) ToCreate(c *gin.Context) (models.EnvelopeCreate, bool)

func (EnvelopeQueryFilterV3) ToCreate ¶ added in v3.15.0

func (f EnvelopeQueryFilterV3) ToCreate() (models.EnvelopeCreate, httperrors.Error)

func (MatchRuleQueryFilter) Parse ¶ added in v3.1.2

func (f MatchRuleQueryFilter) Parse(c *gin.Context) (models.MatchRuleCreate, httperrors.Error)

Parse returns a models.MatchRuleCreate struct that represents the MatchRuleQueryFilter.

func (MatchRuleQueryFilterV3) Parse ¶ added in v3.10.0

func (f MatchRuleQueryFilterV3) Parse() (models.MatchRuleCreate, httperrors.Error)

Parse returns a models.MatchRuleCreate struct that represents the MatchRuleQueryFilter.

func (MonthConfigCreateV3) ToCreate ¶ added in v3.18.0

func (m MonthConfigCreateV3) ToCreate() (create models.MonthConfigCreate)

ToCreate is used to transform the API representation into the model representation

func (MonthConfigQueryFilter) Parse ¶

func (m MonthConfigQueryFilter) Parse(c *gin.Context) (MonthConfigFilter, bool)

func (RenameRuleQueryFilter) Parse ¶

func (f RenameRuleQueryFilter) Parse(c *gin.Context) (models.MatchRuleCreate, bool)

func (TransactionQueryFilterV1) ToCreateHandleErrors ¶ added in v3.5.0

func (f TransactionQueryFilterV1) ToCreateHandleErrors(c *gin.Context) (models.TransactionCreate, bool)

ToCreateHandleErrors parses the query string and returns a TransactionCreate struct for the database request.

This method is deprecated, use ToCreate() and handle errors in the calling method.

func (TransactionQueryFilterV3) ToCreate ¶ added in v3.5.0

func (f TransactionQueryFilterV3) ToCreate() (models.TransactionCreate, httperrors.Error)

ToCreate parses the query string and returns a TransactionCreate struct for the database request. On error, it returns httperrors.ErrorStatus struct with.