Input schema (JSON)
{
"type": "object",
"required": [
"order_id",
"order_token"
],
"properties": {
"facts": {
"type": [
"null",
"object"
],
"properties": {
"attic": {
"type": "string",
"description": "beheizt (lived in, heated), unbeheizt (unheated loft) or keins (none, e.g. flat roof)"
},
"units": {
"type": "integer",
"description": "number of flats in the whole building"
},
"purpose": {
"type": "string",
"description": "verkauf (sale), vermietung (letting), verlaengerung (lease extension) or aushang (display or own records)"
},
"storeys": {
"type": "integer",
"description": "full storeys (Vollgeschosse), without attic and basement"
},
"basement": {
"type": "string",
"description": "keiner, unbeheizt or beheizt"
},
"ownership": {
"type": "string",
"description": "gebaeude if the customer owns the whole building, wohnung if one flat in it; the certificate always covers the whole building"
},
"modernised": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
},
"description": "envelope parts renewed since construction: dach, aussenwand, fenster, kellerdecke; replaces the list"
},
"year_built": {
"type": "integer",
"description": "year the building was built"
},
"living_area_m2": {
"type": "number",
"description": "Wohnfläche of the whole building in m², all flats together"
},
"residential_only": {
"type": [
"null",
"boolean"
],
"description": "true if the building is used for housing only"
}
},
"additionalProperties": false
},
"heating": {
"type": [
"null",
"object"
],
"properties": {
"year": {
"type": "integer",
"description": "Baujahr of the boiler or heat pump (with Fernwärme: of the transfer station), from the type plate or the chimney sweep's record"
},
"carrier": {
"type": "string",
"description": "main energy carrier of the heating: erdgas, fluessiggas, heizoel, fernwaerme, holzpellets, scheitholz, hackschnitzel, strom_waermepumpe, strom_direkt, steinkohle or braunkohle"
},
"cooling": {
"type": "string",
"description": "keine, or strom for electric air conditioning"
},
"hot_water": {
"type": "string",
"description": "zentral_enthalten (made by the heating, in its consumption, share unknown), zentral_gemessen (made by the heating, and the bill states the hot water share: send it as hot_water_kwh with each period) or dezentral (electric boilers or instantaneous heaters, not in the consumption)"
},
"renewables": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
},
"description": "solarthermie, photovoltaik, biomasse (wood stove); replaces the list. A heat pump or wood heating counts on its own"
},
"ventilation": {
"type": "string",
"description": "fenster (windows), anlage (ventilation system) or anlage_wrg (with heat recovery)"
},
"hot_water_by": {
"type": "string",
"description": "with hot_water zentral_enthalten and periods of several carriers: the carrier whose system heats the water, or gemeinsam when several heat it together (e.g. a wood stove with a water jacket and a heat pump on one tank). A room stove without a water jacket heats no water. Leave it out if unknown: the hot water is then split by consumption"
},
"cooled_area_m2": {
"type": "number",
"description": "living area cooled by air conditioning, in m²"
},
"district_heating": {
"type": [
"null",
"object"
],
"properties": {
"supplier": {
"type": "string",
"description": "the Fernwärme supplier, e.g. Stadtwerke Münster"
},
"generation": {
"type": "string",
"description": "how the heat is made, as the supplier states: kwk_gas, kwk_kohle, kwk_erneuerbar (combined heat and power) or heizwerk_gas, heizwerk_kohle, heizwerk_erneuerbar (heating plant)"
},
"primary_factor": {
"type": [
"null",
"number"
],
"description": "the Primärenergiefaktor the supplier publishes, if known"
}
},
"description": "with Fernwärme: how it is generated",
"additionalProperties": false
}
},
"additionalProperties": false
},
"order_id": {
"type": "string",
"description": "the order_id start_order returned"
},
"consumption": {
"type": [
"null",
"object"
],
"properties": {
"periods": {
"type": [
"null",
"array"
],
"items": {
"type": "object",
"required": [
"start",
"end",
"carrier",
"quantity",
"unit"
],
"properties": {
"end": {
"type": "string",
"description": "last day of the billing period (inclusive), YYYY-MM-DD"
},
"unit": {
"type": "string",
"description": "unit as printed: kWh, MWh, m3, l, kg, t, rm (Raummeter) or srm"
},
"start": {
"type": "string",
"description": "first day of the billing period, YYYY-MM-DD"
},
"carrier": {
"type": "string",
"description": "energy carrier billed, e.g. erdgas, heizoel, fernwaerme, holzpellets, strom_waermepumpe"
},
"evidence": {
"type": "string",
"description": "the text you read this period from on the bill, verbatim, for the Energieberater"
},
"quantity": {
"type": "number",
"description": "consumption for heating and hot water in the period, as printed on the bill, as a plain number: German bills group thousands with a point, so 18.451 kWh is 18451"
},
"kwh_is_gross": {
"type": [
"null",
"boolean"
],
"description": "for kWh of gas: true if the bill states kWh by the Brennwert (gas bills usually do; default true for gas)"
},
"hot_water_kwh": {
"type": [
"null",
"number"
],
"description": "only if the bill states the energy for hot water separately, in kWh"
},
"calorific_value": {
"type": "number",
"description": "gas billed in m3 only: the Abrechnungsbrennwert (Hs) in kWh/m3 as printed; send it together with condition_factor"
},
"condition_factor": {
"type": "number",
"description": "gas billed in m3 only: the Zustandszahl as printed; send it together with calorific_value"
}
},
"additionalProperties": false
},
"description": "the billing periods of the whole building, one per period on the bill; from a Heizkostenabrechnung the Gesamtverbrauch der Liegenschaft, never one flat's share; replaces all periods"
},
"vacancy_percent": {
"type": [
"null",
"number"
],
"description": "share of the living area that stood empty in the periods, in percent"
}
},
"additionalProperties": false
},
"order_token": {
"type": "string",
"description": "the order_token start_order returned; it opens only this order, keep it private"
}
},
"additionalProperties": false
}