Put /api/v3/account/{accountId}/meter/{meterId}/calculatedBill/{versionId}/demand

Operation: ManageCalculateBillDemandV3 Permissions: Chargebacks (Manage)

Summary

Manage calculated bill’s demand
If demand does not exist on the distribution it will be added
If one exists it will be saved as the option sent in
If the dto sends null for both (channel and fixed), then demand will get cleared

Path and Query Parameters

Parameter Description Type Location
accountId ID of the account to receive calculated bill detailsRequired integer Path
meterId ID of the meter to receive calculated bill detailsRequired integer Path
versionId ID of the calculated bill distribution versionRequired integer Path

Request Body Parameters

Content-Type: application/json

Type Reference: CalculatedBillDemandRequest

Parameter Description Type
readingsChannelId Use channel data readings to calculate bill demand Required (defined) Only one of ReadingsChannelId, FixedDemand, UseWatticsDataPoint can be set integer
fixedDemand FixedDemandRequest
   fixedDemandAmount Fixed demand amount Required Max scale of 6 number
   unitId Unit to which demand is applied Required integer
useWatticsDataPoint Use SmartAnalytics (Wattics) data readings to calculate bill demand Required (defined) Only one of ReadingsChannelId, FixedDemand, UseWatticsDataPoint can be set boolean

Request Body

{
  "readingsChannelId": 1,
  "fixedDemand": {
    "fixedDemandAmount": 1.0,
    "unitId": 1
  },
  "useWatticsDataPoint": false
}

Response Parameters

HTTP 200


Body Parameters

Content Type: application/json

Type Reference: CalculatedBillDemandResponse

Parameter Description Type
readingsFromChannel ChannelChildWithObservationType
   type ObservationTypeChild
      nounId The identifier for the observation type’s noun integer
      nounCode The observation type’s noun code string
      credit Indicates the type of credit for the observation type. Possible values include: 1 (Credit), 2 (Debit), 3 (Ignore) integer
      observationTypeId The observation type identifier integer
      observationTypeCode The observation type code string
      observationTypeInfo The observation type info string
   rule ObservationRule
      observationRuleId The observation rule identifier integer
      observationRuleCode The observation rule code string
      observationRuleInfo The observation rule info string
   channelCode The channel code
Combines observationTypeCode:unitCode:observationMethodCode:observationRuleCode:interval in minutes		 string
   channelId The channel identifier integer
   interval The channel interval in seconds.
Monthly = 2592000
Weekly = 604800
Daily = 86400
Hourly = 3600
Thirty_Minutes = 1800
Fifteen_Minutes = 900		 integer
fixedDemand Fixed amount per unit to apply during bill calculation FixedAmountResponse
   amount Fixed amount number
   unit UnitChild
      unitId The unit identifier integer
      unitCode The unit code string
      unitInfo The unit info string
readingsFromWatticsDataPoint WatticsDataPointChild
   watticsDataPointId The identifier for a SmartAnalytics (Wattics) meter integer
   watticsDataPointInfo The name for a SmartAnalytics (Wattics) meter string

Responses

HTTP 200

Body

Content Type: application/json
{
  "readingsFromChannel": {
    "type": {
      "nounId": 1,
      "nounCode": "string",
      "credit": 1,
      "observationTypeId": 1,
      "observationTypeCode": "string",
      "observationTypeInfo": "string"
    },
    "rule": {
      "observationRuleId": 1,
      "observationRuleCode": "string",
      "observationRuleInfo": "string"
    },
    "channelCode": "string",
    "channelId": 1,
    "interval": 1
  },
  "fixedDemand": {
    "amount": 1.0,
    "unit": {
      "unitId": 1,
      "unitCode": "string",
      "unitInfo": "string"
    }
  },
  "readingsFromWatticsDataPoint": {
    "watticsDataPointId": 1,
    "watticsDataPointInfo": "string"
  }
}