billing

Documentation

Index

• type BudgetStatus
  • func NewBudgetStatus(budgetHours, totalMinutes int) *BudgetStatus
• type CostReport
  • func NewCostReport(currency string) *CostReport
  • func (cr *CostReport) AddEntry(entry CostReportEntry, tax *TaxConfig)
  • func (cr *CostReport) CSV() string
  • func (cr *CostReport) SetTax(tax *TaxConfig)
• type CostReportEntry
• type Rate
  • func NewRate(id, name string, hourlyRate float64, isDefault bool) (Rate, error)
• type RateConfig
  • func (rc *RateConfig) AddRate(rate Rate) error
  • func (rc *RateConfig) GetByID(id string) *Rate
  • func (rc *RateConfig) GetDefault() *Rate
  • func (rc *RateConfig) RemoveRate(rateID string) error
  • func (rc *RateConfig) SetDefault(rateID string) error
• type Repository
• type TaxConfig
• type TimeEntry
  • func NewTimeEntry(id, taskID, rateID string, minutes int, description string, ...) (TimeEntry, error)
  • func (te *TimeEntry) Hours() float64

Types

type BudgetStatus

type BudgetStatus struct {
	BudgetHours int     `json:"budget_hours"`
	UsedHours   float64 `json:"used_hours"`
	Remaining   float64 `json:"remaining"`
	PercentUsed float64 `json:"percent_used"`
	OverBudget  bool    `json:"over_budget"`
}

BudgetStatus represents the current budget consumption state.

func NewBudgetStatus

func NewBudgetStatus(budgetHours, totalMinutes int) *BudgetStatus

NewBudgetStatus creates a BudgetStatus from budget hours and total consumed minutes.

type CostReport

type CostReport struct {
	GeneratedAt  time.Time         `json:"generated_at"`
	Currency     string            `json:"currency"`
	Period       string            `json:"period,omitempty"`
	TaxName      string            `json:"tax_name,omitempty"`
	TaxPercent   float64           `json:"tax_percent,omitempty"`
	Entries      []CostReportEntry `json:"entries"`
	TotalHours   float64           `json:"total_hours"`
	TotalCost    float64           `json:"total_cost"`
	TotalTax     float64           `json:"total_tax"`
	TotalWithTax float64           `json:"total_with_tax"`
}

func NewCostReport

func NewCostReport(currency string) *CostReport

func (*CostReport) AddEntry

func (cr *CostReport) AddEntry(entry CostReportEntry, tax *TaxConfig)

func (*CostReport) CSV

func (cr *CostReport) CSV() string

func (*CostReport) SetTax

func (cr *CostReport) SetTax(tax *TaxConfig)

type CostReportEntry

type CostReportEntry struct {
	TaskID       string  `json:"task_id"`
	Title        string  `json:"title"`
	RateID       string  `json:"rate_id"`
	RateName     string  `json:"rate_name"`
	Hours        float64 `json:"hours"`
	HourlyRate   float64 `json:"hourly_rate"`
	Cost         float64 `json:"cost"`
	Currency     string  `json:"currency"`
	Description  string  `json:"description,omitempty"`
	Tax          float64 `json:"tax,omitempty"`
	TotalWithTax float64 `json:"total_with_tax,omitempty"`
}

type Rate

type Rate struct {
	ID         string  `yaml:"id" json:"id"`
	Name       string  `yaml:"name" json:"name"`
	HourlyRate float64 `yaml:"hourly_rate" json:"hourly_rate"`
	IsDefault  bool    `yaml:"default" json:"default"`
}

func NewRate

func NewRate(id, name string, hourlyRate float64, isDefault bool) (Rate, error)

NewRate creates a validated Rate value object.

type RateConfig

type RateConfig struct {
	Currency string     `yaml:"currency" json:"currency"`
	Tax      *TaxConfig `yaml:"tax,omitempty" json:"tax,omitempty"`
	Rates    []Rate     `yaml:"rates" json:"rates"`
}

func (*RateConfig) AddRate

func (rc *RateConfig) AddRate(rate Rate) error

AddRate adds a rate to the config, enforcing uniqueness and single-default.

func (*RateConfig) GetByID

func (rc *RateConfig) GetByID(id string) *Rate

func (*RateConfig) GetDefault

func (rc *RateConfig) GetDefault() *Rate

func (*RateConfig) RemoveRate

func (rc *RateConfig) RemoveRate(rateID string) error

RemoveRate removes a rate by ID.

func (*RateConfig) SetDefault

func (rc *RateConfig) SetDefault(rateID string) error

SetDefault marks the given rate as default, clearing default from all others.

type Repository

type Repository interface {
	SaveRates(config *RateConfig) error
	LoadRates() (*RateConfig, error)
	SaveTimeEntries(entries []TimeEntry) error
	LoadTimeEntries() ([]TimeEntry, error)
}

Repository handles the persistence of billing artifacts. New code should depend on this interface rather than the composed WorkspaceRepository.

type TaxConfig

type TaxConfig struct {
	Name     string  `yaml:"name" json:"name"`         // e.g., "VAT", "Sales Tax"
	Percent  float64 `yaml:"percent" json:"percent"`   // e.g., 20.0 for 20%
	Included bool    `yaml:"included" json:"included"` // true if tax is included in rate
}

type TimeEntry

type TimeEntry struct {
	ID          string    `yaml:"id" json:"id"`
	TaskID      string    `yaml:"task_id" json:"task_id"`
	RateID      string    `yaml:"rate_id" json:"rate_id"`
	Minutes     int       `yaml:"minutes" json:"minutes"`
	Description string    `yaml:"description,omitempty" json:"description,omitempty"`
	CreatedAt   time.Time `yaml:"created_at" json:"created_at"`
}

func NewTimeEntry

func NewTimeEntry(id, taskID, rateID string, minutes int, description string, createdAt time.Time) (TimeEntry, error)

NewTimeEntry creates a validated TimeEntry.

func (*TimeEntry) Hours

func (te *TimeEntry) Hours() float64