Distributor Tariffs Schema

NameData TypeDescription
notesCollectionCollection of distributor notes
distibutor_idIntegerInternal ID of the distributor
tariff_nameStringThe name of the tariff
effective_start_dateStringApplies to usage after this date
customer_chargeCollectionCollection of Customer Charges
energy_chargeCollectionCollection of Energy Charges
consumption_profile_idInteger1=Residential, 2=Commercial
distribution_chargeCollectionCollection of Distribution Charges
idIntegerInternal tariff id
distributor_tariff_detail_idIntegerId for this effective date/version
revision_reasonStringReason for this version

Distributor notes

NameData TypeDescription
notesStringThe distributors description of the tariff
research_urlStringhttp://url_link_to_distributors_documentation

Customer Charges

NameData TypeDescription
rangeCollectionCollection of charge ranges
basisStringSee https://www.claritygrid.net/api-basis/
peak_intervalIntegerReserved for future use

Energy Charges

NameData TypeDescription
rangeCollectionCollection of charge ranges
basisStringSee https://www.claritygrid.net/api-basis/

Distribution Charges

NameData TypeDescription
componentsCollectionCollection of charge components
rangeCollectionCollection of charge ranges
basisStringSee https://www.claritygrid.net/api-basis/

Components

NameData TypeDescription
costFloatCost of the component
labelStringLabel of the component

Range

NameData TypeDescription
costFloatCost of the tier
blcfctrFloatCharge block factor
fromIntegerTier starting value
toIntegerTier ending value
{
    "notes": {
      "notes": “” 		                The distributors description of the tariff,
      "research_url": "”	                http://url_link_to_distributors_documentation
    },
    "distributor_id": 		                Internal ID of the distributor
    "tariff_name":  		                The name of the tariff
    "effective_start_date": 	                Applies to usage after this date
    "customer_charge": [                
      {
        "range": [  		                Range collections describe the tiers or blocks for charges amounts
          {
            "cost": 5.47,               
            "blcfctr": 0,   	                Block factor
            "from": 0                           Range starting value
          }
        ],
        "basis": “” 		                See https://www.claritygrid.net/api-basis/ 
        "peak_interval": 		        Reserved for future use
      }
    ],
    "energy_charge": [                          
      {
        "range": [
          {
            "cost": 0.06,                       Cost of this tier
            "from": 0                           Range starting value
          }
        ],
        "basis": "kwh"                          See https://www.claritygrid.net/api-basis/
      }
    ],
    "consumption_profile_id": 1,     		1=Residential, 2=Commercial
    "distribution_charge": [
      {
        "components": [
          {
            "price": 0.008439,                  Cost of this component
            "label": ""                         Label of this component
          },
        ],
        "range": [
          {
            "cost": 0.037125,                   Cost of this tier
            "from": 0                           Range starting value
          }
        ],
        "basis": "kwh"                          See https://www.claritygrid.net/api-basis/
      }
    ],

    "id": 2228,					Internal tariff id
    "distributor_tariff_detail_id": 10122,	Id for this effective date / version
    "revision_reason": "Effective Date"	        Reason for this version
  },

rev 1.0 2023-02-13