Rechercher des devis

Tool namesearch_estimates
Read-onlyIdempotent

Lists or searches estimates, including amendments and versions, newest first, with filters by project, customer, status and dates.

Description

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

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.

Required access

Parameters

NameTypePresenceDescription
querystringoptionalMots-clés : numéro ou intitulé du devis, client, référence ou intitulé du dossier.
dossierIdintegeroptionalIdentifiant d'un dossier pour n'avoir que ses devis.
tiersIdintegeroptionalIdentifiant d'un tiers pour n'avoir que ses devis.
statusstringoptionalall (défaut), draft (en édition), sent (envoyé ou imprimé), accepted, refused ou canceled.
fromstring (date)optionalPremier jour de la date du devis (AAAA-MM-JJ).
tostring (date)optionalDernier jour de la date du devis (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[].titlestringnullableIntitulé du devis.
items[].typestringnullableType : devis ou contrat.
items[].validUntilstring (date)nullableDate de fin de validité de l'offre.
items[].isAmendmentbooleanVrai pour un avenant (travaux complémentaires d'un devis).
items[].parentEstimateIdintegernullablePour un avenant : identifiant du devis principal.
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 devisHuman-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_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
  }
}