Types

Version: 4.9.0

BillingDocument

Inheritance: System-2.5.0/Entity-1 ➔ Basic-2.4.0/Document-1 ➔ EnergyCommunity-4.9.0/BillingDocument-1

A billing document entity that contains accounting information.

ID	Auto Complete Values	Auto Increment Reference	Is Optional
EnergyCommunity-4/CustomerNumber			False
Basic-2/Contact			False
Basic-2/TimeRange			False
Basic-2/Comment			True
EnergyCommunity-4/TaxProcedureCreditNote			False
EnergyCommunity-4/BillingType			False
EnergyCommunity-4/BillingDocumentState			False
EnergyCommunity-4/GrossTotal			False
Basic-2/BankAccount			True

Outbound Associations

Outbound Name	Outbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
AssignedTo	ZeroOrOne	EnergyCommunity-4/AssignedBilling	EnergyCommunity-4/Customer

Inbound Associations

Inbound Name	Inbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
Children	N	System-2/ParentChild	EnergyCommunity-4/BillingDocumentLineItem

BillingDocumentLineItem

Inheritance: System-2.5.0/Entity-1 ➔ EnergyCommunity-4.9.0/BillingDocumentLineItem-1

A billing document line item

ID	Auto Complete Values	Auto Increment Reference	Is Optional
EnergyCommunity-4/GrossAmount			False
EnergyCommunity-4/NetAmount			False
EnergyCommunity-4/TaxAmount			False
EnergyCommunity-4/TaxRate			False
EnergyCommunity-4/UnitPrice			False
EnergyCommunity-4/BillingType			False
Basic-2/Quantity			False
Basic-2/TimeRange			True
EnergyCommunity-4/IntervalCount			True
EnergyCommunity-4/IntervalCountL1			True
EnergyCommunity-4/IntervalCountL2			True
EnergyCommunity-4/IntervalCountL3			True
EnergyCommunity-4/IntervalCountUnknown			True

Outbound Associations

Outbound Name	Outbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
Parent	One	System-2/ParentChild	EnergyCommunity-4/BillingDocument

CommunitySettings

Inheritance: System-2.5.0/Entity-1 ➔ EnergyCommunity-4.9.0/CommunitySettings-1

Product settings of the energy community as a whole (one entity per tenant; real and simulated communities alike). Readers take the first entity and fall back to the documented defaults when none exists or a value is empty.

ID	Auto Complete Values	Auto Increment Reference	Is Optional
EnergyCommunity-4/AllocationCutOffTime			True
EnergyCommunity-4/AllocationKey			True
System-2/Description			True

Consumer

Inheritance: System-2.5.0/Entity-1 ➔ Basic-2.4.0/NamedEntity-1 ➔ Basic.Energy-1.9.0/MeteringPoint-1 ➔ Basic.Energy-1.9.0/Consumer-1 ➔ EnergyCommunity-4.9.0/Consumer-1

A consumer metering point participating in an energy community

ID	Auto Complete Values	Auto Increment Reference	Is Optional
Basic.Energy/PartitionFactor			True
EnergyCommunity-4/EnergyConsumption			True
EnergyCommunity-4/MeteringDataSource			True
EnergyCommunity-4/LoadProfile			True

Customer

Inheritance: System-2.5.0/Entity-1 ➔ EnergyCommunity-4.9.0/Customer-1

Represents a customer of an energy community

ID	Auto Complete Values	Auto Increment Reference	Is Optional
EnergyCommunity-4/CustomerNumber		C u s t o m e r N u m b e r	False
Basic-2/Contact			False
Basic-2/Comment			True
EnergyCommunity-4/BillingCycle			False
Basic.Energy/State			False
Basic-2/BankAccount			True
EnergyCommunity-4/TaxProcedureCreditNote			False
EnergyCommunity-4/DateOfBirth			True

Outbound Associations

Outbound Name	Outbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
Facilities	N	EnergyCommunity-4/AssociatedFacilities	Basic.Energy/OperatingFacility

Inbound Associations

Inbound Name	Inbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
Billing	N	EnergyCommunity-4/AssignedBilling	EnergyCommunity-4/BillingDocument

EnergyPrice

Inheritance: System-2.5.0/Entity-1 ➔ EnergyCommunity-4.9.0/EnergyPrice-1

The price of Energy at a certain time

ID	Auto Complete Values	Auto Increment Reference	Is Optional
EnergyCommunity-4/Price			False
EnergyCommunity-4/Currency			False

ParticipationPeriod

Inheritance: System-2.5.0/Entity-1 ➔ EnergyCommunity-4.9.0/ParticipationPeriod-1

The participation period with a start and end date

ID	Auto Complete Values	Auto Increment Reference	Is Optional
Basic-2/TimeRange			False

Outbound Associations

Outbound Name	Outbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
MeteringPoint	One	EnergyCommunity-4/ParticipationPeriod	Basic.Energy/MeteringPoint

Producer

Inheritance: System-2.5.0/Entity-1 ➔ Basic-2.4.0/NamedEntity-1 ➔ Basic.Energy-1.9.0/MeteringPoint-1 ➔ Basic.Energy-1.9.0/Producer-1 ➔ EnergyCommunity-4.9.0/Producer-1

A producer metering point participating in an energy community

ID	Auto Complete Values	Auto Increment Reference	Is Optional
Basic.Energy/PartitionFactor			True
EnergyCommunity-4/EnergyProductionCapacity			True
EnergyCommunity-4/MeteringDataSource			True

SimulationResetRequest

Inheritance: System-2.5.0/Entity-1 ➔ EnergyCommunity-4.9.0/SimulationResetRequest-1

A request to reset the simulated data of the energy community. The request is only recorded here; an operator tool executes it and writes state and report back.

ID	Auto Complete Values	Auto Increment Reference	Is Optional
EnergyCommunity-4/SimulationResetMode			False
EnergyCommunity-4/BackfillDays			True
EnergyCommunity-4/DiscardReported			True
EnergyCommunity-4/SimulationResetState			False
EnergyCommunity-4/RequestedAt			False
EnergyCommunity-4/RequestedBy			True
EnergyCommunity-4/CompletedAt			True
System-2/Description			True

SimulationSettings

Inheritance: System-2.5.0/Entity-1 ➔ EnergyCommunity-4.9.0/SimulationSettings-1

One revision of the simulation settings of an energy community. For a day D the non-superseded revision with the greatest effective date <= D applies; the effective date is max(EffectiveFrom, creation date), except for the base revision written by a reset. Unset values fall back to the simulation defaults.

ID	Auto Complete Values	Auto Increment Reference	Is Optional
EnergyCommunity-4/SimulationPreset			False
EnergyCommunity-4/EffectiveFrom			False
EnergyCommunity-4/SimulationSeed			True
EnergyCommunity-4/ConsumptionFactor			True
EnergyCommunity-4/PvCapacityFactor			True
EnergyCommunity-4/PvSpecificYield			True
EnergyCommunity-4/MemberSpread			True
EnergyCommunity-4/SimulationNoiseLevel			True
EnergyCommunity-4/SimulationWeatherMode			True
EnergyCommunity-4/MemberScale			True
EnergyCommunity-4/BackfillDays			True
EnergyCommunity-4/DailyRun			True
EnergyCommunity-4/NearRealTime			True
EnergyCommunity-4/SupersededByReset			True
System-2/Description			True