Détail d'un devis

Nom de l'outilget_estimate
Lecture seuleIdempotent

Description

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

Renvoie le détail d'un devis : client, montants et ventilation TVA, lignes (titres, articles, options), avenants, factures et notes de crédit liées, et pour un devis accepté le reste à facturer. Montants en euros ; le total hors TVA est net de la remise globale.

Accès requis

Paramètres

NomTypePrésenceDescription
estimateIdintegerobligatoireIdentifiant du devis (champ id de search_estimates).

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
customerVatNumberstringpeut être nullNuméro de TVA du client imprimé sur le devis.
customerAddressstringpeut être nullAdresse du client imprimée sur le devis.
dossierIndicationstringpeut être nullIntitulé court du dossier.
discountPercentagenumberpeut être nullRemise globale en pourcents.
discountAmountnumberpeut être nullMontant de la remise globale (hors TVA).
remarkstringpeut être nullRemarque imprimée sur le devis.
vatBreakdownobject[]Montant de TVA par taux.
vatBreakdown[].ratestringpeut être nullCode du taux de TVA (ex. 21, 6, CO pour cocontractant).
vatBreakdown[].percentagenumberpeut être nullPourcentage de TVA.
vatBreakdown[].amountnumberpeut être nullMontant de TVA à ce taux.
linesobjectLignes du devis.
lines.totalCountintegerNombre total de lignes du document.
lines.isTruncatedbooleanVrai si le document compte plus de lignes que celles renvoyées.
lines.itemsobject[]Lignes dans l'ordre du document.
lines.items[].idintegerIdentifiant de la ligne (lineId ou parentLineId des outils de modification d'un devis).
lines.items[].numberstringpeut être nullNuméro de la ligne tel qu'imprimé (ex. 1.2).
lines.items[].typestringsupertitle, title, subtitle, item (article) ou other.
lines.items[].isOptionbooleanVrai pour une ligne en option (variante), non comprise dans les totaux.
lines.items[].namestringpeut être nullLibellé de la ligne.
lines.items[].descriptionstringpeut être nullDescription détaillée.
lines.items[].quantitynumberpeut être nullQuantité (articles).
lines.items[].unitstringpeut être nullUnité (articles).
lines.items[].unitPricenumberpeut être nullPrix unitaire hors TVA (articles).
lines.items[].vatRatenumberpeut être nullTaux de TVA en pourcents (articles).
lines.items[].discountAmountnumberpeut être nullRemise accordée sur la ligne (articles).
lines.items[].amountExcludingVatnumberpeut être nullMontant hors TVA, net de la remise de la ligne (articles).
lines.items[].remarkstringpeut être nullRemarque imprimée sous la ligne (devis).
lines.items[].depositInvoiceIdintegerpeut être nullFacture d'acompte déduite par cette ligne (à passer à get_invoice).
amendmentsobject[]Avenants de ce devis.
amendments[].idintegerIdentifiant du document lié.
amendments[].referencestringpeut être nullNuméro du document lié.
amendments[].typestringpeut être nullType de facture (acompte, finale, avancement…).
amendments[].statusstringpeut être nullStatut du document lié.
amendments[].datestring (date)peut être nullDate du document lié.
amendments[].amountIncludingVatnumberpeut être nullTotal TVA comprise.
invoicesobject[]Factures émises pour ce devis et ses avenants (vide sans accès aux factures).
Même structure que amendments[]
creditNotesobject[]Notes de crédit liées à ce devis (vide sans accès aux notes de crédit).
Même structure que amendments[]
billingBalanceobjectpeut être nullAvancement de la facturation d'un devis accepté (absent sinon, ou sans accès aux factures).
billingBalance.acceptedAmountExcludingVatnumberpeut être nullMontant accepté : devis principal et avenants acceptés, hors TVA.
billingBalance.invoicedAmountExcludingVatnumberpeut être nullMontant déjà facturé (factures non annulées), hors TVA.
billingBalance.creditedAmountExcludingVatnumberpeut être nullMontant des notes de crédit, hors TVA.
billingBalance.remainingAmountExcludingVatnumberpeut être nullReste à facturer, hors TVA.
titlestringpeut être nullIntitulé du devis.
typestringpeut être nullType : devis ou contrat.
validUntilstring (date)peut être nullDate de fin de validité de l'offre.
isAmendmentbooleanVrai pour un avenant (travaux complémentaires d'un devis).
parentEstimateIdintegerpeut être nullPour un avenant : identifiant du devis principal.
idintegerIdentifiant du document (à passer à l'outil de détail).
referencestringpeut être nullNuméro du document (vide pour un brouillon de facture ou de note de crédit).
statusstringpeut être nullStatut du document.
datestring (date)peut être nullDate du document.
customerstringpeut être nullClient tel qu'imprimé sur le document.
tiersIdintegerIdentifiant du tiers client (à passer à get_tiers).
dossierIdintegerIdentifiant du dossier (à passer à get_dossier).
dossierReferencestringpeut être nullRéférence du dossier.
amountExcludingVatnumberpeut être nullTotal hors TVA, net de la remise globale.
vatAmountnumberpeut être nullMontant de TVA.
amountIncludingVatnumberpeut être nullTotal TVA comprise.

Annotations MCP

AnnotationValeurSignification
titleDétail d'un devisNom 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": "get_estimate",
  "title": "Détail d'un devis",
  "description": "Renvoie le détail d'un devis : client, montants et ventilation TVA, lignes (titres, articles, options), avenants, factures et notes de crédit liées, et pour un devis accepté le reste à facturer. Montants en euros ; le total hors TVA est net de la remise globale.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "estimateId": {
        "description": "Identifiant du devis (champ id de search_estimates).",
        "type": "integer"
      }
    },
    "required": [
      "estimateId"
    ]
  },
  "outputSchema": {
    "type": "object",
    "properties": {
      "customerVatNumber": {
        "description": "Numéro de TVA du client imprimé sur le devis.",
        "type": [
          "string",
          "null"
        ]
      },
      "customerAddress": {
        "description": "Adresse du client imprimée sur le devis.",
        "type": [
          "string",
          "null"
        ]
      },
      "dossierIndication": {
        "description": "Intitulé court du dossier.",
        "type": [
          "string",
          "null"
        ]
      },
      "discountPercentage": {
        "description": "Remise globale en pourcents.",
        "type": [
          "number",
          "null"
        ]
      },
      "discountAmount": {
        "description": "Montant de la remise globale (hors TVA).",
        "type": [
          "number",
          "null"
        ]
      },
      "remark": {
        "description": "Remarque imprimée sur le devis.",
        "type": [
          "string",
          "null"
        ]
      },
      "vatBreakdown": {
        "description": "Montant de TVA par taux.",
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "rate": {
              "description": "Code du taux de TVA (ex. 21, 6, CO pour cocontractant).",
              "type": [
                "string",
                "null"
              ]
            },
            "percentage": {
              "description": "Pourcentage de TVA.",
              "type": [
                "number",
                "null"
              ]
            },
            "amount": {
              "description": "Montant de TVA à ce taux.",
              "type": [
                "number",
                "null"
              ]
            }
          }
        }
      },
      "lines": {
        "description": "Lignes du devis.",
        "type": "object",
        "properties": {
          "totalCount": {
            "description": "Nombre total de lignes du document.",
            "type": "integer"
          },
          "isTruncated": {
            "description": "Vrai si le document compte plus de lignes que celles renvoyées.",
            "type": "boolean"
          },
          "items": {
            "description": "Lignes dans l'ordre du document.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Identifiant de la ligne (lineId ou parentLineId des outils de modification d'un devis).",
                  "type": "integer"
                },
                "number": {
                  "description": "Numéro de la ligne tel qu'imprimé (ex. 1.2).",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "type": {
                  "description": "supertitle, title, subtitle, item (article) ou other.",
                  "type": "string"
                },
                "isOption": {
                  "description": "Vrai pour une ligne en option (variante), non comprise dans les totaux.",
                  "type": "boolean"
                },
                "name": {
                  "description": "Libellé de la ligne.",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "description": {
                  "description": "Description détaillée.",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "quantity": {
                  "description": "Quantité (articles).",
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "unit": {
                  "description": "Unité (articles).",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "unitPrice": {
                  "description": "Prix unitaire hors TVA (articles).",
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "vatRate": {
                  "description": "Taux de TVA en pourcents (articles).",
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "discountAmount": {
                  "description": "Remise accordée sur la ligne (articles).",
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "amountExcludingVat": {
                  "description": "Montant hors TVA, net de la remise de la ligne (articles).",
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "remark": {
                  "description": "Remarque imprimée sous la ligne (devis).",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "depositInvoiceId": {
                  "description": "Facture d'acompte déduite par cette ligne (à passer à get_invoice).",
                  "type": [
                    "integer",
                    "null"
                  ]
                }
              },
              "required": [
                "type"
              ]
            }
          }
        },
        "required": [
          "totalCount",
          "isTruncated",
          "items"
        ]
      },
      "amendments": {
        "description": "Avenants de ce devis.",
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "description": "Identifiant du document lié.",
              "type": "integer"
            },
            "reference": {
              "description": "Numéro du document lié.",
              "type": [
                "string",
                "null"
              ]
            },
            "type": {
              "description": "Type de facture (acompte, finale, avancement…).",
              "type": [
                "string",
                "null"
              ]
            },
            "status": {
              "description": "Statut du document lié.",
              "type": [
                "string",
                "null"
              ]
            },
            "date": {
              "description": "Date du document lié.",
              "type": [
                "string",
                "null"
              ],
              "format": "date"
            },
            "amountIncludingVat": {
              "description": "Total TVA comprise.",
              "type": [
                "number",
                "null"
              ]
            }
          },
          "required": [
            "id"
          ]
        }
      },
      "invoices": {
        "description": "Factures émises pour ce devis et ses avenants (vide sans accès aux factures).",
        "type": "array",
        "items": {
          "$ref": "#/properties/amendments/items"
        }
      },
      "creditNotes": {
        "description": "Notes de crédit liées à ce devis (vide sans accès aux notes de crédit).",
        "type": "array",
        "items": {
          "$ref": "#/properties/amendments/items"
        }
      },
      "billingBalance": {
        "description": "Avancement de la facturation d'un devis accepté (absent sinon, ou sans accès aux factures).",
        "type": [
          "object",
          "null"
        ],
        "properties": {
          "acceptedAmountExcludingVat": {
            "description": "Montant accepté : devis principal et avenants acceptés, hors TVA.",
            "type": [
              "number",
              "null"
            ]
          },
          "invoicedAmountExcludingVat": {
            "description": "Montant déjà facturé (factures non annulées), hors TVA.",
            "type": [
              "number",
              "null"
            ]
          },
          "creditedAmountExcludingVat": {
            "description": "Montant des notes de crédit, hors TVA.",
            "type": [
              "number",
              "null"
            ]
          },
          "remainingAmountExcludingVat": {
            "description": "Reste à facturer, hors TVA.",
            "type": [
              "number",
              "null"
            ]
          }
        }
      },
      "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": [
      "lines",
      "id",
      "tiersId",
      "dossierId"
    ]
  },
  "annotations": {
    "title": "Détail d'un devis",
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false,
    "readOnlyHint": true
  }
}