mms-client 1.10.0__py3-none-any.whl → 1.11.0__py3-none-any.whl

mms_client/services/base.py

@@ -420,7 +420,7 @@ class BaseClient:  # pylint: disable=too-many-instance-attributes
 
         # First, create the MMS request from the payload and data.
         is_list = isinstance(payload, list)
-        data_type = type(payload[0]) if is_list else type(payload)  # type: ignore[index]
+        data_type: type = type(payload[0]) if is_list else type(payload)  # type: ignore[index]
         logger.debug(
             (
                 f"{config.name}: Starting multi-request. Envelope: {type(envelope).__name__}, "

mms_client/services/market.py

@@ -12,6 +12,9 @@ from mms_client.services.base import mms_endpoint
 from mms_client.services.base import mms_multi_endpoint
 from mms_client.types.award import AwardQuery
 from mms_client.types.award import AwardResponse
+from mms_client.types.bup import BalancingUnitPriceQuery
+from mms_client.types.bup import BalancingUnitPriceSubmit
+from mms_client.types.market import Defaults
 from mms_client.types.market import MarketCancel
 from mms_client.types.market import MarketQuery
 from mms_client.types.market import MarketSubmit
@@ -21,6 +24,8 @@ from mms_client.types.offer import OfferData
 from mms_client.types.offer import OfferQuery
 from mms_client.types.reserve import ReserveRequirement
 from mms_client.types.reserve import ReserveRequirementQuery
+from mms_client.types.settlement import SettlementQuery
+from mms_client.types.settlement import SettlementResults
 from mms_client.types.transport import RequestType
 from mms_client.utils.serialization import SchemaType
 from mms_client.utils.serialization import Serializer
@@ -213,3 +218,120 @@ class MarketClientMixin:  # pylint: disable=unused-argument
             user=self.user,
             days=days,
         )
+
+    @mms_endpoint(
+        name="MarketQuery_SettlementResultsFileListQuery",
+        service=config,
+        request_type=RequestType.MARKET,
+        response_envelope_type=MarketSubmit,
+        response_data_type=SettlementResults,
+        allowed_clients=[ClientType.BSP, ClientType.TSO],
+    )
+    def get_settlement_results(
+        self: ClientProto, request: SettlementQuery, days: int, date: Optional[Date] = None
+    ) -> SettlementResults:
+        """Query the MMS server for settlement results.
+
+        This endpoint is only accessible to BSPs and TSOs.
+
+        Arguments:
+        request (SettlementQuery):  The query to submit to the MMS server.
+        days (int):                 The number of days ahead for which the data is being queried.
+        date (Date):                The date of the transaction in the format "YYYY-MM-DD". This value defaults to the
+                                    current date.
+
+        Returns:    The settlement results that match the query.
+        """
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
+        return MarketQuery(  # type: ignore[return-value]
+            date=date or Date.today(),
+            participant=self.participant,
+            user=self.user,
+            days=days,
+        )
+
+    @mms_multi_endpoint(
+        name="MarketSubmit_BupSubmit", service=config, request_type=RequestType.MARKET, allowed_clients=[ClientType.BSP]
+    )
+    def put_bups(
+        self: ClientProto,
+        requests: List[BalancingUnitPriceSubmit],
+        date: Optional[Date] = None,
+        default: bool = False,
+    ) -> List[BalancingUnitPriceSubmit]:
+        """Submit multiple balancing unit prices to the MMS server.
+
+        This endpoint is only accessible to BSPs.
+
+        Arguments:
+        requests (List[BalancingUnitPriceSubmit]):  The balancing unit prices to submit to the MMS server.
+        date (Date):                                The date of the transaction in the format "YYYY-MM-DD". This value
+                                                    defaults to the current date.
+        default (bool):                             Whether or not the balancing unit prices are the default.
+
+        Returns:    A list of balancing unit prices that have been registered with the MMS server.
+        """
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
+        return MarketSubmit(  # type: ignore[return-value]
+            date=date or Date.today(),
+            participant=self.participant,
+            user=self.user,
+            defaults=Defaults(is_default=default),
+        )
+
+    @mms_endpoint(
+        name="MarketSubmit_BupSubmit", service=config, request_type=RequestType.MARKET, allowed_clients=[ClientType.BSP]
+    )
+    def put_bup(
+        self: ClientProto,
+        request: BalancingUnitPriceSubmit,
+        date: Optional[Date] = None,
+        default: bool = False,
+    ) -> BalancingUnitPriceSubmit:
+        """Submit a balancing unit price to the MMS server.
+
+        This endpoint is only accessible to BSPs.
+
+        Arguments:
+        request (BalancingUnitPriceSubmit): The balancing unit price to submit to the MMS server.
+        date (Date):                        The date of the transaction in the format "YYYY-MM-DD". This value defaults
+                                            to the current date.
+        default (bool):                     Whether or not the balancing unit price is the default.
+
+        Returns:    The balancing unit price that has been registered with the MMS server.
+        """
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
+        return MarketSubmit(  # type: ignore[return-value]
+            date=date or Date.today(),
+            participant=self.participant,
+            user=self.user,
+            defaults=Defaults(is_default=default),
+        )
+
+    @mms_multi_endpoint(
+        name="MarketQuery_BupQuery",
+        service=config,
+        request_type=RequestType.MARKET,
+        response_envelope_type=MarketSubmit,
+        response_data_type=BalancingUnitPriceSubmit,
+    )
+    def query_bups(
+        self: ClientProto, request: BalancingUnitPriceQuery, date: Optional[Date] = None
+    ) -> List[BalancingUnitPriceSubmit]:
+        """Query the MMS server for balancing unit prices.
+
+        This endpoint is accessible to all client types.
+
+        Arguments:
+        request (BalancingUnitPriceSubmit): The query to submit to the MMS server.
+        date (Date):                        The date of the transaction in the format "YYYY-MM-DD". This value defaults
+                                            to the current date.
+
+        Returns:    A list of balancing unit prices that match the query.
+        """
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
+        return MarketQuery(  # type: ignore[return-value]
+            date=date or Date.today(),
+            participant=self.participant,
+            user=self.user,
+        )

mms_client/services/omi.py

@@ -1,10 +1,24 @@
 """Contains the client layer for making OMI requests to the MMS server."""
 
 from logging import getLogger
+from typing import List
+from typing import Optional
 
+from pydantic_extra_types.pendulum_dt import Date
+
+from mms_client.services.base import ClientProto
 from mms_client.services.base import ServiceConfiguration
+from mms_client.services.base import mms_endpoint
+from mms_client.services.base import mms_multi_endpoint
+from mms_client.types.omi import MarketQuery
+from mms_client.types.omi import MarketSubmit
+from mms_client.types.surplus_capcity import SurplusCapacityData
+from mms_client.types.surplus_capcity import SurplusCapacityQuery
+from mms_client.types.surplus_capcity import SurplusCapacitySubmit
+from mms_client.types.transport import RequestType
 from mms_client.utils.serialization import SchemaType
 from mms_client.utils.serialization import Serializer
+from mms_client.utils.web import ClientType
 from mms_client.utils.web import Interface
 
 # Set the default logger for the MMS client
@@ -16,3 +30,88 @@ class OMIClientMixin:  # pylint: disable=unused-argument
 
     # The configuration for the OMI service
     config = ServiceConfiguration(Interface.OMI, Serializer(SchemaType.OMI, "MarketData"))
+
+    @mms_endpoint(
+        name="MarketSubmit_RemainingReserveData",
+        service=config,
+        request_type=RequestType.OMI,
+        response_data_type=SurplusCapacityData,
+        allowed_clients=[ClientType.BSP],
+    )
+    def put_surplus_capacity(
+        self: ClientProto, request: SurplusCapacitySubmit, date: Optional[Date] = None
+    ) -> SurplusCapacityData:
+        """Submit an offer to the MMS server.
+
+        This endpoint is only accessible to BSPs.
+
+        Arguments:
+        request (SurplusCapacitySubmit):    The surplus capacity data to submit to the MMS server.
+        date (Date):                        The date of the transaction in the format "YYYY-MM-DD". This value defaults
+                                            to the current date.
+
+        Returns:    The surplus capacity data that has been registered with the MMS server.
+        """
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
+        return MarketSubmit(  # type: ignore[return-value]
+            date=date or Date.today(),
+            participant=self.participant,
+            user=self.user,
+        )
+
+    @mms_multi_endpoint(
+        name="MarketSubmit_RemainingReserveData",
+        service=config,
+        request_type=RequestType.OMI,
+        response_data_type=SurplusCapacityData,
+        allowed_clients=[ClientType.BSP],
+    )
+    def put_surplus_capacities(
+        self: ClientProto, requests: List[SurplusCapacitySubmit], date: Optional[Date] = None
+    ) -> List[SurplusCapacityData]:
+        """Submit multiple surplus capacity data to the MMS server.
+
+        This endpoint is only accessible to BSPs.
+
+        Arguments:
+        requests (list[SurplusCapacitySubmit]): The surplus capacity data to submit to the MMS server.
+        date (Date):                            The date of the transaction in the format "YYYY-MM-DD". This value
+                                                defaults to the current date.
+
+        Returns:    A list of surplus capacity data that have been registered with the MMS server.
+        """
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
+        return MarketSubmit(  # type: ignore[return-value]
+            date=date or Date.today(),
+            participant=self.participant,
+            user=self.user,
+        )
+
+    @mms_multi_endpoint(
+        name="MarketQuery_RemainingReserveDataQuery",
+        service=config,
+        request_type=RequestType.OMI,
+        response_envelope_type=MarketSubmit,
+        response_data_type=SurplusCapacityData,
+        allowed_clients=[ClientType.BSP, ClientType.TSO],
+    )
+    def query_surplus_capacity(
+        self: ClientProto, request: SurplusCapacityQuery, date: Optional[Date] = None
+    ) -> List[SurplusCapacityData]:
+        """Query the MMS server for surplus capacity data.
+
+        This endpoint is only accessible to BSPs and TSOs.
+
+        Arguments:
+        request (SurplusCapacityQuery): The query to submit to the MMS server.
+        date (Date):                    The date of the transaction in the format "YYYY-MM-DD". This value defaults to
+                                        the current date.
+
+        Returns:    A list of surplus capacity data that match the query.
+        """
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
+        return MarketQuery(  # type: ignore[return-value]
+            date=date or Date.today(),
+            participant=self.participant,
+            user=self.user,
+        )

mms_client/types/award.py

@@ -192,6 +192,12 @@ class Award(Payload):
     # The contract price, in JPY/kW/segment
     contract_price: Decimal = price("ContractPrice", 10000.00)
 
+    # The unit price charged for the start up cost of the power, in JPY/kW/segment
+    start_up_unit_price: Decimal = price("StartUpUnitPrice", 10000.00, True)
+
+    # The unit price charged for the ramp down cost of the power, in JPY/kW/segment
+    ramp_down_unit_price: Decimal = price("RampDownUnitPrice", 10000.00, True)
+
     # The performance evaluation coefficient, alpha
     performance_evaluation_coefficient: Decimal = attr(name="PerfEvalCoeff", ge=0.00, le=100.0, decimal_places=2)
 

mms_client/types/bup.py

@@ -0,0 +1,207 @@
+"""Contains objects for BUPs."""
+
+from decimal import Decimal
+from enum import Enum
+from typing import Annotated
+from typing import List
+from typing import Optional
+
+from pendulum import Timezone
+from pydantic import field_serializer
+from pydantic import field_validator
+from pydantic_core import PydanticUndefined
+from pydantic_extra_types.pendulum_dt import DateTime
+from pydantic_xml import attr
+from pydantic_xml import element
+from pydantic_xml import wrapped
+
+from mms_client.types.base import Payload
+from mms_client.types.enums import AreaCode
+from mms_client.types.fields import capacity
+from mms_client.types.fields import company_short_name
+from mms_client.types.fields import participant
+from mms_client.types.fields import power_positive
+from mms_client.types.fields import price
+from mms_client.types.fields import resource_name
+from mms_client.types.fields import resource_short_name
+from mms_client.types.fields import system_code
+
+
+def abc_price(alias: str, optional: bool = False):
+    """Create a field for an abc price.
+
+    Arguments:
+    alias (str):        The name of the alias to assign to the Pydanitc field. This value will be used to map the field
+                        to the JSON/XML key.
+    optional (bool):    If True, the field will be optional with a default of None. If False, the field will be
+                        required, with no default.
+
+    Returns:    A Pydantic Field object for the abc price.
+    """
+    return attr(
+        default=None if optional else PydanticUndefined, name=alias, gt=-100000.0, lt=100000.0, decimal_places=1
+    )
+
+
+class Status(Enum):
+    """Enum representing the possible statuses of a pattern."""
+
+    INACTIVE = "0"
+    ACTIVE = "1"
+
+
+class StartupCostBand(Payload, tag="BandStartup"):
+    """Represents a band of a startup cost."""
+
+    # The band number which must be unique within the startup cost and will identify this band in sequence.
+    number: int = attr(name="CaseNo", ge=1, le=10)
+
+    # The time at which the startup cost is applied. This value must be greater than or equal to 0.
+    stop_time_hours: int = attr(name="StopTime", ge=0, lt=1000)
+
+    # The V3 unit price charged for this band.
+    v3_unit_price: int = attr(name="V3", ge=0, lt=100000000)
+
+    # The remarks associated with this band.
+    remarks: Optional[str] = attr(default=None, name="Remark", min_length=1, max_length=30)
+
+
+class AbcBand(Payload, tag="BandAbc"):
+    """Represents a band of an ABC, whatever that is."""
+
+    # The band number which must be unique within the ABC and will identify this band in sequence.
+    number: int = attr(name="Band", ge=1, le=5)
+
+    # The capacity from which the band is allowed to operate.
+    from_capacity: int = power_positive("FromCap")
+
+    # The a term of the band.
+    a: Decimal = abc_price("a")
+
+    # The b term of the band.
+    b: Decimal = abc_price("b")
+
+    # The c term of the band.
+    c: Decimal = abc_price("c")
+
+
+class BalancingUnitPriceBand(Payload):
+    """Represents a band of a balancing unit price."""
+
+    # The band number which must be unique within the balancing unit price and will identify this band in sequence.
+    number: int = attr(name="Band", ge=1, le=20)
+
+    # The capacity from which the band is allowed to operate. If the resource_type on the associated resource is set to
+    # THERMAL or HYDRO then the value of this field must be greater than or equal to 0. Otherwise, the value of this
+    # field is unrestricted.
+    from_capacity: int = capacity("FromCap", -10000000)
+
+    # The V1 unit price charged for this band.
+    v1_unit_price: Decimal = price("V1", 10000.00)
+
+    # The V2 unit price charged for this band. This value is only valid when the contract_type on the associated
+    # resource is set to anything other than ONLY_POWER_SUPPLY_1.
+    v2_unit_price: Annotated[Decimal, price("V2", 10000.00, True)]
+
+
+class BalancingUnitPrice(Payload):
+    """Represents a balancing unit profile."""
+
+    # The V4 unit price charged for this pattern. This value is only valid when the contract_type on the associated
+    # resource is set to anything other than ONLY_POWER_SUPPLY_1.
+    v4_unit_price: Annotated[Decimal, price("V4", 10000.00, True)]
+
+    # The bands associated with this BUP.
+    bands: Annotated[List[BalancingUnitPriceBand], element(tag="BandBup", min_length=1, max_length=20)]
+
+
+class Pattern(Payload):
+    """Represents a pattern associated with a BUP."""
+
+    # A number identifying this pattern in the overall sequence of patterns
+    number: int = attr(name="PatternNo", ge=1, le=10)
+
+    # The status of the pattern
+    status: Status = attr(name="PatternStatus")
+
+    # Any comments associated with the pattern
+    remarks: Optional[str] = attr(default=None, name="PatternRemark", min_length=1, max_length=50)
+
+    # The balancing unit profile associated with this pattern
+    balancing_unit_profile: Optional[BalancingUnitPrice] = element(default=None, tag="Bup")
+
+    # The quadratic pricing bands associated with this pattern
+    abc: Annotated[Optional[List[AbcBand]], wrapped(default=None, path="Abc", min_length=1, max_length=5)]
+
+    # The startup cost bands associated with this pattern
+    startup_costs: Annotated[
+        Optional[List[StartupCostBand]], wrapped(default=None, path="StartupCost", min_length=1, max_length=10)
+    ]
+
+
+class BalancingUnitPriceSubmit(Payload, tag="BupSubmit"):
+    """Represents the data included with a BUP."""
+
+    # The resource with which the BUP is associated
+    resource_code: str = resource_name("ResourceName")
+
+    # The start date and time for the validity period of the BUP
+    start: DateTime = attr(name="StartTime")
+
+    # The end date and time for the validity period of the BUP
+    end: DateTime = attr(name="EndTime")
+
+    # The patterns associated with this BUP
+    patterns: Annotated[List[Pattern], element(tag="PatternData", max_length=10)]
+
+    # The name of the BSP participant submitting the BUP. This will only be populated when the object is returned.
+    participant_name: Optional[str] = participant("BspParticipantName", True)
+
+    # The name of the company submitting the BUP. This will only be populated when the object is returned.
+    company: Optional[str] = company_short_name("CompanyShortName", True)
+
+    # The area associated with the BUP. This will only be populated when the object is returned.
+    area: Optional[AreaCode] = attr(default=None, name="Area")
+
+    # The name of the resource being traded. This will only be populated when the object is returned.
+    resource_name: Optional[str] = resource_short_name("ResourceShortName", True)
+
+    # The MMS code of the business entity to which the registration applies. This will only be populated when the
+    # object is returned.
+    system_code: Optional[str] = system_code("SystemCode", True)
+
+    @field_serializer("start", "end")
+    def encode_datetime(self, value: DateTime) -> str:
+        """Encode the datetime to an MMS-compliant ISO 8601 string."""
+        return value.replace(tzinfo=None).isoformat() if value else ""
+
+    @field_validator("start", "end")
+    def decode_datetime(cls, value: DateTime) -> DateTime:  # pylint: disable=no-self-argument
+        """Decode the datetime from an MMS-compliant ISO 8601 string."""
+        return value.replace(tzinfo=Timezone("Asia/Tokyo"))
+
+
+class BalancingUnitPriceQuery(Payload, tag="BupQuery"):
+    """Represents the data included with a BUP query."""
+
+    # Whether or not the BUP is the default
+    is_default: Optional[bool] = attr(default=None, name="StandingFlag")
+
+    # The resource with which the BUP is associated
+    resource_code: str = resource_name("ResourceName")
+
+    # The start date and time for the validity period of the BUP
+    start: Annotated[DateTime, attr(default=None, name="StartTime")]
+
+    # The end date and time for the validity period of the BUP
+    end: Annotated[DateTime, attr(default=None, name="EndTime")]
+
+    @field_serializer("start", "end")
+    def encode_datetime(self, value: DateTime) -> str:
+        """Encode the datetime to an MMS-compliant ISO 8601 string."""
+        return value.replace(tzinfo=None).isoformat() if value else ""
+
+    @field_validator("start", "end")
+    def decode_datetime(cls, value: DateTime) -> DateTime:  # pylint: disable=no-self-argument
+        """Decode the datetime from an MMS-compliant ISO 8601 string."""
+        return value.replace(tzinfo=Timezone("Asia/Tokyo"))

mms_client/types/market.py

@@ -4,7 +4,9 @@ from enum import Enum
 from typing import Optional
 
 from pydantic_extra_types.pendulum_dt import Date
+from pydantic_xml import BaseXmlModel
 from pydantic_xml import attr
+from pydantic_xml import element
 
 from mms_client.types.base import Envelope
 from mms_client.types.fields import participant
@@ -32,12 +34,19 @@ class BaseMarketRequest(Envelope):
     user: str = attr(name="UserName", min_length=1, max_length=12, pattern=r"^[A-Z0-9]*$")
 
 
+class Defaults(BaseXmlModel):
+    """Represents the default settings to apply when submitting a market request."""
+
+    # Whether or not the submission represents the default
+    is_default: bool = attr(name="StandingFlag")
+
+
 class MarketQuery(BaseMarketRequest):
     """Represents the base fields for a market query."""
 
     # If the market type is specified as "DAM" (day-ahead market), the number of days should be specified as "1".
     # Otherwise, this field indicates the number of days ahead for which the data is being queried.
-    days: int = attr(default=1, name="NumOfDays", ge=1, le=7)
+    days: Optional[int] = attr(default=None, name="NumOfDays", ge=1, le=7)
 
 
 class MarketSubmit(BaseMarketRequest):
@@ -48,7 +57,11 @@ class MarketSubmit(BaseMarketRequest):
 
     # If the market type is specified as "DAM" (day-ahead market), the number of days should be specified as "1".
     # Otherwise, this field indicates the number of days ahead for which the data is being submitted.
-    days: int = attr(default=1, name="NumOfDays", ge=1, le=31)
+    days: Optional[int] = attr(default=None, name="NumOfDays", ge=1, le=31)
+
+    # Default values to include with the submission. The request will be rejected if this is included in a request
+    # where it is not allowed.
+    defaults: Optional[Defaults] = element(default=None, tag="StandingData")
 
 
 class MarketCancel(BaseMarketRequest):

mms_client/types/offer.py

@@ -72,6 +72,12 @@ class OfferStack(Payload):
     # The unit price of the power, in JPY/kW/segment
     unit_price: Decimal = price("OfferUnitPrice", 10000.00)
 
+    # The unit price charged for the start up cost of the power, in JPY/kW/segment
+    start_up_unit_price: Annotated[Decimal, price("StartUpUnitPrice", 10000.00, True)]
+
+    # The unit price charged for the ramp down cost of the power, in JPY/kW/segment
+    ramp_down_unit_price: Annotated[Decimal, price("RampDownUnitPrice", 10000.00, True)]
+
     # The ID of the offer to which this stack belongs
     id: Optional[str] = offer_id("OfferId", True)
 

mms_client/types/omi.py

@@ -0,0 +1,26 @@
+"""Contains objects for OMI information."""
+
+from pydantic_extra_types.pendulum_dt import Date
+from pydantic_xml import attr
+
+from mms_client.types.base import Envelope
+from mms_client.types.fields import participant
+
+
+class MarketSubmit(Envelope):
+    """Represents the base fields for a market registration request."""
+
+    # Date of the transaction in the format "YYYY-MM-DD"
+    date: Date = attr(name="Date")
+
+    # MMS code of the business entity to which the requesting user belongs, and will be used to track the user who made
+    # the request. This value will be checked against the certificate used to make the request.
+    participant: str = participant("ParticipantName")
+
+    # The user name of the person making the request. This value is used to track the user who made the request, and
+    # will be checked against the certificate used to make the request.
+    user: str = attr(name="UserName", min_length=1, max_length=12, pattern=r"^[A-Z0-9]*$")
+
+
+class MarketQuery(MarketSubmit):
+    """Represents the base fields for a market query."""

mms_client/types/settlement.py

@@ -0,0 +1,81 @@
+"""Contains objects for MMS settlement."""
+
+from typing import Annotated
+from typing import List
+from typing import Optional
+
+from pendulum import Timezone
+from pydantic import field_serializer
+from pydantic import field_validator
+from pydantic_core import PydanticUndefined
+from pydantic_extra_types.pendulum_dt import Date
+from pydantic_extra_types.pendulum_dt import DateTime
+from pydantic_xml import attr
+from pydantic_xml import element
+
+from mms_client.types.base import Payload
+from mms_client.types.fields import company_short_name
+from mms_client.types.fields import participant
+
+
+def file_name(alias: str, optional: bool = False):
+    """Create a field for a file name.
+
+    Arguments:
+    alias (str):        The name of the alias to assign to the Pydanitc field. This value will be used to map the field
+                        to the JSON/XML key.
+    optional (bool):    If True, the field will be optional with a default of None. If False, the field will be
+                        required, with no default.
+
+    Returns:    A Pydantic Field object for the file name.
+    """
+    return attr(
+        default=None if optional else PydanticUndefined,
+        name=alias,
+        min_length=18,
+        max_length=60,
+        pattern=r"^([A-Z0-9]{4}_){2}[A-Z0-9_-]{4,46}\.(pdf|zip|csv|xml)$",
+    )
+
+
+class SettlementFile(Payload):
+    """Represents a settlement file."""
+
+    # The name of the settlement file as it is recorded in the system
+    name: str = file_name("Name")
+
+    # The name of the participant (only valid if operating as a TSO)
+    participant: Optional[str] = participant("ParticipantName", True)
+
+    # The name of the company associated with the file (only valid if operating as a TSO)
+    company: Optional[str] = company_short_name("CompanyShortName", True)
+
+    # When the file was submitted (not sure why this can be None but it's in the spec)
+    submission_time: Optional[DateTime] = attr(name="SubmissionTime", default=None)
+
+    # The date when settlement occurred (not included if settlement is in the future)
+    settlement_date: Optional[Date] = attr(name="SttlDate", default=None)
+
+    # The size of the file in bytes, if it has been uploaded
+    size: Optional[int] = attr(name="FileSize", default=None, ge=0, lt=1000000000)
+
+    @field_serializer("submission_time")
+    def encode_datetime(self, value: DateTime) -> str:
+        """Encode the datetime to an MMS-compliant ISO 8601 string."""
+        return value.replace(tzinfo=None).isoformat() if value else ""
+
+    @field_validator("submission_time")
+    def decode_datetime(cls, value: DateTime) -> DateTime:  # pylint: disable=no-self-argument
+        """Decode the datetime from an MMS-compliant ISO 8601 string."""
+        return value.replace(tzinfo=Timezone("Asia/Tokyo"))
+
+
+class SettlementResults(Payload):
+    """Contains a list of settlement files that can be requested separately later."""
+
+    # The file results that were retrieved by the query
+    files: Annotated[List[SettlementFile], element(tag="File", min_length=1)]
+
+
+class SettlementQuery(Payload, tag="SettlementResultsFileListQuery"):
+    """Represents a request to query settlement results file list."""