Lexoffice (Éditeur indépendant) (préversion)

L’API Lexware fournit un accès programmatique aux fonctionnalités métier principales de Lexware, telles que les articles, les contacts, les factures, les commandes et la gestion des fichiers. Ce connecteur Éditeur indépendant permet une intégration sécurisée à l’API REST de Lexware, ce qui permet aux utilisateurs de créer et de récupérer des données métier, d’automatiser les processus et de connecter des ressources Lexware avec des applications Power Platform. Le connecteur utilise le flux de code d’autorisation OAuth 2.0 pour obtenir des instructions d’authentification et d’API sécurisées.

Ce connecteur est disponible dans les produits et régions suivants :

Service	classe	Régions
Copilot Studio	Premium	Toutes les régions Power Automate , à l’exception des éléments suivants :      - Us Government (GCC)      - Us Government (GCC High)      - China Cloud géré par 21Vianet      - Us Department of Defense (DoD)
Applications logiques	Norme	Toutes les régions Logic Apps , à l’exception des suivantes :      - Régions Azure Government      - Régions Azure Chine      - Us Department of Defense (DoD)
Power Apps	Premium	Toutes les régions Power Apps , à l’exception des suivantes :      - Us Government (GCC)      - Us Government (GCC High)      - China Cloud géré par 21Vianet      - Us Department of Defense (DoD)
Power Automate	Premium	Toutes les régions Power Automate , à l’exception des éléments suivants :      - Us Government (GCC)      - Us Government (GCC High)      - China Cloud géré par 21Vianet      - Us Department of Defense (DoD)

Contact
Nom	Prise en charge des enquêteurs LowCode
URL	https://lowcode-investigator.com/
Messagerie électronique	kontakt@lowcodeinvestigator.com

Métadonnées du connecteur
Éditeur	LowCodeInvestigator
Site internet	https://office.lexware.de/
Politique de confidentialité	https://office.lexware.de/datenschutz/
Catégories	Gestion de l’entreprise ; Finance

Connecteur d’API Lexware (éditeur indépendant)

L’API Lexware est une interface RESTful qui permet aux développeurs d’intégrer des fonctions métier Lexware telles que des contacts, des factures, des articles et des fichiers dans leurs propres applications. Ce connecteur permet une interaction directe avec ces ressources via des demandes d’API sécurisées et authentifiées.

Éditeur : Éditeur indépendant

Prerequisites

• Un compte Lexware inscrit et une licence appropriée
• Clé API valide (jeton d’accès) obtenue via le portail des développeurs Lexware
• Le flux de code d’autorisation OAuth 2.0 est requis pour l’authentification

Opérations prises en charge

Ce connecteur prend en charge les points de terminaison d’API Lexware suivants :

• Articles : Créer, récupérer, mettre à jour, supprimer et filtrer des articles
• Contacts : Gérer les données des clients et des fournisseurs
• Factures : créer et récupérer des données de facture, y compris le rendu des fichiers PDF
• Notes de crédit, notes de livraison, commandes, devis et bons
• Pays, conditions de paiement, dispositions d’impression et profils
• Abonnements et fichiers d’événements
• Liste complète documentée à l’adresse : Docs de l’API Lexware

Obtention des informations d’identification

Pour appeler l’API Lexware, vous avez besoin d’une clé API :

1. Connectez-vous à votre compte Office Lexware.
2. Accédez aux extensions → Weitere Apps → API publique ou ouvrez
   Portail des développeurs Lexware directement.
3. Créez une clé API avec les autorisations souhaitées.
4. Copiez la clé API générée. Cette valeur sera utilisée comme accessToken dans le connecteur.

Passerelle d’API

Utilisez la nouvelle passerelle d’API Lexware :

https://api.lexware.io

Limites de débit

• Nombre maximal de 2 requêtes/seconde
• Les requêtes dépassant cette limite reçoivent HTTP 429 Too Many Requests
• Recommandé : Utiliser l’algorithme de compartiment de jetons ou l’interruption exponentielle

Authentication

L’API Lexware utilise le flux de code d’autorisation OAuth 2.0. Incluez le jeton dans l’en-tête Authorization: Bearer {accessToken} de chaque requête.

Exemple d’utilisation

Création d’un article :

curl https://api.lexware.io/v1/articles \
  -X POST \
  -H "Authorization: Bearer {accessToken}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Lexware Buchhaltung Premium 2024",
    "type": "PRODUCT",
    "unitName": "Download-Code",
    "articleNumber": "LXW-BUHA-2024-001",
    "price": {
      "netPrice": 61.90,
      "leadingPrice": "NET",
      "taxRate": 19
    }
  }'

Problèmes connus et limitations

• Nombre maximal de 2 requêtes/seconde
• Certains points de terminaison nécessitent des autorisations ou des rôles supplémentaires

Documentation de l’API

La référence complète de l’API est disponible à l’adresse suivante :
https://developers.lexware.io/docs/

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :

Par défaut	Paramètres de création de connexion.	Toutes les régions	Non partageable

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Nom	Type	Descriptif	Obligatoire
Clé d’API	securestring	Clé API pour cette API	Vrai

Limites de limitation

Nom	Appels	Période de renouvellement
Appels d’API par connexion	100	60 secondes

Actions

Afficher un document de confirmation de commande (PDF)	Pour télécharger le fichier pdf d’un document de confirmation de commande, vous avez besoin de son documentFileId. Cet ID est généralement retourné par la ressource de confirmation de commande. Toutefois, les confirmations de commande nouvellement créées via l’API doivent déclencher le rendu du fichier de document pdf séparément. Cette opération peut être effectuée avec ce point de terminaison.
Afficher un document de copie (PDF)	Pour télécharger le fichier pdf d’un document de copie, vous avez besoin de son documentFileId. Cet ID est généralement retourné par la ressource de dénning. Toutefois, les opérations de vidage nouvellement créées via l’API doivent déclencher le rendu du fichier de document pdf séparément. Cette opération peut être effectuée avec ce point de terminaison.
Afficher un document de facture (PDF)	Pour télécharger le fichier pdf d’un document de facture, vous avez besoin de son documentFileId. Cet ID est généralement retourné par la ressource de facture. Toutefois, les factures nouvellement créées dans l’état ouvertes via l’API doivent déclencher le rendu du fichier de document pdf séparément. Cette opération peut être effectuée avec ce point de terminaison.
Afficher un document de guillemets (PDF)	Pour télécharger le fichier pdf d’un document de guillemets, vous avez besoin de son documentFileId. Cet ID est généralement retourné par la ressource de guillemets. Toutefois, les guillemets nouvellement créés dans l’état ouverts via l’API doivent déclencher le rendu du fichier de document pdf séparément. Cette opération peut être effectuée avec ce point de terminaison.
Afficher un document de note de crédit (PDF)	Pour télécharger le fichier pdf d’un document de note de crédit, vous avez besoin de son documentFileId. Cet ID est généralement retourné par la ressource de note de crédit. Toutefois, les notes de crédit nouvellement créées dans l’état ouvertes via l’API doivent déclencher le rendu du fichier de document pdf séparément. Cette opération peut être effectuée avec ce point de terminaison.
Afficher un document de note de remise (PDF)	Ce point de terminaison fournit un accès en lecture et en écriture aux notes de remise, ainsi que la possibilité d’afficher le document au format PDF afin de le télécharger. Les notes de remise sont toujours créées en mode brouillon et n’ont pas besoin d’être finalisées.
Charger un fichier	Utilisez ce point de terminaison pour charger des fichiers, par exemple des bons ou des factures.
Charger un fichier dans un bon	Chargez et attribuez des fichiers (pdf ou image) au bon identifié par {id}.
Créer un article	Le contenu de l’article est attendu dans le corps de la requête en tant qu’application/json.
Créer un bon	Créer des bons (limités aux bons de vente)
Créer un contact	Créer un contact
Créer un devis	Les guillemets transmis via l’API sont créés en mode brouillon par défaut. Pour créer un devis finalisé avec l’état, ouvrez la finalisation facultative du paramètre de requête doit être définie. L’état d’un devis ne peut pas être modifié via l’API.
Créer un dunning	Le dénning créé ne sera pas affiché dans la liste principale des bons dans lexoffice, mais sera attaché à une facture et y sera visible. Pour fournir à vos clients l’accès aunning créé, utilisez notre fonction deeplink.
Créer une confirmation de commande	Ce point de terminaison fournit un accès en lecture et écriture aux confirmations de commande, ainsi que la possibilité d’afficher le document au format PDF afin de le télécharger. Les confirmations de commande sont toujours créées en mode brouillon et n’ont pas besoin d’être finalisées.
Créer une facture	Les factures transmises via l’API sont créées en mode brouillon par défaut. Pour créer une facture finalisée avec l’état, ouvrez la finalisation du paramètre de requête facultatif doit être définie. L’état d’une facture ne peut pas être modifié via l’API.
Créer une note de crédit	Les notes de crédit transmises via l’API sont créées en mode brouillon par défaut. Pour créer une note de crédit finalisée avec l’état, le paramètre de requête facultatif finalise doit être défini. L’état d’une note de crédit ne peut pas être modifié via l’API
Créer une note de remise	La note de livraison créée s’affiche dans la liste principale des bons dans lexoffice. Les notes de remise transmises via l’API sont créées en mode brouillon uniquement.
Filtrage d’articles	Retourne les articles qui répondent aux critères donnés par les filtres filter_1 à filter_n à l’aide d’un mécanisme de pagination. Si plusieurs filtres sont donnés, le connecteur logique est AND. Les filtres qui ne sont pas définis sont ignorés. Pour vérifier la taille de page maximale de ce point de terminaison, consultez Pagination des ressources.
Mettre à jour le bon	Mettre à jour un bon
Mettre à jour un article	Mettez à jour un article existant avec l’ID {id} avec les données fournies dans la charge utile au format JSON. Retourne un résultat d’action en cas de réussite.
Mettre à jour un contact	Mettre à jour un contact
Récupérer et filtrer la liste des bons	Obtenez des bons de liste de bons (comptabilité) (par exemple, salesinvoices, salescreditnotes), factures (y compris des factures de paiement en baisse), des notes de crédit, des confirmations de commande, des devis et des notes de livraison.
Récupérer la liste des conditions de paiement	L’exemple suivant montre comment récupérer la liste des conditions de paiement actuellement configurées. Il est nécessaire de remplacer l’espace réservé {accessToken} avant d’envoyer la requête.
Récupérer la liste des pays	Liste des pays connus pour lexoffice.
Récupérer les informations de paiement	Le point de terminaison de paiement fournit un accès en lecture aux bons de paiement (comptabilité ou ventes), y compris les factures et les notes de crédit.
Récupérer les informations de profil	L’exemple suivant montre comment récupérer vos informations de profil de base. Il est nécessaire de remplacer l’espace réservé {accessToken} avant d’envoyer la requête.
Récupérer tous les abonnements aux événements	Récupérer tous les abonnements aux événements
Récupérer tous les contacts	Récupérer tous les contacts
Récupérer tous les modèles périodiques	Récupérez une collection de modèles périodiques. Le résultat retourne uniquement une partie des données les plus pertinentes qui sont le contact référencé (id et nom uniquement), le prix total, les conditions de paiement et les paramètres de modèles récurrents complets. Toutefois, le nommage des objets et des propriétés est le même.
Récupérer un abonnement aux événements	Récupérer un abonnement aux événements
Récupérer un article	Retourne l’article avec la valeur d’ID {id}.
Récupérer un bon	Répertorier les bons de vente (par exemple, les factures, les billets de crédit)
Récupérer un contact	Récupérer un contact par ID
Récupérer un devis	Retourne les guillemets avec la valeur d’ID {id}. Afficher un document de guillemets (PDF)
Récupérer un dunning	Retourne le dunning avec la valeur d’ID {id}.
Récupérer un modèle périodique	Retourne le modèle périodique avec la valeur d’ID {id}.
Récupérer une confirmation de commande	Retourne la confirmation de la commande avec la valeur d’ID {id}.
Récupérer une facture	Retourne la facture avec la valeur d’ID {id}.
Récupérer une facture de paiement vers le bas	Retourne la facture de paiement inférieur avec la valeur d’ID {id}.
Récupérer une liste de catégories de publication	Ce point de terminaison fournit un accès en lecture à la liste des catégories de publications pour les bons (comptabilité) revenus ou dépenses pris en charge dans lexoffice.
Récupérer une note de crédit	Ce point de terminaison fournit un accès en lecture et en écriture aux notes de crédit, ainsi que la possibilité d’afficher le document au format PDF afin de le télécharger. Les notes de crédit peuvent être créées en tant que brouillon ou finalisées en mode ouvert.
Récupérer une note de remise	Retourne la note de remise avec la valeur d’ID {id}.
Supprimer un article	Supprime l’article avec la valeur d’ID {id}. Retourne 204 en cas de réussite ou 404 si l’ID n’existe pas.
Supprimer un Event-Subscription	Supprimer le webHook du déclencheur
Télécharger un fichier	Utilisez ce point de terminaison pour télécharger des fichiers.

Afficher un document de confirmation de commande (PDF)

ID de l’opération :

RenderOrderConfirmationDocument

Pour télécharger le fichier pdf d’un document de confirmation de commande, vous avez besoin de son documentFileId. Cet ID est généralement retourné par la ressource de confirmation de commande. Toutefois, les confirmations de commande nouvellement créées via l’API doivent déclencher le rendu du fichier de document pdf séparément. Cette opération peut être effectuée avec ce point de terminaison.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Nom	Chemin	Type	Description
documentFileId	documentFileId	uuid

Afficher un document de copie (PDF)

ID de l’opération :

RenderDunningDocument

Pour télécharger le fichier pdf d’un document de copie, vous avez besoin de son documentFileId. Cet ID est généralement retourné par la ressource de dénning. Toutefois, les opérations de vidage nouvellement créées via l’API doivent déclencher le rendu du fichier de document pdf séparément. Cette opération peut être effectuée avec ce point de terminaison.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Dunningsid	dunningsid	True	string	Spécifiez le dunningsid.

Retourne

Nom	Chemin	Type	Description
documentFileId	documentFileId	uuid

Afficher un document de facture (PDF)

ID de l’opération :

RenderInvoiceDocument

Pour télécharger le fichier pdf d’un document de facture, vous avez besoin de son documentFileId. Cet ID est généralement retourné par la ressource de facture. Toutefois, les factures nouvellement créées dans l’état ouvertes via l’API doivent déclencher le rendu du fichier de document pdf séparément. Cette opération peut être effectuée avec ce point de terminaison.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Nom	Chemin	Type	Description
documentFileId	documentFileId	uuid

Afficher un document de guillemets (PDF)

ID de l’opération :

RenderQuotationDocument

Pour télécharger le fichier pdf d’un document de guillemets, vous avez besoin de son documentFileId. Cet ID est généralement retourné par la ressource de guillemets. Toutefois, les guillemets nouvellement créés dans l’état ouverts via l’API doivent déclencher le rendu du fichier de document pdf séparément. Cette opération peut être effectuée avec ce point de terminaison.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Nom	Chemin	Type	Description
documentFileId	documentFileId	uuid

Afficher un document de note de crédit (PDF)

ID de l’opération :

RenderCreditNoteDocument

Pour télécharger le fichier pdf d’un document de note de crédit, vous avez besoin de son documentFileId. Cet ID est généralement retourné par la ressource de note de crédit. Toutefois, les notes de crédit nouvellement créées dans l’état ouvertes via l’API doivent déclencher le rendu du fichier de document pdf séparément. Cette opération peut être effectuée avec ce point de terminaison.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Nom	Chemin	Type	Description
documentFileId	documentFileId	uuid

Afficher un document de note de remise (PDF)

ID de l’opération :

RenderDeliveryNoteDocument

Ce point de terminaison fournit un accès en lecture et en écriture aux notes de remise, ainsi que la possibilité d’afficher le document au format PDF afin de le télécharger. Les notes de remise sont toujours créées en mode brouillon et n’ont pas besoin d’être finalisées.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Note de remise	DeliveryNoteid	True	string	Spécifiez le noteid de remise.

Retourne

Nom	Chemin	Type	Description
city	address.city	string
countryCode	address.countryCode	string
nom	address.name	string
street	address.street	string
Supplément	address.supplement	string
fichier ZIP	address.zip	string
Archivés	archived	boolean
date de création	createdDate	date-time
deliveryTerms	deliveryTerms	string
pièce d'identité	id	uuid
introduction	introduction	string
language	language	string
lineItems	lineItems	array of object
nom	lineItems.name	string
quantité	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Monnaie	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
remarque	remark	string
taxType	taxConditions.taxType	string
title	title	string
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
couponNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Charger un fichier

ID de l’opération :

UploadFile_Lexoffice

Utilisez ce point de terminaison pour charger des fichiers, par exemple des bons ou des factures.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Fichier	file	True	file	Fichier à charger.
Type	type	True	string	Description du contenu du fichier.

Retourne

Corps

Response_files_post

Charger un fichier dans un bon

ID de l’opération :

UploadFileVoucher_Lexoffice

Chargez et attribuez des fichiers (pdf ou image) au bon identifié par {id}.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.
Fichier	file	True	file	Fichier à charger.

Créer un article

ID de l’opération :

CreateArticle

Le contenu de l’article est attendu dans le corps de la requête en tant qu’application/json.

Paramètres

Nom	Clé	Obligatoire	Type	Description
articleNumber	articleNumber		string	articleNumber
grossPrice	grossPrice		float	grossPrice
leadingPrice	leadingPrice		string	leadingPrice
netPrice	netPrice		float	netPrice
taxRate	taxRate		float	taxRate
title	title		string	title
type	type		string	type
unitName	unitName		string	unitName

Retourne

Corps

Response_articles_post

Créer un bon

ID de l’opération :

CreateVoucher

Créer des bons (limités aux bons de vente)

Paramètres

Nom	Clé	Obligatoire	Type	Description
contactId	contactId		string
dueDate	dueDate		date
remarque	remark		string
shippingDate	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
type	type	True	string
useCollectiveContact	useCollectiveContact		boolean
voucherDate	voucherDate		date
montant	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
couponNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Retourne

Corps

Response_vouchers_post

Créer un contact

ID de l’opération :

CreateContact

Créer un contact

Retourne

Corps

Response_contacts_post

Créer un devis

ID de l’opération :

CreateQuotation

Les guillemets transmis via l’API sont créés en mode brouillon par défaut. Pour créer un devis finalisé avec l’état, ouvrez la finalisation facultative du paramètre de requête doit être définie. L’état d’un devis ne peut pas être modifié via l’API.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Finaliser	finalize	True	boolean	Spécifiez la finalisation.

Retourne

Corps

Response_quotations_post

Créer un dunning

ID de l’opération :

CreateDunning

Le dénning créé ne sera pas affiché dans la liste principale des bons dans lexoffice, mais sera attaché à une facture et y sera visible. Pour fournir à vos clients l’accès aunning créé, utilisez notre fonction deeplink.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de bon de vente précédent	precedingSalesVoucherId		string	Spécifiez l’ID de bon de vente précédent.

Retourne

Corps

Response_dunnings_post

Créer une confirmation de commande

ID de l’opération :

CreateOrderConfirmation

Ce point de terminaison fournit un accès en lecture et écriture aux confirmations de commande, ainsi que la possibilité d’afficher le document au format PDF afin de le télécharger. Les confirmations de commande sont toujours créées en mode brouillon et n’ont pas besoin d’être finalisées.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de bon de vente précédent	precedingSalesVoucherId		string	Spécifiez l’ID de bon de vente précédent.

Retourne

Corps

Response_order-confirmations_post

Créer une facture

ID de l’opération :

CreateInvoice

Les factures transmises via l’API sont créées en mode brouillon par défaut. Pour créer une facture finalisée avec l’état, ouvrez la finalisation du paramètre de requête facultatif doit être définie. L’état d’une facture ne peut pas être modifié via l’API.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de bon de vente précédent	precedingSalesVoucherId		string	Spécifiez l’ID de bon de vente précédent.
Finaliser	finalize	True	boolean	Spécifiez la finalisation.

Retourne

Corps

Response_invoices_post

Créer une note de crédit

ID de l’opération :

CreateCreditNote

Les notes de crédit transmises via l’API sont créées en mode brouillon par défaut. Pour créer une note de crédit finalisée avec l’état, le paramètre de requête facultatif finalise doit être défini. L’état d’une note de crédit ne peut pas être modifié via l’API

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de bon de vente précédent	precedingSalesVoucherId		string	Spécifiez l’ID de bon de vente précédent.
Finaliser	finalize	True	boolean	Spécifiez la finalisation.

Retourne

Corps

Response_credit-notes_post

Créer une note de remise

ID de l’opération :

CreateDeliveryNote

La note de livraison créée s’affiche dans la liste principale des bons dans lexoffice. Les notes de remise transmises via l’API sont créées en mode brouillon uniquement.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de bon de vente précédent	precedingSalesVoucherId		string	Spécifiez l’ID de bon de vente précédent.

Retourne

Corps

Response_delivery-notes_post

Filtrage d’articles

ID de l’opération :

FilteringArticles

Retourne les articles qui répondent aux critères donnés par les filtres filter_1 à filter_n à l’aide d’un mécanisme de pagination. Si plusieurs filtres sont donnés, le connecteur logique est AND. Les filtres qui ne sont pas définis sont ignorés. Pour vérifier la taille de page maximale de ce point de terminaison, consultez Pagination des ressources.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Numéro d’article	articleNumber		string	Spécifiez le numéro d’article.
Gtin	gtin		string	Spécifiez le gtin.
Type	type		string	Spécifiez le type.
Page	page		integer	Spécifiez la page.
Taille	size		integer	Spécifiez la taille.
Trier	sort		string	Spécifiez le tri.

Retourne

Corps

Response_articles_get

Mettre à jour le bon

ID de l’opération :

UpdateVoucher

Mettre à jour un bon

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.
contactId	contactId		string
dueDate	dueDate		date
Fichiers	files		array of string	liste des fileIds omis
remarque	remark		string
shippingDate	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
type	type	True	string
useCollectiveContact	useCollectiveContact		boolean
version	version		integer
voucherDate	voucherDate		date
montant	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
couponNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Retourne

Corps

Response_vouchers_id_put

Mettre à jour un article

ID de l’opération :

UpdateAnArticle

Mettez à jour un article existant avec l’ID {id} avec les données fournies dans la charge utile au format JSON. Retourne un résultat d’action en cas de réussite.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.
articleNumber	articleNumber		string	articleNumber
gtin	gtin		string	gtin
Note	note		string	Note
grossPrice	grossPrice	True	float	grossPrice
leadingPrice	leadingPrice	True	string	leadingPrice
netPrice	netPrice	True	float	netPrice
taxRate	taxRate		float	taxRate
title	title		string	title
type	type	True	string	type
unitName	unitName	True	string	unitName
version	version	True	integer	version

Retourne

Corps

Response_articles_id_get

Mettre à jour un contact

ID de l’opération :

UpdateContact

Mettre à jour un contact

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Corps

Response_contacts_id_put

Récupérer et filtrer la liste des bons

ID de l’opération :

RetrieveAndFilterVoucherlist

Obtenez des bons de liste de bons (comptabilité) (par exemple, salesinvoices, salescreditnotes), factures (y compris des factures de paiement en baisse), des notes de crédit, des confirmations de commande, des devis et des notes de livraison.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Type de bons	voucherType	True	string	Spécifiez le type de bon.
État du bon	voucherStatus	True	string	Spécifiez l’état du bon.
Archivés	archived		boolean	Spécifiez l’archive.
Contact Id	contactId		string	Spécifiez l’ID de contact.
Date de bon à partir de	voucherDateFrom		string	Spécifiez la date du bon à partir de.
Date du bon à	voucherDateTo		string	Spécifiez la date du bon à.
Date de création à partir de	createdDateFrom		string	Spécifiez la date de création à partir de laquelle.
Date de création à	createdDateTo		string	Spécifiez la date de création à.
Date de mise à jour à partir de	updatedDateFrom		string	Spécifiez la date de mise à jour à partir de laquelle.
Date à jour jusqu’à	updatedDateTo		string	Spécifiez la date à laquelle vous avez été mise à jour.
Numéro de bon	voucherNumber		string	Spécifiez le numéro de bon.
Page	page		integer	Spécifiez la page.
Taille	size		integer	Spécifiez la taille.
Trier	sort		string	Spécifiez le tri.

Retourne

Corps

Response_voucherlist_get

Récupérer la liste des conditions de paiement

ID de l’opération :

RetrieveListOfPaymentConditions

L’exemple suivant montre comment récupérer la liste des conditions de paiement actuellement configurées. Il est nécessaire de remplacer l’espace réservé {accessToken} avant d’envoyer la requête.

Retourne

response

array of Response_payment-conditions_get_items

Récupérer la liste des pays

ID de l’opération :

RetrieveListCountries

Liste des pays connus pour lexoffice.

Retourne

response

array of Response_countries_get_default

Récupérer les informations de paiement

ID de l’opération :

RetrievePaymentInformation

Le point de terminaison de paiement fournit un accès en lecture aux bons de paiement (comptabilité ou ventes), y compris les factures et les notes de crédit.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de bon	voucherId	True	string	Spécifiez l’ID de bon.

Retourne

Nom	Chemin	Type	Description
Monnaie	currency	string
openAmount	openAmount	string
paymentItems	paymentItems	array of object
montant	paymentItems.amount	float
Monnaie	paymentItems.currency	string
paymentItemType	paymentItems.paymentItemType	string
publicationDate	paymentItems.postingDate	date-time
paymentStatus	paymentStatus	string
voucherStatus	voucherStatus	string
voucherType	voucherType	string

Récupérer les informations de profil

ID de l’opération :

RetrieveProfileInformation

L’exemple suivant montre comment récupérer vos informations de profil de base. Il est nécessaire de remplacer l’espace réservé {accessToken} avant d’envoyer la requête.

Retourne

Corps

Response_profile_get

Récupérer tous les abonnements aux événements

ID de l’opération :

RetrieveAllEventSubscriptions

Récupérer tous les abonnements aux événements

Retourne

Corps

Response_event-subscriptions_get

Récupérer tous les contacts

ID de l’opération :

RetrieveAllContacts

Récupérer tous les contacts

Paramètres

Nom	Clé	Obligatoire	Type	Description
Number	number		integer	Spécifiez le nombre.
Messagerie électronique	email		string	Spécifiez l’e-mail.
Nom	name		string	Spécifiez le nom.
Fournisseur	vendor		boolean	Spécifiez le fournisseur.
Client	customer		boolean	Spécifiez le client.
Page	page		integer	Spécifiez la page.
Taille	size		integer	Spécifiez la taille.
Trier	sort		string	Spécifiez le tri.

Retourne

Corps

Response_contacts_get

Récupérer tous les modèles périodiques

ID de l’opération :

RetrieveAllRecurringTemplates

Récupérez une collection de modèles périodiques. Le résultat retourne uniquement une partie des données les plus pertinentes qui sont le contact référencé (id et nom uniquement), le prix total, les conditions de paiement et les paramètres de modèles récurrents complets. Toutefois, le nommage des objets et des propriétés est le même.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Page	page		integer	Spécifiez la page.
Taille	size		integer	Spécifiez la taille.
Trier	sort		string	Spécifiez le tri.

Retourne

Corps

Response_recurring-templates_get

Récupérer un abonnement aux événements

ID de l’opération :

RetrieveAEventSubscription

Récupérer un abonnement aux événements

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’abonnement	subscriptionId	True	string	Spécifiez l’ID d’abonnement.

Retourne

Corps

EventSubscriptionResponse

Récupérer un article

ID de l’opération :

RetrieveAnArticle

Retourne l’article avec la valeur d’ID {id}.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Nom	Chemin	Type	Description
articleNumber	articleNumber	string
gtin	gtin	string
pièce d'identité	id	string
Note	note	string
grossPrice	price.grossPrice	float
leadingPrice	price.leadingPrice	string
netPrice	price.netPrice	float
taxRate	price.taxRate	float
title	title	string
type	type	string
unitName	unitName	string
version	version	integer

Récupérer un bon

ID de l’opération :

RetrieveVoucher

Répertorier les bons de vente (par exemple, les factures, les billets de crédit)

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Nom	Chemin	Type	Description
date de création	createdDate	date-time
dueDate	dueDate	date-time
Fichiers	files	array of string
pièce d'identité	id	uuid
organizationId	organizationId	uuid
remarque	remark	string
shippingDate	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
type	type	string
updatedDate	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
version	version	integer
voucherDate	voucherDate	date-time
voucherItems	voucherItems	array of object
montant	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
couponNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Récupérer un contact

ID de l’opération :

RetrieveContact

Récupérer un contact par ID

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Nom	Chemin	Type	Description
Archivés	archived	boolean
pièce d'identité	id	string
organizationId	organizationId	string
firstName	person.firstName	string
lastName	person.lastName	string
salutation	person.salutation	string
nombre	roles.customer.number	integer
version	version	integer

Récupérer un devis

ID de l’opération :

RetrieveQuotation

Retourne les guillemets avec la valeur d’ID {id}. Afficher un document de guillemets (PDF)

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Nom	Chemin	Type	Description
city	address.city	string
contactId	address.contactId	uuid
countryCode	address.countryCode	string
nom	address.name	string
street	address.street	string
fichier ZIP	address.zip	string
Archivés	archived	boolean
date de création	createdDate	date-time
date d'expiration	expirationDate	date-time
documentFileId	files.documentFileId	uuid
pièce d'identité	id	uuid
introduction	introduction	string
language	language	string
lineItems	lineItems	array of object
alternatif	lineItems.alternative	boolean
discountPercentage	lineItems.discountPercentage	number
pièce d'identité	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
nom	lineItems.name	string
optionnel	lineItems.optional	boolean
quantité	lineItems.quantity	number
Sous-éléments	lineItems.subItems	array of object
alternatif	lineItems.subItems.alternative	boolean
discountPercentage	lineItems.subItems.discountPercentage	number
pièce d'identité	lineItems.subItems.id	uuid
lineItemAmount	lineItems.subItems.lineItemAmount	number
nom	lineItems.subItems.name	string
optionnel	lineItems.subItems.optional	boolean
quantité	lineItems.subItems.quantity	number
type	lineItems.subItems.type	string
unitName	lineItems.subItems.unitName	string
Monnaie	lineItems.subItems.unitPrice.currency	string
grossAmount	lineItems.subItems.unitPrice.grossAmount	number
netAmount	lineItems.subItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.subItems.unitPrice.taxRatePercentage	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Monnaie	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
remarque	remark	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
Monnaie	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
couponNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Récupérer un dunning

ID de l’opération :

RetrieveDunning

Retourne le dunning avec la valeur d’ID {id}.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Dunningsid	dunningsid	True	string	Spécifiez le dunningsid.

Retourne

Nom	Chemin	Type	Description
city	address.city	string
countryCode	address.countryCode	string
nom	address.name	string
street	address.street	string
Supplément	address.supplement	string
fichier ZIP	address.zip	string
Archivés	archived	boolean
date de création	createdDate	date-time
pièce d'identité	id	uuid
introduction	introduction	string
language	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
nom	lineItems.name	string
quantité	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Monnaie	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
relatedVouchers	relatedVouchers	array of object
pièce d'identité	relatedVouchers.id	uuid
couponNumber	relatedVouchers.voucherNumber	string
voucherType	relatedVouchers.voucherType	string
remarque	remark	string
shippingDate	shippingConditions.shippingDate	date-time
shippingType	shippingConditions.shippingType	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
Monnaie	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherStatus	voucherStatus	string

Récupérer un modèle périodique

ID de l’opération :

RetrieveRecurringTemplate

Retourne le modèle périodique avec la valeur d’ID {id}.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Nom	Chemin	Type	Description
city	address.city	string
contactId	address.contactId	uuid
countryCode	address.countryCode	string
nom	address.name	string
street	address.street	string
fichier ZIP	address.zip	string
Archivés	archived	boolean
date de création	createdDate	date-time
pièce d'identité	id	uuid
introduction	introduction	string
language	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
nom	lineItems.name	string
quantité	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Monnaie	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
recurringTemplateSettings	recurringTemplateSettings	object
remarque	remark	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
Monnaie	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer

Récupérer une confirmation de commande

ID de l’opération :

RetrieveOrderConfirmation

Retourne la confirmation de la commande avec la valeur d’ID {id}.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Nom	Chemin	Type	Description
city	address.city	string
countryCode	address.countryCode	string
nom	address.name	string
street	address.street	string
Supplément	address.supplement	string
fichier ZIP	address.zip	string
Archivés	archived	boolean
date de création	createdDate	date-time
deliveryTerms	deliveryTerms	string
documentFileId	files.documentFileId	uuid
pièce d'identité	id	uuid
introduction	introduction	string
language	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
pièce d'identité	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
nom	lineItems.name	string
quantité	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Monnaie	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
remarque	remark	string
shippingDate	shippingConditions.shippingDate	date-time
shippingType	shippingConditions.shippingType	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
Monnaie	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
couponNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Récupérer une facture

ID de l’opération :

RetrieveInvoice

Retourne la facture avec la valeur d’ID {id}.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Nom	Chemin	Type	Description
city	address.city	string
countryCode	address.countryCode	string
nom	address.name	string
street	address.street	string
Supplément	address.supplement	string
fichier ZIP	address.zip	string
Archivés	archived	boolean
date de création	createdDate	date-time
pièce d'identité	id	uuid
introduction	introduction	string
language	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
pièce d'identité	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
nom	lineItems.name	string
quantité	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Monnaie	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
remarque	remark	string
shippingDate	shippingConditions.shippingDate	date-time
shippingType	shippingConditions.shippingType	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
Monnaie	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
couponNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Récupérer une facture de paiement vers le bas

ID de l’opération :

RetrieveDownPaymentInvoice

Retourne la facture de paiement inférieur avec la valeur d’ID {id}.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Nom	Chemin	Type	Description
city	address.city	string
countryCode	address.countryCode	string
nom	address.name	string
street	address.street	string
Supplément	address.supplement	string
fichier ZIP	address.zip	string
Archivés	archived	boolean
closingInvoiceId	closingInvoiceId	uuid
date de création	createdDate	date-time
dueDate	dueDate	date-time
documentFileId	files.documentFileId	uuid
pièce d'identité	id	uuid
introduction	introduction	string
language	language	string
lineItems	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
nom	lineItems.name	string
quantité	lineItems.quantity	number
type	lineItems.type	string
Monnaie	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
remarque	remark	string
shippingType	shippingConditions.shippingType	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
Monnaie	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
couponNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Récupérer une liste de catégories de publication

ID de l’opération :

RetrieveListPostingCategories

Ce point de terminaison fournit un accès en lecture à la liste des catégories de publications pour les bons (comptabilité) revenus ou dépenses pris en charge dans lexoffice.

Retourne

response

array of Response_posting-categories_get_items

Récupérer une note de crédit

ID de l’opération :

RetrieveCreditNote

Ce point de terminaison fournit un accès en lecture et en écriture aux notes de crédit, ainsi que la possibilité d’afficher le document au format PDF afin de le télécharger. Les notes de crédit peuvent être créées en tant que brouillon ou finalisées en mode ouvert.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Nom	Chemin	Type	Description
city	address.city	string
countryCode	address.countryCode	string
nom	address.name	string
street	address.street	string
Supplément	address.supplement	string
fichier ZIP	address.zip	string
Archivés	archived	boolean
date de création	createdDate	date-time
pièce d'identité	id	uuid
introduction	introduction	string
language	language	string
lineItems	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
nom	lineItems.name	string
quantité	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Monnaie	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
remarque	remark	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
Monnaie	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	float
totalNetAmount	totalPrice.totalNetAmount	float
totalTaxAmount	totalPrice.totalTaxAmount	float
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
couponNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Récupérer une note de remise

ID de l’opération :

RetrieveDeliveryNote

Retourne la note de remise avec la valeur d’ID {id}.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Retourne

Nom	Chemin	Type	Description
city	address.city	string
countryCode	address.countryCode	string
nom	address.name	string
street	address.street	string
Supplément	address.supplement	string
fichier ZIP	address.zip	string
Archivés	archived	boolean
date de création	createdDate	date-time
deliveryTerms	deliveryTerms	string
pièce d'identité	id	uuid
introduction	introduction	string
language	language	string
lineItems	lineItems	array of object
nom	lineItems.name	string
quantité	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Monnaie	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
remarque	remark	string
taxType	taxConditions.taxType	string
title	title	string
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
couponNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Supprimer un article

ID de l’opération :

DeleteAnArticle

Supprime l’article avec la valeur d’ID {id}. Retourne 204 en cas de réussite ou 404 si l’ID n’existe pas.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Id	id	True	string	Spécifiez l’ID.

Supprimer un Event-Subscription

ID de l’opération :

DeleteEventSubscription

Supprimer le webHook du déclencheur

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’abonnement	subscriptionId	True	string	Spécifiez l’ID d’abonnement.

Télécharger un fichier

ID de l’opération :

DownloadFile_Lexoffice

Utilisez ce point de terminaison pour télécharger des fichiers.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de fichier	fileId	True	string	Spécifiez l’ID de fichier.
Accepter	Accept		string	Spécifiez l’acceptation.

Retourne

response

file

Déclenche

Sélectionner votre déclencheur personnalisé

Inscrire un nouveau déclencheur pour le point de terminaison de contacts

Sélectionner votre déclencheur personnalisé

ID de l’opération :

EventSubscription_Lexoffice

Inscrire un nouveau déclencheur pour le point de terminaison de contacts

Paramètres

Nom	Clé	Obligatoire	Type	Description
Type d'événement	eventType	True	string	eventType

Retourne

Nom	Chemin	Type	Description
eventDate	eventDate	string	eventDate
eventType	eventType	string	eventType
organizationId	organizationId	string	organizationId
resourceId	resourceId	string	resourceId

Définitions

EventSubscriptionResponse

Nom	Chemin	Type	Description
subscriptionId	subscriptionId	string
eventType	eventType	string
organizationId	organizationId	string
date de création	createdDate	date-time
callbackUrl	callbackUrl	string

Response_articles_get

Nom	Chemin	Type	Description
contenu	content	array of object	contenu
articleNumber	content.articleNumber	string	articleNumber
gtin	content.gtin	string	gtin
pièce d'identité	content.id	string	pièce d'identité
Note	content.note	string	Note
grossPrice	content.price.grossPrice	float	grossPrice
leadingPrice	content.price.leadingPrice	string	leadingPrice
netPrice	content.price.netPrice	float	netPrice
taxRate	content.price.taxRate	float	taxRate
title	content.title	string	title
type	content.type	string	type
unitName	content.unitName	string	unitName
version	content.version	integer	version
premier	first	boolean	premier
last	last	boolean	last
nombre	number	integer	nombre
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
ascendant	sort.ascending	boolean	ascendant
direction	sort.direction	string	direction
ignoreCase	sort.ignoreCase	boolean	ignoreCase
NullHandling	sort.nullHandling	string	NullHandling
property	sort.property	string	property
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_articles_id_get

Nom	Chemin	Type	Description
articleNumber	articleNumber	string	articleNumber
gtin	gtin	string	gtin
pièce d'identité	id	string	pièce d'identité
Note	note	string	Note
grossPrice	price.grossPrice	float	grossPrice
leadingPrice	price.leadingPrice	string	leadingPrice
netPrice	price.netPrice	float	netPrice
taxRate	price.taxRate	float	taxRate
title	title	string	title
type	type	string	type
unitName	unitName	string	unitName
version	version	integer	version

Response_articles_post

Nom	Chemin	Type	Description
date de création	createdDate	string	date de création
pièce d'identité	id	string	pièce d'identité
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_contacts_get

Nom	Chemin	Type	Description
contenu	content	array of object	contenu
Facturation	content.addresses.billing	array of object	Facturation
city	content.addresses.billing.city	string	city
countryCode	content.addresses.billing.countryCode	string	countryCode
street	content.addresses.billing.street	string	street
Supplément	content.addresses.billing.supplement	string	Supplément
fichier ZIP	content.addresses.billing.zip	string	fichier ZIP
livraison	content.addresses.shipping	array of object	livraison
city	content.addresses.shipping.city	string	city
countryCode	content.addresses.shipping.countryCode	string	countryCode
street	content.addresses.shipping.street	string	street
Supplément	content.addresses.shipping.supplement	string	Supplément
fichier ZIP	content.addresses.shipping.zip	string	fichier ZIP
Archivés	content.archived	boolean	Archivés
allowTaxFreeInvoices	content.company.allowTaxFreeInvoices	boolean	allowTaxFreeInvoices
contactPersons	content.company.contactPersons	array of object	contactPersons
adresse e-mail	content.company.contactPersons.emailAddress	string	adresse e-mail
firstName	content.company.contactPersons.firstName	string	firstName
lastName	content.company.contactPersons.lastName	string	lastName
primaire	content.company.contactPersons.primary	boolean	primaire
salutation	content.company.contactPersons.salutation	string	salutation
nom	content.company.name	string	nom
Numéro d’impôt	content.company.taxNumber	string	Numéro d’impôt
vatRegistrationId	content.company.vatRegistrationId	string	vatRegistrationId
Entreprise	content.emailAddresses.business	array of string	Entreprise
Office	content.emailAddresses.office	array of string	Office
other	content.emailAddresses.other	array of string	other
pièce d'identité	content.id	string	pièce d'identité
Note	content.note	string	Note
organizationId	content.organizationId	string	organizationId
Entreprise	content.phoneNumbers.business	array of string	Entreprise
fax	content.phoneNumbers.fax	array of string	fax
Office	content.phoneNumbers.office	array of string	Office
other	content.phoneNumbers.other	array of string	other
nombre	content.roles.customer.number	integer	nombre
nombre	content.roles.vendor.number	integer	nombre
version	content.version	integer	version
premier	first	boolean	premier
last	last	boolean	last
nombre	number	integer	nombre
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
ascendant	sort.ascending	boolean	ascendant
direction	sort.direction	string	direction
ignoreCase	sort.ignoreCase	boolean	ignoreCase
NullHandling	sort.nullHandling	string	NullHandling
property	sort.property	string	property
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_contacts_post

Nom	Chemin	Type	Description
date de création	createdDate	string	date de création
pièce d'identité	id	string	pièce d'identité
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_countries_get_default

Nom	Chemin	Type	Description
countryCode	countryCode	string	countryCode
countryNameDE	countryNameDE	string	countryNameDE
countryNameEN	countryNameEN	string	countryNameEN
taxClassification	taxClassification	string	taxClassification

Response_credit-notes_post

Nom	Chemin	Type	Description
date de création	createdDate	string	date de création
pièce d'identité	id	string	pièce d'identité
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_delivery-notes_post

Nom	Chemin	Type	Description
date de création	createdDate	string	date de création
pièce d'identité	id	string	pièce d'identité
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_dunnings_post

Nom	Chemin	Type	Description
date de création	createdDate	string	date de création
pièce d'identité	id	string	pièce d'identité
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_event-subscriptions_get

Nom	Chemin	Type	Description
contenu	content	array of object	contenu
callbackUrl	content.callbackUrl	string	callbackUrl
date de création	content.createdDate	string	date de création
eventType	content.eventType	string	eventType
organizationId	content.organizationId	string	organizationId
subscriptionId	content.subscriptionId	string	subscriptionId

Response_files_post

Nom	Chemin	Type	Description
pièce d'identité	id	string	pièce d'identité

Response_invoices_post

Nom	Chemin	Type	Description
date de création	createdDate	string	date de création
pièce d'identité	id	string	pièce d'identité
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_order-confirmations_post

Nom	Chemin	Type	Description
date de création	createdDate	string	date de création
pièce d'identité	id	string	pièce d'identité
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_payment-conditions_get_items

Nom	Chemin	Type	Description
pièce d'identité	id	string	pièce d'identité
organizationDefault	organizationDefault	boolean	organizationDefault
discountPercentage	paymentDiscountConditions.discountPercentage	integer	discountPercentage
discountRange	paymentDiscountConditions.discountRange	integer	discountRange
paymentTermDuration	paymentTermDuration	integer	paymentTermDuration
paymentTermLabelTemplate	paymentTermLabelTemplate	string	paymentTermLabelTemplate

Response_posting-categories_get_items

Nom	Chemin	Type	Description
contactRequired	contactRequired	boolean	contactRequired
groupName	groupName	string	groupName
pièce d'identité	id	string	pièce d'identité
nom	name	string	nom
splitAllowed	splitAllowed	boolean	splitAllowed
type	type	string	type

Response_profile_get

Nom	Chemin	Type	Description
businessFeatures	businessFeatures	array of string	businessFeatures
companyName	companyName	string	companyName
connectionId	connectionId	string	connectionId
date	created.date	string	date
userEmail	created.userEmail	string	userEmail
userId	created.userId	string	userId
nom d’utilisateur	created.userName	string	nom d’utilisateur
features	features	array of string	features
organizationId	organizationId	string	organizationId
smallBusiness	smallBusiness	boolean	smallBusiness
subscriptionStatus	subscriptionStatus	string	subscriptionStatus
taxType	taxType	string	taxType

Response_quotations_post

Nom	Chemin	Type	Description
date de création	createdDate	string	date de création
pièce d'identité	id	string	pièce d'identité
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_recurring-templates_get

Nom	Chemin	Type	Description
contenu	content	array of object	contenu
contactId	content.address.contactId	string	contactId
nom	content.address.name	string	nom
date de création	content.createdDate	string	date de création
pièce d'identité	content.id	string	pièce d'identité
organizationId	content.organizationId	string	organizationId
discountPercentage	content.paymentConditions.paymentDiscountConditions.discountPercentage	integer	discountPercentage
discountRange	content.paymentConditions.paymentDiscountConditions.discountRange	integer	discountRange
paymentTermDuration	content.paymentConditions.paymentTermDuration	integer	paymentTermDuration
paymentTermLabel	content.paymentConditions.paymentTermLabel	string	paymentTermLabel
paymentTermLabelTemplate	content.paymentConditions.paymentTermLabelTemplate	string	paymentTermLabelTemplate
date de fin	content.recurringTemplateSettings.endDate	string	date de fin
executionInterval	content.recurringTemplateSettings.executionInterval	string	executionInterval
executionStatus	content.recurringTemplateSettings.executionStatus	string	executionStatus
Finaliser	content.recurringTemplateSettings.finalize	boolean	Finaliser
pièce d'identité	content.recurringTemplateSettings.id	string	pièce d'identité
lastExecutionFailed	content.recurringTemplateSettings.lastExecutionFailed	boolean	lastExecutionFailed
nextExecutionDate	content.recurringTemplateSettings.nextExecutionDate	string	nextExecutionDate
shippingType	content.recurringTemplateSettings.shippingType	string	shippingType
date de début	content.recurringTemplateSettings.startDate	string	date de début
title	content.title	string	title
Monnaie	content.totalPrice.currency	string	Monnaie
totalGrossAmount	content.totalPrice.totalGrossAmount	integer	totalGrossAmount
totalNetAmount	content.totalPrice.totalNetAmount	float	totalNetAmount
updatedDate	content.updatedDate	string	updatedDate
premier	first	boolean	premier
last	last	boolean	last
nombre	number	integer	nombre
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
ascendant	sort.ascending	boolean	ascendant
direction	sort.direction	string	direction
ignoreCase	sort.ignoreCase	boolean	ignoreCase
NullHandling	sort.nullHandling	string	NullHandling
property	sort.property	string	property
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_voucherlist_get

Nom	Chemin	Type	Description
contenu	content	array of object	contenu
Archivés	content.archived	boolean	Archivés
contactId	content.contactId	string	contactId
contactName	content.contactName	string	contactName
date de création	content.createdDate	string	date de création
Monnaie	content.currency	string	Monnaie
dueDate	content.dueDate	string	dueDate
pièce d'identité	content.id	string	pièce d'identité
openAmount	content.openAmount	float	openAmount
totalAmount	content.totalAmount	float	totalAmount
updatedDate	content.updatedDate	string	updatedDate
voucherDate	content.voucherDate	string	voucherDate
couponNumber	content.voucherNumber	string	couponNumber
voucherStatus	content.voucherStatus	string	voucherStatus
voucherType	content.voucherType	string	voucherType
premier	first	boolean	premier
last	last	boolean	last
nombre	number	integer	nombre
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
ascendant	sort.ascending	boolean	ascendant
direction	sort.direction	string	direction
ignoreCase	sort.ignoreCase	boolean	ignoreCase
NullHandling	sort.nullHandling	string	NullHandling
property	sort.property	string	property
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_vouchers_post

Nom	Chemin	Type	Description
date de création	createdDate	string	date de création
pièce d'identité	id	string	pièce d'identité
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_contacts_id_put

Nom	Chemin	Type	Description
Archivés	archived	boolean
pièce d'identité	id	uuid
organizationId	organizationId	uuid
firstName	person.firstName	string
lastName	person.lastName	string
salutation	person.salutation	string
nombre	roles.customer.number	integer
version	version	integer

Response_vouchers_id_put

Nom	Chemin	Type	Description
date de création	createdDate	date-time
dueDate	dueDate	date-time
Fichiers	files	array of object
items	files	object
pièce d'identité	id	uuid
organizationId	organizationId	uuid
remarque	remark	string
shippingDate	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
type	type	string
updatedDate	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
version	version	integer
voucherDate	voucherDate	date-time
voucherItems	voucherItems	array of object
montant	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
couponNumber	voucherNumber	string
voucherStatus	voucherStatus	string

file

Il s’agit du type de données de base « fichier ».