Rechercher des notes de crédit

Tool namesearch_credit_notes
Read-onlyIdempotent

Lists or searches credit notes, newest first, with filters by project, invoice, customer, status and dates.

Description

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

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.

Required access

Parameters

NameTypePresenceDescription
querystringoptionalMots-clés : numéro, communication structurée, client, numéro de la facture, référence ou intitulé du dossier.
dossierIdintegeroptionalIdentifiant d'un dossier pour n'avoir que ses notes de crédit.
invoiceIdintegeroptionalIdentifiant d'une facture pour n'avoir que les notes qui la créditent.
tiersIdintegeroptionalIdentifiant d'un tiers pour n'avoir que ses notes de crédit.
statusstringoptionalall (défaut), draft (en édition), validated (validée, envoyée ou imprimée) ou canceled.
fromstring (date)optionalPremier jour de la date de la note (AAAA-MM-JJ).
tostring (date)optionalDernier jour de la date de la note (AAAA-MM-JJ), inclus.
limitintegeroptionalNombre de résultats souhaités (10 par défaut, plafonné par le serveur).
Default : 10
offsetintegeroptionalNombre de résultats à sauter pour la pagination (0 par défaut).
Default : 0

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
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[].invoiceIdintegernullableIdentifiant de la facture créditée (à passer à get_invoice), si la note en crédite une.
items[].invoiceReferencestringnullableNuméro de la facture créditée.
items[].idintegerIdentifiant du document (à passer à l'outil de détail).
items[].referencestringnullableNuméro du document (vide pour un brouillon de facture ou de note de crédit).
items[].statusstringnullableStatut du document.
items[].datestring (date)nullableDate du document.
items[].customerstringnullableClient tel qu'imprimé sur le document.
items[].tiersIdintegerIdentifiant du tiers client (à passer à get_tiers).
items[].dossierIdintegerIdentifiant du dossier (à passer à get_dossier).
items[].dossierReferencestringnullableRéférence du dossier.
items[].amountExcludingVatnumbernullableTotal hors TVA, net de la remise globale.
items[].vatAmountnumbernullableMontant de TVA.
items[].amountIncludingVatnumbernullableTotal TVA comprise.

MCP annotations

AnnotationValueMeaning
titleRechercher des notes de créditHuman-readable name shown by the MCP client.
readOnlyHintyesThe 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": "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
  }
}