Subsidy Applications
Update a subsidy application
You only need to provide the fields you want to update. An application can be updated once it is commissioned and until it is submitted; otherwise the request is refused with 400. amountOfApartments and amountOfSubsidizedApartments take whole numbers. The application is submitted in autarc, so state and completed are ignored, as are fields the application form no longer asks: yearlyNetIncome, hasChildrenInHousehold, newHeatingSystem, newHeatpumpRefrigerant, allocatedLivingSpace, ratedOutput, buildingConstructionDate and currentHeatingSystem (use currentHeatingSystemKfwType). Of plannedHeatingSystems and speedBonusReplacedHeatings only the first entry is kept.
patch/subsidy-application/{subsidyApplicationId}
Request
- Base URLhttps://api3.autarc.energy/v1
- AuthAPI key in header X-Api-Key
Path parameters
subsidyApplicationIdstring uuid required
Request body
firstNamestring nullable
lastNamestring nullable
state'dataCompletion' | 'supplyAndServiceContract' | 'submission' | 'submitted'
completedboolean
grantRecipientType'privatePerson' | 'company' | 'brineWater' nullable
grantRecipientOwner'singleFamilyHouse' | 'multiFamilyHouse' | 'no' nullable
isPrimaryResidenceboolean
yearlyNetIncome'moreThan40k' | 'lessThan40k' | 'unknown' nullable
currentHeatingSystem'oil' | 'coalOrNightStorage' | 'gas' | 'gasFloorHeating' | 'biomass' | 'heatpump' | 'districtHeating' | 'combinedHeatAndPowerUnit' | 'other' | 'noHeatingSystem' nullable
isCurrentHeatingSystemWorkingboolean
willCurrentHeatingSystemReplacedboolean
currentHeatingSystemStartOfOperationstring date nullable
currentHeatingSystemKfwType'gas' | 'gasFloorHeating' | 'oil' | 'nightStorage' | 'electricDirect' | 'coal' | 'biomassSolid' | 'biomassLiquid' | 'biomassGaseous' | 'biomassSingleStove' | 'solarThermalDomesticWater' | 'solarThermalHeating' | 'heatpumpAirWater' | 'heatpumpAirAir' | 'heatpumpBrineWater' | 'heatpumpWaterWater' | 'heatpumpGasDriven' | 'heatpumpOther' | 'bivalentHeatpumpBiomassElectric' | 'bivalentHeatpumpGasElectric' | 'districtHeating' | 'combinedHeatAndPowerUnit' | 'other' | 'noHeatingSystem' nullable
The existing heat generator as the KfW BzA portal lists it.
currentHeatingSystemRatedOutputnumber nullable
Rated output of the existing heat generator in kW.
currentHeatingSystemFinalEnergyConsumptionnumber nullable
Yearly final energy consumption of the existing heat generator in kWh/a.
projectAlreadyStartedboolean
isBuildingHeatedByFossilFuelsAfterReplacementboolean
qualifiesForSpeedBonusboolean nullable
KfW BzA "Boni" — whether the project qualifies for the Klimageschwindigkeitsbonus.
speedBonusReplacedHeatingsstring[]
KfW BzA "Boni" — which heating kinds are replaced.
buildingConstructionDatestring date nullable
buildingUsageType'residential' | 'fullyCommercial' nullable
buildingCategory'accommodation' | 'careFacility' | 'daycare' | 'clinic' | 'warehouse' | 'workshop' | 'dataCenter' | 'school' | 'socialBuilding' | 'sportsFacility' | 'retailEstablishment' | 'officeBuilding' | 'otherCommercial' | 'otherHealthcare' nullable
amountOfApartmentsnumber nullable
amountOfSubsidizedApartmentsnumber nullable
willMoreThanOneBuildingConnectedToNewHeatingSystemboolean
newHeatingSystem'heatpump' | 'biomass' | 'solarThermal' | 'districtHeating' nullable
newHeatingSystemCombinedWith'heatpump' | 'photovoltaic' | 'solarThermal' | 'noAdditionalCombination' nullable
biomassEmissionValueComplianceboolean nullable
newHeatpumpType'airWater' | 'waterWater' | 'brineWater' nullable
plannedHeatingSystemsstring[]
isContractingboolean nullable
heatpumpSystemNumberstring nullable
heatpumpManufacturerstring nullable
heatpumpModelstring nullable
heatpumpFlowTemperature'celsius35' | 'celsius55' nullable
newHeatpumpRefrigerant'R290' | 'R32' | 'R134a' | 'R410A' | 'R452B' | 'R454C' | 'R600A' | 'R717' | 'R744' | 'R454B' | 'R407C' | 'R513A' | 'R1234ze(E)' | 'R449A' | 'R515B' | 'R417A' | 'R1234ze' | 'R404A' nullable
allocatedLivingSpacenumber nullable
estimatedGrossCostnumber nullable
liabilityInsuranceboolean
ratedOutputnumber nullable
connectedLoadnumber nullable
expectedImplementationDatestring date nullable
optionalMessagestring nullable
netHeatedFloorAreanumber nullable
netHeatedFloorAreaRelevantToMeasurenumber nullable
absoluteCo2savingsnumber nullable
Response
A single subsidy application
idstring uuid
project_idstring uuid
company_idstring uuid
state'dataCompletion' | 'supplyAndServiceContract' | 'submission' | 'submitted'
first_namestring nullable
last_namestring nullable
grant_recipient_type'privatePerson' | 'company' | 'brineWater' nullable
grant_recipient_owner'singleFamilyHouse' | 'multiFamilyHouse' | 'no' nullable
is_primary_residenceboolean
yearly_net_income'moreThan40k' | 'lessThan40k' | 'unknown' nullable
current_heating_system'oil' | 'coalOrNightStorage' | 'gas' | 'gasFloorHeating' | 'biomass' | 'heatpump' | 'districtHeating' | 'combinedHeatAndPowerUnit' | 'other' | 'noHeatingSystem' nullable
is_current_heating_system_workingboolean
will_current_heating_system_replacedboolean
current_heating_system_start_of_operationstring date-time nullable
current_heating_system_kfw_type'gas' | 'gasFloorHeating' | 'oil' | 'nightStorage' | 'electricDirect' | 'coal' | 'biomassSolid' | 'biomassLiquid' | 'biomassGaseous' | 'biomassSingleStove' | 'solarThermalDomesticWater' | 'solarThermalHeating' | 'heatpumpAirWater' | 'heatpumpAirAir' | 'heatpumpBrineWater' | 'heatpumpWaterWater' | 'heatpumpGasDriven' | 'heatpumpOther' | 'bivalentHeatpumpBiomassElectric' | 'bivalentHeatpumpGasElectric' | 'districtHeating' | 'combinedHeatAndPowerUnit' | 'other' | 'noHeatingSystem' nullable
The existing heat generator as the KfW BzA portal lists it.
current_heating_system_rated_outputnumber nullable
Rated output of the existing heat generator in kW.
current_heating_system_final_energy_consumptionnumber nullable
Yearly final energy consumption of the existing heat generator in kWh/a.
project_already_startedboolean
is_building_heated_by_fossil_fuels_after_replacementboolean
qualifies_for_speed_bonusboolean nullable
KfW BzA "Boni" — whether the project qualifies for the Klimageschwindigkeitsbonus.
speed_bonus_replaced_heatingsstring[]
KfW BzA "Boni" — which heating kinds are replaced.
building_construction_datestring date-time nullable
building_usage_type'residential' | 'fullyCommercial' nullable
building_category'accommodation' | 'careFacility' | 'daycare' | 'clinic' | 'warehouse' | 'workshop' | 'dataCenter' | 'school' | 'socialBuilding' | 'sportsFacility' | 'retailEstablishment' | 'officeBuilding' | 'otherCommercial' | 'otherHealthcare' nullable
amount_of_apartmentsnumber nullable
amount_of_subsidized_apartmentsnumber nullable
will_more_than_one_building_connected_to_new_heating_systemboolean
new_heating_system'heatpump' | 'biomass' | 'solarThermal' | 'districtHeating' nullable
new_heating_system_combined_with'heatpump' | 'photovoltaic' | 'solarThermal' | 'noAdditionalCombination' nullable
biomass_emission_value_complianceboolean nullable
new_heatpump_type'airWater' | 'waterWater' | 'brineWater' nullable
planned_heating_systemsstring[]
is_contractingboolean nullable
heatpump_system_numberstring nullable
heatpump_manufacturerstring nullable
heatpump_modelstring nullable
heatpump_flow_temperature'celsius35' | 'celsius55' nullable
new_heatpump_refrigerant'R290' | 'R32' | 'R134a' | 'R410A' | 'R452B' | 'R454C' | 'R600A' | 'R717' | 'R744' | 'R454B' | 'R407C' | 'R513A' | 'R1234ze(E)' | 'R449A' | 'R515B' | 'R417A' | 'R1234ze' | 'R404A' nullable
net_heated_floor_areanumber nullable
net_heated_floor_area_relevant_to_measurenumber nullable
absolute_co2savingsnumber nullable
estimated_gross_costnumber nullable
allocated_living_spacenumber nullable
liability_insuranceboolean
rated_outputnumber nullable
connected_loadnumber nullable
sent_atstring date-time nullable
expected_implementation_datestring date-time nullable
optional_messagestring nullable
bza_idstring nullable
bza_funding_ratenumber nullable
bza_commentstring nullable
application_datestring date-time nullable
completedboolean
created_atstring date-time
updated_atstring date-time
deleted_atstring date-time nullable
Changes
No recorded changes to this operation across all 1 revision of this API.