ofx

README

ofx

OFX library in Golang

Documentation

Index

• type AccountType
• type Amount
  • func (a *Amount) ParseFromString(s string) error
• type Ofx
  • func Parse(f io.Reader) (*Ofx, error)
  • func (o Ofx) String() string
• type Transaction
  • func (t Transaction) String() string
• type TransactionType
  • func (i TransactionType) String() string

Types

type AccountType

type AccountType int

AccountType indicates type of account represented by OFX document.

const (
	// UNKNOWN - Account type could not be determined
	UNKNOWN AccountType = iota
	// CHECKING - Checking account
	CHECKING AccountType = iota
	// SAVING - Savings account
	SAVING AccountType = iota
)

type Amount

type Amount struct {
	Value big.Rat
}

func (*Amount) ParseFromString

func (a *Amount) ParseFromString(s string) error

type Ofx

type Ofx struct {
	Type          AccountType
	BankCode      string
	BranchCode    string
	AccountNumber string
	Transactions  []*Transaction
}

Ofx contains a parsed Ofx document.

func Parse

func Parse(f io.Reader) (*Ofx, error)

Parse parses an input stream and produces an Ofx instance summarizing it. In case of any errors during the parse, a non-nil error is returned.

func (Ofx) String

func (o Ofx) String() string

type Transaction

type Transaction struct {
	Type        TransactionType
	Description string
	Memo        string
	PostedDate  time.Time
	UserDate    time.Time
	ID          string
	Amount      Amount
}

func (Transaction) String

func (t Transaction) String() string

type TransactionType

type TransactionType int

TransactionType indicates type of transaction (Debit/Credit).

const (
	DEBIT  TransactionType = iota
	CREDIT TransactionType = iota
)

func (TransactionType) String

func (i TransactionType) String() string