domain

Documentation

Index

• type ErrorReport
• type IgnoredTransaction
• type MovementType
• type Notification
• type SuccessReport
• type Summary
• type Transaction

Types

type ErrorReport

type ErrorReport struct {
	FileName string
	Date     time.Time
	Error    string
}

type IgnoredTransaction

type IgnoredTransaction struct {
	ID          string
	Date        string
	Transaction string
	Reason      string
}

IgnoredTransaction represent a transaction without valid format, that was ignored

type MovementType

type MovementType string

MovementType groups the valid types of movements

const (
	Credit MovementType = "credit"
	Debit  MovementType = "debit"
)

type Notification

type Notification struct {
	Content    string
	Subject    string
	Recipients []string
	Branding   string
}

Notification contains necessary data to send notifications, for example, Summary notifications via mail

type SuccessReport

type SuccessReport struct {
	FileName           string
	Date               time.Time
	Summary            Summary
	SendTo             []string
	Transactions       []Transaction
	IgnoredTransaction []IgnoredTransaction
}

type Summary

type Summary struct {
	Total              float32
	TransactionByMonth map[time.Month]int
	AvrDebitAmount     float32
	AvrCreditAmount    float32
}

type Transaction

type Transaction struct {
	Number   int
	Date     time.Time
	Movement MovementType
	Value    float32
}

Transaction represent a formatted transaction, with its type of movement and value separate