> ## Documentation Index
> Fetch the complete documentation index at: https://docs.engrate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List Messages

> List EDIFACT messages for a clearing period.

Filters: - message_type: IFTSTA, UTILMD, MSCONS, PARTIN - direction: inbound, outbound - status: pending, sent, delivered, acknowledged, etc.



## OpenAPI

````yaml /openapi.json get /schedule-management/v1/mabis/clearing-periods/{uid}/messages
openapi: 3.1.0
info:
  title: Engrate API
  version: 1.0.0
servers:
  - url: https://api.engrate.io
security:
  - apiKeyAuth: []
paths:
  /schedule-management/v1/mabis/clearing-periods/{uid}/messages:
    get:
      tags:
        - mabis
      summary: List Messages
      description: >-
        List EDIFACT messages for a clearing period.


        Filters: - message_type: IFTSTA, UTILMD, MSCONS, PARTIN - direction:
        inbound, outbound - status: pending, sent, delivered, acknowledged, etc.
      operationId: >-
        list_messages_schedule_management_v1_mabis_clearing_periods__uid__messages_get
      parameters:
        - description: Clearing period unique identifier.
          in: path
          name: uid
          required: true
          schema:
            description: Clearing period unique identifier.
            format: uuid
            title: Uid
            type: string
        - description: >-
            Filter by EDIFACT message type: `MSCONS`, `PRICAT`, `UTILMD`,
            `IFTSTA`, `PARTIN`.
          in: query
          name: message_type
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Filter by EDIFACT message type: `MSCONS`, `PRICAT`, `UTILMD`,
              `IFTSTA`, `PARTIN`.
            title: Message Type
        - description: 'Filter by direction: `inbound` or `outbound`.'
          in: query
          name: direction
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: 'Filter by direction: `inbound` or `outbound`.'
            title: Direction
        - description: >-
            Filter by processing status: `pending`, `processed`, `failed`, or
            `acknowledged`.
          in: query
          name: status
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Filter by processing status: `pending`, `processed`, `failed`, or
              `acknowledged`.
            title: Status
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/SettlementMessageResponse'
                title: >-
                  Response List Messages Schedule Management V1 Mabis Clearing
                  Periods  Uid  Messages Get
                type: array
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    SettlementMessageResponse:
      description: >-
        An EDIFACT message exchanged during the settlement process (MSCONS,
        PRICAT, UTILMD, IFTSTA, etc.).
      properties:
        clearing_period_uid:
          description: >-
            Parent [Clearing
            Period](/api-reference/settlement-management/models/clearing-period)
            identifier.
          title: Clearing Period Uid
          type: string
        created_ts:
          description: ISO 8601 datetime when this record was created.
          examples:
            - '2026-02-20T08:00:00+00:00'
          title: Created Ts
          type: string
        direction:
          description: >-
            Message direction: `inbound` (received from TSO/DSO) or `outbound`
            (sent to TSO/DSO).
          examples:
            - inbound
            - outbound
          title: Direction
          type: string
        error_message:
          anyOf:
            - type: string
            - type: 'null'
          description: Error description if processing failed.
          title: Error Message
        message_type:
          description: >-
            EDIFACT message type: `MSCONS`, `PRICAT`, `UTILMD`, `IFTSTA`,
            `PARTIN`, etc.
          examples:
            - MSCONS
            - PRICAT
            - IFTSTA
          title: Message Type
          type: string
        received_ts:
          anyOf:
            - type: string
            - type: 'null'
          description: ISO 8601 datetime when the message was received (inbound only).
          title: Received Ts
        reference_id:
          description: EDIFACT reference identifier for this message.
          examples:
            - MSCONS-20260115-001
          title: Reference Id
          type: string
        sent_ts:
          anyOf:
            - type: string
            - type: 'null'
          description: ISO 8601 datetime when the message was sent (outbound only).
          title: Sent Ts
        status:
          description: >-
            Processing status: `pending`, `processed`, `failed`, or
            `acknowledged`.
          examples:
            - processed
            - pending
          title: Status
          type: string
        uid:
          description: Unique identifier for this message record.
          examples:
            - f8a9b0c1-d2e3-4f4a-8b5c-6d7e8f9a0b1c
          title: Uid
          type: string
      required:
        - clearing_period_uid
        - created_ts
        - direction
        - message_type
        - reference_id
        - status
        - uid
      title: SettlementMessageResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    apiKeyAuth:
      in: header
      name: Authorization
      type: apiKey

````