Détail d'une note de crédit

Tool nameget_credit_note
Read-onlyIdempotent

Returns a credit note: customer, credited invoice, amounts and VAT breakdown, lines.

Description

Exact text sent to the model by tools/list (French, the language of the data):

Renvoie le détail d'une note de crédit : client, facture créditée, montants et ventilation TVA, lignes. Montants en euros ; le total hors TVA est net de la remise globale.

Required access

Parameters

NameTypePresenceDescription
creditNoteIdintegerrequiredIdentifiant de la note de crédit (champ id de search_credit_notes).

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
NameTypePresenceDescription
customerVatNumberstringnullableNuméro de TVA du client imprimé sur la note de crédit.
customerAddressstringnullableAdresse du client imprimée sur la note de crédit.
dossierIndicationstringnullableIntitulé court du dossier.
structuredCommunicationstringnullableCommunication structurée.
discountPercentagenumbernullableRemise globale en pourcents.
discountAmountnumbernullableMontant de la remise globale (hors TVA).
vatBreakdownobject[]Montant de TVA par taux.
vatBreakdown[].ratestringnullableCode du taux de TVA (ex. 21, 6, CO pour cocontractant).
vatBreakdown[].percentagenumbernullablePourcentage de TVA.
vatBreakdown[].amountnumbernullableMontant de TVA à ce taux.
linesobjectLignes de la note de crédit.
lines.totalCountintegerNombre total de lignes du document.
lines.isTruncatedbooleanVrai si le document compte plus de lignes que celles renvoyées.
lines.itemsobject[]Lignes dans l'ordre du document.
lines.items[].idintegerIdentifiant de la ligne (lineId ou parentLineId des outils de modification d'un devis).
lines.items[].numberstringnullableNuméro de la ligne tel qu'imprimé (ex. 1.2).
lines.items[].typestringsupertitle, title, subtitle, item (article) ou other.
lines.items[].isOptionbooleanVrai pour une ligne en option (variante), non comprise dans les totaux.
lines.items[].namestringnullableLibellé de la ligne.
lines.items[].descriptionstringnullableDescription détaillée.
lines.items[].quantitynumbernullableQuantité (articles).
lines.items[].unitstringnullableUnité (articles).
lines.items[].unitPricenumbernullablePrix unitaire hors TVA (articles).
lines.items[].vatRatenumbernullableTaux de TVA en pourcents (articles).
lines.items[].discountAmountnumbernullableRemise accordée sur la ligne (articles).
lines.items[].amountExcludingVatnumbernullableMontant hors TVA, net de la remise de la ligne (articles).
lines.items[].remarkstringnullableRemarque imprimée sous la ligne (devis).
lines.items[].depositInvoiceIdintegernullableFacture d'acompte déduite par cette ligne (à passer à get_invoice).
invoiceIdintegernullableIdentifiant de la facture créditée (à passer à get_invoice), si la note en crédite une.
invoiceReferencestringnullableNuméro de la facture créditée.
idintegerIdentifiant du document (à passer à l'outil de détail).
referencestringnullableNuméro du document (vide pour un brouillon de facture ou de note de crédit).
statusstringnullableStatut du document.
datestring (date)nullableDate du document.
customerstringnullableClient tel qu'imprimé sur le document.
tiersIdintegerIdentifiant du tiers client (à passer à get_tiers).
dossierIdintegerIdentifiant du dossier (à passer à get_dossier).
dossierReferencestringnullableRéférence du dossier.
amountExcludingVatnumbernullableTotal hors TVA, net de la remise globale.
vatAmountnumbernullableMontant de TVA.
amountIncludingVatnumbernullableTotal TVA comprise.

MCP annotations

AnnotationValueMeaning
titleDétail d'une note de créditHuman-readable name shown by the MCP client.
readOnlyHintyesThe tool changes nothing.
destructiveHintnoThe tool may change or delete existing data, or trigger an irreversible action.
idempotentHintyesCalling it again with the same arguments has no further effect.
openWorldHintnoThe tool reads e-mails or document content, or reaches an external service.

JSON definition

Exact tools/list entry
{
  "name": "get_credit_note",
  "title": "Détail d'une note de crédit",
  "description": "Renvoie le détail d'une note de crédit : client, facture créditée, montants et ventilation TVA, lignes. Montants en euros ; le total hors TVA est net de la remise globale.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "creditNoteId": {
        "description": "Identifiant de la note de crédit (champ id de search_credit_notes).",
        "type": "integer"
      }
    },
    "required": [
      "creditNoteId"
    ]
  },
  "outputSchema": {
    "type": "object",
    "properties": {
      "customerVatNumber": {
        "description": "Numéro de TVA du client imprimé sur la note de crédit.",
        "type": [
          "string",
          "null"
        ]
      },
      "customerAddress": {
        "description": "Adresse du client imprimée sur la note de crédit.",
        "type": [
          "string",
          "null"
        ]
      },
      "dossierIndication": {
        "description": "Intitulé court du dossier.",
        "type": [
          "string",
          "null"
        ]
      },
      "structuredCommunication": {
        "description": "Communication structurée.",
        "type": [
          "string",
          "null"
        ]
      },
      "discountPercentage": {
        "description": "Remise globale en pourcents.",
        "type": [
          "number",
          "null"
        ]
      },
      "discountAmount": {
        "description": "Montant de la remise globale (hors TVA).",
        "type": [
          "number",
          "null"
        ]
      },
      "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 note de crédit.",
        "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"
        ]
      },
      "invoiceId": {
        "description": "Identifiant de la facture créditée (à passer à get_invoice), si la note en crédite une.",
        "type": [
          "integer",
          "null"
        ]
      },
      "invoiceReference": {
        "description": "Numéro de la facture créditée.",
        "type": [
          "string",
          "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 note de crédit",
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false,
    "readOnlyHint": true
  }
}