Aller au contenu

Lister les relevés d'un propriétaire (dernier relevé par contrat actif)

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

Relevés du propriétaire

Media type application/json
object
data
required
Array<object>
object
id
required
string format: uuid
ownerId
required
string format: uuid
contractId
required
string format: uuid
periodFrom
required
string format: date
periodTo
required
string format: date
currency
required
string
status
required
string
netPayableCents
required

Montant net payable en centimes (bigint string)

string
Example generated
{
"data": [
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"ownerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"contractId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"periodFrom": "2026-04-15",
"periodTo": "2026-04-15",
"currency": "example",
"status": "example",
"netPayableCents": "example"
}
]
}

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
}

Propriétaire 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
}