Lexoffice (oberoende utgivare) (förhandsversion)

Lexware-API:et ger programmatisk åtkomst till centrala Lexware-affärsfunktioner som artiklar, kontakter, fakturor, beställningar och filhantering. Den här independent publisher-anslutningsappen möjliggör säker integrering med Lexwares REST-API, vilket gör det möjligt för användare att skapa och hämta affärsdata, automatisera processer och ansluta Lexware-resurser med Power Platform-program. Anslutningsappen använder OAuth 2.0 Authorization Code Flow för säker autentisering och API-riktlinjer.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster	Class	Regioner
Copilot Studio	Premie	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Logiska appar	Norm	Alla Logic Apps-regioner utom följande:      – Azure Government-regioner      – Regioner i Azure Kina      - US Department of Defense (DoD)
Power Apps	Premie	Alla Power Apps-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Power Automate	Premie	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)

Kontakt
Namn	Stöd för LowCode-utredare
URL	https://lowcode-investigator.com/
E-postmeddelande	kontakt@lowcodeinvestigator.com

Metadata för anslutningsprogram
Utgivare	LowCodeInvestigator
Webbplats	https://office.lexware.de/
Sekretesspolicy	https://office.lexware.de/datenschutz/
Kategorier	Företagsledning; Finans

Lexware API Connector (oberoende utgivare)

Lexware API är ett RESTful-gränssnitt som gör det möjligt för utvecklare att integrera Lexware-affärsfunktioner som kontakter, fakturor, artiklar och filer i sina egna program. Den här anslutningsappen möjliggör direkt interaktion med dessa resurser via säkra, autentiserade API-begäranden.

Utgivare: Oberoende utgivare

Förutsättningar

• Ett registrerat Lexware-konto och en korrekt licens
• En giltig API-nyckel (åtkomsttoken) som hämtas via Lexware Developer Portal
• OAuth 2.0-auktoriseringskodflöde krävs för autentisering

Åtgärder som stöds

Den här anslutningsappen stöder följande Lexware API-slutpunkter:

• Artiklar: Skapa, hämta, uppdatera, ta bort och filtrera artiklar
• Kontakter: Hantera kund- och leverantörsdata
• Fakturor: Skapa och hämta fakturadata, inklusive återgivning av PDF-filer
• Kreditanteckningar, leveransanteckningar, beställningar, offerter och kuponger
• Länder, betalningsvillkor, utskriftslayouter och profiler
• Händelseprenumerationer och filer
• Fullständig lista dokumenterad på: Lexware API Docs

Hämta autentiseringsuppgifter

För att anropa Lexware-API:et behöver du en API-nyckel:

1. Logga in på ditt Lexware Office-konto.
2. Gå till Tillägg → Weitere Apps → offentligt API eller öppna
   Lexware Developer Portal direkt.
3. Skapa en ny API-nyckel med önskade behörigheter.
4. Kopiera den genererade API-nyckeln. Det här värdet används som accessToken i anslutningsappen.

API-gateway

Använd den nya Lexware API-gatewayen:

https://api.lexware.io

Hastighetsgränser

• Max 2 begäranden/sekund
• Begäranden som överskrider den här gränsen tar emot HTTP 429 Too Many Requests
• Rekommenderas: Använd token bucket-algoritm eller exponentiell backoff

Authentication

Lexware API använder OAuth 2.0 Authorization Code Flow. Inkludera token i rubriken för Authorization: Bearer {accessToken} varje begäran.

Exempel på användning

Skapa en artikel:

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

Kända problem och begränsningar

• Max 2 begäranden/sekund
• Vissa slutpunkter kräver ytterligare behörigheter eller roller

API-dokumentation

Fullständig API-referens är tillgänglig på:
https://developers.lexware.io/docs/

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:

Standardinställning	Parametrar för att skapa anslutning.	Alla regioner	Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn	Typ	Description	Krävs
API-nyckel	securestring	API-nyckeln för det här API:et	Sann

Gränser för begränsning

Namn	Samtal	Förnyelse period
API-anrop per anslutning	100	60 sekunder

Åtgärder

Filtrera artiklar	Returnerar de artiklar som uppfyller de villkor som anges av filter filter_1 för att filter_n med hjälp av en växlingsmekanism. Om fler än ett filter anges är den logiska anslutningsappen AND. Filter som inte har angetts ignoreras. Information om hur du kontrollerar den maximala sidstorleken för den här slutpunkten finns i Sidindelning av resurser.
Hämta alla händelseprenumerationer	Hämta alla händelseprenumerationer
Hämta alla kontakter	Hämta alla kontakter
Hämta alla återkommande mallar	Hämta en samling återkommande mallar. Resultatet returnerar endast en del av de mest relevanta data som är den refererade kontakten (endast ID och namn), totalt pris, betalningsvillkor och de fullständiga återkommande mallinställningarna. Namngivning av objekt och egenskaper är dock desamma.
Hämta betalningsinformation	Betalningsslutpunkten ger läsåtkomst till betalningsstatusen för (bokföring eller försäljning) kuponger, inklusive fakturor och kreditfakturor.
Hämta en artikel	Returnerar artikeln med ID-värdet {id}.
Hämta en dunning	Returnerar dunning med ID-värdet {id}.
Hämta en faktura	Returnerar fakturan med ID-värdet {id}.
Hämta en faktura för handpenning	Returnerar handpenningsfakturan med ID-värdet {id}.
Hämta en händelseprenumeration	Hämta en händelseprenumeration
Hämta en kontakt	Hämta en kontakt via ID
Hämta en kreditanteckning	Den här slutpunkten ger läs- och skrivåtkomst till kreditanteckningar och även möjlighet att återge dokumentet som pdf för att ladda ned det. Kreditanteckningar kan skapas som ett utkast eller slutföras i öppet läge.
Hämta en leveransanteckning	Returnerar leveransnoten med ID-värdet {id}.
Hämta en lista över bokföringskategorier	Den här slutpunkten ger läsåtkomst till listan över bokföringskategorier för de (bokförings) kuponger intäkter eller kostnader som stöds i lexoffice.
Hämta en offert	Returnerar offerten med ID-värdet {id}. Rendera ett citatdokument (PDF)
Hämta en orderbekräftelse	Returnerar orderbekräftelsen med ID-värdet {id}.
Hämta en verifikation	Visa en lista över försäljningskuponger (t.ex. fakturor, kreditanmärkningar)
Hämta en återkommande mall	Returnerar den återkommande mallen med ID-värdet {id}.
Hämta lista över betalningsvillkor	Följande exempel visar hur du hämtar en lista över för närvarande konfigurerade betalningsvillkor. Du måste ersätta platshållaren {accessToken} innan du skickar begäran.
Hämta lista över länder	Lista över länder som är kända för lexoffice.
Hämta och filtrera verifikationslista	Få verifikationslista (bokföring) kuponger (t.ex. salesinvoices, salescreditnotes), fakturor (inklusive handpenningsfakturor), kreditfakturor, orderbekräftelser, offerter och leveransfakturor.
Hämta profilinformation	Följande exempel visar hur du hämtar din grundläggande profilinformation. Du måste ersätta platshållaren {accessToken} innan du skickar begäran.
Ladda ned en fil	Använd den här slutpunkten för att ladda ned filer.
Ladda upp en fil	Använd den här slutpunkten för att ladda upp filer, t.ex. kuponger eller fakturor.
Ladda upp en fil till en verifikation	Ladda upp och tilldela filer (pdf eller bild) till verifikationen som identifieras av {id}.
Rendera ett citatdokument (PDF)	Om du vill ladda ned pdf-filen för ett citatdokument behöver du dess documentFileId. Det här ID:t returneras vanligtvis av offertresursen. Nyligen skapade citat i status öppen via API:et måste dock utlösa pdf-dokumentfilens återgivning separat. Detta kan göras med den här slutpunkten.
Rendera ett dokument för kreditfakturor (PDF)	Om du vill ladda ned pdf-filen för ett kreditfakturadokument behöver du dess documentFileId. Det här ID:t returneras vanligtvis av kreditfaktureresursen. Nyligen skapade kreditanteckningar i status som är öppna via API:et måste dock utlösa pdf-dokumentfilens återgivning separat. Detta kan göras med den här slutpunkten.
Rendera ett dokument för leveransanteckning (PDF)	Den här slutpunkten ger läs- och skrivåtkomst till leveransanteckningar och även möjlighet att återge dokumentet som en PDF för att ladda ned det. Leveransanteckningar skapas alltid i utkastläge och behöver inte slutföras.
Rendera ett dunning-dokument (PDF)	Om du vill ladda ned pdf-filen för ett dunning-dokument behöver du dess documentFileId. Det här ID:t returneras vanligtvis av dunning-resursen. Nyligen skapade dunnings via API:et måste dock utlösa pdf-dokumentfilens återgivning separat. Detta kan göras med den här slutpunkten.
Rendera ett fakturadokument (PDF)	Om du vill ladda ned pdf-filen för ett fakturadokument behöver du dess documentFileId. Det här ID:t returneras vanligtvis av fakturaresursen. Nyligen skapade fakturor i status öppen via API:et måste dock utlösa pdf-dokumentfilens återgivning separat. Detta kan göras med den här slutpunkten.
Rendera ett orderbekräftelsedokument (PDF)	Om du vill ladda ned pdf-filen i ett orderbekräftelsedokument behöver du dess documentFileId. Det här ID:t returneras vanligtvis av orderbekräftelseresursen. Nyligen skapade orderbekräftelser via API:et måste dock utlösa pdf-dokumentfilens återgivning separat. Detta kan göras med den här slutpunkten.
Skapa en artikel	Innehållet i artikeln förväntas i begärandetexten som ett program/json.
Skapa en dunning	Den skapade dunningen visas inte i huvudverifikationslistan i lexoffice, men kommer att bifogas till en faktura och visas där. Om du vill ge dina kunder åtkomst till den skapade dunningen använder du vår deeplink-funktion.
Skapa en faktura	Fakturor som skickas via API:et skapas i utkastläge som standard. För att skapa en slutförd faktura med status öppen måste den valfria frågeparametern slutföras anges. Det går inte att ändra statusen för en faktura via API:et.
Skapa en kontakt	Skapa en ny kontakt
Skapa en kreditfaktura	Kreditanteckningar som överförs via API:et skapas i utkastläge som standard. Om du vill skapa en slutförd kreditnota med status öppen måste den valfria frågeparametern slutföras anges. Det går inte att ändra statusen för en kreditfaktura via API:et
Skapa en leveransanteckning	Den skapade leveransnotan visas i huvudverifikationslistan i lexoffice. Leveransanteckningar som överförs via API:et skapas endast i utkastläge.
Skapa en offert	Offerter som överförs via API:et skapas i utkastläge som standard. Om du vill skapa en slutförd offert med status öppen måste den valfria frågeparametern slutföras anges. Det går inte att ändra statusen för en offert via API:et.
Skapa en orderbekräftelse	Den här slutpunkten ger läs- och skrivåtkomst till orderbekräftelser och även möjlighet att återge dokumentet som pdf för att ladda ned det. Orderbekräftelser skapas alltid i utkastläge och behöver inte slutföras.
Skapa en verifikation	Skapa kuponger (begränsat till försäljningsverifikationer)
Ta bort en artikel	Tar bort artikeln med ID-värdet {id}. Returnerar 204 vid lyckat resultat, eller 404 om ID:t inte finns.
Ta bort en Event-Subscription	Ta bort Utlösarwebbhook
Uppdatera en artikel	Uppdatera en befintlig artikel med ID {id} med data som anges i nyttolasten som JSON. Returnerar ett åtgärdsresultat vid lyckat resultat.
Uppdatera en kontakt	Uppdatera en kontakt
Uppdatera verifikation	Uppdatera en verifikation

Filtrera artiklar

Åtgärds-ID:

FilteringArticles

Returnerar de artiklar som uppfyller de villkor som anges av filter filter_1 för att filter_n med hjälp av en växlingsmekanism. Om fler än ett filter anges är den logiska anslutningsappen AND. Filter som inte har angetts ignoreras. Information om hur du kontrollerar den maximala sidstorleken för den här slutpunkten finns i Sidindelning av resurser.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Artikelnummer	articleNumber		string	Ange artikelnumret.
Gtin	gtin		string	Ange gtin.
Typ	type		string	Ange typ.
Sida	page		integer	Ange sidan.
Storlek	size		integer	Ange storlek.
Sortera	sort		string	Ange sorteringen.

Returnerar

Body

Response_articles_get

Hämta alla händelseprenumerationer

Åtgärds-ID:

RetrieveAllEventSubscriptions

Hämta alla händelseprenumerationer

Returnerar

Body

Response_event-subscriptions_get

Hämta alla kontakter

Åtgärds-ID:

RetrieveAllContacts

Hämta alla kontakter

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Nummer	number		integer	Ange numret.
E-postmeddelande	email		string	Ange e-postmeddelandet.
Namn	name		string	Ange namnet.
Leverantör	vendor		boolean	Ange leverantören.
Kund	customer		boolean	Ange kunden.
Sida	page		integer	Ange sidan.
Storlek	size		integer	Ange storlek.
Sortera	sort		string	Ange sorteringen.

Returnerar

Body

Response_contacts_get

Hämta alla återkommande mallar

Åtgärds-ID:

RetrieveAllRecurringTemplates

Hämta en samling återkommande mallar. Resultatet returnerar endast en del av de mest relevanta data som är den refererade kontakten (endast ID och namn), totalt pris, betalningsvillkor och de fullständiga återkommande mallinställningarna. Namngivning av objekt och egenskaper är dock desamma.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Sida	page		integer	Ange sidan.
Storlek	size		integer	Ange storlek.
Sortera	sort		string	Ange sorteringen.

Returnerar

Body

Response_recurring-templates_get

Hämta betalningsinformation

Åtgärds-ID:

RetrievePaymentInformation

Betalningsslutpunkten ger läsåtkomst till betalningsstatusen för (bokföring eller försäljning) kuponger, inklusive fakturor och kreditfakturor.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Verifikations-ID	voucherId	True	string	Ange verifikations-ID: t.

Returnerar

Namn	Stig	Typ	Beskrivning
valuta	currency	string
openAmount	openAmount	string
paymentItems	paymentItems	array of object
belopp	paymentItems.amount	float
valuta	paymentItems.currency	string
paymentItemType	paymentItems.paymentItemType	string
postingDate	paymentItems.postingDate	date-time
betalningsstatus	paymentStatus	string
voucherStatus	voucherStatus	string
voucherType	voucherType	string

Hämta en artikel

Åtgärds-ID:

RetrieveAnArticle

Returnerar artikeln med ID-värdet {id}.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Namn	Stig	Typ	Beskrivning
articleNumber	articleNumber	string
gtin	gtin	string
Id-nummer	id	string
not	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

Hämta en dunning

Åtgärds-ID:

RetrieveDunning

Returnerar dunning med ID-värdet {id}.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Dunningsid	dunningsid	True	string	Ange dunningsid.

Returnerar

Namn	Stig	Typ	Beskrivning
city	address.city	string
landskod	address.countryCode	string
name	address.name	string
gata	address.street	string
Tillägg	address.supplement	string
ZIP-fil	address.zip	string
arkiverad	archived	boolean
skapadDatum	createdDate	date-time
Id-nummer	id	uuid
Introduktion	introduction	string
Språk	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
name	lineItems.name	string
kvantitet	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
valuta	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
Id-nummer	relatedVouchers.id	uuid
voucherNumber	relatedVouchers.voucherNumber	string
voucherType	relatedVouchers.voucherType	string
anmärkning	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
valuta	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

Hämta en faktura

Åtgärds-ID:

RetrieveInvoice

Returnerar fakturan med ID-värdet {id}.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Namn	Stig	Typ	Beskrivning
city	address.city	string
landskod	address.countryCode	string
name	address.name	string
gata	address.street	string
Tillägg	address.supplement	string
ZIP-fil	address.zip	string
arkiverad	archived	boolean
skapadDatum	createdDate	date-time
Id-nummer	id	uuid
Introduktion	introduction	string
Språk	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
Id-nummer	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
name	lineItems.name	string
kvantitet	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
valuta	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
anmärkning	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
valuta	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

Hämta en faktura för handpenning

Åtgärds-ID:

RetrieveDownPaymentInvoice

Returnerar handpenningsfakturan med ID-värdet {id}.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Namn	Stig	Typ	Beskrivning
city	address.city	string
landskod	address.countryCode	string
name	address.name	string
gata	address.street	string
Tillägg	address.supplement	string
ZIP-fil	address.zip	string
arkiverad	archived	boolean
closingInvoiceId	closingInvoiceId	uuid
skapadDatum	createdDate	date-time
dueDate (på engelska)	dueDate	date-time
documentFileId	files.documentFileId	uuid
Id-nummer	id	uuid
Introduktion	introduction	string
Språk	language	string
lineItems	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
name	lineItems.name	string
kvantitet	lineItems.quantity	number
type	lineItems.type	string
valuta	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
anmärkning	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
valuta	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

Hämta en händelseprenumeration

Åtgärds-ID:

RetrieveAEventSubscription

Hämta en händelseprenumeration

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Prenumerations-ID	subscriptionId	True	string	Ange prenumerations-ID.

Returnerar

Body

EventSubscriptionResponse

Hämta en kontakt

Åtgärds-ID:

RetrieveContact

Hämta en kontakt via ID

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Namn	Stig	Typ	Beskrivning
arkiverad	archived	boolean
Id-nummer	id	string
organizationId	organizationId	string
förnamn	person.firstName	string
efternamn	person.lastName	string
hälsningsfras	person.salutation	string
nummer	roles.customer.number	integer
version	version	integer

Hämta en kreditanteckning

Åtgärds-ID:

RetrieveCreditNote

Den här slutpunkten ger läs- och skrivåtkomst till kreditanteckningar och även möjlighet att återge dokumentet som pdf för att ladda ned det. Kreditanteckningar kan skapas som ett utkast eller slutföras i öppet läge.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Namn	Stig	Typ	Beskrivning
city	address.city	string
landskod	address.countryCode	string
name	address.name	string
gata	address.street	string
Tillägg	address.supplement	string
ZIP-fil	address.zip	string
arkiverad	archived	boolean
skapadDatum	createdDate	date-time
Id-nummer	id	uuid
Introduktion	introduction	string
Språk	language	string
lineItems	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
name	lineItems.name	string
kvantitet	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
valuta	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
anmärkning	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
valuta	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

Hämta en leveransanteckning

Åtgärds-ID:

RetrieveDeliveryNote

Returnerar leveransnoten med ID-värdet {id}.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Namn	Stig	Typ	Beskrivning
city	address.city	string
landskod	address.countryCode	string
name	address.name	string
gata	address.street	string
Tillägg	address.supplement	string
ZIP-fil	address.zip	string
arkiverad	archived	boolean
skapadDatum	createdDate	date-time
deliveryTerms	deliveryTerms	string
Id-nummer	id	uuid
Introduktion	introduction	string
Språk	language	string
lineItems	lineItems	array of object
name	lineItems.name	string
kvantitet	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
valuta	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
anmärkning	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

Hämta en lista över bokföringskategorier

Åtgärds-ID:

RetrieveListPostingCategories

Den här slutpunkten ger läsåtkomst till listan över bokföringskategorier för de (bokförings) kuponger intäkter eller kostnader som stöds i lexoffice.

Returnerar

response

array of Response_posting-categories_get_items

Hämta en offert

Åtgärds-ID:

RetrieveQuotation

Returnerar offerten med ID-värdet {id}. Rendera ett citatdokument (PDF)

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Namn	Stig	Typ	Beskrivning
city	address.city	string
contactId	address.contactId	uuid
landskod	address.countryCode	string
name	address.name	string
gata	address.street	string
ZIP-fil	address.zip	string
arkiverad	archived	boolean
skapadDatum	createdDate	date-time
utgångsdatum	expirationDate	date-time
documentFileId	files.documentFileId	uuid
Id-nummer	id	uuid
Introduktion	introduction	string
Språk	language	string
lineItems	lineItems	array of object
alternativ	lineItems.alternative	boolean
discountPercentage	lineItems.discountPercentage	number
Id-nummer	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
name	lineItems.name	string
optional	lineItems.optional	boolean
kvantitet	lineItems.quantity	number
Underavdelningar	lineItems.subItems	array of object
alternativ	lineItems.subItems.alternative	boolean
discountPercentage	lineItems.subItems.discountPercentage	number
Id-nummer	lineItems.subItems.id	uuid
lineItemAmount	lineItems.subItems.lineItemAmount	number
name	lineItems.subItems.name	string
optional	lineItems.subItems.optional	boolean
kvantitet	lineItems.subItems.quantity	number
type	lineItems.subItems.type	string
unitName	lineItems.subItems.unitName	string
valuta	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
valuta	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
anmärkning	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
valuta	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

Hämta en orderbekräftelse

Åtgärds-ID:

RetrieveOrderConfirmation

Returnerar orderbekräftelsen med ID-värdet {id}.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Namn	Stig	Typ	Beskrivning
city	address.city	string
landskod	address.countryCode	string
name	address.name	string
gata	address.street	string
Tillägg	address.supplement	string
ZIP-fil	address.zip	string
arkiverad	archived	boolean
skapadDatum	createdDate	date-time
deliveryTerms	deliveryTerms	string
documentFileId	files.documentFileId	uuid
Id-nummer	id	uuid
Introduktion	introduction	string
Språk	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
Id-nummer	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
name	lineItems.name	string
kvantitet	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
valuta	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
anmärkning	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
valuta	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

Hämta en verifikation

Åtgärds-ID:

RetrieveVoucher

Visa en lista över försäljningskuponger (t.ex. fakturor, kreditanmärkningar)

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Namn	Stig	Typ	Beskrivning
skapadDatum	createdDate	date-time
dueDate (på engelska)	dueDate	date-time
files	files	array of string
Id-nummer	id	uuid
organizationId	organizationId	uuid
anmärkning	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
belopp	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Hämta en återkommande mall

Åtgärds-ID:

RetrieveRecurringTemplate

Returnerar den återkommande mallen med ID-värdet {id}.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Namn	Stig	Typ	Beskrivning
city	address.city	string
contactId	address.contactId	uuid
landskod	address.countryCode	string
name	address.name	string
gata	address.street	string
ZIP-fil	address.zip	string
arkiverad	archived	boolean
skapadDatum	createdDate	date-time
Id-nummer	id	uuid
Introduktion	introduction	string
Språk	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
name	lineItems.name	string
kvantitet	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
valuta	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
anmärkning	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
valuta	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer

Hämta lista över betalningsvillkor

Åtgärds-ID:

RetrieveListOfPaymentConditions

Följande exempel visar hur du hämtar en lista över för närvarande konfigurerade betalningsvillkor. Du måste ersätta platshållaren {accessToken} innan du skickar begäran.

Returnerar

response

array of Response_payment-conditions_get_items

Hämta lista över länder

Åtgärds-ID:

RetrieveListCountries

Lista över länder som är kända för lexoffice.

Returnerar

response

array of Response_countries_get_default

Hämta och filtrera verifikationslista

Åtgärds-ID:

RetrieveAndFilterVoucherlist

Få verifikationslista (bokföring) kuponger (t.ex. salesinvoices, salescreditnotes), fakturor (inklusive handpenningsfakturor), kreditfakturor, orderbekräftelser, offerter och leveransfakturor.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Verifikationstyp	voucherType	True	string	Ange verifikationstyp.
Verifikationsstatus	voucherStatus	True	string	Ange status för verifikationen.
Arkiverad	archived		boolean	Ange den arkiverade filen.
Kontakt Id	contactId		string	Ange kontakt-ID: t.
Kupongdatum från	voucherDateFrom		string	Ange datum för verifikationen från.
Kupongdatum till	voucherDateTo		string	Ange datum för verifikationen till.
Skapad från	createdDateFrom		string	Ange det skapade datumet från.
Skapat datum till	createdDateTo		string	Ange det skapade datumet till.
Uppdaterat datum från	updatedDateFrom		string	Ange det uppdaterade datumet från.
Uppdaterat datum till	updatedDateTo		string	Ange det uppdaterade datumet till.
Verifikationsnummer	voucherNumber		string	Ange verifikationsnumret.
Sida	page		integer	Ange sidan.
Storlek	size		integer	Ange storlek.
Sortera	sort		string	Ange sorteringen.

Returnerar

Body

Response_voucherlist_get

Hämta profilinformation

Åtgärds-ID:

RetrieveProfileInformation

Följande exempel visar hur du hämtar din grundläggande profilinformation. Du måste ersätta platshållaren {accessToken} innan du skickar begäran.

Returnerar

Body

Response_profile_get

Ladda ned en fil

Åtgärds-ID:

DownloadFile_Lexoffice

Använd den här slutpunkten för att ladda ned filer.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Fil-ID	fileId	True	string	Ange fil-ID: t.
Godkänn	Accept		string	Ange accept.

Returnerar

response

file

Ladda upp en fil

Åtgärds-ID:

UploadFile_Lexoffice

Använd den här slutpunkten för att ladda upp filer, t.ex. kuponger eller fakturor.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
File	file	True	file	Filen som ska laddas upp.
Typ	type	True	string	Beskrivning av filinnehåll.

Returnerar

Body

Response_files_post

Ladda upp en fil till en verifikation

Åtgärds-ID:

UploadFileVoucher_Lexoffice

Ladda upp och tilldela filer (pdf eller bild) till verifikationen som identifieras av {id}.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.
File	file	True	file	Filen som ska laddas upp.

Rendera ett citatdokument (PDF)

Åtgärds-ID:

RenderQuotationDocument

Om du vill ladda ned pdf-filen för ett citatdokument behöver du dess documentFileId. Det här ID:t returneras vanligtvis av offertresursen. Nyligen skapade citat i status öppen via API:et måste dock utlösa pdf-dokumentfilens återgivning separat. Detta kan göras med den här slutpunkten.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Namn	Stig	Typ	Beskrivning
documentFileId	documentFileId	uuid

Rendera ett dokument för kreditfakturor (PDF)

Åtgärds-ID:

RenderCreditNoteDocument

Om du vill ladda ned pdf-filen för ett kreditfakturadokument behöver du dess documentFileId. Det här ID:t returneras vanligtvis av kreditfaktureresursen. Nyligen skapade kreditanteckningar i status som är öppna via API:et måste dock utlösa pdf-dokumentfilens återgivning separat. Detta kan göras med den här slutpunkten.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Namn	Stig	Typ	Beskrivning
documentFileId	documentFileId	uuid

Rendera ett dokument för leveransanteckning (PDF)

Åtgärds-ID:

RenderDeliveryNoteDocument

Den här slutpunkten ger läs- och skrivåtkomst till leveransanteckningar och även möjlighet att återge dokumentet som en PDF för att ladda ned det. Leveransanteckningar skapas alltid i utkastläge och behöver inte slutföras.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Leveransnotid	DeliveryNoteid	True	string	Ange leveransnotid.

Returnerar

Namn	Stig	Typ	Beskrivning
city	address.city	string
landskod	address.countryCode	string
name	address.name	string
gata	address.street	string
Tillägg	address.supplement	string
ZIP-fil	address.zip	string
arkiverad	archived	boolean
skapadDatum	createdDate	date-time
deliveryTerms	deliveryTerms	string
Id-nummer	id	uuid
Introduktion	introduction	string
Språk	language	string
lineItems	lineItems	array of object
name	lineItems.name	string
kvantitet	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
valuta	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
anmärkning	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

Rendera ett dunning-dokument (PDF)

Åtgärds-ID:

RenderDunningDocument

Om du vill ladda ned pdf-filen för ett dunning-dokument behöver du dess documentFileId. Det här ID:t returneras vanligtvis av dunning-resursen. Nyligen skapade dunnings via API:et måste dock utlösa pdf-dokumentfilens återgivning separat. Detta kan göras med den här slutpunkten.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Dunningsid	dunningsid	True	string	Ange dunningsid.

Returnerar

Namn	Stig	Typ	Beskrivning
documentFileId	documentFileId	uuid

Rendera ett fakturadokument (PDF)

Åtgärds-ID:

RenderInvoiceDocument

Om du vill ladda ned pdf-filen för ett fakturadokument behöver du dess documentFileId. Det här ID:t returneras vanligtvis av fakturaresursen. Nyligen skapade fakturor i status öppen via API:et måste dock utlösa pdf-dokumentfilens återgivning separat. Detta kan göras med den här slutpunkten.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Namn	Stig	Typ	Beskrivning
documentFileId	documentFileId	uuid

Rendera ett orderbekräftelsedokument (PDF)

Åtgärds-ID:

RenderOrderConfirmationDocument

Om du vill ladda ned pdf-filen i ett orderbekräftelsedokument behöver du dess documentFileId. Det här ID:t returneras vanligtvis av orderbekräftelseresursen. Nyligen skapade orderbekräftelser via API:et måste dock utlösa pdf-dokumentfilens återgivning separat. Detta kan göras med den här slutpunkten.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Namn	Stig	Typ	Beskrivning
documentFileId	documentFileId	uuid

Skapa en artikel

Åtgärds-ID:

CreateArticle

Innehållet i artikeln förväntas i begärandetexten som ett program/json.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
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

Returnerar

Body

Response_articles_post

Skapa en dunning

Åtgärds-ID:

CreateDunning

Den skapade dunningen visas inte i huvudverifikationslistan i lexoffice, men kommer att bifogas till en faktura och visas där. Om du vill ge dina kunder åtkomst till den skapade dunningen använder du vår deeplink-funktion.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Föregående försäljningsverifikations-ID	precedingSalesVoucherId		string	Ange föregående försäljningsverifikations-ID.

Returnerar

Body

Response_dunnings_post

Skapa en faktura

Åtgärds-ID:

CreateInvoice

Fakturor som skickas via API:et skapas i utkastläge som standard. För att skapa en slutförd faktura med status öppen måste den valfria frågeparametern slutföras anges. Det går inte att ändra statusen för en faktura via API:et.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Föregående försäljningsverifikations-ID	precedingSalesVoucherId		string	Ange föregående försäljningsverifikations-ID.
Slutföra	finalize	True	boolean	Ange slutförande.

Returnerar

Body

Response_invoices_post

Skapa en kontakt

Åtgärds-ID:

CreateContact

Skapa en ny kontakt

Returnerar

Body

Response_contacts_post

Skapa en kreditfaktura

Åtgärds-ID:

CreateCreditNote

Kreditanteckningar som överförs via API:et skapas i utkastläge som standard. Om du vill skapa en slutförd kreditnota med status öppen måste den valfria frågeparametern slutföras anges. Det går inte att ändra statusen för en kreditfaktura via API:et

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Föregående försäljningsverifikations-ID	precedingSalesVoucherId		string	Ange föregående försäljningsverifikations-ID.
Slutföra	finalize	True	boolean	Ange slutförande.

Returnerar

Body

Response_credit-notes_post

Skapa en leveransanteckning

Åtgärds-ID:

CreateDeliveryNote

Den skapade leveransnotan visas i huvudverifikationslistan i lexoffice. Leveransanteckningar som överförs via API:et skapas endast i utkastläge.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Föregående försäljningsverifikations-ID	precedingSalesVoucherId		string	Ange föregående försäljningsverifikations-ID.

Returnerar

Body

Response_delivery-notes_post

Skapa en offert

Åtgärds-ID:

CreateQuotation

Offerter som överförs via API:et skapas i utkastläge som standard. Om du vill skapa en slutförd offert med status öppen måste den valfria frågeparametern slutföras anges. Det går inte att ändra statusen för en offert via API:et.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Slutföra	finalize	True	boolean	Ange slutförande.

Returnerar

Body

Response_quotations_post

Skapa en orderbekräftelse

Åtgärds-ID:

CreateOrderConfirmation

Den här slutpunkten ger läs- och skrivåtkomst till orderbekräftelser och även möjlighet att återge dokumentet som pdf för att ladda ned det. Orderbekräftelser skapas alltid i utkastläge och behöver inte slutföras.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Föregående försäljningsverifikations-ID	precedingSalesVoucherId		string	Ange föregående försäljningsverifikations-ID.

Returnerar

Body

Response_order-confirmations_post

Skapa en verifikation

Åtgärds-ID:

CreateVoucher

Skapa kuponger (begränsat till försäljningsverifikationer)

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
contactId	contactId		string
dueDate (på engelska)	dueDate		date
anmärkning	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
belopp	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Returnerar

Body

Response_vouchers_post

Ta bort en artikel

Åtgärds-ID:

DeleteAnArticle

Tar bort artikeln med ID-värdet {id}. Returnerar 204 vid lyckat resultat, eller 404 om ID:t inte finns.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Ta bort en Event-Subscription

Åtgärds-ID:

DeleteEventSubscription

Ta bort Utlösarwebbhook

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Prenumerations-ID	subscriptionId	True	string	Ange prenumerations-ID.

Uppdatera en artikel

Åtgärds-ID:

UpdateAnArticle

Uppdatera en befintlig artikel med ID {id} med data som anges i nyttolasten som JSON. Returnerar ett åtgärdsresultat vid lyckat resultat.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.
articleNumber	articleNumber		string	articleNumber
gtin	gtin		string	gtin
not	note		string	not
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

Returnerar

Body

Response_articles_id_get

Uppdatera en kontakt

Åtgärds-ID:

UpdateContact

Uppdatera en kontakt

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.

Returnerar

Body

Response_contacts_id_put

Uppdatera verifikation

Åtgärds-ID:

UpdateVoucher

Uppdatera en verifikation

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Id	id	True	string	Ange ID:t.
contactId	contactId		string
dueDate (på engelska)	dueDate		date
files	files		array of string	lista över utelämnande fileIds
anmärkning	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
belopp	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Returnerar

Body

Response_vouchers_id_put

Utlösare

Välj din anpassade utlösare

Registrera en ny utlösare för kontaktslutpunkten

Välj din anpassade utlösare

Åtgärds-ID:

EventSubscription_Lexoffice

Registrera en ny utlösare för kontaktslutpunkten

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Händelsetyp	eventType	True	string	eventType

Returnerar

Namn	Stig	Typ	Beskrivning
eventDate	eventDate	string	eventDate
eventType	eventType	string	eventType
organizationId	organizationId	string	organizationId
resourceId	resourceId	string	resourceId

Definitioner

EventSubscriptionResponse

Namn	Stig	Typ	Beskrivning
subscriptionId	subscriptionId	string
eventType	eventType	string
organizationId	organizationId	string
skapadDatum	createdDate	date-time
callbackUrl	callbackUrl	string

Response_articles_get

Namn	Stig	Typ	Beskrivning
innehåll	content	array of object	innehåll
articleNumber	content.articleNumber	string	articleNumber
gtin	content.gtin	string	gtin
Id-nummer	content.id	string	Id-nummer
not	content.note	string	not
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
första	first	boolean	första
sista	last	boolean	sista
nummer	number	integer	nummer
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
uppstigande	sort.ascending	boolean	uppstigande
riktning	sort.direction	string	riktning
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
fastighet / egendom	sort.property	string	fastighet / egendom
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_articles_id_get

Namn	Stig	Typ	Beskrivning
articleNumber	articleNumber	string	articleNumber
gtin	gtin	string	gtin
Id-nummer	id	string	Id-nummer
not	note	string	not
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

Namn	Stig	Typ	Beskrivning
skapadDatum	createdDate	string	skapadDatum
Id-nummer	id	string	Id-nummer
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_contacts_get

Namn	Stig	Typ	Beskrivning
innehåll	content	array of object	innehåll
fakturering	content.addresses.billing	array of object	fakturering
city	content.addresses.billing.city	string	city
landskod	content.addresses.billing.countryCode	string	landskod
gata	content.addresses.billing.street	string	gata
Tillägg	content.addresses.billing.supplement	string	Tillägg
ZIP-fil	content.addresses.billing.zip	string	ZIP-fil
frakt	content.addresses.shipping	array of object	frakt
city	content.addresses.shipping.city	string	city
landskod	content.addresses.shipping.countryCode	string	landskod
gata	content.addresses.shipping.street	string	gata
Tillägg	content.addresses.shipping.supplement	string	Tillägg
ZIP-fil	content.addresses.shipping.zip	string	ZIP-fil
arkiverad	content.archived	boolean	arkiverad
allowTaxFreeInvoices	content.company.allowTaxFreeInvoices	boolean	allowTaxFreeInvoices
contactPersons	content.company.contactPersons	array of object	contactPersons
e-postadress	content.company.contactPersons.emailAddress	string	e-postadress
förnamn	content.company.contactPersons.firstName	string	förnamn
efternamn	content.company.contactPersons.lastName	string	efternamn
primär	content.company.contactPersons.primary	boolean	primär
hälsningsfras	content.company.contactPersons.salutation	string	hälsningsfras
name	content.company.name	string	name
tax-nummer	content.company.taxNumber	string	tax-nummer
vatRegistrationId	content.company.vatRegistrationId	string	vatRegistrationId
affär	content.emailAddresses.business	array of string	affär
kontor	content.emailAddresses.office	array of string	kontor
other	content.emailAddresses.other	array of string	other
Id-nummer	content.id	string	Id-nummer
not	content.note	string	not
organizationId	content.organizationId	string	organizationId
affär	content.phoneNumbers.business	array of string	affär
fax	content.phoneNumbers.fax	array of string	fax
kontor	content.phoneNumbers.office	array of string	kontor
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
första	first	boolean	första
sista	last	boolean	sista
nummer	number	integer	nummer
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
uppstigande	sort.ascending	boolean	uppstigande
riktning	sort.direction	string	riktning
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
fastighet / egendom	sort.property	string	fastighet / egendom
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_contacts_post

Namn	Stig	Typ	Beskrivning
skapadDatum	createdDate	string	skapadDatum
Id-nummer	id	string	Id-nummer
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_countries_get_default

Namn	Stig	Typ	Beskrivning
landskod	countryCode	string	landskod
countryNameDE	countryNameDE	string	countryNameDE
countryNameEN	countryNameEN	string	countryNameEN
taxClassification	taxClassification	string	taxClassification

Response_credit-notes_post

Namn	Stig	Typ	Beskrivning
skapadDatum	createdDate	string	skapadDatum
Id-nummer	id	string	Id-nummer
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_delivery-notes_post

Namn	Stig	Typ	Beskrivning
skapadDatum	createdDate	string	skapadDatum
Id-nummer	id	string	Id-nummer
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_dunnings_post

Namn	Stig	Typ	Beskrivning
skapadDatum	createdDate	string	skapadDatum
Id-nummer	id	string	Id-nummer
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_event-subscriptions_get

Namn	Stig	Typ	Beskrivning
innehåll	content	array of object	innehåll
callbackUrl	content.callbackUrl	string	callbackUrl
skapadDatum	content.createdDate	string	skapadDatum
eventType	content.eventType	string	eventType
organizationId	content.organizationId	string	organizationId
subscriptionId	content.subscriptionId	string	subscriptionId

Response_files_post

Namn	Stig	Typ	Beskrivning
Id-nummer	id	string	Id-nummer

Response_invoices_post

Namn	Stig	Typ	Beskrivning
skapadDatum	createdDate	string	skapadDatum
Id-nummer	id	string	Id-nummer
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_order-confirmations_post

Namn	Stig	Typ	Beskrivning
skapadDatum	createdDate	string	skapadDatum
Id-nummer	id	string	Id-nummer
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_payment-conditions_get_items

Namn	Stig	Typ	Beskrivning
Id-nummer	id	string	Id-nummer
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

Namn	Stig	Typ	Beskrivning
contactRequired	contactRequired	boolean	contactRequired
groupName	groupName	string	groupName
Id-nummer	id	string	Id-nummer
name	name	string	name
splitAllowed	splitAllowed	boolean	splitAllowed
type	type	string	type

Response_profile_get

Namn	Stig	Typ	Beskrivning
businessFeatures	businessFeatures	array of string	businessFeatures
companyName	companyName	string	companyName
connectionId	connectionId	string	connectionId
date	created.date	string	date
användareEmail	created.userEmail	string	användareEmail
userId	created.userId	string	userId
användarnamn	created.userName	string	användarnamn
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

Namn	Stig	Typ	Beskrivning
skapadDatum	createdDate	string	skapadDatum
Id-nummer	id	string	Id-nummer
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_recurring-templates_get

Namn	Stig	Typ	Beskrivning
innehåll	content	array of object	innehåll
contactId	content.address.contactId	string	contactId
name	content.address.name	string	name
skapadDatum	content.createdDate	string	skapadDatum
Id-nummer	content.id	string	Id-nummer
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
slutdatum	content.recurringTemplateSettings.endDate	string	slutdatum
executionInterval	content.recurringTemplateSettings.executionInterval	string	executionInterval
executionStatus	content.recurringTemplateSettings.executionStatus	string	executionStatus
Slutföra	content.recurringTemplateSettings.finalize	boolean	Slutföra
Id-nummer	content.recurringTemplateSettings.id	string	Id-nummer
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
valuta	content.totalPrice.currency	string	valuta
totalGrossAmount	content.totalPrice.totalGrossAmount	integer	totalGrossAmount
totalNetAmount	content.totalPrice.totalNetAmount	float	totalNetAmount
updatedDate	content.updatedDate	string	updatedDate
första	first	boolean	första
sista	last	boolean	sista
nummer	number	integer	nummer
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
uppstigande	sort.ascending	boolean	uppstigande
riktning	sort.direction	string	riktning
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
fastighet / egendom	sort.property	string	fastighet / egendom
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_voucherlist_get

Namn	Stig	Typ	Beskrivning
innehåll	content	array of object	innehåll
arkiverad	content.archived	boolean	arkiverad
contactId	content.contactId	string	contactId
contactName (kontaktnamn)	content.contactName	string	contactName (kontaktnamn)
skapadDatum	content.createdDate	string	skapadDatum
valuta	content.currency	string	valuta
dueDate (på engelska)	content.dueDate	string	dueDate (på engelska)
Id-nummer	content.id	string	Id-nummer
openAmount	content.openAmount	float	openAmount
totalbelopp	content.totalAmount	float	totalbelopp
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
första	first	boolean	första
sista	last	boolean	sista
nummer	number	integer	nummer
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
uppstigande	sort.ascending	boolean	uppstigande
riktning	sort.direction	string	riktning
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
fastighet / egendom	sort.property	string	fastighet / egendom
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_vouchers_post

Namn	Stig	Typ	Beskrivning
skapadDatum	createdDate	string	skapadDatum
Id-nummer	id	string	Id-nummer
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_contacts_id_put

Namn	Stig	Typ	Beskrivning
arkiverad	archived	boolean
Id-nummer	id	uuid
organizationId	organizationId	uuid
förnamn	person.firstName	string
efternamn	person.lastName	string
hälsningsfras	person.salutation	string
nummer	roles.customer.number	integer
version	version	integer

Response_vouchers_id_put

Namn	Stig	Typ	Beskrivning
skapadDatum	createdDate	date-time
dueDate (på engelska)	dueDate	date-time
files	files	array of object
items	files	object
Id-nummer	id	uuid
organizationId	organizationId	uuid
anmärkning	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
belopp	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

fil

Det här är den grundläggande datatypen "fil".