Générer le relevé d'un propriétaire pour une période (contrat + période)

POST

/v1/owners/{id}/statements

curl --request POST \
  --url https://example.com/v1/owners/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/statements \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "contractId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "periodFrom": "2026-04-15", "periodTo": "2026-04-15", "debitPolicy": "carry_over" }'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Header Parameters

Idempotency-Key

string

Clé d’idempotence (8–200 car.) — recommandée : anti-double-émission de relevé (NF203) au rejeu réseau

Request Body ^required

Agrège les parts de revenu calculées (statut computed) du contrat sur la période en un relevé émis (NF203, atomique).

Media type application/json

object

contractId

required

string format: uuid

periodFrom

required

Début de période (inclus), ISO YYYY-MM-DD

string format: date

periodTo

required

Fin de période (inclus), ISO YYYY-MM-DD

string format: date

debitPolicy

Défaut : carry_over

string

Allowed values: carry_over immediate_debit

Responses

201

Relevé généré et émis

Media type application/json

object

data

required

object

statementId

required

string format: uuid

shareCount

required

Nombre de parts de revenu incluses

integer

documentId

ID du PDF généré (null tant que le BC Document n’est pas raccordé)

string

nullable

Example ^generated

{
  "data": {
    "statementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "shareCount": 1,
    "documentId": "example"
  }
}

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 (owner.manage)

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
}

409

Aucune part de revenu calculée pour la période/contrat

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
}