item

Documentation

Index

• func DeleteItem(id primitive.ObjectID) error
• func ModifyItem(id primitive.ObjectID, ni Item) error
• func SaveItem(i Item) (primitive.ObjectID, error)
• type InvoiceItem
• type Item
  • func GetItems(filter bson.M) ([]Item, error)

Functions

func DeleteItem

func DeleteItem(id primitive.ObjectID) error

Delete item from DB

func ModifyItem

func ModifyItem(id primitive.ObjectID, ni Item) error

modify item in DB

func SaveItem

func SaveItem(i Item) (primitive.ObjectID, error)

Add item to db

Types

type InvoiceItem

type InvoiceItem struct {
	Item
	/* Each product must have a quantity
	 * but it is upto the backend to enforce that
	 */
	// TODO: float64 isn't ideal, find a better way
	Quantity           float64 `bson:"Quantitiy" json:"Quantity"`
	DiscountPercentage float64 `bson:"DiscountPercentage,omitempty" json:"DiscountPercentage"`
}

Item but with extra fields an invoice might require

type Item

type Item struct {
	Id                 primitive.ObjectID `bson:"_id,omitempty" json:"Id"`
	Brand              brand.Brand        `bson:"Brand,omitempty" json:"Brand"`
	UnitOfMeasure      string             `bson:"UnitOfMeasure" json:"UnitOfMeasure"`
	HasDecimalQuantity bool               `bson:"HasDecimalQuantity, json:"HasDecimalQuantity"`
	// just the defaults, can be overridden in an invoice
	Name        string  `bson:"Name" json:"Name"`
	Description string  `bson:"Description" json:"Description"`
	HSN         string  `bson:"HSN" json:"HSN"`
	UnitPrice   float64 `bson:"UnitPrice" json:"UnitPrice"`
	// default tax percentage
	GSTPercentage float64 `bson:"GSTPercentage" json:"GSTPercentage"`
	MaxQuantity   float64 `bson:"MaxQuantity" json:"MaxQuantity"`
	MinQuantity   float64 `bson:"MinQuantity" json:"MinQuantity"`
}

An item is any product * or service that can be sold * Items may have a max and min quanity * and some default fields like GST and Unit Price * that don't need to be entered manually * * the front-end may or may not implement * the default fields * * Items can be assigned brands * and certain actions can be performed * on the products of a brand altogether

func GetItems

func GetItems(filter bson.M) ([]Item, error)

GetItems queries the database and * returns items based on the given filter * if filter is nil every item is returned