reports

package
v0.22.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 23, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package reports implements the production of various common reports from bookkeeping data.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountLedger added in v0.20.0

type AccountLedger struct {
	Account journal.Account
	Rows    []LedgerRow
}

An AccountLedger represents the ledger for one account.

func NewAccountLedger added in v0.20.0

func NewAccountLedger(j *journal.Journal, a journal.Account) *AccountLedger

type LedgerRow added in v0.20.0

type LedgerRow struct {
	Date        civil.Date
	Description string
	// A reference to the file location for the transaction split.
	Ref  string
	Pair Pair[*journal.Amount]
	// Running balance for the account.
	Balance journal.Balance
}

A LedgerRow represents a row in an AccountLedger.

type Pair

type Pair[T any] struct {
	Debit  T
	Credit T
}

A Pair is a Debit-Credit pair.

type TrialBalance

type TrialBalance struct {
	Rows  []TrialBalanceRow
	Total Pair[journal.Balance]
}

A TrialBalance represents a trial balance report.

func NewTrialBalance

func NewTrialBalance(j *journal.Journal) *TrialBalance

NewTrialBalance creates a trial balance report.

type TrialBalanceRow

type TrialBalanceRow struct {
	Account journal.Account
	Pairs   []Pair[*journal.Amount]
}

A TrialBalanceRow represents a row in a TrialBalance.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL