data

package

Go to main page

Versions in this module

v0

v0.5.2

Sep 5, 2026

Changes in this version

+ func CompanyIDFromContext(ctx context.Context) (uuid.UUID, bool)

+ func WithCompanyID(ctx context.Context, companyID uuid.UUID) context.Context

v0.5.1

Sep 3, 2026

Changes in this version

+ var ErrAssetAlreadyDisposed = errors.New("this asset has already been disposed")

+ var ErrAssetLocked = errors.New(...)

+ var ErrAssetTrackingInUse = errors.New(...)

+ var ErrBranchNotInCompany = errors.New("branch does not belong to this company")

+ var ErrCorrectionCannotChangePaymentType = errors.New("paid_immediately cannot be changed via a correction")

+ var ErrInvoiceAlreadyPaid = errors.New("this invoice has already been paid in full")

+ var ErrInvoiceHasPayments = errors.New("cannot correct a procurement whose invoice already has payments recorded")

+ var ErrInvoiceOverpayment = errors.New("payment amount exceeds the invoice's remaining balance")

+ var ErrNoOpeningBalanceAmount = errors.New("enter at least one nonzero opening balance amount")

+ var ErrOpeningBalanceAlreadySet = errors.New("this branch already has an opening balance recorded")

+ var ErrRecipeFeatureDisabled = errors.New(...)

+ var ErrRecipesInUse = errors.New(...)

+ var ErrSalvageValueTooHigh = errors.New("salvage value must be less than purchase cost")

+ var ErrSupplierRequiredForCreditProcurement = errors.New("supplier_id is required for procurement on credit")

type AccountingRepoer

+ CountDepreciationPeriods func(ctx context.Context, assetID uuid.UUID) (int, error)

+ HasOpeningBalanceEntry func(ctx context.Context, companyID, branchID uuid.UUID) (bool, error)

+ ListJournalEntriesByCompanyFiltered func(ctx context.Context, companyID uuid.UUID, filter JournalEntryFilter, ...) (*dto.PaginationResults[model.JournalEntry], error)

+ type AssetRepoer interface

+ Create func(ctx context.Context, asset *model.FixedAsset) error

+ GetByID func(ctx context.Context, id uuid.UUID) (*model.FixedAsset, error)

+ HasAssetsForCompany func(ctx context.Context, companyID uuid.UUID) (bool, error)

+ ListActiveByBranch func(ctx context.Context, companyID, branchID uuid.UUID) ([]model.FixedAsset, error)

+ ListByCompany func(ctx context.Context, companyID uuid.UUID) ([]model.FixedAsset, error)

+ Update func(ctx context.Context, asset *model.FixedAsset) error

type InventoryQuerier

+ LPPTrend func(ctx context.Context, productID uuid.UUID) (current int64, previous *int64, err error)

type InventoryRepoer

+ CreateInvoice func(ctx context.Context, entity *model.ProcurementInvoice) error

+ GetInvoiceByID func(ctx context.Context, id uuid.UUID) (*model.ProcurementInvoice, error)

+ LPPTrend func(ctx context.Context, productID uuid.UUID) (current int64, previous *int64, err error)

+ UpdateInvoiceTotalAmount func(ctx context.Context, id uuid.UUID, totalAmount int64) error

+ type InvoiceRepoer interface

+ GetByID func(ctx context.Context, id uuid.UUID) (*model.ProcurementInvoice, error)

+ ListByCompany func(ctx context.Context, companyID uuid.UUID, q SupportsPagination) (*dto.PaginationResults[model.ProcurementInvoice], error)

+ ListBySupplier func(ctx context.Context, supplierID uuid.UUID, q SupportsPagination) (*dto.PaginationResults[model.ProcurementInvoice], error)

+ ListOpenBySupplier func(ctx context.Context, supplierID uuid.UUID) ([]model.ProcurementInvoice, error)

+ type JournalEntryFilter struct

+ BranchID *uuid.UUID

+ DateFrom string

+ DateTo string

+ EventName string

type OrderRepoer

+ GetOpenOrderBySession func(ctx context.Context, sessionID uuid.UUID) (*model.Order, error)

type ProductRepoer

+ GetBySKUForBranch func(ctx context.Context, companyID, branchID uuid.UUID, sku string) (*model.Product, error)

+ GetProductBranches func(ctx context.Context, productID uuid.UUID) ([]model.Branch, error)

+ HasRecipeOrIngredientProducts func(ctx context.Context, companyID uuid.UUID) (bool, error)

+ ListByCompanyFiltered func(ctx context.Context, companyID uuid.UUID, productType *model.ProductType, ...) (*dto.PaginationResults[model.Product], error)

+ ListSellableByCompanyForBranch func(ctx context.Context, companyID, branchID uuid.UUID, search string, ...) (*dto.PaginationResults[model.Product], error)

+ SetProductBranches func(ctx context.Context, productID uuid.UUID, branchIDs []uuid.UUID) error

type ReportsQuerier

+ ExpiringSoon func(ctx context.Context, companyID uuid.UUID) ([]model.ExpiringBatch, error)

+ TrialBalanceAsOf func(ctx context.Context, companyID uuid.UUID, asOf string, branchID *uuid.UUID) ([]model.AccountBalance, error)

type SupplierPaymentRepoer

+ GetInvoiceByID func(ctx context.Context, id uuid.UUID) (*model.ProcurementInvoice, error)

+ UpdateInvoicePaid func(ctx context.Context, id uuid.UUID, paidAmount int64, status string) error

+ WithTx func(ctx context.Context, fn func(SupplierPaymentRepoer) error) error

v0.2.0

Aug 13, 2026

Changes in this version

+ type BackgroundJob interface

+ Kind func() string

type Enqueuer

+ Enqueue func(ctx context.Context, job BackgroundJob) error

v0.1.7

Aug 7, 2026

Changes in this version

type ProductRepoer

+ GetOrCreateCategories func(ctx context.Context, companyID uuid.UUID, names []string) ([]model.Category, error)

+ GetProductCategories func(ctx context.Context, productID uuid.UUID) ([]model.Category, error)

+ ListByCompanyAndCategory func(ctx context.Context, companyID, categoryID uuid.UUID, search string, ...) (*dto.PaginationResults[model.Product], error)

+ ListByCompanyTypeAndCategory func(ctx context.Context, companyID uuid.UUID, t model.ProductType, ...) (*dto.PaginationResults[model.Product], error)

+ ListCategoriesByCompany func(ctx context.Context, companyID uuid.UUID) ([]model.Category, error)

+ SetProductCategories func(ctx context.Context, productID uuid.UUID, categoryIDs []uuid.UUID) error

type UserRepoer

+ CountByRole func(ctx context.Context, role auth.UserRole) (int64, error)

v0.1.6

Aug 4, 2026

v0.1.5

Aug 3, 2026

v0.1.4

Aug 2, 2026

Changes in this version

+ var ErrDiscountCodeNotFound = errors.New("discount code not found")

+ var ErrDiscountExhausted = errors.New("discount has reached its redemption limit")

+ var ErrDiscountExpired = errors.New("discount has expired")

+ var ErrDiscountInactive = errors.New("discount is not active")

+ var ErrDiscountNotYetValid = errors.New("discount is not valid yet")

type DiscountRepoer

+ CountRedemptions func(ctx context.Context, discountID uuid.UUID) (int, error)

+ CreateRedemption func(ctx context.Context, r *model.DiscountRedemption) error

+ DeleteRedemptionByOrder func(ctx context.Context, orderID uuid.UUID) error

+ GetByCode func(ctx context.Context, companyID uuid.UUID, code string) (*model.Discount, error)

+ ListSelectable func(ctx context.Context, companyID uuid.UUID, at time.Time) ([]model.Discount, error)

v0.1.2

Aug 2, 2026

Changes in this version

+ var ErrAlreadyCorrected = errors.New("this stock movement has already been corrected")

+ var ErrCustomerContactRequired = errors.New("email or phone is required to create a customer")

+ var ErrCustomerNameRequired = errors.New("name is required to create a customer")

+ var ErrInvalidPayment = errors.New("tendered amount cannot be less than payment amount")

+ var ErrNotCorrectable = errors.New("this stock movement cannot be corrected")

type CustomerRepoer

+ GetByCompanyAndEmail func(ctx context.Context, companyID uuid.UUID, email string) (*model.Customer, error)

+ GetByCompanyAndPhone func(ctx context.Context, companyID uuid.UUID, phone string) (*model.Customer, error)

type InventoryRepoer

+ IsReversed func(ctx context.Context, movementID uuid.UUID) (bool, error)

v0.1.1

Aug 1, 2026

v0.1.0

Aug 1, 2026

Changes in this version

+ var ErrConflict = errors.New("resource conflict")

+ var ErrDiscountExceedsTotal = errors.New("discount amount exceeds order total")

+ var ErrFileTooLarge = errors.New("file exceeds the maximum size for this upload intent")

+ var ErrForbidden = errors.New("forbidden: insufficient permissions")

+ var ErrInitialStockIncomplete = errors.New("initial quantity and initial unit cost must both be set, or neither")

+ var ErrInsufficientStock = errors.New("insufficient stock")

+ var ErrInternal = errors.New("internal error")

+ var ErrInvalidIntent = errors.New("invalid upload intent")

+ var ErrInvalidPaymentMethod = errors.New("payment method is not accepted")

+ var ErrInvalidProductType = errors.New("invalid product type for operation")

+ var ErrNoProcurementPrice = errors.New("no procurement price on record")

+ var ErrNotFound = errors.New("resource not found")

+ var ErrOpenOrdersExist = errors.New("session has open orders and cannot be closed")

+ var ErrOrderAlreadyVoided = errors.New("order is already voided")

+ var ErrOrderNotOpen = errors.New("order is not in open status")

+ var ErrOrderNotPaid = errors.New("order is not in paid status")

+ var ErrPaymentMismatch = errors.New("payment total does not match order total")

+ var ErrSessionAlreadyClosed = errors.New("session is already closed")

+ var ErrStationBusy = errors.New("station already has an open session")

+ var ErrUnbalancedEntry = errors.New("journal entry is unbalanced: debit total must equal credit total")

+ var ErrUnitCostForbidden = errors.New("unit_cost must not be set for this movement reason")

+ var ErrUnitCostRequired = errors.New("unit_cost is required for this movement reason")

+ var ErrUnsupportedMimeType = errors.New("unsupported file type for this upload intent")

+ func IsValidUploadIntent(intent string) bool

+ type AccountingRepoer interface

+ BalanceByAccount func(ctx context.Context, companyID uuid.UUID) ([]model.AccountBalance, error)

+ CreateJournalEntry func(ctx context.Context, entry *model.JournalEntry) error

+ GetAccountByCode func(ctx context.Context, code string) (*model.Account, error)

+ ListAccounts func(ctx context.Context) ([]model.Account, error)

+ ListJournalEntriesByCompany func(ctx context.Context, companyID uuid.UUID, q SupportsPagination) (*dto.PaginationResults[model.JournalEntry], error)

+ type BranchRepoer interface

+ Create func(ctx context.Context, entity *model.Branch) error

+ Delete func(ctx context.Context, id uuid.UUID) error

+ GetByID func(ctx context.Context, id uuid.UUID) (*model.Branch, error)

+ ListByCompany func(ctx context.Context, companyID uuid.UUID, q SupportsPagination) (*dto.PaginationResults[model.Branch], error)

+ Update func(ctx context.Context, entity *model.Branch) error

+ WithTx func(ctx context.Context, fn func(BranchRepoer) error) error

+ type CompanyRepoer interface

+ Create func(ctx context.Context, entity *model.Company) error

+ Delete func(ctx context.Context, id uuid.UUID) error

+ GetByHandle func(ctx context.Context, handle string) (*model.Company, error)

+ GetByID func(ctx context.Context, id uuid.UUID) (*model.Company, error)

+ ListByOwner func(ctx context.Context, ownerID uuid.UUID, q SupportsPagination) (*dto.PaginationResults[model.Company], error)

+ Update func(ctx context.Context, entity *model.Company) error

+ WithTx func(ctx context.Context, fn func(CompanyRepoer) error) error

+ type Crudable interface

+ Create func(ctx context.Context, entity *T) error

+ Delete func(ctx context.Context, id uuid.UUID) error

+ GetByID func(ctx context.Context, id uuid.UUID) (*T, error)

+ Paginate func(ctx context.Context, q SupportsPagination) (*dto.PaginationResults[T], error)

+ Update func(ctx context.Context, entity *T) error

+ type CrudableWithTx interface

+ type CustomerRepoer interface

+ Create func(ctx context.Context, entity *model.Customer) error

+ Delete func(ctx context.Context, id uuid.UUID) error

+ GetByID func(ctx context.Context, id uuid.UUID) (*model.Customer, error)

+ ListByCompany func(ctx context.Context, companyID uuid.UUID, search string, q SupportsPagination) (*dto.PaginationResults[model.Customer], error)

+ Update func(ctx context.Context, entity *model.Customer) error

+ WithTx func(ctx context.Context, fn func(CustomerRepoer) error) error

+ type DiscountRepoer interface

+ Create func(ctx context.Context, entity *model.Discount) error

+ Delete func(ctx context.Context, id uuid.UUID) error

+ GetByID func(ctx context.Context, id uuid.UUID) (*model.Discount, error)

+ ListByCompany func(ctx context.Context, companyID uuid.UUID, search string, q SupportsPagination) (*dto.PaginationResults[model.Discount], error)

+ Update func(ctx context.Context, entity *model.Discount) error

+ type Enqueuer interface

+ Send func(ctx context.Context, name string, payload []byte) error

+ SendTx func(ctx context.Context, tx *sql.Tx, name string, payload []byte) error

+ type Event struct

+ Name string

+ Payload map[string]any

+ type EventEmitter interface

+ Emit func(ctx context.Context, event Event) error

+ type ExpenseRepoer interface

+ Create func(ctx context.Context, entity *model.Expense) error

+ GetByID func(ctx context.Context, id uuid.UUID) (*model.Expense, error)

+ ListByCompany func(ctx context.Context, companyID uuid.UUID, search string, q SupportsPagination) (*dto.PaginationResults[model.Expense], error)

+ type FileRepoer interface

+ Create func(ctx context.Context, entity *model.File) error

+ Delete func(ctx context.Context, id, companyID uuid.UUID) error

+ GetByID func(ctx context.Context, id, companyID uuid.UUID) (*model.File, error)

+ type FileStorage interface

+ Delete func(ctx context.Context, key string) error

+ Get func(ctx context.Context, key string) (io.ReadCloser, error)

+ Put func(ctx context.Context, key string, r io.Reader, size int64) error

+ type IntentConfig struct

+ AllowedMIMETypes []string

+ MaxSizeBytes int64

+ Prefix string

+ URLExpiry time.Duration

+ func LookupIntent(intent UploadIntent) (IntentConfig, bool)

+ type InventoryQuerier interface

+ CurrentStock func(ctx context.Context, productID uuid.UUID) (float64, error)

+ LPP func(ctx context.Context, productID uuid.UUID) (int64, error)

+ StockAt func(ctx context.Context, productID uuid.UUID, at time.Time) (float64, error)

+ type InventoryRepoer interface

+ CurrentStock func(ctx context.Context, productID uuid.UUID) (float64, error)

+ GetByID func(ctx context.Context, id uuid.UUID) (*model.StockMovement, error)

+ HasMovements func(ctx context.Context, productID uuid.UUID) (bool, error)

+ LPP func(ctx context.Context, productID uuid.UUID) (int64, error)

+ ListByCompany func(ctx context.Context, companyID uuid.UUID, q SupportsPagination) (*dto.PaginationResults[model.StockMovement], error)

+ ListByProduct func(ctx context.Context, productID, companyID uuid.UUID, q SupportsPagination) (*dto.PaginationResults[model.StockMovement], error)

+ Record func(ctx context.Context, entity *model.StockMovement) error

+ StockAt func(ctx context.Context, productID uuid.UUID, at time.Time) (float64, error)

+ WithTx func(ctx context.Context, fn func(InventoryRepoer) error) error

+ type OrderFilter struct

+ BranchID uuid.UUID

+ DateFrom string

+ DateTo string

+ StationID uuid.UUID

+ Status string

+ type OrderRepoer interface

+ CountOrdersByCompanyAndDate func(ctx context.Context, companyID uuid.UUID, date string) (int64, error)

+ CreateOrder func(ctx context.Context, entity *model.Order) error

+ CreateOrderItem func(ctx context.Context, entity *model.OrderItem) error

+ CreateOrderReturn func(ctx context.Context, entity *model.OrderReturn) error

+ CreateOrderReturnItem func(ctx context.Context, entity *model.OrderReturnItem) error

+ CreatePayment func(ctx context.Context, entity *model.Payment) error

+ DeleteOrder func(ctx context.Context, id uuid.UUID) error

+ DeleteOrderItem func(ctx context.Context, id uuid.UUID) error

+ GetOrderByID func(ctx context.Context, id uuid.UUID) (*model.Order, error)

+ GetOrderItemByID func(ctx context.Context, id uuid.UUID) (*model.OrderItem, error)

+ GetOrderReturnByID func(ctx context.Context, id uuid.UUID) (*model.OrderReturn, error)

+ ListOrderItemsByOrder func(ctx context.Context, orderID uuid.UUID) ([]model.OrderItem, error)

+ ListOrderReturnItemsByReturn func(ctx context.Context, returnID uuid.UUID) ([]model.OrderReturnItem, error)

+ ListOrderReturnsByOrder func(ctx context.Context, orderID uuid.UUID) ([]model.OrderReturn, error)

+ ListOrdersByCompany func(ctx context.Context, companyID uuid.UUID, q SupportsPagination) (*dto.PaginationResults[model.Order], error)

+ ListOrdersByCompanyFiltered func(ctx context.Context, companyID uuid.UUID, filter *OrderFilter, ...) (*dto.PaginationResults[model.Order], error)

+ ListOrdersBySession func(ctx context.Context, sessionID uuid.UUID, q SupportsPagination) (*dto.PaginationResults[model.Order], error)

+ ListPaymentsByOrder func(ctx context.Context, orderID uuid.UUID) ([]model.Payment, error)

+ SumPaymentsByOrder func(ctx context.Context, orderID uuid.UUID) (int64, error)

+ UpdateOrder func(ctx context.Context, entity *model.Order) error

+ UpdateOrderItem func(ctx context.Context, entity *model.OrderItem) error

+ WithTx func(ctx context.Context, fn func(orders OrderRepoer, inv InventoryRepoer) error) error

+ type POSStationRepoer interface

+ Create func(ctx context.Context, entity *model.POSStation) error

+ Delete func(ctx context.Context, id uuid.UUID) error

+ GetByID func(ctx context.Context, id uuid.UUID) (*model.POSStation, error)

+ ListByCompany func(ctx context.Context, companyID uuid.UUID, q SupportsPagination) (*dto.PaginationResults[model.POSStation], error)

+ Update func(ctx context.Context, entity *model.POSStation) error

+ WithTx func(ctx context.Context, fn func(POSStationRepoer) error) error

+ type ProductRepoer interface

+ Create func(ctx context.Context, entity *model.Product) error

+ Delete func(ctx context.Context, id uuid.UUID) error

+ GetByID func(ctx context.Context, id uuid.UUID) (*model.Product, error)

+ GetBySKU func(ctx context.Context, companyID uuid.UUID, sku string) (*model.Product, error)

+ GetRecipeComponents func(ctx context.Context, recipeID uuid.UUID) ([]model.RecipeComponent, error)

+ GetRecipeOverheads func(ctx context.Context, recipeID uuid.UUID) ([]model.RecipeOverhead, error)

+ ListByCompany func(ctx context.Context, companyID uuid.UUID, search string, q SupportsPagination) (*dto.PaginationResults[model.Product], error)

+ ListByCompanyAndType func(ctx context.Context, companyID uuid.UUID, t model.ProductType, search string, ...) (*dto.PaginationResults[model.Product], error)

+ ListSellableByCompany func(ctx context.Context, companyID uuid.UUID, search string, q SupportsPagination) (*dto.PaginationResults[model.Product], error)

+ SetRecipeComponents func(ctx context.Context, recipeID uuid.UUID, components []model.RecipeComponent) error

+ SetRecipeOverheads func(ctx context.Context, recipeID uuid.UUID, overheads []model.RecipeOverhead) error

+ Update func(ctx context.Context, entity *model.Product) error

+ WithTx func(ctx context.Context, ...) error

+ type ReportsQuerier interface

+ InventorySnapshot func(ctx context.Context, companyID uuid.UUID) ([]model.InventoryLine, error)

+ InventorySnapshotPaged func(ctx context.Context, companyID uuid.UUID, search string, q SupportsPagination) (*dto.PaginationResults[model.InventoryLine], error)

+ PLByPeriod func(ctx context.Context, companyID uuid.UUID, from, to string) (model.PLSummary, error)

+ RevenueByPaymentMethod func(ctx context.Context, companyID uuid.UUID, from, to string) ([]model.PaymentMethodRevenue, error)

+ SalesByPeriod func(ctx context.Context, companyID uuid.UUID, from, to, groupBy string) ([]model.SalesPeriod, error)

+ SalesTotals func(ctx context.Context, companyID uuid.UUID, from, to string) (model.SalesSummary, error)

+ TopProductsByRevenue func(ctx context.Context, companyID uuid.UUID, from, to string, topN int) ([]model.TopProduct, error)

+ type SessionFilter struct

+ BranchID uuid.UUID

+ type SessionRepoer interface

+ Close func(ctx context.Context, sessionID uuid.UUID, closedAt time.Time) error

+ Create func(ctx context.Context, entity *model.POSSession) error

+ CreateReconciliation func(ctx context.Context, entity *model.SessionReconciliation) error

+ DeleteOpenOrders func(ctx context.Context, sessionID uuid.UUID) (int64, error)

+ GetByID func(ctx context.Context, id uuid.UUID) (*model.POSSession, error)

+ GetOpenByStation func(ctx context.Context, stationID uuid.UUID) (*model.POSSession, error)

+ GetOpenByUser func(ctx context.Context, companyID, userID uuid.UUID) (*model.POSSession, error)

+ GetReconciliationBySession func(ctx context.Context, sessionID uuid.UUID) (*model.SessionReconciliation, error)

+ HasOpenOrders func(ctx context.Context, sessionID uuid.UUID) (bool, error)

+ ListByCompany func(ctx context.Context, companyID uuid.UUID, q SupportsPagination) (*dto.PaginationResults[model.POSSession], error)

+ ListOpenByCompanyFiltered func(ctx context.Context, companyID uuid.UUID, filter *SessionFilter, ...) (*dto.PaginationResults[model.POSSession], error)

+ SumCashPayments func(ctx context.Context, sessionID uuid.UUID) (int64, error)

+ type SupplierPaymentRepoer interface

+ Create func(ctx context.Context, entity *model.SupplierPayment) error

+ GetByID func(ctx context.Context, id uuid.UUID) (*model.SupplierPayment, error)

+ ListByCompany func(ctx context.Context, companyID uuid.UUID, q SupportsPagination) (*dto.PaginationResults[model.SupplierPayment], error)

+ ListBySupplier func(ctx context.Context, supplierID uuid.UUID, q SupportsPagination) (*dto.PaginationResults[model.SupplierPayment], error)

+ type SupplierRepoer interface

+ Create func(ctx context.Context, entity *model.Supplier) error

+ Delete func(ctx context.Context, id uuid.UUID) error

+ GetByID func(ctx context.Context, id uuid.UUID) (*model.Supplier, error)

+ ListByCompany func(ctx context.Context, companyID uuid.UUID, search string, q SupportsPagination) (*dto.PaginationResults[model.Supplier], error)

+ Update func(ctx context.Context, entity *model.Supplier) error

+ WithTx func(ctx context.Context, fn func(SupplierRepoer) error) error

+ type SupportsPagination interface

+ Limit func() int32

+ Offset func() int32

+ type TxAware interface

+ WithTx func(ctx context.Context, fn func(T) error) error

+ type URLPresigner interface

+ PresignGET func(ctx context.Context, key string, ttl time.Duration) (string, error)

+ type UploadIntent string

+ const IntentAvatar

+ const IntentCompanyLogo

+ const IntentProductImage

+ type UserRepoer interface

+ CountByCompany func(ctx context.Context, companyID uuid.UUID) (int64, error)

+ GetByEmail func(ctx context.Context, email string) (*model.User, error)

+ InvalidateTokens func(ctx context.Context, userID uuid.UUID) error

+ ListByCompany func(ctx context.Context, companyID uuid.UUID, q SupportsPagination) (*dto.PaginationResults[model.User], error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL