Ajouter des lignes à une facture

Nom de l'outiladd_invoice_lines
Écriture

Description

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

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

Paramètres

NomTypePrésenceDescription
invoiceIdintegerobligatoireFacture (champ id de search_invoices).
linesobject[]obligatoireLignes à ajouter, 50 au plus.
lines[].kindstringobligatoiretitle (titre), subtitle (sous-titre), free (ligne libre à prix saisi), item (article du catalogue) ou job (ouvrage du catalogue, avec ses articles).
lines[].namestringfacultatifLibellé : obligatoire pour title, subtitle et free ; celui du catalogue pour item et job.
lines[].descriptionstringfacultatifDescription ; celle du catalogue par défaut pour item et job.
lines[].quantitynumberfacultatifQuantité (1 par défaut) ; celle d'un ouvrage multiplie les quantités de ses articles.
lines[].unitPricenumberfacultatifPrix unitaire hors TVA : celui d'une ligne libre, ou un prix imposé à un article à la place de celui du catalogue.
lines[].itemIdintegerfacultatifArticle ou ouvrage du catalogue (champ id de search_items : kind job pour un ouvrage, item pour les autres), pour item et job.
lines[].unitstringfacultatifUnité, par son nom (ex. m², h, pièce) ; celle de l'article par défaut.
lines[].vatRatenumberfacultatifTaux de TVA en pourcents (ex. 21, 6) ; celui du client par défaut.
lines[].parentLineIdintegerfacultatifTitre 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
NomTypePrésenceDescription
addedLineIdsinteger[]Identifiant de chaque ligne ajoutée, dans l'ordre de la demande (le sous-titre pour un ouvrage).
invoiceobjectLa facture à jour, montants recalculés.
invoice.customerVatNumberstringpeut être nullNuméro de TVA du client imprimé sur la facture.
invoice.customerAddressstringpeut être nullAdresse du client imprimée sur la facture.
invoice.customerOrderNumberstringpeut être nullRéférence de commande (bon de commande) du client.
invoice.dossierIndicationstringpeut être nullIntitulé court du dossier.
invoice.structuredCommunicationstringpeut être nullCommunication structurée du virement.
invoice.paymentTermstringpeut être nullCondition de paiement.
invoice.discountPercentagenumberpeut être nullRemise globale en pourcents.
invoice.discountAmountnumberpeut être nullMontant de la remise globale (hors TVA).
invoice.retentionPercentagenumberpeut être nullRetenue de garantie en pourcents.
invoice.retentionAmountnumberpeut être nullMontant de la retenue de garantie.
invoice.paidAmountnumberpeut être nullTotal des paiements reçus.
invoice.creditedAmountnumberpeut être nullTotal des notes de crédit sur cette facture, TVA comprise.
invoice.paymentsobject[]Paiements reçus.
invoice.payments[].datestring (date)Date du paiement.
invoice.payments[].amountnumberpeut être nullMontant payé.
invoice.payments[].methodstringpeut être nullMoyen de paiement.
invoice.vatBreakdownobject[]Montant de TVA par taux.
invoice.vatBreakdown[].ratestringpeut être nullCode du taux de TVA (ex. 21, 6, CO pour cocontractant).
invoice.vatBreakdown[].percentagenumberpeut être nullPourcentage de TVA.
invoice.vatBreakdown[].amountnumberpeut être nullMontant de TVA à ce taux.
invoice.linesobjectLignes de la facture.
invoice.lines.totalCountintegerNombre total de lignes du document.
invoice.lines.isTruncatedbooleanVrai si le document compte plus de lignes que celles renvoyées.
invoice.lines.itemsobject[]Lignes dans l'ordre du document.
invoice.lines.items[].idintegerIdentifiant de la ligne (lineId ou parentLineId des outils de modification d'un devis).
invoice.lines.items[].numberstringpeut être nullNuméro de la ligne tel qu'imprimé (ex. 1.2).
invoice.lines.items[].typestringsupertitle, title, subtitle, item (article) ou other.
invoice.lines.items[].isOptionbooleanVrai pour une ligne en option (variante), non comprise dans les totaux.
invoice.lines.items[].namestringpeut être nullLibellé de la ligne.
invoice.lines.items[].descriptionstringpeut être nullDescription détaillée.
invoice.lines.items[].quantitynumberpeut être nullQuantité (articles).
invoice.lines.items[].unitstringpeut être nullUnité (articles).
invoice.lines.items[].unitPricenumberpeut être nullPrix unitaire hors TVA (articles).
invoice.lines.items[].vatRatenumberpeut être nullTaux de TVA en pourcents (articles).
invoice.lines.items[].discountAmountnumberpeut être nullRemise accordée sur la ligne (articles).
invoice.lines.items[].amountExcludingVatnumberpeut être nullMontant hors TVA, net de la remise de la ligne (articles).
invoice.lines.items[].remarkstringpeut être nullRemarque imprimée sous la ligne (devis).
invoice.lines.items[].depositInvoiceIdintegerpeut être nullFacture d'acompte déduite par cette ligne (à passer à get_invoice).
invoice.estimateIdintegerpeut être nullIdentifiant du devis facturé (à passer à get_estimate ; absent sans accès aux devis).
invoice.estimateReferencestringpeut être nullNuméro du devis facturé.
invoice.creditNotesobject[]Notes de crédit sur cette facture (vide sans accès aux notes de crédit).
invoice.creditNotes[].idintegerIdentifiant du document lié.
invoice.creditNotes[].referencestringpeut être nullNuméro du document lié.
invoice.creditNotes[].typestringpeut être nullType de facture (acompte, finale, avancement…).
invoice.creditNotes[].statusstringpeut être nullStatut du document lié.
invoice.creditNotes[].datestring (date)peut être nullDate du document lié.
invoice.creditNotes[].amountIncludingVatnumberpeut être nullTotal TVA comprise.
invoice.typestringpeut être nullType : acompte, finale, état d'avancement, intervention, proforma…
invoice.dueDatestring (date)peut être nullDate d'échéance.
invoice.amountDuenumberpeut être nullMontant à payer TVA comprise : le total, diminué de la retenue de garantie éventuelle.
invoice.outstandingnumberpeut être nullSolde restant dû : montant à payer moins paiements et notes de crédit (absent pour un brouillon, une facture annulée ou proforma).
invoice.isOverduebooleanVrai si la facture est ouverte, échue et pas soldée.
invoice.daysOverdueintegerpeut être nullNombre de jours depuis l'échéance, pour une facture en retard.
invoice.idintegerIdentifiant du document (à passer à l'outil de détail).
invoice.referencestringpeut être nullNuméro du document (vide pour un brouillon de facture ou de note de crédit).
invoice.statusstringpeut être nullStatut du document.
invoice.datestring (date)peut être nullDate du document.
invoice.customerstringpeut être nullClient tel qu'imprimé sur le document.
invoice.tiersIdintegerIdentifiant du tiers client (à passer à get_tiers).
invoice.dossierIdintegerIdentifiant du dossier (à passer à get_dossier).
invoice.dossierReferencestringpeut être nullRéférence du dossier.
invoice.amountExcludingVatnumberpeut être nullTotal hors TVA, net de la remise globale.
invoice.vatAmountnumberpeut être nullMontant de TVA.
invoice.amountIncludingVatnumberpeut être nullTotal TVA comprise.

Annotations MCP

AnnotationValeurSignification
titleAjouter des lignes à une factureNom lisible affiché par le client MCP.
readOnlyHintnonL'outil ne modifie rien.
destructiveHintnonL'outil peut modifier ou supprimer des données existantes, ou déclencher une action irréversible.
idempotentHintnonRappeler 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": "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
  }
}