Préparer la numérotation d'une note de crédit
prepare_credit_note_finalizationDescription
Prépare la numérotation d'une note de crédit en brouillon (finalize_credit_note) : numéro légal définitif, PDF et UBL, statut Imprimé, crédit au compte client, effet sur la facture créditée (solde diminué, ou facture annulée par une note de son montant), envoi automatique au comptable selon le réglage de la société. Refusée pour une note sans ligne, annulée ou déjà numérotée, ou qui crédite une facture non numérotée, annulée ou payée, ou qui annulerait une facture et délierait ses paiements. Ne change rien : renvoie le document tel qu'il est enregistré, les effets de l'action et les points d'attention, et un jeton de confirmation valable 10 minutes. Montrer le tout à l'utilisateur et attendre son accord explicite avant l'outil de l'action ; un document modifié ensuite doit être préparé à nouveau.
Accès requis
- Permission :
credit-note.list.view - Société ouverte aux outils d'écriture (Paramètres → Intégration IA).
- Sans ces conditions, l'outil n'apparaît pas dans
tools/listet son appel est refusé.
Paramètres
| Nom | Type | Présence | Description |
|---|---|---|---|
creditNoteId | integer | obligatoire | Note de crédit (champ id de search_credit_notes). |
Résultat
Le résultat est renvoyé en contenu structuré (structuredContent), conforme au schéma de sortie ci-dessous, et en texte JSON pour les clients qui ne lisent pas le contenu structuré. Une erreur est renvoyée avec isError: true et un message en français qui explique quoi corriger.
Champs du résultat
| Nom | Type | Présence | Description |
|---|---|---|---|
action | string | Action préparée, et outil qui l'exécute avec le jeton. | |
document | object | Document visé, tel qu'il est enregistré : le montrer à l'utilisateur. | |
document.kind | string | estimate (devis), invoice (facture) ou credit_note (note de crédit). | |
document.id | integer | Identifiant du document. | |
document.reference | string | peut être null | Numéro du document (vide pour un brouillon de facture ou de note de crédit). |
document.status | string | peut être null | Statut actuel. |
document.date | string (date) | peut être null | Date du document. |
document.customer | string | peut être null | Client facturé. |
document.dossierId | integer | peut être null | Dossier du document. |
document.amountExcludingVat | number | peut être null | Total hors TVA, en euros. |
document.amountIncludingVat | number | peut être null | Total TVA comprise, en euros. |
effects | string[] | Ce que l'action déclenche dans Oxygenius et au dehors : à annoncer à l'utilisateur. | |
warnings | string[] | Points à signaler à l'utilisateur avant qu'il décide. | |
confirmationToken | string | Jeton à passer à l'outil de l'action, seulement après l'accord explicite de l'utilisateur sur ce document et ces effets. | |
expiresAt | string (date-time) | Échéance du jeton (10 minutes) ; au-delà, ou si le document change, préparer à nouveau. |
Annotations MCP
| Annotation | Valeur | Signification |
|---|---|---|
title | Préparer la numérotation d'une note de crédit | Nom lisible affiché par le client MCP. |
readOnlyHint | non | L'outil ne modifie rien. |
destructiveHint | non | L'outil peut modifier ou supprimer des données existantes, ou déclencher une action irréversible. |
idempotentHint | oui | Rappeler l'outil avec les mêmes arguments n'a pas d'effet supplémentaire. |
openWorldHint | non | L'outil lit des courriels ou le contenu d'un document, ou contacte un service extérieur. |
Définition JSON
Entrée exacte de tools/list
{
"name": "prepare_credit_note_finalization",
"title": "Préparer la numérotation d'une note de crédit",
"description": "Prépare la numérotation d'une note de crédit en brouillon (finalize_credit_note) : numéro légal définitif, PDF et UBL, statut Imprimé, crédit au compte client, effet sur la facture créditée (solde diminué, ou facture annulée par une note de son montant), envoi automatique au comptable selon le réglage de la société. Refusée pour une note sans ligne, annulée ou déjà numérotée, ou qui crédite une facture non numérotée, annulée ou payée, ou qui annulerait une facture et délierait ses paiements. Ne change rien : renvoie le document tel qu'il est enregistré, les effets de l'action et les points d'attention, et un jeton de confirmation valable 10 minutes. Montrer le tout à l'utilisateur et attendre son accord explicite avant l'outil de l'action ; un document modifié ensuite doit être préparé à nouveau.",
"inputSchema": {
"type": "object",
"properties": {
"creditNoteId": {
"description": "Note de crédit (champ id de search_credit_notes).",
"type": "integer"
}
},
"required": [
"creditNoteId"
]
},
"outputSchema": {
"type": "object",
"properties": {
"action": {
"description": "Action préparée, et outil qui l'exécute avec le jeton.",
"type": "string"
},
"document": {
"description": "Document visé, tel qu'il est enregistré : le montrer à l'utilisateur.",
"type": "object",
"properties": {
"kind": {
"description": "estimate (devis), invoice (facture) ou credit_note (note de crédit).",
"type": "string"
},
"id": {
"description": "Identifiant du document.",
"type": "integer"
},
"reference": {
"description": "Numéro du document (vide pour un brouillon de facture ou de note de crédit).",
"type": [
"string",
"null"
]
},
"status": {
"description": "Statut actuel.",
"type": [
"string",
"null"
]
},
"date": {
"description": "Date du document.",
"type": [
"string",
"null"
],
"format": "date"
},
"customer": {
"description": "Client facturé.",
"type": [
"string",
"null"
]
},
"dossierId": {
"description": "Dossier du document.",
"type": [
"integer",
"null"
]
},
"amountExcludingVat": {
"description": "Total hors TVA, en euros.",
"type": [
"number",
"null"
]
},
"amountIncludingVat": {
"description": "Total TVA comprise, en euros.",
"type": [
"number",
"null"
]
}
},
"required": [
"kind",
"id"
]
},
"effects": {
"description": "Ce que l'action déclenche dans Oxygenius et au dehors : à annoncer à l'utilisateur.",
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"description": "Points à signaler à l'utilisateur avant qu'il décide.",
"type": "array",
"items": {
"type": "string"
}
},
"confirmationToken": {
"description": "Jeton à passer à l'outil de l'action, seulement après l'accord explicite de l'utilisateur sur ce document et ces effets.",
"type": "string"
},
"expiresAt": {
"description": "Échéance du jeton (10 minutes) ; au-delà, ou si le document change, préparer à nouveau.",
"type": "string",
"format": "date-time"
}
},
"required": [
"action",
"document",
"confirmationToken",
"expiresAt"
]
},
"annotations": {
"title": "Préparer la numérotation d'une note de crédit",
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": false
}
}