Tools
The server exposes 81 tools, grouped by domain. Each tool page shows the exact text sent to the model, the parameters, the result schema, the annotations and the Oxygenius permission required.
The list returned by tools/list depends on the signed-in user: a tool is listed only if the user has the permission of the matching Oxygenius screen, and write tools only if their company has enabled them. See Authentication & access.
The full catalogue is also available as JSON: /tools.json.
Projects (job sites)
The project (dossier) is the heart of Oxygenius: a job site, its customer, address, procedure and steps.
| Tool | Purpose | Behaviour | Permission |
|---|---|---|---|
search_dossiers | Rechercher des dossiers | Read-onlyIdempotent | dossier.list.view |
get_dossier | Détail d'un dossier | Read-onlyIdempotent | dossier.details.view |
create_dossier | Créer un dossier | Write | dossier.new-dossier.create |
update_dossier | Modifier un dossier | WriteDestructiveIdempotent | dossier-detail.dossier.edit + dossier.details.view |
Third parties (customers, suppliers, contacts)
The company's customers, suppliers and contacts, with their details and VAT regime.
| Tool | Purpose | Behaviour | Permission |
|---|---|---|---|
search_tiers | Rechercher des tiers | Read-onlyIdempotent | tiers.list.view |
get_tiers | Détail d'un tiers | Read-onlyIdempotent | tiers.list.view |
create_tiers | Créer un tiers | Write | tiers.new-tiers.create |
update_tiers | Modifier un tiers | WriteDestructiveIdempotent | tiers.tiers.edit |
check_vat | Vérifier un numéro de TVA | WriteIdempotentOpen world | tiers.new-tiers.create or tiers.tiers.edit |
Planning & calendar
Crew and equipment planning on job sites, and the appointment calendar.
| Tool | Purpose | Behaviour | Permission |
|---|---|---|---|
search_planning_events | Rechercher dans le planning | Read-onlyIdempotent | planning.list.view |
get_planning_event | Détail d'un événement du planning | Read-onlyIdempotent | planning.list.view |
search_calendar_events | Rechercher dans le calendrier | Read-onlyIdempotent | calendar.list.view or calendar-hybrid.list.view |
get_calendar_event | Détail d'un événement du calendrier | Read-onlyIdempotent | calendar.list.view or calendar-hybrid.list.view |
get_agenda_lists | Listes de l'agenda | Read-onlyIdempotent | planning.list.view or calendar.list.view or calendar-hybrid.list.view |
create_planning_event | Planifier un événement | Write | planning.list.view |
update_planning_event | Modifier un événement du planning | WriteDestructive | planning.list.view |
create_calendar_event | Ajouter un événement au calendrier | Write | calendar.list.view or calendar-hybrid.list.view |
update_calendar_event | Modifier un événement du calendrier | WriteDestructive | calendar.list.view or calendar-hybrid.list.view |
Estimates (quotes)
Searching, drafting and following up estimates: lines, versions, printing and the customer's decision.
| Tool | Purpose | Behaviour | Permission |
|---|---|---|---|
search_estimates | Rechercher des devis | Read-onlyIdempotent | estimate.list.view |
get_estimate | Détail d'un devis | Read-onlyIdempotent | estimate.list.view |
create_estimate | Créer un devis | Write | dossier-detail.estimate.create + estimate.list.view |
update_estimate | Modifier un devis | WriteDestructiveIdempotent | estimate.list.view |
add_estimate_lines | Ajouter des lignes à un devis | Write | estimate.list.view |
update_estimate_lines | Modifier des lignes d'un devis | WriteDestructiveIdempotent | estimate.list.view |
remove_estimate_lines | Retirer des lignes d'un devis | WriteDestructiveIdempotent | estimate.list.view |
create_estimate_version | Nouvelle version d'un devis | Write | estimate.list.view |
print_estimate | Imprimer un devis | Write | estimate.list.view |
prepare_estimate_decision | Préparer la décision sur un devis | WriteIdempotentPrepares an action, no effect | estimate.list.view |
accept_estimate | Accepter un devis | WriteDestructiveRequires a confirmation token | estimate.list.view |
refuse_estimate | Refuser un devis | WriteDestructiveRequires a confirmation token | estimate.list.view |
Invoices
Invoices, free or from an estimate (deposit, progress, final): drafts and legal numbering.
| Tool | Purpose | Behaviour | Permission |
|---|---|---|---|
search_invoices | Rechercher des factures | Read-onlyIdempotent | invoice.list.view |
get_invoice | Détail d'une facture | Read-onlyIdempotent | invoice.list.view |
create_invoice | Créer une facture | Write | dossier-detail.invoice.create + invoice.list.view |
update_invoice | Modifier une facture | WriteDestructiveIdempotent | invoice.list.view |
add_invoice_lines | Ajouter des lignes à une facture | Write | invoice.list.view |
update_invoice_lines | Modifier des lignes d'une facture | WriteDestructiveIdempotent | invoice.list.view |
remove_invoice_lines | Retirer des lignes d'une facture | WriteDestructiveIdempotent | invoice.list.view |
prepare_invoice_finalization | Préparer la numérotation d'une facture | WriteIdempotentPrepares an action, no effect | invoice.list.view |
finalize_invoice | Numéroter une facture | WriteDestructiveRequires a confirmation token | invoice.list.view |
Credit notes
Credit notes, free or from an invoice: drafts and legal numbering.
| Tool | Purpose | Behaviour | Permission |
|---|---|---|---|
search_credit_notes | Rechercher des notes de crédit | Read-onlyIdempotent | credit-note.list.view |
get_credit_note | Détail d'une note de crédit | Read-onlyIdempotent | credit-note.list.view |
create_credit_note | Créer une note de crédit | Write | dossier-detail.credit-note.create + credit-note.list.view |
update_credit_note | Modifier une note de crédit | WriteDestructiveIdempotent | credit-note.list.view |
add_credit_note_lines | Ajouter des lignes à une note de crédit | Write | credit-note.list.view |
update_credit_note_lines | Modifier des lignes d'une note de crédit | WriteDestructiveIdempotent | credit-note.list.view |
remove_credit_note_lines | Retirer des lignes d'une note de crédit | WriteDestructiveIdempotent | credit-note.list.view |
prepare_credit_note_finalization | Préparer la numérotation d'une note de crédit | WriteIdempotentPrepares an action, no effect | credit-note.list.view |
finalize_credit_note | Numéroter une note de crédit | WriteDestructiveRequires a confirmation token | credit-note.list.view |
E-invoicing & accountant
Official sending of an invoice or credit note over Peppol, or to the accountant, always in two steps.
| Tool | Purpose | Behaviour | Permission |
|---|---|---|---|
prepare_peppol_send | Préparer un envoi Peppol | WriteIdempotentPrepares an action, no effect | peppol.all.send |
send_peppol | Envoyer par Peppol | WriteDestructiveOpen worldRequires a confirmation token | peppol.all.send |
prepare_accountant_send | Préparer un envoi au comptable | WriteIdempotentPrepares an action, no effect | invoice.list.view or credit-note.list.view |
send_to_accountant | Envoyer au comptable | WriteDestructiveOpen worldRequires a confirmation token | invoice.list.view or credit-note.list.view |
Items, assemblies & stock
The catalogue of items and assemblies, their prices and, with the Stock module, their availability.
| Tool | Purpose | Behaviour | Permission |
|---|---|---|---|
search_items | Rechercher des articles | Read-onlyIdempotent | item-job.list.view |
get_item | Détail d'un article | Read-onlyIdempotent | item-job.list.view |
get_item_stock | Stock d'un article | Read-onlyIdempotent | item-job.list.view + Stock module |
Tasks
Requests that colleagues send to each other, usually about a project.
| Tool | Purpose | Behaviour | Permission |
|---|---|---|---|
search_tasks | Rechercher des tâches | Read-onlyIdempotent | dashboard.tasksWidget.view or dossier-detail.tab.task |
get_my_tasks | Mes tâches | Read-onlyIdempotent | dashboard.tasksWidget.view or dossier-detail.tab.task |
get_task | Détail d'une tâche | Read-onlyIdempotent | dashboard.tasksWidget.view or dossier-detail.tab.task |
list_task_types | Types de tâche | Read-onlyIdempotent | dashboard.tasksWidget.view or dossier-detail.tab.task |
create_task | Créer une tâche | Write | dashboard.tasksWidget.view or dossier-detail.tab.task |
reply_task | Répondre à une tâche | WriteDestructive | dashboard.tasksWidget.view or dossier-detail.tab.task |
transfer_task | Transférer une tâche | WriteDestructive | dashboard.tasksWidget.view or dossier-detail.tab.task |
set_task_pinned | Épingler une tâche | WriteIdempotent | dashboard.tasksWidget.view or dossier-detail.tab.task |
update_my_task | Modifier une de mes tâches | WriteDestructiveIdempotent | dashboard.tasksWidget.view or dossier-detail.tab.task |
E-mails
The Oxygenius mailbox, synchronised with Microsoft 365: reading, drafts and confirmed sending.
| Tool | Purpose | Behaviour | Permission |
|---|---|---|---|
search_emails | Rechercher des courriels | Read-onlyIdempotentOpen world | mail-inbox.list.view or mail-outbox.list.view or mail-sendbox.list.view or mail-trashbox.list.view or all-mail.list.view or dossier-detail.tab.mailbox |
get_my_emails | Mes courriels | Read-onlyIdempotentOpen world | mail-inbox.list.view or mail-outbox.list.view or mail-sendbox.list.view or mail-trashbox.list.view or all-mail.list.view or dossier-detail.tab.mailbox |
get_email | Détail d'un courriel | Read-onlyIdempotentOpen world | mail-inbox.list.view or mail-outbox.list.view or mail-sendbox.list.view or mail-trashbox.list.view or all-mail.list.view or dossier-detail.tab.mailbox |
list_dossier_emails | Courriels d'un dossier | Read-onlyIdempotentOpen world | dossier-detail.tab.mailbox + dossier.details.view |
create_email_draft | Créer un brouillon de courriel | Write | mail-inbox.list.view or mail-outbox.list.view or mail-sendbox.list.view or mail-trashbox.list.view or all-mail.list.view or dossier-detail.tab.mailbox |
create_document_email | Préparer l'envoi d'un document par courriel | Write | mail-inbox.list.view or mail-outbox.list.view or mail-sendbox.list.view or mail-trashbox.list.view or all-mail.list.view or dossier-detail.tab.mailbox |
update_email_draft | Modifier un brouillon de courriel | WriteDestructiveIdempotent | mail-inbox.list.view or mail-outbox.list.view or mail-sendbox.list.view or mail-trashbox.list.view or all-mail.list.view or dossier-detail.tab.mailbox |
attach_documents_to_email | Joindre des documents à un courriel | Write | mail-inbox.list.view or mail-outbox.list.view or mail-sendbox.list.view or mail-trashbox.list.view or all-mail.list.view or dossier-detail.tab.mailbox |
remove_email_attachments | Retirer des pièces jointes d'un courriel | WriteDestructive | mail-inbox.list.view or mail-outbox.list.view or mail-sendbox.list.view or mail-trashbox.list.view or all-mail.list.view or dossier-detail.tab.mailbox |
prepare_email_send | Préparer l'envoi d'un courriel | WriteIdempotentPrepares an action, no effect | mail-inbox.list.view or mail-outbox.list.view or mail-sendbox.list.view or mail-trashbox.list.view or all-mail.list.view or dossier-detail.tab.mailbox |
send_email | Envoyer un courriel | WriteDestructiveOpen worldRequires a confirmation token | mail-inbox.list.view or mail-outbox.list.view or mail-sendbox.list.view or mail-trashbox.list.view or all-mail.list.view or dossier-detail.tab.mailbox |
Documents
Project files and e-mail attachments: listing, text reading, download link.
| Tool | Purpose | Behaviour | Permission |
|---|---|---|---|
list_dossier_documents | Documents d'un dossier | Read-onlyIdempotent | dossier-detail.tab.document + dossier.details.view |
read_document | Lire un document | Read-onlyIdempotentOpen world | dossier-detail.tab.document or mail-inbox.list.view or mail-outbox.list.view or mail-sendbox.list.view or mail-trashbox.list.view or all-mail.list.view or dossier-detail.tab.mailbox |
get_document_download_link | Lien de téléchargement d'un document | Read-only | dossier-detail.tab.document or mail-inbox.list.view or mail-outbox.list.view or mail-sendbox.list.view or mail-trashbox.list.view or all-mail.list.view or dossier-detail.tab.mailbox |
Profile & reference data
Who is signed in, whom to assign, and the values of the form drop-down lists.
| Tool | Purpose | Behaviour | Permission |
|---|---|---|---|
get_my_profile | Mon profil | Read-onlyIdempotent | No permission (signed-in user's own data) |
search_users | Rechercher une personne | Read-onlyIdempotent | dashboard.tasksWidget.view or dossier-detail.tab.task or dossier.new-dossier.create or dossier-detail.dossier.edit |
get_reference_lists | Listes de référence | Read-onlyIdempotent | tiers.new-tiers.create or tiers.tiers.edit or dossier.new-dossier.create or dossier-detail.dossier.edit or invoice.list.view |