Créer un compteur (eau, électricité, gaz)

POST

/v1/meters

curl --request POST \
  --url https://example.com/v1/meters \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "establishmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "unitId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "code": "example", "label": "example", "kind": "water", "uom": "m3", "unitPriceDtmc": "1234", "purchaseCostDtmc": "example", "vatRateBp": 550, "rolloverMaxMilli": "example", "sensorRef": "example" }'

Authorizations

• ApiKeyAuth
• BearerAuth

Request Body ^required

Tous les montants en dix-millièmes de centime (bigint string).

Media type application/json

object

establishmentId

required

string format: uuid

unitId

string format: uuid

nullable

code

required

string

<= 50 characters

label

required

string

<= 200 characters

kind

required

string

Allowed values: water electricity gas

uom

required

string

Allowed values: m3 l kwh

unitPriceDtmc

required

Prix unitaire en dix-millièmes de centime (bigint string)

string

Example

1234

purchaseCostDtmc

string

nullable

vatRateBp

required

TVA en basis points (5,50% = 550)

integer

Example

550

rolloverMaxMilli

string

nullable

sensorRef

string

nullable <= 200 characters

Responses

201

Compteur créé

Media type application/json

object

data

required

object

meterId

required

string format: uuid

Example ^generated

{
  "data": {
    "meterId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
}

400

Corps invalide

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

401

Non authentifié

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

403

Permission refusée

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}