api

Documentation

Index

• func StartApiServer(ctx context.Context)
• type AccountDTO
• type AccountFormDTO
• type AccountsPageDTO
• type BalanceDTO
• type BalanceFormDTO
• type BalancesPageDTO
• type BudgetDTO
• type BudgetFormDTO
• type BudgetsPageDTO
• type ImportStatementFormDTO
• type ImportStatusPageDTO
• type TransactionDTO
• type TransactionFormDTO
• type TransactionsPageDTO

Functions

func StartApiServer

func StartApiServer(ctx context.Context)

Types

type AccountDTO

type AccountDTO struct {
	ID                 uint
	Name               string
	AccountCategory    string
	AccountType        string
	DefaultParser      *string
	Balance            string
	BalanceLastUpdated string
}

type AccountFormDTO

type AccountFormDTO struct {
	// If we're updating an existing account in the form, Updating will be true
	// If we're creating a new account, Updating will be false
	Updating        bool
	AccountID       string
	AccountName     string
	AccountCategory string
	AccountType     string
	DefaultParser   string
}

type AccountsPageDTO

type AccountsPageDTO struct {
	Accounts           []AccountDTO
	AccountSaved       bool
	CreatedAccountName string
}

type BalanceDTO

type BalanceDTO struct {
	ID            uint
	UpdatedAt     string
	Date          string
	EffectiveDate string
	Amount        string
	AccountID     uint
	AccountName   string
}

type BalanceFormDTO

type BalanceFormDTO struct {
	// If we're editing an existing account, Editing will be true
	// If we're creating a new account, Editing will be false
	Editing bool
	// we set the AccountID for the to populate the balanceForm with the accountID
	// in HTML forms, so the account ID can be passed in the form submission even
	// if there is no Balance object set
	AccountID    uint
	BalanceDTO   BalanceDTO
	ErrorMessage string
}

type BalancesPageDTO

type BalancesPageDTO struct {
	AccountID           uint
	Balances            []BalanceDTO
	BalanceSaved        bool
	BalanceSavedMessage string
}

type BudgetDTO

type BudgetDTO struct {
	ID           uint
	CategoryName string
	Amount       string
}

type BudgetFormDTO

type BudgetFormDTO struct {
	// If we're updating an existing budget in the form, Updating will be true
	// If we're creating a new budget, Updating will be false
	Updating     bool
	BudgetID     string
	CategoryName string
	Amount       string
	Categories   []models.Category
}

type BudgetsPageDTO

type BudgetsPageDTO struct {
	Budgets     []BudgetDTO
	BudgetSaved bool
}

type ImportStatementFormDTO

type ImportStatementFormDTO struct {
	AccountNamesAndIDs []services.AccountNameAndID
}

type ImportStatusPageDTO

type ImportStatusPageDTO struct {
	Submission   *models.ImportSubmission
	Transactions []TransactionDTO
}

type TransactionDTO

type TransactionDTO struct {
	ID                 uint
	Date               string
	Description        string
	Amount             string
	Excluded           bool
	AccountName        string
	CategoryName       string
	ImportSubmissionID string
}

type TransactionFormDTO

type TransactionFormDTO struct {
	// If we're editing an existing transaction, Editing will be true
	// If we're creating a new transaction, Editing will be false
	Editing            bool
	TransactionID      uint
	Date               string
	Description        string
	Amount             string
	Excluded           bool
	AccountName        string
	CategoryName       string
	ImportSubmissionID string
	Accounts           []models.Account
	Categories         []models.Category
}

type TransactionsPageDTO

type TransactionsPageDTO struct {
	Transactions           []TransactionDTO
	TransactionSaved       bool
	CreatedTransactionName string
}