v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Charges
Retrieve a charge price and cost breakdown

Required scope: charges:readNote: Please be aware that this endpoint is currently in the BETA phase,calculations may return slightly varying results, and the payload can change.
get/api/v1/charges/{chargeId}/breakdown
Path parameters

chargeIdinteger required
Response

Charge Breakdown for the given id
chargeIdinteger required
The charge id associated with this charge breakdown
Example response

{
  "chargeId": 10001,
  "priceBreakdown": {
    "summary": {
      "totalMasterPrice": 1000,
      "totalSecondaryPrice": 500,
      "totalFees": 500,
      "totalAdjustments": 200,
      "totalPrice": 2220,
      "totalDiscount": 2220
    },
    "currency": {
      "identifier": "dkk",
      "name": "Danish krone",
      "decimals": 2
    },
    "breakdown": [
      {
        "from": "2022-04-22T09:00:00Z",
        "to": "2022-04-22T09:59:59Z",
        "subTotalPrice": 100,
        "subTotalMasterPrice": 50,
        "subTotalSecondaryPrice": 25,
        "components": [
          {
            "price": 1200,
            "description": "Tariff for 10 kwh charged at 1.20 DKK",
            "masterPricing": true,
            "tag": {
              "name": "Energy",
              "description": "Used to group `Energy` pricing elements",
              "partnerExternalId": "ACME-12345",
              "operator": {
                "id": 14,
                "name": "Monta",
                "identifier": "monta",
                "partnerId": 1,
                "vatNumber": "FOO-123-ABC"
              },
              "createdAt": "2022-05-12T15:56:45.99Z",
              "updatedAt": "2022-05-12T16:56:45.99Z"
            },
            "metadata": {
              "kwh": 12.5,
              "pricePerKwh": 120
            }
          }
        ]
      }
    ],
    "fees": [
      {
        "price": 1200,
        "description": "Tariff for 10 kwh charged at 1.20 DKK",
        "masterPricing": true,
        "tag": {
          "name": "Energy",
          "description": "Used to group `Energy` pricing elements",
          "partnerExternalId": "ACME-12345",
          "operator": {
            "id": 14,
            "name": "Monta",
            "identifier": "monta",
            "partnerId": 1,
            "vatNumber": "FOO-123-ABC"
          },
          "createdAt": "2022-05-12T15:56:45.99Z",
          "updatedAt": "2022-05-12T16:56:45.99Z"
        },
        "metadata": {
          "kwh": 12.5,
          "pricePerKwh": 120
        }
      }
    ],
    "adjustments": [
      {
        "price": 1200,
        "description": "Tariff for 10 kwh charged at 1.20 DKK",
        "masterPricing": true,
        "tag": {
          "name": "Energy",
          "description": "Used to group `Energy` pricing elements",
          "partnerExternalId": "ACME-12345",
          "operator": {
            "id": 14,
            "name": "Monta",
            "identifier": "monta",
            "partnerId": 1,
            "vatNumber": "FOO-123-ABC"
          },
          "createdAt": "2022-05-12T15:56:45.99Z",
          "updatedAt": "2022-05-12T16:56:45.99Z"
        },
        "metadata": {
          "kwh": 12.5,
          "pricePerKwh": 120
        }
      }
    ]
  },
  "costBreakdown": {
    "summary": {
      "totalMasterPrice": 1000,
      "totalSecondaryPrice": 500,
      "totalFees": 500,
      "totalAdjustments": 200,
      "totalPrice": 2220,
      "totalDiscount": 2220
    },
    "currency": {
      "identifier": "dkk",
      "name": "Danish krone",
      "decimals": 2
    },
    "breakdown": [
      {
        "from": "2022-04-22T09:00:00Z",
        "to": "2022-04-22T09:59:59Z",
        "subTotalPrice": 100,
        "subTotalMasterPrice": 50,
        "subTotalSecondaryPrice": 25,
        "components": [
          {
            "price": 1200,
            "description": "Tariff for 10 kwh charged at 1.20 DKK",
            "masterPricing": true,
            "tag": {
              "name": "Energy",
              "description": "Used to group `Energy` pricing elements",
              "partnerExternalId": "ACME-12345",
              "operator": {
                "id": 14,
                "name": "Monta",
                "identifier": "monta",
                "partnerId": 1,
                "vatNumber": "FOO-123-ABC"
              },
              "createdAt": "2022-05-12T15:56:45.99Z",
              "updatedAt": "2022-05-12T16:56:45.99Z"
            },
            "metadata": {
              "kwh": 12.5,
              "pricePerKwh": 120
            }
          }
        ]
      }
    ],
    "fees": [
      {
        "price": 1200,
        "description": "Tariff for 10 kwh charged at 1.20 DKK",
        "masterPricing": true,
        "tag": {
          "name": "Energy",
          "description": "Used to group `Energy` pricing elements",
          "partnerExternalId": "ACME-12345",
          "operator": {
            "id": 14,
            "name": "Monta",
            "identifier": "monta",
            "partnerId": 1,
            "vatNumber": "FOO-123-ABC"
          },
          "createdAt": "2022-05-12T15:56:45.99Z",
          "updatedAt": "2022-05-12T16:56:45.99Z"
        },
        "metadata": {
          "kwh": 12.5,
          "pricePerKwh": 120
        }
      }
    ],
    "adjustments": [
      {
        "price": 1200,
        "description": "Tariff for 10 kwh charged at 1.20 DKK",
        "masterPricing": true,
        "tag": {
          "name": "Energy",
          "description": "Used to group `Energy` pricing elements",
          "partnerExternalId": "ACME-12345",
          "operator": {
            "id": 14,
            "name": "Monta",
            "identifier": "monta",
            "partnerId": 1,
            "vatNumber": "FOO-123-ABC"
          },
          "createdAt": "2022-05-12T15:56:45.99Z",
          "updatedAt": "2022-05-12T16:56:45.99Z"
        },
        "metadata": {
          "kwh": 12.5,
          "pricePerKwh": 120
        }
      }
    ]
  }
}