Lexoffice (független kiadó) (előzetes verzió)

A Lexware API programozott hozzáférést biztosít a Lexware alapvető üzleti funkcióihoz, például cikkekhez, névjegyekhez, számlákhoz, megrendelésekhez és fájlkezeléshez. Ez a Független Közzétevő-összekötő biztonságos integrációt tesz lehetővé a Lexware REST API-jával, lehetővé téve a felhasználók számára az üzleti adatok létrehozását és lekérését, a folyamatok automatizálását és a Lexware-erőforrások Power Platform-alkalmazásokkal való összekapcsolását. Az összekötő az OAuth 2.0 engedélyezési kódfolyamatot használja a biztonságos hitelesítéshez és az API-irányelvekhez.

Ez az összekötő a következő termékekben és régiókban érhető el:

Service	Class	Régiók
Copilot Studio	prémium	Az összes Power Automate-régió, kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Logikai alkalmazások	Standard	Az összes Logic Apps-régió , kivéve a következőket:      - Azure Government-régiók      - Azure China-régiók      - Amerikai Védelmi Minisztérium (DoD)
Power Alkalmazások	prémium	Az összes Power Apps-régió , kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Power Automate	prémium	Az összes Power Automate-régió, kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)

Érintkezés
Név	LowCode-vizsgáló támogatása
URL	https://lowcode-investigator.com/
Email	kontakt@lowcodeinvestigator.com

Összekötő metaadatai
Kiadó	LowCodeInvestigator
Webhely	https://office.lexware.de/
Adatvédelmi irányelvek	https://office.lexware.de/datenschutz/
Kategóriák	Üzletvezetés; Pénzügy

Lexware API-összekötő (független közzétevő)

A Lexware API egy RESTful felület, amellyel a fejlesztők a Lexware üzleti funkcióit, például névjegyeket, számlákat, cikkeket és fájlokat integrálhatják saját alkalmazásaikba. Ez az összekötő biztonságos, hitelesített API-kérésekkel teszi lehetővé az erőforrásokkal való közvetlen interakciót.

Kiadó: Független kiadó

Előfeltételek

• Regisztrált Lexware-fiók és megfelelő licenc
• Érvényes API-kulcs (hozzáférési jogkivonat) a Lexware fejlesztői portálon keresztül
• A hitelesítéshez OAuth 2.0 engedélyezési kódfolyamat szükséges

Támogatott műveletek

Ez az összekötő a következő Lexware API-végpontokat támogatja:

• Cikkek: Cikkek létrehozása, lekérése, frissítése, törlése és szűrése
• Névjegyek: Ügyfél- és szállítóadatok kezelése
• Számlák: Számlaadatok létrehozása és lekérése, beleértve a PDF-fájlok megjelenítését is
• Jóváírási jegyzetek, szállítólevelek, rendelések, árajánlatok és utalványok
• Országok, fizetési feltételek, nyomtatási elrendezések és profilok
• Esemény-előfizetések és -fájlok
• Teljes lista dokumentálva: Lexware API Docs

Hitelesítő adatok beszerzése

A Lexware API meghívásához api-kulcsra van szükség:

1. Jelentkezzen be Lexware Office-fiókjába.
2. Nyissa meg a Bővítmények → a Weitere Apps → nyilvános API-t , vagy nyissa meg
   Lexware Fejlesztői portál közvetlenül.
3. Hozzon létre egy új API-kulcsot a kívánt engedélyekkel.
4. Másolja ki a létrehozott API-kulcsot. Ez az érték az összekötőhöz hasonlóan accessToken lesz használva.

API-átjáró

Használja az új Lexware API-átjárót:

https://api.lexware.io

Sebességkorlátok

• Legfeljebb 2 kérelem/másodperc
• A korlátot meghaladó kérések HTTP-t kapnak 429 Too Many Requests
• Ajánlott: Jogkivonat gyűjtőalgoritmusának vagy exponenciális visszalépésének használata

Authentication

A Lexware API OAuth 2.0 engedélyezési kódfolyamatot használ. Adja meg a jogkivonatot az Authorization: Bearer {accessToken} egyes kérések fejlécében.

Használati példa

Cikk létrehozása:

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

Ismert problémák és korlátozások

• Legfeljebb 2 kérelem/másodperc
• Egyes végpontok további engedélyeket vagy szerepköröket igényelnek

API-dokumentáció

A teljes API-referencia a következő címen érhető el:
https://developers.lexware.io/docs/

Kapcsolat létrehozása

Az összekötő a következő hitelesítési típusokat támogatja:

Alapértelmezett	A kapcsolat létrehozásának paraméterei.	Minden régió	Nem osztható meg

Alapértelmezett

Alkalmazható: Minden régió

A kapcsolat létrehozásának paraméterei.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Név	Típus	Description	Kötelező
API-kulcs	securestring	Az API API-kulcsa	True

Szabályozási korlátok

Name	Hívások	Megújítási időszak
API-hívások kapcsolatonként	100	60 másodperc

Műveletek

Az összes esemény-előfizetés lekérése	Az összes esemény-előfizetés lekérése
Az összes ismétlődő sablon lekérése	Ismétlődő sablonok gyűjteményének lekérése. Az eredmény csak egy részét adja vissza a legrelevánsabb adatoknak, amelyek a hivatkozott partner (csak azonosító és név), a teljes ár, a fizetési feltételek és a teljes ismétlődő sablonbeállítások. Az objektumok és tulajdonságok elnevezése azonban megegyezik.
Az összes partner lekérése	Az összes partner lekérése
Bizonylat frissítése	Utalvány frissítése
Bizonylatlista lekérése és szűrése	Szerezze be az utalványlistát (könyvelési) bizonylatokat (pl. salesinvoices, salescreditnotes), számlákat (beleértve az előlegszámlákat), a jóváírási jegyzeteket, a megrendelés visszaigazolásait, az árajánlatokat és a szállítási jegyzeteket.
Cikk frissítése	Frissítsen egy meglévő cikket {id} azonosítóval a hasznos adatban megadott adatokkal JSON-ként. Sikeres műveleteredményt ad vissza.
Cikk lekérése	A(z) {id} azonosítójú cikket adja vissza.
Cikk létrehozása	A cikk tartalma várhatóan alkalmazásként/jsonként szerepel a kérelem törzsében.
Cikk törlése	Törli a(z) {id} azonosítójú cikket. 204-et ad eredményül, vagy ha az azonosító nem létezik, akkor a 404-et.
Cikkek szűrése	Azokat a cikkeket adja vissza, amelyek megfelelnek a szűrők által megadott feltételeknek, filter_1 filter_n lapozási mechanizmus használatával. Ha egynél több szűrőt ad meg, a logikai összekötő az AND. A nem beállított szűrők figyelmen kívül lesznek hagyva. A végpont maximális oldalméretének ellenőrzéséhez tekintse meg az Erőforrások lapozása című témakört.
Down Payment Invoice lekérése	A(z) {id} azonosítójú előlegszámlát adja vissza.
Dunning-dokumentum renderelése (PDF)	A dokumentum pdf-fájljának letöltéséhez a documentFileId fájlra van szüksége. Ezt az azonosítót általában a dunning erőforrás adja vissza. Az API-val újonnan létrehozott dunningoknak azonban külön kell aktiválnia a pdf-dokumentumfájl renderelését. Ez ezzel a végponttal is elvégezhető.
Dunning lekérése	A(z) {id} azonosítójú dunning értékét adja vissza.
Dunning létrehozása	A létrehozott dunning nem jelenik meg a lexoffice fő utalványlistájában, hanem egy számlához lesz csatolva, és ott látható lesz. Ha hozzáférést szeretne biztosítani ügyfeleinek a létrehozott dunninghoz, használja a deeplink függvényt.
Esemény-előfizetés lekérése	Esemény-előfizetés lekérése
Event-Subscription törlése	Trigger WebHook törlése
Fizetési adatok lekérése	A fizetési végpont olvasási hozzáférést biztosít a (könyvelési vagy értékesítési) bizonylatok fizetési állapotához, beleértve a számlákat és a jóváírásokat.
Fizetési feltételek listájának lekérése	Az alábbi minta bemutatja, hogyan kérhető le a jelenleg konfigurált fizetési feltételek listája. A kérés elküldése előtt le kell cserélni a helyőrzőt ({accessToken}).
Fájl feltöltése	Ezzel a végponttal feltölthet fájlokat, például utalványokat vagy számlákat.
Fájl feltöltése utalványba	Fájlok (pdf vagy kép) feltöltése és hozzárendelése a(z) {id} által azonosított utalványhoz.
Fájl letöltése	Használja ezt a végpontot fájlok letöltéséhez.
Idéző dokumentum megjelenítése (PDF)	Egy idéződokumentum pdf-fájljának letöltéséhez a documentFileId fájlra van szüksége. Ezt az azonosítót általában az idézőerőforrás adja vissza. Az API-val megnyitott állapotú újonnan létrehozott idézeteknek azonban külön kell aktiválnia a pdf-dokumentumfájl renderelését. Ez ezzel a végponttal is elvégezhető.
Ismétlődő sablon lekérése	A(z) {id} azonosítójú ismétlődő sablont adja vissza.
Jóváírás lekérése	Ez a végpont olvasási és írási hozzáférést biztosít a kreditjegyzetekhez, valamint lehetővé teszi a dokumentum PDF formátumban való megjelenítését a letöltéshez. A kreditjegyzetek piszkozatként hozhatók létre, vagy nyílt módban véglegesíthetők.
Jóváírási jegyzet dokumentumának renderelése (PDF)	Egy kreditjegyzet-dokumentum pdf-fájljának letöltéséhez a documentFileId fájlra van szüksége. Ezt az azonosítót általában a kreditjegyzet-erőforrás adja vissza. Az API-val megnyitott állapotú újonnan létrehozott kreditjegyzeteknek azonban külön kell aktiválnia a pdf-dokumentumfájl renderelését. Ez ezzel a végponttal is elvégezhető.
Jóváírási megjegyzés létrehozása	Az API-val továbbított kreditjegyzetek alapértelmezés szerint piszkozat módban jönnek létre. Ha véglegesített kreditjegyzetet szeretne létrehozni állapottal, meg kell adnia az opcionális lekérdezési paraméter véglegesítését. A kreditjegy állapota nem módosítható az API-val
Kézbesítési megjegyzés dokumentumának renderelése (PDF)	Ez a végpont olvasási és írási hozzáférést biztosít a kézbesítési jegyzetekhez, valamint lehetővé teszi a dokumentum PDF formátumban való megjelenítését a letöltéshez. A kézbesítési jegyzetek mindig piszkozat módban jönnek létre, és nem kell véglegesíteni.
Kézbesítési megjegyzés lekérése	A(z) {id} azonosítójú kézbesítési megjegyzést adja vissza.
Kézbesítési megjegyzés létrehozása	A létrehozott kézbesítési megjegyzés megjelenik a lexoffice fő utalványlistájában. Az API-val továbbított kézbesítési jegyzetek csak piszkozat módban jönnek létre.
Könyvelési kategóriák listájának lekérése	Ez a végpont olvasási hozzáférést biztosít a (könyvelési) bizonylatok bevételének vagy költségeinek könyvelési kategóriáinak listájához, amelyeket a lexoffice támogat.
Megrendelés visszaigazolásának lekérése	A rendelés visszaigazolását {id} azonosítóval adja vissza.
Megrendelés visszaigazolásának létrehozása	Ez a végpont olvasási és írási hozzáférést biztosít a megrendelések megerősítéséhez, valamint lehetővé teszi a dokumentum PDF formátumban való megjelenítését a letöltéshez. A megrendelés visszaigazolása mindig piszkozat módban jön létre, és nem kell véglegesíteni.
Megrendelést visszaigazoló dokumentum megjelenítése (PDF)	A megrendelést visszaigazoló dokumentum pdf-fájljának letöltéséhez a documentFileId fájlra van szüksége. Ezt az azonosítót általában a rendelést visszaigazoló erőforrás adja vissza. Az API-val újonnan létrehozott megrendelés-visszaigazolásoknak azonban külön kell aktiválnia a pdf-dokumentumfájl renderelését. Ez ezzel a végponttal is elvégezhető.
Országok listájának lekérése	A lexoffice-ról ismert országok listája.
Partner frissítése	Névjegy frissítése
Partner lekérése	Partner lekérése azonosító alapján
Partner létrehozása	Új partner létrehozása
Profiladatok lekérése	Az alábbi minta bemutatja, hogyan kérhető le az alapvető profiladatok. A kérés elküldése előtt le kell cserélni a helyőrzőt ({accessToken}).
Számla lekérése	A(z) {id} azonosítójú számlát adja vissza.
Számla létrehozása	Az API-val továbbított számlák alapértelmezés szerint piszkozat módban jönnek létre. Ha véglegesített számlát szeretne létrehozni állapottal, meg kell adni az opcionális lekérdezési paraméter véglegesítését. A számla állapota nem módosítható az API-val.
Számladokumentum megjelenítése (PDF)	A számladokumentum pdf-fájljának letöltéséhez a documentFileId fájlra van szükség. Ezt az azonosítót általában a számlaerőforrás adja vissza. Az API-val megnyitott állapotú újonnan létrehozott számláknak azonban külön kell aktiválnia a pdf-dokumentumfájl renderelését. Ez ezzel a végponttal is elvégezhető.
Utalvány lekérése	Értékesítési bizonylatok (például számlák, jóváírások) listázása
Utalvány létrehozása	Utalványok létrehozása (csak értékesítési utalványokra korlátozva)
Árajánlat lekérése	A(z) {id} azonosítójú idézőjelet adja vissza. Idéző dokumentum megjelenítése (PDF)
Árajánlat létrehozása	Az API-val továbbított idézetek alapértelmezés szerint piszkozat módban jönnek létre. Ha véglegesített árajánlatot szeretne létrehozni állapottal, meg kell adnia az opcionális lekérdezési paraméter véglegesítését. Az ajánlat állapota nem módosítható az API-val.

Az összes esemény-előfizetés lekérése

Műveletazonosító:

RetrieveAllEventSubscriptions

Az összes esemény-előfizetés lekérése

Válaszok

Törzs

Response_event-subscriptions_get

Az összes ismétlődő sablon lekérése

Műveletazonosító:

RetrieveAllRecurringTemplates

Ismétlődő sablonok gyűjteményének lekérése. Az eredmény csak egy részét adja vissza a legrelevánsabb adatoknak, amelyek a hivatkozott partner (csak azonosító és név), a teljes ár, a fizetési feltételek és a teljes ismétlődő sablonbeállítások. Az objektumok és tulajdonságok elnevezése azonban megegyezik.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Oldal	page		integer	Adja meg a lapot.
Méret	size		integer	Adja meg a méretet.
Fajta	sort		string	Adja meg a rendezést.

Válaszok

Törzs

Response_recurring-templates_get

Az összes partner lekérése

Műveletazonosító:

RetrieveAllContacts

Az összes partner lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Szám	number		integer	Adja meg a számot.
Email	email		string	Adja meg az e-mailt.
Név	name		string	Adja meg a nevet.
Beszállító	vendor		boolean	Adja meg a szállítót.
Ügyfél	customer		boolean	Adja meg az ügyfelet.
Oldal	page		integer	Adja meg a lapot.
Méret	size		integer	Adja meg a méretet.
Fajta	sort		string	Adja meg a rendezést.

Válaszok

Törzs

Response_contacts_get

Bizonylat frissítése

Műveletazonosító:

UpdateVoucher

Utalvány frissítése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.
contactId	contactId		string
esedékesség dátuma	dueDate		date
files	files		array of string	kihagyott fájlazonosítók listája
megjegyzés	remark		string
shippingDate	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
típus	type	True	string
useCollectiveContact	useCollectiveContact		boolean
verzió	version		integer
voucherDate	voucherDate		date
mennyiség	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Válaszok

Törzs

Response_vouchers_id_put

Bizonylatlista lekérése és szűrése

Műveletazonosító:

RetrieveAndFilterVoucherlist

Szerezze be az utalványlistát (könyvelési) bizonylatokat (pl. salesinvoices, salescreditnotes), számlákat (beleértve az előlegszámlákat), a jóváírási jegyzeteket, a megrendelés visszaigazolásait, az árajánlatokat és a szállítási jegyzeteket.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Utalvány típusa	voucherType	True	string	Adja meg a bizonylat típusát.
Utalvány állapota	voucherStatus	True	string	Adja meg az utalvány állapotát.
Archivált	archived		boolean	Adja meg az archivált fájlt.
Kapcsolattartó azonosító	contactId		string	Adja meg a partner azonosítóját.
Utalvány dátuma innen:	voucherDateFrom		string	Adja meg a bizonylat dátumát.
Bizonylat dátuma	voucherDateTo		string	Adja meg a bizonylat dátumát.
Létrehozás dátuma:	createdDateFrom		string	Adja meg a létrehozott dátumot.
Létrehozás dátuma	createdDateTo		string	Adja meg a létrehozandó dátumot.
Dátum frissítése innen:	updatedDateFrom		string	Adja meg a frissített dátumot.
Frissítve a dátum	updatedDateTo		string	Adja meg a frissített dátumot.
Utalvány száma	voucherNumber		string	Adja meg az utalvány számát.
Oldal	page		integer	Adja meg a lapot.
Méret	size		integer	Adja meg a méretet.
Fajta	sort		string	Adja meg a rendezést.

Válaszok

Törzs

Response_voucherlist_get

Cikk frissítése

Műveletazonosító:

UpdateAnArticle

Frissítsen egy meglévő cikket {id} azonosítóval a hasznos adatban megadott adatokkal JSON-ként. Sikeres műveleteredményt ad vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.
articleNumber	articleNumber		string	articleNumber
gtin	gtin		string	gtin
jegyzet	note		string	jegyzet
bruttó ár	grossPrice	True	float	bruttó ár
leadingPrice	leadingPrice	True	string	leadingPrice
netPrice	netPrice	True	float	netPrice
taxRate	taxRate		float	taxRate
title	title		string	title
típus	type	True	string	típus
unitName	unitName	True	string	unitName
verzió	version	True	integer	verzió

Válaszok

Törzs

Response_articles_id_get

Cikk lekérése

Műveletazonosító:

RetrieveAnArticle

A(z) {id} azonosítójú cikket adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Name	Elérési út	Típus	Description
articleNumber	articleNumber	string
gtin	gtin	string
azonosító	id	string
jegyzet	note	string
bruttó ár	price.grossPrice	float
leadingPrice	price.leadingPrice	string
netPrice	price.netPrice	float
taxRate	price.taxRate	float
title	title	string
típus	type	string
unitName	unitName	string
verzió	version	integer

Cikk létrehozása

Műveletazonosító:

CreateArticle

A cikk tartalma várhatóan alkalmazásként/jsonként szerepel a kérelem törzsében.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
articleNumber	articleNumber		string	articleNumber
bruttó ár	grossPrice		float	bruttó ár
leadingPrice	leadingPrice		string	leadingPrice
netPrice	netPrice		float	netPrice
taxRate	taxRate		float	taxRate
title	title		string	title
típus	type		string	típus
unitName	unitName		string	unitName

Válaszok

Törzs

Response_articles_post

Cikk törlése

Műveletazonosító:

DeleteAnArticle

Törli a(z) {id} azonosítójú cikket. 204-et ad eredményül, vagy ha az azonosító nem létezik, akkor a 404-et.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Cikkek szűrése

Műveletazonosító:

FilteringArticles

Azokat a cikkeket adja vissza, amelyek megfelelnek a szűrők által megadott feltételeknek, filter_1 filter_n lapozási mechanizmus használatával. Ha egynél több szűrőt ad meg, a logikai összekötő az AND. A nem beállított szűrők figyelmen kívül lesznek hagyva. A végpont maximális oldalméretének ellenőrzéséhez tekintse meg az Erőforrások lapozása című témakört.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Cikkszám	articleNumber		string	Adja meg a cikk számát.
Gtin	gtin		string	Adja meg a gtin értéket.
Típus	type		string	Adja meg a típust.
Oldal	page		integer	Adja meg a lapot.
Méret	size		integer	Adja meg a méretet.
Fajta	sort		string	Adja meg a rendezést.

Válaszok

Törzs

Response_articles_get

Down Payment Invoice lekérése

Műveletazonosító:

RetrieveDownPaymentInvoice

A(z) {id} azonosítójú előlegszámlát adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Name	Elérési út	Típus	Description
city	address.city	string
országkód	address.countryCode	string
név	address.name	string
utca	address.street	string
Kiegészítő	address.supplement	string
zip fájl	address.zip	string
Archivált	archived	boolean
closingInvoiceId	closingInvoiceId	uuid
létrehozás dátuma	createdDate	date-time
esedékesség dátuma	dueDate	date-time
documentFileId	files.documentFileId	uuid
azonosító	id	uuid
Bevezetés	introduction	string
nyelv	language	string
lineItems	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
név	lineItems.name	string
mennyiség	lineItems.quantity	number
típus	lineItems.type	string
pénznem	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
megjegyzés	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
pénznem	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
verzió	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Dunning-dokumentum renderelése (PDF)

Műveletazonosító:

RenderDunningDocument

A dokumentum pdf-fájljának letöltéséhez a documentFileId fájlra van szüksége. Ezt az azonosítót általában a dunning erőforrás adja vissza. Az API-val újonnan létrehozott dunningoknak azonban külön kell aktiválnia a pdf-dokumentumfájl renderelését. Ez ezzel a végponttal is elvégezhető.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dunningsid	dunningsid	True	string	Adja meg a dunningsid azonosítót.

Válaszok

Name	Elérési út	Típus	Description
documentFileId	documentFileId	uuid

Dunning lekérése

Műveletazonosító:

RetrieveDunning

A(z) {id} azonosítójú dunning értékét adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dunningsid	dunningsid	True	string	Adja meg a dunningsid azonosítót.

Válaszok

Name	Elérési út	Típus	Description
city	address.city	string
országkód	address.countryCode	string
név	address.name	string
utca	address.street	string
Kiegészítő	address.supplement	string
zip fájl	address.zip	string
Archivált	archived	boolean
létrehozás dátuma	createdDate	date-time
azonosító	id	uuid
Bevezetés	introduction	string
nyelv	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
név	lineItems.name	string
mennyiség	lineItems.quantity	number
típus	lineItems.type	string
unitName	lineItems.unitName	string
pénznem	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
azonosító	relatedVouchers.id	uuid
voucherNumber	relatedVouchers.voucherNumber	string
voucherType	relatedVouchers.voucherType	string
megjegyzés	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
pénznem	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
verzió	version	integer
voucherDate	voucherDate	date-time
voucherStatus	voucherStatus	string

Dunning létrehozása

Műveletazonosító:

CreateDunning

A létrehozott dunning nem jelenik meg a lexoffice fő utalványlistájában, hanem egy számlához lesz csatolva, és ott látható lesz. Ha hozzáférést szeretne biztosítani ügyfeleinek a létrehozott dunninghoz, használja a deeplink függvényt.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Előző értékesítési bizonylat azonosítója	precedingSalesVoucherId		string	Adja meg az előző értékesítési bizonylat azonosítóját.

Válaszok

Törzs

Response_dunnings_post

Esemény-előfizetés lekérése

Műveletazonosító:

RetrieveAEventSubscription

Esemény-előfizetés lekérése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Előfizetés azonosítója	subscriptionId	True	string	Adja meg az előfizetés azonosítóját.

Válaszok

Törzs

EventSubscriptionResponse

Event-Subscription törlése

Műveletazonosító:

DeleteEventSubscription

Trigger WebHook törlése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Előfizetés azonosítója	subscriptionId	True	string	Adja meg az előfizetés azonosítóját.

Fizetési adatok lekérése

Műveletazonosító:

RetrievePaymentInformation

A fizetési végpont olvasási hozzáférést biztosít a (könyvelési vagy értékesítési) bizonylatok fizetési állapotához, beleértve a számlákat és a jóváírásokat.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Utalvány azonosítója	voucherId	True	string	Adja meg az utalvány azonosítóját.

Válaszok

Name	Elérési út	Típus	Description
pénznem	currency	string
openAmount	openAmount	string
paymentItems	paymentItems	array of object
mennyiség	paymentItems.amount	float
pénznem	paymentItems.currency	string
paymentItemType	paymentItems.paymentItemType	string
postingDate	paymentItems.postingDate	date-time
fizetési állapot	paymentStatus	string
voucherStatus	voucherStatus	string
voucherType	voucherType	string

Fizetési feltételek listájának lekérése

Műveletazonosító:

RetrieveListOfPaymentConditions

Az alábbi minta bemutatja, hogyan kérhető le a jelenleg konfigurált fizetési feltételek listája. A kérés elküldése előtt le kell cserélni a helyőrzőt ({accessToken}).

Válaszok

response

array of Response_payment-conditions_get_items

Fájl feltöltése

Műveletazonosító:

UploadFile_Lexoffice

Ezzel a végponttal feltölthet fájlokat, például utalványokat vagy számlákat.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
File	file	True	file	A feltöltendő fájl.
Típus	type	True	string	A fájl tartalmának leírása.

Válaszok

Törzs

Response_files_post

Fájl feltöltése utalványba

Műveletazonosító:

UploadFileVoucher_Lexoffice

Fájlok (pdf vagy kép) feltöltése és hozzárendelése a(z) {id} által azonosított utalványhoz.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.
File	file	True	file	A feltöltendő fájl.

Fájl letöltése

Műveletazonosító:

DownloadFile_Lexoffice

Használja ezt a végpontot fájlok letöltéséhez.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fájlazonosító	fileId	True	string	Adja meg a fájlazonosítót.
Elfogadás	Accept		string	Adja meg az elfogadást.

Válaszok

response

file

Idéző dokumentum megjelenítése (PDF)

Műveletazonosító:

RenderQuotationDocument

Egy idéződokumentum pdf-fájljának letöltéséhez a documentFileId fájlra van szüksége. Ezt az azonosítót általában az idézőerőforrás adja vissza. Az API-val megnyitott állapotú újonnan létrehozott idézeteknek azonban külön kell aktiválnia a pdf-dokumentumfájl renderelését. Ez ezzel a végponttal is elvégezhető.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Name	Elérési út	Típus	Description
documentFileId	documentFileId	uuid

Ismétlődő sablon lekérése

Műveletazonosító:

RetrieveRecurringTemplate

A(z) {id} azonosítójú ismétlődő sablont adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Name	Elérési út	Típus	Description
city	address.city	string
contactId	address.contactId	uuid
országkód	address.countryCode	string
név	address.name	string
utca	address.street	string
zip fájl	address.zip	string
Archivált	archived	boolean
létrehozás dátuma	createdDate	date-time
azonosító	id	uuid
Bevezetés	introduction	string
nyelv	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
név	lineItems.name	string
mennyiség	lineItems.quantity	number
típus	lineItems.type	string
unitName	lineItems.unitName	string
pénznem	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
megjegyzés	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
pénznem	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
verzió	version	integer

Jóváírás lekérése

Műveletazonosító:

RetrieveCreditNote

Ez a végpont olvasási és írási hozzáférést biztosít a kreditjegyzetekhez, valamint lehetővé teszi a dokumentum PDF formátumban való megjelenítését a letöltéshez. A kreditjegyzetek piszkozatként hozhatók létre, vagy nyílt módban véglegesíthetők.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Name	Elérési út	Típus	Description
city	address.city	string
országkód	address.countryCode	string
név	address.name	string
utca	address.street	string
Kiegészítő	address.supplement	string
zip fájl	address.zip	string
Archivált	archived	boolean
létrehozás dátuma	createdDate	date-time
azonosító	id	uuid
Bevezetés	introduction	string
nyelv	language	string
lineItems	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
név	lineItems.name	string
mennyiség	lineItems.quantity	number
típus	lineItems.type	string
unitName	lineItems.unitName	string
pénznem	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
megjegyzés	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
pénznem	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	float
totalNetAmount	totalPrice.totalNetAmount	float
totalTaxAmount	totalPrice.totalTaxAmount	float
updatedDate	updatedDate	date-time
verzió	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Jóváírási jegyzet dokumentumának renderelése (PDF)

Műveletazonosító:

RenderCreditNoteDocument

Egy kreditjegyzet-dokumentum pdf-fájljának letöltéséhez a documentFileId fájlra van szüksége. Ezt az azonosítót általában a kreditjegyzet-erőforrás adja vissza. Az API-val megnyitott állapotú újonnan létrehozott kreditjegyzeteknek azonban külön kell aktiválnia a pdf-dokumentumfájl renderelését. Ez ezzel a végponttal is elvégezhető.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Name	Elérési út	Típus	Description
documentFileId	documentFileId	uuid

Jóváírási megjegyzés létrehozása

Műveletazonosító:

CreateCreditNote

Az API-val továbbított kreditjegyzetek alapértelmezés szerint piszkozat módban jönnek létre. Ha véglegesített kreditjegyzetet szeretne létrehozni állapottal, meg kell adnia az opcionális lekérdezési paraméter véglegesítését. A kreditjegy állapota nem módosítható az API-val

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Előző értékesítési bizonylat azonosítója	precedingSalesVoucherId		string	Adja meg az előző értékesítési bizonylat azonosítóját.
Véglegesít	finalize	True	boolean	Adja meg a véglegesítést.

Válaszok

Törzs

Response_credit-notes_post

Kézbesítési megjegyzés dokumentumának renderelése (PDF)

Műveletazonosító:

RenderDeliveryNoteDocument

Ez a végpont olvasási és írási hozzáférést biztosít a kézbesítési jegyzetekhez, valamint lehetővé teszi a dokumentum PDF formátumban való megjelenítését a letöltéshez. A kézbesítési jegyzetek mindig piszkozat módban jönnek létre, és nem kell véglegesíteni.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Kézbesítési Noteid	DeliveryNoteid	True	string	Adja meg a kézbesítési noteid azonosítót.

Válaszok

Name	Elérési út	Típus	Description
city	address.city	string
országkód	address.countryCode	string
név	address.name	string
utca	address.street	string
Kiegészítő	address.supplement	string
zip fájl	address.zip	string
Archivált	archived	boolean
létrehozás dátuma	createdDate	date-time
deliveryTerms	deliveryTerms	string
azonosító	id	uuid
Bevezetés	introduction	string
nyelv	language	string
lineItems	lineItems	array of object
név	lineItems.name	string
mennyiség	lineItems.quantity	number
típus	lineItems.type	string
unitName	lineItems.unitName	string
pénznem	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
megjegyzés	remark	string
taxType	taxConditions.taxType	string
title	title	string
updatedDate	updatedDate	date-time
verzió	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Kézbesítési megjegyzés lekérése

Műveletazonosító:

RetrieveDeliveryNote

A(z) {id} azonosítójú kézbesítési megjegyzést adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Name	Elérési út	Típus	Description
city	address.city	string
országkód	address.countryCode	string
név	address.name	string
utca	address.street	string
Kiegészítő	address.supplement	string
zip fájl	address.zip	string
Archivált	archived	boolean
létrehozás dátuma	createdDate	date-time
deliveryTerms	deliveryTerms	string
azonosító	id	uuid
Bevezetés	introduction	string
nyelv	language	string
lineItems	lineItems	array of object
név	lineItems.name	string
mennyiség	lineItems.quantity	number
típus	lineItems.type	string
unitName	lineItems.unitName	string
pénznem	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
megjegyzés	remark	string
taxType	taxConditions.taxType	string
title	title	string
updatedDate	updatedDate	date-time
verzió	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Kézbesítési megjegyzés létrehozása

Műveletazonosító:

CreateDeliveryNote

A létrehozott kézbesítési megjegyzés megjelenik a lexoffice fő utalványlistájában. Az API-val továbbított kézbesítési jegyzetek csak piszkozat módban jönnek létre.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Előző értékesítési bizonylat azonosítója	precedingSalesVoucherId		string	Adja meg az előző értékesítési bizonylat azonosítóját.

Válaszok

Törzs

Response_delivery-notes_post

Könyvelési kategóriák listájának lekérése

Műveletazonosító:

RetrieveListPostingCategories

Ez a végpont olvasási hozzáférést biztosít a (könyvelési) bizonylatok bevételének vagy költségeinek könyvelési kategóriáinak listájához, amelyeket a lexoffice támogat.

Válaszok

response

array of Response_posting-categories_get_items

Megrendelés visszaigazolásának lekérése

Műveletazonosító:

RetrieveOrderConfirmation

A rendelés visszaigazolását {id} azonosítóval adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Name	Elérési út	Típus	Description
city	address.city	string
országkód	address.countryCode	string
név	address.name	string
utca	address.street	string
Kiegészítő	address.supplement	string
zip fájl	address.zip	string
Archivált	archived	boolean
létrehozás dátuma	createdDate	date-time
deliveryTerms	deliveryTerms	string
documentFileId	files.documentFileId	uuid
azonosító	id	uuid
Bevezetés	introduction	string
nyelv	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
azonosító	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
név	lineItems.name	string
mennyiség	lineItems.quantity	number
típus	lineItems.type	string
unitName	lineItems.unitName	string
pénznem	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
megjegyzés	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
pénznem	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
verzió	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Megrendelés visszaigazolásának létrehozása

Műveletazonosító:

CreateOrderConfirmation

Ez a végpont olvasási és írási hozzáférést biztosít a megrendelések megerősítéséhez, valamint lehetővé teszi a dokumentum PDF formátumban való megjelenítését a letöltéshez. A megrendelés visszaigazolása mindig piszkozat módban jön létre, és nem kell véglegesíteni.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Előző értékesítési bizonylat azonosítója	precedingSalesVoucherId		string	Adja meg az előző értékesítési bizonylat azonosítóját.

Válaszok

Törzs

Response_order-confirmations_post

Megrendelést visszaigazoló dokumentum megjelenítése (PDF)

Műveletazonosító:

RenderOrderConfirmationDocument

A megrendelést visszaigazoló dokumentum pdf-fájljának letöltéséhez a documentFileId fájlra van szüksége. Ezt az azonosítót általában a rendelést visszaigazoló erőforrás adja vissza. Az API-val újonnan létrehozott megrendelés-visszaigazolásoknak azonban külön kell aktiválnia a pdf-dokumentumfájl renderelését. Ez ezzel a végponttal is elvégezhető.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Name	Elérési út	Típus	Description
documentFileId	documentFileId	uuid

Országok listájának lekérése

Műveletazonosító:

RetrieveListCountries

A lexoffice-ról ismert országok listája.

Válaszok

response

array of Response_countries_get_default

Partner frissítése

Műveletazonosító:

UpdateContact

Névjegy frissítése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Törzs

Response_contacts_id_put

Partner lekérése

Műveletazonosító:

RetrieveContact

Partner lekérése azonosító alapján

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Name	Elérési út	Típus	Description
Archivált	archived	boolean
azonosító	id	string
organizationId	organizationId	string
keresztnév	person.firstName	string
lastName	person.lastName	string
köszöntés	person.salutation	string
szám	roles.customer.number	integer
verzió	version	integer

Partner létrehozása

Műveletazonosító:

CreateContact

Új partner létrehozása

Válaszok

Törzs

Response_contacts_post

Profiladatok lekérése

Műveletazonosító:

RetrieveProfileInformation

Az alábbi minta bemutatja, hogyan kérhető le az alapvető profiladatok. A kérés elküldése előtt le kell cserélni a helyőrzőt ({accessToken}).

Válaszok

Törzs

Response_profile_get

Számla lekérése

Műveletazonosító:

RetrieveInvoice

A(z) {id} azonosítójú számlát adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Name	Elérési út	Típus	Description
city	address.city	string
országkód	address.countryCode	string
név	address.name	string
utca	address.street	string
Kiegészítő	address.supplement	string
zip fájl	address.zip	string
Archivált	archived	boolean
létrehozás dátuma	createdDate	date-time
azonosító	id	uuid
Bevezetés	introduction	string
nyelv	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
azonosító	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
név	lineItems.name	string
mennyiség	lineItems.quantity	number
típus	lineItems.type	string
unitName	lineItems.unitName	string
pénznem	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
megjegyzés	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
pénznem	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
verzió	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Számla létrehozása

Műveletazonosító:

CreateInvoice

Az API-val továbbított számlák alapértelmezés szerint piszkozat módban jönnek létre. Ha véglegesített számlát szeretne létrehozni állapottal, meg kell adni az opcionális lekérdezési paraméter véglegesítését. A számla állapota nem módosítható az API-val.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Előző értékesítési bizonylat azonosítója	precedingSalesVoucherId		string	Adja meg az előző értékesítési bizonylat azonosítóját.
Véglegesít	finalize	True	boolean	Adja meg a véglegesítést.

Válaszok

Törzs

Response_invoices_post

Számladokumentum megjelenítése (PDF)

Műveletazonosító:

RenderInvoiceDocument

A számladokumentum pdf-fájljának letöltéséhez a documentFileId fájlra van szükség. Ezt az azonosítót általában a számlaerőforrás adja vissza. Az API-val megnyitott állapotú újonnan létrehozott számláknak azonban külön kell aktiválnia a pdf-dokumentumfájl renderelését. Ez ezzel a végponttal is elvégezhető.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Name	Elérési út	Típus	Description
documentFileId	documentFileId	uuid

Utalvány lekérése

Műveletazonosító:

RetrieveVoucher

Értékesítési bizonylatok (például számlák, jóváírások) listázása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Name	Elérési út	Típus	Description
létrehozás dátuma	createdDate	date-time
esedékesség dátuma	dueDate	date-time
files	files	array of string
azonosító	id	uuid
organizationId	organizationId	uuid
megjegyzés	remark	string
shippingDate	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
típus	type	string
updatedDate	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
verzió	version	integer
voucherDate	voucherDate	date-time
voucherItems	voucherItems	array of object
mennyiség	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Utalvány létrehozása

Műveletazonosító:

CreateVoucher

Utalványok létrehozása (csak értékesítési utalványokra korlátozva)

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
contactId	contactId		string
esedékesség dátuma	dueDate		date
megjegyzés	remark		string
shippingDate	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
típus	type	True	string
useCollectiveContact	useCollectiveContact		boolean
voucherDate	voucherDate		date
mennyiség	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Válaszok

Törzs

Response_vouchers_post

Árajánlat lekérése

Műveletazonosító:

RetrieveQuotation

A(z) {id} azonosítójú idézőjelet adja vissza. Idéző dokumentum megjelenítése (PDF)

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Azonosító	id	True	string	Adja meg az azonosítót.

Válaszok

Name	Elérési út	Típus	Description
city	address.city	string
contactId	address.contactId	uuid
országkód	address.countryCode	string
név	address.name	string
utca	address.street	string
zip fájl	address.zip	string
Archivált	archived	boolean
létrehozás dátuma	createdDate	date-time
lejárati dátum	expirationDate	date-time
documentFileId	files.documentFileId	uuid
azonosító	id	uuid
Bevezetés	introduction	string
nyelv	language	string
lineItems	lineItems	array of object
alternatív	lineItems.alternative	boolean
discountPercentage	lineItems.discountPercentage	number
azonosító	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
név	lineItems.name	string
optional	lineItems.optional	boolean
mennyiség	lineItems.quantity	number
alelemek	lineItems.subItems	array of object
alternatív	lineItems.subItems.alternative	boolean
discountPercentage	lineItems.subItems.discountPercentage	number
azonosító	lineItems.subItems.id	uuid
lineItemAmount	lineItems.subItems.lineItemAmount	number
név	lineItems.subItems.name	string
optional	lineItems.subItems.optional	boolean
mennyiség	lineItems.subItems.quantity	number
típus	lineItems.subItems.type	string
unitName	lineItems.subItems.unitName	string
pénznem	lineItems.subItems.unitPrice.currency	string
grossAmount	lineItems.subItems.unitPrice.grossAmount	number
netAmount	lineItems.subItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.subItems.unitPrice.taxRatePercentage	number
típus	lineItems.type	string
unitName	lineItems.unitName	string
pénznem	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
megjegyzés	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
pénznem	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
verzió	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Árajánlat létrehozása

Műveletazonosító:

CreateQuotation

Az API-val továbbított idézetek alapértelmezés szerint piszkozat módban jönnek létre. Ha véglegesített árajánlatot szeretne létrehozni állapottal, meg kell adnia az opcionális lekérdezési paraméter véglegesítését. Az ajánlat állapota nem módosítható az API-val.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Véglegesít	finalize	True	boolean	Adja meg a véglegesítést.

Válaszok

Törzs

Response_quotations_post

Triggerek

Válassza ki az egyéni eseményindítót

Új eseményindító regisztrálása a névjegyek végpontjához

Válassza ki az egyéni eseményindítót

Műveletazonosító:

EventSubscription_Lexoffice

Új eseményindító regisztrálása a névjegyek végpontjához

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Esemény típusa	eventType	True	string	eventType

Válaszok

Name	Elérési út	Típus	Description
eventDate	eventDate	string	eventDate
eventType	eventType	string	eventType
organizationId	organizationId	string	organizationId
resourceId	resourceId	string	resourceId

Definíciók

EventSubscriptionResponse

Name	Elérési út	Típus	Description
subscriptionId	subscriptionId	string
eventType	eventType	string
organizationId	organizationId	string
létrehozás dátuma	createdDate	date-time
visszahívási URL-cím	callbackUrl	string

Response_articles_get

Name	Elérési út	Típus	Description
tartalom	content	array of object	tartalom
articleNumber	content.articleNumber	string	articleNumber
gtin	content.gtin	string	gtin
azonosító	content.id	string	azonosító
jegyzet	content.note	string	jegyzet
bruttó ár	content.price.grossPrice	float	bruttó ár
leadingPrice	content.price.leadingPrice	string	leadingPrice
netPrice	content.price.netPrice	float	netPrice
taxRate	content.price.taxRate	float	taxRate
title	content.title	string	title
típus	content.type	string	típus
unitName	content.unitName	string	unitName
verzió	content.version	integer	verzió
első	first	boolean	első
utolsó	last	boolean	utolsó
szám	number	integer	szám
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
rendez	sort	array of object	rendez
Növekvő	sort.ascending	boolean	Növekvő
irány	sort.direction	string	irány
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
tulajdonság	sort.property	string	tulajdonság
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_articles_id_get

Name	Elérési út	Típus	Description
articleNumber	articleNumber	string	articleNumber
gtin	gtin	string	gtin
azonosító	id	string	azonosító
jegyzet	note	string	jegyzet
bruttó ár	price.grossPrice	float	bruttó ár
leadingPrice	price.leadingPrice	string	leadingPrice
netPrice	price.netPrice	float	netPrice
taxRate	price.taxRate	float	taxRate
title	title	string	title
típus	type	string	típus
unitName	unitName	string	unitName
verzió	version	integer	verzió

Response_articles_post

Name	Elérési út	Típus	Description
létrehozás dátuma	createdDate	string	létrehozás dátuma
azonosító	id	string	azonosító
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verzió	version	integer	verzió

Response_contacts_get

Name	Elérési út	Típus	Description
tartalom	content	array of object	tartalom
számlázási	content.addresses.billing	array of object	számlázási
city	content.addresses.billing.city	string	city
országkód	content.addresses.billing.countryCode	string	országkód
utca	content.addresses.billing.street	string	utca
Kiegészítő	content.addresses.billing.supplement	string	Kiegészítő
zip fájl	content.addresses.billing.zip	string	zip fájl
szállítás	content.addresses.shipping	array of object	szállítás
city	content.addresses.shipping.city	string	city
országkód	content.addresses.shipping.countryCode	string	országkód
utca	content.addresses.shipping.street	string	utca
Kiegészítő	content.addresses.shipping.supplement	string	Kiegészítő
zip fájl	content.addresses.shipping.zip	string	zip fájl
Archivált	content.archived	boolean	Archivált
allowTaxFreeInvoices	content.company.allowTaxFreeInvoices	boolean	allowTaxFreeInvoices
contactPersons	content.company.contactPersons	array of object	contactPersons
email cím	content.company.contactPersons.emailAddress	string	email cím
keresztnév	content.company.contactPersons.firstName	string	keresztnév
lastName	content.company.contactPersons.lastName	string	lastName
elsődleges	content.company.contactPersons.primary	boolean	elsődleges
köszöntés	content.company.contactPersons.salutation	string	köszöntés
név	content.company.name	string	név
adószám	content.company.taxNumber	string	adószám
vatRegistrationId	content.company.vatRegistrationId	string	vatRegistrationId
üzlet	content.emailAddresses.business	array of string	üzlet
iroda	content.emailAddresses.office	array of string	iroda
other	content.emailAddresses.other	array of string	other
azonosító	content.id	string	azonosító
jegyzet	content.note	string	jegyzet
organizationId	content.organizationId	string	organizationId
üzlet	content.phoneNumbers.business	array of string	üzlet
fax	content.phoneNumbers.fax	array of string	fax
iroda	content.phoneNumbers.office	array of string	iroda
other	content.phoneNumbers.other	array of string	other
szám	content.roles.customer.number	integer	szám
szám	content.roles.vendor.number	integer	szám
verzió	content.version	integer	verzió
első	first	boolean	első
utolsó	last	boolean	utolsó
szám	number	integer	szám
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
rendez	sort	array of object	rendez
Növekvő	sort.ascending	boolean	Növekvő
irány	sort.direction	string	irány
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
tulajdonság	sort.property	string	tulajdonság
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_contacts_post

Name	Elérési út	Típus	Description
létrehozás dátuma	createdDate	string	létrehozás dátuma
azonosító	id	string	azonosító
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verzió	version	integer	verzió

Response_countries_get_default

Name	Elérési út	Típus	Description
országkód	countryCode	string	országkód
countryNameDE	countryNameDE	string	countryNameDE
countryNameEN	countryNameEN	string	countryNameEN
taxClassification	taxClassification	string	taxClassification

Response_credit-notes_post

Name	Elérési út	Típus	Description
létrehozás dátuma	createdDate	string	létrehozás dátuma
azonosító	id	string	azonosító
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verzió	version	integer	verzió

Response_delivery-notes_post

Name	Elérési út	Típus	Description
létrehozás dátuma	createdDate	string	létrehozás dátuma
azonosító	id	string	azonosító
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verzió	version	integer	verzió

Response_dunnings_post

Name	Elérési út	Típus	Description
létrehozás dátuma	createdDate	string	létrehozás dátuma
azonosító	id	string	azonosító
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verzió	version	integer	verzió

Response_event-subscriptions_get

Name	Elérési út	Típus	Description
tartalom	content	array of object	tartalom
visszahívási URL-cím	content.callbackUrl	string	visszahívási URL-cím
létrehozás dátuma	content.createdDate	string	létrehozás dátuma
eventType	content.eventType	string	eventType
organizationId	content.organizationId	string	organizationId
subscriptionId	content.subscriptionId	string	subscriptionId

Response_files_post

Name	Elérési út	Típus	Description
azonosító	id	string	azonosító

Response_invoices_post

Name	Elérési út	Típus	Description
létrehozás dátuma	createdDate	string	létrehozás dátuma
azonosító	id	string	azonosító
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verzió	version	integer	verzió

Response_order-confirmations_post

Name	Elérési út	Típus	Description
létrehozás dátuma	createdDate	string	létrehozás dátuma
azonosító	id	string	azonosító
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verzió	version	integer	verzió

Response_payment-conditions_get_items

Name	Elérési út	Típus	Description
azonosító	id	string	azonosító
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	Elérési út	Típus	Description
contactRequired	contactRequired	boolean	contactRequired
groupName	groupName	string	groupName
azonosító	id	string	azonosító
név	name	string	név
splitAllowed	splitAllowed	boolean	splitAllowed
típus	type	string	típus

Response_profile_get

Name	Elérési út	Típus	Description
businessFeatures	businessFeatures	array of string	businessFeatures
companyName	companyName	string	companyName
connectionId	connectionId	string	connectionId
date	created.date	string	date
userEmail	created.userEmail	string	userEmail
userId	created.userId	string	userId
Felhasználónév	created.userName	string	Felhasználónév
features	features	array of string	features
organizationId	organizationId	string	organizationId
Smallbusiness	smallBusiness	boolean	Smallbusiness
előfizetés állapota	subscriptionStatus	string	előfizetés állapota
taxType	taxType	string	taxType

Response_quotations_post

Name	Elérési út	Típus	Description
létrehozás dátuma	createdDate	string	létrehozás dátuma
azonosító	id	string	azonosító
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verzió	version	integer	verzió

Response_recurring-templates_get

Name	Elérési út	Típus	Description
tartalom	content	array of object	tartalom
contactId	content.address.contactId	string	contactId
név	content.address.name	string	név
létrehozás dátuma	content.createdDate	string	létrehozás dátuma
azonosító	content.id	string	azonosító
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
befejezési dátum	content.recurringTemplateSettings.endDate	string	befejezési dátum
executionInterval	content.recurringTemplateSettings.executionInterval	string	executionInterval
executionStatus	content.recurringTemplateSettings.executionStatus	string	executionStatus
Véglegesítse	content.recurringTemplateSettings.finalize	boolean	Véglegesítse
azonosító	content.recurringTemplateSettings.id	string	azonosító
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
pénznem	content.totalPrice.currency	string	pénznem
totalGrossAmount	content.totalPrice.totalGrossAmount	integer	totalGrossAmount
totalNetAmount	content.totalPrice.totalNetAmount	float	totalNetAmount
updatedDate	content.updatedDate	string	updatedDate
első	first	boolean	első
utolsó	last	boolean	utolsó
szám	number	integer	szám
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
rendez	sort	array of object	rendez
Növekvő	sort.ascending	boolean	Növekvő
irány	sort.direction	string	irány
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
tulajdonság	sort.property	string	tulajdonság
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_voucherlist_get

Name	Elérési út	Típus	Description
tartalom	content	array of object	tartalom
Archivált	content.archived	boolean	Archivált
contactId	content.contactId	string	contactId
kapcsolatnév	content.contactName	string	kapcsolatnév
létrehozás dátuma	content.createdDate	string	létrehozás dátuma
pénznem	content.currency	string	pénznem
esedékesség dátuma	content.dueDate	string	esedékesség dátuma
azonosító	content.id	string	azonosító
openAmount	content.openAmount	float	openAmount
összeg	content.totalAmount	float	összeg
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
első	first	boolean	első
utolsó	last	boolean	utolsó
szám	number	integer	szám
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
rendez	sort	array of object	rendez
Növekvő	sort.ascending	boolean	Növekvő
irány	sort.direction	string	irány
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
tulajdonság	sort.property	string	tulajdonság
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_vouchers_post

Name	Elérési út	Típus	Description
létrehozás dátuma	createdDate	string	létrehozás dátuma
azonosító	id	string	azonosító
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verzió	version	integer	verzió

Response_contacts_id_put

Name	Elérési út	Típus	Description
Archivált	archived	boolean
azonosító	id	uuid
organizationId	organizationId	uuid
keresztnév	person.firstName	string
lastName	person.lastName	string
köszöntés	person.salutation	string
szám	roles.customer.number	integer
verzió	version	integer

Response_vouchers_id_put

Name	Elérési út	Típus	Description
létrehozás dátuma	createdDate	date-time
esedékesség dátuma	dueDate	date-time
files	files	array of object
items	files	object
azonosító	id	uuid
organizationId	organizationId	uuid
megjegyzés	remark	string
shippingDate	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
típus	type	string
updatedDate	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
verzió	version	integer
voucherDate	voucherDate	date-time
voucherItems	voucherItems	array of object
mennyiség	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

fájl

Ez a fájl alapszintű adattípusa.