Consulter un avoir et son statut

GET

/v1/credit-notes/{creditNoteId}

curl --request GET \
  --url http://localhost:4000/v1/credit-notes/example \
  --header 'Authorization: Bearer <token>'

• Développement local

Authorizations

• bearerAuth

Parameters

Path Parameters

creditNoteId

required

string

Identifiant attribué par la passerelle.

Responses

200

Avoir et dernier statut connu.

Media typeapplication/json

object

submission_id

required

Identifiant attribué par la passerelle.

string

saas_id

required

Identifiant côté SaaS (id fourni au dépôt).

string

number

string

processing_state

required

État de traitement dans la passerelle, indépendant des statuts PA 200 à 214. received → validated → sent ; rejected si la validation ou la PA refuse définitivement. Seul received est produit aujourd’hui.

string

Allowed values: received validated sent rejected

lifecycle_status

Dernier statut PA connu ; absent tant que la PA n’a rien renvoyé.

object

code

required

Statut du cycle de vie (référentiel 02 §17) : 200 Déposée, 201 Émise, 202 Reçue, 203 Mise à disposition, 204 Prise en charge, 205 Approuvée, 206 Approuvée partiellement, 207 En litige, 208 Suspendue, 209 Complétée, 210 Refusée, 211 Paiement transmis, 212 Encaissée, 213 Rejetée, 214 Visée (à vérifier : absent du référentiel 02).

integer

>= 200 <= 214

label

string

occurred_at

required

string format: date-time

reason

Motif, notamment pour 210 et 213.

string

origin_submission_id

Avoirs uniquement. Dépôt de la facture d’origine (piste d’audit).

string

created_at

required

string format: date-time

Example

{
  "processing_state": "received"
}

401

Jeton absent ou invalide.

Media typeapplication/problem+json

Erreur au format RFC 9457.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

submission_id

Dépôt existant, pour un doublon (409).

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "submission_id": "example"
}

404

Ressource inconnue.

Media typeapplication/problem+json

Erreur au format RFC 9457.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

submission_id

Dépôt existant, pour un doublon (409).

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "submission_id": "example"
}

500

Erreur interne (message générique, détail dans les logs du serveur).

Media typeapplication/problem+json

Erreur au format RFC 9457.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

submission_id

Dépôt existant, pour un doublon (409).

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "submission_id": "example"
}