Aller au contenu

Détail d'un contrat saisonnier

GET
/v1/long-stay-contracts/{id}
curl --request GET \
--url https://example.com/v1/long-stay-contracts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'X-API-Key: <X-API-Key>'
id
required
string format: uuid

Détail du contrat saisonnier

Media type application/json
object
data
required
object
id
required
string format: uuid
establishmentId
required
string format: uuid
guestProfileId
required
string format: uuid
status
required
string
Allowed values: draft active terminated renewed
target
required
object
kind
string
unitId
string
nullable
unitType
string
nullable
period
required
object
start
string format: date
end
string format: date
nullable
totalAmountCents
required

Montant total en centimes (bigint string)

string
currency
required
string
Allowed values: EUR GBP
installments
required
Array<object>
object
id
string
seqNo
integer
dueDate
string format: date
amountCents
string
currency
string
status
string
Example
{
"data": {
"status": "draft",
"currency": "EUR"
}
}

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
}

Contrat 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
}