API Version 2024.05

Aurora released a new API version to make backward-incompatible changes. To avoid disrupting your integration and breaking your code, we don’t change your version automatically. When you are ready, you can upgrade to the latest version in Aurora settings, or by using Versions API. The following are breaking changes in version 2024.05.

• Removed Aurora-API-Version header from production. The header is still available for use in sandbox for testing. To upgrade your production version, please use versioning API or visit the settings page in the Aurora app.
• Remove user_ids field from Retrieve Tenant endpoint
• Changed preferred_solar_panels to preferred_solar_modules in Create Project and Update Project
• Changed customer_address to mailing_address in Project APIs
• Changed address to property_address and added property_address, longitude, and latitude to the location object in Project APIs
• Removed updated_at from Project and Agreement endpoints
• Added Nearmap (True Ortho) as option for image_src in Design Request endpoints
• Changed NearMap to Nearmap in Retreive Design Request endpoint
• Removed manufacturer field from Retrieve Design Summary arrays when redundant with bill_of_materials items
• Changed panels to modules in Retrieve Roof Summary
• Changed max_panel_spacing to max_module_spacing, and increased default value from 1cm to 2.6cm in List Racking Arrays
• Updated url path for Retrieve Design Asset from /tenants/{tenant_id}/assets/{id} to /tenants/{tenant_id}/designs/{design_id}/assets/{id}
• Changed several fields in Retrieve Design Pricing and Update Design Pricing:
  • Changed all references to cost to price
  • Changed pricing_mode to pricing_method
  • Change line_items to pricing_by_component
  • Changed adders_without_discounts to adders and adders to discounts in system_price_breakdown and storage_system_price_breakdown
• Changed system_cost to system_price and inverter_cost_per_watt to inverter_price_per_watt in Retrieve Financing API
• Removed support for string values in the enabled field from Create Webhook and Update Webhook
• Updated webhook filters to use a list of objects with static keys url_parameter and value instead of an object with each url_parameter as a key.