Lexoffice (nezávislý vydavatel) (Preview)

Rozhraní Lexware API poskytuje programový přístup k základním obchodním funkcím Lexware, jako jsou články, kontakty, faktury, objednávky a správa souborů. Tento nezávislý konektor publisheru umožňuje zabezpečenou integraci s rozhraním REST API lexwaru a umožňuje uživatelům vytvářet a načítat obchodní data, automatizovat procesy a připojovat prostředky Lexware s aplikacemi Power Platform. Konektor používá tok autorizačního kódu OAuth 2.0 pro zabezpečené ověřování a pokyny k rozhraní API.

Tento konektor je dostupný v následujících produktech a oblastech:

Service	Class	Regions
Copilot Studio	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Logic Apps	Standard	Všechny oblasti Logic Apps s výjimkou následujících:      – Oblasti Azure Government      – Oblasti Azure China      - Ministerstvo obrany USA (DoD)
Power Apps	Premium	Všechny oblasti Power Apps s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Power Automate	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)

Kontakt
Název	Podpora vyšetřovatelů LowCode
URL	https://lowcode-investigator.com/
Email	kontakt@lowcodeinvestigator.com

Metadata konektoru
Vydavatel	LowCodeInvestigator
Internetová stránka	https://office.lexware.de/
Zásady ochrany osobních údajů	https://office.lexware.de/datenschutz/
Kategorie	Řízení podniku; Finance

Konektor rozhraní LEXWARE API (nezávislý vydavatel)

Rozhraní Lexware API je rozhraní RESTful, které vývojářům umožňuje integrovat obchodní funkce Lexware, jako jsou kontakty, faktury, články a soubory do vlastních aplikací. Tento konektor umožňuje přímou interakci s těmito prostředky prostřednictvím zabezpečených a ověřených požadavků rozhraní API.

Vydavatel: Nezávislý vydavatel

Požadavky

• Registrovaný účet Lexware a správná licence
• Platný klíč rozhraní API (přístupový token) získaný prostřednictvím portálu pro vývojáře Lexware
• Tok autorizačního kódu OAuth 2.0 se vyžaduje pro ověřování.

Podporované operace

Tento konektor podporuje následující koncové body rozhraní Lexware API:

• Články: Vytváření, načítání, aktualizace, odstraňování a filtrování článků
• Kontakty: Správa dat zákazníků a dodavatelů
• Faktury: Vytváření a načítání dat faktur, včetně vykreslování souborů PDF
• Dobropisy, dodací poznámky, objednávky, nabídky a poukázky
• Země, platební podmínky, rozložení tisku a profily
• Odběry a soubory událostí
• Úplný seznam zdokumentovaný na webu: Dokumentace k rozhraní API Lexware

Získání přihlašovacích údajů

K volání rozhraní Lexware API potřebujete klíč rozhraní API:

1. Přihlaste se ke svému účtu Lexware Office.
2. Přejděte na Rozšíření → Aplikace Weitere → veřejné rozhraní API nebo otevřete
   Portál pro vývojáře Lexware přímo.
3. Vytvořte nový klíč rozhraní API s požadovanými oprávněními.
4. Zkopírujte vygenerovaný klíč rozhraní API. Tato hodnota se použije jako accessToken v konektoru.

Brána rozhraní API

Použijte novou bránu rozhraní Lexware API:

https://api.lexware.io

Omezení rychlosti

• Maximálně 2 požadavky za sekundu
• Požadavky překračující tento limit přijímají http 429 Too Many Requests
• Doporučeno: Použití algoritmu kbelíku tokenů nebo exponenciálního zpožnění

Autentizace

Rozhraní Lexware API používá tok autorizačního kódu OAuth 2.0. Zahrňte token do Authorization: Bearer {accessToken} hlavičky každého požadavku.

Příklad použití

Vytvoření článku:

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

Známé problémy a omezení

• Maximálně 2 požadavky za sekundu
• Některé koncové body vyžadují další oprávnění nebo role.

Dokumentace API

Úplné referenční informace k rozhraní API jsou k dispozici na adrese:
https://developers.lexware.io/docs/

Vytvoření připojení

Konektor podporuje následující typy ověřování:

výchozí	Parametry pro vytvoření připojení	Všechny oblasti	Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Název	Typ	Description	Povinné
Klíč rozhraní API	securestring	Klíč rozhraní API pro toto rozhraní API	Pravdivé

Limity omezování

Name	Volání	Období obnovení
Volání rozhraní API na připojení	100	60 sekund

Akce

Aktualizace kontaktu	Aktualizace kontaktu
Aktualizace článku	Aktualizujte existující článek s ID {id} daty zadanými v datové části jako JSON. Vrátí výsledek akce při úspěchu.
Aktualizovat poukázku	Aktualizace poukázky
Filtrování článků	Vrátí články, které splňují kritéria zadaná filtry, filter_1 filter_n pomocí mechanismu stránkování. Pokud je zadaný více než jeden filtr, logický konektor je AND. Filtry, které nejsou nastavené, se ignorují. Pokud chcete zkontrolovat maximální velikost stránky pro tento koncový bod, přečtěte si téma Stránkování prostředků.
Nahrání souboru	Tento koncový bod použijte k nahrání souborů, např. poukázek nebo faktur.
Nahrání souboru do poukázky	Nahrajte a přiřaďte soubory (pdf nebo obrázek) k dokladu identifikovanému uživatelem {id}.
Načtení a filtrování seznamu poukázek	Získejte poukázky na poukázky (např. salesinvoices, salescreditnotes), faktury (včetně faktur za platbu), dobropisy, potvrzení objednávky, nabídky a dodací poznámky.
Načtení dobropisu	Tento koncový bod poskytuje přístup ke čtení a zápisu k kreditním poznámkám a také možnost vykreslit dokument jako PDF, aby si ho bylo možné stáhnout. Poznámky k kreditu je možné vytvořit jako koncept nebo finalizovat v otevřeném režimu.
Načtení dunningu	Vrátí dunning s hodnotou ID {id}.
Načtení faktury	Vrátí fakturu s hodnotou ID {id}.
Načtení faktury za platbu po splatnosti	Vrátí fakturu za platbu po splatnosti s hodnotou ID {id}.
Načtení informací o profilu	Následující ukázka ukazuje, jak načíst základní informace o profilu. Před odesláním požadavku je nutné nahradit zástupný symbol {accessToken}.
Načtení kontaktu	Načtení kontaktu podle ID
Načtení nabídky	Vrátí uvozovku s hodnotou ID {id}. Vykreslení uvozovek (PDF)
Načtení odběru událostí	Načtení odběru událostí
Načtení opakované šablony	Vrátí opakující se šablonu s hodnotou ID {id}.
Načtení platebních údajů	Koncový bod plateb poskytuje přístup pro čtení ke stavu platby (účetnictví nebo prodeje) poukázek, včetně faktur a dobropisů.
Načtení potvrzení objednávky	Vrátí potvrzení objednávky s hodnotou ID {id}.
Načtení poukázky	Výpis prodejních poukázek (např. faktury, dobropisy)
Načtení poznámky k doručení	Vrátí poznámku k doručení s hodnotou ID {id}.
Načtení seznamu kategorií účtování	Tento koncový bod poskytuje přístup pro čtení k seznamu kategorií účtování pro výnosy nebo výdaje (účetní) poukázky nebo výdaje, které jsou podporovány v lexoffice.
Načtení seznamu platebních podmínek	Následující ukázka ukazuje, jak načíst seznam aktuálně nakonfigurovaných platebních podmínek. Před odesláním požadavku je nutné nahradit zástupný symbol {accessToken}.
Načtení seznamu zemí	Seznam zemí známých lexoffice.
Načtení všech kontaktů	Načtení všech kontaktů
Načtení všech odběrů událostí	Načtení všech odběrů událostí
Načtení všech opakovaných šablon	Načte kolekci opakujících se šablon. Výsledek vrátí jenom část nejrelevavantnějších dat, která jsou odkazovaným kontaktem (pouze ID a jméno), celkovou cenu, platební podmínky a kompletní nastavení opakujících se šablon. Pojmenování objektů a vlastností je však stejné.
Načtení článku	Vrátí článek s hodnotou ID {id}.
Odstranění Event-Subscription	Odstranění webhooku triggeru
Odstranění článku	Odstraní článek s hodnotou ID {id}. Vrátí hodnotu 204 při úspěchu nebo 404, pokud ID neexistuje.
Potvrzení vytvoření objednávky	Tento koncový bod poskytuje přístup pro čtení a zápis k potvrzení objednávky a také možnost vykreslit dokument jako PDF, aby si ho bylo možné stáhnout. Potvrzení objednávek se vždy vytvářejí v režimu konceptu a není nutné je finalizovat.
Stažení souboru	Pomocí tohoto koncového bodu můžete stahovat soubory.
Vykreslení dokumentu dobropisu (PDF)	Chcete-li stáhnout soubor PDF dokumentu dobropisu, potřebujete jeho documentFileId. Toto ID obvykle vrací prostředek dobropisu. Nově vytvořené platební poznámky ve stavu otevřené prostřednictvím rozhraní API však musí aktivovat vykreslování souboru dokumentu PDF samostatně. To se dá provést pomocí tohoto koncového bodu.
Vykreslení dokumentu faktury (PDF)	Pokud chcete stáhnout soubor PDF dokumentu faktury, potřebujete jeho documentFileId. Toto ID obvykle vrací prostředek faktury. Nově vytvořené faktury ve stavu otevřené prostřednictvím rozhraní API však musí aktivovat vykreslování souboru dokumentu PDF samostatně. To se dá provést pomocí tohoto koncového bodu.
Vykreslení dokumentu potvrzení objednávky (PDF)	Pokud chcete stáhnout soubor PDF dokumentu potvrzení objednávky, potřebujete jeho documentFileId. Toto ID obvykle vrací prostředek potvrzení objednávky. Nově vytvořené potvrzení objednávek prostřednictvím rozhraní API však musí aktivovat vykreslování souboru pdf dokumentu samostatně. To se dá provést pomocí tohoto koncového bodu.
Vykreslení dokumentu s poznámkou k doručení (PDF)	Tento koncový bod poskytuje přístup ke čtení a zápisu doručovacím poznámkám a také možnost vykreslit dokument jako PDF, aby si ho bylo možné stáhnout. Poznámky k doručení se vždy vytvářejí v režimu konceptu a není nutné je finalizovat.
Vykreslení duplicitního dokumentu (PDF)	Pokud chcete stáhnout pdf soubor dunning dokumentu, potřebujete jeho documentFileId. Toto ID obvykle vrací dunning prostředku. Nově vytvořené dunningy prostřednictvím rozhraní API však musí aktivovat vykreslování souboru dokumentu PDF samostatně. To se dá provést pomocí tohoto koncového bodu.
Vykreslení uvozovek (PDF)	Pokud chcete stáhnout soubor PDF uvozovek, potřebujete jeho documentFileId. Toto ID je obvykle vráceno uvozovkami. Nově vytvořené uvozovky ve stavu otevřené prostřednictvím rozhraní API však musí aktivovat vykreslování souboru dokumentu PDF samostatně. To se dá provést pomocí tohoto koncového bodu.
Vytvoření dobropisu	Poznámky k kreditu přenášené přes rozhraní API se vytvářejí v režimu konceptu podle výchozího nastavení. Pokud chcete vytvořit finalizovanou poznámku kreditu se stavem, musí být nastaven volitelný parametr dotazu finalizace. Stav poznámky k kreditu nelze změnit prostřednictvím rozhraní API.
Vytvoření dunningu	Vytvořené dunning se nezobrazí v hlavním seznamu poukázek v lexoffice, ale bude připojen k faktuře a bude tam viditelné. Pokud chcete svým zákazníkům poskytnout přístup k vytvořenému dunningu, použijte naši funkci deeplinku.
Vytvoření faktury	Faktury přenášené přes rozhraní API se vytvářejí v režimu konceptu podle výchozího nastavení. Pokud chcete vytvořit finalizovanou fakturu se stavem, je potřeba nastavit volitelný parametr dotazu. Stav faktury nejde změnit prostřednictvím rozhraní API.
Vytvoření kontaktu	Vytvoření nového kontaktu
Vytvoření nabídky	Uvozovky přenášené prostřednictvím rozhraní API se vytvářejí v režimu konceptu podle výchozího nastavení. Pokud chcete vytvořit finalizovanou uvozovku se stavem, je nutné nastavit volitelný parametr dotazu. Stav uvozovek nelze změnit prostřednictvím rozhraní API.
Vytvoření poukázky	Vytváření poukázek (omezeno na prodejní poukázky)
Vytvoření poznámky k doručení	Vytvořené oznámení o doručení se zobrazí v hlavním seznamu poukázek v lexoffice. Poznámky k doručení přenášené prostřednictvím rozhraní API se vytvářejí pouze v režimu konceptu.
Vytvoření článku	Obsah článku se očekává v textu požadavku jako application/json.

Aktualizace kontaktu

ID operace:

UpdateContact

Aktualizace kontaktu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Body

Response_contacts_id_put

Aktualizace článku

ID operace:

UpdateAnArticle

Aktualizujte existující článek s ID {id} daty zadanými v datové části jako JSON. Vrátí výsledek akce při úspěchu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.
articleNumber	articleNumber		string	articleNumber
gtin	gtin		string	gtin
poznámka	note		string	poznámka
grossPrice	grossPrice	True	float	grossPrice
leadingPrice	leadingPrice	True	string	leadingPrice
netPrice	netPrice	True	float	netPrice
taxRate	taxRate		float	taxRate
title	title		string	title
typ	type	True	string	typ
unitName	unitName	True	string	unitName
verze	version	True	integer	verze

Návraty

Body

Response_articles_id_get

Aktualizovat poukázku

ID operace:

UpdateVoucher

Aktualizace poukázky

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.
contactId	contactId		string
splatné datum	dueDate		date
files	files		array of string	seznam vynechaných ID souborů
komentář	remark		string
shippingDate	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
typ	type	True	string
useCollectiveContact	useCollectiveContact		boolean
verze	version		integer
voucherDate	voucherDate		date
částky	amount		float
categoryId (Id kategorie)	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Návraty

Body

Response_vouchers_id_put

Filtrování článků

ID operace:

FilteringArticles

Vrátí články, které splňují kritéria zadaná filtry, filter_1 filter_n pomocí mechanismu stránkování. Pokud je zadaný více než jeden filtr, logický konektor je AND. Filtry, které nejsou nastavené, se ignorují. Pokud chcete zkontrolovat maximální velikost stránky pro tento koncový bod, přečtěte si téma Stránkování prostředků.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Číslo článku	articleNumber		string	Zadejte číslo článku.
Gtin	gtin		string	Zadejte hodnotu gtin.
Typ	type		string	Zadejte typ.
Stránka	page		integer	Zadejte stránku.
Velikost	size		integer	Zadejte velikost.
Seřadit	sort		string	Zadejte řazení.

Návraty

Body

Response_articles_get

Nahrání souboru

ID operace:

UploadFile_Lexoffice

Tento koncový bod použijte k nahrání souborů, např. poukázek nebo faktur.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
File	file	True	file	Soubor, který chcete nahrát.
Typ	type	True	string	Popis obsahu souboru

Návraty

Body

Response_files_post

Nahrání souboru do poukázky

ID operace:

UploadFileVoucher_Lexoffice

Nahrajte a přiřaďte soubory (pdf nebo obrázek) k dokladu identifikovanému uživatelem {id}.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.
File	file	True	file	Soubor, který chcete nahrát.

Načtení a filtrování seznamu poukázek

ID operace:

RetrieveAndFilterVoucherlist

Získejte poukázky na poukázky (např. salesinvoices, salescreditnotes), faktury (včetně faktur za platbu), dobropisy, potvrzení objednávky, nabídky a dodací poznámky.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Typ poukázky	voucherType	True	string	Zadejte typ poukázky.
Stav poukázky	voucherStatus	True	string	Zadejte stav poukázky.
Archivovaný	archived		boolean	Zadejte archivovaný.
ID kontaktu	contactId		string	Zadejte ID kontaktu.
Datum poukázky od	voucherDateFrom		string	Zadejte datum poukázky od.
Datum poukázky na	voucherDateTo		string	Zadejte datum poukázky.
Datum vytvoření od	createdDateFrom		string	Zadejte datum vytvoření.
Datum vytvoření do	createdDateTo		string	Zadejte datum vytvoření.
Datum aktualizace od	updatedDateFrom		string	Zadejte aktualizované datum od.
Datum aktualizace na	updatedDateTo		string	Zadejte aktualizované datum.
Číslo poukázky	voucherNumber		string	Zadejte číslo poukázky.
Stránka	page		integer	Zadejte stránku.
Velikost	size		integer	Zadejte velikost.
Seřadit	sort		string	Zadejte řazení.

Návraty

Body

Response_voucherlist_get

Načtení dobropisu

ID operace:

RetrieveCreditNote

Tento koncový bod poskytuje přístup ke čtení a zápisu k kreditním poznámkám a také možnost vykreslit dokument jako PDF, aby si ho bylo možné stáhnout. Poznámky k kreditu je možné vytvořit jako koncept nebo finalizovat v otevřeném režimu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Name	Cesta	Typ	Description
město	address.city	string
kód země	address.countryCode	string
název	address.name	string
ulice	address.street	string
Doplněk	address.supplement	string
zip (jako formát souboru)	address.zip	string
archivovaný	archived	boolean
datum vytvoření	createdDate	date-time
identifikační číslo	id	uuid
Úvod	introduction	string
jazyk	language	string
řádkové položky	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
název	lineItems.name	string
množství	lineItems.quantity	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
měna	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
ID organizace	organizationId	uuid
komentář	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
měna	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	float
totalNetAmount	totalPrice.totalNetAmount	float
totalTaxAmount	totalPrice.totalTaxAmount	float
updatedDate	updatedDate	date-time
verze	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Načtení dunningu

ID operace:

RetrieveDunning

Vrátí dunning s hodnotou ID {id}.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Dunningsid	dunningsid	True	string	Zadejte dunningsid.

Návraty

Name	Cesta	Typ	Description
město	address.city	string
kód země	address.countryCode	string
název	address.name	string
ulice	address.street	string
Doplněk	address.supplement	string
zip (jako formát souboru)	address.zip	string
archivovaný	archived	boolean
datum vytvoření	createdDate	date-time
identifikační číslo	id	uuid
Úvod	introduction	string
jazyk	language	string
řádkové položky	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
název	lineItems.name	string
množství	lineItems.quantity	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
měna	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
ID organizace	organizationId	uuid
souvisejícíVouchers	relatedVouchers	array of object
identifikační číslo	relatedVouchers.id	uuid
voucherNumber	relatedVouchers.voucherNumber	string
voucherType	relatedVouchers.voucherType	string
komentář	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
měna	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
verze	version	integer
voucherDate	voucherDate	date-time
voucherStatus	voucherStatus	string

Načtení faktury

ID operace:

RetrieveInvoice

Vrátí fakturu s hodnotou ID {id}.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Name	Cesta	Typ	Description
město	address.city	string
kód země	address.countryCode	string
název	address.name	string
ulice	address.street	string
Doplněk	address.supplement	string
zip (jako formát souboru)	address.zip	string
archivovaný	archived	boolean
datum vytvoření	createdDate	date-time
identifikační číslo	id	uuid
Úvod	introduction	string
jazyk	language	string
řádkové položky	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
identifikační číslo	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
název	lineItems.name	string
množství	lineItems.quantity	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
měna	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
ID organizace	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
komentář	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
měna	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
verze	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Načtení faktury za platbu po splatnosti

ID operace:

RetrieveDownPaymentInvoice

Vrátí fakturu za platbu po splatnosti s hodnotou ID {id}.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Name	Cesta	Typ	Description
město	address.city	string
kód země	address.countryCode	string
název	address.name	string
ulice	address.street	string
Doplněk	address.supplement	string
zip (jako formát souboru)	address.zip	string
archivovaný	archived	boolean
closingInvoiceId	closingInvoiceId	uuid
datum vytvoření	createdDate	date-time
splatné datum	dueDate	date-time
documentFileId	files.documentFileId	uuid
identifikační číslo	id	uuid
Úvod	introduction	string
jazyk	language	string
řádkové položky	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
název	lineItems.name	string
množství	lineItems.quantity	number
typ	lineItems.type	string
měna	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
ID organizace	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
komentář	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
měna	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
verze	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Načtení informací o profilu

ID operace:

RetrieveProfileInformation

Následující ukázka ukazuje, jak načíst základní informace o profilu. Před odesláním požadavku je nutné nahradit zástupný symbol {accessToken}.

Návraty

Body

Response_profile_get

Načtení kontaktu

ID operace:

RetrieveContact

Načtení kontaktu podle ID

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Name	Cesta	Typ	Description
archivovaný	archived	boolean
identifikační číslo	id	string
ID organizace	organizationId	string
křestní jméno	person.firstName	string
lastName	person.lastName	string
oslovení	person.salutation	string
číslo	roles.customer.number	integer
verze	version	integer

Načtení nabídky

ID operace:

RetrieveQuotation

Vrátí uvozovku s hodnotou ID {id}. Vykreslení uvozovek (PDF)

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Name	Cesta	Typ	Description
město	address.city	string
contactId	address.contactId	uuid
kód země	address.countryCode	string
název	address.name	string
ulice	address.street	string
zip (jako formát souboru)	address.zip	string
archivovaný	archived	boolean
datum vytvoření	createdDate	date-time
datum vypršení platnosti	expirationDate	date-time
documentFileId	files.documentFileId	uuid
identifikační číslo	id	uuid
Úvod	introduction	string
jazyk	language	string
řádkové položky	lineItems	array of object
alternativa	lineItems.alternative	boolean
discountPercentage	lineItems.discountPercentage	number
identifikační číslo	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
název	lineItems.name	string
optional	lineItems.optional	boolean
množství	lineItems.quantity	number
Podpoložky	lineItems.subItems	array of object
alternativa	lineItems.subItems.alternative	boolean
discountPercentage	lineItems.subItems.discountPercentage	number
identifikační číslo	lineItems.subItems.id	uuid
lineItemAmount	lineItems.subItems.lineItemAmount	number
název	lineItems.subItems.name	string
optional	lineItems.subItems.optional	boolean
množství	lineItems.subItems.quantity	number
typ	lineItems.subItems.type	string
unitName	lineItems.subItems.unitName	string
měna	lineItems.subItems.unitPrice.currency	string
grossAmount	lineItems.subItems.unitPrice.grossAmount	number
netAmount	lineItems.subItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.subItems.unitPrice.taxRatePercentage	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
měna	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
ID organizace	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
komentář	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
měna	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
verze	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Načtení odběru událostí

ID operace:

RetrieveAEventSubscription

Načtení odběru událostí

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID předplatného	subscriptionId	True	string	Zadejte ID předplatného.

Návraty

Body

EventSubscriptionResponse

Načtení opakované šablony

ID operace:

RetrieveRecurringTemplate

Vrátí opakující se šablonu s hodnotou ID {id}.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Name	Cesta	Typ	Description
město	address.city	string
contactId	address.contactId	uuid
kód země	address.countryCode	string
název	address.name	string
ulice	address.street	string
zip (jako formát souboru)	address.zip	string
archivovaný	archived	boolean
datum vytvoření	createdDate	date-time
identifikační číslo	id	uuid
Úvod	introduction	string
jazyk	language	string
řádkové položky	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
název	lineItems.name	string
množství	lineItems.quantity	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
měna	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
ID organizace	organizationId	uuid
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
recurringTemplateSettings	recurringTemplateSettings	object
komentář	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
měna	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
verze	version	integer

Načtení platebních údajů

ID operace:

RetrievePaymentInformation

Koncový bod plateb poskytuje přístup pro čtení ke stavu platby (účetnictví nebo prodeje) poukázek, včetně faktur a dobropisů.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Id poukázky	voucherId	True	string	Zadejte ID poukázky.

Návraty

Name	Cesta	Typ	Description
měna	currency	string
openAmount	openAmount	string
paymentItems	paymentItems	array of object
částky	paymentItems.amount	float
měna	paymentItems.currency	string
paymentItemType	paymentItems.paymentItemType	string
postDate	paymentItems.postingDate	date-time
Stav platby	paymentStatus	string
voucherStatus	voucherStatus	string
voucherType	voucherType	string

Načtení potvrzení objednávky

ID operace:

RetrieveOrderConfirmation

Vrátí potvrzení objednávky s hodnotou ID {id}.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Name	Cesta	Typ	Description
město	address.city	string
kód země	address.countryCode	string
název	address.name	string
ulice	address.street	string
Doplněk	address.supplement	string
zip (jako formát souboru)	address.zip	string
archivovaný	archived	boolean
datum vytvoření	createdDate	date-time
deliveryTerms	deliveryTerms	string
documentFileId	files.documentFileId	uuid
identifikační číslo	id	uuid
Úvod	introduction	string
jazyk	language	string
řádkové položky	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
identifikační číslo	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
název	lineItems.name	string
množství	lineItems.quantity	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
měna	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
ID organizace	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
komentář	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
měna	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
verze	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Načtení poukázky

ID operace:

RetrieveVoucher

Výpis prodejních poukázek (např. faktury, dobropisy)

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Name	Cesta	Typ	Description
datum vytvoření	createdDate	date-time
splatné datum	dueDate	date-time
files	files	array of string
identifikační číslo	id	uuid
ID organizace	organizationId	uuid
komentář	remark	string
shippingDate	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
typ	type	string
updatedDate	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
verze	version	integer
voucherDate	voucherDate	date-time
voucherItems	voucherItems	array of object
částky	voucherItems.amount	number
categoryId (Id kategorie)	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Načtení poznámky k doručení

ID operace:

RetrieveDeliveryNote

Vrátí poznámku k doručení s hodnotou ID {id}.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Name	Cesta	Typ	Description
město	address.city	string
kód země	address.countryCode	string
název	address.name	string
ulice	address.street	string
Doplněk	address.supplement	string
zip (jako formát souboru)	address.zip	string
archivovaný	archived	boolean
datum vytvoření	createdDate	date-time
deliveryTerms	deliveryTerms	string
identifikační číslo	id	uuid
Úvod	introduction	string
jazyk	language	string
řádkové položky	lineItems	array of object
název	lineItems.name	string
množství	lineItems.quantity	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
měna	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
ID organizace	organizationId	uuid
komentář	remark	string
taxType	taxConditions.taxType	string
title	title	string
updatedDate	updatedDate	date-time
verze	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Načtení seznamu kategorií účtování

ID operace:

RetrieveListPostingCategories

Tento koncový bod poskytuje přístup pro čtení k seznamu kategorií účtování pro výnosy nebo výdaje (účetní) poukázky nebo výdaje, které jsou podporovány v lexoffice.

Návraty

response

array of Response_posting-categories_get_items

Načtení seznamu platebních podmínek

ID operace:

RetrieveListOfPaymentConditions

Následující ukázka ukazuje, jak načíst seznam aktuálně nakonfigurovaných platebních podmínek. Před odesláním požadavku je nutné nahradit zástupný symbol {accessToken}.

Návraty

response

array of Response_payment-conditions_get_items

Načtení seznamu zemí

ID operace:

RetrieveListCountries

Seznam zemí známých lexoffice.

Návraty

response

array of Response_countries_get_default

Načtení všech kontaktů

ID operace:

RetrieveAllContacts

Načtení všech kontaktů

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Number	number		integer	Zadejte číslo.
Email	email		string	Zadejte e-mail.
Název	name		string	Zadejte název.
Prodejce	vendor		boolean	Zadejte dodavatele.
Zákazník	customer		boolean	Zadejte zákazníka.
Stránka	page		integer	Zadejte stránku.
Velikost	size		integer	Zadejte velikost.
Seřadit	sort		string	Zadejte řazení.

Návraty

Body

Response_contacts_get

Načtení všech odběrů událostí

ID operace:

RetrieveAllEventSubscriptions

Načtení všech odběrů událostí

Návraty

Body

Response_event-subscriptions_get

Načtení všech opakovaných šablon

ID operace:

RetrieveAllRecurringTemplates

Načte kolekci opakujících se šablon. Výsledek vrátí jenom část nejrelevavantnějších dat, která jsou odkazovaným kontaktem (pouze ID a jméno), celkovou cenu, platební podmínky a kompletní nastavení opakujících se šablon. Pojmenování objektů a vlastností je však stejné.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Stránka	page		integer	Zadejte stránku.
Velikost	size		integer	Zadejte velikost.
Seřadit	sort		string	Zadejte řazení.

Návraty

Body

Response_recurring-templates_get

Načtení článku

ID operace:

RetrieveAnArticle

Vrátí článek s hodnotou ID {id}.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Name	Cesta	Typ	Description
articleNumber	articleNumber	string
gtin	gtin	string
identifikační číslo	id	string
poznámka	note	string
grossPrice	price.grossPrice	float
leadingPrice	price.leadingPrice	string
netPrice	price.netPrice	float
taxRate	price.taxRate	float
title	title	string
typ	type	string
unitName	unitName	string
verze	version	integer

Odstranění Event-Subscription

ID operace:

DeleteEventSubscription

Odstranění webhooku triggeru

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID předplatného	subscriptionId	True	string	Zadejte ID předplatného.

Odstranění článku

ID operace:

DeleteAnArticle

Odstraní článek s hodnotou ID {id}. Vrátí hodnotu 204 při úspěchu nebo 404, pokud ID neexistuje.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Potvrzení vytvoření objednávky

ID operace:

CreateOrderConfirmation

Tento koncový bod poskytuje přístup pro čtení a zápis k potvrzení objednávky a také možnost vykreslit dokument jako PDF, aby si ho bylo možné stáhnout. Potvrzení objednávek se vždy vytvářejí v režimu konceptu a není nutné je finalizovat.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Id předchozího prodejního poukazu	precedingSalesVoucherId		string	Zadejte předchozí ID prodejního poukazu.

Návraty

Body

Response_order-confirmations_post

Stažení souboru

ID operace:

DownloadFile_Lexoffice

Pomocí tohoto koncového bodu můžete stahovat soubory.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID souboru	fileId	True	string	Zadejte ID souboru.
Přijmout	Accept		string	Zadejte přijetí.

Návraty

response

file

Vykreslení dokumentu dobropisu (PDF)

ID operace:

RenderCreditNoteDocument

Chcete-li stáhnout soubor PDF dokumentu dobropisu, potřebujete jeho documentFileId. Toto ID obvykle vrací prostředek dobropisu. Nově vytvořené platební poznámky ve stavu otevřené prostřednictvím rozhraní API však musí aktivovat vykreslování souboru dokumentu PDF samostatně. To se dá provést pomocí tohoto koncového bodu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Name	Cesta	Typ	Description
documentFileId	documentFileId	uuid

Vykreslení dokumentu faktury (PDF)

ID operace:

RenderInvoiceDocument

Pokud chcete stáhnout soubor PDF dokumentu faktury, potřebujete jeho documentFileId. Toto ID obvykle vrací prostředek faktury. Nově vytvořené faktury ve stavu otevřené prostřednictvím rozhraní API však musí aktivovat vykreslování souboru dokumentu PDF samostatně. To se dá provést pomocí tohoto koncového bodu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Name	Cesta	Typ	Description
documentFileId	documentFileId	uuid

Vykreslení dokumentu potvrzení objednávky (PDF)

ID operace:

RenderOrderConfirmationDocument

Pokud chcete stáhnout soubor PDF dokumentu potvrzení objednávky, potřebujete jeho documentFileId. Toto ID obvykle vrací prostředek potvrzení objednávky. Nově vytvořené potvrzení objednávek prostřednictvím rozhraní API však musí aktivovat vykreslování souboru pdf dokumentu samostatně. To se dá provést pomocí tohoto koncového bodu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Name	Cesta	Typ	Description
documentFileId	documentFileId	uuid

Vykreslení dokumentu s poznámkou k doručení (PDF)

ID operace:

RenderDeliveryNoteDocument

Tento koncový bod poskytuje přístup ke čtení a zápisu doručovacím poznámkám a také možnost vykreslit dokument jako PDF, aby si ho bylo možné stáhnout. Poznámky k doručení se vždy vytvářejí v režimu konceptu a není nutné je finalizovat.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Delivery Noteid	DeliveryNoteid	True	string	Zadejte id poznámky k doručení.

Návraty

Name	Cesta	Typ	Description
město	address.city	string
kód země	address.countryCode	string
název	address.name	string
ulice	address.street	string
Doplněk	address.supplement	string
zip (jako formát souboru)	address.zip	string
archivovaný	archived	boolean
datum vytvoření	createdDate	date-time
deliveryTerms	deliveryTerms	string
identifikační číslo	id	uuid
Úvod	introduction	string
jazyk	language	string
řádkové položky	lineItems	array of object
název	lineItems.name	string
množství	lineItems.quantity	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
měna	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
ID organizace	organizationId	uuid
komentář	remark	string
taxType	taxConditions.taxType	string
title	title	string
updatedDate	updatedDate	date-time
verze	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Vykreslení duplicitního dokumentu (PDF)

ID operace:

RenderDunningDocument

Pokud chcete stáhnout pdf soubor dunning dokumentu, potřebujete jeho documentFileId. Toto ID obvykle vrací dunning prostředku. Nově vytvořené dunningy prostřednictvím rozhraní API však musí aktivovat vykreslování souboru dokumentu PDF samostatně. To se dá provést pomocí tohoto koncového bodu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Dunningsid	dunningsid	True	string	Zadejte dunningsid.

Návraty

Name	Cesta	Typ	Description
documentFileId	documentFileId	uuid

Vykreslení uvozovek (PDF)

ID operace:

RenderQuotationDocument

Pokud chcete stáhnout soubor PDF uvozovek, potřebujete jeho documentFileId. Toto ID je obvykle vráceno uvozovkami. Nově vytvořené uvozovky ve stavu otevřené prostřednictvím rozhraní API však musí aktivovat vykreslování souboru dokumentu PDF samostatně. To se dá provést pomocí tohoto koncového bodu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Zadejte ID.

Návraty

Name	Cesta	Typ	Description
documentFileId	documentFileId	uuid

Vytvoření dobropisu

ID operace:

CreateCreditNote

Poznámky k kreditu přenášené přes rozhraní API se vytvářejí v režimu konceptu podle výchozího nastavení. Pokud chcete vytvořit finalizovanou poznámku kreditu se stavem, musí být nastaven volitelný parametr dotazu finalizace. Stav poznámky k kreditu nelze změnit prostřednictvím rozhraní API.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Id předchozího prodejního poukazu	precedingSalesVoucherId		string	Zadejte předchozí ID prodejního poukazu.
Dokončit	finalize	True	boolean	Zadejte finalizaci.

Návraty

Body

Response_credit-notes_post

Vytvoření dunningu

ID operace:

CreateDunning

Vytvořené dunning se nezobrazí v hlavním seznamu poukázek v lexoffice, ale bude připojen k faktuře a bude tam viditelné. Pokud chcete svým zákazníkům poskytnout přístup k vytvořenému dunningu, použijte naši funkci deeplinku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Id předchozího prodejního poukazu	precedingSalesVoucherId		string	Zadejte předchozí ID prodejního poukazu.

Návraty

Body

Response_dunnings_post

Vytvoření faktury

ID operace:

CreateInvoice

Faktury přenášené přes rozhraní API se vytvářejí v režimu konceptu podle výchozího nastavení. Pokud chcete vytvořit finalizovanou fakturu se stavem, je potřeba nastavit volitelný parametr dotazu. Stav faktury nejde změnit prostřednictvím rozhraní API.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Id předchozího prodejního poukazu	precedingSalesVoucherId		string	Zadejte předchozí ID prodejního poukazu.
Dokončit	finalize	True	boolean	Zadejte finalizaci.

Návraty

Body

Response_invoices_post

Vytvoření kontaktu

ID operace:

CreateContact

Vytvoření nového kontaktu

Návraty

Body

Response_contacts_post

Vytvoření nabídky

ID operace:

CreateQuotation

Uvozovky přenášené prostřednictvím rozhraní API se vytvářejí v režimu konceptu podle výchozího nastavení. Pokud chcete vytvořit finalizovanou uvozovku se stavem, je nutné nastavit volitelný parametr dotazu. Stav uvozovek nelze změnit prostřednictvím rozhraní API.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Dokončit	finalize	True	boolean	Zadejte finalizaci.

Návraty

Body

Response_quotations_post

Vytvoření poukázky

ID operace:

CreateVoucher

Vytváření poukázek (omezeno na prodejní poukázky)

Parametry

Name	Klíč	Vyžadováno	Typ	Description
contactId	contactId		string
splatné datum	dueDate		date
komentář	remark		string
shippingDate	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
typ	type	True	string
useCollectiveContact	useCollectiveContact		boolean
voucherDate	voucherDate		date
částky	amount		float
categoryId (Id kategorie)	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Návraty

Body

Response_vouchers_post

Vytvoření poznámky k doručení

ID operace:

CreateDeliveryNote

Vytvořené oznámení o doručení se zobrazí v hlavním seznamu poukázek v lexoffice. Poznámky k doručení přenášené prostřednictvím rozhraní API se vytvářejí pouze v režimu konceptu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Id předchozího prodejního poukazu	precedingSalesVoucherId		string	Zadejte předchozí ID prodejního poukazu.

Návraty

Body

Response_delivery-notes_post

Vytvoření článku

ID operace:

CreateArticle

Obsah článku se očekává v textu požadavku jako application/json.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
articleNumber	articleNumber		string	articleNumber
grossPrice	grossPrice		float	grossPrice
leadingPrice	leadingPrice		string	leadingPrice
netPrice	netPrice		float	netPrice
taxRate	taxRate		float	taxRate
title	title		string	title
typ	type		string	typ
unitName	unitName		string	unitName

Návraty

Body

Response_articles_post

Aktivační události

Výběr vlastní aktivační události

Registrace nového triggeru pro koncový bod kontaktů

Výběr vlastní aktivační události

ID operace:

EventSubscription_Lexoffice

Registrace nového triggeru pro koncový bod kontaktů

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Typ události	eventType	True	string	eventType

Návraty

Name	Cesta	Typ	Description
eventDate	eventDate	string	eventDate
eventType	eventType	string	eventType
ID organizace	organizationId	string	ID organizace
resourceId	resourceId	string	resourceId

Definice

EventSubscriptionResponse

Name	Cesta	Typ	Description
subscriptionId	subscriptionId	string
eventType	eventType	string
ID organizace	organizationId	string
datum vytvoření	createdDate	date-time
callbackUrl	callbackUrl	string

Response_articles_get

Name	Cesta	Typ	Description
obsah	content	array of object	obsah
articleNumber	content.articleNumber	string	articleNumber
gtin	content.gtin	string	gtin
identifikační číslo	content.id	string	identifikační číslo
poznámka	content.note	string	poznámka
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
typ	content.type	string	typ
unitName	content.unitName	string	unitName
verze	content.version	integer	verze
první	first	boolean	první
last	last	boolean	last
číslo	number	integer	číslo
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
řadit	sort	array of object	řadit
vzestupný	sort.ascending	boolean	vzestupný
směr	sort.direction	string	směr
ignorovat případ	sort.ignoreCase	boolean	ignorovat případ
nullHandling	sort.nullHandling	string	nullHandling
vlastnost	sort.property	string	vlastnost
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_articles_id_get

Name	Cesta	Typ	Description
articleNumber	articleNumber	string	articleNumber
gtin	gtin	string	gtin
identifikační číslo	id	string	identifikační číslo
poznámka	note	string	poznámka
grossPrice	price.grossPrice	float	grossPrice
leadingPrice	price.leadingPrice	string	leadingPrice
netPrice	price.netPrice	float	netPrice
taxRate	price.taxRate	float	taxRate
title	title	string	title
typ	type	string	typ
unitName	unitName	string	unitName
verze	version	integer	verze

Response_articles_post

Name	Cesta	Typ	Description
datum vytvoření	createdDate	string	datum vytvoření
identifikační číslo	id	string	identifikační číslo
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verze	version	integer	verze

Response_contacts_get

Name	Cesta	Typ	Description
obsah	content	array of object	obsah
fakturační	content.addresses.billing	array of object	fakturační
město	content.addresses.billing.city	string	město
kód země	content.addresses.billing.countryCode	string	kód země
ulice	content.addresses.billing.street	string	ulice
Doplněk	content.addresses.billing.supplement	string	Doplněk
zip (jako formát souboru)	content.addresses.billing.zip	string	zip (jako formát souboru)
doprava	content.addresses.shipping	array of object	doprava
město	content.addresses.shipping.city	string	město
kód země	content.addresses.shipping.countryCode	string	kód země
ulice	content.addresses.shipping.street	string	ulice
Doplněk	content.addresses.shipping.supplement	string	Doplněk
zip (jako formát souboru)	content.addresses.shipping.zip	string	zip (jako formát souboru)
archivovaný	content.archived	boolean	archivovaný
allowTaxFreeInvoices	content.company.allowTaxFreeInvoices	boolean	allowTaxFreeInvoices
kontaktní osoby	content.company.contactPersons	array of object	kontaktní osoby
e-mailová adresa	content.company.contactPersons.emailAddress	string	e-mailová adresa
křestní jméno	content.company.contactPersons.firstName	string	křestní jméno
lastName	content.company.contactPersons.lastName	string	lastName
primární	content.company.contactPersons.primary	boolean	primární
oslovení	content.company.contactPersons.salutation	string	oslovení
název	content.company.name	string	název
daňové číslo	content.company.taxNumber	string	daňové číslo
vatRegistrationId	content.company.vatRegistrationId	string	vatRegistrationId
podnikání	content.emailAddresses.business	array of string	podnikání
kancelář	content.emailAddresses.office	array of string	kancelář
other	content.emailAddresses.other	array of string	other
identifikační číslo	content.id	string	identifikační číslo
poznámka	content.note	string	poznámka
ID organizace	content.organizationId	string	ID organizace
podnikání	content.phoneNumbers.business	array of string	podnikání
fax	content.phoneNumbers.fax	array of string	fax
kancelář	content.phoneNumbers.office	array of string	kancelář
other	content.phoneNumbers.other	array of string	other
číslo	content.roles.customer.number	integer	číslo
číslo	content.roles.vendor.number	integer	číslo
verze	content.version	integer	verze
první	first	boolean	první
last	last	boolean	last
číslo	number	integer	číslo
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
řadit	sort	array of object	řadit
vzestupný	sort.ascending	boolean	vzestupný
směr	sort.direction	string	směr
ignorovat případ	sort.ignoreCase	boolean	ignorovat případ
nullHandling	sort.nullHandling	string	nullHandling
vlastnost	sort.property	string	vlastnost
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_contacts_post

Name	Cesta	Typ	Description
datum vytvoření	createdDate	string	datum vytvoření
identifikační číslo	id	string	identifikační číslo
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verze	version	integer	verze

Response_countries_get_default

Name	Cesta	Typ	Description
kód země	countryCode	string	kód země
countryNameDE	countryNameDE	string	countryNameDE
countryNameEN	countryNameEN	string	countryNameEN
taxClassification	taxClassification	string	taxClassification

Response_credit-notes_post

Name	Cesta	Typ	Description
datum vytvoření	createdDate	string	datum vytvoření
identifikační číslo	id	string	identifikační číslo
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verze	version	integer	verze

Response_delivery notes_post

Name	Cesta	Typ	Description
datum vytvoření	createdDate	string	datum vytvoření
identifikační číslo	id	string	identifikační číslo
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verze	version	integer	verze

Response_dunnings_post

Name	Cesta	Typ	Description
datum vytvoření	createdDate	string	datum vytvoření
identifikační číslo	id	string	identifikační číslo
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verze	version	integer	verze

Response_event subscriptions_get

Name	Cesta	Typ	Description
obsah	content	array of object	obsah
callbackUrl	content.callbackUrl	string	callbackUrl
datum vytvoření	content.createdDate	string	datum vytvoření
eventType	content.eventType	string	eventType
ID organizace	content.organizationId	string	ID organizace
subscriptionId	content.subscriptionId	string	subscriptionId

Response_files_post

Name	Cesta	Typ	Description
identifikační číslo	id	string	identifikační číslo

Response_invoices_post

Name	Cesta	Typ	Description
datum vytvoření	createdDate	string	datum vytvoření
identifikační číslo	id	string	identifikační číslo
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verze	version	integer	verze

Response_order confirmations_post

Name	Cesta	Typ	Description
datum vytvoření	createdDate	string	datum vytvoření
identifikační číslo	id	string	identifikační číslo
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verze	version	integer	verze

conditions_get_items Response_payment

Name	Cesta	Typ	Description
identifikační číslo	id	string	identifikační číslo
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	Cesta	Typ	Description
ContactRequired	contactRequired	boolean	ContactRequired
groupName	groupName	string	groupName
identifikační číslo	id	string	identifikační číslo
název	name	string	název
splitAllowed	splitAllowed	boolean	splitAllowed
typ	type	string	typ

Response_profile_get

Name	Cesta	Typ	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
userName	created.userName	string	userName
features	features	array of string	features
ID organizace	organizationId	string	ID organizace
Smallbusiness	smallBusiness	boolean	Smallbusiness
stav předplatného	subscriptionStatus	string	stav předplatného
taxType	taxType	string	taxType

Response_quotations_post

Name	Cesta	Typ	Description
datum vytvoření	createdDate	string	datum vytvoření
identifikační číslo	id	string	identifikační číslo
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verze	version	integer	verze

Response_recurring templates_get

Name	Cesta	Typ	Description
obsah	content	array of object	obsah
contactId	content.address.contactId	string	contactId
název	content.address.name	string	název
datum vytvoření	content.createdDate	string	datum vytvoření
identifikační číslo	content.id	string	identifikační číslo
ID organizace	content.organizationId	string	ID organizace
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
datum ukončení	content.recurringTemplateSettings.endDate	string	datum ukončení
executionInterval	content.recurringTemplateSettings.executionInterval	string	executionInterval
executionStatus	content.recurringTemplateSettings.executionStatus	string	executionStatus
Dokončit	content.recurringTemplateSettings.finalize	boolean	Dokončit
identifikační číslo	content.recurringTemplateSettings.id	string	identifikační číslo
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
měna	content.totalPrice.currency	string	měna
totalGrossAmount	content.totalPrice.totalGrossAmount	integer	totalGrossAmount
totalNetAmount	content.totalPrice.totalNetAmount	float	totalNetAmount
updatedDate	content.updatedDate	string	updatedDate
první	first	boolean	první
last	last	boolean	last
číslo	number	integer	číslo
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
řadit	sort	array of object	řadit
vzestupný	sort.ascending	boolean	vzestupný
směr	sort.direction	string	směr
ignorovat případ	sort.ignoreCase	boolean	ignorovat případ
nullHandling	sort.nullHandling	string	nullHandling
vlastnost	sort.property	string	vlastnost
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_voucherlist_get

Name	Cesta	Typ	Description
obsah	content	array of object	obsah
archivovaný	content.archived	boolean	archivovaný
contactId	content.contactId	string	contactId
contactName	content.contactName	string	contactName
datum vytvoření	content.createdDate	string	datum vytvoření
měna	content.currency	string	měna
splatné datum	content.dueDate	string	splatné datum
identifikační číslo	content.id	string	identifikační číslo
openAmount	content.openAmount	float	openAmount
celková částka	content.totalAmount	float	celková částka
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
první	first	boolean	první
last	last	boolean	last
číslo	number	integer	číslo
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
řadit	sort	array of object	řadit
vzestupný	sort.ascending	boolean	vzestupný
směr	sort.direction	string	směr
ignorovat případ	sort.ignoreCase	boolean	ignorovat případ
nullHandling	sort.nullHandling	string	nullHandling
vlastnost	sort.property	string	vlastnost
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_vouchers_post

Name	Cesta	Typ	Description
datum vytvoření	createdDate	string	datum vytvoření
identifikační číslo	id	string	identifikační číslo
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
verze	version	integer	verze

Response_contacts_id_put

Name	Cesta	Typ	Description
archivovaný	archived	boolean
identifikační číslo	id	uuid
ID organizace	organizationId	uuid
křestní jméno	person.firstName	string
lastName	person.lastName	string
oslovení	person.salutation	string
číslo	roles.customer.number	integer
verze	version	integer

Response_vouchers_id_put

Name	Cesta	Typ	Description
datum vytvoření	createdDate	date-time
splatné datum	dueDate	date-time
files	files	array of object
items	files	object
identifikační číslo	id	uuid
ID organizace	organizationId	uuid
komentář	remark	string
shippingDate	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
typ	type	string
updatedDate	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
verze	version	integer
voucherDate	voucherDate	date-time
voucherItems	voucherItems	array of object
částky	voucherItems.amount	number
categoryId (Id kategorie)	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

soubor

Toto je základní datový typ "file".