{
  "openapi": "3.0.0",
  "info": {
    "title": "Corrected Profile Fractions API",
    "description": "Als klant betaal je niet voor de hoeveelheid gas (kubieke meters) die je gebruikt, maar voor de\nenergie die in het gas zit. De hoeveelheid energie wordt bepaald door de calorische waarde van\nhet gas. De calorische waarde is per netgebied en per periode verschillend. Voor de bepaling van\nde af te rekenen hoeveelheid energie wordt met de calorische waarde een correctie toegepast op\nde hoeveelheid gas. Via deze API kun je de calorische waarden van de aansluiting in het\nbetreffend gebied of voor een bepaalde periode downloaden ter controle van de energiefactuur. De\ngegevens worden beschikbaar gesteld door de Regionale Netbeheerders en worden maandelijks op de\n7e werkdag van de maand bijgewerkt. De temperatuur gecorrigeerde profielfracties worden gebruikt\nin het reconciliatieproces om het calorische gecorrigeerde verbruik te verdelen over\nverbruiksmaanden bij verbruik over meerdere maanden.\n",
    "contact": {
      "name": "EDSN",
      "url": "https://www.edsn.nl/",
      "email": "servicedesk@edsn.nl"
    },
    "version": "2.0.1",
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "x-date:": "01-06-2021"
  },
  "servers": [
    {
      "url": "https://b2b.gateway.edsn.nl/energybalance/v1",
      "description": "Productie server",
      "variables": {}
    },
    {
      "url": "https://b2b.gateway-acc.edsn.nl/energybalance/v1",
      "description": "Acceptatie server",
      "variables": {}
    },
    {
      "url": "https://b2b.gateway-tst.edsn.nl/energybalance/v1",
      "description": "Integratie test server",
      "variables": {}
    }
  ],
  "paths": {
    "/profilecategorycorrectedprofilefractions": {
      "get": {
        "tags": [
          "CorrectedProfileFractions"
        ],
        "summary": "getProfileCategoryCorrectedProfileFractions",
        "description": "",
        "operationId": "getProfileCategoryCorrectedProfileFractions",
        "parameters": [
          {
            "name": "profileCategory",
            "in": "query",
            "description": "De profielcategorie. Wanneer deze waarde gevuld is zal alleen de data van deze profielcategorie teruggeven worden.\nWanneer deze parameter niet meegegeven wordt, dan zal de data voor alle profielcategorien teruggegeven worden.",
            "style": "form",
            "explode": true,
            "schema": {
              "maxLength": 3,
              "minLength": 3,
              "pattern": "^.{3}$",
              "type": "string",
              "example": "G2C"
            }
          },
          {
            "name": "startMonth",
            "in": "query",
            "description": "De beginmaand van de periode waarover data opgevraagd wordt. Het formaat van deze parameter is YYYY-MM.",
            "required": true,
            "style": "form",
            "explode": true,
            "schema": {
              "maxLength": 7,
              "minLength": 7,
              "pattern": "^\\d{4}-\\d{2}$",
              "type": "string",
              "example": "2020-01"
            }
          },
          {
            "name": "endMonth",
            "in": "query",
            "description": "De eindmaand van de periode waarover data opgevraagd wordt. Deze waarde is optioneel en wanneer\ndeze niet meegegeven wordt, dan zal de huidige maand gebruikt worden. Het formaat van deze parameter is YYYY-MM.",
            "style": "form",
            "explode": true,
            "schema": {
              "maxLength": 7,
              "minLength": 7,
              "pattern": "^\\d{4}-\\d{2}$",
              "type": "string",
              "example": "2021-01"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Verzoek successvol verwerkt.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ProfileCategory"
                  },
                  "description": ""
                }
              }
            }
          },
          "400": {
            "description": "Wanneer het verzoek onvolledig is of de inhoud van de parameters onjuist is.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ProfileCategory": {
        "title": "ProfileCategory",
        "type": "object",
        "properties": {
          "profileCategory": {
            "maxLength": 3,
            "minLength": 3,
            "type": "string",
            "description": "De profielcategorie. Als er geen data aanwezig is voor de opgevraagde periode zal er een lege lijst worden teruggegeven.",
            "example": "G2C"
          },
          "correctedProfileFractions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CorrectedProfileFraction"
            },
            "description": ""
          }
        },
        "description": "Een object met een lijst van gecorrigeerde profielfracties per profielcategorie. Als er geen data aanwezig is voor de opgevraagde periode of profielcategorie zal er een lege lijst worden teruggegeven."
      },
      "CorrectedProfileFraction": {
        "title": "CorrectedProfileFraction",
        "type": "object",
        "properties": {
          "value": {
            "multipleOf": 0.00000001,
            "type": "number",
            "description": "De gecorrigeerde profielfractie voor een profielcategorie op een specifiek uur.",
            "example": 0.00000078
          },
          "dateTime": {
            "type": "string",
            "description": "De starttijd van het uur waarvoor de gecorrigeerde profielfractie geldig is. Het resultaat is een ISO 8601-formaat (Europa/Amsterdam) op het uur nauwkeurig.",
            "format": "date-time",
            "example": "2021-01-01T13:00:00+01:00"
          }
        }
      },
      "ErrorResponse": {
        "title": "ErrorResponse",
        "required": [
          "error"
        ],
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "Mogelijke foutcodes\n- missing_required_parameter bijv. wanneer een verplichte parameter ontbreekt in het vezoek.\n- invalid_period bijv. wanneer de opgegeven periode (startMonth / endMonth) geen geldige periode is.\n- invalid_parameter_value bijv. wanneer de waarde van een parameter niet het juiste formaat of inhoud heeft.",
            "example": "missing_required_parameter"
          },
          "errorDescription": {
            "type": "string",
            "example": "Missing required parameter 'startMonth'"
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "CorrectedProfileFractions",
      "description": ""
    }
  ]
}