Skip to main content

Create or Update a Consumption

Creates a new consumption or updates an existing one.

On update, only the provided attributes will be modified.

Request Body REQUIRED
sources object[] REQUIRED
uuid string

The unique identifier of the comsumption, only required in update response

national_registry_number string REQUIRED

The National Registry Number of the company associated with the consumption

month integer REQUIRED

A number between 1 and 12 representing the month of the consumption

year integer REQUIRED

A number representing the year of the consumption

category string REQUIRED

Possible values: [ENERGY, MOBILE_COMBUSTION, STATIONARY_COMBUSTION]

The GHG protocol category related with the consumption

fuel string

Possible values: [ACETYLENE, TAR, ASPHALTS, SUGARCANE_BAGASSE, BIODIESEL_B100, BIOGAS, SUGARCANE_JUICE, IMPORTED_METALLURGICAL_COAL, NATIONAL_METALLURGICAL_COAL, STEAM_COAL_3100_KCAL_KG, STEAM_COAL_3300_KCAL_KG, STEAM_COAL_3700_KCAL_KG, STEAM_COAL_4200_KCAL_KG, STEAM_COAL_4500_KCAL_KG, STEAM_COAL_4700_KCAL_KG, STEAM_COAL_5200_KCAL_KG, STEAM_COAL_5900_KCAL_KG, STEAM_COAL_6000_KCAL_KG, UNSPECIFIED_STEAM_COAL, CHARCOAL, MINERAL_COAL_COKE, PETROLEUM_COKE, ETHANE, ETHANOL, COKE_OVEN_GAS, REFINERY_GAS, LPG, DRY_NATURAL_GAS, WET_NATURAL_GAS, COMMERCIAL_AUTOMOTIVE_GASOLINE, PURE_AUTOMOTIVE_GASOLINE, AVIATION_GASOLINE, FIREWOOD_FOR_CHARCOAL, COMMERCIAL_FIREWOOD, BLACK_LIQUOR, NGL, LUBRICANTS, MOLASSES, NAPHTHA, FUEL_OIL, SHALE_OIL, COMMERCIAL_DIESEL_OIL, PURE_DIESEL_OIL, RESIDUAL_OILS, OTHER_PETROLEUM_PRODUCTS, PARAFFIN_WAX, CRUDE_OIL, AVIATION_KEROSENE, ILLUMINATING_KEROSENE, INDUSTRIAL_WASTE, MUNICIPAL_WASTE_BIOMASS_FRACTION, MUNICIPAL_WASTE_NON_BIOMASS_FRACTION, VEGETABLE_RESIDUES, SOLVENTS, PEAT, OIL_SHALE_AND_TAR_SANDS, CNG, COAL, PURE_MARINE_DIESEL_OIL, OTHER_BIOGAS, LANDFILL_GAS, BIOMETHANE, LNG, METHANOL, BIOKEROSENE_SAF, HVO_GREEN_DIESEL, BIOMETHANOL]

The fuel related with the consumption (only to MOBILE_COMBUSTION and STATIONARY_COMBUSTION categories)

source_description string

The description of the source of the consumption

quantity number REQUIRED

The quantity of the consumption

unit_measure string REQUIRED

Possible values: [T, KG, MG, L, M3, KWH, MWH]

The unit of measure related with the consumption

Responses
200

200 response

Schema OPTIONAL
id string OPTIONAL

The unique identifier of the integration

path string OPTIONAL

The path of the integration

message string OPTIONAL

A message describing the integration

status string OPTIONAL

Possible values: [CREATED, PROCESSING, COMPLETED, FAILED, ARCHIVED]

The status of the integration

request_details object OPTIONAL

Details of the request made to the integration

path string OPTIONAL

The original request's path

http_method string OPTIONAL

The original request's HTTP method

body string OPTIONAL

The original request's body content

query_params string OPTIONAL

The original request's query param content

response OPTIONAL

Contains the result of the process, each request type has it's own result format.