----------------------------------------------------------------------------------------------------------------------- Version List ----------------------------------------------------------------------------------------------------------------------- 04/11/2021 - Version 1.0.0 1st part: Add the AuditMessages, AuditMessage, Headers and Payload element for the XML validation 2nd part: Add version to xsd schema ----------------------------------------------------------------------------------------------------------------------- 04/11/2021 - Version 1.1.0 - Add the contract rule details - Remove the ContractApportionmentId (the ContractApportionment is at the contract level so ContractApportionmentId did not have any sense) - Add ClearingVersion - Remove the rule name at contract level - Remove the payerRoleType in Apportionment/Settlement at contract level - Remove the compensation in Settlement at contract level ----------------------------------------------------------------------------------------------------------------------- 11/07/2022 - Version 1.2.0 - Add ContractSerialNumber ----------------------------------------------------------------------------------------------------------------------- 17/10/2022 - Version 1.2.1 - Add BestEffort in ContractApportionmentAuditExchange ----------------------------------------------------------------------------------------------------------------------- 03/11/2022 - Version 1.3.0 - Rename ApportionedRevenue to AmountToApportion - see ClearingItemType.xsd file version 1.1.0 ----------------------------------------------------------------------------------------------------------------------- 03/11/2023 - Version 1.3.1 - Add capping product code et journey definition product code to identify the capping/journey definition used in the apportionment. ----------------------------------------------------------------------------------------------------------------------- 23/04/2024 - Version 1.3.2 - Add DailyMediaConsumptions with dailyMediaConsumptionId and legIds. ----------------------------------------------------------------------------------------------------------------------- Apportionment of a fraction of contract from a payer to a payee's account during a settlement period. clr_apportionment_get: At apportionment creation Apportionment of a fraction of contract from a payer to a payee's account during a settlement period. Sorted rule details The total revenue to be apportioned among all the stakeholder The contract as an instance of a product, possibly on a media. The contract serial number: serial number of the Contract Id. The unique identifier of the related event. The media holding the contract The type of product of the contract instance if it is a non transit product. Dictionary prefix: NonTransitProductCode The version of the clearing parameters. The type of product of the contract instance if it is a transit product. Dictionary prefix: ProductCode The type of product of the contract instance if it is a supplement product. Dictionary prefix: SupplementProductCode The type of capping of the contract instance if it is a capping instance. Dictionary prefix: CappingRule The type of journey definition of the contract instance if it is a journey instance. Dictionary prefix: JourneyDefinition In case of an apportionment of an amount lower than the revenue: If true, will perform the apportionment the best way possible. If false, will do nothing for the apportionment. The ordering sequence number of this contract's apportionment. DailyMediaConsumptions Id of the daily media consumption that was involved in this payment request Legs Unique identifier for a leg. Between multiple reconstructions, the legId will be kept constant if the leg did not change