Create a company emission estimate
HTTPPOST to /v1/estimates/companyEstimate emissions produced by a company. This includes office-related emissions, employee transportation, food, drinks, electronic equipment and computing/networking operations.The result is an estimate of a year-worth of company emissions.Request body
Parameters for estimating emissions associated with operating a company.
All relevant values are yearly values.
monthsinteger
Number of months covered by the emission estimate
employeesintegerrequired
Number of employees
remote_employees_percentageintegerrequired
Share of employees working remotely (in percent)
office_areaobjectrequired
Office area in square meters
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
square_meterssquare_feetcountry_codestringrequired
The three-letter country code of the country where the company is located.
postcodestring
The company's postal code
citystring
electricity_consumptionintegerrequired
Electricity consumption in kWh
green_electricity_usedbooleanrequired
Is the electricity provided by renewable source(s)?
gas_consumptionintegerrequired
Yearly natural gas consumption in cubic meters
company_carsintegerrequired
Company cars
average_car_distance_travelledobjectrequired
Average yearly distance travelled per car
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, km for kilometers, mi for miles
kmminmemployees_using_public_transportintegerrequired
Number of employees commuting by public transport
short_flightsintegerrequired
Number of short (under 3 hours) flights per year
medium_flightsintegerrequired
Number of medium (between 3 and 6 hours) flights per year
long_flightsintegerrequired
Number of long (over 6 hours) flights per year
first_or_business_class_percentageintegerrequired
Share of business or first class flights, in percent
food_and_drinks_expensesobjectrequired
Amount spend on food and drinks
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGvegetarian_and_vegan_percentageintegerrequired
Share of vegetarians or vegans in the company, in percent
electronic_device_expensesobjectrequired
New electronic devices (laptops, monitors, etc.) expenses
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGgarbageintegerrequired
The amount of garbage produced, in kilograms
recycled_garbage_percentageintegerrequired
Share of recycled garbage, in percent
techobject
on_premiseobject
Company's own tech infrastructure details
electricity_costobjectrequired
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGcloudobject
Company's use of cloud services
costobjectrequired
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGproviderstringrequired
The identifier of a cloud provider.
awsgcpazureovhotherbundle_selectionarray
Bundle selection percentages.
The sum of all percentages must equal 100.
If not specified, the preconfigured allocation ratios are going to be used.
If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.
object
Maps a bundle id to an allocation ratio
bundle_idstringrequired
The bundle's unique identifier
percentageoneOfSelection percentage as integer
Selection percentage as integer
quantity_truncstring
Selects to which precision to truncate quantities specific to carbon offsetting.
gkgtnamestring
A name to reference this calculation.
metadataobject
An arbitrary dictionary (key-value pairs) to store application-specific information.
Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.
idempotency_keystring
Account-unique identifier provided by the client.
idempotency_key has two purposes:
- Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
- Clients can use
idempotency_keyto reconcile estimates with entities on their system.
Response
massobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
An arbitrary dictionary (key-value pairs) to store application-specific information.
Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.
idempotency_keystring
Account-unique identifier provided by the client.
idempotency_key has two purposes:
- Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
- Clients can use
idempotency_keyto reconcile estimates with entities on their system.
idstringrequired
The emission calculation unique identifier
quoteoneOfrequiredError response
Error response
requestobjectrequired
Parameters for estimating emissions associated with operating a company.
All relevant values are yearly values.
monthsinteger
Number of months covered by the emission estimate
employeesintegerrequired
Number of employees
remote_employees_percentageintegerrequired
Share of employees working remotely (in percent)
office_areaobjectrequired
Office area in square meters
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
square_meterssquare_feetcountry_codestringrequired
The three-letter country code of the country where the company is located.
postcodestring
The company's postal code
citystring
electricity_consumptionintegerrequired
Electricity consumption in kWh
green_electricity_usedbooleanrequired
Is the electricity provided by renewable source(s)?
gas_consumptionintegerrequired
Yearly natural gas consumption in cubic meters
company_carsintegerrequired
Company cars
average_car_distance_travelledobjectrequired
Average yearly distance travelled per car
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, km for kilometers, mi for miles
kmminmemployees_using_public_transportintegerrequired
Number of employees commuting by public transport
short_flightsintegerrequired
Number of short (under 3 hours) flights per year
medium_flightsintegerrequired
Number of medium (between 3 and 6 hours) flights per year
long_flightsintegerrequired
Number of long (over 6 hours) flights per year
first_or_business_class_percentageintegerrequired
Share of business or first class flights, in percent
food_and_drinks_expensesobjectrequired
Amount spend on food and drinks
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGvegetarian_and_vegan_percentageintegerrequired
Share of vegetarians or vegans in the company, in percent
electronic_device_expensesobjectrequired
New electronic devices (laptops, monitors, etc.) expenses
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGgarbageintegerrequired
The amount of garbage produced, in kilograms
recycled_garbage_percentageintegerrequired
Share of recycled garbage, in percent
techobject
on_premiseobject
Company's own tech infrastructure details
electricity_costobjectrequired
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGcloudobject
Company's use of cloud services
costobjectrequired
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGproviderstringrequired
The identifier of a cloud provider.
awsgcpazureovhotherbundle_selectionarray
Bundle selection percentages.
The sum of all percentages must equal 100.
If not specified, the preconfigured allocation ratios are going to be used.
If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.
object
Maps a bundle id to an allocation ratio
bundle_idstringrequired
The bundle's unique identifier
percentageoneOfSelection percentage as integer
Selection percentage as integer
quantity_truncstring
Selects to which precision to truncate quantities specific to carbon offsetting.
gkgtnamestring
A name to reference this calculation.
metadataobject
An arbitrary dictionary (key-value pairs) to store application-specific information.
Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.
idempotency_keystring
Account-unique identifier provided by the client.
idempotency_key has two purposes:
- Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
- Clients can use
idempotency_keyto reconcile estimates with entities on their system.
scope1objectrequired
Scope 1 emissions. Direct emissions from owned or controlled sources.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtscope2objectrequired
Scope 2 emissions. Indirect emissions from the generation of purchased or acquired electricity, steam, heating, or cooling consumed.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtscope3objectrequired
Scope 3 emissions. All indirect emissions, not included in scope 2, that occur in the value chain.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtcomponentsobjectrequired
material_and_wasteobjectrequired
Emissions associated with buying equipment and generating waste.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtenergyobjectrequired
Emissions associated with purchasing energy (electricy, heating etc.)
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgttravel_and_commuteobjectrequired
Emissions associated with business travels and commuting to/from work.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtfood_and_drinkobjectrequired
Emissions associated with food and drinks.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgttechobjectrequired
Emissions associated with operating computer systems.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtremote_employeeobject
Emissions associated with remote employees (electricity, heating etc.)
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtErrors
This API operation can return the following errors:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_foundGet a company emission estimate
HTTPGET to /v1/estimates/company/{id}Query parameters
idstringrequired
The estimate's unique identifier
Response
massobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
An arbitrary dictionary (key-value pairs) to store application-specific information.
Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.
idempotency_keystring
Account-unique identifier provided by the client.
idempotency_key has two purposes:
- Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
- Clients can use
idempotency_keyto reconcile estimates with entities on their system.
idstringrequired
The emission calculation unique identifier
quoteoneOfrequiredError response
Error response
requestobjectrequired
Parameters for estimating emissions associated with operating a company.
All relevant values are yearly values.
monthsinteger
Number of months covered by the emission estimate
employeesintegerrequired
Number of employees
remote_employees_percentageintegerrequired
Share of employees working remotely (in percent)
office_areaobjectrequired
Office area in square meters
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
square_meterssquare_feetcountry_codestringrequired
The three-letter country code of the country where the company is located.
postcodestring
The company's postal code
citystring
electricity_consumptionintegerrequired
Electricity consumption in kWh
green_electricity_usedbooleanrequired
Is the electricity provided by renewable source(s)?
gas_consumptionintegerrequired
Yearly natural gas consumption in cubic meters
company_carsintegerrequired
Company cars
average_car_distance_travelledobjectrequired
Average yearly distance travelled per car
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, km for kilometers, mi for miles
kmminmemployees_using_public_transportintegerrequired
Number of employees commuting by public transport
short_flightsintegerrequired
Number of short (under 3 hours) flights per year
medium_flightsintegerrequired
Number of medium (between 3 and 6 hours) flights per year
long_flightsintegerrequired
Number of long (over 6 hours) flights per year
first_or_business_class_percentageintegerrequired
Share of business or first class flights, in percent
food_and_drinks_expensesobjectrequired
Amount spend on food and drinks
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGvegetarian_and_vegan_percentageintegerrequired
Share of vegetarians or vegans in the company, in percent
electronic_device_expensesobjectrequired
New electronic devices (laptops, monitors, etc.) expenses
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGgarbageintegerrequired
The amount of garbage produced, in kilograms
recycled_garbage_percentageintegerrequired
Share of recycled garbage, in percent
techobject
on_premiseobject
Company's own tech infrastructure details
electricity_costobjectrequired
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGcloudobject
Company's use of cloud services
costobjectrequired
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGproviderstringrequired
The identifier of a cloud provider.
awsgcpazureovhotherbundle_selectionarray
Bundle selection percentages.
The sum of all percentages must equal 100.
If not specified, the preconfigured allocation ratios are going to be used.
If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.
object
Maps a bundle id to an allocation ratio
bundle_idstringrequired
The bundle's unique identifier
percentageoneOfSelection percentage as integer
Selection percentage as integer
quantity_truncstring
Selects to which precision to truncate quantities specific to carbon offsetting.
gkgtnamestring
A name to reference this calculation.
metadataobject
An arbitrary dictionary (key-value pairs) to store application-specific information.
Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.
idempotency_keystring
Account-unique identifier provided by the client.
idempotency_key has two purposes:
- Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
- Clients can use
idempotency_keyto reconcile estimates with entities on their system.
scope1objectrequired
Scope 1 emissions. Direct emissions from owned or controlled sources.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtscope2objectrequired
Scope 2 emissions. Indirect emissions from the generation of purchased or acquired electricity, steam, heating, or cooling consumed.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtscope3objectrequired
Scope 3 emissions. All indirect emissions, not included in scope 2, that occur in the value chain.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtcomponentsobjectrequired
material_and_wasteobjectrequired
Emissions associated with buying equipment and generating waste.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtenergyobjectrequired
Emissions associated with purchasing energy (electricy, heating etc.)
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgttravel_and_commuteobjectrequired
Emissions associated with business travels and commuting to/from work.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtfood_and_drinkobjectrequired
Emissions associated with food and drinks.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgttechobjectrequired
Emissions associated with operating computer systems.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtremote_employeeobject
Emissions associated with remote employees (electricity, heating etc.)
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtErrors
This API operation can return the following errors:401404429503service_unavailableUpdate a company emissions estimate
HTTPPUT to /v1/estimates/company/{id}Query parameters
idstringrequired
The estimate's unique identifier
Request body
Parameters for estimating emissions associated with operating a company.
All relevant values are yearly values.
monthsinteger
Number of months covered by the emission estimate
employeesintegerrequired
Number of employees
remote_employees_percentageintegerrequired
Share of employees working remotely (in percent)
office_areaobjectrequired
Office area in square meters
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
square_meterssquare_feetcountry_codestringrequired
The three-letter country code of the country where the company is located.
postcodestring
The company's postal code
citystring
electricity_consumptionintegerrequired
Electricity consumption in kWh
green_electricity_usedbooleanrequired
Is the electricity provided by renewable source(s)?
gas_consumptionintegerrequired
Yearly natural gas consumption in cubic meters
company_carsintegerrequired
Company cars
average_car_distance_travelledobjectrequired
Average yearly distance travelled per car
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, km for kilometers, mi for miles
kmminmemployees_using_public_transportintegerrequired
Number of employees commuting by public transport
short_flightsintegerrequired
Number of short (under 3 hours) flights per year
medium_flightsintegerrequired
Number of medium (between 3 and 6 hours) flights per year
long_flightsintegerrequired
Number of long (over 6 hours) flights per year
first_or_business_class_percentageintegerrequired
Share of business or first class flights, in percent
food_and_drinks_expensesobjectrequired
Amount spend on food and drinks
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGvegetarian_and_vegan_percentageintegerrequired
Share of vegetarians or vegans in the company, in percent
electronic_device_expensesobjectrequired
New electronic devices (laptops, monitors, etc.) expenses
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGgarbageintegerrequired
The amount of garbage produced, in kilograms
recycled_garbage_percentageintegerrequired
Share of recycled garbage, in percent
techobject
on_premiseobject
Company's own tech infrastructure details
electricity_costobjectrequired
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGcloudobject
Company's use of cloud services
costobjectrequired
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGproviderstringrequired
The identifier of a cloud provider.
awsgcpazureovhotherbundle_selectionarray
Bundle selection percentages.
The sum of all percentages must equal 100.
If not specified, the preconfigured allocation ratios are going to be used.
If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.
object
Maps a bundle id to an allocation ratio
bundle_idstringrequired
The bundle's unique identifier
percentageoneOfSelection percentage as integer
Selection percentage as integer
quantity_truncstring
Selects to which precision to truncate quantities specific to carbon offsetting.
gkgtnamestring
A name to reference this calculation.
metadataobject
An arbitrary dictionary (key-value pairs) to store application-specific information.
Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.
idempotency_keystring
Account-unique identifier provided by the client.
idempotency_key has two purposes:
- Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
- Clients can use
idempotency_keyto reconcile estimates with entities on their system.
Response
massobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
An arbitrary dictionary (key-value pairs) to store application-specific information.
Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.
idempotency_keystring
Account-unique identifier provided by the client.
idempotency_key has two purposes:
- Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
- Clients can use
idempotency_keyto reconcile estimates with entities on their system.
idstringrequired
The emission calculation unique identifier
quoteoneOfrequiredError response
Error response
requestobjectrequired
Parameters for estimating emissions associated with operating a company.
All relevant values are yearly values.
monthsinteger
Number of months covered by the emission estimate
employeesintegerrequired
Number of employees
remote_employees_percentageintegerrequired
Share of employees working remotely (in percent)
office_areaobjectrequired
Office area in square meters
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
square_meterssquare_feetcountry_codestringrequired
The three-letter country code of the country where the company is located.
postcodestring
The company's postal code
citystring
electricity_consumptionintegerrequired
Electricity consumption in kWh
green_electricity_usedbooleanrequired
Is the electricity provided by renewable source(s)?
gas_consumptionintegerrequired
Yearly natural gas consumption in cubic meters
company_carsintegerrequired
Company cars
average_car_distance_travelledobjectrequired
Average yearly distance travelled per car
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, km for kilometers, mi for miles
kmminmemployees_using_public_transportintegerrequired
Number of employees commuting by public transport
short_flightsintegerrequired
Number of short (under 3 hours) flights per year
medium_flightsintegerrequired
Number of medium (between 3 and 6 hours) flights per year
long_flightsintegerrequired
Number of long (over 6 hours) flights per year
first_or_business_class_percentageintegerrequired
Share of business or first class flights, in percent
food_and_drinks_expensesobjectrequired
Amount spend on food and drinks
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGvegetarian_and_vegan_percentageintegerrequired
Share of vegetarians or vegans in the company, in percent
electronic_device_expensesobjectrequired
New electronic devices (laptops, monitors, etc.) expenses
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGgarbageintegerrequired
The amount of garbage produced, in kilograms
recycled_garbage_percentageintegerrequired
Share of recycled garbage, in percent
techobject
on_premiseobject
Company's own tech infrastructure details
electricity_costobjectrequired
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGcloudobject
Company's use of cloud services
costobjectrequired
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystringrequired
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AEDAFNALLAMDANGproviderstringrequired
The identifier of a cloud provider.
awsgcpazureovhotherbundle_selectionarray
Bundle selection percentages.
The sum of all percentages must equal 100.
If not specified, the preconfigured allocation ratios are going to be used.
If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.
object
Maps a bundle id to an allocation ratio
bundle_idstringrequired
The bundle's unique identifier
percentageoneOfSelection percentage as integer
Selection percentage as integer
quantity_truncstring
Selects to which precision to truncate quantities specific to carbon offsetting.
gkgtnamestring
A name to reference this calculation.
metadataobject
An arbitrary dictionary (key-value pairs) to store application-specific information.
Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.
idempotency_keystring
Account-unique identifier provided by the client.
idempotency_key has two purposes:
- Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
- Clients can use
idempotency_keyto reconcile estimates with entities on their system.
scope1objectrequired
Scope 1 emissions. Direct emissions from owned or controlled sources.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtscope2objectrequired
Scope 2 emissions. Indirect emissions from the generation of purchased or acquired electricity, steam, heating, or cooling consumed.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtscope3objectrequired
Scope 3 emissions. All indirect emissions, not included in scope 2, that occur in the value chain.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtcomponentsobjectrequired
material_and_wasteobjectrequired
Emissions associated with buying equipment and generating waste.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtenergyobjectrequired
Emissions associated with purchasing energy (electricy, heating etc.)
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgttravel_and_commuteobjectrequired
Emissions associated with business travels and commuting to/from work.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtfood_and_drinkobjectrequired
Emissions associated with food and drinks.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgttechobjectrequired
Emissions associated with operating computer systems.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtremote_employeeobject
Emissions associated with remote employees (electricity, heating etc.)
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtErrors
This API operation can return the following errors:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_found