Calculators page

Produced by POST /api/v2/bulk/calculators/search; the task reports "requestType": "BulkGetCompanyCalculators". One file per page of companies, each a complete document — see Result files for how pages are delivered and the conventions they share.

A calculator is one company's computation for one reporting period — a carbon footprint for 2025, a water-use figure for March 2026 — with the values it was fed and the values it produced. The variables those values belong to are declared once at the top of the page and referenced by id from every calculator.

Top level

Field	Type	Notes
customProperties	CustomProperty[]	{ id, name } for the requested properties your profile owns. Drawn from that list rather than from the values, so it is identical on every page and can name a property no company in the export holds a value for; every key in this page's companies[].fields still resolves here. A requested id your profile does not own is silently left out rather than rejected. Absent when the request asked for no custom properties.
calculatorVariables	CalculatorVariable[]	{ id, name } for every variable referenced by any calculator's inputs or outputs on the page. name is the variable's type name, for example "EstimatedConsumptionPurchasedElectricityGrid". Absent when no calculator carries a value.
companies	Company[]	The page's companies.

Company

Field	Type	Notes
id	uuid	The company id the rest of the API uses.
name	string
fields	object	Keyed by custom-property id, each value a string[] of that property's values for the company. Holds only the ids the request listed in customPropertyIds; absent when none apply.
calculators	Calculator[]	The company's calculators matching the request. A company with none has an empty list.

Calculator

Field	Type	Notes
id	uuid	The calculator instance.
typeId	uuid	The calculator type — the same id the request's calculatorTypeIds selects on.
title	string
period	{ year, month }	The reporting period. month is a month name, present on monthly calculators only.
inputs	object	Keyed by variable id — resolved in calculatorVariables — each value the input as a string. Absent when the calculator has no input values.
outputs	object	Keyed by variable id, each value the computed output as a string. Absent when the calculator has no output values.

Values are strings as stored, not parsed numbers; blank values are left out rather than emitted empty.

Example

{
  "customProperties": [
    { "id": "0992e704-5c3b-4b6e-8a1d-7f2e9c4b6d18", "name": "Property code" }
  ],
  "calculatorVariables": [
    { "id": "2f1c9d7e-8a3b-4c5d-9e6f-0a1b2c3d4e01", "name": "EstimatedConsumptionPurchasedElectricityGrid" },
    { "id": "6b5a4c3d-2e1f-4a9b-8c7d-6e5f4a3b2c02", "name": "CarbonFootprintPrOccupiedRoom" }
  ],
  "companies": [
    {
      "id": "9c56d3a1-8b0f-4c7a-9e2d-5b1a7f3e0c11",
      "name": "Hotel Aurora",
      "fields": {
        "0992e704-5c3b-4b6e-8a1d-7f2e9c4b6d18": ["HA-2041"]
      },
      "calculators": [
        {
          "id": "c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e03",
          "typeId": "d7e8f9a0-b1c2-4d3e-8f4a-5b6c7d8e9f04",
          "title": "Carbon footprint 2025",
          "period": { "year": 2025 },
          "inputs": {
            "2f1c9d7e-8a3b-4c5d-9e6f-0a1b2c3d4e01": "412500"
          },
          "outputs": {
            "6b5a4c3d-2e1f-4a9b-8c7d-6e5f4a3b2c02": "128.4"
          }
        }
      ]
    }
  ]
}