Skip to main content

Attributes

Version: 4.9.0

AllocationCutOffTime​

Local time (HH:mm, Europe/Vienna) on day D+1 after which the allocation of day D is final and frozen; empty means 06:00

Data Type​

STRING

AllocationKey​

Allocation key of the community (default Dynamic)

Data Type​

ENUM: EnergyCommunity-4/AllocationKey

BackfillDays​

Number of days a reset simulates backwards from today (default 730)

Data Type​

INT

BillingCycle​

Billing cycle associated with the customer

Data Type​

ENUM: EnergyCommunity-4/BillingCycle

Default Values​
Default Value
1

BillingDocumentState​

The state of the billing document

Data Type​

ENUM: EnergyCommunity-4/BillingDocumentState

BillingType​

The type of the billing document or billing item

Data Type​

ENUM: EnergyCommunity-4/BillingType

CompletedAt​

When the reset runner finished the request

Data Type​

DATE_TIME

ConsumptionFactor​

Multiplier on the annual consumption of all simulated consumers (default 1.0, sensible range 0.5-2)

Data Type​

DOUBLE

Currency​

The ISO 4217 representation of the used currency

Data Type​

STRING

CustomerNumber​

Internal customer number

Data Type​

STRING

DailyRun​

Whether the daily simulation run generates values for this community (default true)

Data Type​

BOOLEAN

DateOfBirth​

Date of birth of the customer (natural person)

Data Type​

DATE_TIME

DiscardReported​

Allow a full reset to discard the values of self-reported metering points

Data Type​

BOOLEAN

EffectiveFrom​

First day (Europe/Vienna) the settings revision applies to; never earlier than the day the revision was created, unless it is the base revision of a reset

Data Type​

DATE_TIME

EnergyConsumption​

Energy consumed per year in kWh

Data Type​

DOUBLE

Meta Data​
KeyValue
UnitkWh

EnergyProductionCapacity​

Maximal energy production capacity in kWp

Data Type​

DOUBLE

Meta Data​
KeyValue
UnitkWp

GrossAmount​

The gross amount of the billing document

Data Type​

DOUBLE

GrossTotal​

The gross total of the billing document

Data Type​

DOUBLE

IntervalCount​

Total number of stream-data intervals aggregated into the billed quantity

Data Type​

INT

IntervalCountL1​

Number of billed intervals with data quality L1 (metered values)

Data Type​

INT

IntervalCountL2​

Number of billed intervals with data quality L2 (interpolated values)

Data Type​

INT

IntervalCountL3​

Number of billed intervals with data quality L3 (estimated values)

Data Type​

INT

IntervalCountUnknown​

Number of billed intervals with unknown data quality

Data Type​

INT

LoadProfile​

Standard load profile used to simulate the consumption (default H0)

Data Type​

ENUM: EnergyCommunity-4/LoadProfile

MemberScale​

Multiplier on the number of members of the preset; takes effect only through a full reset (default 1.0)

Data Type​

DOUBLE

MemberSpread​

Relative seeded spread of the size of each simulated member around its nominal value (0 = none, 0.25 = +/-25 %)

Data Type​

DOUBLE

MeteringDataSource​

Origin of the metering values; the simulation only writes metering points marked Simulated

Data Type​

ENUM: EnergyCommunity-4/MeteringDataSource

NearRealTime​

Generate values every 15 minutes instead of once per day (planned)

Data Type​

BOOLEAN

NetAmount​

The net amount of the billing document

Data Type​

DOUBLE

Price​

The price of a given unit of energy

Data Type​

DOUBLE

PvCapacityFactor​

Multiplier on the installed capacity of all simulated PV producers (default 1.0, sensible range 0-3)

Data Type​

DOUBLE

PvSpecificYield​

Annual PV yield in kWh per kWp under clear sky (default 1050, Salzburg)

Data Type​

DOUBLE

Meta Data​
KeyValue
UnitkWh/kWp

RequestedAt​

When the reset was requested

Data Type​

DATE_TIME

RequestedBy​

Who requested the reset (user or client id)

Data Type​

STRING

SimulationNoiseLevel​

Seeded noise on simulated values (default Off)

Data Type​

ENUM: EnergyCommunity-4/SimulationNoiseLevel

SimulationPreset​

Composition preset of the simulated community; changing it takes effect only through a full reset

Data Type​

ENUM: EnergyCommunity-4/SimulationPreset

SimulationResetMode​

Requested reset mode

Data Type​

ENUM: EnergyCommunity-4/SimulationResetMode

SimulationResetState​

Processing state of the reset request

Data Type​

ENUM: EnergyCommunity-4/SimulationResetState

SimulationSeed​

Seed of all random values of the simulation; same settings and seed give identical data

Data Type​

INT

SimulationWeatherMode​

Daily weather model for PV (default ClearSky)

Data Type​

ENUM: EnergyCommunity-4/SimulationWeatherMode

SupersededByReset​

Set by a reset on all earlier settings revisions; superseded revisions no longer apply

Data Type​

BOOLEAN

TaxAmount​

The tax amount of the billing document

Data Type​

DOUBLE

TaxProcedureCreditNote​

The tax procedure credit notes associated with the billing document

Data Type​

ENUM: EnergyCommunity-4/TaxProcedureCreditNote

TaxRate​

The tax rate of the billing document

Data Type​

DOUBLE

UnitPrice​

The unit price of the billing document

Data Type​

DOUBLE