Détail d'un dossier
Tool name
get_dossierRead-onlyIdempotent
Returns a project: status, site type, manager, site address, current step and procedure steps, linked third parties and counts of estimates, invoices and credit notes.
Description
Renvoie le détail d'un dossier (chantier) Oxygenius : statut, type de chantier, gestionnaire, adresse du chantier, étape en cours et étapes de la procédure, tiers liés avec leur rôle et leurs coordonnées, et nombre de devis, factures et notes de crédit.
Required access
- Permission:
dossier.details.view - Without them, the tool is not listed by
tools/listand calling it is refused.
Parameters
| Name | Type | Presence | Description |
|---|---|---|---|
dossierId | integer | required | Identifiant technique du dossier (champ id de search_dossiers). |
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 |
|---|---|---|---|
id | integer | Identifiant technique du dossier. | |
reference | string | nullable | Référence du dossier. |
indication | string | nullable | Intitulé court du dossier (indication). |
status | string | nullable | Libellé du statut du dossier. |
siteType | string | nullable | Type de chantier. |
isActive | boolean | Faux si le dossier est désactivé. | |
externalReference1 | string | nullable | Référence externe 1 (référence client). |
externalReference2 | string | nullable | Référence externe 2. |
manager | string | nullable | Nom du gestionnaire du dossier. |
creationDate | string (date) | nullable | Date de création du dossier (AAAA-MM-JJ). |
siteAddress | string | nullable | Adresse du chantier : celle du tiers « chantier » s'il y en a un, sinon celle du dossier. |
currentStep | string | nullable | Étape en cours : première étape non terminée de la procédure. |
steps | object[] | Étapes de la procédure, dans l'ordre. | |
steps[].name | string | nullable | Nom de l'étape. |
steps[].isCompleted | boolean | Vrai si l'étape est terminée. | |
steps[].completedOn | string (date) | nullable | Date de fin de l'étape (AAAA-MM-JJ), si elle est terminée. |
steps[].dueDate | string (date) | nullable | Échéance prévue de l'étape (AAAA-MM-JJ). |
tiers | object[] | Tiers liés au dossier, avec leur rôle (propriétaire, locataire, contact, provenance…). | |
tiers[].tiersId | integer | Identifiant technique du tiers (à passer à get_tiers). | |
tiers[].role | string | nullable | Rôle du tiers dans le dossier (libellé). |
tiers[].name | string | Dénomination : société, sinon nom et prénom. | |
tiers[].reference | string | nullable | Référence du tiers. |
tiers[].email | string | nullable | Courriel principal. |
tiers[].phone | string | nullable | Téléphone principal. |
tiers[].isInvoiceReceiver | boolean | Vrai si le tiers reçoit les factures du dossier. | |
tiers[].isSiteTiers | boolean | Vrai si l'adresse du tiers est l'adresse du chantier. | |
estimateCount | integer | nullable | Nombre de devis du dossier (null sans accès aux devis). Détail : search_estimates avec dossierId. |
invoiceCount | integer | nullable | Nombre de factures du dossier (null sans accès aux factures). Détail : search_invoices avec dossierId. |
creditNoteCount | integer | nullable | Nombre de notes de crédit du dossier (null sans accès). Détail : search_credit_notes avec dossierId. |
MCP annotations
| Annotation | Value | Meaning |
|---|---|---|
title | Détail d'un dossier | 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_dossier",
"title": "Détail d'un dossier",
"description": "Renvoie le détail d'un dossier (chantier) Oxygenius : statut, type de chantier, gestionnaire, adresse du chantier, étape en cours et étapes de la procédure, tiers liés avec leur rôle et leurs coordonnées, et nombre de devis, factures et notes de crédit.",
"inputSchema": {
"type": "object",
"properties": {
"dossierId": {
"description": "Identifiant technique du dossier (champ id de search_dossiers).",
"type": "integer"
}
},
"required": [
"dossierId"
]
},
"outputSchema": {
"type": "object",
"properties": {
"id": {
"description": "Identifiant technique du dossier.",
"type": "integer"
},
"reference": {
"description": "Référence du dossier.",
"type": [
"string",
"null"
]
},
"indication": {
"description": "Intitulé court du dossier (indication).",
"type": [
"string",
"null"
]
},
"status": {
"description": "Libellé du statut du dossier.",
"type": [
"string",
"null"
]
},
"siteType": {
"description": "Type de chantier.",
"type": [
"string",
"null"
]
},
"isActive": {
"description": "Faux si le dossier est désactivé.",
"type": "boolean"
},
"externalReference1": {
"description": "Référence externe 1 (référence client).",
"type": [
"string",
"null"
]
},
"externalReference2": {
"description": "Référence externe 2.",
"type": [
"string",
"null"
]
},
"manager": {
"description": "Nom du gestionnaire du dossier.",
"type": [
"string",
"null"
]
},
"creationDate": {
"description": "Date de création du dossier (AAAA-MM-JJ).",
"type": [
"string",
"null"
],
"format": "date"
},
"siteAddress": {
"description": "Adresse du chantier : celle du tiers « chantier » s'il y en a un, sinon celle du dossier.",
"type": [
"string",
"null"
]
},
"currentStep": {
"description": "Étape en cours : première étape non terminée de la procédure.",
"type": [
"string",
"null"
]
},
"steps": {
"description": "Étapes de la procédure, dans l'ordre.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Nom de l'étape.",
"type": [
"string",
"null"
]
},
"isCompleted": {
"description": "Vrai si l'étape est terminée.",
"type": "boolean"
},
"completedOn": {
"description": "Date de fin de l'étape (AAAA-MM-JJ), si elle est terminée.",
"type": [
"string",
"null"
],
"format": "date"
},
"dueDate": {
"description": "Échéance prévue de l'étape (AAAA-MM-JJ).",
"type": [
"string",
"null"
],
"format": "date"
}
},
"required": [
"isCompleted"
]
}
},
"tiers": {
"description": "Tiers liés au dossier, avec leur rôle (propriétaire, locataire, contact, provenance…).",
"type": "array",
"items": {
"type": "object",
"properties": {
"tiersId": {
"description": "Identifiant technique du tiers (à passer à get_tiers).",
"type": "integer"
},
"role": {
"description": "Rôle du tiers dans le dossier (libellé).",
"type": [
"string",
"null"
]
},
"name": {
"description": "Dénomination : société, sinon nom et prénom.",
"type": "string"
},
"reference": {
"description": "Référence du tiers.",
"type": [
"string",
"null"
]
},
"email": {
"description": "Courriel principal.",
"type": [
"string",
"null"
]
},
"phone": {
"description": "Téléphone principal.",
"type": [
"string",
"null"
]
},
"isInvoiceReceiver": {
"description": "Vrai si le tiers reçoit les factures du dossier.",
"type": "boolean"
},
"isSiteTiers": {
"description": "Vrai si l'adresse du tiers est l'adresse du chantier.",
"type": "boolean"
}
},
"required": [
"tiersId",
"name",
"isInvoiceReceiver",
"isSiteTiers"
]
}
},
"estimateCount": {
"description": "Nombre de devis du dossier (null sans accès aux devis). Détail : search_estimates avec dossierId.",
"type": [
"integer",
"null"
]
},
"invoiceCount": {
"description": "Nombre de factures du dossier (null sans accès aux factures). Détail : search_invoices avec dossierId.",
"type": [
"integer",
"null"
]
},
"creditNoteCount": {
"description": "Nombre de notes de crédit du dossier (null sans accès). Détail : search_credit_notes avec dossierId.",
"type": [
"integer",
"null"
]
}
},
"required": [
"id",
"isActive"
]
},
"annotations": {
"title": "Détail d'un dossier",
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": true
}
}