Skip to main content
PATCH
/
usage
/
{usage_data_id}
Update Usage Data
curl --request PATCH \
  --url https://external.nectarclimate.com/v2.1/usage/{usage_data_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "startDate": "2023-12-25",
  "endDate": "2023-12-25",
  "usage": 123,
  "usageUnits": "J",
  "isEstimated": true,
  "isImplied": true,
  "tariff": "<string>",
  "supplierName": "<string>"
}
'
{
  "id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "startDate": "2023-12-25",
  "endDate": "2023-12-25",
  "isEstimated": true,
  "netMeteringGeneratedKwh": "<string>",
  "netMeteringGridImportKwh": "<string>",
  "exclusion": true,
  "usage": "<string>",
  "usageUnits": "J",
  "meter": "<string>",
  "meterAddress": "<string>",
  "site": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "dataCollectionStopDate": "2023-12-25",
    "externalId": "<string>",
    "address": "<string>",
    "path": [
      "<string>"
    ],
    "occupancyPercent": "<string>"
  },
  "identifiers": [
    {
      "rawName": "<string>",
      "value": "<string>",
      "name": "<string>"
    }
  ],
  "datasourceType": "ELECTRICITY",
  "timeOfUse": "PEAK",
  "electricityType": "USAGE",
  "netMeteringType": "EXPORT",
  "waterType": "POTABLE_WATER",
  "meterHighLow": "HIGH",
  "gasType": "NATURAL_GAS",
  "fuelType": "ANTHRACITE_COAL",
  "districtType": "HEATING",
  "districtMediumType": "HOT_WATER",
  "wasteDescription": "<string>",
  "wasteType": "<string>",
  "wasteStream": "<string>",
  "refrigerantType": "R11",
  "meterIsTracked": true,
  "additionalFields": {},
  "document": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "auditTrailUrl": "<string>",
    "url": "<string>",
    "billDate": "2023-12-25",
    "chargesUnits": "USD",
    "utilityCompany": "<string>",
    "status": "<string>",
    "flaggedStatus": "<string>",
    "revisedDocumentId": "<string>",
    "updated": "2023-11-07T05:31:56Z",
    "fileName": "<string>",
    "email": "[email protected]",
    "jobId": "<string>",
    "notes": "<string>",
    "dueDate": "2023-12-25",
    "totalCharges": "<string>",
    "sourceType": "INVOICE",
    "isFlagged": true
  },
  "isImplied": true,
  "currentReading": "<string>",
  "previousReading": "<string>",
  "multiplier": "<string>",
  "multiplierDescription": "<string>",
  "multiplier2": "<string>",
  "multiplier2Description": "<string>",
  "fractionRenewable": "<string>",
  "netMeteringGridExportKwh": "<string>",
  "tariff": "<string>",
  "billedDemand": "<string>",
  "supplierName": "<string>",
  "utilityName": "<string>",
  "country": "<string>",
  "serviceAddress": "<string>",
  "apparentUsage": "<string>",
  "apparentUsageUnits": "kVAh",
  "reactiveUsage": "<string>",
  "reactiveUsageUnits": "kVArh",
  "powerFactor": "<string>",
  "timeOfUseBreakdown": [
    {
      "timeOfUse": "PEAK",
      "usage": "<string>",
      "usageUnits": "Wh",
      "description": "<string>",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
usage_data_id
string<uuid>
required

ID of the usage data entry to update.

Body

Request body for updating a usage data entry.

​
startDate
string<date>

Start date for the meter site usage data entry.

​
endDate
string<date>

End date for the meter site usage data entry. If not available or not applicable, this is set to the start date by default.

​
usage
number<double>
​
usageUnits
enum<string>
  • J - J
  • Btu - Btu
  • MMBtu - Mmbtu
  • kJ - Kj
  • MJ - Mj
  • GJ - Gj
  • TJ - Tj
  • thm (EC) - Therm Ec
  • thm (US) - Therm Us
  • thm (UK) - Therm Uk
  • Dth (EC) - Dth Ec
  • Dth (US) - Dth Us
  • Dth (UK) - Dth Uk
  • Cal - Cal
  • kCal - Kcal
  • MCal - Mcal
  • erg - Erg
  • kVA - Kva
  • Wh - WH
  • kWh - KWH
  • MWh - MWH
  • GWh - GWH
  • ton hours - Ton Hours
  • W - W
  • KW - Kw
  • MW - Mw
  • GW - Gw
  • L - L
  • kL - Kl
  • ML - Ml
  • cubic ft - Cubic Ft
  • cubic yd - Cubic Yd
  • cubic m - Cubic M
  • MMCF - Mmcf
  • MCF - Mcf
  • HCF - Hcf
  • CF - Cf
  • CCF - Ccf
  • gal (UK) - Gal Uk
  • gal (US) - Gal Us
  • 100 gal (US) - Hundred Gal Us
  • 100 gal (UK) - Hundred Gal Uk
  • kgal (US) - Kgal Us
  • kgal (UK) - Kgal Uk
  • Mgal (US) - Million Gal Us
  • Mgal (UK) - Million Gal Uk
  • teu - Teu
  • bbl - Bbl
  • mbbl - Mbbl
  • kg - Kg
  • oz t - Oz T
  • g - G
  • lb - Lb
  • mlb - Mlb
  • tons (US) - Tons
  • sh ton - Sh Ton
  • metric ton - Metric Ton
  • tonne - Tonne
  • long tn - Long Tn
  • km - Km
  • mi - Mi
  • m - M
  • cm - Cm
  • mm - Mm
  • nm - Nm
  • yd - Yd
  • ft - Ft
  • in - In
Available options:
J,
Btu,
MMBtu,
kJ,
MJ,
GJ,
TJ,
thm (EC),
thm (US),
thm (UK),
Dth (EC),
Dth (US),
Dth (UK),
Cal,
kCal,
MCal,
erg,
kVA,
Wh,
kWh,
MWh,
GWh,
ton hours,
W,
KW,
MW,
GW,
L,
kL,
ML,
cubic ft,
cubic yd,
cubic m,
MMCF,
MCF,
HCF,
CF,
CCF,
gal (UK),
gal (US),
100 gal (US),
100 gal (UK),
kgal (US),
kgal (UK),
Mgal (US),
Mgal (UK),
teu,
bbl,
mbbl,
kg,
oz t,
g,
lb,
mlb,
tons (US),
sh ton,
metric ton,
tonne,
long tn,
km,
mi,
m,
cm,
mm,
nm,
yd,
ft,
in
​
isEstimated
boolean

Indicates if the usage data is estimated by the utility company.

​
isImplied
boolean

Indicates if the usage data is implied by the tenant usage and the raw usage. For more information on how this differs from estimation, see the Nectar methodology.

​
tariff
string | null

[ELECTRICITY, GAS, WATER, DISTRICT] Tariff code or description associated with the usage.

​
supplierName
string | null

[ELECTRICITY, GAS] Name of the supplier. Only applies to electricity and gas meters.

Response

Serializer for usage data with document.

​
id
string
required

Id of the usage data.

​
created
string<date-time>
required

Timestamp when the usage data was created.

​
updated
string<date-time>
required

Timestamp when the usage data was last updated.

​
startDate
string<date>
required

Date when the usage data starts.

​
endDate
string<date>
required

Date when the usage data ends.

​
isEstimated
boolean
required

Whether the usage data is estimated.

​
netMeteringGeneratedKwh
string<decimal> | null
required

Deprecated. Always returns null.

Pattern: ^-?\d{0,10}(?:\.\d{0,10})?$
​
netMeteringGridImportKwh
string<decimal> | null
required

Deprecated. Always returns null.

Pattern: ^-?\d{0,10}(?:\.\d{0,10})?$
​
exclusion
boolean
required

Deprecated. Always returns false.

​
usage
string
required

Usage amount extracted from billing data. For solar data, this is the kWh produced.

​
usageUnits
enum<string>
required

Units for usage, as specified in the document

Available options:
J,
Btu,
MMBtu,
kJ,
MJ,
GJ,
TJ,
thm (EC),
thm (US),
thm (UK),
Dth (EC),
Dth (US),
Dth (UK),
Cal,
kCal,
MCal,
erg,
kVA,
Wh,
kWh,
MWh,
GWh,
ton hours,
W,
KW,
MW,
GW,
L,
kL,
ML,
cubic ft,
cubic yd,
cubic m,
MMCF,
MCF,
HCF,
CF,
CCF,
gal (UK),
gal (US),
100 gal (US),
100 gal (UK),
kgal (US),
kgal (UK),
Mgal (US),
Mgal (UK),
teu,
bbl,
mbbl,
kg,
oz t,
g,
lb,
mlb,
tons (US),
sh ton,
metric ton,
tonne,
long tn,
km,
mi,
m,
cm,
mm,
nm,
yd,
ft,
in,
kW,
kVAR
​
meter
string | null
required

Id of the matching meter associated with the usage data. For uploaded documents, field may be empty if no matching meter is found.

​
meterAddress
string | null
required

Address of the service location associated with the demand usage data.

​
site
object
required

Site matched with the usage data.

​
identifiers
object[]
required

Identifiers associated with the meter.

​
datasourceType
enum<string>
required

Type of data source (utility) for the usage data entry.

  • ELECTRICITY - Electricity
  • GAS - Gas
  • WATER - Water
  • DISTRICT - District
  • WASTE - Waste
  • FUEL - Fuel
  • MISC - Misc
  • REFRIGERANT - Refrigerant
  • SOLAR - Solar
  • TELECOM - Telecom
Available options:
ELECTRICITY,
GAS,
WATER,
DISTRICT,
WASTE,
FUEL,
MISC,
REFRIGERANT,
SOLAR,
TELECOM
​
timeOfUse
enum<string> | null
required

[ELECTRICITY] Time of use associated with the electricity usage data entry, e.g. daytime, nighttime, peak, off-peak, etc.

  • PEAK - Peak
  • OFF_PEAK - Off Peak
  • SHOULDER_MIDPEAK - Shoulder Midpeak
  • NIGHT_TIME - Night Time
  • DAY_TIME - Day Time
  • SUPER_OFF_PEAK - Super Off Peak
  • CRITICAL_PEAK - Critical Peak
  • WEEKDAY - Weekday
  • WEEKEND - Weekend
  • OTHER - Other
Available options:
PEAK,
OFF_PEAK,
SHOULDER_MIDPEAK,
NIGHT_TIME,
DAY_TIME,
SUPER_OFF_PEAK,
CRITICAL_PEAK,
WEEKDAY,
WEEKEND,
OTHER
​
electricityType
enum<string> | null
required

[ELECTRICITY] Type of electricity used.

  • USAGE - Usage
  • DEMAND - Demand
Available options:
USAGE,
DEMAND
​
netMeteringType
enum<string> | null
required

[ELECTRICITY] Indicates whether the meter is tracking electricity imports from the grid, exports to the grid, or onsite generation.

  • EXPORT - Export
  • IMPORT - Import
  • GENERATION - Generation
Available options:
EXPORT,
IMPORT,
GENERATION
​
waterType
enum<string> | null
required

[WATER] Type of water used.

  • POTABLE_WATER - Potable Water
  • WELL_WATER - Well Water
  • MUNICIPAL_WATER - Municipal Water
  • WASTE_WATER - Waste Water
Available options:
POTABLE_WATER,
WELL_WATER,
MUNICIPAL_WATER,
WASTE_WATER
​
meterHighLow
enum<string> | null
required

[WATER] Indicates if the meter type is 'HIGH' or 'LOW'.

  • HIGH - High
  • LOW - Low
Available options:
HIGH,
LOW
​
gasType
enum<string> | null
required

[GAS] Type of gas used.

  • NATURAL_GAS - Natural Gas
Available options:
NATURAL_GAS
​
fuelType
enum<string> | null
required

[FUEL] Type of fuel used, with predefined choices.

  • ANTHRACITE_COAL - Anthracite Coal
  • BITUMINOUS_COAL - Bituminous Coal
  • SUB_BITUMINOUS_COAL - Sub Bituminous Coal
  • LIGNITE_COAL - Lignite Coal
  • MIXED_COMMERCIAL_SECTOR - Mixed Commercial Sector
  • MIXED_ELECTRIC_POWER_SECTOR - Mixed Electric Power Sector
  • MIXED_INDUSTRIAL_COKING - Mixed Industrial Coking
  • MIXED_INDUSTRIAL_SECTOR - Mixed Industrial Sector
  • COAL_COKE - Coal Coke
  • MUNICIPAL_SOLID_WASTE - Municipal Solid Waste
  • PETROLEUM_COKE_SOLID - Petroleum Coke Solid
  • PLASTICS - Plastics
  • TIRES - Tires
  • AGRICULTURAL_BYPRODUCTS - Agricultural Byproducts
  • PEAT - Peat
  • SOLID_BYPRODUCTS - Solid Byproducts
  • WOOD_AND_WOOD_RESIDUALS - Wood And Wood Residuals
  • NATURAL_GAS - Natural Gas
  • BLAST_FURNACE_GAS - Blast Furnace Gas
  • COKE_OVEN_GAS - Coke Oven Gas
  • FUEL_GAS - Fuel Gas
  • PROPANE_GAS - Propane Gas
  • LANDFILL_GAS - Landfill Gas
  • OTHER_BIOMASS_GASES - Other Biomass Gases
  • ASPHALT_AND_ROAD_OIL - Asphalt And Road Oil
  • BUTANE - Butane
  • BUTYLENE - Butylene
  • CRUDE_OIL - Crude Oil
  • DISTILLATE_FUEL_OIL_NO_1 - Distillate Fuel Oil No 1
  • DISTILLATE_FUEL_OIL_NO_2 - Distillate Fuel Oil No 2
  • DISTILLATE_FUEL_OIL_NO_4 - Distillate Fuel Oil No 4
  • ETHANE - Ethane
  • ETHYLENE - Ethylene
  • HEAVY_GAS_OILS - Heavy Gas Oils
  • ISOBUTANE - Isobutane
  • ISOBUTYLENE - Isobutylene
  • KEROSENE - Kerosene
  • LIQUEFIED_PETROLEUM_GASES_LPG - Liquefied Petroleum Gases Lpg
  • COMPRESSED_NATURAL_GAS_CNG - Compressed Natural Gas Cng
  • LUBRICANTS - Lubricants
  • MOTOR_GASOLINE - Motor Gasoline
  • NAPHTHA_LESS_THAN_401_DEG_F - Naphtha Less Than 401 Deg F
  • NATURAL_GASOLINE - Natural Gasoline
  • OTHER_OIL_MORE_THAN_401_DEG_F - Other Oil More Than 401 Deg F
  • PENTANES_PLUS - Pentanes Plus
  • PETROCHEMICAL_FEEDSTOCKS - Petrochemical Feedstocks
  • PROPYLENE - Propylene
  • RESIDUAL_FUEL_OIL_NO_5 - Residual Fuel Oil No 5
  • RESIDUAL_FUEL_OIL_NO_6 - Residual Fuel Oil No 6
  • SPECIAL_NAPHTHA - Special Naphtha
  • UNFINISHED_OILS - Unfinished Oils
  • USED_OIL - Used Oil
  • BIODIESEL_100_PERCENT - Biodiesel 100 Percent
  • BIODIESEL_BLEND - Biodiesel Blend
  • ETHANOL_BLENDED_GASOLINE - Ethanol Blended Gasoline
  • ETHANOL_100_PERCENT - Ethanol 100 Percent
  • RENDERED_ANIMAL_FAT - Rendered Animal Fat
  • VEGETABLE_OIL - Vegetable Oil
  • NORTH_AMERICAN_SOFTWOOD - North American Softwood
  • NORTH_AMERICAN_HARDWOOD - North American Hardwood
  • BAGASSE - Bagasse
  • BAMBOO - Bamboo
  • STRAW - Straw
Available options:
ANTHRACITE_COAL,
BITUMINOUS_COAL,
SUB_BITUMINOUS_COAL,
LIGNITE_COAL,
MIXED_COMMERCIAL_SECTOR,
MIXED_ELECTRIC_POWER_SECTOR,
MIXED_INDUSTRIAL_COKING,
MIXED_INDUSTRIAL_SECTOR,
COAL_COKE,
MUNICIPAL_SOLID_WASTE,
PETROLEUM_COKE_SOLID,
PLASTICS,
TIRES,
AGRICULTURAL_BYPRODUCTS,
PEAT,
SOLID_BYPRODUCTS,
WOOD_AND_WOOD_RESIDUALS,
NATURAL_GAS,
BLAST_FURNACE_GAS,
COKE_OVEN_GAS,
FUEL_GAS,
PROPANE_GAS,
LANDFILL_GAS,
OTHER_BIOMASS_GASES,
ASPHALT_AND_ROAD_OIL,
BUTANE,
BUTYLENE,
CRUDE_OIL,
DISTILLATE_FUEL_OIL_NO_1,
DISTILLATE_FUEL_OIL_NO_2,
DISTILLATE_FUEL_OIL_NO_4,
ETHANE,
ETHYLENE,
HEAVY_GAS_OILS,
ISOBUTANE,
ISOBUTYLENE,
KEROSENE,
LIQUEFIED_PETROLEUM_GASES_LPG,
COMPRESSED_NATURAL_GAS_CNG,
LUBRICANTS,
MOTOR_GASOLINE,
NAPHTHA_LESS_THAN_401_DEG_F,
NATURAL_GASOLINE,
OTHER_OIL_MORE_THAN_401_DEG_F,
PENTANES_PLUS,
PETROCHEMICAL_FEEDSTOCKS,
PROPYLENE,
RESIDUAL_FUEL_OIL_NO_5,
RESIDUAL_FUEL_OIL_NO_6,
SPECIAL_NAPHTHA,
UNFINISHED_OILS,
USED_OIL,
BIODIESEL_100_PERCENT,
BIODIESEL_BLEND,
ETHANOL_BLENDED_GASOLINE,
ETHANOL_100_PERCENT,
RENDERED_ANIMAL_FAT,
VEGETABLE_OIL,
NORTH_AMERICAN_SOFTWOOD,
NORTH_AMERICAN_HARDWOOD,
BAGASSE,
BAMBOO,
STRAW
​
districtType
enum<string> | null
required

[DISTRICT] Type of district used, either HEATING or COOLING.

  • HEATING - Heating
  • COOLING - Cooling
Available options:
HEATING,
COOLING
​
districtMediumType
enum<string> | null
required

[DISTRICT] Type of heating or cooling medium used, e.g. STEAM, HOT_WATER, etc.

  • HOT_WATER - Hot Water
  • STEAM - Steam
  • HOT_OIL - Hot Oil
  • CHILLED_WATER - Chilled Water
Available options:
HOT_WATER,
STEAM,
HOT_OIL,
CHILLED_WATER
​
wasteDescription
string
required

[WASTE] Description of the waste line item. E.g. OCC, Plastic bottles, etc.

​
wasteType
string
required

[WASTE] Type of waste, e.g. OCC, Plastic bottles, etc. The waste type config can be configured on the Nectar platform.

​
wasteStream
string
required

[WASTE] Stream of waste, e.g. OCC, Plastic bottles, etc. The waste stream config can be configured on the Nectar platform.

​
refrigerantType
enum<string> | null
required

[REFRIGERANT] Type of refrigerant used.

  • R11 - R11
  • R12 - R12
  • R22 - R22
  • R123 - R123
  • R124 - R124
  • R134A - R134A
  • R401A - R401A
  • R401B - R401B
  • R402A - R402A
  • R402B - R402B
  • R403A - R403A
  • R403B - R403B
  • R404A - R404A
  • R405A - R405A
  • R406A - R406A
  • R407A - R407A
  • R407B - R407B
  • R407C - R407C
  • R407D - R407D
  • R407F - R407F
  • R408A - R408A
  • R409A - R409A
  • R409B - R409B
  • R410A - R410A
  • R410B - R410B
  • R411A - R411A
  • R411B - R411B
  • R412A - R412A
  • R413A - R413A
  • R413B - R413B
  • R414A - R414A
  • R414B - R414B
  • R415A - R415A
  • R415B - R415B
  • R416A - R416A
  • R417A - R417A
  • R417B - R417B
  • R417C - R417C
  • R418A - R418A
  • R419A - R419A
  • R419B - R419B
  • R420A - R420A
  • R420B - R420B
  • R421A - R421A
  • R421B - R421B
  • R421C - R421C
  • R422A - R422A
  • R422B - R422B
  • R422C - R422C
  • R422D - R422D
  • R422E - R422E
  • R423A - R423A
  • R423B - R423B
  • R424A - R424A
  • R424B - R424B
  • R425A - R425A
  • R426A - R426A
  • R426B - R426B
  • R426C - R426C
  • R427A - R427A
  • R427B - R427B
  • R427C - R427C
  • R428A - R428A
  • R428B - R428B
  • R429A - R429A
  • R429B - R429B
  • R430A - R430A
  • R430B - R430B
  • R431A - R431A
  • R431B - R431B
  • R432A - R432A
  • R432B - R432B
  • R433A - R433A
  • R433B - R433B
  • R433C - R433C
  • R433D - R433D
  • R434A - R434A
  • R434B - R434B
  • R435A - R435A
  • R435B - R435B
  • R436A - R436A
  • R436B - R436B
  • R437A - R437A
  • R437B - R437B
  • R438A - R438A
  • R438B - R438B
  • R444B - R444B
  • R445A - R445A
  • R447A - R447A
  • R448A - R448A
  • R448B - R448B
  • R449A - R449A
  • R449B - R449B
  • R450A - R450A
  • R450B - R450B
  • R451A - R451A
  • R451B - R451B
  • R452A - R452A
  • R452B - R452B
  • R453A - R453A
  • R454A - R454A
  • R454B - R454B
  • R454C - R454C
  • R455A - R455A
  • R456A - R456A
  • R459A - R459A
  • R460A - R460A
  • R461A - R461A
  • R462A - R462A
  • R463A - R463A
  • R464A - R464A
  • R465A - R465A
  • R115 - R115
  • R116 - R116
  • R12B1 - R12B1
  • R13 - R13
  • R13B1 - R13B1
  • R13I1 - R13I1
  • R14 - R14
  • R14e - R14E
  • R21 - R21
  • R23 - R23
  • R30 - R30
  • R31 - R31
  • R40 - R40
  • R41 - R41
  • R50 - R50
  • R113 - R113
  • R114 - R114
  • R125 - R125
  • R141B - R141B
  • R142B - R142B
  • R143A - R143A
  • R152A - R152A
  • R170 - R170
  • R218 - R218
  • R290 - R290
  • R318 - R318
  • R600 - R600
  • R600A - R600A
  • R717 - R717
  • R744 - R744
  • R508B - R508B
  • R1270 - R1270
  • R32 - R32
  • R161 - R161
  • R227EA - R227Ea
  • R236CB - R236Cb
  • R236EA - R236Ea
  • R236FA - R236Fa
  • R245CA - R245Ca
  • R245FA - R245Fa
  • R414C - R414C
  • R415C - R415C
  • R416B - R416B
  • R123A - R123A
  • R123B - R123B
  • R365MFC - R365Mfc
  • R4310 - R4310
  • R127C - R127C
  • R12A - R12A
  • R22A - R22A
  • R502A - R502A
  • R601A - R601A
Available options:
R11,
R12,
R22,
R123,
R124,
R134A,
R401A,
R401B,
R402A,
R402B,
R403A,
R403B,
R404A,
R405A,
R406A,
R407A,
R407B,
R407C,
R407D,
R407F,
R408A,
R409A,
R409B,
R410A,
R410B,
R411A,
R411B,
R412A,
R413A,
R413B,
R414A,
R414B,
R415A,
R415B,
R416A,
R417A,
R417B,
R417C,
R418A,
R419A,
R419B,
R420A,
R420B,
R421A,
R421B,
R421C,
R422A,
R422B,
R422C,
R422D,
R422E,
R423A,
R423B,
R424A,
R424B,
R425A,
R426A,
R426B,
R426C,
R427A,
R427B,
R427C,
R428A,
R428B,
R429A,
R429B,
R430A,
R430B,
R431A,
R431B,
R432A,
R432B,
R433A,
R433B,
R433C,
R433D,
R434A,
R434B,
R435A,
R435B,
R436A,
R436B,
R437A,
R437B,
R438A,
R438B,
R444B,
R445A,
R447A,
R448A,
R448B,
R449A,
R449B,
R450A,
R450B,
R451A,
R451B,
R452A,
R452B,
R453A,
R454A,
R454B,
R454C,
R455A,
R456A,
R459A,
R460A,
R461A,
R462A,
R463A,
R464A,
R465A,
R115,
R116,
R12B1,
R13,
R13B1,
R13I1,
R14,
R14e,
R21,
R23,
R30,
R31,
R40,
R41,
R50,
R113,
R114,
R125,
R141B,
R142B,
R143A,
R152A,
R170,
R218,
R290,
R318,
R600,
R600A,
R717,
R744,
R508B,
R1270,
R32,
R161,
R227EA,
R236CB,
R236EA,
R236FA,
R245CA,
R245FA,
R414C,
R415C,
R416B,
R123A,
R123B,
R365MFC,
R4310,
R127C,
R12A,
R22A,
R502A,
R601A
​
meterIsTracked
boolean
required

Whether the meter is tracked.

​
additionalFields
object
required

Additional fields for the usage data. For information on adding custom fields to the Nectar schema get in touch with our team.

​
document
object
required

Document associated with the usage data.

​
isImplied
boolean

Whether the usage data is implied.

​
currentReading
string<decimal> | null

Current reading of the meter.

Pattern: ^-?\d{0,10}(?:\.\d{0,10})?$
​
previousReading
string<decimal> | null

Previous reading of the meter.

Pattern: ^-?\d{0,10}(?:\.\d{0,10})?$
​
multiplier
string<decimal> | null

Multiplier for the usage data.

Pattern: ^-?\d{0,10}(?:\.\d{0,10})?$
​
multiplierDescription
string | null

Description of the multiplier for the usage data.

​
multiplier2
string<decimal> | null

Second multiplier for the usage data.

Pattern: ^-?\d{0,10}(?:\.\d{0,10})?$
​
multiplier2Description
string | null

Description of the second multiplier for the usage data.

​
fractionRenewable
string<decimal> | null

Fraction of the usage data that is renewable.

Pattern: ^-?\d{0,5}(?:\.\d{0,5})?$
​
netMeteringGridExportKwh
string<decimal> | null

Net metering grid export kWh.

Pattern: ^-?\d{0,10}(?:\.\d{0,10})?$
​
tariff
string | null

Tariff for the usage data.

​
billedDemand
string<decimal> | null

Billed demand for the usage data.

Pattern: ^-?\d{0,10}(?:\.\d{0,10})?$
​
supplierName
string | null

Name of the supplier for the usage data.

​
utilityName
string | null

Name of the local utility distributor for the usage data.

​
country
string | null

Country of the usage data.

​
serviceAddress
string | null

Address of the service location associated with the usage data.

​
apparentUsage
string<decimal> | null

[ELECTRICITY] Apparent energy usage for this electricity meter (kVAh, MVAh, or GVAh). Represents the total power (real + reactive).

Pattern: ^-?\d{0,10}(?:\.\d{0,10})?$
​
apparentUsageUnits
enum<string> | null

[ELECTRICITY] Units for the apparent usage amount.

  • kVAh - Kvah
  • MVAh - Mvah
  • GVAh - Gvah
Available options:
kVAh,
MVAh,
GVAh
​
reactiveUsage
string<decimal> | null

[ELECTRICITY] Reactive energy usage for this electricity meter (kVArh, MVArh, or GVArh). Represents the non-working power.

Pattern: ^-?\d{0,10}(?:\.\d{0,10})?$
​
reactiveUsageUnits
enum<string> | null

[ELECTRICITY] Units for the reactive usage amount.

  • kVArh - Kvarh
  • MVArh - Mvarh
  • GVArh - Gvarh
Available options:
kVArh,
MVArh,
GVArh
​
powerFactor
string<decimal> | null

[ELECTRICITY] Power factor ratio expressing the efficiency of power usage. Value between 0.0 and 1.0.

Pattern: ^-?\d{0,1}(?:\.\d{0,19})?$
​
timeOfUseBreakdown
object[] | null

[ELECTRICITY] Array of time-of-use breakdown entries when usage is split by TOU periods. Each entry contains timeOfUse category, usage amount, units, and optional description/dates.