types

type Address struct {
	Name     string `json:"name" yaml:"name"`
	Address  string `json:"address" yaml:"address"`
	Address2 string `json:"address2" yaml:"address2"`
	City     string `json:"city" yaml:"city"`
	State    string `json:"state" yaml:"state"`
	ZipCode  string `json:"zipCode" yaml:"zipCode"`
	Country  string `json:"country" yaml:"country"`
}

type BankAccount struct {
	*Address `json:",inline" yaml:",inline"`

	AccountNumber string `json:"accountNumber" yaml:"accountNumber"`
	RoutingNumber string `json:"routingNumber" yaml:"routingNumber"`
}

type Billable struct {
	Alias       string  `json:"alias" yaml:"alias"`
	Description string  `json:"description" yaml:"description"`
	Quantity    float64 `json:"quantity" yaml:"quantity"`
	UnitPrice   float64 `json:"unitPrice" yaml:"unitPrice"`
	Discount    float64 `json:"discount" yaml:"discount"`
	Tax         float64 `json:"tax" yaml:"tax"`
}

type BillableList []*Billable

type BuildOutput string

type Builder interface {
	// Builders can be used as readers after they have generated the invoice.
	io.ReadCloser

	// Set the font family to use when BuildInvoice is called.
	SetFontFamily(FontFamily)

	// Build an invoice with the given details
	BuildInvoice(*InvoiceDetails) error

	// Write the generated invoice to the given path
	WriteFile(path string) error

	// A convenience method for building an invoice and automatically
	// writing it to an output file.
	BuildAndWriteInvoice(info *InvoiceDetails, outpath string) error
}

type Config struct {
	// The configuration for invoices
	Invoices InvoicesConfig `json:"invoices" yaml:"invoices"`
	// The entity issuing invoices
	Payee *Entity `json:"payee" yaml:"payee"`
	// Entities eligible for invoicing.
	Payers []*Entity `json:"payers" yaml:"payers"`
	// Items that can be added to invoices
	Billables BillableList `json:"billables" yaml:"billables"`
}

type Entity struct {
	*Address `json:",inline" yaml:",inline"`

	Alias          string       `json:"alias" yaml:"alias"`
	BankAccount    *BankAccount `json:"bankAccount" yaml:"bankAccount"`
	RegistrationNo string       `json:"registrationNo" yaml:"registrationNo"`
	Email          string       `json:"email" yaml:"email"`
	Currency       string       `json:"currency" yaml:"currency"`
}

type FontFamily string

type InvoiceDetails struct {
	// The invoice number
	InvoiceNumber string
	// The date the invoice is being issued
	InvoiceDate time.Time
	// The date the invoice is due
	DueDate time.Time

	// The entity sending the invoice
	Payee *Entity
	// The entity responsible for paying the invoice
	Payer *Entity

	// The billable items in the invoice
	Items BillableList
}

type InvoicesConfig struct {
	// A prefix appended to invoice numbers
	Prefix string `json:"prefix" yaml:"prefix"`
	// A directory to store invoices by default
	Directory string `json:"directory" yaml:"directory"`
	// The font family to use for invoices
	FontFamily FontFamily `json:"fontFamily" yaml:"fontFamily"`
	// The number of zeroes to pad invoice numbers with
	ZeroPadding int `json:"zeroPadding" yaml:"zeroPadding"`
}