Retourne la politique de relance active du tenant

GET

/v1/dunning-policy

curl --request GET \
  --url https://example.com/v1/dunning-policy \
  --header 'X-API-Key: <X-API-Key>'

Retourne la politique de relance actuellement active. 404 si aucune politique n’est configurée.

Authorizations

• ApiKeyAuth
• BearerAuth

Responses

200

Politique active

Media type application/json

object

data

required

object

id

required

string format: uuid

name

required

string

active

required

boolean

levels

required

Array<object>

object

levelNo

required

integer

>= 1

triggerDaysAfterDue

required

integer

channel

required

string

Allowed values: email postal sms phone_task

templateRef

required

string

escalatesToLitigation

required

boolean

Example

{
  "data": {
    "name": "Standard",
    "levels": [
      {
        "channel": "email"
      }
    ]
  }
}

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

Aucune politique configurée

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
}