Ajouter des lignes à une facture
add_invoice_linesDescription
Ajoute des lignes à une facture en brouillon, dans l'ordre donné : titres, sous-titres, lignes libres à prix saisi, articles et ouvrages du catalogue. Les lignes d'une facture d'acompte ou d'avancement viennent du devis et ne changent pas. Prix, marges, unités et TVA des articles viennent du catalogue (search_items) et du client, sauf valeur fournie. Une ligne sans parentLineId se place en fin de document, sous le titre qui précède. Avant l'appel, annoncer précisément la modification et attendre l'accord de l'utilisateur. Ne pas rappeler l'outil après un succès : chaque appel ajoute de nouvelles lignes. 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.
Accès requis
- Permission :
invoice.list.view - Société ouverte aux outils d'écriture (Paramètres → Intégration IA).
- Sans ces conditions, l'outil n'apparaît pas dans
tools/listet son appel est refusé.
Paramètres
| Nom | Type | Présence | Description |
|---|---|---|---|
invoiceId | integer | obligatoire | Facture (champ id de search_invoices). |
lines | object[] | obligatoire | Lignes à ajouter, 50 au plus. |
lines[].kind | string | obligatoire | title (titre), subtitle (sous-titre), free (ligne libre à prix saisi), item (article du catalogue) ou job (ouvrage du catalogue, avec ses articles). |
lines[].name | string | facultatif | Libellé : obligatoire pour title, subtitle et free ; celui du catalogue pour item et job. |
lines[].description | string | facultatif | Description ; celle du catalogue par défaut pour item et job. |
lines[].quantity | number | facultatif | Quantité (1 par défaut) ; celle d'un ouvrage multiplie les quantités de ses articles. |
lines[].unitPrice | number | facultatif | Prix unitaire hors TVA : celui d'une ligne libre, ou un prix imposé à un article à la place de celui du catalogue. |
lines[].itemId | integer | facultatif | Article ou ouvrage du catalogue (champ id de search_items : kind job pour un ouvrage, item pour les autres), pour item et job. |
lines[].unit | string | facultatif | Unité, par son nom (ex. m², h, pièce) ; celle de l'article par défaut. |
lines[].vatRate | number | facultatif | Taux de TVA en pourcents (ex. 21, 6) ; celui du client par défaut. |
lines[].parentLineId | integer | facultatif | Titre ou sous-titre (champ id des lignes du document) sous lequel placer la ligne ; sinon en fin de document, rattachée au titre qui précède. |
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 |
|---|---|---|---|
addedLineIds | integer[] | Identifiant de chaque ligne ajoutée, dans l'ordre de la demande (le sous-titre pour un ouvrage). | |
invoice | object | La facture à jour, montants recalculés. | |
invoice.customerVatNumber | string | peut être null | Numéro de TVA du client imprimé sur la facture. |
invoice.customerAddress | string | peut être null | Adresse du client imprimée sur la facture. |
invoice.customerOrderNumber | string | peut être null | Référence de commande (bon de commande) du client. |
invoice.dossierIndication | string | peut être null | Intitulé court du dossier. |
invoice.structuredCommunication | string | peut être null | Communication structurée du virement. |
invoice.paymentTerm | string | peut être null | Condition de paiement. |
invoice.discountPercentage | number | peut être null | Remise globale en pourcents. |
invoice.discountAmount | number | peut être null | Montant de la remise globale (hors TVA). |
invoice.retentionPercentage | number | peut être null | Retenue de garantie en pourcents. |
invoice.retentionAmount | number | peut être null | Montant de la retenue de garantie. |
invoice.paidAmount | number | peut être null | Total des paiements reçus. |
invoice.creditedAmount | number | peut être null | Total des notes de crédit sur cette facture, TVA comprise. |
invoice.payments | object[] | Paiements reçus. | |
invoice.payments[].date | string (date) | Date du paiement. | |
invoice.payments[].amount | number | peut être null | Montant payé. |
invoice.payments[].method | string | peut être null | Moyen de paiement. |
invoice.vatBreakdown | object[] | Montant de TVA par taux. | |
invoice.vatBreakdown[].rate | string | peut être null | Code du taux de TVA (ex. 21, 6, CO pour cocontractant). |
invoice.vatBreakdown[].percentage | number | peut être null | Pourcentage de TVA. |
invoice.vatBreakdown[].amount | number | peut être null | Montant de TVA à ce taux. |
invoice.lines | object | Lignes de la facture. | |
invoice.lines.totalCount | integer | Nombre total de lignes du document. | |
invoice.lines.isTruncated | boolean | Vrai si le document compte plus de lignes que celles renvoyées. | |
invoice.lines.items | object[] | Lignes dans l'ordre du document. | |
invoice.lines.items[].id | integer | Identifiant de la ligne (lineId ou parentLineId des outils de modification d'un devis). | |
invoice.lines.items[].number | string | peut être null | Numéro de la ligne tel qu'imprimé (ex. 1.2). |
invoice.lines.items[].type | string | supertitle, title, subtitle, item (article) ou other. | |
invoice.lines.items[].isOption | boolean | Vrai pour une ligne en option (variante), non comprise dans les totaux. | |
invoice.lines.items[].name | string | peut être null | Libellé de la ligne. |
invoice.lines.items[].description | string | peut être null | Description détaillée. |
invoice.lines.items[].quantity | number | peut être null | Quantité (articles). |
invoice.lines.items[].unit | string | peut être null | Unité (articles). |
invoice.lines.items[].unitPrice | number | peut être null | Prix unitaire hors TVA (articles). |
invoice.lines.items[].vatRate | number | peut être null | Taux de TVA en pourcents (articles). |
invoice.lines.items[].discountAmount | number | peut être null | Remise accordée sur la ligne (articles). |
invoice.lines.items[].amountExcludingVat | number | peut être null | Montant hors TVA, net de la remise de la ligne (articles). |
invoice.lines.items[].remark | string | peut être null | Remarque imprimée sous la ligne (devis). |
invoice.lines.items[].depositInvoiceId | integer | peut être null | Facture d'acompte déduite par cette ligne (à passer à get_invoice). |
invoice.estimateId | integer | peut être null | Identifiant du devis facturé (à passer à get_estimate ; absent sans accès aux devis). |
invoice.estimateReference | string | peut être null | Numéro du devis facturé. |
invoice.creditNotes | object[] | Notes de crédit sur cette facture (vide sans accès aux notes de crédit). | |
invoice.creditNotes[].id | integer | Identifiant du document lié. | |
invoice.creditNotes[].reference | string | peut être null | Numéro du document lié. |
invoice.creditNotes[].type | string | peut être null | Type de facture (acompte, finale, avancement…). |
invoice.creditNotes[].status | string | peut être null | Statut du document lié. |
invoice.creditNotes[].date | string (date) | peut être null | Date du document lié. |
invoice.creditNotes[].amountIncludingVat | number | peut être null | Total TVA comprise. |
invoice.type | string | peut être null | Type : acompte, finale, état d'avancement, intervention, proforma… |
invoice.dueDate | string (date) | peut être null | Date d'échéance. |
invoice.amountDue | number | peut être null | Montant à payer TVA comprise : le total, diminué de la retenue de garantie éventuelle. |
invoice.outstanding | number | peut être null | Solde restant dû : montant à payer moins paiements et notes de crédit (absent pour un brouillon, une facture annulée ou proforma). |
invoice.isOverdue | boolean | Vrai si la facture est ouverte, échue et pas soldée. | |
invoice.daysOverdue | integer | peut être null | Nombre de jours depuis l'échéance, pour une facture en retard. |
invoice.id | integer | Identifiant du document (à passer à l'outil de détail). | |
invoice.reference | string | peut être null | Numéro du document (vide pour un brouillon de facture ou de note de crédit). |
invoice.status | string | peut être null | Statut du document. |
invoice.date | string (date) | peut être null | Date du document. |
invoice.customer | string | peut être null | Client tel qu'imprimé sur le document. |
invoice.tiersId | integer | Identifiant du tiers client (à passer à get_tiers). | |
invoice.dossierId | integer | Identifiant du dossier (à passer à get_dossier). | |
invoice.dossierReference | string | peut être null | Référence du dossier. |
invoice.amountExcludingVat | number | peut être null | Total hors TVA, net de la remise globale. |
invoice.vatAmount | number | peut être null | Montant de TVA. |
invoice.amountIncludingVat | number | peut être null | Total TVA comprise. |
Annotations MCP
| Annotation | Valeur | Signification |
|---|---|---|
title | Ajouter des lignes à une facture | Nom lisible affiché par le client MCP. |
readOnlyHint | non | 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 | non | 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": "add_invoice_lines",
"title": "Ajouter des lignes à une facture",
"description": "Ajoute des lignes à une facture en brouillon, dans l'ordre donné : titres, sous-titres, lignes libres à prix saisi, articles et ouvrages du catalogue. Les lignes d'une facture d'acompte ou d'avancement viennent du devis et ne changent pas. Prix, marges, unités et TVA des articles viennent du catalogue (search_items) et du client, sauf valeur fournie. Une ligne sans parentLineId se place en fin de document, sous le titre qui précède. Avant l'appel, annoncer précisément la modification et attendre l'accord de l'utilisateur. Ne pas rappeler l'outil après un succès : chaque appel ajoute de nouvelles lignes. 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": {
"invoiceId": {
"description": "Facture (champ id de search_invoices).",
"type": "integer"
},
"lines": {
"description": "Lignes à ajouter, 50 au plus.",
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"description": "title (titre), subtitle (sous-titre), free (ligne libre à prix saisi), item (article du catalogue) ou job (ouvrage du catalogue, avec ses articles).",
"type": "string"
},
"name": {
"description": "Libellé : obligatoire pour title, subtitle et free ; celui du catalogue pour item et job.",
"type": [
"string",
"null"
]
},
"description": {
"description": "Description ; celle du catalogue par défaut pour item et job.",
"type": [
"string",
"null"
]
},
"quantity": {
"description": "Quantité (1 par défaut) ; celle d'un ouvrage multiplie les quantités de ses articles.",
"type": [
"number",
"null"
]
},
"unitPrice": {
"description": "Prix unitaire hors TVA : celui d'une ligne libre, ou un prix imposé à un article à la place de celui du catalogue.",
"type": [
"number",
"null"
]
},
"itemId": {
"description": "Article ou ouvrage du catalogue (champ id de search_items : kind job pour un ouvrage, item pour les autres), pour item et job.",
"type": [
"integer",
"null"
]
},
"unit": {
"description": "Unité, par son nom (ex. m², h, pièce) ; celle de l'article par défaut.",
"type": [
"string",
"null"
]
},
"vatRate": {
"description": "Taux de TVA en pourcents (ex. 21, 6) ; celui du client par défaut.",
"type": [
"number",
"null"
]
},
"parentLineId": {
"description": "Titre ou sous-titre (champ id des lignes du document) sous lequel placer la ligne ; sinon en fin de document, rattachée au titre qui précède.",
"type": [
"integer",
"null"
]
}
},
"required": [
"kind"
]
}
}
},
"required": [
"invoiceId",
"lines"
]
},
"outputSchema": {
"type": "object",
"properties": {
"addedLineIds": {
"description": "Identifiant de chaque ligne ajoutée, dans l'ordre de la demande (le sous-titre pour un ouvrage).",
"type": "array",
"items": {
"type": "integer"
}
},
"invoice": {
"description": "La facture à jour, montants recalculés.",
"type": "object",
"properties": {
"customerVatNumber": {
"description": "Numéro de TVA du client imprimé sur la facture.",
"type": [
"string",
"null"
]
},
"customerAddress": {
"description": "Adresse du client imprimée sur la facture.",
"type": [
"string",
"null"
]
},
"customerOrderNumber": {
"description": "Référence de commande (bon de commande) du client.",
"type": [
"string",
"null"
]
},
"dossierIndication": {
"description": "Intitulé court du dossier.",
"type": [
"string",
"null"
]
},
"structuredCommunication": {
"description": "Communication structurée du virement.",
"type": [
"string",
"null"
]
},
"paymentTerm": {
"description": "Condition de paiement.",
"type": [
"string",
"null"
]
},
"discountPercentage": {
"description": "Remise globale en pourcents.",
"type": [
"number",
"null"
]
},
"discountAmount": {
"description": "Montant de la remise globale (hors TVA).",
"type": [
"number",
"null"
]
},
"retentionPercentage": {
"description": "Retenue de garantie en pourcents.",
"type": [
"number",
"null"
]
},
"retentionAmount": {
"description": "Montant de la retenue de garantie.",
"type": [
"number",
"null"
]
},
"paidAmount": {
"description": "Total des paiements reçus.",
"type": [
"number",
"null"
]
},
"creditedAmount": {
"description": "Total des notes de crédit sur cette facture, TVA comprise.",
"type": [
"number",
"null"
]
},
"payments": {
"description": "Paiements reçus.",
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"description": "Date du paiement.",
"type": "string",
"format": "date"
},
"amount": {
"description": "Montant payé.",
"type": [
"number",
"null"
]
},
"method": {
"description": "Moyen de paiement.",
"type": [
"string",
"null"
]
}
},
"required": [
"date"
]
}
},
"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 facture.",
"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"
]
},
"estimateId": {
"description": "Identifiant du devis facturé (à passer à get_estimate ; absent sans accès aux devis).",
"type": [
"integer",
"null"
]
},
"estimateReference": {
"description": "Numéro du devis facturé.",
"type": [
"string",
"null"
]
},
"creditNotes": {
"description": "Notes de crédit sur cette facture (vide sans accès aux notes de crédit).",
"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"
]
}
},
"type": {
"description": "Type : acompte, finale, état d'avancement, intervention, proforma…",
"type": [
"string",
"null"
]
},
"dueDate": {
"description": "Date d'échéance.",
"type": [
"string",
"null"
],
"format": "date"
},
"amountDue": {
"description": "Montant à payer TVA comprise : le total, diminué de la retenue de garantie éventuelle.",
"type": [
"number",
"null"
]
},
"outstanding": {
"description": "Solde restant dû : montant à payer moins paiements et notes de crédit (absent pour un brouillon, une facture annulée ou proforma).",
"type": [
"number",
"null"
]
},
"isOverdue": {
"description": "Vrai si la facture est ouverte, échue et pas soldée.",
"type": "boolean"
},
"daysOverdue": {
"description": "Nombre de jours depuis l'échéance, pour une facture en retard.",
"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"
]
}
},
"required": [
"addedLineIds",
"invoice"
]
},
"annotations": {
"title": "Ajouter des lignes à une facture",
"destructiveHint": false,
"idempotentHint": false,
"openWorldHint": false,
"readOnlyHint": false
}
}