Rechercher des devis
Nom de l'outil
search_estimatesLecture seuleIdempotent
Description
Liste ou recherche les devis Oxygenius (avenants et versions compris), du plus récent au plus ancien. Filtrer par dossierId pour tous les devis d'un dossier, par tiersId pour ceux d'un client. Montants en euros ; le total hors TVA est net de la remise globale. Utiliser get_estimate pour les lignes, avenants et factures liées.
Accès requis
- Permission :
estimate.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 ou intitulé du devis, client, référence ou intitulé du dossier. |
dossierId | integer | facultatif | Identifiant d'un dossier pour n'avoir que ses devis. |
tiersId | integer | facultatif | Identifiant d'un tiers pour n'avoir que ses devis. |
status | string | facultatif | all (défaut), draft (en édition), sent (envoyé ou imprimé), accepted, refused ou canceled. |
from | string (date) | facultatif | Premier jour de la date du devis (AAAA-MM-JJ). |
to | string (date) | facultatif | Dernier jour de la date du devis (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[].title | string | peut être null | Intitulé du devis. |
items[].type | string | peut être null | Type : devis ou contrat. |
items[].validUntil | string (date) | peut être null | Date de fin de validité de l'offre. |
items[].isAmendment | boolean | Vrai pour un avenant (travaux complémentaires d'un devis). | |
items[].parentEstimateId | integer | peut être null | Pour un avenant : identifiant du devis principal. |
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 devis | 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_estimates",
"title": "Rechercher des devis",
"description": "Liste ou recherche les devis Oxygenius (avenants et versions compris), du plus récent au plus ancien. Filtrer par dossierId pour tous les devis d'un dossier, par tiersId pour ceux d'un client. Montants en euros ; le total hors TVA est net de la remise globale. Utiliser get_estimate pour les lignes, avenants et factures liées.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"description": "Mots-clés : numéro ou intitulé du devis, client, référence ou intitulé du dossier.",
"type": [
"string",
"null"
],
"default": null
},
"dossierId": {
"description": "Identifiant d'un dossier pour n'avoir que ses devis.",
"type": [
"integer",
"null"
],
"default": null
},
"tiersId": {
"description": "Identifiant d'un tiers pour n'avoir que ses devis.",
"type": [
"integer",
"null"
],
"default": null
},
"status": {
"description": "all (défaut), draft (en édition), sent (envoyé ou imprimé), accepted, refused ou canceled.",
"type": [
"string",
"null"
],
"default": null
},
"from": {
"description": "Premier jour de la date du devis (AAAA-MM-JJ).",
"type": [
"string",
"null"
],
"format": "date",
"default": null
},
"to": {
"description": "Dernier jour de la date du devis (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": {
"title": {
"description": "Intitulé du devis.",
"type": [
"string",
"null"
]
},
"type": {
"description": "Type : devis ou contrat.",
"type": [
"string",
"null"
]
},
"validUntil": {
"description": "Date de fin de validité de l'offre.",
"type": [
"string",
"null"
],
"format": "date"
},
"isAmendment": {
"description": "Vrai pour un avenant (travaux complémentaires d'un devis).",
"type": "boolean"
},
"parentEstimateId": {
"description": "Pour un avenant : identifiant du devis principal.",
"type": [
"integer",
"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 devis",
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": true
}
}