Capacités du serveur MCP Altoviz
114 outils, 8 prompts et 1 ressources pour piloter la facturation, les devis, les achats et les statistiques d'une petite entreprise française. L'accès nécessite une authentification ; cette page ne fait que décrire ce qui est exposé.
Clients
Crée un client. Vérifier d'abord avec find_customer ou list_customers qu'il n'existe pas déjà, pour éviter les doublons.
| Paramètre | Type | Description | |
|---|---|---|---|
| customerJson | string | requis | Client au format JSON. Champs usuels : name, companyName, email, phone, type (Business | Consumer | Government), billingOptions. Ex. {"name":"Acme","email":"contact@acme.fr"} |
Supprime un client. Demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du client |
Recherche des clients par email, identifiant interne ou numéro client. À utiliser pour résoudre un client avant de créer une facture ou un devis.
| Paramètre | Type | Description | |
|---|---|---|---|
| string | optionnel | Email du client | |
| internalId | string | optionnel | Identifiant interne du client (issu de votre système) |
| number | string | optionnel | Numéro client |
Récupère un client par son id numérique Altoviz.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du client |
Liste les contacts rattachés à un client.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du client |
Liste les clients, avec recherche plein texte et pagination.
| Paramètre | Type | Description | |
|---|---|---|---|
| query | string | optionnel | Recherche plein texte (nom, société, email...) |
| pageIndex | integer | optionnel | Numéro de page, à partir de 1 |
| pageSize | integer | optionnel | Nombre d'éléments par page (25 par défaut, 100 maximum conseillé) |
| orderBy | string | optionnel | Champ de tri, ex. 'name' |
Modifie un client existant. Remplacement complet, pas une modification partielle : un champ omis est effacé. Lire d'abord l'objet avec l'outil get_* correspondant, modifier ce qui doit l'être et renvoyer l'objet entier. Les champs en lecture seule (id, montants calculés...) sont ignorés. Seul metadata est fusionné (une clé à null est supprimée).
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du client |
| customerJson | string | requis | Client complet au format JSON, tel que renvoyé par get_customer puis modifié. Mêmes champs que create_customer. |
Familles de clients
Crée une famille de clients. L'API ne permet pas de modifier une famille existante.
| Paramètre | Type | Description | |
|---|---|---|---|
| familyJson | string | requis | Famille au format JSON, ex. {"label":"Grands comptes"} |
Supprime une famille de clients. Demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de la famille |
Recherche une famille de clients par numéro ou identifiant interne.
| Paramètre | Type | Description | |
|---|---|---|---|
| number | string | optionnel | Numéro de la famille |
| internalId | string | optionnel | Identifiant interne de la famille |
Récupère une famille de clients par son id numérique Altoviz.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de la famille |
Liste les familles de clients (regroupements servant au classement et aux statistiques).
| Paramètre | Type | Description | |
|---|---|---|---|
| query | string | optionnel | Recherche plein texte |
| pageIndex | integer | optionnel | Numéro de page, à partir de 1 |
| pageSize | integer | optionnel | Nombre d'éléments par page (25 par défaut, 100 maximum conseillé) |
Contacts
Crée un contact. Vérifier d'abord avec find_contact qu'il n'existe pas déjà.
| Paramètre | Type | Description | |
|---|---|---|---|
| contactJson | string | requis | Contact au format JSON. Champs usuels : firstName, lastName, email, phone, function. Ex. {"firstName":"Marie","lastName":"Dupont","email":"m.dupont@acme.fr"} |
Supprime un contact. Demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du contact |
Recherche des contacts par email ou identifiant interne.
| Paramètre | Type | Description | |
|---|---|---|---|
| string | optionnel | Email du contact | |
| internalId | string | optionnel | Identifiant interne du contact |
Récupère un contact par son id numérique Altoviz.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du contact |
Liste les contacts (interlocuteurs rattachés aux clients et fournisseurs), avec recherche plein texte et pagination.
| Paramètre | Type | Description | |
|---|---|---|---|
| query | string | optionnel | Recherche plein texte (nom, email...) |
| pageIndex | integer | optionnel | Numéro de page, à partir de 1 |
| pageSize | integer | optionnel | Nombre d'éléments par page (25 par défaut, 100 maximum conseillé) |
| orderBy | string | optionnel | Champ de tri |
Modifie un contact existant. Remplacement complet, pas une modification partielle : un champ omis est effacé. Lire d'abord l'objet avec l'outil get_* correspondant, modifier ce qui doit l'être et renvoyer l'objet entier. Les champs en lecture seule (id, montants calculés...) sont ignorés. Seul metadata est fusionné (une clé à null est supprimée).
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du contact |
| contactJson | string | requis | Contact complet au format JSON, tel que renvoyé par get_contact puis modifié. Mêmes champs que create_contact. |
Fournisseurs
Crée un fournisseur. Vérifier d'abord avec find_supplier ou list_suppliers qu'il n'existe pas déjà, pour éviter les doublons.
| Paramètre | Type | Description | |
|---|---|---|---|
| supplierJson | string | requis | Fournisseur au format JSON. Champs usuels : name, companyName, email, phone, active (booleen). Ex. {"name":"OVH","email":"contact@ovh.com"} |
Supprime un fournisseur. Demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du fournisseur |
Recherche des fournisseurs par email ou identifiant interne.
| Paramètre | Type | Description | |
|---|---|---|---|
| string | optionnel | Email du fournisseur | |
| internalId | string | optionnel | Identifiant interne du fournisseur |
Récupère un fournisseur par son id numérique Altoviz.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du fournisseur |
Liste les contacts rattachés à un fournisseur.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du fournisseur |
Liste les fournisseurs, avec recherche plein texte et pagination.
| Paramètre | Type | Description | |
|---|---|---|---|
| query | string | optionnel | Recherche plein texte (nom, société, email...) |
| pageIndex | integer | optionnel | Numéro de page, à partir de 1 |
| pageSize | integer | optionnel | Nombre d'éléments par page (25 par défaut, 100 maximum conseillé) |
| orderBy | string | optionnel | Champ de tri |
Modifie un fournisseur existant. Remplacement complet, pas une modification partielle : un champ omis est effacé. Lire d'abord l'objet avec l'outil get_* correspondant, modifier ce qui doit l'être et renvoyer l'objet entier. Les champs en lecture seule (id, montants calculés...) sont ignorés. Seul metadata est fusionné (une clé à null est supprimée).
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du fournisseur |
| supplierJson | string | requis | Fournisseur complet au format JSON, tel que renvoyé par get_supplier puis modifié. Mêmes champs que create_supplier. |
Collaborateurs
Crée un collaborateur.
| Paramètre | Type | Description | |
|---|---|---|---|
| colleagueJson | string | requis | Collaborateur au format JSON. Champs usuels : firstName, lastName, email, phone. |
Supprime un collaborateur. Demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du collaborateur |
Recherche des collaborateurs par email, identifiant interne ou numéro.
| Paramètre | Type | Description | |
|---|---|---|---|
| string | optionnel | Email du collaborateur | |
| internalId | string | optionnel | Identifiant interne du collaborateur |
| number | string | optionnel | Numéro du collaborateur |
Récupère un collaborateur par son id numérique Altoviz.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du collaborateur |
Liste les collaborateurs de l'entreprise. Ce sont eux qui portent les notes de frais.
| Paramètre | Type | Description | |
|---|---|---|---|
| query | string | optionnel | Recherche plein texte (nom, email...) |
| pageIndex | integer | optionnel | Numéro de page, à partir de 1 |
| pageSize | integer | optionnel | Nombre d'éléments par page (25 par défaut, 100 maximum conseillé) |
| orderBy | string | optionnel | Champ de tri |
Modifie un collaborateur existant. Remplacement complet, pas une modification partielle : un champ omis est effacé. Lire d'abord l'objet avec l'outil get_* correspondant, modifier ce qui doit l'être et renvoyer l'objet entier. Les champs en lecture seule (id, montants calculés...) sont ignorés. Seul metadata est fusionné (une clé à null est supprimée).
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du collaborateur |
| colleagueJson | string | requis | Collaborateur complet au format JSON, tel que renvoyé par get_colleague puis modifié. Mêmes champs que create_colleague. |
Produits
Crée un produit ou une prestation au catalogue.
| Paramètre | Type | Description | |
|---|---|---|---|
| productJson | string | requis | Produit au format JSON. Champs : name (requis), number (référence), type (Product | Service | Text), taxExcludedPrice (prix de vente HT) ou taxIncludedPrice (TTC, pris en compte seulement si taxExcludedPrice est absent ou à 0), purchasePrice (prix d'achat HT), vat ({"rate":20} : taux en pour cent, jamais d'id ; sans vat le produit n'a pas de TVA), unit ({"code":"H"} : code issu de list_units), family ({"label":"Prestations"} : famille retrouvée par libellé, créée si elle n'existe pas ; ou {"number":"..."} ; il n'y a pas de familyId), defaultQuantity, description, active, internalId. unitPrice et isUnitPriceTaxIncluded sont obsolètes. margin, marginRate et markupRate sont calculés par Altoviz et ignorés. Ex. {"name":"Journée de conseil","type":"Service","taxExcludedPrice":600,"vat":{"rate":20},"unit":{"code":"J"}} |
Crée une famille de produits. L'API ne permet pas de modifier une famille existante.
| Paramètre | Type | Description | |
|---|---|---|---|
| familyJson | string | requis | Famille au format JSON, ex. {"label":"Prestations"} |
Supprime un produit du catalogue. Demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du produit |
Supprime une famille de produits. Demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de la famille |
Recherche un produit par sa référence ou son identifiant interne. À utiliser pour reprendre libellé, prix et TVA sur une ligne de document.
| Paramètre | Type | Description | |
|---|---|---|---|
| number | string | optionnel | Référence du produit |
| internalId | string | optionnel | Identifiant interne du produit |
Récupère un produit ou une prestation par son id numérique Altoviz.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du produit |
Récupère une famille de produits par son id numérique Altoviz.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de la famille |
Liste les familles de produits (regroupements du catalogue).
| Paramètre | Type | Description | |
|---|---|---|---|
| query | string | optionnel | Recherche plein texte |
| pageIndex | integer | optionnel | Numéro de page, à partir de 1 |
| pageSize | integer | optionnel | Nombre d'éléments par page (25 par défaut, 100 maximum conseillé) |
Liste le catalogue de produits et de prestations, avec recherche plein texte et filtre par famille.
| Paramètre | Type | Description | |
|---|---|---|---|
| query | string | optionnel | Recherche plein texte (libellé, référence...) |
| familyId | integer | optionnel | Filtrer sur l'id d'une famille de produits |
| pageIndex | integer | optionnel | Numéro de page, à partir de 1 |
| pageSize | integer | optionnel | Nombre d'éléments par page (25 par défaut, 100 maximum conseillé) |
| orderBy | string | optionnel | Champ de tri |
Modifie un produit existant. Remplacement complet, pas une modification partielle : un champ omis est effacé. Lire d'abord l'objet avec l'outil get_* correspondant, modifier ce qui doit l'être et renvoyer l'objet entier. Les champs en lecture seule (id, montants calculés...) sont ignorés. Seul metadata est fusionné (une clé à null est supprimée). Sans vat, unit ou family, le produit les perd. Pour fixer un prix TTC, mettre taxExcludedPrice à 0 et renseigner taxIncludedPrice, sinon le prix HT l'emporte. internalId et internalNotes ne sont pas modifiables par cet outil.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du produit |
| productJson | string | requis | Produit complet au format JSON, tel que renvoyé par get_product puis modifié. Mêmes champs que create_product. |
Factures de vente
Contrôle une facture de vente au regard des règles de la facturation électronique (Factur-X / CII) et renvoie les anomalies détaillées : texte, gravité (Error / Warning), origine (Application = à corriger dans Altoviz, Directory = adresse électronique ou annuaire, Platform = contenu de la facture), emplacement dans le XML et validateur. Soumet le document généré à la plateforme de validation e-facturation pour contrôle ; ne finalise pas la facture et ne l'envoie pas au client. UNIQUEMENT sur une facture en brouillon, à utiliser AVANT finalize_sale_invoice pour savoir si elle passerait ; une facture déjà finalisée renvoie une erreur 409. Se fier au champ isValid pour le verdict : une facture peut être non conforme alors que toutes les anomalies sont de gravité Warning, les règles françaises BR-FR étant remontées en avertissement.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de la facture en brouillon |
Crée une facture de vente au statut brouillon. Tant qu'elle n'est pas finalisée, elle n'est ni numérotée ni opposable et reste modifiable. Résoudre le client avec find_customer ou list_customers avant d'appeler cet outil.
| Paramètre | Type | Description | |
|---|---|---|---|
| invoiceJson | string | requis | Facture au format JSON. Champs : customerId ou customerNumber (l'un des deux est requis ; obtenus avec find_customer ou list_customers ; customerNumber doit être le numéro client exact, erreur 400 si aucun ou plusieurs clients correspondent), date (AAAA-MM-JJ, aujourd'hui par défaut), subject, headerNotes, footerNotes, customerOrderReference, internalId, globalDiscount ({"type":"Percent","value":10}, value de 0 à 100 en Percent), useTaxIncludedPrices (false par défaut, même si le compte travaille en TTC : les prix des lignes sont alors HT), lines (requis, au moins une ligne). Adresses, contact, SIRET et numéro de TVA sont repris du client s'ils sont omis. À la création, ne pas envoyer liableToVat : il est déduit du compte (s'il est envoyé à false, vatNote devient obligatoire). L'API n'expose pas les conditions de règlement. Chaque ligne : type (Product | Service | Text | Subtotal | NewPage ; déduit du produit si un produit est référencé), productId ou productNumber (produit du catalogue : description, prix et TVA en sont repris s'ils sont omis ; ne jamais envoyer d'objet product, qui créerait un nouveau produit), description (requise pour une ligne Product ou Service sans produit ; HTML accepté), quantity, taxExcludedPrice (prix unitaire HT ; taxIncludedPrice si useTaxIncludedPrices=true), vat ({"rate":20} : taux en pour cent, jamais d'id ; omis = TVA du produit ou taux par défaut ; ne pas l'envoyer si l'entreprise n'est pas assujettie, cela rendrait le document assujetti), unit ({"code":"H"} : code issu de list_units ; jamais repris du produit), discount ({"type":"Percent","value":10} avec value de 0 à 100, ou {"type":"Fixed","value":50}, Fixed étant un montant retiré du total de la ligne), purchasePrice. Ligne de texte : {"type":"Text","description":"..."}. Ex. {"customerId":42,"date":"2026-06-01","subject":"Mission de conseil","lines":[{"type":"Service","description":"Journée de conseil","quantity":2,"taxExcludedPrice":600,"vat":{"rate":20},"unit":{"code":"J"}}]} |
Supprime une facture de vente encore au statut brouillon. Une facture finalisée ne peut pas être supprimée. Demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de la facture |
Télécharge une facture de vente au format PDF, renvoyé encodé en base64.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de la facture |
Finalise une facture de vente : elle est numérotée et devient une pièce comptable opposable. IRRÉVERSIBLE - une facture finalisée ne peut plus être modifiée, seulement annulée par un avoir. Demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de la facture |
| finalizationDate | string | optionnel | Date de finalisation (AAAA-MM-JJ). Par défaut, la date de la facture elle-même. |
| dateAdjustment | string | optionnel | Que faire si la date de la facture empêche la finalisation (antérieure à la dernière facture finalisée, ou trop lointaine). None (défaut) : conserver la date, la finalisation échoue. MinimumDate : reprendre la date de la dernière facture finalisée. Today : utiliser la date du jour. |
Recherche une facture de vente par son numéro, tel qu'il figure sur le document, ou par son identifiant interne (issu de votre système). Un brouillon porte un numéro provisoire (ex. 000001) jusqu'à sa finalisation, qui lui attribue son numéro définitif : la recherche par numéro peut correspondre à l'un ou l'autre. Si les deux critères sont fournis, internalId prévaut.
| Paramètre | Type | Description | |
|---|---|---|---|
| number | string | optionnel | Numéro de la facture, tel qu'il figure sur le document |
| internalId | string | optionnel | Identifiant interne de la facture (issu de votre système) |
Récupère une facture de vente par son id numérique Altoviz, avec ses lignes et ses échéances.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de la facture |
Liste les factures de vente (ventes émises), filtrables par période, client et statut. Pour les factures impayées et en retard, utiliser status=Expired. Par défaut, les factures annulées et les factures traitées sont exclues.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Date de début incluse (ISO 8601, ex. 2026-01-01) |
| to | string | optionnel | Date de fin incluse (ISO 8601, ex. 2026-12-31) |
| customerId | integer | optionnel | Filtrer sur l'id d'un client |
| status | string | optionnel | Filtrer sur le statut. Expired = échue et non payée, c'est-à-dire en retard / impayée. Incoming = finalisée et pas encore échue. ToSend = finalisée mais pas encore envoyée. |
| cancelled | string | optionnel | Factures annulées : Excluded (défaut) les masque, Only ne renvoie qu'elles, All renvoie les deux. |
| processed | string | optionnel | Factures traitées, c'est-à-dire dont le statut e-facturation terminal a été pris en compte : Excluded (défaut) les masque, Only ne renvoie qu'elles, All renvoie les deux. |
| pageIndex | integer | optionnel | Numéro de page, à partir de 1 |
| pageSize | integer | optionnel | Nombre d'éléments par page (25 par défaut, 100 maximum conseillé) |
| orderBy | string | optionnel | Champ de tri |
Enregistre le règlement (encaissement) d'une facture de vente. Difficilement réversible : demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| paymentJson | string | requis | Règlement au format JSON. Champs : invoiceId (requis), date (AAAA-MM-JJ), amount (montant encaissé en euros, omis = solde total), paymentMethod, paymentReference, finalizeInvoice (finalise la facture si elle est encore en brouillon), finalizationDate (date de finalisation, distincte de date qui est la date du règlement) et dateAdjustment (None | MinimumDate | Today, si la date de la facture empêche la finalisation). Ex. {"invoiceId":123,"date":"2026-06-01","amount":1000.00} |
Envoie une facture de vente finalisée au client par email. L'email part réellement : demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de la facture |
Modifie une facture de vente encore au statut brouillon. Une facture finalisée ne peut plus être modifiée : il faut l'annuler par un avoir. Remplacement complet, pas une modification partielle : un champ omis est effacé. Lire d'abord l'objet avec l'outil get_* correspondant, modifier ce qui doit l'être et renvoyer l'objet entier. Les champs en lecture seule (id, montants calculés...) sont ignorés. Seul metadata est fusionné (une clé à null est supprimée). Toutes les lignes sont supprimées puis recréées à partir de lines : une ligne absente de lines disparaît. Pour changer un prix, modifier taxExcludedPrice (ou taxIncludedPrice si useTaxIncludedPrices=true).
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de la facture |
| invoiceJson | string | requis | Facture complète au format JSON, telle que renvoyée par get_sale_invoice puis modifiée. Mêmes champs que create_sale_invoice. |
Devis
Crée un devis (proposition commerciale). Résoudre le client avec find_customer ou list_customers avant d'appeler cet outil. L'API ne permet pas de modifier un devis existant : pour le corriger, le supprimer et le recréer.
| Paramètre | Type | Description | |
|---|---|---|---|
| quoteJson | string | requis | Devis au format JSON. Champs : customerId ou customerNumber (l'un des deux est requis ; obtenus avec find_customer ou list_customers ; customerNumber doit être le numéro client exact, erreur 400 si aucun ou plusieurs clients correspondent), date (AAAA-MM-JJ, aujourd'hui par défaut), subject, headerNotes, footerNotes, customerOrderReference, internalId, globalDiscount ({"type":"Percent","value":10}, value de 0 à 100 en Percent), useTaxIncludedPrices (false par défaut, même si le compte travaille en TTC : les prix des lignes sont alors HT), lines (requis, au moins une ligne). Adresses, contact, SIRET et numéro de TVA sont repris du client s'ils sont omis. À la création, ne pas envoyer liableToVat : il est déduit du compte (s'il est envoyé à false, vatNote devient obligatoire). L'API n'expose pas les conditions de règlement. Propres au devis : validityDate (AAAA-MM-JJ ; aujourd'hui par défaut, donc à renseigner), deposit (acompte demandé, {"type":"Percent","value":30}). Chaque ligne : type (Product | Service | Text | Subtotal | NewPage ; déduit du produit si un produit est référencé), productId ou productNumber (produit du catalogue : description, prix et TVA en sont repris s'ils sont omis ; ne jamais envoyer d'objet product, qui créerait un nouveau produit), description (requise pour une ligne Product ou Service sans produit ; HTML accepté), quantity, taxExcludedPrice (prix unitaire HT ; taxIncludedPrice si useTaxIncludedPrices=true), vat ({"rate":20} : taux en pour cent, jamais d'id ; omis = TVA du produit ou taux par défaut ; ne pas l'envoyer si l'entreprise n'est pas assujettie, cela rendrait le document assujetti), unit ({"code":"H"} : code issu de list_units ; jamais repris du produit), discount ({"type":"Percent","value":10} avec value de 0 à 100, ou {"type":"Fixed","value":50}, Fixed étant un montant retiré du total de la ligne), purchasePrice. Ligne de texte : {"type":"Text","description":"..."}. Ex. {"customerId":42,"date":"2026-06-01","validityDate":"2026-07-01","lines":[{"type":"Service","description":"Journée de conseil","quantity":2,"taxExcludedPrice":600,"vat":{"rate":20},"unit":{"code":"J"}}]} |
Supprime un devis. Demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du devis |
Télécharge un devis au format PDF, renvoyé encodé en base64.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du devis |
Recherche un devis par son numéro, tel qu'il figure sur le document, ou par son identifiant interne (issu de votre système). Un brouillon porte un numéro provisoire (ex. 000001) jusqu'à sa finalisation, qui lui attribue son numéro définitif : la recherche par numéro peut correspondre à l'un ou l'autre. Si les deux critères sont fournis, internalId prévaut.
| Paramètre | Type | Description | |
|---|---|---|---|
| number | string | optionnel | Numéro du devis, tel qu'il figure sur le document |
| internalId | string | optionnel | Identifiant interne du devis (issu de votre système) |
Récupère un devis par son id numérique Altoviz, avec ses lignes.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du devis |
Liste les devis, filtrables par période et par client.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Date de début incluse (ISO 8601, ex. 2026-01-01) |
| to | string | optionnel | Date de fin incluse (ISO 8601, ex. 2026-12-31) |
| customerId | integer | optionnel | Filtrer sur l'id d'un client |
| pageIndex | integer | optionnel | Numéro de page, à partir de 1 |
| pageSize | integer | optionnel | Nombre d'éléments par page (25 par défaut, 100 maximum conseillé) |
| orderBy | string | optionnel | Champ de tri |
Envoie un devis au client par email. L'email part réellement : demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du devis |
Avoirs
Contrôle un avoir au regard des règles de la facturation électronique (Factur-X / CII) et renvoie les anomalies détaillées : texte, gravité (Error / Warning), origine (Application = à corriger dans Altoviz, Directory = adresse électronique ou annuaire, Platform = contenu de l'avoir), emplacement dans le XML et validateur. Soumet le document généré à la plateforme de validation e-facturation pour contrôle ; ne finalise pas l'avoir et ne l'envoie pas au client. UNIQUEMENT sur un avoir en brouillon, à utiliser AVANT finalize_sale_credit pour savoir s'il passerait ; un avoir déjà finalisé renvoie une erreur 409. Se fier au champ isValid pour le verdict : un avoir peut être non conforme alors que toutes les anomalies sont de gravité Warning, les règles françaises BR-FR étant remontées en avertissement.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de l'avoir en brouillon |
Crée un avoir au statut brouillon. Un avoir est le seul moyen d'annuler ou de corriger une facture déjà finalisée. Tant qu'il n'est pas finalisé, il n'est ni numéroté ni opposable.
| Paramètre | Type | Description | |
|---|---|---|---|
| creditJson | string | requis | Avoir au format JSON. Champs : customerId ou customerNumber (l'un des deux est requis ; obtenus avec find_customer ou list_customers ; customerNumber doit être le numéro client exact, erreur 400 si aucun ou plusieurs clients correspondent), date (AAAA-MM-JJ, aujourd'hui par défaut), subject, headerNotes, footerNotes, customerOrderReference, internalId, globalDiscount ({"type":"Percent","value":10}, value de 0 à 100 en Percent), useTaxIncludedPrices (false par défaut, même si le compte travaille en TTC : les prix des lignes sont alors HT), lines (requis, au moins une ligne). Adresses, contact, SIRET et numéro de TVA sont repris du client s'ils sont omis. À la création, ne pas envoyer liableToVat : il est déduit du compte (s'il est envoyé à false, vatNote devient obligatoire). L'API n'expose pas les conditions de règlement. Chaque ligne : type (Product | Service | Text | Subtotal | NewPage ; déduit du produit si un produit est référencé), productId ou productNumber (produit du catalogue : description, prix et TVA en sont repris s'ils sont omis ; ne jamais envoyer d'objet product, qui créerait un nouveau produit), description (requise pour une ligne Product ou Service sans produit ; HTML accepté), quantity, taxExcludedPrice (prix unitaire HT ; taxIncludedPrice si useTaxIncludedPrices=true), vat ({"rate":20} : taux en pour cent, jamais d'id ; omis = TVA du produit ou taux par défaut ; ne pas l'envoyer si l'entreprise n'est pas assujettie, cela rendrait le document assujetti), unit ({"code":"H"} : code issu de list_units ; jamais repris du produit), discount ({"type":"Percent","value":10} avec value de 0 à 100, ou {"type":"Fixed","value":50}, Fixed étant un montant retiré du total de la ligne), purchasePrice. Ligne de texte : {"type":"Text","description":"..."}. L'API ne relie pas l'avoir à une facture : pour annuler une facture, reprendre ses lignes (get_sale_invoice) et citer son numéro dans subject. Ex. {"customerId":42,"subject":"Avoir sur facture FA001000","lines":[{"type":"Service","description":"Journée de conseil","quantity":2,"taxExcludedPrice":600,"vat":{"rate":20},"unit":{"code":"J"}}]} |
Supprime un avoir encore au statut brouillon. Demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de l'avoir |
Télécharge un avoir au format PDF, renvoyé encodé en base64.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de l'avoir |
Finalise un avoir : il est numéroté et devient une pièce comptable opposable. IRRÉVERSIBLE - demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de l'avoir |
| finalizationDate | string | optionnel | Date de finalisation (AAAA-MM-JJ). Par défaut, la date de l'avoir lui-même. |
| dateAdjustment | string | optionnel | Que faire si la date de l'avoir empêche la finalisation (antérieure au dernier avoir finalisé, ou trop lointaine). None (défaut) : conserver la date, la finalisation échoue. MinimumDate : reprendre la date du dernier avoir finalisé. Today : utiliser la date du jour. |
Recherche un avoir par son numéro, tel qu'il figure sur le document, ou par son identifiant interne (issu de votre système). Un brouillon porte un numéro provisoire (ex. 000001) jusqu'à sa finalisation, qui lui attribue son numéro définitif : la recherche par numéro peut correspondre à l'un ou l'autre. Si les deux critères sont fournis, internalId prévaut.
| Paramètre | Type | Description | |
|---|---|---|---|
| number | string | optionnel | Numéro de l'avoir, tel qu'il figure sur le document |
| internalId | string | optionnel | Identifiant interne de l'avoir (issu de votre système) |
Récupère un avoir par son id numérique Altoviz, avec ses lignes.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de l'avoir |
Liste les avoirs (notes de crédit émises aux clients), filtrables par période et par client. Par défaut, les avoirs annulés et les avoirs traités sont exclus.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Date de début incluse (ISO 8601) |
| to | string | optionnel | Date de fin incluse (ISO 8601) |
| customerId | integer | optionnel | Filtrer sur l'id d'un client |
| cancelled | string | optionnel | Avoirs annulés : Excluded (défaut) les masque, Only ne renvoie qu'eux, All renvoie les deux. |
| processed | string | optionnel | Avoirs traités, c'est-à-dire dont le statut e-facturation terminal a été pris en compte : Excluded (défaut) les masque, Only ne renvoie qu'eux, All renvoie les deux. |
| pageIndex | integer | optionnel | Numéro de page, à partir de 1 |
| pageSize | integer | optionnel | Nombre d'éléments par page (25 par défaut, 100 maximum conseillé) |
| orderBy | string | optionnel | Champ de tri |
Enregistre le remboursement d'un avoir au client. Difficilement réversible : demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| refundJson | string | requis | Remboursement au format JSON. Champs : creditId (requis), date (AAAA-MM-JJ), amount (montant en euros, omis = solde total), paymentMethod, refundReference, finalizeCredit (finalise l'avoir s'il est encore en brouillon), finalizationDate (date de finalisation, distincte de date qui est la date du remboursement) et dateAdjustment (None | MinimumDate | Today, si la date de l'avoir empêche la finalisation). Ex. {"creditId":123,"date":"2026-06-01"} |
Envoie un avoir finalisé au client par email. L'email part réellement : demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de l'avoir |
Modifie un avoir encore au statut brouillon. Un avoir finalisé ne peut plus être modifié. Remplacement complet, pas une modification partielle : un champ omis est effacé. Lire d'abord l'objet avec l'outil get_* correspondant, modifier ce qui doit l'être et renvoyer l'objet entier. Les champs en lecture seule (id, montants calculés...) sont ignorés. Seul metadata est fusionné (une clé à null est supprimée). Toutes les lignes sont supprimées puis recréées à partir de lines : une ligne absente de lines disparaît. Pour changer un prix, modifier taxExcludedPrice (ou taxIncludedPrice si useTaxIncludedPrices=true). Envoyer lines vide ou l'omettre supprime toutes les lignes.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de l'avoir |
| creditJson | string | requis | Avoir complet au format JSON, tel que renvoyé par get_sale_credit puis modifié. Mêmes champs que create_sale_credit. |
Achats et dépenses
Télécharge une facture fournisseur (achat) au format PDF, renvoyé encodé en base64.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de la facture fournisseur |
Enregistre une facture fournisseur (achat, charge) à partir d'un PDF ou d'une image. Altoviz lit le document et en extrait le fournisseur, la date, la référence et le montant TTC. C'est le seul moyen de créer une facture fournisseur : vérifier ensuite les données extraites avec export_expense_charges, car la lecture automatique peut se tromper.
| Paramètre | Type | Description | |
|---|---|---|---|
| fileUrl | string | optionnel | URL https du fichier (PDF, PNG, JPEG). Alternative à fileBase64. |
| fileBase64 | string | optionnel | Contenu du fichier encodé en base64. Alternative à fileUrl. |
| fileName | string | optionnel | Nom du fichier, ex. « facture-ovh-2026-03.pdf ». Sert à déduire le type de document. |
Encaissements clients
Enregistre un encaissement reçu d'un client et l'affecte à une ou plusieurs pièces. Pour solder simplement une facture, mark_sale_invoice_as_paid est plus direct.
| Paramètre | Type | Description | |
|---|---|---|---|
| receiptJson | string | requis | Encaissement au format JSON. Champs : customerId (ou customerNumber, numéro client exact, ou customerInternalId ; erreur 400 si aucun ou plusieurs clients correspondent), date (AAAA-MM-JJ), amount (montant reçu en euros), paymentMethod (Transfer | Order | Check | Cash | Card | Bill | Usec | Other), reference, status (Success | Pending | Failed), links (affectation : [{"type":"Invoice","id":123,"amount":600}], type valant Invoice, Credit ou Commitment). Ex. {"customerId":42,"date":"2026-06-01","amount":600,"paymentMethod":"Transfer","links":[{"type":"Invoice","id":123,"amount":600}]} |
Supprime un encaissement client : la facture correspondante redevient impayée. Demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de l'encaissement |
Recherche un encaissement client par son identifiant interne.
| Paramètre | Type | Description | |
|---|---|---|---|
| internalId | string | requis | Identifiant interne de l'encaissement |
Récupère un encaissement client par son id numérique Altoviz.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de l'encaissement |
Liste les encaissements / règlements reçus des clients, avec leur affectation aux factures, avoirs ou échéances. Ce sont des rentrées d'argent, pas des dépenses : pour les achats et les justificatifs de dépense, voir les factures fournisseurs et export_expense_charges.
| Paramètre | Type | Description | |
|---|---|---|---|
| pageIndex | integer | optionnel | Numéro de page, à partir de 1 |
| pageSize | integer | optionnel | Nombre d'éléments par page (25 par défaut, 100 maximum conseillé) |
| orderBy | string | optionnel | Champ de tri |
Modifie un encaissement client existant, par exemple pour corriger son montant ou son affectation. Remplacement complet, pas une modification partielle : un champ omis est effacé. Lire d'abord l'objet avec l'outil get_* correspondant, modifier ce qui doit l'être et renvoyer l'objet entier. Les champs en lecture seule (id, montants calculés...) sont ignorés. Seul metadata est fusionné (une clé à null est supprimée).
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de l'encaissement |
| receiptJson | string | requis | Encaissement complet au format JSON, tel que renvoyé par get_receipt puis modifié. Mêmes champs que create_receipt ; links remplace toute l'affectation. |
Statistiques
Balance âgée : montants restant dus, regroupés selon l'écart entre chaque échéance et aujourd'hui. period négatif = en retard, 0 = dû aujourd'hui, positif = à venir ; les paliers sont 1, 7, 15, 30, 60 et 90 jours, et -7 / 7 signifient plus de 90 jours. Répond à « combien me doit-on, et avec quel retard ? » en totaux ; pour le détail par client, get_top_overdue_customers ou export_commitments.
| Paramètre | Type | Description | |
|---|---|---|---|
| side | string | requis | Customers = sommes dues par les clients (créances) ; Suppliers = sommes dues aux fournisseurs (dettes). Soustraire l'une de l'autre donne la position nette. |
Suivi de trésorerie découpé en intervalles (mois par défaut) : encaissements et décaissements réalisés, montants restant à encaisser et à payer, et prévisionnel (réalisé + en attente), avec le solde de chaque série. Chaque liste partage les mêmes intervalles : l'indice N désigne la même période partout. Un intervalle partial=true est tronqué par la période demandée et ne doit pas être comparé tel quel.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Premier jour de la période (ISO 8601, ex. 2026-01-01). Combiné avec to, prévaut sur year. |
| to | string | optionnel | Dernier jour de la période, inclus (ISO 8601, ex. 2026-03-31) |
| year | integer | optionnel | Raccourci pour une année civile entière (année en cours par défaut). Ignoré si from/to sont fournis. |
| periodicity | string | optionnel | Taille des intervalles : Daily, Weekly, Monthly (défaut), Quarterly ou Annually |
| cumulative | boolean | optionnel | Renvoyer des cumuls depuis le début de la période au lieu du montant de chaque intervalle |
État de préparation à la facturation électronique : nombre de clients et de fournisseurs correctement paramétrés, et nombre présentant des données manquantes (adresse électronique, SIRET, numéro de TVA).
Chiffre d'affaires cumulé depuis la création de l'entreprise, toutes années confondues.
Délais de paiement réellement constatés sur une période : jours entre la date du document et le règlement, jours de retard après l'échéance, part du montant réglé en retard, avec leur évolution par intervalle. Répond à « mes clients paient-ils à l'heure ? ». Se fier aux médianes (medianDaysToPayment, medianDaysLate) plutôt qu'aux moyennes, tirées vers le haut par quelques très mauvais payeurs.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Premier jour de la période (ISO 8601, ex. 2026-01-01). Combiné avec to, prévaut sur year. |
| to | string | optionnel | Dernier jour de la période, inclus (ISO 8601, ex. 2026-03-31) |
| year | integer | optionnel | Raccourci pour une année civile entière (année en cours par défaut). Ignoré si from/to sont fournis. |
| periodicity | string | optionnel | Taille des intervalles : Daily, Weekly, Monthly (défaut), Quarterly ou Annually |
| side | string | optionnel | Customers (défaut) = délais de paiement des clients ; Suppliers = délais de paiement de l'entreprise envers ses fournisseurs |
Clients ayant des échéances en retard, classés par montant dû. Pour chacun : montant en retard, nombre d'échéances, ancienneté de la plus vieille échéance impayée et date de la dernière relance (null = jamais relancé). Répond à « qui dois-je relancer en premier ? ».
| Paramètre | Type | Description | |
|---|---|---|---|
| take | integer | optionnel | Nombre de clients à renvoyer, de 1 à 20 (5 par défaut) |
Chiffre d'affaires (ou dépenses) HT sur une période, comparé à la même période un an plus tôt et à la période de même durée qui la précède immédiatement. Pour un mois : from/to sur ce mois. Pour une micro-entreprise, le calcul se fait toujours sur les encaissements.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Premier jour de la période (ISO 8601, ex. 2026-01-01). Combiné avec to, prévaut sur year. |
| to | string | optionnel | Dernier jour de la période, inclus (ISO 8601, ex. 2026-03-31) |
| year | integer | optionnel | Raccourci pour une année civile entière (année en cours par défaut). Ignoré si from/to sont fournis. |
| expenses | boolean | optionnel | true pour les dépenses (achats) au lieu des ventes |
| paid | boolean | optionnel | true pour compter ce qui a été réellement réglé (encaissements / décaissements) au lieu de ce qui a été facturé. Toujours appliqué pour une micro-entreprise (get_settings : company.isMicroBusiness). |
Évolution du chiffre d'affaires HT découpée en intervalles (mois par défaut) sur une période, éventuellement comparée à la même période des années précédentes et ventilée par client, fournisseur, produit ou collaborateur. La première série est la période demandée, les suivantes les années antérieures (offset = nombre d'années en arrière) ; l'intervalle N de chaque série couvre la même période décalée, pour comparer indice par indice.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Premier jour de la période (ISO 8601, ex. 2026-01-01). Combiné avec to, prévaut sur year. |
| to | string | optionnel | Dernier jour de la période, inclus (ISO 8601, ex. 2026-03-31) |
| year | integer | optionnel | Raccourci pour une année civile entière (année en cours par défaut). Ignoré si from/to sont fournis. |
| periodicity | string | optionnel | Taille des intervalles : Daily, Weekly, Monthly (défaut), Quarterly ou Annually |
| compare | integer | optionnel | Nombre de périodes antérieures à renvoyer en plus, chacune une année civile plus tôt (0 à 2, 0 par défaut) |
| type | string | optionnel | Dimension d'analyse : Sales, Expenses, Customer, Supplier, Product, Colleague, Margin (marge) ou Discount (remises) |
| cumulative | boolean | optionnel | Renvoyer des cumuls au lieu du montant de chaque intervalle |
| customerId | integer | optionnel | Filtrer sur l'id d'un client |
| supplierId | integer | optionnel | Filtrer sur l'id d'un fournisseur |
| colleagueId | integer | optionnel | Filtrer sur l'id d'un collaborateur |
| productId | integer | optionnel | Filtrer sur l'id d'un produit |
Exports
Exporte les opérations d'un compte bancaire sur une période. Pour les consulter page par page, list_bank_transactions.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id du compte bancaire, obtenu avec list_bank_accounts |
| from | string | optionnel | Date de début incluse (ISO 8601, ex. 2026-01-01) |
| to | string | optionnel | Date de fin incluse (ISO 8601, ex. 2026-12-31) |
| sheets | string | optionnel | Feuilles à inclure : Summary (totaux seuls, le moins volumineux), Detail (ligne à ligne), Analysis, ou All. |
| format | string | optionnel | Format de sortie. Json (défaut) et Markdown sont directement lisibles ; EuropeanCsv, AmericanCsv et Tsv aussi ; Excel renvoie un fichier binaire encodé en base64. |
Exporte l'échéancier sur une période : ce qui doit être encaissé des clients, payé aux fournisseurs ou remboursé aux collaborateurs, et à quelle date. C'est la vue à utiliser pour les impayés et les relances.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Date de début incluse (ISO 8601, ex. 2026-01-01) |
| to | string | optionnel | Date de fin incluse (ISO 8601, ex. 2026-12-31) |
| types | string | optionnel | Restreindre à certains types d'échéances : Customer, Supplier, Colleague. Plusieurs valeurs séparées par des virgules. |
| sheets | string | optionnel | Feuilles à inclure : Summary (totaux seuls, le moins volumineux), Detail (ligne à ligne), Analysis, ou All. |
| format | string | optionnel | Format de sortie. Json (défaut) et Markdown sont directement lisibles ; EuropeanCsv, AmericanCsv et Tsv aussi ; Excel renvoie un fichier binaire encodé en base64. |
Exporte la liste des clients.
| Paramètre | Type | Description | |
|---|---|---|---|
| searchTerm | string | optionnel | Recherche plein texte |
| sheets | string | optionnel | Feuilles à inclure : Summary (totaux seuls, le moins volumineux), Detail (ligne à ligne), Analysis, ou All. |
| format | string | optionnel | Format de sortie. Json (défaut) et Markdown sont directement lisibles ; EuropeanCsv, AmericanCsv et Tsv aussi ; Excel renvoie un fichier binaire encodé en base64. |
Exporte les factures fournisseurs (achats, charges) sur une période. C'est le seul moyen de lire les achats de façon structurée : l'API n'offre ni liste ni consultation unitaire des factures fournisseurs.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Date de début incluse (ISO 8601, ex. 2026-01-01) |
| to | string | optionnel | Date de fin incluse (ISO 8601, ex. 2026-12-31) |
| supplierId | integer | optionnel | Filtrer sur l'id d'un fournisseur |
| searchTerm | string | optionnel | Recherche plein texte |
| sheets | string | optionnel | Feuilles à inclure : Summary (totaux seuls, le moins volumineux), Detail (ligne à ligne), Analysis, ou All. |
| format | string | optionnel | Format de sortie. Json (défaut) et Markdown sont directement lisibles ; EuropeanCsv, AmericanCsv et Tsv aussi ; Excel renvoie un fichier binaire encodé en base64. |
Exporte les notes de frais des collaborateurs sur une période. C'est le seul accès aux notes de frais : l'API n'expose pas d'endpoint dédié.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Date de début incluse (ISO 8601, ex. 2026-01-01) |
| to | string | optionnel | Date de fin incluse (ISO 8601, ex. 2026-12-31) |
| colleagueId | integer | optionnel | Filtrer sur l'id d'un collaborateur |
| sheets | string | optionnel | Feuilles à inclure : Summary (totaux seuls, le moins volumineux), Detail (ligne à ligne), Analysis, ou All. |
| format | string | optionnel | Format de sortie. Json (défaut) et Markdown sont directement lisibles ; EuropeanCsv, AmericanCsv et Tsv aussi ; Excel renvoie un fichier binaire encodé en base64. |
Exporte le livre des achats (registre comptable obligatoire des dépenses) sur une période.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Date de début incluse (ISO 8601, ex. 2026-01-01) |
| to | string | optionnel | Date de fin incluse (ISO 8601, ex. 2026-12-31) |
| sheets | string | optionnel | Feuilles à inclure : Summary (totaux seuls, le moins volumineux), Detail (ligne à ligne), Analysis, ou All. |
| format | string | optionnel | Format de sortie. Json (défaut) et Markdown sont directement lisibles ; EuropeanCsv, AmericanCsv et Tsv aussi ; Excel renvoie un fichier binaire encodé en base64. |
Exporte le catalogue de produits et de prestations, avec prix et TVA.
| Paramètre | Type | Description | |
|---|---|---|---|
| searchTerm | string | optionnel | Recherche plein texte |
| sheets | string | optionnel | Feuilles à inclure : Summary (totaux seuls, le moins volumineux), Detail (ligne à ligne), Analysis, ou All. |
| format | string | optionnel | Format de sortie. Json (défaut) et Markdown sont directement lisibles ; EuropeanCsv, AmericanCsv et Tsv aussi ; Excel renvoie un fichier binaire encodé en base64. |
Exporte le livre des recettes (registre comptable obligatoire des encaissements) sur une période.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Date de début incluse (ISO 8601, ex. 2026-01-01) |
| to | string | optionnel | Date de fin incluse (ISO 8601, ex. 2026-12-31) |
| sheets | string | optionnel | Feuilles à inclure : Summary (totaux seuls, le moins volumineux), Detail (ligne à ligne), Analysis, ou All. |
| format | string | optionnel | Format de sortie. Json (défaut) et Markdown sont directement lisibles ; EuropeanCsv, AmericanCsv et Tsv aussi ; Excel renvoie un fichier binaire encodé en base64. |
Exporte les avoirs (notes de crédit émises aux clients) sur une période.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Date de début incluse (ISO 8601, ex. 2026-01-01) |
| to | string | optionnel | Date de fin incluse (ISO 8601, ex. 2026-12-31) |
| customerId | integer | optionnel | Filtrer sur l'id d'un client |
| searchTerm | string | optionnel | Recherche plein texte |
| sheets | string | optionnel | Feuilles à inclure : Summary (totaux seuls, le moins volumineux), Detail (ligne à ligne), Analysis, ou All. |
| format | string | optionnel | Format de sortie. Json (défaut) et Markdown sont directement lisibles ; EuropeanCsv, AmericanCsv et Tsv aussi ; Excel renvoie un fichier binaire encodé en base64. |
Exporte les factures de vente sur une période, avec leurs totaux et leur détail.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Date de début incluse (ISO 8601, ex. 2026-01-01) |
| to | string | optionnel | Date de fin incluse (ISO 8601, ex. 2026-12-31) |
| customerId | integer | optionnel | Filtrer sur l'id d'un client |
| searchTerm | string | optionnel | Recherche plein texte |
| sheets | string | optionnel | Feuilles à inclure : Summary (totaux seuls, le moins volumineux), Detail (ligne à ligne), Analysis, ou All. |
| format | string | optionnel | Format de sortie. Json (défaut) et Markdown sont directement lisibles ; EuropeanCsv, AmericanCsv et Tsv aussi ; Excel renvoie un fichier binaire encodé en base64. |
Exporte les devis sur une période.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Date de début incluse (ISO 8601, ex. 2026-01-01) |
| to | string | optionnel | Date de fin incluse (ISO 8601, ex. 2026-12-31) |
| customerId | integer | optionnel | Filtrer sur l'id d'un client |
| searchTerm | string | optionnel | Recherche plein texte |
| sheets | string | optionnel | Feuilles à inclure : Summary (totaux seuls, le moins volumineux), Detail (ligne à ligne), Analysis, ou All. |
| format | string | optionnel | Format de sortie. Json (défaut) et Markdown sont directement lisibles ; EuropeanCsv, AmericanCsv et Tsv aussi ; Excel renvoie un fichier binaire encodé en base64. |
Exporte les règlements sur une période : encaissements clients, paiements fournisseurs et remboursements de notes de frais.
| Paramètre | Type | Description | |
|---|---|---|---|
| from | string | optionnel | Date de début incluse (ISO 8601, ex. 2026-01-01) |
| to | string | optionnel | Date de fin incluse (ISO 8601, ex. 2026-12-31) |
| sheets | string | optionnel | Feuilles à inclure : Summary (totaux seuls, le moins volumineux), Detail (ligne à ligne), Analysis, ou All. |
| format | string | optionnel | Format de sortie. Json (défaut) et Markdown sont directement lisibles ; EuropeanCsv, AmericanCsv et Tsv aussi ; Excel renvoie un fichier binaire encodé en base64. |
Exporte la liste des fournisseurs.
| Paramètre | Type | Description | |
|---|---|---|---|
| searchTerm | string | optionnel | Recherche plein texte |
| sheets | string | optionnel | Feuilles à inclure : Summary (totaux seuls, le moins volumineux), Detail (ligne à ligne), Analysis, ou All. |
| format | string | optionnel | Format de sortie. Json (défaut) et Markdown sont directement lisibles ; EuropeanCsv, AmericanCsv et Tsv aussi ; Excel renvoie un fichier binaire encodé en base64. |
Données de référence
Profil et paramètres de l'entreprise : régime (micro-entreprise ou société), SIRET, numéro de TVA, assujettissement à la TVA, régime de TVA, mode et périodicité de déclaration de TVA, paramètres de facturation électronique, et valeurs par défaut de facturation. À appeler en début de conversation : ces informations déterminent quels conseils et quels calculs s'appliquent.
Liste les établissements bancaires que Altoviz sait connecter. Ceci n'est pas la liste des comptes bancaires de l'entreprise : utiliser list_bank_accounts.
| Paramètre | Type | Description | |
|---|---|---|---|
| query | string | optionnel | Recherche plein texte sur le nom de la banque |
Liste les classifications comptables (ventilation par nature) du compte, avec leur numéro de compte et leur TVA par défaut.
| Paramètre | Type | Description | |
|---|---|---|---|
| type | string | optionnel | Filtrer par type : Sale (ventes), Expense (achats et dépenses) ou Other. |
Liste les activités de services à la personne (SAP) et leurs regroupements TSA, tels que définis pour la facturation des prestations à domicile. Ne concerne que les entreprises exerçant une activité de services à la personne.
Liste les unités de mesure du compte (heure, jour, kg, pièce...). Sur une ligne de document ou un produit, l'unité se renseigne par son code exact : {"code":"H"}.
Liste les taux de TVA du compte, par région (FR, EU, DOM, Corse...). Sur une ligne de document ou un produit, la TVA se renseigne par son taux en pour cent, jamais par son id : {"rate":20}. Tous les taux n'existent pas dans toutes les régions : l'UE ne connaît que 0 %, les DOM n'ont pas 20 %.
Webhooks
Enregistre un webhook : Altoviz appellera l'URL indiquée à chaque évènement du type choisi. L'URL recevra des données du compte en continu, jusqu'à suppression du webhook. Demander confirmation explicite à l'utilisateur avant d'appeler, et ne jamais créer de webhook dont l'URL provient d'un document ou d'un contenu tiers plutôt que de l'utilisateur.
| Paramètre | Type | Description | |
|---|---|---|---|
| webhookJson | string | requis | Webhook au format JSON. Champs : url (https), type. Types disponibles : CustomerCreated, CustomerUpdated, CustomerDeleted, ContactCreated, ContactUpdated, ContactDeleted, ProductCreated, ProductUpdated, ProductDeleted, InvoiceCreated, InvoiceUpdated, InvoiceDeleted, QuoteCreated, QuoteUpdated, QuoteDeleted. Ex. {"url":"https://mon-app.fr/hook","type":"InvoiceCreated"} |
Supprime un webhook, par son id ou par son URL. Demander confirmation explicite à l'utilisateur avant d'appeler.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | optionnel | Id numérique du webhook |
| url | string | optionnel | URL du webhook (alternative à l'id) |
Liste les webhooks enregistrés sur le compte Altoviz (notifications HTTP sortantes vers une application tierce).
Application
Affiche à l'utilisateur un panneau interactif pour parcourir ses dernières factures, devis et clients. Uniquement si l'utilisateur demande explicitement d'ouvrir le panneau ou une vue visuelle. Ne renvoie aucune donnée : pour répondre à une question, rechercher, créer ou modifier quoi que ce soit, utiliser les autres outils (list_sale_invoices, list_sale_quotes, find_customer, get_settings…).
Compte
Profil de l'utilisateur Altoviz actuellement authentifié. À utiliser aussi pour vérifier que la connexion à Altoviz fonctionne et que les identifiants sont valides, par exemple pour diagnostiquer un problème d'accès.
Autres
Récupère un compte bancaire par son id numérique Altoviz : solde, opérations en attente, banque et état de synchronisation.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique du compte bancaire |
Récupère une opération bancaire par son id numérique Altoviz.
| Paramètre | Type | Description | |
|---|---|---|---|
| id | integer | requis | Id numérique de l'opération bancaire |
Liste les comptes bancaires de l'entreprise avec leur solde courant, le nombre et le montant des opérations en attente de rapprochement, et s'ils sont synchronisés avec une banque (connected). Fournit l'id attendu par list_bank_transactions et export_bank_transactions.
Liste les opérations d'un compte bancaire, filtrables par période et par recherche sur le libellé ou le montant. value est négatif pour une sortie d'argent. isReconciliated indique une opération déjà rapprochée d'un règlement ; isExcluded une opération mise de côté.
| Paramètre | Type | Description | |
|---|---|---|---|
| bankAccountId | integer | requis | Id du compte bancaire, obtenu avec list_bank_accounts |
| from | string | optionnel | Date de début incluse (ISO 8601, ex. 2026-01-01) |
| to | string | optionnel | Date de fin incluse (ISO 8601, ex. 2026-12-31) |
| searchTerm | string | optionnel | Recherche plein texte sur le libellé et le montant |
| hideExcluded | boolean | optionnel | true pour masquer les opérations mises de côté (renvoyées par défaut) |
| hideReconciliated | boolean | optionnel | true pour masquer les opérations déjà rapprochées, et ne garder que celles restant à rapprocher (renvoyées par défaut) |
| pageIndex | integer | optionnel | Numéro de page, à partir de 1 |
| pageSize | integer | optionnel | Nombre d'éléments par page (25 par défaut, 100 maximum conseillé) |
| orderBy | string | optionnel | Champ de tri |
Prompts
Reprend un devis accepté pour en faire une facture de vente.
| Paramètre | Type | Description | |
|---|---|---|---|
| devis | string | optionnel | Numéro ou nom du devis à transformer |
Crée une facture de vente de bout en bout, avec validation avant finalisation.
| Paramètre | Type | Description | |
|---|---|---|---|
| client | string | optionnel | Nom du client |
| prestation | string | optionnel | Prestation ou produit à facturer |
| montant | string | optionnel | Montant HT en euros |
Synthèse mensuelle : ventes, dépenses, trésorerie et impayés.
| Paramètre | Type | Description | |
|---|---|---|---|
| mois | string | optionnel | Mois à analyser au format AAAA-MM (mois en cours par défaut) |
Rassemble les éléments nécessaires à une déclaration de TVA sur une période.
| Paramètre | Type | Description | |
|---|---|---|---|
| periode | string | optionnel | Période à déclarer, ex. « 2e trimestre 2026 » ou « juin 2026 » |
Liste les clients en retard de paiement, du plus urgent au moins urgent.
Prépare des relances pour les factures en retard, graduées selon l'ancienneté.
| Paramètre | Type | Description | |
|---|---|---|---|
| depuisJours | string | optionnel | Ne relancer que les factures en retard de plus de N jours (optionnel) |
Enregistre un achat depuis un PDF ou une photo, puis vérifie la lecture automatique.
| Paramètre | Type | Description | |
|---|---|---|---|
| fichier | string | optionnel | URL https du fichier, ou description du document à enregistrer |
Situation du chiffre d'affaires par rapport aux plafonds du régime micro.
| Paramètre | Type | Description | |
|---|---|---|---|
| annee | string | optionnel | Année à analyser (année en cours par défaut) |