Lexoffice (onafhankelijke uitgever) (preview)

De Lexware-API biedt programmatische toegang tot kernfuncties van Lexware, zoals artikelen, contactpersonen, facturen, orders en bestandsbeheer. Deze Onafhankelijke Publisher-connector maakt veilige integratie mogelijk met de REST API van Lexware, zodat gebruikers zakelijke gegevens kunnen maken en ophalen, processen kunnen automatiseren en Lexware-resources kunnen verbinden met Power Platform-toepassingen. De connector maakt gebruik van OAuth 2.0-autorisatiecodestroom voor veilige verificatie en API-richtlijnen.

Deze connector is beschikbaar in de volgende producten en regio's:

Dienst	Class	Regions
Copilot Studio	Premium	Alle Power Automate-regio's , met uitzondering van het volgende:      - Amerikaanse overheid (GCC)      - Amerikaanse overheid (GCC High)      - China Cloud beheerd door 21Vianet      - Us Department of Defense (DoD)
Logic-apps	Standaard	Alle Logic Apps-regio's , met uitzondering van het volgende:      - Azure Government-regio's      - Azure China-regio's      - Us Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps-regio's , met uitzondering van het volgende:      - Amerikaanse overheid (GCC)      - Amerikaanse overheid (GCC High)      - China Cloud beheerd door 21Vianet      - Us Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate-regio's , met uitzondering van het volgende:      - Amerikaanse overheid (GCC)      - Amerikaanse overheid (GCC High)      - China Cloud beheerd door 21Vianet      - Us Department of Defense (DoD)

Contactpersoon
Naam	Ondersteuning voor LowCode-onderzoekers
URL	https://lowcode-investigator.com/
E-mailen	kontakt@lowcodeinvestigator.com

Connectormetagegevens
Uitgever	LowCodeInvestigator
Webpagina	https://office.lexware.de/
Privacybeleid	https://office.lexware.de/datenschutz/
Categorieën	Bedrijfsbeheer; Financieren

Lexware-API-connector (onafhankelijke uitgever)

De Lexware-API is een RESTful-interface waarmee ontwikkelaars Lexware-bedrijfsfuncties, zoals contactpersonen, facturen, artikelen en bestanden, kunnen integreren in hun eigen toepassingen. Deze connector maakt directe interactie met deze resources mogelijk via beveiligde, geverifieerde API-aanvragen.

Uitgever: Onafhankelijke uitgever

Vereiste voorwaarden

• Een geregistreerd Lexware-account en een juiste licentie
• Een geldige API-sleutel (toegangstoken) verkregen via de Lexware Developer Portal
• OAuth 2.0-autorisatiecodestroom is vereist voor verificatie

Ondersteunde bewerkingen

Deze connector ondersteunt de volgende Lexware-API-eindpunten:

• Artikelen: Artikelen maken, ophalen, bijwerken, verwijderen en filteren
• Contactpersonen: Klant- en leveranciergegevens beheren
• Facturen: Factuurgegevens maken en ophalen, inclusief het weergeven van PDF-bestanden
• Creditnota's, leveringsbonnen, orders, offertes en vouchers
• Landen, betalingsvoorwaarden, afdrukindelingen en profielen
• Gebeurtenisabonnementen en -bestanden
• Volledige lijst die wordt beschreven op: Lexware API Docs

Referenties verkrijgen

Als u de Lexware-API wilt aanroepen, hebt u een API-sleutel nodig:

1. Meld u aan bij uw Lexware Office-account.
2. Ga naar Extensies → Weitere-apps → openbare API of open
   Lexware Developer Portal rechtstreeks.
3. Maak een nieuwe API-sleutel met de gewenste machtigingen.
4. Kopieer de gegenereerde API-sleutel. Deze waarde wordt gebruikt zoals accessToken in de connector.

API-gateway

Gebruik de nieuwe Lexware-API-gateway:

https://api.lexware.io

Frequentielimieten

• Maximaal 2 aanvragen per seconde
• Aanvragen die deze limiet overschrijden, ontvangen HTTP 429 Too Many Requests
• Aanbevolen: Tokenbucket-algoritme of exponentieel uitstel gebruiken

Authenticatie

De Lexware-API maakt gebruik van OAuth 2.0-autorisatiecodestroom. Neem het token op in de Authorization: Bearer {accessToken} header van elke aanvraag.

Voorbeeldgebruik

Een artikel maken:

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
    }
  }'

Bekende problemen en beperkingen

• Maximaal 2 aanvragen per seconde
• Voor sommige eindpunten zijn extra machtigingen of rollen vereist

API-documentatie

Volledige API-verwijzing is beschikbaar op:
https://developers.lexware.io/docs/

Een verbinding maken

De connector ondersteunt de volgende verificatietypen:

standaard	Parameters voor het maken van verbinding.	Alle regio's	Niet deelbaar

Verstek

Van toepassing: Alle regio's

Parameters voor het maken van verbinding.

Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.

Naam	Typologie	Description	Verplicht
API-sleutel	beveiligde string	De API-sleutel voor deze API	Klopt

Beperkingslimieten

Name	Aanroepen	Verlengingsperiode
API-aanroepen per verbinding	100	60 seconden

Acties

Alle contactpersonen ophalen	Alle contactpersonen ophalen
Alle gebeurtenisabonnementen ophalen	Alle gebeurtenisabonnementen ophalen
Alle terugkerende sjablonen ophalen	Haal een verzameling terugkerende sjablonen op. Het resultaat retourneert slechts een deel van de meest relevante gegevens waarnaar wordt verwezen contact (alleen id en naam), totale prijs, betalingsvoorwaarden en de volledige instellingen voor terugkerende sjablonen. De naamgeving van objecten en eigenschappen is echter hetzelfde.
Artikelen filteren	Retourneert de artikelen die voldoen aan de criteria die zijn opgegeven door filters filter_1 om te filter_n met behulp van een pagingmechanisme. Als er meer dan één filter is opgegeven, is de logische connector AND. Filters die niet zijn ingesteld, worden genegeerd. Zie Paging van resources om het maximale paginaformaat voor dit eindpunt te controleren.
Betalingsgegevens ophalen	Het betalingseindpunt biedt leestoegang tot de betalingsstatus van (boekhouding of verkoop) vouchers, inclusief facturen en creditnota's.
Een artikel bijwerken	Werk een bestaand artikel bij met id {id} met de gegevens in de nettolading als JSON. Retourneert een actieresultaat bij geslaagde bewerking.
Een artikel maken	De inhoud van het artikel wordt verwacht in de hoofdtekst van de aanvraag als een toepassing/json.
Een artikel ophalen	Retourneert het artikel met de id-waarde {id}.
Een artikel verwijderen	Hiermee verwijdert u het artikel met de id-waarde {id}. Retourneert 204 bij succes of 404 als de id niet bestaat.
Een bestand downloaden	Gebruik dit eindpunt om bestanden te downloaden.
Een bestand uploaden	Gebruik dit eindpunt om bestanden, zoals vouchers of facturen, te uploaden.
Een bestand uploaden naar een voucher	Upload en wijs bestanden (pdf of afbeelding) toe aan de voucher die is geïdentificeerd door {id}.
Een bezorgingsbrief ophalen	Retourneert de leveringsbrief met id-waarde {id}.
Een bezorgingsnotitie maken	De gemaakte leveringsbon wordt weergegeven in de hoofdvoucherlijst in lexoffice. Bezorgingsnotities die via de API worden verzonden, worden alleen gemaakt in de conceptmodus.
Een contactpersoon bijwerken	Een contactpersoon bijwerken
Een contactpersoon maken	Een nieuwe contactpersoon maken
Een contactpersoon ophalen	Een contactpersoon ophalen op id
Een document met een bezorgingsnotitie weergeven (PDF)	Dit eindpunt biedt lees- en schrijftoegang tot bezorgingsnotities en ook de mogelijkheid om het document weer te geven als PDF-bestand om het te downloaden. Bezorgingsnotities worden altijd gemaakt in de conceptmodus en hoeven niet te worden voltooid.
Een document met een creditnota weergeven (PDF)	Als u het PDF-bestand van een creditnota-document wilt downloaden, hebt u de documentFileId nodig. Deze id wordt meestal geretourneerd door de resource van de creditnota. Nieuw gemaakte tegoednotities in de status worden echter geopend via de API, moeten de weergave van het PDF-documentbestand afzonderlijk activeren. Dit kan worden gedaan met dit eindpunt.
Een dunning maken	De gemaakte dunning wordt niet weergegeven in de hoofdvoucherlijst in lexoffice, maar wordt gekoppeld aan een factuur en zal daar zichtbaar zijn. Gebruik onze deeplink-functie om uw klanten toegang te geven tot de gemaakte dunning.
Een dunning ophalen	Retourneert de dunning met de id-waarde {id}.
Een dunningsdocument weergeven (PDF)	Als u het PDF-bestand van een dunning-document wilt downloaden, hebt u de documentFileId nodig. Deze id wordt meestal geretourneerd door de dunning-resource. Nieuwe dunnings via de API moeten echter afzonderlijk de rendering van het PDF-documentbestand activeren. Dit kan worden gedaan met dit eindpunt.
Een Event-Subscription verwijderen	Triggerwebhook verwijderen
Een factuur maken	Facturen die via de API worden verzonden, worden standaard gemaakt in de conceptmodus. Als u een voltooide factuur met de status wilt maken, moet de optionele queryparameter worden ingesteld. De status van een factuur kan niet worden gewijzigd via de API.
Een factuur ophalen	Retourneert de factuur met id-waarde {id}.
Een factuur voor een aanbetaling ophalen	Retourneert de aanbetalingsfactuur met id-waarde {id}.
Een factuurdocument weergeven (PDF)	Als u het PDF-bestand van een factuurdocument wilt downloaden, hebt u de documentFileId nodig. Deze id wordt meestal geretourneerd door de factuurresource. Nieuwe facturen in de status worden echter geopend via de API, moeten de weergave van het PDF-documentbestand afzonderlijk activeren. Dit kan worden gedaan met dit eindpunt.
Een gebeurtenisabonnement ophalen	Een gebeurtenisabonnement ophalen
Een lijst met boekingscategorieën ophalen	Dit eindpunt biedt leestoegang tot de lijst met boekingscategorieën voor de omzet of onkosten van de vouchers (boekhouden) die worden ondersteund in lexoffice.
Een offerte maken	Offertes die via de API worden verzonden, worden standaard gemaakt in de conceptmodus. Als u een definitieve aanhaling met de status wilt maken, moet de optionele queryparameter worden ingesteld. De status van een offerte kan niet worden gewijzigd via de API.
Een offerte ophalen	Retourneert de aanhaling met de id-waarde {id}. Een offertedocument weergeven (PDF)
Een offertedocument weergeven (PDF)	Als u het PDF-bestand van een offertedocument wilt downloaden, hebt u de documentFileId nodig. Deze id wordt meestal geretourneerd door de offerteresource. Nieuwe aanhalingstekens in de status worden echter geopend via de API, moeten de weergave van het PDF-documentbestand afzonderlijk activeren. Dit kan worden gedaan met dit eindpunt.
Een orderbevestiging maken	Dit eindpunt biedt lees- en schrijftoegang tot orderbevestigingen en ook de mogelijkheid om het document als PDF weer te geven om het te downloaden. Orderbevestigingen worden altijd gemaakt in de conceptmodus en hoeven niet te worden voltooid.
Een orderbevestiging ophalen	Retourneert de orderbevestiging met de id-waarde {id}.
Een orderbevestigingsdocument weergeven (PDF)	Als u het PDF-bestand van een orderbevestigingsdocument wilt downloaden, hebt u de documentFileId nodig. Deze id wordt meestal geretourneerd door de orderbevestigingsresource. Nieuwe orderbevestigingen via de API moeten de weergave van het PDF-documentbestand echter afzonderlijk activeren. Dit kan worden gedaan met dit eindpunt.
Een tegoednotitie maken	Creditnota's die via de API worden verzonden, worden per standaard conceptmodus gemaakt. Als u een voltooide tegoednotitie met de status wilt maken, moet de optionele queryparameter worden ingesteld. De status van een creditnota kan niet worden gewijzigd via de API
Een tegoednotitie ophalen	Dit eindpunt biedt lees- en schrijftoegang tot creditnota's en ook de mogelijkheid om het document weer te geven als pdf-bestand om het te downloaden. Creditnota's kunnen worden gemaakt als concept of voltooid in de geopende modus.
Een terugkerende sjabloon ophalen	Retourneert de terugkerende sjabloon met id-waarde {id}.
Een voucher maken	Vouchers maken (beperkt tot verkoopvouchers)
Een voucher ophalen	Verkoopvouchers vermelden (bijvoorbeeld facturen, creditnotes)
Lijst met betalingsvoorwaarden ophalen	In het volgende voorbeeld ziet u hoe u een lijst met momenteel geconfigureerde betalingsvoorwaarden ophaalt. U moet de tijdelijke aanduiding {accessToken} vervangen voordat u de aanvraag verzendt.
Lijst met landen ophalen	Lijst met landen die bekend zijn bij lexoffice.
Profielgegevens ophalen	In het volgende voorbeeld ziet u hoe u uw basisprofielgegevens ophaalt. U moet de tijdelijke aanduiding {accessToken} vervangen voordat u de aanvraag verzendt.
Voucher bijwerken	Een voucher bijwerken
Voucherlijst ophalen en filteren	Ontvang voucherlistbonnen (boekhouding) (bijvoorbeeld salesinvoices, salescreditnotes), facturen (inclusief aanbetalingsfacturen), creditnota's, orderbevestigingen, offertes en leveringsbonnen.

Alle contactpersonen ophalen

Bewerkings-id:

RetrieveAllContacts

Alle contactpersonen ophalen

Parameters

Name	Sleutel	Vereist	Type	Description
Number	number		integer	Geef het getal op.
E-mailen	email		string	Geef het e-mailbericht op.
Naam	name		string	Geef de naam op.
Leverancier	vendor		boolean	Geef de leverancier op.
Customer	customer		boolean	Geef de klant op.
Page	page		integer	Geef de pagina op.
Grootte	size		integer	Geef de grootte op.
Sorteren	sort		string	Geef de sortering op.

Retouren

Body

Response_contacts_get

Alle gebeurtenisabonnementen ophalen

Bewerkings-id:

RetrieveAllEventSubscriptions

Alle gebeurtenisabonnementen ophalen

Retouren

Body

Response_event-subscriptions_get

Alle terugkerende sjablonen ophalen

Bewerkings-id:

RetrieveAllRecurringTemplates

Haal een verzameling terugkerende sjablonen op. Het resultaat retourneert slechts een deel van de meest relevante gegevens waarnaar wordt verwezen contact (alleen id en naam), totale prijs, betalingsvoorwaarden en de volledige instellingen voor terugkerende sjablonen. De naamgeving van objecten en eigenschappen is echter hetzelfde.

Parameters

Name	Sleutel	Vereist	Type	Description
Page	page		integer	Geef de pagina op.
Grootte	size		integer	Geef de grootte op.
Sorteren	sort		string	Geef de sortering op.

Retouren

Body

Response_recurring-templates_get

Artikelen filteren

Bewerkings-id:

FilteringArticles

Retourneert de artikelen die voldoen aan de criteria die zijn opgegeven door filters filter_1 om te filter_n met behulp van een pagingmechanisme. Als er meer dan één filter is opgegeven, is de logische connector AND. Filters die niet zijn ingesteld, worden genegeerd. Zie Paging van resources om het maximale paginaformaat voor dit eindpunt te controleren.

Parameters

Name	Sleutel	Vereist	Type	Description
Artikelnummer	articleNumber		string	Geef het artikelnummer op.
Gtin	gtin		string	Geef de gtin op.
Typologie	type		string	Geef het type op.
Page	page		integer	Geef de pagina op.
Grootte	size		integer	Geef de grootte op.
Sorteren	sort		string	Geef de sortering op.

Retouren

Body

Response_articles_get

Betalingsgegevens ophalen

Bewerkings-id:

RetrievePaymentInformation

Het betalingseindpunt biedt leestoegang tot de betalingsstatus van (boekhouding of verkoop) vouchers, inclusief facturen en creditnota's.

Parameters

Name	Sleutel	Vereist	Type	Description
Voucher-id	voucherId	True	string	Geef de voucher-id op.

Retouren

Name	Pad	Type	Description
currency	currency	string
openAmount	openAmount	string
paymentItems	paymentItems	array of object
aantal	paymentItems.amount	float
currency	paymentItems.currency	string
paymentItemType	paymentItems.paymentItemType	string
postingDate	paymentItems.postingDate	date-time
betalingsstatus	paymentStatus	string
voucherStatus	voucherStatus	string
voucherType	voucherType	string

Een artikel bijwerken

Bewerkings-id:

UpdateAnArticle

Werk een bestaand artikel bij met id {id} met de gegevens in de nettolading als JSON. Retourneert een actieresultaat bij geslaagde bewerking.

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.
articleNumber	articleNumber		string	articleNumber
gtin	gtin		string	gtin
notitie	note		string	notitie
brutoprijs	grossPrice	True	float	brutoprijs
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

Retouren

Body

Response_articles_id_get

Een artikel maken

Bewerkings-id:

CreateArticle

De inhoud van het artikel wordt verwacht in de hoofdtekst van de aanvraag als een toepassing/json.

Parameters

Name	Sleutel	Vereist	Type	Description
articleNumber	articleNumber		string	articleNumber
brutoprijs	grossPrice		float	brutoprijs
leadingPrice	leadingPrice		string	leadingPrice
netPrice	netPrice		float	netPrice
taxRate	taxRate		float	taxRate
title	title		string	title
type	type		string	type
unitName	unitName		string	unitName

Retouren

Body

Response_articles_post

Een artikel ophalen

Bewerkings-id:

RetrieveAnArticle

Retourneert het artikel met de id-waarde {id}.

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Name	Pad	Type	Description
articleNumber	articleNumber	string
gtin	gtin	string
identiteitskaart	id	string
notitie	note	string
brutoprijs	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

Een artikel verwijderen

Bewerkings-id:

DeleteAnArticle

Hiermee verwijdert u het artikel met de id-waarde {id}. Retourneert 204 bij succes of 404 als de id niet bestaat.

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Een bestand downloaden

Bewerkings-id:

DownloadFile_Lexoffice

Gebruik dit eindpunt om bestanden te downloaden.

Parameters

Name	Sleutel	Vereist	Type	Description
Bestands-id	fileId	True	string	Geef de bestands-id op.
Accepteren	Accept		string	Geef de accept op.

Retouren

response

file

Een bestand uploaden

Bewerkings-id:

UploadFile_Lexoffice

Gebruik dit eindpunt om bestanden, zoals vouchers of facturen, te uploaden.

Parameters

Name	Sleutel	Vereist	Type	Description
Bestand	file	True	file	Het bestand dat moet worden geüpload.
Typologie	type	True	string	Beschrijving van bestandsinhoud.

Retouren

Body

Response_files_post

Een bestand uploaden naar een voucher

Bewerkings-id:

UploadFileVoucher_Lexoffice

Upload en wijs bestanden (pdf of afbeelding) toe aan de voucher die is geïdentificeerd door {id}.

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.
Bestand	file	True	file	Het bestand dat moet worden geüpload.

Een bezorgingsbrief ophalen

Bewerkings-id:

RetrieveDeliveryNote

Retourneert de leveringsbrief met id-waarde {id}.

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Name	Pad	Type	Description
city	address.city	string
landCode	address.countryCode	string
naam	address.name	string
straat	address.street	string
Supplement	address.supplement	string
ZIP-bestand	address.zip	string
Gearchiveerde	archived	boolean
aanmaakdatum	createdDate	date-time
deliveryTerms	deliveryTerms	string
identiteitskaart	id	uuid
Introductie	introduction	string
language	language	string
lineItems	lineItems	array of object
naam	lineItems.name	string
hoeveelheid	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organisatie-ID	organizationId	uuid
opmerking	remark	string
taxType	taxConditions.taxType	string
title	title	string
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Een bezorgingsnotitie maken

Bewerkings-id:

CreateDeliveryNote

De gemaakte leveringsbon wordt weergegeven in de hoofdvoucherlijst in lexoffice. Bezorgingsnotities die via de API worden verzonden, worden alleen gemaakt in de conceptmodus.

Parameters

Name	Sleutel	Vereist	Type	Description
Voorafgaande verkoopvoucher-id	precedingSalesVoucherId		string	Geef de voorgaande verkoopvoucher-id op.

Retouren

Body

Response_delivery-notes_post

Een contactpersoon bijwerken

Bewerkings-id:

UpdateContact

Een contactpersoon bijwerken

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Body

Response_contacts_id_put

Een contactpersoon maken

Bewerkings-id:

CreateContact

Een nieuwe contactpersoon maken

Retouren

Body

Response_contacts_post

Een contactpersoon ophalen

Bewerkings-id:

RetrieveContact

Een contactpersoon ophalen op id

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Name	Pad	Type	Description
Gearchiveerde	archived	boolean
identiteitskaart	id	string
organisatie-ID	organizationId	string
voornaam	person.firstName	string
achternaam	person.lastName	string
groet	person.salutation	string
nummer	roles.customer.number	integer
version	version	integer

Een document met een bezorgingsnotitie weergeven (PDF)

Bewerkings-id:

RenderDeliveryNoteDocument

Dit eindpunt biedt lees- en schrijftoegang tot bezorgingsnotities en ook de mogelijkheid om het document weer te geven als PDF-bestand om het te downloaden. Bezorgingsnotities worden altijd gemaakt in de conceptmodus en hoeven niet te worden voltooid.

Parameters

Name	Sleutel	Vereist	Type	Description
Delivery Noteid	DeliveryNoteid	True	string	Geef de leverings noteid op.

Retouren

Name	Pad	Type	Description
city	address.city	string
landCode	address.countryCode	string
naam	address.name	string
straat	address.street	string
Supplement	address.supplement	string
ZIP-bestand	address.zip	string
Gearchiveerde	archived	boolean
aanmaakdatum	createdDate	date-time
deliveryTerms	deliveryTerms	string
identiteitskaart	id	uuid
Introductie	introduction	string
language	language	string
lineItems	lineItems	array of object
naam	lineItems.name	string
hoeveelheid	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organisatie-ID	organizationId	uuid
opmerking	remark	string
taxType	taxConditions.taxType	string
title	title	string
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Een document met een creditnota weergeven (PDF)

Bewerkings-id:

RenderCreditNoteDocument

Als u het PDF-bestand van een creditnota-document wilt downloaden, hebt u de documentFileId nodig. Deze id wordt meestal geretourneerd door de resource van de creditnota. Nieuw gemaakte tegoednotities in de status worden echter geopend via de API, moeten de weergave van het PDF-documentbestand afzonderlijk activeren. Dit kan worden gedaan met dit eindpunt.

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Name	Pad	Type	Description
documentFileId	documentFileId	uuid

Een dunning maken

Bewerkings-id:

CreateDunning

De gemaakte dunning wordt niet weergegeven in de hoofdvoucherlijst in lexoffice, maar wordt gekoppeld aan een factuur en zal daar zichtbaar zijn. Gebruik onze deeplink-functie om uw klanten toegang te geven tot de gemaakte dunning.

Parameters

Name	Sleutel	Vereist	Type	Description
Voorafgaande verkoopvoucher-id	precedingSalesVoucherId		string	Geef de voorgaande verkoopvoucher-id op.

Retouren

Body

Response_dunnings_post

Een dunning ophalen

Bewerkings-id:

RetrieveDunning

Retourneert de dunning met de id-waarde {id}.

Parameters

Name	Sleutel	Vereist	Type	Description
Dunningsid	dunningsid	True	string	Geef de dunningsid op.

Retouren

Name	Pad	Type	Description
city	address.city	string
landCode	address.countryCode	string
naam	address.name	string
straat	address.street	string
Supplement	address.supplement	string
ZIP-bestand	address.zip	string
Gearchiveerde	archived	boolean
aanmaakdatum	createdDate	date-time
identiteitskaart	id	uuid
Introductie	introduction	string
language	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
naam	lineItems.name	string
hoeveelheid	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organisatie-ID	organizationId	uuid
relatedVouchers	relatedVouchers	array of object
identiteitskaart	relatedVouchers.id	uuid
voucherNumber	relatedVouchers.voucherNumber	string
voucherType	relatedVouchers.voucherType	string
opmerking	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
currency	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

Een dunningsdocument weergeven (PDF)

Bewerkings-id:

RenderDunningDocument

Als u het PDF-bestand van een dunning-document wilt downloaden, hebt u de documentFileId nodig. Deze id wordt meestal geretourneerd door de dunning-resource. Nieuwe dunnings via de API moeten echter afzonderlijk de rendering van het PDF-documentbestand activeren. Dit kan worden gedaan met dit eindpunt.

Parameters

Name	Sleutel	Vereist	Type	Description
Dunningsid	dunningsid	True	string	Geef de dunningsid op.

Retouren

Name	Pad	Type	Description
documentFileId	documentFileId	uuid

Een Event-Subscription verwijderen

Bewerkings-id:

DeleteEventSubscription

Triggerwebhook verwijderen

Parameters

Name	Sleutel	Vereist	Type	Description
Abonnements-id	subscriptionId	True	string	Geef de abonnements-id op.

Een factuur maken

Bewerkings-id:

CreateInvoice

Facturen die via de API worden verzonden, worden standaard gemaakt in de conceptmodus. Als u een voltooide factuur met de status wilt maken, moet de optionele queryparameter worden ingesteld. De status van een factuur kan niet worden gewijzigd via de API.

Parameters

Name	Sleutel	Vereist	Type	Description
Voorafgaande verkoopvoucher-id	precedingSalesVoucherId		string	Geef de voorgaande verkoopvoucher-id op.
Afronden	finalize	True	boolean	Geef het voltooien op.

Retouren

Body

Response_invoices_post

Een factuur ophalen

Bewerkings-id:

RetrieveInvoice

Retourneert de factuur met id-waarde {id}.

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Name	Pad	Type	Description
city	address.city	string
landCode	address.countryCode	string
naam	address.name	string
straat	address.street	string
Supplement	address.supplement	string
ZIP-bestand	address.zip	string
Gearchiveerde	archived	boolean
aanmaakdatum	createdDate	date-time
identiteitskaart	id	uuid
Introductie	introduction	string
language	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
identiteitskaart	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
naam	lineItems.name	string
hoeveelheid	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organisatie-ID	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
opmerking	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
currency	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
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Een factuur voor een aanbetaling ophalen

Bewerkings-id:

RetrieveDownPaymentInvoice

Retourneert de aanbetalingsfactuur met id-waarde {id}.

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Name	Pad	Type	Description
city	address.city	string
landCode	address.countryCode	string
naam	address.name	string
straat	address.street	string
Supplement	address.supplement	string
ZIP-bestand	address.zip	string
Gearchiveerde	archived	boolean
closingInvoiceId	closingInvoiceId	uuid
aanmaakdatum	createdDate	date-time
vervaldatum	dueDate	date-time
documentFileId	files.documentFileId	uuid
identiteitskaart	id	uuid
Introductie	introduction	string
language	language	string
lineItems	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
naam	lineItems.name	string
hoeveelheid	lineItems.quantity	number
type	lineItems.type	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organisatie-ID	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
opmerking	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
currency	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
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Een factuurdocument weergeven (PDF)

Bewerkings-id:

RenderInvoiceDocument

Als u het PDF-bestand van een factuurdocument wilt downloaden, hebt u de documentFileId nodig. Deze id wordt meestal geretourneerd door de factuurresource. Nieuwe facturen in de status worden echter geopend via de API, moeten de weergave van het PDF-documentbestand afzonderlijk activeren. Dit kan worden gedaan met dit eindpunt.

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Name	Pad	Type	Description
documentFileId	documentFileId	uuid

Een gebeurtenisabonnement ophalen

Bewerkings-id:

RetrieveAEventSubscription

Een gebeurtenisabonnement ophalen

Parameters

Name	Sleutel	Vereist	Type	Description
Abonnements-id	subscriptionId	True	string	Geef de abonnements-id op.

Retouren

Body

EventSubscriptionResponse

Een lijst met boekingscategorieën ophalen

Bewerkings-id:

RetrieveListPostingCategories

Dit eindpunt biedt leestoegang tot de lijst met boekingscategorieën voor de omzet of onkosten van de vouchers (boekhouden) die worden ondersteund in lexoffice.

Retouren

response

array of Response_posting-categories_get_items

Een offerte maken

Bewerkings-id:

CreateQuotation

Offertes die via de API worden verzonden, worden standaard gemaakt in de conceptmodus. Als u een definitieve aanhaling met de status wilt maken, moet de optionele queryparameter worden ingesteld. De status van een offerte kan niet worden gewijzigd via de API.

Parameters

Name	Sleutel	Vereist	Type	Description
Afronden	finalize	True	boolean	Geef het voltooien op.

Retouren

Body

Response_quotations_post

Een offerte ophalen

Bewerkings-id:

RetrieveQuotation

Retourneert de aanhaling met de id-waarde {id}. Een offertedocument weergeven (PDF)

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Name	Pad	Type	Description
city	address.city	string
contactId	address.contactId	uuid
landCode	address.countryCode	string
naam	address.name	string
straat	address.street	string
ZIP-bestand	address.zip	string
Gearchiveerde	archived	boolean
aanmaakdatum	createdDate	date-time
vervaldatum	expirationDate	date-time
documentFileId	files.documentFileId	uuid
identiteitskaart	id	uuid
Introductie	introduction	string
language	language	string
lineItems	lineItems	array of object
alternatief	lineItems.alternative	boolean
discountPercentage	lineItems.discountPercentage	number
identiteitskaart	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
naam	lineItems.name	string
optional	lineItems.optional	boolean
hoeveelheid	lineItems.quantity	number
Subitems	lineItems.subItems	array of object
alternatief	lineItems.subItems.alternative	boolean
discountPercentage	lineItems.subItems.discountPercentage	number
identiteitskaart	lineItems.subItems.id	uuid
lineItemAmount	lineItems.subItems.lineItemAmount	number
naam	lineItems.subItems.name	string
optional	lineItems.subItems.optional	boolean
hoeveelheid	lineItems.subItems.quantity	number
type	lineItems.subItems.type	string
unitName	lineItems.subItems.unitName	string
currency	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
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organisatie-ID	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
opmerking	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
currency	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
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Een offertedocument weergeven (PDF)

Bewerkings-id:

RenderQuotationDocument

Als u het PDF-bestand van een offertedocument wilt downloaden, hebt u de documentFileId nodig. Deze id wordt meestal geretourneerd door de offerteresource. Nieuwe aanhalingstekens in de status worden echter geopend via de API, moeten de weergave van het PDF-documentbestand afzonderlijk activeren. Dit kan worden gedaan met dit eindpunt.

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Name	Pad	Type	Description
documentFileId	documentFileId	uuid

Een orderbevestiging maken

Bewerkings-id:

CreateOrderConfirmation

Dit eindpunt biedt lees- en schrijftoegang tot orderbevestigingen en ook de mogelijkheid om het document als PDF weer te geven om het te downloaden. Orderbevestigingen worden altijd gemaakt in de conceptmodus en hoeven niet te worden voltooid.

Parameters

Name	Sleutel	Vereist	Type	Description
Voorafgaande verkoopvoucher-id	precedingSalesVoucherId		string	Geef de voorgaande verkoopvoucher-id op.

Retouren

Body

Response_order-confirmations_post

Een orderbevestiging ophalen

Bewerkings-id:

RetrieveOrderConfirmation

Retourneert de orderbevestiging met de id-waarde {id}.

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Name	Pad	Type	Description
city	address.city	string
landCode	address.countryCode	string
naam	address.name	string
straat	address.street	string
Supplement	address.supplement	string
ZIP-bestand	address.zip	string
Gearchiveerde	archived	boolean
aanmaakdatum	createdDate	date-time
deliveryTerms	deliveryTerms	string
documentFileId	files.documentFileId	uuid
identiteitskaart	id	uuid
Introductie	introduction	string
language	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
identiteitskaart	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
naam	lineItems.name	string
hoeveelheid	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organisatie-ID	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
opmerking	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
currency	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
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Een orderbevestigingsdocument weergeven (PDF)

Bewerkings-id:

RenderOrderConfirmationDocument

Als u het PDF-bestand van een orderbevestigingsdocument wilt downloaden, hebt u de documentFileId nodig. Deze id wordt meestal geretourneerd door de orderbevestigingsresource. Nieuwe orderbevestigingen via de API moeten de weergave van het PDF-documentbestand echter afzonderlijk activeren. Dit kan worden gedaan met dit eindpunt.

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Name	Pad	Type	Description
documentFileId	documentFileId	uuid

Een tegoednotitie maken

Bewerkings-id:

CreateCreditNote

Creditnota's die via de API worden verzonden, worden per standaard conceptmodus gemaakt. Als u een voltooide tegoednotitie met de status wilt maken, moet de optionele queryparameter worden ingesteld. De status van een creditnota kan niet worden gewijzigd via de API

Parameters

Name	Sleutel	Vereist	Type	Description
Voorafgaande verkoopvoucher-id	precedingSalesVoucherId		string	Geef de voorgaande verkoopvoucher-id op.
Afronden	finalize	True	boolean	Geef het voltooien op.

Retouren

Body

Response_credit-notes_post

Een tegoednotitie ophalen

Bewerkings-id:

RetrieveCreditNote

Dit eindpunt biedt lees- en schrijftoegang tot creditnota's en ook de mogelijkheid om het document weer te geven als pdf-bestand om het te downloaden. Creditnota's kunnen worden gemaakt als concept of voltooid in de geopende modus.

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Name	Pad	Type	Description
city	address.city	string
landCode	address.countryCode	string
naam	address.name	string
straat	address.street	string
Supplement	address.supplement	string
ZIP-bestand	address.zip	string
Gearchiveerde	archived	boolean
aanmaakdatum	createdDate	date-time
identiteitskaart	id	uuid
Introductie	introduction	string
language	language	string
lineItems	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
naam	lineItems.name	string
hoeveelheid	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organisatie-ID	organizationId	uuid
opmerking	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
currency	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
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Een terugkerende sjabloon ophalen

Bewerkings-id:

RetrieveRecurringTemplate

Retourneert de terugkerende sjabloon met id-waarde {id}.

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Name	Pad	Type	Description
city	address.city	string
contactId	address.contactId	uuid
landCode	address.countryCode	string
naam	address.name	string
straat	address.street	string
ZIP-bestand	address.zip	string
Gearchiveerde	archived	boolean
aanmaakdatum	createdDate	date-time
identiteitskaart	id	uuid
Introductie	introduction	string
language	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
naam	lineItems.name	string
hoeveelheid	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organisatie-ID	organizationId	uuid
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
terugkerendeTemplateSettings	recurringTemplateSettings	object
opmerking	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
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer

Een voucher maken

Bewerkings-id:

CreateVoucher

Vouchers maken (beperkt tot verkoopvouchers)

Parameters

Name	Sleutel	Vereist	Type	Description
contactId	contactId		string
vervaldatum	dueDate		date
opmerking	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
aantal	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Retouren

Body

Response_vouchers_post

Een voucher ophalen

Bewerkings-id:

RetrieveVoucher

Verkoopvouchers vermelden (bijvoorbeeld facturen, creditnotes)

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.

Retouren

Name	Pad	Type	Description
aanmaakdatum	createdDate	date-time
vervaldatum	dueDate	date-time
files	files	array of string
identiteitskaart	id	uuid
organisatie-ID	organizationId	uuid
opmerking	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
aantal	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Lijst met betalingsvoorwaarden ophalen

Bewerkings-id:

RetrieveListOfPaymentConditions

In het volgende voorbeeld ziet u hoe u een lijst met momenteel geconfigureerde betalingsvoorwaarden ophaalt. U moet de tijdelijke aanduiding {accessToken} vervangen voordat u de aanvraag verzendt.

Retouren

response

array of Response_payment-conditions_get_items

Lijst met landen ophalen

Bewerkings-id:

RetrieveListCountries

Lijst met landen die bekend zijn bij lexoffice.

Retouren

response

array of Response_countries_get_default

Profielgegevens ophalen

Bewerkings-id:

RetrieveProfileInformation

In het volgende voorbeeld ziet u hoe u uw basisprofielgegevens ophaalt. U moet de tijdelijke aanduiding {accessToken} vervangen voordat u de aanvraag verzendt.

Retouren

Body

Response_profile_get

Voucher bijwerken

Bewerkings-id:

UpdateVoucher

Een voucher bijwerken

Parameters

Name	Sleutel	Vereist	Type	Description
Identiteitsbewijs	id	True	string	Geef de id op.
contactId	contactId		string
vervaldatum	dueDate		date
files	files		array of string	lijst met weggelaten fileIds
opmerking	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
aantal	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Retouren

Body

Response_vouchers_id_put

Voucherlijst ophalen en filteren

Bewerkings-id:

RetrieveAndFilterVoucherlist

Ontvang voucherlistbonnen (boekhouding) (bijvoorbeeld salesinvoices, salescreditnotes), facturen (inclusief aanbetalingsfacturen), creditnota's, orderbevestigingen, offertes en leveringsbonnen.

Parameters

Name	Sleutel	Vereist	Type	Description
Vouchertype	voucherType	True	string	Geef het type voucher op.
Voucherstatus	voucherStatus	True	string	Geef de voucherstatus op.
Gearchiveerde	archived		boolean	Geef het gearchiveerde bestand op.
Contactpersoon-ID	contactId		string	Geef de contactpersoon-id op.
Voucherdatum van	voucherDateFrom		string	Geef de datum van de voucher op van.
Voucherdatum tot	voucherDateTo		string	Geef de voucherdatum op tot.
Gemaakt op basis van	createdDateFrom		string	Geef de gemaakte datum op van.
Gemaakt tot	createdDateTo		string	Geef de gemaakte datum op tot.
Datum bijgewerkt vanaf	updatedDateFrom		string	Geef de bijgewerkte datum op vanaf.
Bijgewerkte datum tot	updatedDateTo		string	Geef de bijgewerkte datum op tot.
Vouchernummer	voucherNumber		string	Geef het vouchernummer op.
Page	page		integer	Geef de pagina op.
Grootte	size		integer	Geef de grootte op.
Sorteren	sort		string	Geef de sortering op.

Retouren

Body

Response_voucherlist_get

Triggers

Uw aangepaste trigger selecteren

Een nieuwe trigger registreren voor het eindpunt van contactpersonen

Uw aangepaste trigger selecteren

Bewerkings-id:

EventSubscription_Lexoffice

Een nieuwe trigger registreren voor het eindpunt van contactpersonen

Parameters

Name	Sleutel	Vereist	Type	Description
Gebeurtenistype	eventType	True	string	eventType

Retouren

Name	Pad	Type	Description
eventDate	eventDate	string	eventDate
eventType	eventType	string	eventType
organisatie-ID	organizationId	string	organisatie-ID
bron-ID	resourceId	string	bron-ID

Definities

EventSubscriptionResponse

Name	Pad	Type	Description
subscriptionId	subscriptionId	string
eventType	eventType	string
organisatie-ID	organizationId	string
aanmaakdatum	createdDate	date-time
callbackUrl	callbackUrl	string

Response_articles_get

Name	Pad	Type	Description
inhoud	content	array of object	inhoud
articleNumber	content.articleNumber	string	articleNumber
gtin	content.gtin	string	gtin
identiteitskaart	content.id	string	identiteitskaart
notitie	content.note	string	notitie
brutoprijs	content.price.grossPrice	float	brutoprijs
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
eerste	first	boolean	eerste
laatste	last	boolean	laatste
nummer	number	integer	nummer
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
oplopend	sort.ascending	boolean	oplopend
richting	sort.direction	string	richting
negerenCase	sort.ignoreCase	boolean	negerenCase
nullHandling	sort.nullHandling	string	nullHandling
vastgoed	sort.property	string	vastgoed
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_articles_id_get

Name	Pad	Type	Description
articleNumber	articleNumber	string	articleNumber
gtin	gtin	string	gtin
identiteitskaart	id	string	identiteitskaart
notitie	note	string	notitie
brutoprijs	price.grossPrice	float	brutoprijs
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

Name	Pad	Type	Description
aanmaakdatum	createdDate	string	aanmaakdatum
identiteitskaart	id	string	identiteitskaart
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_contacts_get

Name	Pad	Type	Description
inhoud	content	array of object	inhoud
Facturering	content.addresses.billing	array of object	Facturering
city	content.addresses.billing.city	string	city
landCode	content.addresses.billing.countryCode	string	landCode
straat	content.addresses.billing.street	string	straat
Supplement	content.addresses.billing.supplement	string	Supplement
ZIP-bestand	content.addresses.billing.zip	string	ZIP-bestand
scheepvaart	content.addresses.shipping	array of object	scheepvaart
city	content.addresses.shipping.city	string	city
landCode	content.addresses.shipping.countryCode	string	landCode
straat	content.addresses.shipping.street	string	straat
Supplement	content.addresses.shipping.supplement	string	Supplement
ZIP-bestand	content.addresses.shipping.zip	string	ZIP-bestand
Gearchiveerde	content.archived	boolean	Gearchiveerde
allowTaxFreeInvoices	content.company.allowTaxFreeInvoices	boolean	allowTaxFreeInvoices
contactPersons	content.company.contactPersons	array of object	contactPersons
emailadres	content.company.contactPersons.emailAddress	string	emailadres
voornaam	content.company.contactPersons.firstName	string	voornaam
achternaam	content.company.contactPersons.lastName	string	achternaam
primair	content.company.contactPersons.primary	boolean	primair
groet	content.company.contactPersons.salutation	string	groet
naam	content.company.name	string	naam
btw-nummer	content.company.taxNumber	string	btw-nummer
vatRegistrationId	content.company.vatRegistrationId	string	vatRegistrationId
zaak	content.emailAddresses.business	array of string	zaak
kantoor	content.emailAddresses.office	array of string	kantoor
other	content.emailAddresses.other	array of string	other
identiteitskaart	content.id	string	identiteitskaart
notitie	content.note	string	notitie
organisatie-ID	content.organizationId	string	organisatie-ID
zaak	content.phoneNumbers.business	array of string	zaak
fax	content.phoneNumbers.fax	array of string	fax
kantoor	content.phoneNumbers.office	array of string	kantoor
other	content.phoneNumbers.other	array of string	other
nummer	content.roles.customer.number	integer	nummer
nummer	content.roles.vendor.number	integer	nummer
version	content.version	integer	version
eerste	first	boolean	eerste
laatste	last	boolean	laatste
nummer	number	integer	nummer
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
oplopend	sort.ascending	boolean	oplopend
richting	sort.direction	string	richting
negerenCase	sort.ignoreCase	boolean	negerenCase
nullHandling	sort.nullHandling	string	nullHandling
vastgoed	sort.property	string	vastgoed
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_contacts_post

Name	Pad	Type	Description
aanmaakdatum	createdDate	string	aanmaakdatum
identiteitskaart	id	string	identiteitskaart
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_countries_get_default

Name	Pad	Type	Description
landCode	countryCode	string	landCode
countryNameDE	countryNameDE	string	countryNameDE
countryNameEN	countryNameEN	string	countryNameEN
taxClassification	taxClassification	string	taxClassification

Response_credit-notes_post

Name	Pad	Type	Description
aanmaakdatum	createdDate	string	aanmaakdatum
identiteitskaart	id	string	identiteitskaart
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_delivery-notes_post

Name	Pad	Type	Description
aanmaakdatum	createdDate	string	aanmaakdatum
identiteitskaart	id	string	identiteitskaart
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_dunnings_post

Name	Pad	Type	Description
aanmaakdatum	createdDate	string	aanmaakdatum
identiteitskaart	id	string	identiteitskaart
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_event-subscriptions_get

Name	Pad	Type	Description
inhoud	content	array of object	inhoud
callbackUrl	content.callbackUrl	string	callbackUrl
aanmaakdatum	content.createdDate	string	aanmaakdatum
eventType	content.eventType	string	eventType
organisatie-ID	content.organizationId	string	organisatie-ID
subscriptionId	content.subscriptionId	string	subscriptionId

Response_files_post

Name	Pad	Type	Description
identiteitskaart	id	string	identiteitskaart

Response_invoices_post

Name	Pad	Type	Description
aanmaakdatum	createdDate	string	aanmaakdatum
identiteitskaart	id	string	identiteitskaart
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_order-confirmations_post

Name	Pad	Type	Description
aanmaakdatum	createdDate	string	aanmaakdatum
identiteitskaart	id	string	identiteitskaart
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_payment-conditions_get_items

Name	Pad	Type	Description
identiteitskaart	id	string	identiteitskaart
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

Name	Pad	Type	Description
contactRequired	contactRequired	boolean	contactRequired
groupName	groupName	string	groupName
identiteitskaart	id	string	identiteitskaart
naam	name	string	naam
splitAllowed	splitAllowed	boolean	splitAllowed
type	type	string	type

Response_profile_get

Name	Pad	Type	Description
businessFeatures	businessFeatures	array of string	businessFeatures
companyName	companyName	string	companyName
connectionId	connectionId	string	connectionId
date	created.date	string	date
gebruikerE-mail	created.userEmail	string	gebruikerE-mail
userId	created.userId	string	userId
gebruikersnaam	created.userName	string	gebruikersnaam
features	features	array of string	features
organisatie-ID	organizationId	string	organisatie-ID
Smallbusiness	smallBusiness	boolean	Smallbusiness
abonnementStatus	subscriptionStatus	string	abonnementStatus
taxType	taxType	string	taxType

Response_quotations_post

Name	Pad	Type	Description
aanmaakdatum	createdDate	string	aanmaakdatum
identiteitskaart	id	string	identiteitskaart
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_recurring-templates_get

Name	Pad	Type	Description
inhoud	content	array of object	inhoud
contactId	content.address.contactId	string	contactId
naam	content.address.name	string	naam
aanmaakdatum	content.createdDate	string	aanmaakdatum
identiteitskaart	content.id	string	identiteitskaart
organisatie-ID	content.organizationId	string	organisatie-ID
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
einddatum	content.recurringTemplateSettings.endDate	string	einddatum
executionInterval	content.recurringTemplateSettings.executionInterval	string	executionInterval
executionStatus	content.recurringTemplateSettings.executionStatus	string	executionStatus
Voltooien	content.recurringTemplateSettings.finalize	boolean	Voltooien
identiteitskaart	content.recurringTemplateSettings.id	string	identiteitskaart
lastExecutionFailed	content.recurringTemplateSettings.lastExecutionFailed	boolean	lastExecutionFailed
nextExecutionDate	content.recurringTemplateSettings.nextExecutionDate	string	nextExecutionDate
shippingType	content.recurringTemplateSettings.shippingType	string	shippingType
startDate	content.recurringTemplateSettings.startDate	string	startDate
title	content.title	string	title
currency	content.totalPrice.currency	string	currency
totalGrossAmount	content.totalPrice.totalGrossAmount	integer	totalGrossAmount
totalNetAmount	content.totalPrice.totalNetAmount	float	totalNetAmount
updatedDate	content.updatedDate	string	updatedDate
eerste	first	boolean	eerste
laatste	last	boolean	laatste
nummer	number	integer	nummer
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
oplopend	sort.ascending	boolean	oplopend
richting	sort.direction	string	richting
negerenCase	sort.ignoreCase	boolean	negerenCase
nullHandling	sort.nullHandling	string	nullHandling
vastgoed	sort.property	string	vastgoed
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_voucherlist_get

Name	Pad	Type	Description
inhoud	content	array of object	inhoud
Gearchiveerde	content.archived	boolean	Gearchiveerde
contactId	content.contactId	string	contactId
contactNaam	content.contactName	string	contactNaam
aanmaakdatum	content.createdDate	string	aanmaakdatum
currency	content.currency	string	currency
vervaldatum	content.dueDate	string	vervaldatum
identiteitskaart	content.id	string	identiteitskaart
openAmount	content.openAmount	float	openAmount
totaalbedrag	content.totalAmount	float	totaalbedrag
updatedDate	content.updatedDate	string	updatedDate
voucherDate	content.voucherDate	string	voucherDate
voucherNumber	content.voucherNumber	string	voucherNumber
voucherStatus	content.voucherStatus	string	voucherStatus
voucherType	content.voucherType	string	voucherType
eerste	first	boolean	eerste
laatste	last	boolean	laatste
nummer	number	integer	nummer
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
oplopend	sort.ascending	boolean	oplopend
richting	sort.direction	string	richting
negerenCase	sort.ignoreCase	boolean	negerenCase
nullHandling	sort.nullHandling	string	nullHandling
vastgoed	sort.property	string	vastgoed
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_vouchers_post

Name	Pad	Type	Description
aanmaakdatum	createdDate	string	aanmaakdatum
identiteitskaart	id	string	identiteitskaart
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_contacts_id_put

Name	Pad	Type	Description
Gearchiveerde	archived	boolean
identiteitskaart	id	uuid
organisatie-ID	organizationId	uuid
voornaam	person.firstName	string
achternaam	person.lastName	string
groet	person.salutation	string
nummer	roles.customer.number	integer
version	version	integer

Response_vouchers_id_put

Name	Pad	Type	Description
aanmaakdatum	createdDate	date-time
vervaldatum	dueDate	date-time
files	files	array of object
items	files	object
identiteitskaart	id	uuid
organisatie-ID	organizationId	uuid
opmerking	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
aantal	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

bestand

Dit is het basisgegevenstype 'bestand'.