Modifier une note de crédit
Tool name
update_credit_noteWriteDestructiveIdempotent
Updates a draft credit note's header: date and billed third party.
Description
Modifie l'en-tête d'une note de crédit en brouillon : date, tiers facturé. Seuls les champs fournis changent. Avant l'appel, annoncer précisément la modification et attendre l'accord de l'utilisateur. Seul un brouillon (sans numéro, à éditer) change : le numéro d'une facture est légal et définitif. Oxygenius recalcule les prix, les sous-totaux, la TVA et les totaux comme l'écran du document. Rien n'est envoyé au client.
Required access
- Permission:
credit-note.list.view - Company that has enabled write tools (Settings → AI integration).
- Without them, the tool is not listed by
tools/listand calling it is refused.
Parameters
| Name | Type | Presence | Description |
|---|---|---|---|
creditNoteId | integer | required | Note de crédit (champ id de search_credit_notes). |
date | string (date) | optional | Nouvelle date (AAAA-MM-JJ). |
billingTiersId | integer | optional | Nouveau tiers facturé : un tiers lié au dossier (champ tiersId des tiers de get_dossier), à l'adresse complète. |
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
| Name | Type | Presence | Description |
|---|---|---|---|
customerVatNumber | string | nullable | Numéro de TVA du client imprimé sur la note de crédit. |
customerAddress | string | nullable | Adresse du client imprimée sur la note de crédit. |
dossierIndication | string | nullable | Intitulé court du dossier. |
structuredCommunication | string | nullable | Communication structurée. |
discountPercentage | number | nullable | Remise globale en pourcents. |
discountAmount | number | nullable | Montant de la remise globale (hors TVA). |
vatBreakdown | object[] | Montant de TVA par taux. | |
vatBreakdown[].rate | string | nullable | Code du taux de TVA (ex. 21, 6, CO pour cocontractant). |
vatBreakdown[].percentage | number | nullable | Pourcentage de TVA. |
vatBreakdown[].amount | number | nullable | Montant de TVA à ce taux. |
lines | object | Lignes de la note de crédit. | |
lines.totalCount | integer | Nombre total de lignes du document. | |
lines.isTruncated | boolean | Vrai si le document compte plus de lignes que celles renvoyées. | |
lines.items | object[] | Lignes dans l'ordre du document. | |
lines.items[].id | integer | Identifiant de la ligne (lineId ou parentLineId des outils de modification d'un devis). | |
lines.items[].number | string | nullable | Numéro de la ligne tel qu'imprimé (ex. 1.2). |
lines.items[].type | string | supertitle, title, subtitle, item (article) ou other. | |
lines.items[].isOption | boolean | Vrai pour une ligne en option (variante), non comprise dans les totaux. | |
lines.items[].name | string | nullable | Libellé de la ligne. |
lines.items[].description | string | nullable | Description détaillée. |
lines.items[].quantity | number | nullable | Quantité (articles). |
lines.items[].unit | string | nullable | Unité (articles). |
lines.items[].unitPrice | number | nullable | Prix unitaire hors TVA (articles). |
lines.items[].vatRate | number | nullable | Taux de TVA en pourcents (articles). |
lines.items[].discountAmount | number | nullable | Remise accordée sur la ligne (articles). |
lines.items[].amountExcludingVat | number | nullable | Montant hors TVA, net de la remise de la ligne (articles). |
lines.items[].remark | string | nullable | Remarque imprimée sous la ligne (devis). |
lines.items[].depositInvoiceId | integer | nullable | Facture d'acompte déduite par cette ligne (à passer à get_invoice). |
invoiceId | integer | nullable | Identifiant de la facture créditée (à passer à get_invoice), si la note en crédite une. |
invoiceReference | string | nullable | Numéro de la facture créditée. |
id | integer | Identifiant du document (à passer à l'outil de détail). | |
reference | string | nullable | Numéro du document (vide pour un brouillon de facture ou de note de crédit). |
status | string | nullable | Statut du document. |
date | string (date) | nullable | Date du document. |
customer | string | nullable | Client tel qu'imprimé sur le document. |
tiersId | integer | Identifiant du tiers client (à passer à get_tiers). | |
dossierId | integer | Identifiant du dossier (à passer à get_dossier). | |
dossierReference | string | nullable | Référence du dossier. |
amountExcludingVat | number | nullable | Total hors TVA, net de la remise globale. |
vatAmount | number | nullable | Montant de TVA. |
amountIncludingVat | number | nullable | Total TVA comprise. |
MCP annotations
| Annotation | Value | Meaning |
|---|---|---|
title | Modifier une note de crédit | Human-readable name shown by the MCP client. |
readOnlyHint | no | The tool changes nothing. |
destructiveHint | yes | The tool may change or delete existing data, or trigger an irreversible action. |
idempotentHint | yes | Calling it again with the same arguments has no further effect. |
openWorldHint | no | The tool reads e-mails or document content, or reaches an external service. |
JSON definition
Exact tools/list entry
{
"name": "update_credit_note",
"title": "Modifier une note de crédit",
"description": "Modifie l'en-tête d'une note de crédit en brouillon : date, tiers facturé. Seuls les champs fournis changent. Avant l'appel, annoncer précisément la modification et attendre l'accord de l'utilisateur. Seul un brouillon (sans numéro, à éditer) change : le numéro d'une facture est légal et définitif. Oxygenius recalcule les prix, les sous-totaux, la TVA et les totaux comme l'écran du document. Rien n'est envoyé au client.",
"inputSchema": {
"type": "object",
"properties": {
"creditNoteId": {
"description": "Note de crédit (champ id de search_credit_notes).",
"type": "integer"
},
"date": {
"description": "Nouvelle date (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.",
"type": [
"integer",
"null"
],
"default": null
}
},
"required": [
"creditNoteId"
]
},
"outputSchema": {
"type": "object",
"properties": {
"customerVatNumber": {
"description": "Numéro de TVA du client imprimé sur la note de crédit.",
"type": [
"string",
"null"
]
},
"customerAddress": {
"description": "Adresse du client imprimée sur la note de crédit.",
"type": [
"string",
"null"
]
},
"dossierIndication": {
"description": "Intitulé court du dossier.",
"type": [
"string",
"null"
]
},
"structuredCommunication": {
"description": "Communication structurée.",
"type": [
"string",
"null"
]
},
"discountPercentage": {
"description": "Remise globale en pourcents.",
"type": [
"number",
"null"
]
},
"discountAmount": {
"description": "Montant de la remise globale (hors TVA).",
"type": [
"number",
"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 de la note de crédit.",
"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"
]
},
"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": [
"lines",
"id",
"tiersId",
"dossierId"
]
},
"annotations": {
"title": "Modifier une note de crédit",
"destructiveHint": true,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": false
}
}