Retrieve monthly emissions summaries by business entity

get

https://api.sinai.com/v1/carbon_accounting/summaries/monthly_business_entity_emissions_summaries

Use this endpoint to retrieve emissions summaries by emissions source

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

fiscal_year

string

^\d{4}$

Filter by a specific fiscal year, using the organization's fiscal start month setting

calendar_year

string

^\d{4}$

Filter by a specific calendar year

month

string

^\d{4}-\d{2}$

Filter by a specific month in YYYY-MM format

from_month

string

^\d{4}-\d{2}$

Filter starting at a specific month, inclusive. Can optionally use with to_month.

to_month

string

^\d{4}-\d{2}$

Filter up to a specific month, inclusive. Can optionally use with from_month.

business_entity_ids

array of objects

A list of business entity UUIDs to filter against, returning summaries for the specificed business entities

business_entity_ids

parent_business_entity_id

uuid

A business entity UUIDs to filter against, returning summaries for business entities one level below the given parent

business_entity_type_id

uuid

A business entity type to filter against, returning summaries for business entities of this type

Responses

200Monthly emissions source summaries retrieved successfully.