feat: cash advance

internal/entities/cash_advance.go

@@ -0,0 +1,63 @@
+package entities
+
+import (
+	"time"
+
+	"github.com/google/uuid"
+
+	"gorm.io/gorm"
+)
+
+// CashAdvance is money handed to a team up front so it can go shopping — kasbon in
+// the Indonesian UI. While the cash is out it is still the outlet's, not a cost, so
+// nothing about what the team bought lives here: that is read back from the purchase
+// orders and expenses charged to the advance.
+type CashAdvance struct {
+	ID             uuid.UUID `gorm:"type:uuid;primary_key;default:gen_random_uuid()" json:"id"`
+	OrganizationID uuid.UUID `gorm:"type:uuid;not null;index" json:"organization_id"`
+	OutletID       uuid.UUID `gorm:"type:uuid;not null;index" json:"outlet_id"`
+	CodeNumber     string    `gorm:"not null;size:50" json:"code_number"`
+	// An advance is always handed to a team, so unlike a purchase order it has no
+	// "not chosen yet" state. TeamCategoryID is set only when the scope is category.
+	TeamScope      string     `gorm:"not null;size:20;index" json:"team_scope"`
+	TeamCategoryID *uuid.UUID `gorm:"type:uuid;index" json:"team_category_id"`
+	Amount         float64    `gorm:"type:decimal(15,2);not null;default:0" json:"amount"`
+	ReturnedAmount float64    `gorm:"type:decimal(15,2);not null;default:0" json:"returned_amount"`
+	IssuedDate     time.Time  `gorm:"type:date;not null" json:"issued_date"`
+	DueDate        *time.Time `gorm:"type:date" json:"due_date"`
+	Status         string     `gorm:"not null;size:20;default:'draft'" json:"status"`
+	Description    *string    `gorm:"type:text" json:"description"`
+	CreatedAt      time.Time  `gorm:"autoCreateTime" json:"created_at"`
+	UpdatedAt      time.Time  `gorm:"autoUpdateTime" json:"updated_at"`
+
+	// SettledAmount is filled in by the read queries from the spending charged to
+	// this advance. It has no column of its own, so it can never drift out of step
+	// with the purchases behind it; the arrow tag keeps writes from touching it.
+	SettledAmount float64 `gorm:"->;-:migration" json:"settled_amount"`
+
+	Organization *Organization `gorm:"foreignKey:OrganizationID" json:"organization,omitempty"`
+	Outlet       *Outlet       `gorm:"foreignKey:OutletID" json:"outlet,omitempty"`
+	TeamCategory *Category     `gorm:"foreignKey:TeamCategoryID" json:"team_category,omitempty"`
+}
+
+func (k *CashAdvance) BeforeCreate(tx *gorm.DB) error {
+	if k.ID == uuid.Nil {
+		k.ID = uuid.New()
+	}
+	return nil
+}
+
+func (CashAdvance) TableName() string {
+	return "cash_advances"
+}
+
+// CashAdvanceSettlement is one piece of spending charged to an advance. It is read
+// out of purchase_orders and expenses, so it has no table of its own.
+type CashAdvanceSettlement struct {
+	Type   string    `json:"type"`
+	ID     uuid.UUID `json:"id"`
+	Number string    `json:"number"`
+	Date   time.Time `json:"date"`
+	Amount float64   `json:"amount"`
+	Status string    `json:"status"`
+}

internal/entities/entities.go

@@ -43,6 +43,7 @@ func GetAllEntities() []interface{} {
 		&NotificationDelivery{},
 		&ProductOutletPrice{},
 		&Expense{},
+		&CashAdvance{},
 	}
 }
 

internal/entities/expense.go

@@ -20,11 +20,14 @@ type Expense struct {
 	Tax             float64   `gorm:"type:decimal(15,2);not null;default:0" json:"tax"`
 	Total           float64   `gorm:"type:decimal(15,2);not null;default:0" json:"total"`
 	Reserved1       *string   `gorm:"type:text" json:"reserved1"`
-	CreatedAt       time.Time `gorm:"autoCreateTime" json:"created_at"`
-	UpdatedAt       time.Time `gorm:"autoUpdateTime" json:"updated_at"`
+	// CashAdvanceID is set when the expense was paid out of cash advanced to a team.
+	CashAdvanceID *uuid.UUID `gorm:"type:uuid;index" json:"cash_advance_id"`
+	CreatedAt     time.Time  `gorm:"autoCreateTime" json:"created_at"`
+	UpdatedAt     time.Time  `gorm:"autoUpdateTime" json:"updated_at"`
 
 	Organization *Organization `gorm:"foreignKey:OrganizationID" json:"organization,omitempty"`
 	Outlet       *Outlet       `gorm:"foreignKey:OutletID" json:"outlet,omitempty"`
+	CashAdvance  *CashAdvance  `gorm:"foreignKey:CashAdvanceID" json:"cash_advance,omitempty"`
 	Items        []ExpenseItem `gorm:"foreignKey:ExpenseID" json:"items,omitempty"`
 }
 

internal/entities/purchase_order.go

@@ -24,13 +24,17 @@ type PurchaseOrder struct {
 	// 'central' for Pusat. Nil means no team was chosen, which is not the same as Pusat.
 	TeamScope      *string    `gorm:"size:20;index" json:"team_scope" validate:"omitempty,oneof=category central"`
 	TeamCategoryID *uuid.UUID `gorm:"type:uuid;index" json:"team_category_id" validate:"omitempty"`
-	CreatedAt      time.Time  `gorm:"autoCreateTime" json:"created_at"`
-	UpdatedAt      time.Time  `gorm:"autoUpdateTime" json:"updated_at"`
+	// CashAdvanceID is set when the purchase was paid out of cash advanced to the team.
+	// It is what accounts for that advance, so the cash advance holds no copy of the items.
+	CashAdvanceID *uuid.UUID `gorm:"type:uuid;index" json:"cash_advance_id" validate:"omitempty"`
+	CreatedAt     time.Time  `gorm:"autoCreateTime" json:"created_at"`
+	UpdatedAt     time.Time  `gorm:"autoUpdateTime" json:"updated_at"`
 
 	Organization *Organization             `gorm:"foreignKey:OrganizationID" json:"organization,omitempty"`
 	Outlet       *Outlet                   `gorm:"foreignKey:OutletID" json:"outlet,omitempty"`
 	Vendor       *Vendor                   `gorm:"foreignKey:VendorID" json:"vendor,omitempty"`
 	TeamCategory *Category                 `gorm:"foreignKey:TeamCategoryID" json:"team_category,omitempty"`
+	CashAdvance  *CashAdvance              `gorm:"foreignKey:CashAdvanceID" json:"cash_advance,omitempty"`
 	Items        []PurchaseOrderItem       `gorm:"foreignKey:PurchaseOrderID" json:"items,omitempty"`
 	Attachments  []PurchaseOrderAttachment `gorm:"foreignKey:PurchaseOrderID" json:"attachments,omitempty"`
 }