Modifier un devis

Tool nameupdate_estimate
WriteDestructiveIdempotent

Updates an estimate's header (name, dates, billed third party) or applies a margin or discount to all its lines.

Description

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

Modifie l'en-tête d'un devis (nom, dates, tiers facturé) ou applique une marge ou une remise à toutes ses lignes, comme les champs globaux de l'écran du devis. Seuls les champs fournis changent. Avant l'appel, annoncer précisément la modification et attendre l'accord de l'utilisateur. Oxygenius recalcule les prix, les sous-totaux, la TVA et les totaux comme l'écran du devis ; un devis accepté, refusé ou annulé, ou en attente de signature électronique, ne change plus (proposer create_estimate_version). Rien n'est envoyé au client. Renvoie le devis à jour.

Required access

Parameters

NameTypePresenceDescription
estimateIdintegerrequiredDevis (champ id de search_estimates).
namestringoptionalNouveau nom.
startDatestring (date)optionalNouvelle date du devis (AAAA-MM-JJ) ; la date de validité suit si elle devient antérieure.
dueDatestring (date)optionalNouvelle date de validité (AAAA-MM-JJ).
billingTiersIdintegeroptionalNouveau tiers facturé : un tiers lié au dossier (champ tiersId des tiers de get_dossier), à l'adresse complète ; le taux de TVA par défaut suit son régime.
benefitPercentagenumberoptionalMarge en pourcents du prix de vente (0 à 99,99), appliquée à toutes les lignes chiffrées : leurs prix sont recalculés.
discountPercentagenumberoptionalRemise en pourcents (0 à 100), appliquée à toutes les lignes d'article.

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
customerVatNumberstringnullableNuméro de TVA du client imprimé sur le devis.
customerAddressstringnullableAdresse du client imprimée sur le devis.
dossierIndicationstringnullableIntitulé court du dossier.
discountPercentagenumbernullableRemise globale en pourcents.
discountAmountnumbernullableMontant de la remise globale (hors TVA).
remarkstringnullableRemarque imprimée sur le devis.
vatBreakdownobject[]Montant de TVA par taux.
vatBreakdown[].ratestringnullableCode du taux de TVA (ex. 21, 6, CO pour cocontractant).
vatBreakdown[].percentagenumbernullablePourcentage de TVA.
vatBreakdown[].amountnumbernullableMontant 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[].numberstringnullableNumé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[].namestringnullableLibellé de la ligne.
lines.items[].descriptionstringnullableDescription détaillée.
lines.items[].quantitynumbernullableQuantité (articles).
lines.items[].unitstringnullableUnité (articles).
lines.items[].unitPricenumbernullablePrix unitaire hors TVA (articles).
lines.items[].vatRatenumbernullableTaux de TVA en pourcents (articles).
lines.items[].discountAmountnumbernullableRemise accordée sur la ligne (articles).
lines.items[].amountExcludingVatnumbernullableMontant hors TVA, net de la remise de la ligne (articles).
lines.items[].remarkstringnullableRemarque imprimée sous la ligne (devis).
lines.items[].depositInvoiceIdintegernullableFacture d'acompte déduite par cette ligne (à passer à get_invoice).
amendmentsobject[]Avenants de ce devis.
amendments[].idintegerIdentifiant du document lié.
amendments[].referencestringnullableNuméro du document lié.
amendments[].typestringnullableType de facture (acompte, finale, avancement…).
amendments[].statusstringnullableStatut du document lié.
amendments[].datestring (date)nullableDate du document lié.
amendments[].amountIncludingVatnumbernullableTotal TVA comprise.
invoicesobject[]Factures émises pour ce devis et ses avenants (vide sans accès aux factures).
Same structure as amendments[]
creditNotesobject[]Notes de crédit liées à ce devis (vide sans accès aux notes de crédit).
Same structure as amendments[]
billingBalanceobjectnullableAvancement de la facturation d'un devis accepté (absent sinon, ou sans accès aux factures).
billingBalance.acceptedAmountExcludingVatnumbernullableMontant accepté : devis principal et avenants acceptés, hors TVA.
billingBalance.invoicedAmountExcludingVatnumbernullableMontant déjà facturé (factures non annulées), hors TVA.
billingBalance.creditedAmountExcludingVatnumbernullableMontant des notes de crédit, hors TVA.
billingBalance.remainingAmountExcludingVatnumbernullableReste à facturer, hors TVA.
titlestringnullableIntitulé du devis.
typestringnullableType : devis ou contrat.
validUntilstring (date)nullableDate de fin de validité de l'offre.
isAmendmentbooleanVrai pour un avenant (travaux complémentaires d'un devis).
parentEstimateIdintegernullablePour un avenant : identifiant du devis principal.
idintegerIdentifiant du document (à passer à l'outil de détail).
referencestringnullableNuméro du document (vide pour un brouillon de facture ou de note de crédit).
statusstringnullableStatut du document.
datestring (date)nullableDate du document.
customerstringnullableClient tel qu'imprimé sur le document.
tiersIdintegerIdentifiant du tiers client (à passer à get_tiers).
dossierIdintegerIdentifiant du dossier (à passer à get_dossier).
dossierReferencestringnullableRéférence du dossier.
amountExcludingVatnumbernullableTotal hors TVA, net de la remise globale.
vatAmountnumbernullableMontant de TVA.
amountIncludingVatnumbernullableTotal TVA comprise.

MCP annotations

AnnotationValueMeaning
titleModifier un devisHuman-readable name shown by the MCP client.
readOnlyHintnoThe tool changes nothing.
destructiveHintyesThe 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": "update_estimate",
  "title": "Modifier un devis",
  "description": "Modifie l'en-tête d'un devis (nom, dates, tiers facturé) ou applique une marge ou une remise à toutes ses lignes, comme les champs globaux de l'écran du devis. Seuls les champs fournis changent. Avant l'appel, annoncer précisément la modification et attendre l'accord de l'utilisateur. Oxygenius recalcule les prix, les sous-totaux, la TVA et les totaux comme l'écran du devis ; un devis accepté, refusé ou annulé, ou en attente de signature électronique, ne change plus (proposer create_estimate_version). Rien n'est envoyé au client. Renvoie le devis à jour.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "estimateId": {
        "description": "Devis (champ id de search_estimates).",
        "type": "integer"
      },
      "name": {
        "description": "Nouveau nom.",
        "type": [
          "string",
          "null"
        ],
        "default": null
      },
      "startDate": {
        "description": "Nouvelle date du devis (AAAA-MM-JJ) ; la date de validité suit si elle devient antérieure.",
        "type": [
          "string",
          "null"
        ],
        "format": "date",
        "default": null
      },
      "dueDate": {
        "description": "Nouvelle date de validité (AAAA-MM-JJ).",
        "type": [
          "string",
          "null"
        ],
        "format": "date",
        "default": null
      },
      "billingTiersId": {
        "description": "Nouveau tiers facturé : un tiers lié au dossier (champ tiersId des tiers de get_dossier), à l'adresse complète ; le taux de TVA par défaut suit son régime.",
        "type": [
          "integer",
          "null"
        ],
        "default": null
      },
      "benefitPercentage": {
        "description": "Marge en pourcents du prix de vente (0 à 99,99), appliquée à toutes les lignes chiffrées : leurs prix sont recalculés.",
        "type": [
          "number",
          "null"
        ],
        "default": null
      },
      "discountPercentage": {
        "description": "Remise en pourcents (0 à 100), appliquée à toutes les lignes d'article.",
        "type": [
          "number",
          "null"
        ],
        "default": null
      }
    },
    "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": "Modifier un devis",
    "destructiveHint": true,
    "idempotentHint": true,
    "openWorldHint": false,
    "readOnlyHint": false
  }
}