models

Documentation

Index

• Variables
• func ConnectDatabase() error
• func TransactionsSum(incoming, outgoing Transaction) (decimal.Decimal, error)
• type Account
  • func (a *Account) BeforeSave(tx *gorm.DB) (err error)
  • func (a Account) SumReconciledTransactions() (decimal.Decimal, error)
  • func (a Account) Transactions() []Transaction
  • func (a Account) WithCalculations() (*Account, error)
• type Allocation
• type Budget
• type BudgetMonth
• type Category
• type Envelope
  • func (e Envelope) Month(t time.Time) EnvelopeMonth
  • func (e Envelope) Spent(t time.Time) decimal.Decimal
• type EnvelopeMonth
• type Model
  • func (m *Model) AfterFind(tx *gorm.DB) (err error)
• type Transaction
  • func RawTransactions(query string) ([]Transaction, error)
  • func (t *Transaction) AfterFind(tx *gorm.DB) (err error)
  • func (t *Transaction) BeforeSave(tx *gorm.DB) (err error)

Variables

var DB *gorm.DB

DB is the database used by the backend.

Functions

func ConnectDatabase

func ConnectDatabase() error

ConnectDatabase connects to the database DB.

func TransactionsSum

func TransactionsSum(incoming, outgoing Transaction) (decimal.Decimal, error)

TransactionSums returns the sum of all transactions matching two Transaction structs

The incoming Transactions fields is used to add the amount of all matching transactions to the overall sum The outgoing Transactions fields is used to subtract the amount of all matching transactions from the overall sum.

Types

type Account

type Account struct {
	Model
	Name              string          `json:"name,omitempty"`
	BudgetID          uint64          `json:"budgetId"`
	Budget            Budget          `json:"-"`
	OnBudget          bool            `json:"onBudget"` // Always false when external: true
	External          bool            `json:"external"`
	Balance           decimal.Decimal `json:"balance" gorm:"-"`
	ReconciledBalance decimal.Decimal `json:"reconciledBalance" gorm:"-"`
}

Account represents an asset account, e.g. a bank account.

func (*Account) BeforeSave

func (a *Account) BeforeSave(tx *gorm.DB) (err error)

BeforeSave sets OnBudget to false when External is true.

func (Account) SumReconciledTransactions

func (a Account) SumReconciledTransactions() (decimal.Decimal, error)

Transactions returns all transactions for this account.

func (Account) Transactions

func (a Account) Transactions() []Transaction

Transactions returns all transactions for this account.

func (Account) WithCalculations

func (a Account) WithCalculations() (*Account, error)

WithCalculations returns a pointer to the account with the balance calculated.

type Allocation

type Allocation struct {
	Model
	Month      uint8           `json:"month" gorm:"uniqueIndex:year_month;check:month_valid,month >= 1 AND month <= 12"`
	Year       uint            `json:"year" gorm:"uniqueIndex:year_month"`
	Amount     decimal.Decimal `json:"amount" gorm:"type:DECIMAL(20,8)"`
	EnvelopeID uint64          `json:"envelopeId,omitempty"`
	Envelope   Envelope        `json:"-"`
}

Allocation represents the allocation of money to an Envelope for a specific month.

type Budget

type Budget struct {
	Model
	Name     string `json:"name,omitempty"`
	Note     string `json:"note,omitempty"`
	Currency string `json:"currency,omitempty"`
}

Budget represents a budget

A budget is the highest level of organization in Envelope Zero, all other resources reference it directly or transitively.

type BudgetMonth

type BudgetMonth struct {
	ID        uint64          `json:"id"`
	Name      string          `json:"name"`
	Month     time.Time       `json:"month"`
	Envelopes []EnvelopeMonth `json:"envelopes,omitempty"`
}

type Category

type Category struct {
	Model
	Name     string `json:"name,omitempty"`
	BudgetID uint64 `json:"budgetId"`
	Budget   Budget `json:"-"`
	Note     string `json:"note,omitempty"`
}

Category represents a category of envelopes.

type Envelope

type Envelope struct {
	Model
	Name       string   `json:"name,omitempty"`
	CategoryID uint64   `json:"categoryId"`
	Category   Category `json:"-"`
	Note       string   `json:"note,omitempty"`
}

Envelope represents an envelope in your budget.

func (Envelope) Month

func (e Envelope) Month(t time.Time) EnvelopeMonth

Month calculates the month specific values for an envelope and returns an EnvelopeMonth for them.

func (Envelope) Spent

func (e Envelope) Spent(t time.Time) decimal.Decimal

Spent returns the amount spent for the month the time.Time instance is in.

type EnvelopeMonth

type EnvelopeMonth struct {
	ID         uint64          `json:"id"`
	Name       string          `json:"name"`
	Month      time.Time       `json:"month"`
	Spent      decimal.Decimal `json:"spent"`
	Balance    decimal.Decimal `json:"balance"`
	Allocation decimal.Decimal `json:"allocation"`
}

EnvelopeMonth contains data about an Envelope for a specific month.

type Model

type Model struct {
	ID        uint64          `json:"id"`
	CreatedAt time.Time       `json:"createdAt"`
	UpdatedAt time.Time       `json:"updatedAt"`
	DeletedAt *gorm.DeletedAt `json:"deletedAt,omitempty" gorm:"index"`
}

Model is the base model for all other models in Envelope Zero.

func (*Model) AfterFind

func (m *Model) AfterFind(tx *gorm.DB) (err error)

AfterFind updates the timestamps to use UTC as timezone, not +0000. Yes, this is different.

We already store them in UTC, but somehow reading them from the database returns them as +0000.

type Transaction

type Transaction struct {
	Model
	Date                 time.Time       `json:"date,omitempty"`
	Amount               decimal.Decimal `json:"amount" gorm:"type:DECIMAL(20,8)"`
	Note                 string          `json:"note,omitempty"`
	BudgetID             uint64          `json:"budgetId,omitempty"`
	Budget               Budget          `json:"-"`
	SourceAccountID      uint64          `json:"sourceAccountId,omitempty"`
	SourceAccount        Account         `json:"-"`
	DestinationAccountID uint64          `json:"destinationAccountId,omitempty"`
	DestinationAccount   Account         `json:"-"`
	EnvelopeID           uint64          `json:"envelopeId,omitempty"`
	Envelope             Envelope        `json:"-"`
	Reconciled           bool            `json:"reconciled"`
}

Transaction represents a transaction between two accounts.

func RawTransactions

func RawTransactions(query string) ([]Transaction, error)

RawTransactions returns a list of transactions for a raw SQL query.

func (*Transaction) AfterFind

func (t *Transaction) AfterFind(tx *gorm.DB) (err error)

AfterFind updates the timestamps to use UTC as timezone, not +0000. Yes, this is different.

We already store them in UTC, but somehow reading them from the database returns them as +0000.

func (*Transaction) BeforeSave

func (t *Transaction) BeforeSave(tx *gorm.DB) (err error)

BeforeSave sets the timezone for the Date for UTC.