Déclencher manuellement une relance de recouvrement

POST

/v1/accounts-receivable/accounts/{id}/dunning

curl --request POST \
  --url https://example.com/v1/accounts-receivable/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/dunning \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "receivableId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Émet une relance (DunningEvent append-only) sur la créance cible (ou la plus ancienne ouverte), au niveau de la politique de relance active applicable au retard. 404 si aucune politique active. Le PMS ne calcule pas les pénalités de retard.

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Identifiant du compte débiteur

Request Body

Media type application/json

object

receivableId

Créance cible (optionnel — défaut : la plus ancienne ouverte)

string format: uuid

Example ^generated

{
  "receivableId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

201

Relance émise

Media type application/json

object

data

required

object

dunningEventId

required

string format: uuid

receivableId

required

string format: uuid

levelNo

required

integer

channel

required

string

Allowed values: email postal sms phone_task

Example

{
  "data": {
    "channel": "email"
  }
}

400

Corps ou paramètres invalides

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

404

Compte ou politique de relance 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
}

409

Aucune créance ouverte à relancer

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
}