Create emission estimate(s) via receipt or invoice data.
HTTPPOST
to /v1/estimates/transaction-documents
Request body
unstructured_dataobjectrequired
Data to be used to create the appropriate emission estimate.
key_valueobject
An arbitrary dictionary (key-value pairs).
Lune attempts to extract valuable information from here.
namestring
A name to reference this calculation.
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
percentageoneOfSelection percentage as integer
Selection percentage as integer
quantity_truncstring
Selects to which precision to truncate quantities specific to carbon offsetting.
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.
valuestring
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystring
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AED
AFN
ALL
AMD
ANG
merchantoneOfMerchant category code
Merchant category code
Merchant from whom the goods or services the purchase was made
dietstring
Individual diet. Used to better estimate food-related purchases.
high_meat_eater
medium_meat_eater
low_meat_eater
fish_eater
vegetarian
region_fallbackstring
Controls how geographical constraints are interpreted and if a fallback is performed.
For example, how fields like country_code
and region
are interpreted.
never
(the default) means no fallback is performed and only emission factors that match the specified geographical area are returned.always
means the emission factors for related geographic areas are unconditionally included in the results.
never
always
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
quoteoneOfrequiredError response
Error response
requestobjectrequired
unstructured_dataobjectrequired
Data to be used to create the appropriate emission estimate.
key_valueobject
An arbitrary dictionary (key-value pairs).
Lune attempts to extract valuable information from here.
namestring
A name to reference this calculation.
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
percentageoneOfSelection percentage as integer
Selection percentage as integer
quantity_truncstring
Selects to which precision to truncate quantities specific to carbon offsetting.
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.
valuestring
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystring
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AED
AFN
ALL
AMD
ANG
merchantoneOfMerchant category code
Merchant category code
Merchant from whom the goods or services the purchase was made
dietstring
Individual diet. Used to better estimate food-related purchases.
high_meat_eater
medium_meat_eater
low_meat_eater
fish_eater
vegetarian
region_fallbackstring
Controls how geographical constraints are interpreted and if a fallback is performed.
For example, how fields like country_code
and region
are interpreted.
never
(the default) means no fallback is performed and only emission factors that match the specified geographical area are returned.always
means the emission factors for related geographic areas are unconditionally included in the results.
never
always
line_itemsarrayrequired
Line items for the transaction document estimate. At least one line item will always exist.
object
Transaction document line item estimate.
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
typestringrequired
Identifies the type of the line item emission estimate. New values are expected to be introduced over time and considered to be a non breaking change.
transaction
oneOfLine item
Line item
Errors
This API operation can return the following errors: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 transaction document emission estimate
HTTPGET
to /v1/estimates/transaction-documents/{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
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
quoteoneOfrequiredError response
Error response
requestobjectrequired
unstructured_dataobjectrequired
Data to be used to create the appropriate emission estimate.
key_valueobject
An arbitrary dictionary (key-value pairs).
Lune attempts to extract valuable information from here.
namestring
A name to reference this calculation.
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
percentageoneOfSelection percentage as integer
Selection percentage as integer
quantity_truncstring
Selects to which precision to truncate quantities specific to carbon offsetting.
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.
valuestring
Pattern: ^[0-9]+(\.[0-9]+)?$
An amount of money (the fractional part is optional)
currencystring
ISO 4217 3 character currency code.
Note: Lune supports most but not all currency codes.
AED
AFN
ALL
AMD
ANG
merchantoneOfMerchant category code
Merchant category code
Merchant from whom the goods or services the purchase was made
dietstring
Individual diet. Used to better estimate food-related purchases.
high_meat_eater
medium_meat_eater
low_meat_eater
fish_eater
vegetarian
region_fallbackstring
Controls how geographical constraints are interpreted and if a fallback is performed.
For example, how fields like country_code
and region
are interpreted.
never
(the default) means no fallback is performed and only emission factors that match the specified geographical area are returned.always
means the emission factors for related geographic areas are unconditionally included in the results.
never
always
line_itemsarrayrequired
Line items for the transaction document estimate. At least one line item will always exist.
object
Transaction document line item estimate.
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
typestringrequired
Identifies the type of the line item emission estimate. New values are expected to be introduced over time and considered to be a non breaking change.
transaction
oneOfLine item
Line item
Errors
This API operation can return the following errors:401
404
429
503
service_unavailable