Rechercher des factures

Nom de l'outilsearch_invoices
Lecture seuleIdempotent

Description

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

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.

Accès requis

Paramètres

NomTypePrésenceDescription
querystringfacultatifMots-clés : numéro, communication structurée, référence de commande, client, référence ou intitulé du dossier.
dossierIdintegerfacultatifIdentifiant d'un dossier pour n'avoir que ses factures.
estimateIdintegerfacultatifIdentifiant d'un devis pour n'avoir que ses factures.
tiersIdintegerfacultatifIdentifiant d'un tiers pour n'avoir que ses factures.
statestringfacultatifall (défaut), draft (brouillon), open (à payer), overdue (échue et pas soldée), paid ou canceled.
typestringfacultatifall (défaut), deposit (acompte), final, advancement (état d'avancement), intervention ou proforma.
fromstring (date)facultatifPremier jour de la date de facture (AAAA-MM-JJ).
tostring (date)facultatifDernier jour de la date de facture (AAAA-MM-JJ), inclus.
limitintegerfacultatifNombre de résultats souhaités (10 par défaut, plafonné par le serveur).
Par défaut : 10
offsetintegerfacultatifNombre de résultats à sauter pour la pagination (0 par défaut).
Par défaut : 0

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
totalCountintegerNombre total d'éléments correspondant aux critères.
offsetintegerPosition du premier élément de la page.
limitintegerTaille de page appliquée (le serveur plafonne la valeur demandée).
hasMorebooleanVrai s'il reste des éléments : rappeler l'outil avec offset = offset + limit.
itemsobject[]Éléments de la page.
items[].typestringpeut être nullType : acompte, finale, état d'avancement, intervention, proforma…
items[].dueDatestring (date)peut être nullDate d'échéance.
items[].amountDuenumberpeut être nullMontant à payer TVA comprise : le total, diminué de la retenue de garantie éventuelle.
items[].outstandingnumberpeut être nullSolde restant dû : montant à payer moins paiements et notes de crédit (absent pour un brouillon, une facture annulée ou proforma).
items[].isOverduebooleanVrai si la facture est ouverte, échue et pas soldée.
items[].daysOverdueintegerpeut être nullNombre de jours depuis l'échéance, pour une facture en retard.
items[].idintegerIdentifiant du document (à passer à l'outil de détail).
items[].referencestringpeut être nullNuméro du document (vide pour un brouillon de facture ou de note de crédit).
items[].statusstringpeut être nullStatut du document.
items[].datestring (date)peut être nullDate du document.
items[].customerstringpeut être nullClient tel qu'imprimé sur le document.
items[].tiersIdintegerIdentifiant du tiers client (à passer à get_tiers).
items[].dossierIdintegerIdentifiant du dossier (à passer à get_dossier).
items[].dossierReferencestringpeut être nullRéférence du dossier.
items[].amountExcludingVatnumberpeut être nullTotal hors TVA, net de la remise globale.
items[].vatAmountnumberpeut être nullMontant de TVA.
items[].amountIncludingVatnumberpeut être nullTotal TVA comprise.

Annotations MCP

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