Rechercher des notes de crédit

Nom de l'outilsearch_credit_notes
Lecture seuleIdempotent

Description

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

Liste ou recherche les notes de crédit Oxygenius, de la plus récente à la plus ancienne. Filtrer par dossierId pour toutes celles d'un dossier, par invoiceId pour celles d'une facture. Les montants sont positifs (ils viennent en déduction). Montants en euros ; le total hors TVA est net de la remise globale. Utiliser get_credit_note pour les lignes.

Accès requis

Paramètres

NomTypePrésenceDescription
querystringfacultatifMots-clés : numéro, communication structurée, client, numéro de la facture, référence ou intitulé du dossier.
dossierIdintegerfacultatifIdentifiant d'un dossier pour n'avoir que ses notes de crédit.
invoiceIdintegerfacultatifIdentifiant d'une facture pour n'avoir que les notes qui la créditent.
tiersIdintegerfacultatifIdentifiant d'un tiers pour n'avoir que ses notes de crédit.
statusstringfacultatifall (défaut), draft (en édition), validated (validée, envoyée ou imprimée) ou canceled.
fromstring (date)facultatifPremier jour de la date de la note (AAAA-MM-JJ).
tostring (date)facultatifDernier jour de la date de la note (AAAA-MM-JJ), inclus.
limitintegerfacultatifNombre de résultats souhaités (10 par défaut, plafonné par le serveur).
Par défaut : 10
offsetintegerfacultatifNombre de résultats à sauter pour la pagination (0 par défaut).
Par défaut : 0

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
totalCountintegerNombre total d'éléments correspondant aux critères.
offsetintegerPosition du premier élément de la page.
limitintegerTaille de page appliquée (le serveur plafonne la valeur demandée).
hasMorebooleanVrai s'il reste des éléments : rappeler l'outil avec offset = offset + limit.
itemsobject[]Éléments de la page.
items[].invoiceIdintegerpeut être nullIdentifiant de la facture créditée (à passer à get_invoice), si la note en crédite une.
items[].invoiceReferencestringpeut être nullNuméro de la facture créditée.
items[].idintegerIdentifiant du document (à passer à l'outil de détail).
items[].referencestringpeut être nullNuméro du document (vide pour un brouillon de facture ou de note de crédit).
items[].statusstringpeut être nullStatut du document.
items[].datestring (date)peut être nullDate du document.
items[].customerstringpeut être nullClient tel qu'imprimé sur le document.
items[].tiersIdintegerIdentifiant du tiers client (à passer à get_tiers).
items[].dossierIdintegerIdentifiant du dossier (à passer à get_dossier).
items[].dossierReferencestringpeut être nullRéférence du dossier.
items[].amountExcludingVatnumberpeut être nullTotal hors TVA, net de la remise globale.
items[].vatAmountnumberpeut être nullMontant de TVA.
items[].amountIncludingVatnumberpeut être nullTotal TVA comprise.

Annotations MCP

AnnotationValeurSignification
titleRechercher des notes de créditNom lisible affiché par le client MCP.
readOnlyHintouiL'outil ne modifie rien.
destructiveHintnonL'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": "search_credit_notes",
  "title": "Rechercher des notes de crédit",
  "description": "Liste ou recherche les notes de crédit Oxygenius, de la plus récente à la plus ancienne. Filtrer par dossierId pour toutes celles d'un dossier, par invoiceId pour celles d'une facture. Les montants sont positifs (ils viennent en déduction). Montants en euros ; le total hors TVA est net de la remise globale. Utiliser get_credit_note pour les lignes.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "query": {
        "description": "Mots-clés : numéro, communication structurée, client, numéro de la facture, référence ou intitulé du dossier.",
        "type": [
          "string",
          "null"
        ],
        "default": null
      },
      "dossierId": {
        "description": "Identifiant d'un dossier pour n'avoir que ses notes de crédit.",
        "type": [
          "integer",
          "null"
        ],
        "default": null
      },
      "invoiceId": {
        "description": "Identifiant d'une facture pour n'avoir que les notes qui la créditent.",
        "type": [
          "integer",
          "null"
        ],
        "default": null
      },
      "tiersId": {
        "description": "Identifiant d'un tiers pour n'avoir que ses notes de crédit.",
        "type": [
          "integer",
          "null"
        ],
        "default": null
      },
      "status": {
        "description": "all (défaut), draft (en édition), validated (validée, envoyée ou imprimée) ou canceled.",
        "type": [
          "string",
          "null"
        ],
        "default": null
      },
      "from": {
        "description": "Premier jour de la date de la note (AAAA-MM-JJ).",
        "type": [
          "string",
          "null"
        ],
        "format": "date",
        "default": null
      },
      "to": {
        "description": "Dernier jour de la date de la note (AAAA-MM-JJ), inclus.",
        "type": [
          "string",
          "null"
        ],
        "format": "date",
        "default": null
      },
      "limit": {
        "description": "Nombre de résultats souhaités (10 par défaut, plafonné par le serveur).",
        "type": "integer",
        "default": 10
      },
      "offset": {
        "description": "Nombre de résultats à sauter pour la pagination (0 par défaut).",
        "type": "integer",
        "default": 0
      }
    }
  },
  "outputSchema": {
    "type": "object",
    "properties": {
      "totalCount": {
        "description": "Nombre total d'éléments correspondant aux critères.",
        "type": "integer"
      },
      "offset": {
        "description": "Position du premier élément de la page.",
        "type": "integer"
      },
      "limit": {
        "description": "Taille de page appliquée (le serveur plafonne la valeur demandée).",
        "type": "integer"
      },
      "hasMore": {
        "description": "Vrai s'il reste des éléments : rappeler l'outil avec offset = offset + limit.",
        "type": "boolean"
      },
      "items": {
        "description": "Éléments de la page.",
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "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": [
            "id",
            "tiersId",
            "dossierId"
          ]
        }
      }
    },
    "required": [
      "totalCount",
      "offset",
      "limit",
      "hasMore",
      "items"
    ]
  },
  "annotations": {
    "title": "Rechercher des notes de crédit",
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false,
    "readOnlyHint": true
  }
}