Rechercher des notes de crédit
Nom de l'outil
search_credit_notesLecture seuleIdempotent
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.
Accès requis
- Permission :
credit-note.list.view - Sans ces conditions, l'outil n'apparaît pas dans
tools/listet son appel est refusé.
Paramètres
| Nom | Type | Présence | Description |
|---|---|---|---|
query | string | facultatif | Mots-clés : numéro, communication structurée, client, numéro de la facture, référence ou intitulé du dossier. |
dossierId | integer | facultatif | Identifiant d'un dossier pour n'avoir que ses notes de crédit. |
invoiceId | integer | facultatif | Identifiant d'une facture pour n'avoir que les notes qui la créditent. |
tiersId | integer | facultatif | Identifiant d'un tiers pour n'avoir que ses notes de crédit. |
status | string | facultatif | all (défaut), draft (en édition), validated (validée, envoyée ou imprimée) ou canceled. |
from | string (date) | facultatif | Premier jour de la date de la note (AAAA-MM-JJ). |
to | string (date) | facultatif | Dernier jour de la date de la note (AAAA-MM-JJ), inclus. |
limit | integer | facultatif | Nombre de résultats souhaités (10 par défaut, plafonné par le serveur). |
offset | integer | facultatif | Nombre de résultats à sauter pour la pagination (0 par défaut). |
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 |
|---|---|---|---|
totalCount | integer | Nombre total d'éléments correspondant aux critères. | |
offset | integer | Position du premier élément de la page. | |
limit | integer | Taille de page appliquée (le serveur plafonne la valeur demandée). | |
hasMore | boolean | Vrai s'il reste des éléments : rappeler l'outil avec offset = offset + limit. | |
items | object[] | Éléments de la page. | |
items[].invoiceId | integer | peut être null | Identifiant de la facture créditée (à passer à get_invoice), si la note en crédite une. |
items[].invoiceReference | string | peut être null | Numéro de la facture créditée. |
items[].id | integer | Identifiant du document (à passer à l'outil de détail). | |
items[].reference | string | peut être null | Numéro du document (vide pour un brouillon de facture ou de note de crédit). |
items[].status | string | peut être null | Statut du document. |
items[].date | string (date) | peut être null | Date du document. |
items[].customer | string | peut être null | Client tel qu'imprimé sur le document. |
items[].tiersId | integer | Identifiant du tiers client (à passer à get_tiers). | |
items[].dossierId | integer | Identifiant du dossier (à passer à get_dossier). | |
items[].dossierReference | string | peut être null | Référence du dossier. |
items[].amountExcludingVat | number | peut être null | Total hors TVA, net de la remise globale. |
items[].vatAmount | number | peut être null | Montant de TVA. |
items[].amountIncludingVat | number | peut être null | Total TVA comprise. |
Annotations MCP
| Annotation | Valeur | Signification |
|---|---|---|
title | Rechercher des notes de crédit | Nom lisible affiché par le client MCP. |
readOnlyHint | oui | 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": "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
}
}