Retirer des lignes d'une note de crédit

Nom de l'outilremove_credit_note_lines
ÉcritureDestructifIdempotent

Description

Texte exact envoyé au modèle par tools/list :

Retire des lignes d'une note de crédit en brouillon (champ id des lignes de get_credit_note) ; un titre, un sous-titre ou un ouvrage part avec toutes ses lignes. Avant l'appel, citer les lignes retirées, enfants compris, et attendre l'accord de l'utilisateur. Seul un brouillon (sans numéro, à éditer) change : le numéro d'une facture est légal et définitif. Oxygenius recalcule les prix, les sous-totaux, la TVA et les totaux comme l'écran du document. Rien n'est envoyé au client.

Accès requis

Paramètres

NomTypePrésenceDescription
creditNoteIdintegerobligatoireNote de crédit (champ id de search_credit_notes).
lineIdsinteger[]obligatoireLignes à retirer, 50 au plus.

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
NomTypePrésenceDescription
customerVatNumberstringpeut être nullNuméro de TVA du client imprimé sur la note de crédit.
customerAddressstringpeut être nullAdresse du client imprimée sur la note de crédit.
dossierIndicationstringpeut être nullIntitulé court du dossier.
structuredCommunicationstringpeut être nullCommunication structurée.
discountPercentagenumberpeut être nullRemise globale en pourcents.
discountAmountnumberpeut être nullMontant de la remise globale (hors TVA).
vatBreakdownobject[]Montant de TVA par taux.
vatBreakdown[].ratestringpeut être nullCode du taux de TVA (ex. 21, 6, CO pour cocontractant).
vatBreakdown[].percentagenumberpeut être nullPourcentage de TVA.
vatBreakdown[].amountnumberpeut être nullMontant de TVA à ce taux.
linesobjectLignes de la note de crédit.
lines.totalCountintegerNombre total de lignes du document.
lines.isTruncatedbooleanVrai si le document compte plus de lignes que celles renvoyées.
lines.itemsobject[]Lignes dans l'ordre du document.
lines.items[].idintegerIdentifiant de la ligne (lineId ou parentLineId des outils de modification d'un devis).
lines.items[].numberstringpeut être nullNuméro de la ligne tel qu'imprimé (ex. 1.2).
lines.items[].typestringsupertitle, title, subtitle, item (article) ou other.
lines.items[].isOptionbooleanVrai pour une ligne en option (variante), non comprise dans les totaux.
lines.items[].namestringpeut être nullLibellé de la ligne.
lines.items[].descriptionstringpeut être nullDescription détaillée.
lines.items[].quantitynumberpeut être nullQuantité (articles).
lines.items[].unitstringpeut être nullUnité (articles).
lines.items[].unitPricenumberpeut être nullPrix unitaire hors TVA (articles).
lines.items[].vatRatenumberpeut être nullTaux de TVA en pourcents (articles).
lines.items[].discountAmountnumberpeut être nullRemise accordée sur la ligne (articles).
lines.items[].amountExcludingVatnumberpeut être nullMontant hors TVA, net de la remise de la ligne (articles).
lines.items[].remarkstringpeut être nullRemarque imprimée sous la ligne (devis).
lines.items[].depositInvoiceIdintegerpeut être nullFacture d'acompte déduite par cette ligne (à passer à get_invoice).
invoiceIdintegerpeut être nullIdentifiant de la facture créditée (à passer à get_invoice), si la note en crédite une.
invoiceReferencestringpeut être nullNuméro de la facture créditée.
idintegerIdentifiant du document (à passer à l'outil de détail).
referencestringpeut être nullNuméro du document (vide pour un brouillon de facture ou de note de crédit).
statusstringpeut être nullStatut du document.
datestring (date)peut être nullDate du document.
customerstringpeut être nullClient tel qu'imprimé sur le document.
tiersIdintegerIdentifiant du tiers client (à passer à get_tiers).
dossierIdintegerIdentifiant du dossier (à passer à get_dossier).
dossierReferencestringpeut être nullRéférence du dossier.
amountExcludingVatnumberpeut être nullTotal hors TVA, net de la remise globale.
vatAmountnumberpeut être nullMontant de TVA.
amountIncludingVatnumberpeut être nullTotal TVA comprise.

Annotations MCP

AnnotationValeurSignification
titleRetirer des lignes d'une note de créditNom lisible affiché par le client MCP.
readOnlyHintnonL'outil ne modifie rien.
destructiveHintouiL'outil peut modifier ou supprimer des données existantes, ou déclencher une action irréversible.
idempotentHintouiRappeler l'outil avec les mêmes arguments n'a pas d'effet supplémentaire.
openWorldHintnonL'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": "remove_credit_note_lines",
  "title": "Retirer des lignes d'une note de crédit",
  "description": "Retire des lignes d'une note de crédit en brouillon (champ id des lignes de get_credit_note) ; un titre, un sous-titre ou un ouvrage part avec toutes ses lignes. Avant l'appel, citer les lignes retirées, enfants compris, et attendre l'accord de l'utilisateur. Seul un brouillon (sans numéro, à éditer) change : le numéro d'une facture est légal et définitif. Oxygenius recalcule les prix, les sous-totaux, la TVA et les totaux comme l'écran du document. Rien n'est envoyé au client.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "creditNoteId": {
        "description": "Note de crédit (champ id de search_credit_notes).",
        "type": "integer"
      },
      "lineIds": {
        "description": "Lignes à retirer, 50 au plus.",
        "type": "array",
        "items": {
          "type": "integer"
        }
      }
    },
    "required": [
      "creditNoteId",
      "lineIds"
    ]
  },
  "outputSchema": {
    "type": "object",
    "properties": {
      "customerVatNumber": {
        "description": "Numéro de TVA du client imprimé sur la note de crédit.",
        "type": [
          "string",
          "null"
        ]
      },
      "customerAddress": {
        "description": "Adresse du client imprimée sur la note de crédit.",
        "type": [
          "string",
          "null"
        ]
      },
      "dossierIndication": {
        "description": "Intitulé court du dossier.",
        "type": [
          "string",
          "null"
        ]
      },
      "structuredCommunication": {
        "description": "Communication structurée.",
        "type": [
          "string",
          "null"
        ]
      },
      "discountPercentage": {
        "description": "Remise globale en pourcents.",
        "type": [
          "number",
          "null"
        ]
      },
      "discountAmount": {
        "description": "Montant de la remise globale (hors TVA).",
        "type": [
          "number",
          "null"
        ]
      },
      "vatBreakdown": {
        "description": "Montant de TVA par taux.",
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "rate": {
              "description": "Code du taux de TVA (ex. 21, 6, CO pour cocontractant).",
              "type": [
                "string",
                "null"
              ]
            },
            "percentage": {
              "description": "Pourcentage de TVA.",
              "type": [
                "number",
                "null"
              ]
            },
            "amount": {
              "description": "Montant de TVA à ce taux.",
              "type": [
                "number",
                "null"
              ]
            }
          }
        }
      },
      "lines": {
        "description": "Lignes de la note de crédit.",
        "type": "object",
        "properties": {
          "totalCount": {
            "description": "Nombre total de lignes du document.",
            "type": "integer"
          },
          "isTruncated": {
            "description": "Vrai si le document compte plus de lignes que celles renvoyées.",
            "type": "boolean"
          },
          "items": {
            "description": "Lignes dans l'ordre du document.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Identifiant de la ligne (lineId ou parentLineId des outils de modification d'un devis).",
                  "type": "integer"
                },
                "number": {
                  "description": "Numéro de la ligne tel qu'imprimé (ex. 1.2).",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "type": {
                  "description": "supertitle, title, subtitle, item (article) ou other.",
                  "type": "string"
                },
                "isOption": {
                  "description": "Vrai pour une ligne en option (variante), non comprise dans les totaux.",
                  "type": "boolean"
                },
                "name": {
                  "description": "Libellé de la ligne.",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "description": {
                  "description": "Description détaillée.",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "quantity": {
                  "description": "Quantité (articles).",
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "unit": {
                  "description": "Unité (articles).",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "unitPrice": {
                  "description": "Prix unitaire hors TVA (articles).",
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "vatRate": {
                  "description": "Taux de TVA en pourcents (articles).",
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "discountAmount": {
                  "description": "Remise accordée sur la ligne (articles).",
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "amountExcludingVat": {
                  "description": "Montant hors TVA, net de la remise de la ligne (articles).",
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "remark": {
                  "description": "Remarque imprimée sous la ligne (devis).",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "depositInvoiceId": {
                  "description": "Facture d'acompte déduite par cette ligne (à passer à get_invoice).",
                  "type": [
                    "integer",
                    "null"
                  ]
                }
              },
              "required": [
                "type"
              ]
            }
          }
        },
        "required": [
          "totalCount",
          "isTruncated",
          "items"
        ]
      },
      "invoiceId": {
        "description": "Identifiant de la facture créditée (à passer à get_invoice), si la note en crédite une.",
        "type": [
          "integer",
          "null"
        ]
      },
      "invoiceReference": {
        "description": "Numéro de la facture créditée.",
        "type": [
          "string",
          "null"
        ]
      },
      "id": {
        "description": "Identifiant du document (à passer à l'outil de détail).",
        "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 du document.",
        "type": [
          "string",
          "null"
        ]
      },
      "date": {
        "description": "Date du document.",
        "type": [
          "string",
          "null"
        ],
        "format": "date"
      },
      "customer": {
        "description": "Client tel qu'imprimé sur le document.",
        "type": [
          "string",
          "null"
        ]
      },
      "tiersId": {
        "description": "Identifiant du tiers client (à passer à get_tiers).",
        "type": "integer"
      },
      "dossierId": {
        "description": "Identifiant du dossier (à passer à get_dossier).",
        "type": "integer"
      },
      "dossierReference": {
        "description": "Référence du dossier.",
        "type": [
          "string",
          "null"
        ]
      },
      "amountExcludingVat": {
        "description": "Total hors TVA, net de la remise globale.",
        "type": [
          "number",
          "null"
        ]
      },
      "vatAmount": {
        "description": "Montant de TVA.",
        "type": [
          "number",
          "null"
        ]
      },
      "amountIncludingVat": {
        "description": "Total TVA comprise.",
        "type": [
          "number",
          "null"
        ]
      }
    },
    "required": [
      "lines",
      "id",
      "tiersId",
      "dossierId"
    ]
  },
  "annotations": {
    "title": "Retirer des lignes d'une note de crédit",
    "destructiveHint": true,
    "idempotentHint": true,
    "openWorldHint": false,
    "readOnlyHint": false
  }
}