BeMapAPI
BeMap 4.1.0

Charging cost calculation Estimate the cost of a charge

BeMap name: Charging cost calculation

POST/chargingcost/1.0

Part of Charging time and cost1 tutorialBeMap's service page

What a charge will cost and how long it will take, for a vehicle, a connector and a price list.

The whole description

In BeMap's words

Computes an estimated charging cost and time, based on vehicle, connector power, charge need and prices list.

Computes an estimated charging cost and time, based on vehicle, connector power, charge need and prices list.

Provisioned per account. This service is enabled per account; without it BeMap answers 400 with Access Denied.

Request body

JSON, Content-Type: application/json. Schema ChargingCostRequest.

  • vehiclestringrequired

    Model of vehicle (key).

  • temperatureinteger (int32)required

    Temperature in Celsius.

  • chargesChargingCostCharge[]required

    List of charging features.

    ChargingCostCharge fields
    • curBatLvlnumber (double)required

      Current level of battery (in percent), Range between 0% to 100% for a full battery charge.

    • powernumber (double)required

      Nominal power of connector (in kW). For a charging station can deliver 50 kW, set the value to 50.

    • cnnTypeIdinteger (int32)required

      Connector type ID.

    • currencystringrequired

      Defined the currency used for costs calculation. Currency ISO 4217 Code.

    • tariffsChargingTariffItemFront[]required

      List of tariff.

      ChargingTariffItemFront fields
      • pricesChargingPrice[]required

        List of price.

        ChargingPrice fields
        • typeenumrequired

          Type of price dimension.

          4 accepted values
          FLATflat fee, no unit.
          PARKING_TIMEtime not charging, defined in hours.
          ENERGYdefined in kWh.
          TIMEtime charging, defined in hours.
        • pricenumber (float)required

          Price per unit (excluding VAT) for this tariff dimension.

        • unitenum

          Unit of price.

          3 accepted values
          NA
          PER_HOUR
          PER_KWH
        • vatnumber (float)

          Applicable VAT percentage for this tariff dimension. If omitted, no VAT is applicable.

        • minAmountnumber (float)

          Minimum amount to be billed.

      • restrictionChargingPriceRestriction

        Restriction information of prices.

        ChargingPriceRestriction fields
        • startTimestring

          Start time of day (hh:mm).

        • endTimestring

          End time of day (hh:mm).

        • startDatestring

          Start date (AAAA-MM-DD).

        • endDatestring

          End date (AAAA-MM-DD).

        • minKwhnumber (float)

          Minimum used energy in kWh for this tariff to be valid.

        • maxKwhnumber (float)

          Maximum used energy in kWh for this tariff to be valid.

        • minPowernumber (double)

          Minimum power in kW for this tariff to be valid.

        • maxPowernumber (double)

          Maximum power in kW for this tariff to be valid.

        • minDurationinteger (int32)

          Minimum duration in seconds for this tariff to be valid.

        • maxDurationinteger (int32)

          Maximum duration in seconds for this tariff to be valid.

        • dayOfWeekenum[]

          List of day of the week for this tariff to be valid. Values can be MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

          7 accepted values
          MONDAY
          TUESDAY
          WEDNESDAY
          THURSDAY
          FRIDAY
          SATURDAY
          SUNDAY
    • minPriceChargingPriceTaxFront

      Minimum price for a charging session with this tariff.

      ChargingPriceTaxFront fields
      • excludeTaxnumber (float)required

        Represents the price of a charge without a tax.

      • includeTaxnumber (float)required

        Represents the price of a charge with tax. The amount of money of this tax that is due.

      • namestring

        The name of the tax. The intention is that Parties use short names where possible, e.g. VAT.

    • maxPriceChargingPriceTaxFront

      Maximum price for a charging session with this tariff.

      ChargingPriceTaxFront fields
      • excludeTaxnumber (float)required

        Represents the price of a charge without a tax.

      • includeTaxnumber (float)required

        Represents the price of a charge with tax. The amount of money of this tax that is due.

      • namestring

        The name of the tax. The intention is that Parties use short names where possible, e.g. VAT.

    • toBatLvlnumber (double)

      Desired level of battery after charging (in percent), 100% for a full battery charge. For a full charge, set the value to 100. For a charge to 80% of battery capacity set the value to 80.

    • durationinteger (int64)

      Maximum desired time spent to the charge (in seconds).

    • currentTypeenum

      Current type (AC/DC).

      5 accepted values
      NANot available (NA).
      ACAlternating current (AC), but the number of phases is not available.
      AC_SINGLE_PHASEAlternating current (AC), single phase.
      AC_THREE_PHASESAlternating current (AC), three phases.
      DCDirect current (DC).
    • startDateTimestring

      The time when this tariff becomes active, in UTC, the time_zone field of the Location can be used to convert to local time. Typically used for a new tariff already given with the location, before it becomes active.

    • endDateTimestring

      The time after which this tariff is no longer valid, in UTC, time_zone field if the Location can be used to convert to local time. Typically used when this tariff is going to be replaced with a different tariff soon.

    • timeZonestring

      Time zone. The value must come from the Pool timeZone field. One of IANA tzdata's TZ-values representing the time zone of the location. Examples: "Europe/Oslo", "Europe/Zurich". (http://www.iana.org/time-zones)

  • geoserverstring

    Geoserver name.

  • swidxinteger (int32)deprecated

    Switch index.

  • timeinteger (int64)

    Time stamp (in milliseconds). Defines the date and time will be used to apply the price restrictions.

  • curstring

    Defined the currency used for costs calculation. Currency ISO 4217 Code.

Response

200, schema ChargingCostResponse.

Response fields
  • estimationsChargingCostEstimation[]

    List of estimated cost and time.

    ChargingCostEstimation fields
    • chargingTimeinteger (int64)

      Charging time in seconds.

    • energyUsednumber (double)

      Energy used in kW to make the charge.

    • batChargeLvlnumber (double)

      The charge level (in %) of the vehicle at the given charge point.

    • chargingCostChargingCost

      Charging cost.

      ChargingCost fields
      • currencystring

        Currency ISO 4217 Code.

      • withoutVatnumber (float)

        Price without VAT.

      • includeVatnumber (float)

        Price include VAT.

Errors

  • 400 Bad Request, ErrorResponse
  • 302 No credentials were sent. Do not follow the redirect.
  • 401 The account or the API key is wrong.

How to read each one: Errors.

Tutorials

Reference pages