Outils

Le serveur expose 81 outils, regroupés par domaine. Chaque page d'outil reprend le texte exact envoyé au modèle, les paramètres, le schéma du résultat, les annotations et la permission Oxygenius exigée.

81outils
32en lecture seule
49d'écriture (sur activation)
25marqués destructifs
Chaque utilisateur ne voit que ses outils

La liste renvoyée par tools/list dépend de l'utilisateur connecté : un outil n'y figure que si l'utilisateur a la permission de l'écran correspondant dans Oxygenius, et les outils d'écriture seulement si sa société les a activés. Voir Authentification et accès.

Le catalogue complet est aussi disponible en JSON : /tools.json.

Dossiers (chantiers)

Le dossier est le cœur d'Oxygenius : un chantier, son client, son adresse, sa procédure et ses étapes.

OutilRôleComportementPermission
search_dossiersRechercher des dossiers
Liste ou recherche les dossiers (chantiers) de l'entreprise de l'utilisateur dans Oxygenius.
Lecture seuleIdempotent
dossier.list.view
get_dossierDétail d'un dossier
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.
Lecture seuleIdempotent
dossier.details.view
create_dossierCréer un dossier
Crée dans Oxygenius un dossier (chantier) pour un client, avec ses étapes selon la procédure.
Écriture
dossier.new-dossier.create
update_dossierModifier un dossier
Modifie un dossier dans Oxygenius, comme le crayon d'édition de son détail : intitulé, gestionnaire (notifié), type de chantier, références externes, provenance ou adresse propre du chantier.
ÉcritureDestructifIdempotent
dossier-detail.dossier.edit + dossier.details.view

Tiers (clients, fournisseurs, contacts)

Clients, fournisseurs et contacts de l'entreprise, avec leurs coordonnées et leur régime de TVA.

OutilRôleComportementPermission
search_tiersRechercher des tiers
Liste ou recherche les tiers (clients, fournisseurs, contacts) de l'entreprise de l'utilisateur dans Oxygenius.
Lecture seuleIdempotent
tiers.list.view
get_tiersDétail d'un tiers
Renvoie le détail d'un tiers Oxygenius : coordonnées, adresse, TVA, numéro d'entreprise, régime de TVA, condition de paiement et dossiers récents où il intervient.
Lecture seuleIdempotent
tiers.list.view
create_tiersCréer un tiers
Crée dans Oxygenius un tiers (client, fournisseur ou contact), société ou personne.
Écriture
tiers.new-tiers.create
update_tiersModifier un tiers
Modifie un tiers dans Oxygenius.
ÉcritureDestructifIdempotent
tiers.tiers.edit
check_vatVérifier un numéro de TVA
Vérifie un numéro de TVA européen auprès de VIES (service de la Commission européenne), comme le formulaire de tiers de l'application : renvoie le nom et l'adresse enregistrés pour ce numéro, et les tiers d'Oxygenius qui l'ont déjà.
ÉcritureIdempotentMonde ouvert
tiers.new-tiers.create ou tiers.tiers.edit

Planning et calendrier

Le planning des équipes et du matériel sur les chantiers, et le calendrier des rendez-vous.

OutilRôleComportementPermission
search_planning_eventsRechercher dans le planning
Liste ou recherche les événements du planning Oxygenius (chantiers, interventions, équipes) sur une période, par ordre chronologique.
Lecture seuleIdempotent
planning.list.view
get_planning_eventDétail d'un événement du planning
Renvoie le détail d'une occurrence du planning : horaires, type, état de chantier, personnes affectées, description, dossier avec adresse du chantier et client, devis liés.
Lecture seuleIdempotent
planning.list.view
search_calendar_eventsRechercher dans le calendrier
Liste ou recherche les événements du calendrier Oxygenius (rendez-vous, bureau, congés…) sur une période, par ordre chronologique, avec les personnes concernées.
Lecture seuleIdempotent
calendar.list.view ou calendar-hybrid.list.view
get_calendar_eventDétail d'un événement du calendrier
Renvoie le détail d'une occurrence du calendrier : horaires, type, personnes concernées, description et dossier lié.
Lecture seuleIdempotent
calendar.list.view ou calendar-hybrid.list.view
get_agenda_listsListes de l'agenda
Renvoie, pour le planning ou le calendrier, les types d'événement, les états de chantier (planning) et les ressources (personnes et matériel) avec leur identifiant, à passer aux outils de création et de modification d'événements.
Lecture seuleIdempotent
planning.list.view ou calendar.list.view ou calendar-hybrid.list.view
create_planning_eventPlanifier un événement
Crée dans le planning Oxygenius un événement (chantier, visite…) sur un jour ou sur plusieurs jours consécutifs, aux mêmes heures chaque jour, affecté à des personnes ou à du matériel (get_agenda_lists avec kind planning donne les types, états de chantier et ressources).
Écriture
planning.list.view
update_planning_eventModifier un événement du planning
Modifie un événement du planning Oxygenius.
ÉcritureDestructif
planning.list.view
create_calendar_eventAjouter un événement au calendrier
Crée dans le calendrier Oxygenius un événement (rendez-vous, bureau, congé…) sur un jour ou sur plusieurs jours consécutifs, aux mêmes heures chaque jour, pour une ou plusieurs personnes (get_agenda_lists avec kind calendar donne les types et les calendriers accessibles).
Écriture
calendar.list.view ou calendar-hybrid.list.view
update_calendar_eventModifier un événement du calendrier
Modifie un événement du calendrier Oxygenius.
ÉcritureDestructif
calendar.list.view ou calendar-hybrid.list.view

Devis

Recherche, rédaction et suivi des devis : lignes, versions, impression et décision du client.

OutilRôleComportementPermission
search_estimatesRechercher des devis
Liste ou recherche les devis Oxygenius (avenants et versions compris), du plus récent au plus ancien.
Lecture seuleIdempotent
estimate.list.view
get_estimateDétail d'un devis
Renvoie le détail d'un devis : client, montants et ventilation TVA, lignes (titres, articles, options), avenants, factures et notes de crédit liées, et pour un devis accepté le reste à facturer.
Lecture seuleIdempotent
estimate.list.view
create_estimateCréer un devis
Crée un devis vide, à éditer, pour un dossier : client et adresse de facturation sont ceux du tiers facturé du dossier, qui doit avoir une adresse complète.
Écriture
dossier-detail.estimate.create + estimate.list.view
update_estimateModifier un devis
Modifie l'en-tête d'un devis (nom, dates, tiers facturé) ou applique une marge ou une remise à toutes ses lignes, comme les champs globaux de l'écran du devis.
ÉcritureDestructifIdempotent
estimate.list.view
add_estimate_linesAjouter des lignes à un devis
Ajoute des lignes à un devis, dans l'ordre donné : titres, sous-titres, lignes libres à prix saisi, articles du catalogue et ouvrages (un ouvrage ajoute un sous-titre et ses articles).
Écriture
estimate.list.view
update_estimate_linesModifier des lignes d'un devis
Modifie des lignes d'un devis (champ id des lignes de get_estimate) : libellé, description, quantité, prix imposé, marge, remise, TVA, unité.
ÉcritureDestructifIdempotent
estimate.list.view
remove_estimate_linesRetirer des lignes d'un devis
Retire des lignes d'un devis (champ id des lignes de get_estimate) ; un titre, un sous-titre ou un ouvrage part avec toutes ses lignes.
ÉcritureDestructifIdempotent
estimate.list.view
create_estimate_versionNouvelle version d'un devis
Crée une nouvelle version d'un devis, comme le bouton « Nouvelle version » de l'application : une copie à éditer, sous le même numéro, que l'on modifie ensuite à la place d'un devis accepté, refusé ou envoyé.
Écriture
estimate.list.view
print_estimateImprimer un devis
Génère le PDF d'un devis, comme le bouton « Imprimer » de l'application, et le classe dans les documents du dossier.
Écriture
estimate.list.view
prepare_estimate_decisionPréparer la décision sur un devis
Prépare l'acceptation (accept_estimate) ou le refus (refuse_estimate) d'un devis par le client, comme les boutons de la carte du devis : devis imprimé ou envoyé ; refusé, pour l'accepter ; accepté, pour le refuser.
ÉcritureIdempotentPrépare une action, sans effet
estimate.list.view
accept_estimateAccepter un devis
Enregistre l'acceptation d'un devis par le client, préparée par prepare_estimate_decision (decision accept) : le devis passe au statut Accepté et les automatisations du dossier se déclenchent (étapes, tâches, fiche de travail).
ÉcritureDestructifExige un jeton de confirmation
estimate.list.view
refuse_estimateRefuser un devis
Enregistre le refus d'un devis par le client, préparé par prepare_estimate_decision (decision refuse) : le devis passe au statut Refusé.
ÉcritureDestructifExige un jeton de confirmation
estimate.list.view

Factures

Factures libres ou issues d'un devis (acompte, avancement, finale), brouillons et numérotation légale.

OutilRôleComportementPermission
search_invoicesRechercher des factures
Liste ou recherche les factures Oxygenius, de la plus récente à la plus ancienne, avec leur solde restant dû et leur retard de paiement.
Lecture seuleIdempotent
invoice.list.view
get_invoiceDétail d'une facture
Renvoie le détail d'une facture : client, montants, retenue de garantie, solde, paiements reçus, communication structurée, lignes, devis facturé et notes de crédit.
Lecture seuleIdempotent
invoice.list.view
create_invoiceCréer une facture
Crée une facture en brouillon, sans numéro, comme l'écran du dossier : libre pour un dossier (kind free, à remplir avec add_invoice_lines), ou depuis un devis accepté : acompte (kind deposit, pourcentage d'acompte de la société), avancement (kind progress, percentage du montant signé ou amount hors TVA, dans la limite du reste à facturer) ou finale (kind final, montant signé moins ce qui est déjà facturé).
Écriture
dossier-detail.invoice.create + invoice.list.view
update_invoiceModifier une facture
Modifie l'en-tête d'une facture en brouillon : date, échéance, délai de paiement (l'échéance suit, comme dans le formulaire), bon de commande du client, tiers facturé.
ÉcritureDestructifIdempotent
invoice.list.view
add_invoice_linesAjouter des lignes à une facture
Ajoute des lignes à une facture en brouillon, dans l'ordre donné : titres, sous-titres, lignes libres à prix saisi, articles et ouvrages du catalogue.
Écriture
invoice.list.view
update_invoice_linesModifier des lignes d'une facture
Modifie des lignes d'une facture en brouillon (champ id des lignes de get_invoice) : libellé, description, quantité, prix imposé, marge, remise, TVA, unité.
ÉcritureDestructifIdempotent
invoice.list.view
remove_invoice_linesRetirer des lignes d'une facture
Retire des lignes d'une facture en brouillon (champ id des lignes de get_invoice) ; un titre, un sous-titre ou un ouvrage part avec toutes ses lignes.
ÉcritureDestructifIdempotent
invoice.list.view
prepare_invoice_finalizationPréparer la numérotation d'une facture
Prépare la numérotation d'une facture en brouillon (finalize_invoice), comme son bouton « Imprimer » : numéro légal définitif, PDF et UBL, statut Imprimé, écriture au compte client, envoi automatique au comptable selon le réglage de la société.
ÉcritureIdempotentPrépare une action, sans effet
invoice.list.view
finalize_invoiceNuméroter une facture
Numérote et imprime une facture en brouillon, préparée par prepare_invoice_finalization : le numéro est légal et définitif (une facture numérotée ne se corrige que par une note de crédit).
ÉcritureDestructifExige un jeton de confirmation
invoice.list.view

Notes de crédit

Notes de crédit libres ou d'une facture, brouillons et numérotation légale.

OutilRôleComportementPermission
search_credit_notesRechercher des notes de crédit
Liste ou recherche les notes de crédit Oxygenius, de la plus récente à la plus ancienne.
Lecture seuleIdempotent
credit-note.list.view
get_credit_noteDétail d'une note de crédit
Renvoie le détail d'une note de crédit : client, facture créditée, montants et ventilation TVA, lignes.
Lecture seuleIdempotent
credit-note.list.view
create_credit_noteCréer une note de crédit
Crée une note de crédit en brouillon, sans numéro : libre pour un dossier (dossierId, à remplir avec add_credit_note_lines), ou d'une facture numérotée (invoiceId), dont elle reprend les lignes et la TVA.
Écriture
dossier-detail.credit-note.create + credit-note.list.view
update_credit_noteModifier une note de crédit
Modifie l'en-tête d'une note de crédit en brouillon : date, tiers facturé.
ÉcritureDestructifIdempotent
credit-note.list.view
add_credit_note_linesAjouter des lignes à une note de crédit
Ajoute des lignes à une note de crédit en brouillon, dans l'ordre donné : titres, sous-titres, lignes libres à prix saisi, articles et ouvrages du catalogue.
Écriture
credit-note.list.view
update_credit_note_linesModifier des lignes d'une note de crédit
Modifie des lignes d'une note de crédit en brouillon (champ id des lignes de get_credit_note) : libellé, description, quantité, prix imposé, marge, remise, TVA, unité.
ÉcritureDestructifIdempotent
credit-note.list.view
remove_credit_note_linesRetirer des lignes d'une note de crédit
Retire des lignes d'une note de crédit en brouillon (champ id des lignes de get_credit_note) ; un titre, un sous-titre ou un ouvrage part avec toutes ses lignes.
ÉcritureDestructifIdempotent
credit-note.list.view
prepare_credit_note_finalizationPréparer la numérotation d'une note de crédit
Prépare la numérotation d'une note de crédit en brouillon (finalize_credit_note) : numéro légal définitif, PDF et UBL, statut Imprimé, crédit au compte client, effet sur la facture créditée (solde diminué, ou facture annulée par une note de son montant), envoi automatique au comptable selon le réglage de la société.
ÉcritureIdempotentPrépare une action, sans effet
credit-note.list.view
finalize_credit_noteNuméroter une note de crédit
Numérote et imprime une note de crédit en brouillon, préparée par prepare_credit_note_finalization : numéro légal définitif, et effet immédiat sur la facture créditée.
ÉcritureDestructifExige un jeton de confirmation
credit-note.list.view

Facturation électronique et comptable

Envoi officiel d'une facture ou d'une note de crédit par Peppol, ou à l'expert-comptable, toujours en deux temps.

OutilRôleComportementPermission
prepare_peppol_sendPréparer un envoi Peppol
Prépare l'envoi d'une facture ou d'une note de crédit numérotée par le réseau Peppol (send_peppol), comme le bouton « Envoyer via Peppol » : le fichier UBL est transmis au client par Digiteal, par Mercurius pour un client marqué Mercurius.
ÉcritureIdempotentPrépare une action, sans effet
peppol.all.send
send_peppolEnvoyer par Peppol
Transmet au client par Peppol (ou Mercurius) une facture ou une note de crédit préparée par prepare_peppol_send : envoi officiel de la facture électronique, irréversible.
ÉcritureDestructifMonde ouvertExige un jeton de confirmation
peppol.all.send
prepare_accountant_sendPréparer un envoi au comptable
Prépare l'envoi d'une facture ou d'une note de crédit numérotée au comptable de la société (send_to_accountant), comme le bouton « Envoyer au comptable » : le fichier UBL part par courriel vers l'adresse du comptable, depuis la boîte générale.
ÉcritureIdempotentPrépare une action, sans effet
invoice.list.view ou credit-note.list.view
send_to_accountantEnvoyer au comptable
Envoie au comptable de la société une facture ou une note de crédit préparée par prepare_accountant_send (fichier UBL par courriel).
ÉcritureDestructifMonde ouvertExige un jeton de confirmation
invoice.list.view ou credit-note.list.view

Articles, ouvrages et stock

Le catalogue des articles et des ouvrages, leurs prix et, avec le module Stock, leur disponibilité.

OutilRôleComportementPermission
search_itemsRechercher des articles
Liste ou recherche les articles Oxygenius (fournitures) et les ouvrages (composés d'articles), par ordre alphabétique, avec leur prix de vente et, si le module Stock est actif, la quantité en stock.
Lecture seuleIdempotent
item-job.list.view
get_itemDétail d'un article
Renvoie le détail d'un article ou d'un ouvrage : description, prix de vente HTVA et TVAC, unité, catégorie, fournisseurs (délais, références), composition d'un ouvrage.
Lecture seuleIdempotent
item-job.list.view
get_item_stockStock d'un article
Renvoie la disponibilité en stock d'un article (module Stock) : quantité totale et par emplacement, état (disponible, sous le minimum, rupture, surstock) d'après les seuils, quantité de réapprovisionnement et derniers mouvements.
Lecture seuleIdempotent
item-job.list.view + module Stock

Tâches

Les demandes que les collaborateurs s'adressent entre eux, le plus souvent sur un dossier.

OutilRôleComportementPermission
search_tasksRechercher des tâches
Liste ou recherche les tâches Oxygenius (demandes adressées d'un utilisateur à un autre, souvent liées à un dossier), urgentes d'abord puis les plus récentes.
Lecture seuleIdempotent
dashboard.tasksWidget.view ou dossier-detail.tab.task
get_my_tasksMes tâches
Renvoie les tâches de l'utilisateur connecté, comme le widget Tâches de son tableau de bord : par défaut celles qu'il a reçues et doit traiter, sinon celles qu'il a envoyées et qui ne sont pas encore traitées, ou celles qui lui sont planifiées.
Lecture seuleIdempotent
dashboard.tasksWidget.view ou dossier-detail.tab.task
get_taskDétail d'une tâche
Renvoie le détail d'une tâche (contenu complet, expéditeur, destinataire, échéance, dossier) et l'historique de l'échange auquel elle appartient : création, réponses, transferts et clôture, par ordre chronologique.
Lecture seuleIdempotent
dashboard.tasksWidget.view ou dossier-detail.tab.task
list_task_typesTypes de tâche
Liste les types de tâche actifs (catégories, ex.
Lecture seuleIdempotent
dashboard.tasksWidget.view ou dossier-detail.tab.task
create_taskCréer une tâche
Crée dans Oxygenius une tâche sur un dossier, adressée par l'utilisateur connecté à une ou plusieurs personnes (une tâche par personne, chacune notifiée).
Écriture
dashboard.tasksWidget.view ou dossier-detail.tab.task
reply_taskRépondre à une tâche
Répond dans Oxygenius à une tâche à traiter : la réponse devient une nouvelle tâche adressée à l'expéditeur, et la tâche répondue est traitée (définitivement).
ÉcritureDestructif
dashboard.tasksWidget.view ou dossier-detail.tab.task
transfer_taskTransférer une tâche
Transfère dans Oxygenius une tâche à traiter à une autre personne (search_users) : elle lui est adressée avec le même contenu, type et urgence, et la tâche d'origine est traitée (définitivement).
ÉcritureDestructif
dashboard.tasksWidget.view ou dossier-detail.tab.task
set_task_pinnedÉpingler une tâche
Épingle (marque urgente) ou désépingle dans Oxygenius une tâche à traiter, pour tous ceux qui la voient.
ÉcritureIdempotent
dashboard.tasksWidget.view ou dossier-detail.tab.task
update_my_taskModifier une de mes tâches
Modifie dans Oxygenius une tâche que l'utilisateur connecté a créée et qui est encore à traiter : contenu, urgence (épinglage), date de planification, destinataire (réaffectation, notifiée) ou type.
ÉcritureDestructifIdempotent
dashboard.tasksWidget.view ou dossier-detail.tab.task

Courriels

La messagerie Oxygenius, synchronisée avec Microsoft 365 : lecture, brouillons et envoi confirmé.

OutilRôleComportementPermission
search_emailsRechercher des courriels
Liste ou recherche les courriels de la messagerie Oxygenius (boîtes Microsoft 365 synchronisées), du plus récent au plus ancien, ou ceux classés dans un dossier (dossierId).
Lecture seuleIdempotentMonde ouvert
mail-inbox.list.view ou mail-outbox.list.view ou mail-sendbox.list.view ou mail-trashbox.list.view ou all-mail.list.view ou dossier-detail.tab.mailbox
get_my_emailsMes courriels
Renvoie les courriels de la boîte aux lettres de l'utilisateur connecté (par défaut sa boîte de réception), du plus récent au plus ancien.
Lecture seuleIdempotentMonde ouvert
mail-inbox.list.view ou mail-outbox.list.view ou mail-sendbox.list.view ou mail-trashbox.list.view ou all-mail.list.view ou dossier-detail.tab.mailbox
get_emailDétail d'un courriel
Renvoie un courriel : expéditeur, destinataires, copies, dates, dossier où il est classé, corps en texte et pièces jointes (nom, type, taille ; read_document en lit le contenu).
Lecture seuleIdempotentMonde ouvert
mail-inbox.list.view ou mail-outbox.list.view ou mail-sendbox.list.view ou mail-trashbox.list.view ou all-mail.list.view ou dossier-detail.tab.mailbox
list_dossier_emailsCourriels d'un dossier
Liste les courriels classés dans un dossier Oxygenius, comme son onglet Mails : reçus et envoyés, hors corbeille, du plus récent au plus ancien.
Lecture seuleIdempotentMonde ouvert
dossier-detail.tab.mailbox + dossier.details.view
create_email_draftCréer un brouillon de courriel
Crée un brouillon de courriel de l'utilisateur, comme le bouton Nouveau, Répondre, Répondre à tous ou Transférer de la messagerie : la signature de l'utilisateur est ajoutée, une réponse reprend l'expéditeur, l'objet et le message cité, un transfert reprend les pièces jointes du courriel d'origine.
Écriture
mail-inbox.list.view ou mail-outbox.list.view ou mail-sendbox.list.view ou mail-trashbox.list.view ou all-mail.list.view ou dossier-detail.tab.mailbox
create_document_emailPréparer l'envoi d'un document par courriel
Crée le brouillon qui envoie un devis, une facture ou une note de crédit à son client, comme le bouton « Envoyer » du document : destinataire du client (ou contact du dossier), objet, texte de la société, PDF joint (et fichier UBL, conditions générales).
Écriture
mail-inbox.list.view ou mail-outbox.list.view ou mail-sendbox.list.view ou mail-trashbox.list.view ou all-mail.list.view ou dossier-detail.tab.mailbox
update_email_draftModifier un brouillon de courriel
Modifie un brouillon de courriel : destinataires, objet, message, type, boîte d'envoi.
ÉcritureDestructifIdempotent
mail-inbox.list.view ou mail-outbox.list.view ou mail-sendbox.list.view ou mail-trashbox.list.view ou all-mail.list.view ou dossier-detail.tab.mailbox
attach_documents_to_emailJoindre des documents à un courriel
Joint au brouillon une copie de documents d'Oxygenius que l'utilisateur voit (documents d'un dossier, pièces jointes de courriels) : le document d'origine ne change pas.
Écriture
mail-inbox.list.view ou mail-outbox.list.view ou mail-sendbox.list.view ou mail-trashbox.list.view ou all-mail.list.view ou dossier-detail.tab.mailbox
remove_email_attachmentsRetirer des pièces jointes d'un courriel
Retire des pièces jointes d'un brouillon : la copie jointe au courriel est supprimée, le document d'origine reste.
ÉcritureDestructif
mail-inbox.list.view ou mail-outbox.list.view ou mail-sendbox.list.view ou mail-trashbox.list.view ou all-mail.list.view ou dossier-detail.tab.mailbox
prepare_email_sendPréparer l'envoi d'un courriel
Prépare l'envoi d'un brouillon sans rien envoyer ni modifier : renvoie le courriel tel qu'il partira, les points d'attention (destinataires inconnus, hors du dossier, copie cachée) et un jeton de confirmation valable 10 minutes.
ÉcritureIdempotentPrépare une action, sans effet
mail-inbox.list.view ou mail-outbox.list.view ou mail-sendbox.list.view ou mail-trashbox.list.view ou all-mail.list.view ou dossier-detail.tab.mailbox
send_emailEnvoyer un courriel
Envoie un brouillon préparé par prepare_email_send, seulement après l'accord explicite de l'utilisateur sur ce courriel tel que prepare_email_send l'a montré : l'envoi est irréversible.
ÉcritureDestructifMonde ouvertExige un jeton de confirmation
mail-inbox.list.view ou mail-outbox.list.view ou mail-sendbox.list.view ou mail-trashbox.list.view ou all-mail.list.view ou dossier-detail.tab.mailbox

Documents

Les fichiers d'un dossier et les pièces jointes des courriels : liste, lecture du texte, lien de téléchargement.

OutilRôleComportementPermission
list_dossier_documentsDocuments d'un dossier
Liste les documents (fichiers) d'un dossier Oxygenius, comme son onglet Documents : documents importés, devis, factures et rapports générés, photos, pièces jointes classées… du plus récent au plus ancien.
Lecture seuleIdempotent
dossier-detail.tab.document + dossier.details.view
read_documentLire un document
Lit le texte d'un document d'un dossier ou d'une pièce jointe de courriel : PDF (couche texte, sans OCR : les pages scannées sont signalées dans pagesWithoutText) et fichiers texte (txt, csv, xml dont factures UBL, json, html).
Lecture seuleIdempotentMonde ouvert
dossier-detail.tab.document ou mail-inbox.list.view ou mail-outbox.list.view ou mail-sendbox.list.view ou mail-trashbox.list.view ou all-mail.list.view ou dossier-detail.tab.mailbox
get_document_download_linkLien de téléchargement d'un document
Renvoie un lien de téléchargement direct, en lecture seule et valable quelques minutes, vers le fichier d'un document d'un dossier ou d'une pièce jointe de courriel.
Lecture seule
dossier-detail.tab.document ou mail-inbox.list.view ou mail-outbox.list.view ou mail-sendbox.list.view ou mail-trashbox.list.view ou all-mail.list.view ou dossier-detail.tab.mailbox

Profil et listes de référence

Qui est connecté, qui désigner, et les valeurs des listes de choix des formulaires.

OutilRôleComportementPermission
get_my_profileMon profil
Renvoie le profil de l'utilisateur connecté à Oxygenius : nom, courriel et téléphone professionnels, fonction, société, rôles, et modules de licence actifs de la société.
Lecture seuleIdempotent
Aucune permission (données de l'utilisateur connecté)
search_usersRechercher une personne
Recherche les membres actifs du personnel de l'entreprise par leur nom ou prénom, par ordre alphabétique.
Lecture seuleIdempotent
dashboard.tasksWidget.view ou dossier-detail.tab.task ou dossier.new-dossier.create ou dossier-detail.dossier.edit
get_reference_listsListes de référence
Renvoie les valeurs actives des listes de choix des formulaires de tiers et de dossier, avec leur identifiant : régimes de TVA et conditions de paiement (create_tiers, update_tiers, et délai de paiement d'update_invoice), rôles d'un tiers lié à un dossier, types de chantier et procédures (create_dossier, update_dossier).
Lecture seuleIdempotent
tiers.new-tiers.create ou tiers.tiers.edit ou dossier.new-dossier.create ou dossier-detail.dossier.edit ou invoice.list.view