Company

Create a company emission estimate

HTTP POST 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_meters

square_feet

country_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

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

employees_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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

vegetarian_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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

garbageintegerrequired

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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

cloudobject

Company's use of cloud services

costobjectrequired

valuestringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

providerstringrequired

The identifier of a cloud provider.

aws

gcp

azure

ovh

other

bundle_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

percentageoneOf

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

namestring

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_key to reconcile estimates with entities on their system.

Sample request

Response

massobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

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_key to reconcile estimates with entities on their system.

idstringrequired

The emission calculation unique identifier

quoteoneOfrequired

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_meters

square_feet

country_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

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

employees_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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

vegetarian_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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

garbageintegerrequired

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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

cloudobject

Company's use of cloud services

costobjectrequired

valuestringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

providerstringrequired

The identifier of a cloud provider.

aws

gcp

azure

ovh

other

bundle_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

percentageoneOf

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

namestring

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_key to reconcile estimates with entities on their system.

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

Sample response

Errors

This API operation can return the following errors:

HTTP status codeError code

400

api_version_invalid

400

bundle_selection_ratios_invalid

400

bundle_selection_bundle_invalid

400

order_value_invalid

400

bundle_id_invalid

400

id_invalid

400

distance_invalid

400

test_account_name_update_disallowed

400

bundle_selection_ratios_invalid_format

400

address_not_found

Get a company emission estimate

HTTP GET to /v1/estimates/company/{id}

Query parameters

idstringrequired

The estimate's unique identifier

Sample request

Response

massobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

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_key to reconcile estimates with entities on their system.

idstringrequired

The emission calculation unique identifier

quoteoneOfrequired

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_meters

square_feet

country_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

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

employees_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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

vegetarian_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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

garbageintegerrequired

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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

cloudobject

Company's use of cloud services

costobjectrequired

valuestringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

providerstringrequired

The identifier of a cloud provider.

aws

gcp

azure

ovh

other

bundle_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

percentageoneOf

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

namestring

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_key to reconcile estimates with entities on their system.

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

Sample response

Errors

This API operation can return the following errors:

HTTP status codeError code

401

404

429

503

service_unavailable

Update a company emissions estimate

HTTP PUT 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_meters

square_feet

country_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

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

employees_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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

vegetarian_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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

garbageintegerrequired

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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

cloudobject

Company's use of cloud services

costobjectrequired

valuestringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

providerstringrequired

The identifier of a cloud provider.

aws

gcp

azure

ovh

other

bundle_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

percentageoneOf

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

namestring

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_key to reconcile estimates with entities on their system.

Sample request

Response

massobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

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_key to reconcile estimates with entities on their system.

idstringrequired

The emission calculation unique identifier

quoteoneOfrequired

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_meters

square_feet

country_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

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

employees_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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

vegetarian_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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

garbageintegerrequired

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]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

cloudobject

Company's use of cloud services

costobjectrequired

valuestringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

Specify the monetary value in the currency defined by the currency_code property in the request. If no currency_code is provided, the currency will default to that of the associated account.

currencystringrequired

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED

AFN

ALL

AMD

ANG

providerstringrequired

The identifier of a cloud provider.

aws

gcp

azure

ovh

other

bundle_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

percentageoneOf

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

namestring

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_key to reconcile estimates with entities on their system.

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

Sample response

Errors

This API operation can return the following errors:

HTTP status codeError code

400

api_version_invalid

400

bundle_selection_ratios_invalid

400

bundle_selection_bundle_invalid

400

order_value_invalid

400

bundle_id_invalid

400

id_invalid

400

distance_invalid

400

test_account_name_update_disallowed

400

bundle_selection_ratios_invalid_format

400

address_not_found

Company

Create a company emission estimate

Request body

employeesinteger.css-dt1608{margin:0;font-family:Helvetica Neue,Arial,sans-serif;font-size:14px;font-style:normal;font-weight:400;line-height:17px;letter-spacing:0;text-align:left;color:#212121;color:#F44336;margin-right:4px;}required

remote_employees_percentageintegerrequired

office_areaobjectrequired

amountstringrequired

unitstringrequired

country_codestringrequired

postcodestring

electricity_consumptionintegerrequired

green_electricity_usedbooleanrequired

gas_consumptionintegerrequired

company_carsintegerrequired

average_car_distance_travelledobjectrequired

amountstringrequired

unitstringrequired

employees_using_public_transportintegerrequired

short_flightsintegerrequired

medium_flightsintegerrequired

long_flightsintegerrequired

first_or_business_class_percentageintegerrequired

food_and_drinks_expensesobjectrequired

valuestringrequired

currencystringrequired

vegetarian_and_vegan_percentageintegerrequired

electronic_device_expensesobjectrequired

valuestringrequired

currencystringrequired

garbageintegerrequired

recycled_garbage_percentageintegerrequired

techobject

on_premiseobject

electricity_costobjectrequired

valuestringrequired

currencystringrequired

cloudobject

costobjectrequired

valuestringrequired

currencystringrequired

providerstringrequired

bundle_selectionarray

object

bundle_idstringrequired

quantity_truncstring

namestring

metadataobject

idempotency_keystring

Response

massobjectrequired

amountstringrequired

unitstringrequired

metadataobject

idempotency_keystring

idstringrequired

requestobjectrequired

monthsinteger

employeesintegerrequired

remote_employees_percentageintegerrequired

office_areaobjectrequired

amountstringrequired

unitstringrequired

country_codestringrequired

postcodestring

citystring

electricity_consumptionintegerrequired

green_electricity_usedbooleanrequired

gas_consumptionintegerrequired

company_carsintegerrequired

average_car_distance_travelledobjectrequired

amountstringrequired

unitstringrequired

employees_using_public_transportintegerrequired

short_flightsintegerrequired

medium_flightsintegerrequired

long_flightsintegerrequired

first_or_business_class_percentageintegerrequired

food_and_drinks_expensesobjectrequired

valuestringrequired

currencystringrequired

employeesintegerrequired

percentageoneOf