BeMapAPI
BeMap 4.1.0
API reference: POST /chargingstation/tariffs/1.0/search

REST API, Service version 1.0.0

Get charging station tariffs#

Returns the list of tariffs of charging stations.

Summary#

  1. Request
    1. Mandatory parameters
  2. Response
    1. Details of fields
    2. Response samples

Request#

The request must be sent with the HTTP method POST and the HTTP header Content-Type set to application/json.

Sample: URI: /bgis/service/chargingstation/tariffs/1.0/search

POST data:

javascript
{
    "providerName": "ecoMovement",
    "chargePassHashIds": [
        "b6c2f14ed716704ba648926f26071da0", "b2c34a5e76b162327e29fd79ec1589ed"
    ],
    "links": [
        {
            "poolId": "3c4b35cc-368f-11f0-94a6-42010aa40043",
            "chargingPointId": "FR*IOY*E448904",
            "connectorId": "1"
        }
    ]
}

Parameters#

  • providerNamestringrequired

    Provider name used by BeMap (bgis).

  • linksChargingTariffConnectorLinkFront[]required

    Represents a list of associations between charging tariffs and connectors.

    ChargingTariffConnectorLinkFront fields
    • poolIdstringrequired

      Unique identifier of the charging pool.

    • chargingPointIdstringrequired

      Unique identifier of the charging point. Use the ID field from charging station search service.

    • connectorIdstringrequired

      Unique identifier of the charging connector. Use the operator ID field from charging station search service.

    • stationIdstring

      Unique identifier of the charging station.

  • geoserverstring

    Geoserver name.

  • swidxinteger (int32)deprecated

    Switch index.

  • logTagstring

    Log tag is an UUID tag used during the request calculation in log and send to another provider (if need).

  • chargePassHashIdsstring[]

    Represents a collection of hashed identifiers for tariff charge passes added in response. The tariffs of charge passes are returned in response to the AD/HOC tariffs. The AD/HOC tariffs are always returned when they are available.

Response#

Details of fields#

  • itemsFindTariffsItemFront[]required

    List of tariffs.

    FindTariffsItemFront fields
    • poolIdstringrequired

      Unique identifier of the charging pool.

    • stationIdstringrequired

      Unique identifier of the charging station.

    • chargingPointIdstringrequired

      Unique identifier of the charging point.

    • connectorIdstringrequired

      Unique identifier of the charging connector.

    • tariffContentChargingTariffContentFrontrequired

      Details of the charging tariff.

      ChargingTariffContentFront fields
      • idstringrequired

        Unique identifier of database entry, generated by the database.

      • providerNamestringrequired

        Provider name of data.

      • updateDateinteger (int64)required

        Update date, time stamp in milliseconds.

      • providerTariffIdstringrequired

        A unique identifier for the tariff provided by a charging service provider. This identifier is used to distinguish between various tariff plans or pricing structures offered by the provider. Typically assigned by the provider, it serves as a reference for mapping and managing charging tariffs.

      • typeenumrequired

        Represents the type of charging tariff applied in the context of a charging session.

        3 accepted values
        AD_HOC
        MSP
        CPO_SUB
      • chargePassChargingTariffChargePassFrontrequired

        The charge pass may provide information about specific subscription features, fees, or charge network details relevant to the charging process.

        ChargingTariffChargePassFront fields
        • hashIdstringrequired

          Unique identifier of charge pass.

        • titlestringrequired

          Name of charge pass.

        • networkNamestring

          Unique name of charge network.

        • descriptionstring

          A brief description or summary of the station charge pass.

        • currencystring

          Currency used for the subscription fee. This field stores the currency code or symbol used for the subscription fee.

        • subscriptionTypestring

          Type of subscription associated with the entity. This may denote the specific subscription model or tier for accessing the station service.

        • subscriptionFeeExclVatnumber (float)

          Subscription fee excluding VAT. This field stores the fee amount charged for a subscription before any value-added tax is applied.

        • networkUrlstring

          URL link to the website of charge network.

        • androidAppUrlstring

          URL link to the Android application of charge network.

        • iosAppUrlstring

          URL link to the iOS application of charge network.

      • currencystringrequired

        Currency ISO 4217 Code.

      • minPriceChargingPriceTaxFrontrequired

        When this field is set, the minimum cost of a Charging Session before taxes cannot be lower than this amount.

        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.

      • maxPriceChargingPriceTaxFrontrequired

        When this field is set, the maximum cost of a Charging Session before taxes cannot exceed this amount.

        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.

      • tariffItemsChargingTariffItemFront[]required

        A list containing tariff items associated with the charging 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
      • providerUpdatedstring

        Represents the date and time when the charging tariff information was last updated. This timestamp allows tracking changes and updates to the tariff details.

      • tariffExplainTextsLanguageTextFront[]

        A list of multilingual textual descriptions for explaining the tariff.

        LanguageTextFront fields
        • languagestringrequired

          Language code (e.g., 'fr', 'en').

        • textstringrequired

          The actual text content.

      • tariffUrlstring

        URL to a web page that contains an explanation of the tariff information in human-readable form.

Response samples#

JSON Sample:

javascript
{
    "items": [
        {
            "poolId": "3c4b35cc-368f-11f0-94a6-42010aa40043",
            "chargingPointId": "FR*IOY*E448904",
            "connectorId": "1",
            "tariffContent": {
                "id": "696513356c695139442c3013",
                "providerName": "ecoMovement",
                "updateDate": 1768231464512,
                "providerUpdated": "2025-12-24T07:01:11Z",
                "providerTariffId": "e861f26fed5e26b956f34e6cc2439d11e7e9c4c5939465326224baf132b4b418",
                "type": "MSP",
                "chargePass": {
                    "hashId": "b6c2f14ed716704ba648926f26071da0",
                    "networkName": "EnBW",
                    "title": "EnBW mobility+ Ladetarif M",
                    "description": "monthly subscription",
                    "currency": "EUR",
                    "subscriptionType": "monthly",
                    "subscriptionFeeExclVat": 5.0336
                },
                "currency": "EUR",
                "tariffItems": [
                    {
                        "restriction": {
                            "minDuration": 14400,
                            "maxDuration": 21600
                        },
                        "prices": [
                            {
                                "type": "ENERGY",
                                "unit": "PER_KWH",
                                "price": 0.4917,
                                "vat": 20.0,
                                "minAmount": 1.0
                            },
                            {
                                "type": "PARKING_TIME",
                                "unit": "PER_HOUR",
                                "price": 5.0,
                                "vat": 20.0,
                                "minAmount": 60.0
                            }
                        ]
                    },
                    {
                        "prices": [
                            {
                                "type": "ENERGY",
                                "unit": "PER_KWH",
                                "price": 0.4917,
                                "vat": 20.0,
                                "minAmount": 1.0
                            }
                        ]
                    }
                ]
            }
        }
    ]
}