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.

81tools
32read-only
49write (opt-in)
25marked destructive
Each user only sees their tools

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.

ToolPurposeBehaviourPermission
search_dossiersRechercher des dossiers
Lists or searches the company's projects by reference, title, external references, site address and the name, address or phone of linked third parties, newest first.
Read-onlyIdempotent
dossier.list.view
get_dossierDétail d'un dossier
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.
Read-onlyIdempotent
dossier.details.view
create_dossierCréer un dossier
Creates a project for a customer, with its procedure steps, optional linked third parties, manager, site type and site address.
Write
dossier.new-dossier.create
update_dossierModifier un dossier
Updates a project's title, manager, site type, external references, origin or own site address; only the given fields change.
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.

ToolPurposeBehaviourPermission
search_tiersRechercher des tiers
Lists or searches customers, suppliers and contacts by reference, name, e-mail, address or phone.
Read-onlyIdempotent
tiers.list.view
get_tiersDétail d'un tiers
Returns a third party's contact details, address, VAT and company numbers, VAT regime, payment term and recent projects. Bank details are never returned.
Read-onlyIdempotent
tiers.list.view
create_tiersCréer un tiers
Creates a customer, supplier or contact. If similar third parties exist, nothing is created and they are returned as possible duplicates.
Write
tiers.new-tiers.create
update_tiersModifier un tiers
Updates a third party; only the given fields change. Bank details, Peppol identifiers, discount and remarks are never changed by this tool.
WriteDestructiveIdempotent
tiers.tiers.edit
check_vatVérifier un numéro de TVA
Checks a European VAT number with the European Commission's VIES service and returns the registered name and address, and the third parties that already use it.
WriteIdempotentOpen world
tiers.new-tiers.create or tiers.tiers.edit

Planning & calendar

Crew and equipment planning on job sites, and the appointment calendar.

ToolPurposeBehaviourPermission
search_planning_eventsRechercher dans le planning
Lists or searches planning entries (job sites, crews) over a period, one result per day with the people assigned. Next 30 days by default, 366 days at most.
Read-onlyIdempotent
planning.list.view
get_planning_eventDétail d'un événement du planning
Returns a planning entry: times, type, site state, people assigned, description, project with site address and customer, linked estimates.
Read-onlyIdempotent
planning.list.view
search_calendar_eventsRechercher dans le calendrier
Lists or searches calendar events (appointments, office, leave) over a period. Other users' private events show as "Private" without content.
Read-onlyIdempotent
calendar.list.view or calendar-hybrid.list.view
get_calendar_eventDétail d'un événement du calendrier
Returns a calendar event: times, type, people, description and linked project. Another user's private event stays hidden.
Read-onlyIdempotent
calendar.list.view or calendar-hybrid.list.view
get_agenda_listsListes de l'agenda
Returns the event types, site states and resources (people and equipment) of the planning or the calendar, with the identifiers the write tools expect.
Read-onlyIdempotent
planning.list.view or calendar.list.view or calendar-hybrid.list.view
create_planning_eventPlanifier un événement
Creates a planning entry on one day or consecutive days, at the same times, for people or equipment. No confirmation is sent to the customer.
Write
planning.list.view
update_planning_eventModifier un événement du planning
Updates one day of a planning entry, or all its days (times only). Only the given fields change.
WriteDestructive
planning.list.view
create_calendar_eventAjouter un événement au calendrier
Creates a calendar event on one day or consecutive days for one or more people. No confirmation is sent to the customer.
Write
calendar.list.view or calendar-hybrid.list.view
update_calendar_eventModifier un événement du calendrier
Updates one day of a calendar event, or all its days (times only). Another user's private event cannot be changed.
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.

ToolPurposeBehaviourPermission
search_estimatesRechercher des devis
Lists or searches estimates, including amendments and versions, newest first, with filters by project, customer, status and dates.
Read-onlyIdempotent
estimate.list.view
get_estimateDétail d'un devis
Returns an estimate: customer, amounts and VAT breakdown, lines, amendments, linked invoices and credit notes and, once accepted, the amount left to invoice.
Read-onlyIdempotent
estimate.list.view
create_estimateCréer un devis
Creates an empty draft estimate for a project, billed to the project's billing third party.
Write
dossier-detail.estimate.create + estimate.list.view
update_estimateModifier un devis
Updates an estimate's header (name, dates, billed third party) or applies a margin or discount to all its lines.
WriteDestructiveIdempotent
estimate.list.view
add_estimate_linesAjouter des lignes à un devis
Adds titles, subtitles, free lines and catalogue items or assemblies to an estimate; Oxygenius recalculates all amounts.
Write
estimate.list.view
update_estimate_linesModifier des lignes d'un devis
Updates estimate lines (label, description, quantity, price, margin, discount, VAT, unit); Oxygenius recalculates all amounts.
WriteDestructiveIdempotent
estimate.list.view
remove_estimate_linesRetirer des lignes d'un devis
Removes estimate lines, together with their child lines; Oxygenius recalculates all amounts.
WriteDestructiveIdempotent
estimate.list.view
create_estimate_versionNouvelle version d'un devis
Creates a new editable version of an estimate under the same number, like the "New version" button. The original is unchanged.
Write
estimate.list.view
print_estimateImprimer un devis
Generates the estimate PDF and files it in the project's documents; a draft estimate becomes "printed". Nothing is sent to the customer.
Write
estimate.list.view
prepare_estimate_decisionPréparer la décision sur un devis
Changes nothing: shows the effects of recording the customer's acceptance or refusal and returns a 10-minute confirmation token.
WriteIdempotentPrepares an action, no effect
estimate.list.view
accept_estimateAccepter un devis
Records the customer's acceptance prepared by prepare_estimate_decision; project automations (steps, tasks, work sheet) run.
WriteDestructiveRequires a confirmation token
estimate.list.view
refuse_estimateRefuser un devis
Records the customer's refusal prepared by prepare_estimate_decision.
WriteDestructiveRequires a confirmation token
estimate.list.view

Invoices

Invoices, free or from an estimate (deposit, progress, final): drafts and legal numbering.

ToolPurposeBehaviourPermission
search_invoicesRechercher des factures
Lists or searches invoices with their outstanding balance and payment delay, including overdue invoices.
Read-onlyIdempotent
invoice.list.view
get_invoiceDétail d'une facture
Returns an invoice: customer, amounts, retention, balance, payments received, structured reference, lines, invoiced estimate and credit notes.
Read-onlyIdempotent
invoice.list.view
create_invoiceCréer une facture
Creates an unnumbered draft invoice: free, or from an accepted estimate (deposit, progress or final). Nothing is numbered or sent.
Write
dossier-detail.invoice.create + invoice.list.view
update_invoiceModifier une facture
Updates a draft invoice's header: date, due date, payment term, purchase order, billed third party.
WriteDestructiveIdempotent
invoice.list.view
add_invoice_linesAjouter des lignes à une facture
Adds lines to a draft invoice; Oxygenius recalculates all amounts.
Write
invoice.list.view
update_invoice_linesModifier des lignes d'une facture
Updates lines of a draft invoice; Oxygenius recalculates all amounts.
WriteDestructiveIdempotent
invoice.list.view
remove_invoice_linesRetirer des lignes d'une facture
Removes lines from a draft invoice, together with their child lines.
WriteDestructiveIdempotent
invoice.list.view
prepare_invoice_finalizationPréparer la numérotation d'une facture
Changes nothing: shows what numbering a draft invoice will do (legal number, PDF and UBL, accounting) and returns a 10-minute confirmation token.
WriteIdempotentPrepares an action, no effect
invoice.list.view
finalize_invoiceNuméroter une facture
Gives a draft invoice its final legal number and prints it, as prepared by prepare_invoice_finalization. Nothing is sent to the customer.
WriteDestructiveRequires a confirmation token
invoice.list.view

Credit notes

Credit notes, free or from an invoice: drafts and legal numbering.

ToolPurposeBehaviourPermission
search_credit_notesRechercher des notes de crédit
Lists or searches credit notes, newest first, with filters by project, invoice, customer, status and dates.
Read-onlyIdempotent
credit-note.list.view
get_credit_noteDétail d'une note de crédit
Returns a credit note: customer, credited invoice, amounts and VAT breakdown, lines.
Read-onlyIdempotent
credit-note.list.view
create_credit_noteCréer une note de crédit
Creates an unnumbered draft credit note, free or from a numbered invoice that is neither paid nor cancelled.
Write
dossier-detail.credit-note.create + credit-note.list.view
update_credit_noteModifier une note de crédit
Updates a draft credit note's header: date and billed third party.
WriteDestructiveIdempotent
credit-note.list.view
add_credit_note_linesAjouter des lignes à une note de crédit
Adds lines to a draft credit note; Oxygenius recalculates all amounts.
Write
credit-note.list.view
update_credit_note_linesModifier des lignes d'une note de crédit
Updates lines of a draft credit note; Oxygenius recalculates all amounts.
WriteDestructiveIdempotent
credit-note.list.view
remove_credit_note_linesRetirer des lignes d'une note de crédit
Removes lines from a draft credit note, together with their child lines.
WriteDestructiveIdempotent
credit-note.list.view
prepare_credit_note_finalizationPréparer la numérotation d'une note de crédit
Changes nothing: shows what numbering a draft credit note will do, including its effect on the credited invoice, and returns a 10-minute confirmation token.
WriteIdempotentPrepares an action, no effect
credit-note.list.view
finalize_credit_noteNuméroter une note de crédit
Gives a draft credit note its final legal number and prints it, as prepared by prepare_credit_note_finalization.
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.

ToolPurposeBehaviourPermission
prepare_peppol_sendPréparer un envoi Peppol
Changes nothing: shows how a numbered invoice or credit note will be sent over Peppol (or Mercurius) and returns a 10-minute confirmation token.
WriteIdempotentPrepares an action, no effect
peppol.all.send
send_peppolEnvoyer par Peppol
Sends the prepared invoice or credit note over Peppol (or Mercurius). Irreversible; daily limit per user.
WriteDestructiveOpen worldRequires a confirmation token
peppol.all.send
prepare_accountant_sendPréparer un envoi au comptable
Changes nothing: shows how a numbered invoice or credit note will be sent to the company's accountant and returns a 10-minute confirmation token.
WriteIdempotentPrepares an action, no effect
invoice.list.view or credit-note.list.view
send_to_accountantEnvoyer au comptable
Sends the prepared invoice or credit note (UBL file) to the company's accountant by e-mail. Daily limit per user.
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.

ToolPurposeBehaviourPermission
search_itemsRechercher des articles
Lists or searches catalogue items and assemblies alphabetically, with their sale price and, with the Stock module, the quantity in stock.
Read-onlyIdempotent
item-job.list.view
get_itemDétail d'un article
Returns an item or assembly: description, sale prices, unit, category, suppliers and composition. The purchase price requires the profitability permission.
Read-onlyIdempotent
item-job.list.view
get_item_stockStock d'un article
Returns an item's stock (Stock module): quantity per location, state against thresholds, reorder quantity and latest movements.
Read-onlyIdempotent
item-job.list.view + Stock module

Tasks

Requests that colleagues send to each other, usually about a project.

ToolPurposeBehaviourPermission
search_tasksRechercher des tâches
Lists or searches the tasks visible to the user, urgent ones first; to-do tasks by default.
Read-onlyIdempotent
dashboard.tasksWidget.view or dossier-detail.tab.task
get_my_tasksMes tâches
Returns the signed-in user's tasks, like the dashboard widget: received, sent or scheduled.
Read-onlyIdempotent
dashboard.tasksWidget.view or dossier-detail.tab.task
get_taskDétail d'une tâche
Returns a task and the history of its thread: creation, replies, transfers and closing.
Read-onlyIdempotent
dashboard.tasksWidget.view or dossier-detail.tab.task
list_task_typesTypes de tâche
Lists the active task types; with assigneeId, only those that can be assigned to that person.
Read-onlyIdempotent
dashboard.tasksWidget.view or dossier-detail.tab.task
create_taskCréer une tâche
Creates a task on a project for one or more people (one task each, each notified).
Write
dashboard.tasksWidget.view or dossier-detail.tab.task
reply_taskRépondre à une tâche
Replies to a to-do task: the reply becomes a new task for the sender and the original is closed.
WriteDestructive
dashboard.tasksWidget.view or dossier-detail.tab.task
transfer_taskTransférer une tâche
Transfers a to-do task to another person; the original task is closed.
WriteDestructive
dashboard.tasksWidget.view or dossier-detail.tab.task
set_task_pinnedÉpingler une tâche
Pins (marks urgent) or unpins a to-do task, for everyone who sees it.
WriteIdempotent
dashboard.tasksWidget.view or dossier-detail.tab.task
update_my_taskModifier une de mes tâches
Updates a task the user created and that is still to do: content, urgency, scheduling, assignee or type.
WriteDestructiveIdempotent
dashboard.tasksWidget.view or dossier-detail.tab.task

E-mails

The Oxygenius mailbox, synchronised with Microsoft 365: reading, drafts and confirmed sending.

ToolPurposeBehaviourPermission
search_emailsRechercher des courriels
Lists or searches e-mails of the Oxygenius mailbox (synchronised Microsoft 365 mailboxes), or those filed in a project.
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_emailsMes courriels
Returns the signed-in user's own mailbox, inbox by default, newest first.
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_emailDétail d'un courriel
Returns an e-mail: sender, recipients, dates, project, plain-text body and attachment metadata. The e-mail is not marked as read.
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_emailsCourriels d'un dossier
Lists the e-mails filed in a project, like its Mails tab.
Read-onlyIdempotentOpen world
dossier-detail.tab.mailbox + dossier.details.view
create_email_draftCréer un brouillon de courriel
Creates a draft e-mail: new, reply, reply all or forward, with the user's signature. Nothing is sent.
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_emailPréparer l'envoi d'un document par courriel
Creates the draft that sends a printed estimate or a numbered invoice or credit note to its customer, with the PDF attached. Nothing is sent.
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_draftModifier un brouillon de courriel
Updates a draft created by the user: recipients, subject, message, type, sending mailbox.
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_emailJoindre des documents à un courriel
Attaches copies of Oxygenius documents the user can see to a draft; no file comes from the conversation.
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_attachmentsRetirer des pièces jointes d'un courriel
Removes attachments from a draft; the original documents remain.
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_sendPréparer l'envoi d'un courriel
Changes nothing: shows the e-mail exactly as it will leave, with warnings, and returns a 10-minute confirmation token.
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_emailEnvoyer un courriel
Sends the draft prepared by prepare_email_send. Irreversible; daily limit per user.
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.

ToolPurposeBehaviourPermission
list_dossier_documentsDocuments d'un dossier
Lists a project's files (imported documents, generated estimates and invoices, photos, filed attachments), limited to the document types the user's roles allow.
Read-onlyIdempotent
dossier-detail.tab.document + dossier.details.view
read_documentLire un document
Reads the text of a project document or e-mail attachment (PDF text layer, text, CSV, XML including UBL, JSON, HTML), part by part.
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_linkLien de téléchargement d'un document
Returns a direct, read-only download link to a document, valid for a few minutes.
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.

ToolPurposeBehaviourPermission
get_my_profileMon profil
Returns the signed-in user's profile: name, work e-mail and phone, job title, company, roles and active modules.
Read-onlyIdempotent
No permission (signed-in user's own data)
search_usersRechercher une personne
Searches active staff by name and returns the identifier to pass to tools that designate a person (task recipient, project manager).
Read-onlyIdempotent
dashboard.tasksWidget.view or dossier-detail.tab.task or dossier.new-dossier.create or dossier-detail.dossier.edit
get_reference_listsListes de référence
Returns the active values of the third-party and project form lists: VAT regimes, payment terms, roles, site types and procedures.
Read-onlyIdempotent
tiers.new-tiers.create or tiers.tiers.edit or dossier.new-dossier.create or dossier-detail.dossier.edit or invoice.list.view