Passer toutes les écritures du folio en void (contre-écriture NF203 — manager-only)

POST

/v1/folios/{id}/void-all

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

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Identifiant du folio

Request Body ^required

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

Media type application/json

object

originReference

string

>= 1 characters <= 200 characters

Example ^generated

{
  "originReference": "example"
}

Responses

200

Void effectué — toutes les écritures posted ont reçu une contre-écriture

Media type application/json

object

data

required

object

folioId

required

string format: uuid

voided

required

boolean

Example ^generated

{
  "data": {
    "folioId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "voided": true
  }
}

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 fiscal non vérifiable (fail-closed)

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

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
}