Rechercher des factures
search_invoicesLists or searches invoices with their outstanding balance and payment delay, including overdue invoices.
Description
Liste ou recherche les factures Oxygenius, de la plus récente à la plus ancienne, avec leur solde restant dû et leur retard de paiement. Filtrer par dossierId pour toutes les factures d'un dossier, par estimateId pour celles d'un devis (avenants compris), par state=overdue pour les factures en retard. Montants en euros ; le total hors TVA est net de la remise globale. Utiliser get_invoice pour les lignes et les paiements.
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 |
|---|---|---|---|
query | string | optional | Mots-clés : numéro, communication structurée, référence de commande, client, référence ou intitulé du dossier. |
dossierId | integer | optional | Identifiant d'un dossier pour n'avoir que ses factures. |
estimateId | integer | optional | Identifiant d'un devis pour n'avoir que ses factures. |
tiersId | integer | optional | Identifiant d'un tiers pour n'avoir que ses factures. |
state | string | optional | all (défaut), draft (brouillon), open (à payer), overdue (échue et pas soldée), paid ou canceled. |
type | string | optional | all (défaut), deposit (acompte), final, advancement (état d'avancement), intervention ou proforma. |
from | string (date) | optional | Premier jour de la date de facture (AAAA-MM-JJ). |
to | string (date) | optional | Dernier jour de la date de facture (AAAA-MM-JJ), inclus. |
limit | integer | optional | Nombre de résultats souhaités (10 par défaut, plafonné par le serveur). |
offset | integer | optional | Nombre de résultats à sauter pour la pagination (0 par défaut). |
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 |
|---|---|---|---|
totalCount | integer | Nombre total d'éléments correspondant aux critères. | |
offset | integer | Position du premier élément de la page. | |
limit | integer | Taille de page appliquée (le serveur plafonne la valeur demandée). | |
hasMore | boolean | Vrai s'il reste des éléments : rappeler l'outil avec offset = offset + limit. | |
items | object[] | Éléments de la page. | |
items[].type | string | nullable | Type : acompte, finale, état d'avancement, intervention, proforma… |
items[].dueDate | string (date) | nullable | Date d'échéance. |
items[].amountDue | number | nullable | Montant à payer TVA comprise : le total, diminué de la retenue de garantie éventuelle. |
items[].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). |
items[].isOverdue | boolean | Vrai si la facture est ouverte, échue et pas soldée. | |
items[].daysOverdue | integer | nullable | Nombre de jours depuis l'échéance, pour une facture en retard. |
items[].id | integer | Identifiant du document (à passer à l'outil de détail). | |
items[].reference | string | nullable | Numéro du document (vide pour un brouillon de facture ou de note de crédit). |
items[].status | string | nullable | Statut du document. |
items[].date | string (date) | nullable | Date du document. |
items[].customer | string | nullable | Client tel qu'imprimé sur le document. |
items[].tiersId | integer | Identifiant du tiers client (à passer à get_tiers). | |
items[].dossierId | integer | Identifiant du dossier (à passer à get_dossier). | |
items[].dossierReference | string | nullable | Référence du dossier. |
items[].amountExcludingVat | number | nullable | Total hors TVA, net de la remise globale. |
items[].vatAmount | number | nullable | Montant de TVA. |
items[].amountIncludingVat | number | nullable | Total TVA comprise. |
MCP annotations
| Annotation | Value | Meaning |
|---|---|---|
title | Rechercher des factures | 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": "search_invoices",
"title": "Rechercher des factures",
"description": "Liste ou recherche les factures Oxygenius, de la plus récente à la plus ancienne, avec leur solde restant dû et leur retard de paiement. Filtrer par dossierId pour toutes les factures d'un dossier, par estimateId pour celles d'un devis (avenants compris), par state=overdue pour les factures en retard. Montants en euros ; le total hors TVA est net de la remise globale. Utiliser get_invoice pour les lignes et les paiements.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"description": "Mots-clés : numéro, communication structurée, référence de commande, client, référence ou intitulé du dossier.",
"type": [
"string",
"null"
],
"default": null
},
"dossierId": {
"description": "Identifiant d'un dossier pour n'avoir que ses factures.",
"type": [
"integer",
"null"
],
"default": null
},
"estimateId": {
"description": "Identifiant d'un devis pour n'avoir que ses factures.",
"type": [
"integer",
"null"
],
"default": null
},
"tiersId": {
"description": "Identifiant d'un tiers pour n'avoir que ses factures.",
"type": [
"integer",
"null"
],
"default": null
},
"state": {
"description": "all (défaut), draft (brouillon), open (à payer), overdue (échue et pas soldée), paid ou canceled.",
"type": [
"string",
"null"
],
"default": null
},
"type": {
"description": "all (défaut), deposit (acompte), final, advancement (état d'avancement), intervention ou proforma.",
"type": [
"string",
"null"
],
"default": null
},
"from": {
"description": "Premier jour de la date de facture (AAAA-MM-JJ).",
"type": [
"string",
"null"
],
"format": "date",
"default": null
},
"to": {
"description": "Dernier jour de la date de facture (AAAA-MM-JJ), inclus.",
"type": [
"string",
"null"
],
"format": "date",
"default": null
},
"limit": {
"description": "Nombre de résultats souhaités (10 par défaut, plafonné par le serveur).",
"type": "integer",
"default": 10
},
"offset": {
"description": "Nombre de résultats à sauter pour la pagination (0 par défaut).",
"type": "integer",
"default": 0
}
}
},
"outputSchema": {
"type": "object",
"properties": {
"totalCount": {
"description": "Nombre total d'éléments correspondant aux critères.",
"type": "integer"
},
"offset": {
"description": "Position du premier élément de la page.",
"type": "integer"
},
"limit": {
"description": "Taille de page appliquée (le serveur plafonne la valeur demandée).",
"type": "integer"
},
"hasMore": {
"description": "Vrai s'il reste des éléments : rappeler l'outil avec offset = offset + limit.",
"type": "boolean"
},
"items": {
"description": "Éléments de la page.",
"type": "array",
"items": {
"type": "object",
"properties": {
"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": [
"id",
"tiersId",
"dossierId"
]
}
}
},
"required": [
"totalCount",
"offset",
"limit",
"hasMore",
"items"
]
},
"annotations": {
"title": "Rechercher des factures",
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": true
}
}