Skip to content
API Contracts

Money

Record Struct sealedpublic
Represents a monetary amount paired with an ISO 4217 currency code, ensuring that different currencies are never accidentally mixed in arithmetic.
Namespace SampleApi
Assembly SampleApi
Package v1.0.0.0

Definition

Section titled Definition 
public sealed record struct Money
    : System.IEquatable<SampleApi.Money>
IEquatable<Money>

Inheritance

Section titled Inheritance
Implements
IEquatable<Money> 
classDiagram
    direction TB
    class Money {
        <<record>>
    }
    class IEquatable~Money~ {
        <<interface>>
    }
    IEquatable~Money~ <|.. Money

Remarks

Section titled Remarks
Money is a value object implemented as a readonly record struct to guarantee immutability and value-based equality. Using Money instead of a bare Decimal prevents subtle bugs where values in different currencies are summed or compared. The Amount is stored as a Decimal to avoid the floating-point precision issues inherent to Double in financial calculations.

Constructors1

Section titled Constructors
Constructor Section titled Constructor 
Money.Money(
    decimal Amount,
    string Currency)

Represents a monetary amount paired with an ISO 4217 currency code, ensuring that different currencies are never accidentally mixed in arithmetic.

Parameters
Amount decimal
The numeric value of the monetary amount.
Currency string
The three-letter ISO 4217 currency code (e.g., "USD", "EUR", "GBP").
Remarks
Money is a value object implemented as a readonly record struct to guarantee immutability and value-based equality. Using Money instead of a bare Decimal prevents subtle bugs where values in different currencies are summed or compared. The Amount is stored as a Decimal to avoid the floating-point precision issues inherent to Double in financial calculations.
Examples

Creating and displaying monetary values:

var price = Money.Usd(29.99m);
var shipping = Money.Eur(5.50m);


Console.WriteLine(price);    // "29.99 USD"
Console.WriteLine(shipping); // "5.50 EUR"

Properties2

Section titled Properties
Amount Section titled Amount
decimal 
decimal Money.Amount

The numeric value of the monetary amount.

Currency Section titled Currency
string 
string Money.Currency

The three-letter ISO 4217 currency code (e.g., "USD", "EUR", "GBP").

Methods3

Section titled Methods
Eur Section titled Eur static
Money 
Money Money.Eur(
    decimal amount)

Creates a Money value denominated in euros.

Parameters
amount decimal
The euro amount.
Returns
Money A new Money instance with currency set to "EUR".
ToString Section titled ToString override
string 
string Money.ToString()

Returns a string representation in the format "100.00 USD".

Returns
string A formatted string of the monetary value.
Usd Section titled Usd static
Money 
Money Money.Usd(
    decimal amount)

Creates a Money value denominated in US dollars.

Parameters
amount decimal
The dollar amount.
Returns
Money A new Money instance with currency set to "USD".

Examples

Section titled Examples

Creating and displaying monetary values:

var price = Money.Usd(29.99m);
var shipping = Money.Eur(5.50m);


Console.WriteLine(price);    // "29.99 USD"
Console.WriteLine(shipping); // "5.50 EUR"

See Also

Section titled See Also
OrderItem