Aller au contenu

Void unitaire d'une charge (contre-écriture NF203 — manager-only, cat-E)

POST
/v1/folios/{id}/entries/{entryId}/void
curl --request POST \
--url https://example.com/v1/folios/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/entries/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/void \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "originReference": "example" }'
id
required
string format: uuid

Identifiant du folio

entryId
required
string format: uuid

Identifiant de l’écriture à annuler

Idempotency-Key
string

Clé d’idempotence (8–200 car.) — optionnelle ; l’agrégat est déjà idempotent par construction

OriginReference = libellé NF203 (optionnel, défaut = “manager_void_entry”). businessDate dérivée côté SERVEUR (ADR-00D78) — ne pas envoyer.

Media type application/json
object
originReference
string
>= 1 characters <= 200 characters
Example generated
{
"originReference": "example"
}

Void effectué — contre-écriture ajoutée (reversal)

Media type application/json
object
data
required
object
folioId
required
string format: uuid
entryId
required
string format: uuid
reversalEntryId
required
string format: uuid
Example generated
{
"data": {
"folioId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"entryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"reversalEntryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}
}

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
}

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
}

Permission refusée ou périmètre fiscal 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
}

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

Folio non-open ou écriture déjà annulée/transférée (double-void interdit)

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
}