> ## Documentation Index
> Fetch the complete documentation index at: https://docs.datanumia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Offers prices

Energy prices enable the association of prices with supply contract parameters. This data is essential to link prices to a site's contract and to ensure accurate valuation of the site's energy consumption.

When a new tariff offer is launched or when prices change, we need to collect this information in order to provide accurate services.

Prices consist of two main types of information: electricity prices and standing charges (fixed fees such as subscription fees or green energy fees for example).

## Details on the expected information to be sent

### Energy prices

| Information | Description | Required |
| - | - | - |
| Parameters | Contract parameters associated with the prices (e.g. tariff, option, subscribed power) | Yes |
| Prices | Electricity prices categorized by tariff heading | Yes |
| Application date | Functional start date of the prices | Yes |
| Currency | Currency in which the prices are sent | Yes |

### Standing charge prices

| Information | Description | Required |
| - | - | - |
| Parameters | Contract parameters associated with the standing charge prices | Yes |
| Standing charges | Standing charge prices | Yes |
| Application date | Functional start date of the prices | Yes |
| Currency | Currency in which the prices are sent | Yes |

## Prices Collection Process

The prices collection should take place after the declaration of the tariff offer and its options in our Information System.

We use a unified process to collect this data in bulk via an API (ajouter doc API).
This method allows bulk collection of prices associated with multiple contract parameters and includes three endpoints:

* `POST /electricity-prices-jobs`: Allows you to submit a prices archive for processing
* `GET /electricity-prices-jobs/{job-id}`: Allows you to monitor the processing of an archive through its statuses and the detailed report containing the OK/KO operations
* `GET /electricity-prices-jobs`: Returns a list of jobs between two dates, with their statuses and an overview of the OK/KO operations

| Status | Description |
| - | - |
| `SUBMITTED` | The archive is received but processing has not started. |
| `IN_PROGRESS` | The archive is being processed. |
| `DONE` | Archive processing is completed without errors and a detailed report on each request is accessible. |
| `ERROR` | Archive processing is completed but has encountered at least one functional error. The details are available in the detailed report. Actions on the client's side are necessary to correct them and resend the corresponding prices. |
| `INTERNAL_ERROR` | Archive processing stopped mid-process for an unknown reason. Actions on Datanumia's side are necessary to correct them. |

### Example of a JSON file

```json theme={null}
{
  "energyPrices": [
    {
      "beginDate": "2021-07-21",
      "generationTs": "2022-05-17T14:28:37Z",
      "supplyContractParameters": {
          "TARIFF": "TARIFF_1",
          "TARIFF_OPTION": "HPHC",
          "SUBSCRIBED_POWER": "9",
          "MILLESIME": "20230801"
      },
      "pricesByTariffHeading": {
        "HP": "0.2",
        "HC": "0.1"
      },
      "currency": "EUR"
    }
  ],
  "standingCharges": [
    {
      "beginDate": "2021-07-21",
      "generationTs": "2022-05-17T14:28:37Z",
      "supplyContractParameters": {
        "TARIFF": "TARIFF_1",
        "TARIFF_OPTION": "HPHC",
        "SUBSCRIBED_POWER": "9",
        "MILLESIME": "20230801"
      },
      "standingChargesByType": {
        "STANDING_CHARGE_FEE": "0.4",
        "GREEN_ENERGY_FEE": "0.3"
  },
      "currency": "EUR"
    }
  ]
}
```
