poc-reports/es_elt/xsd/auditData/clr/ManualSettlementItemAudit.xsd

<?xml version="1.0" encoding="UTF-8"?>
<!--

    Copyright (C) Revenue Collection Systems France S.A.S. - 2018-2025 ALL RIGHTS RESERVED

-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
           xmlns:head="http://www.thales.dc/Headers"
           xmlns:loc="http://www.thales.dc/Localized"
           xmlns="http://www.thales.dc/ManualSettlementItemAudit"
           targetNamespace="http://www.thales.dc/ManualSettlementItemAudit"
           version="1.0.0">

    <!-- Import of xsd file -->
    <xs:import namespace="http://www.thales.dc/Headers" schemaLocation="../../common/Headers.xsd"/>
    <xs:import namespace="http://www.thales.dc/Localized" schemaLocation="../../common/Localized.xsd"/>

    <!-- Annotate all modification of the xsd file according to version -->
    <xs:annotation>
        <xs:documentation>-----------------------------------------------------------------------------------------------------------------------</xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>Version List</xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>-----------------------------------------------------------------------------------------------------------------------</xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>24/01/2023 - Version 1.0.0</xs:documentation>
        <xs:documentation>
            1st part: Add the AuditMessages, AuditMessage, Headers and Payload element for the XML validation
            2nd part: Add version to xsd schema
        </xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>-----------------------------------------------------------------------------------------------------------------------</xs:documentation>
    </xs:annotation>


    <!-- Description of the AuditMessages structure -->
    <xs:element name="AuditMessages" type="AuditMessagesType"/>
    <xs:complexType name="AuditMessagesType">
        <xs:sequence>
            <!-- List of AuditMessage -->
            <xs:element name="AuditMessage" type="AuditMessageType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <!-- version of AuditMessages structure -->
        <xs:attribute name="ManualSettlementItemXsdVersion" type="xs:string" fixed="1.0"/>
    </xs:complexType>
    <!-- Description of the AuditMessage structure -->
    <xs:complexType name="AuditMessageType">
        <xs:sequence>
            <!-- Headers structure -->
            <xs:element name="Headers" type="head:HeadersType" minOccurs="0"/>
            <!-- Payload is a ManualSettlementItemExchange structure -->
            <xs:element name="Payload" type="ManualSettlementItemExchange"/>
        </xs:sequence>
    </xs:complexType>
    <!-- Description of the ManualSettlementItemExchange structure -->
    <xs:complexType name="ManualSettlementItemExchange">
        <xs:annotation>
            <xs:documentation>clr_manual_settlement_item_post: At manual settlement item creation</xs:documentation>
            <xs:documentation>clr_manual_settlement_item_put: At manual settlement item update</xs:documentation>
            <xs:documentation>clr_manual_settlement_item_delete: At manual settlement item delete</xs:documentation>
        </xs:annotation>
        <xs:all>
            <xs:element name="ManualSettlementItemId" type="xs:string">
                <xs:annotation>
                    <xs:documentation>Manual settlement item Id</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="PayerId" type="loc:LocalizedBusinessEntity">
                <xs:annotation>
                    <xs:documentation>The stakeholder who will be debited money</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="PayerRoleType" type="loc:LocalizedBusinessEntityRoleType">
                <xs:annotation>
                    <xs:documentation>Retailer, Card Owner, Product Owner, Transporter...</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="PayerAccount" type="xs:string">
                <xs:annotation>
                    <xs:documentation>The account from which the money will be debited.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="PayeeId" type="loc:LocalizedBusinessEntity">
                <xs:annotation>
                    <xs:documentation>The stakeholder who will be credited money</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="PayeeRoleType" type="loc:LocalizedBusinessEntityRoleType">
                <xs:annotation>
                    <xs:documentation>Retailer, Card Owner, Product Owner, Transporter...</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="PayeeAccount" type="xs:string">
                <xs:annotation>
                    <xs:documentation>The account to where the money will be credited.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="Amount" type="xs:decimal" minOccurs="0">
                <xs:annotation>
                    <xs:documentation>The amount of the transfer.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="LastModificationDate" type="xs:dateTime" minOccurs="0">
                <xs:annotation>
                    <xs:documentation>Date of last change of the settlement item.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="CreationDate" type="xs:dateTime">
                <xs:annotation>
                    <xs:documentation>Date of creation of the settlement item.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="ExecutionDate" type="xs:dateTime" minOccurs="0">
                <xs:annotation>
                    <xs:documentation>Date of creation or update of the settlement item.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="ApplicationDate" type="xs:dateTime">
                <xs:annotation>
                    <xs:documentation>Application date of the settlement item.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="UserId" type="xs:string">
                <xs:annotation>
                    <xs:documentation>The unique identifier of the user who created ou updated Settlement Item.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="ClearingPeriod" type="xs:string" minOccurs="0">
                <xs:annotation>
                    <xs:documentation>The settlement period id.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="ManualSettlementItemStatus" type="ManualSettlementItemStatus">
                <xs:annotation>
                    <xs:documentation>The type of the rule</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="Reason" type="xs:string"  minOccurs="0">
                <xs:annotation>
                    <xs:documentation>The reason of created or modification manual settlement item</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="Sequence" type="xs:long" minOccurs="0">
                <xs:annotation>
                    <xs:documentation>The ordering sequence number of this settlement period.</xs:documentation>
                </xs:annotation>
            </xs:element>
        </xs:all>
    </xs:complexType>
    <xs:simpleType name="ManualSettlementItemStatus">
        <xs:restriction base="xs:string">
            <xs:enumeration value="PENDING"/>
            <xs:enumeration value="CANCELLED"/>
            <xs:enumeration value="SETTLED"/>
        </xs:restriction>
    </xs:simpleType>
</xs:schema>