Documentation
¶
Overview ¶
Package vehiclelease holds a vehicle's lease terms and computes where the driver stands against the mileage allowance. Distances are miles; the client converts to the user's unit.
Index ¶
- type Reading
- type Status
- type Store
- func (s *Store) Delete(ctx context.Context, uid, vehicleID uuid.UUID) error
- func (s *Store) Get(ctx context.Context, uid, vehicleID uuid.UUID) (*Terms, error)
- func (s *Store) Odometer(ctx context.Context, uid, vehicleID uuid.UUID, now time.Time) (latest, past *Reading, err error)
- func (s *Store) Put(ctx context.Context, uid, vehicleID uuid.UUID, t Terms) error
- type Terms
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Status ¶
type Status struct {
OdometerMi *float64 `json:"odometer_mi"`
OdometerAt *string `json:"odometer_at"`
UsedMi *float64 `json:"used_mi"`
AllowedToDateMi float64 `json:"allowed_to_date_mi"`
AheadBehindMi *float64 `json:"ahead_behind_mi"` // allowed_to_date − used; negative = over the pro-rata allowance
DaysTotal int `json:"days_total"`
DaysElapsed int `json:"days_elapsed"`
DaysLeft int `json:"days_left"`
PaceMiPerDay *float64 `json:"pace_mi_per_day"`
PaceBasis string `json:"pace_basis,omitempty"` // last_90_days | lease_to_date
ProjectedTotalMi *float64 `json:"projected_total_mi"`
ProjectedReturnMi *float64 `json:"projected_return_odometer_mi"`
ProjectedOverMi *float64 `json:"projected_overage_mi"`
ProjectedOverCost *float64 `json:"projected_overage_cost"`
MilesPerDayBudget *float64 `json:"miles_per_day_budget"`
Currency string `json:"currency"`
}
Status is the computed standing. Pointer fields are null when they cannot be known (no recent odometer, not enough history for a pace).
type Store ¶
type Store struct {
// contains filtered or unexported fields
}
Store is the Postgres side.
type Terms ¶
type Terms struct {
StartDate string `json:"start_date"`
EndDate string `json:"end_date"`
StartOdometerMi float64 `json:"start_odometer_mi"`
AllowedMilesTotal float64 `json:"allowed_miles_total"`
OveragePerMile float64 `json:"overage_per_mile"`
Currency string `json:"currency"`
}
Terms are what the driver enters. Dates are calendar dates (YYYY-MM-DD).
Click to show internal directories.
Click to hide internal directories.