Estimer la taxe de séjour d'une réservation (lecture seule, sans écriture folio)

GET

/v1/reservations/{id}/tourist-tax-estimate

curl --request GET \
  --url https://example.com/v1/reservations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/tourist-tax-estimate \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Estimation de taxe de séjour (disponible ou raison d’absence)

Media type application/json

object

data

required

object

available

required

True si le calcul a pu être effectué (barème trouvé, données suffisantes).

boolean

reason

Raison de non-disponibilité : no_tax_profile = établissement sans commune/classement ; no_rule = aucun barème actif à la date d’arrivée ; needs_confirmation = mode non-classé sans snapshotRate (résa non encore confirmée).

string

nullable

Allowed values: no_tax_profile no_rule needs_confirmation

netTaxCents

Taxe communale nette (bigint string centimes). Disponible si available=true.

string

nullable

additionnelleDeptCents

Additionnelle départementale (bigint string centimes). Disponible si available=true.

string

nullable

additionnelleRegionCents

Additionnelle régionale IDF (bigint string centimes, 0 si hors IDF). Disponible si available=true.

string

nullable

totalCents

Total taxe collectée (bigint string centimes). Disponible si available=true.

string

nullable

currency

Devise du barème. Disponible si available=true.

string

nullable

calcMode

Mode de calcul du barème appliqué.

string

nullable

Allowed values: per_person_per_night per_room_per_night

assujettiCount

Nombre d’adultes assujettis utilisés dans le calcul (headcountAdults V1).

integer

nullable

nights

Nombre de nuits (LOS de la réservation).

integer

nullable

Example

{
  "data": {
    "reason": "no_tax_profile",
    "currency": "EUR",
    "calcMode": "per_person_per_night"
  }
}

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 scope IDOR

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
}

404

Réservation introuvable

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
}