server

Documentation

Index

• Constants
• func Run(db plaindb.DB, ldgStore *ledger.Store, accountStore *client.AccountStore, ...) error
• type AccountMessage
• type AccountResponse
• type BalanceResponse
• type CSVRule
• type Options

Constants

const (

	// MaxResults is the maximum number of results from a paginated request
	MaxResults = 50
)

Functions

func Run

func Run(
	db plaindb.DB,
	ldgStore *ledger.Store,
	accountStore *client.AccountStore,
	rulesFile vcs.File, rulesStore *rules.Store,
	logger *zap.Logger,
	options Options,
) error

Run starts the server

Types

type AccountMessage

type AccountMessage struct {
	AccountID   string `json:",omitempty"`
	AccountName string `json:",omitempty"`
	Message     string
}

AccountMessage contains important information for an account

type AccountResponse

type AccountResponse struct {
	ID             string
	Account        string
	AccountType    string
	OpeningBalance *decimal.Decimal
	Balances       []decimal.Decimal
	Institution    string `json:",omitempty"`
}

AccountResponse contains details for an account's balance over time

type BalanceResponse

type BalanceResponse struct {
	Start, End         *time.Time
	OpeningBalanceDate *time.Time
	Messages           []AccountMessage
	Accounts           []AccountResponse
}

BalanceResponse is the response type for fetching account balances

type CSVRule

type CSVRule struct {
	Conditions []string
	Account2   string
}

CSVRule is the request model for changing a single rule

type Options

type Options struct {
	Address  string
	AutoSync bool
	Password redactor.String
}

Options contains options for configuring the Sage HTTP server