Method GetBalanceAtTime

api/balance.go:394–440

GetBalanceAtTime retrieves a balance's state at a specific point in time. It extracts the balance ID from the route parameters and the timestamp from query parameters. The timestamp should be provided in ISO 8601 format (e.g., "2024-01-01T15:04:05Z"). Optionally accepts a "from_source" query paramet

(c *gin.Context)

// - 400 Bad Request: If the balance ID is missing, timestamp is invalid, or there's an error retrieving the balance.
// - 200 OK: If the historical balance state is successfully retrieved.
func (a Api) GetBalanceAtTime(c *gin.Context) {
	balanceID, exists := c.Params.Get("id")
	if !exists {
		c.JSON(http.StatusBadRequest, gin.H{"error": "balance ID is required"})
		return
	}

	var timestamp time.Time
	timestampStr := c.Query("timestamp")
	if timestampStr == "" {
		// Use current time if no timestamp is provided
		timestamp = time.Now().UTC()
	} else {
		var err error
		timestamp, err = time.Parse(time.RFC3339, timestampStr)
		if err != nil {
			c.JSON(http.StatusBadRequest, gin.H{
				"error": "invalid timestamp format. Please use ISO 8601 format (e.g., 2024-01-01T15:04:05Z)",
			})
			return
		}
	}

	// Check if the request specifies to calculate from source transactions
	fromSourceStr := c.Query("from_source")
	fromSource := fromSourceStr == "true" || fromSourceStr == "1"

	balance, err := a.ledgerforge.GetBalanceAtTime(c.Request.Context(), balanceID, timestamp, fromSource)
	if err != nil {
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

	balanceResult := map[string]interface{}{
		"balance":        balance.Balance,
		"debit_balance":  balance.DebitBalance,
		"credit_balance": balance.CreditBalance,
		"currency":       balance.Currency,
		"balance_id":     balance.BalanceID,
	}

	c.JSON(http.StatusOK, gin.H{
		"balance":     balanceResult,
		"timestamp":   timestamp.Format(time.RFC3339),
		"from_source": fromSource,
	})
}

// GetBalanceByIndicator retrieves a balance by its indicator and currency.
// It extracts the indicator and currency from the route parameters.