Rapport remises folio + dérogations tarifaires sur une période (ADR-00D113 D5)

GET

/v1/reporting/discounts

curl --request GET \
  --url 'https://example.com/v1/reporting/discounts?toDate=2026-06-30&fromDate=2026-06-01&establishmentId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'X-API-Key: <X-API-Key>'

Agrège les remises folio (charge_nature=discount, magnitude ≥ 0) par motif ET par acteur (userId extrait de origin_reference — aucun posted_by dédié), et les dérogations tarifaires (écart public − dérogé) par motif, pour l’établissement demandé sur [fromDate, toDate]. totalRemisedCents = Σ remises TTC + Σ écarts dérogation.

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Query Parameters

toDate

required

string format: date

Example

2026-06-30

fromDate

required

string format: date

Example

2026-06-01

establishmentId

required

string format: uuid

Responses

200

Rapport remises

Media type application/json

object

data

required

object

establishmentId

required

string format: uuid

fromDate

required

string format: date

toDate

required

string format: date

discounts

required

object

totalHtCents

required

Magnitude HT remisée (bigint centimes)

string

totalTaxCents

required

Magnitude TVA remisée (bigint centimes)

string

totalTtcCents

required

Magnitude TTC remisée (bigint centimes)

string

byReason

required

Array<object>

object

reason

required

string

count

required

integer

htCents

required

string

taxCents

required

string

ttcCents

required

string

byActor

required

Array<object>

object

actorUserId

required

UserId de l’acteur (extrait de origin_reference)

string

count

required

integer

htCents

required

string

taxCents

required

string

ttcCents

required

string

derogations

required

object

totalGapCents

required

Σ(public − dérogé) sur la période (bigint centimes)

string

byReason

required

Array<object>

object

reason

required

string

count

required

integer

gapCents

required

string

totalRemisedCents

required

Σ remises TTC + Σ écarts dérogation (bigint centimes)

string

Example ^generated

{
  "data": {
    "establishmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "fromDate": "2026-04-15",
    "toDate": "2026-04-15",
    "discounts": {
      "totalHtCents": "example",
      "totalTaxCents": "example",
      "totalTtcCents": "example",
      "byReason": [
        {
          "reason": "example",
          "count": 1,
          "htCents": "example",
          "taxCents": "example",
          "ttcCents": "example"
        }
      ],
      "byActor": [
        {
          "actorUserId": "example",
          "count": 1,
          "htCents": "example",
          "taxCents": "example",
          "ttcCents": "example"
        }
      ]
    },
    "derogations": {
      "totalGapCents": "example",
      "byReason": [
        {
          "reason": "example",
          "count": 1,
          "gapCents": "example"
        }
      ]
    },
    "totalRemisedCents": "example"
  }
}

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 ou périmètre non vérifiable

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
}