ledger

Documentation

Index

• type Accrual
  • func (a *Accrual) Expand() ([]*Transaction, error)
  • func (a *Accrual) Position() model.Range
• type Assertion
  • func (a Assertion) Position() model.Range
• type Builder
  • func NewBuilder(f Filter) *Builder
  • func (b *Builder) AddAssertion(a *Assertion)
  • func (b *Builder) AddClosing(close *Close)
  • func (b *Builder) AddOpening(o *Open)
  • func (b *Builder) AddPrice(p *Price)
  • func (b *Builder) AddTransaction(t *Transaction)
  • func (b *Builder) AddValue(a *Value)
  • func (b *Builder) Build() Ledger
• type Close
  • func (c Close) Position() model.Range
• type Day
• type Directive
• type Filter
• type Include
  • func (i Include) Position() model.Range
• type Ledger
  • func FromDirectives(filter Filter, results <-chan interface{}) (Ledger, error)
  • func (l Ledger) MaxDate() (time.Time, bool)
  • func (l Ledger) MinDate() (time.Time, bool)
• type Lot
• type Open
  • func (o Open) Position() model.Range
• type Posting
  • func NewPosting(crAccount, drAccount *accounts.Account, commodity *commodities.Commodity, ...) *Posting
• type Price
  • func (p Price) Position() model.Range
• type Tag
• type Transaction
  • func (t Transaction) Position() model.Range
• type Value
  • func (v Value) Position() model.Range

Types

type Accrual

type Accrual struct {
	Pos         model.Range
	Period      date.Period
	T0, T1      time.Time
	Account     *accounts.Account
	Transaction *Transaction
}

Accrual represents an accrual.

func (*Accrual) Expand

func (a *Accrual) Expand() ([]*Transaction, error)

Expand expands an accrual transaction.

func (*Accrual) Position

func (a *Accrual) Position() model.Range

Position returns the position.

type Assertion

type Assertion struct {
	Pos       model.Range
	Date      time.Time
	Account   *accounts.Account
	Amount    decimal.Decimal
	Commodity *commodities.Commodity
}

Assertion represents a balance assertion.

func (Assertion) Position

func (a Assertion) Position() model.Range

Position returns the model.Range.

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

Builder maps dates to days

func NewBuilder

func NewBuilder(f Filter) *Builder

NewBuilder creates a new builder.

func (*Builder) AddAssertion

func (b *Builder) AddAssertion(a *Assertion)

AddAssertion adds an assertion directive.

func (*Builder) AddClosing

func (b *Builder) AddClosing(close *Close)

AddClosing adds a close directive.

func (*Builder) AddOpening

func (b *Builder) AddOpening(o *Open)

AddOpening adds an open directive.

func (*Builder) AddPrice

func (b *Builder) AddPrice(p *Price)

AddPrice adds a price directive.

func (*Builder) AddTransaction

func (b *Builder) AddTransaction(t *Transaction)

AddTransaction adds a transaction directive.

func (*Builder) AddValue

func (b *Builder) AddValue(a *Value)

AddValue adds an value directive.

func (*Builder) Build

func (b *Builder) Build() Ledger

Build creates a new

type Close

type Close struct {
	Pos     model.Range
	Date    time.Time
	Account *accounts.Account
}

Close represents a close command.

func (Close) Position

func (c Close) Position() model.Range

Position returns the position.

type Day

type Day struct {
	Date         time.Time
	Prices       []*Price
	Assertions   []*Assertion
	Values       []*Value
	Openings     []*Open
	Transactions []*Transaction
	Closings     []*Close
}

Day groups all commands for a given date.

type Directive

type Directive interface {
	Position() model.Range
}

Directive is an element in a journal with a position.

type Filter

type Filter struct {
	AccountsFilter, CommoditiesFilter *regexp.Regexp
}

Filter represents a filter creating a ledger.

type Include

type Include struct {
	Pos  model.Range
	Date time.Time
	Path string
}

Include represents an include directive.

func (Include) Position

func (i Include) Position() model.Range

Position returns the model.Range.

type Ledger

type Ledger []*Day

Ledger is a ledger.

func FromDirectives

func FromDirectives(filter Filter, results <-chan interface{}) (Ledger, error)

FromDirectives reads directives from the given channel and builds a Ledger if successful.

func (Ledger) MaxDate

func (l Ledger) MaxDate() (time.Time, bool)

MaxDate returns the maximum date for the given ledger.

func (Ledger) MinDate

func (l Ledger) MinDate() (time.Time, bool)

MinDate returns the minimum date for this ledger, as the first date on which an account is opened (ignoring prices, for example).

type Lot

type Lot struct {
	Date      time.Time
	Label     string
	Price     float64
	Commodity *commodities.Commodity
}

Lot represents a lot.

type Open

type Open struct {
	Pos     model.Range
	Date    time.Time
	Account *accounts.Account
}

Open represents an open command.

func (Open) Position

func (o Open) Position() model.Range

Position returns the position.

type Posting

type Posting struct {
	Amount, Value decimal.Decimal
	Credit, Debit *accounts.Account
	Commodity     *commodities.Commodity
	Lot           *Lot
}

Posting represents a posting.

func NewPosting

func NewPosting(crAccount, drAccount *accounts.Account, commodity *commodities.Commodity, amt decimal.Decimal) *Posting

NewPosting creates a new posting from the given parameters. If amount is negative, it will be inverted and the accounts reversed.

type Price

type Price struct {
	Pos       model.Range
	Date      time.Time
	Commodity *commodities.Commodity
	Target    *commodities.Commodity
	Price     decimal.Decimal
}

Price represents a price command.

func (Price) Position

func (p Price) Position() model.Range

Position returns the model.Range.

type Tag

type Tag string

Tag represents a tag for a transaction or booking.

type Transaction

type Transaction struct {
	Pos         model.Range
	Date        time.Time
	Description string
	Tags        []Tag
	Postings    []*Posting
}

Transaction represents a transaction.

func (Transaction) Position

func (t Transaction) Position() model.Range

Position returns the Position.

type Value

type Value struct {
	Pos       model.Range
	Date      time.Time
	Account   *accounts.Account
	Amount    decimal.Decimal
	Commodity *commodities.Commodity
}

Value represents a value directive.

func (Value) Position

func (v Value) Position() model.Range

Position returns the model.Range.