Détail d'une facture
Tool name
get_invoiceRead-onlyIdempotent
Returns an invoice: customer, amounts, retention, balance, payments received, structured reference, lines, invoiced estimate and credit notes.
Description
Renvoie le détail d'une facture : client, montants, retenue de garantie, solde, paiements reçus, communication structurée, lignes, devis facturé et notes de crédit. Montants en euros ; le total hors TVA est net de la remise globale.
Required access
- Permission:
invoice.list.view - Without them, the tool is not listed by
tools/listand calling it is refused.
Parameters
| Name | Type | Presence | Description |
|---|---|---|---|
invoiceId | integer | required | Identifiant de la facture (champ id de search_invoices). |
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 facture. |
customerAddress | string | nullable | Adresse du client imprimée sur la facture. |
customerOrderNumber | string | nullable | Référence de commande (bon de commande) du client. |
dossierIndication | string | nullable | Intitulé court du dossier. |
structuredCommunication | string | nullable | Communication structurée du virement. |
paymentTerm | string | nullable | Condition de paiement. |
discountPercentage | number | nullable | Remise globale en pourcents. |
discountAmount | number | nullable | Montant de la remise globale (hors TVA). |
retentionPercentage | number | nullable | Retenue de garantie en pourcents. |
retentionAmount | number | nullable | Montant de la retenue de garantie. |
paidAmount | number | nullable | Total des paiements reçus. |
creditedAmount | number | nullable | Total des notes de crédit sur cette facture, TVA comprise. |
payments | object[] | Paiements reçus. | |
payments[].date | string (date) | Date du paiement. | |
payments[].amount | number | nullable | Montant payé. |
payments[].method | string | nullable | Moyen de paiement. |
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 facture. | |
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). |
estimateId | integer | nullable | Identifiant du devis facturé (à passer à get_estimate ; absent sans accès aux devis). |
estimateReference | string | nullable | Numéro du devis facturé. |
creditNotes | object[] | Notes de crédit sur cette facture (vide sans accès aux notes de crédit). | |
creditNotes[].id | integer | Identifiant du document lié. | |
creditNotes[].reference | string | nullable | Numéro du document lié. |
creditNotes[].type | string | nullable | Type de facture (acompte, finale, avancement…). |
creditNotes[].status | string | nullable | Statut du document lié. |
creditNotes[].date | string (date) | nullable | Date du document lié. |
creditNotes[].amountIncludingVat | number | nullable | Total TVA comprise. |
type | string | nullable | Type : acompte, finale, état d'avancement, intervention, proforma… |
dueDate | string (date) | nullable | Date d'échéance. |
amountDue | number | nullable | Montant à payer TVA comprise : le total, diminué de la retenue de garantie éventuelle. |
outstanding | number | nullable | Solde restant dû : montant à payer moins paiements et notes de crédit (absent pour un brouillon, une facture annulée ou proforma). |
isOverdue | boolean | Vrai si la facture est ouverte, échue et pas soldée. | |
daysOverdue | integer | nullable | Nombre de jours depuis l'échéance, pour une facture en retard. |
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 | Détail d'une facture | Human-readable name shown by the MCP client. |
readOnlyHint | yes | The tool changes nothing. |
destructiveHint | no | 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": "get_invoice",
"title": "Détail d'une facture",
"description": "Renvoie le détail d'une facture : client, montants, retenue de garantie, solde, paiements reçus, communication structurée, lignes, devis facturé et notes de crédit. Montants en euros ; le total hors TVA est net de la remise globale.",
"inputSchema": {
"type": "object",
"properties": {
"invoiceId": {
"description": "Identifiant de la facture (champ id de search_invoices).",
"type": "integer"
}
},
"required": [
"invoiceId"
]
},
"outputSchema": {
"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"
]
},
"annotations": {
"title": "Détail d'une facture",
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": true
}
}