Préparer la numérotation d'une note de crédit

Tool nameprepare_credit_note_finalization
WriteIdempotentPrepares an action, no effect

Changes nothing: shows what numbering a draft credit note will do, including its effect on the credited invoice, and returns a 10-minute confirmation token.

Description

Exact text sent to the model by tools/list (French, the language of the data):

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.

Required access

Parameters

NameTypePresenceDescription
creditNoteIdintegerrequiredNote de crédit (champ id de search_credit_notes).

Result

The result is returned as structured content (structuredContent) matching the output schema below, and as JSON text for clients that do not read structured content. An error comes back with isError: true and a French message that explains what to fix.

Result fields
NameTypePresenceDescription
actionstringAction préparée, et outil qui l'exécute avec le jeton.
documentobjectDocument visé, tel qu'il est enregistré : le montrer à l'utilisateur.
document.kindstringestimate (devis), invoice (facture) ou credit_note (note de crédit).
document.idintegerIdentifiant du document.
document.referencestringnullableNuméro du document (vide pour un brouillon de facture ou de note de crédit).
document.statusstringnullableStatut actuel.
document.datestring (date)nullableDate du document.
document.customerstringnullableClient facturé.
document.dossierIdintegernullableDossier du document.
document.amountExcludingVatnumbernullableTotal hors TVA, en euros.
document.amountIncludingVatnumbernullableTotal TVA comprise, en euros.
effectsstring[]Ce que l'action déclenche dans Oxygenius et au dehors : à annoncer à l'utilisateur.
warningsstring[]Points à signaler à l'utilisateur avant qu'il décide.
confirmationTokenstringJeton à passer à l'outil de l'action, seulement après l'accord explicite de l'utilisateur sur ce document et ces effets.
expiresAtstring (date-time)Échéance du jeton (10 minutes) ; au-delà, ou si le document change, préparer à nouveau.

MCP annotations

AnnotationValueMeaning
titlePréparer la numérotation d'une note de créditHuman-readable name shown by the MCP client.
readOnlyHintnoThe tool changes nothing.
destructiveHintnoThe tool may change or delete existing data, or trigger an irreversible action.
idempotentHintyesCalling it again with the same arguments has no further effect.
openWorldHintnoThe tool reads e-mails or document content, or reaches an external service.

JSON definition

Exact tools/list entry
{
  "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
  }
}