Lexoffice (niezależny wydawca) (wersja zapoznawcza)

Interfejs API Lexware zapewnia dostęp programowy do podstawowych funkcji biznesowych lexware, takich jak artykuły, kontakty, faktury, zamówienia i zarządzanie plikami. Ten niezależny łącznik wydawcy umożliwia bezpieczną integrację z interfejsem API REST firmy Lexware, umożliwiając użytkownikom tworzenie i pobieranie danych biznesowych, automatyzowanie procesów i łączenie zasobów Lexware z aplikacjami platformy Power Platform. Łącznik używa przepływu kodu autoryzacji OAuth 2.0 do bezpiecznego uwierzytelniania i wytycznych dotyczących interfejsu API.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa	Class	Regions
Copilot Studio	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących:      - Rząd USA (GCC)      - Rząd USA (GCC High)      - China Cloud obsługiwane przez firmę 21Vianet      - Departament Obrony USA (DoD)
Logic Apps	Standard	Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:      — Regiony platformy Azure Government      — Regiony platformy Azure (Chiny)      - Departament Obrony USA (DoD)
Power Apps	Premium	Wszystkie regiony usługi Power Apps z wyjątkiem następujących:      - Rząd USA (GCC)      - Rząd USA (GCC High)      - China Cloud obsługiwane przez firmę 21Vianet      - Departament Obrony USA (DoD)
Power Automate - narzędzie do automatyzacji procesów	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących:      - Rząd USA (GCC)      - Rząd USA (GCC High)      - China Cloud obsługiwane przez firmę 21Vianet      - Departament Obrony USA (DoD)

Kontakt
Name	Pomoc techniczna dla badaczy lowcode
adres URL	https://lowcode-investigator.com/
Email	kontakt@lowcodeinvestigator.com

Metadane łącznika
Publisher	LowCodeInvestigator
Witryna internetowa	https://office.lexware.de/
Zasady ochrony prywatności	https://office.lexware.de/datenschutz/
Kategorie	Zarządzanie biznesem; Finanse

Łącznik interfejsu API lexware (niezależny wydawca)

Interfejs API Lexware to interfejs RESTful umożliwiający deweloperom integrowanie funkcji biznesowych Lexware, takich jak kontakty, faktury, artykuły i pliki we własnych aplikacjach. Ten łącznik umożliwia bezpośrednią interakcję z tymi zasobami za pośrednictwem bezpiecznych, uwierzytelnionych żądań interfejsu API.

Wydawca: Niezależny wydawca

Wymagania wstępne

• Zarejestrowane konto Lexware i właściwa licencja
• Prawidłowy klucz interfejsu API (token dostępu) uzyskany za pośrednictwem portalu deweloperów Lexware
• Przepływ kodu autoryzacji OAuth 2.0 jest wymagany do uwierzytelniania

Obsługiwane operacje

Ten łącznik obsługuje następujące punkty końcowe interfejsu API lexware:

• Artykuły: tworzenie, pobieranie, aktualizowanie, usuwanie i filtrowanie artykułów
• Kontakty: zarządzanie danymi klienta i dostawcy
• Faktury: tworzenie i pobieranie danych faktur, w tym renderowanie plików PDF
• Noty kredytowe, noty dostawy, zamówienia, oferty i bony
• Kraje, warunki płatności, układy wydruku i profile
• Subskrypcje i pliki zdarzeń
• Pełna lista udokumentowana na stronie: Dokumentacja interfejsu API lexware

Uzyskiwanie poświadczeń

Aby wywołać interfejs API Lexware, potrzebny jest klucz interfejsu API:

1. Zaloguj się do konta pakietu Office Lexware.
2. Przejdź do pozycji Rozszerzenia → Aplikacje Weitere → publicznego interfejsu API lub otwórz
   Portal deweloperów lexware bezpośrednio.
3. Utwórz nowy klucz interfejsu API z żądanymi uprawnieniami.
4. Skopiuj wygenerowany klucz interfejsu API. Ta wartość będzie używana jako accessToken w łączniku.

Bramka interfejsu API

Użyj nowej bramy interfejsu API Lexware:

https://api.lexware.io

Limity szybkości

• Maksymalna liczba żądań na sekundę
• Żądania przekraczające ten limit odbierają protokół HTTP 429 Too Many Requests
• Zalecane: Użyj algorytmu zasobnika tokenu lub wycofywania wykładniczego

Authentication

Interfejs API lexware używa przepływu kodu autoryzacji OAuth 2.0. Uwzględnij token w nagłówku Authorization: Bearer {accessToken} każdego żądania.

Przykładowe użycie

Tworzenie artykułu:

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

Znane problemy i ograniczenia

• Maksymalna liczba żądań na sekundę
• Niektóre punkty końcowe wymagają dodatkowych uprawnień lub ról

Dokumentacja interfejsu API

Pełna dokumentacja interfejsu API jest dostępna pod adresem:
https://developers.lexware.io/docs/

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:

Wartość domyślna	Parametry tworzenia połączenia.	Wszystkie regiony	Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name	Typ	Description	Required
Klucz interfejsu API	securestring	Klucz interfejsu API dla tego interfejsu API	Prawda

Limity ograniczania przepustowości

Nazwa	Wywołania	Okres odnowienia
Wywołania interfejsu API na połączenie	100	60 sekund

Akcje

Aktualizowanie artykułu	Zaktualizuj istniejący artykuł o identyfikatorze {id} przy użyciu danych podanych w ładunku jako JSON. Zwraca wynik akcji dla powodzenia.
Aktualizowanie kontaktu	Aktualizowanie kontaktu
Aktualizowanie kuponu	Aktualizowanie kuponu
Artykuły dotyczące filtrowania	Zwraca artykuły spełniające kryteria podane przez filtry filter_1, aby filter_n za pomocą mechanizmu stronicowania. Jeśli podano więcej niż jeden filtr, łącznik logiczny to AND. Filtry, które nie są ustawione, są ignorowane. Aby sprawdzić maksymalny rozmiar strony dla tego punktu końcowego, zobacz stronicowanie zasobów.
Pobieranie artykułu	Zwraca artykuł o wartości identyfikatora {id}.
Pobieranie bonu	Wyświetlanie listy bonów sprzedażowych (np. faktur, przypisów kredytowych)
Pobieranie faktury	Zwraca fakturę z wartością identyfikatora {id}.
Pobieranie faktury za płatność w dół	Zwraca fakturę za płatność w dół z wartością identyfikatora {id}.
Pobieranie i filtrowanie listy kuponów	Pobierz kupony z listą kuponów (księgowanie) (np. salesinvoices, salescreditnotes), faktury (w tym faktury za płatność w dół), notatki kredytowe, potwierdzenia zamówień, oferty i noty dostawy.
Pobieranie informacji o profilu	W poniższym przykładzie pokazano, jak pobrać podstawowe informacje o profilu. Przed wysłaniem żądania wymagane jest zastąpienie symbolu zastępczego {accessToken}.
Pobieranie informacji o płatności	Punkt końcowy płatności zapewnia dostęp do odczytu do stanu płatności (księgowania lub sprzedaży) bonów, w tym faktur i notatek kredytowych.
Pobieranie kontaktu	Pobieranie kontaktu według identyfikatora
Pobieranie listy kategorii publikowania	Ten punkt końcowy zapewnia dostęp do odczytu do listy kategorii delegowania bonów (księgowania) przychodów lub wydatków, które są obsługiwane w lexoffice.
Pobieranie listy krajów	Lista krajów znanych lexoffice.
Pobieranie listy warunków płatności	W poniższym przykładzie pokazano, jak pobrać listę aktualnie skonfigurowanych warunków płatności. Przed wysłaniem żądania wymagane jest zastąpienie symbolu zastępczego {accessToken}.
Pobieranie notatki kredytowej	Ten punkt końcowy zapewnia dostęp do odczytu i zapisu do notatek kredytowych, a także możliwość renderowania dokumentu jako pliku PDF w celu jego pobrania. Notatki kredytowe można utworzyć jako wersję roboczą lub sfinalizowaną w trybie otwierania.
Pobieranie notatki o dostawie	Zwraca notatkę dostawy z wartością identyfikatora {id}.
Pobieranie oferty	Zwraca cudzysłów z wartością identyfikatora {id}. Renderowanie dokumentu cudzysłowu (PDF)
Pobieranie pliku	Użyj tego punktu końcowego, aby pobrać pliki.
Pobieranie potwierdzenia zamówienia	Zwraca potwierdzenie zamówienia z wartością identyfikatora {id}.
Pobieranie subskrypcji zdarzeń	Pobieranie subskrypcji zdarzeń
Pobieranie szablonu cyklicznego	Zwraca szablon cykliczny o wartości identyfikatora {id}.
Pobieranie wszystkich kontaktów	Pobieranie wszystkich kontaktów
Pobieranie wszystkich subskrypcji zdarzeń	Pobieranie wszystkich subskrypcji zdarzeń
Pobieranie wszystkich szablonów cyklicznych	Pobieranie kolekcji szablonów cyklicznych. Wynik zwraca tylko część najbardziej odpowiednich danych, do których odwołuje się kontakt (tylko identyfikator i nazwa), łączną cenę, warunki płatności i pełne ustawienia szablonów cyklicznych. Jednak nazewnictwo obiektów i właściwości jest takie samo.
Pobieranie zrzutu	Zwraca przebieg z wartością identyfikatora {id}.
Przekazywanie pliku	Ten punkt końcowy służy do przekazywania plików, np. bonów lub faktur.
Przekazywanie pliku do bonu	Przekaż i przypisz pliki (pdf lub obraz) do bonu zidentyfikowany przez użytkownika {id}.
Renderowanie dokumentu cudzysłowu (PDF)	Aby pobrać plik PDF dokumentu cudzysłowu, potrzebny jest jego identyfikator documentFileId. Ten identyfikator jest zwykle zwracany przez zasób cudzysłowu. Jednak nowo utworzone cudzysłów w stanie otwartym za pośrednictwem interfejsu API muszą wyzwolić renderowanie pliku dokumentu pdf oddzielnie. Można to zrobić za pomocą tego punktu końcowego.
Renderowanie dokumentu dunning (PDF)	Aby pobrać plik pdf z dokumentem rozpieszanym, potrzebny jest jego identyfikator documentFileId. Ten identyfikator jest zwykle zwracany przez zasób tworzenia zrzutu. Jednak nowo utworzone przebiegi za pośrednictwem interfejsu API muszą wyzwolić renderowanie pliku dokumentu PDF oddzielnie. Można to zrobić za pomocą tego punktu końcowego.
Renderowanie dokumentu faktury (PDF)	Aby pobrać plik PDF dokumentu z fakturą, potrzebny jest jego identyfikator documentFileId. Ten identyfikator jest zwykle zwracany przez zasób faktury. Jednak nowo utworzone faktury w stanie otwartym za pośrednictwem interfejsu API muszą wyzwolić renderowanie pliku dokumentu pdf oddzielnie. Można to zrobić za pomocą tego punktu końcowego.
Renderowanie dokumentu notatki dotyczącej dostarczania (PDF)	Ten punkt końcowy zapewnia dostęp do odczytu i zapisu do notatek dostarczania, a także możliwość renderowania dokumentu jako pliku PDF w celu jego pobrania. Notatki dotyczące dostarczania są zawsze tworzone w trybie roboczym i nie muszą być finalizowane.
Renderowanie dokumentu notatki kredytowej (PDF)	Aby pobrać plik PDF dokumentu notatki kredytowej, potrzebny jest jego identyfikator documentFileId. Ten identyfikator jest zwykle zwracany przez zasób noty kredytowej. Jednak nowo utworzone notatki kredytowe w stanie otwartym za pośrednictwem interfejsu API muszą wyzwolić renderowanie pliku dokumentu pdf oddzielnie. Można to zrobić za pomocą tego punktu końcowego.
Renderowanie dokumentu potwierdzenia zamówienia (PDF)	Aby pobrać plik PDF dokumentu potwierdzenia zamówienia, potrzebny jest jego identyfikator documentFileId. Ten identyfikator jest zwykle zwracany przez zasób potwierdzenia zamówienia. Jednak nowo utworzone potwierdzenia zamówienia za pośrednictwem interfejsu API muszą wyzwolić renderowanie pliku dokumentu PDF oddzielnie. Można to zrobić za pomocą tego punktu końcowego.
Tworzenie artykułu	Zawartość artykułu jest oczekiwana w treści żądania jako aplikacja/json.
Tworzenie bonu	Tworzenie bonów (ograniczonych do kuponów sprzedaży)
Tworzenie faktury	Faktury przesyłane za pośrednictwem interfejsu API są tworzone w trybie roboczym na wartość domyślną. Aby utworzyć sfinalizowaną fakturę ze stanem, należy ustawić opcjonalny parametr zapytania. Nie można zmienić stanu faktury za pośrednictwem interfejsu API.
Tworzenie kontaktu	Tworzenie nowego kontaktu
Tworzenie kwantowania	Utworzone przebiegi nie będą wyświetlane na głównej liście kuponów w lexoffice, ale zostaną dołączone do faktury i będą tam widoczne. Aby zapewnić klientom dostęp do utworzonego narzędzia dunning, użyj naszej funkcji deeplink.
Tworzenie notatki dotyczącej dostarczania	Utworzona notatka dostawy zostanie wyświetlona na głównej liście kuponów w lexoffice. Notatki dotyczące dostarczania przesyłane za pośrednictwem interfejsu API są tworzone tylko w trybie roboczym.
Tworzenie notatki kredytowej	Notatki kredytowe przesyłane za pośrednictwem interfejsu API są tworzone w trybie roboczym na wartość domyślną. Aby utworzyć sfinalizowaną notatkę kredytową ze stanem, należy ustawić opcjonalny parametr zapytania. Nie można zmienić stanu notatki kredytowej za pośrednictwem interfejsu API
Tworzenie oferty	Cudzysłów przesyłanych za pośrednictwem interfejsu API są tworzone w trybie roboczym na wartość domyślną. Aby utworzyć sfinalizowany cudzysłów ze stanem, należy ustawić opcjonalny parametr zapytania. Nie można zmienić stanu cudzysłowu za pośrednictwem interfejsu API.
Tworzenie potwierdzenia zamówienia	Ten punkt końcowy zapewnia dostęp do odczytu i zapisu w celu potwierdzenia zamówienia, a także możliwość renderowania dokumentu jako pliku PDF w celu jego pobrania. Potwierdzenia zamówień są zawsze tworzone w trybie roboczym i nie muszą być finalizowane.
Usuwanie artykułu	Usuwa artykuł o wartości identyfikatora {id}. Zwraca wartość 204 dla powodzenia lub 404, jeśli identyfikator nie istnieje.
Usuwanie Event-Subscription	Usuń element WebHook wyzwalacza

Aktualizowanie artykułu

Identyfikator operacji:

UpdateAnArticle

Zaktualizuj istniejący artykuł o identyfikatorze {id} przy użyciu danych podanych w ładunku jako JSON. Zwraca wynik akcji dla powodzenia.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.
articleNumber	articleNumber		string	articleNumber
gtin	gtin		string	gtin
nuta	note		string	nuta
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
wersja	version	True	integer	wersja

Zwraca

Body

Response_articles_id_get

Aktualizowanie kontaktu

Identyfikator operacji:

UpdateContact

Aktualizowanie kontaktu

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Body

Response_contacts_id_put

Aktualizowanie kuponu

Identyfikator operacji:

UpdateVoucher

Aktualizowanie kuponu

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.
contactId	contactId		string
data ukończenia	dueDate		date
files	files		array of string	lista pominiętych identyfikatorów plików
uwaga	remark		string
data wysyłki	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
typ	type	True	string
useCollectiveContact	useCollectiveContact		boolean
wersja	version		integer
voucherDate	voucherDate		date
kwota	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Zwraca

Body

Response_vouchers_id_put

Artykuły dotyczące filtrowania

Identyfikator operacji:

FilteringArticles

Zwraca artykuły spełniające kryteria podane przez filtry filter_1, aby filter_n za pomocą mechanizmu stronicowania. Jeśli podano więcej niż jeden filtr, łącznik logiczny to AND. Filtry, które nie są ustawione, są ignorowane. Aby sprawdzić maksymalny rozmiar strony dla tego punktu końcowego, zobacz stronicowanie zasobów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Numer artykułu	articleNumber		string	Określ numer artykułu.
Gtin	gtin		string	Określ gtin.
Typ	type		string	Określ typ.
Strona	page		integer	Określ stronę.
Rozmiar	size		integer	Określ rozmiar.
Sortuj	sort		string	Określ sortowanie.

Zwraca

Body

Response_articles_get

Pobieranie artykułu

Identyfikator operacji:

RetrieveAnArticle

Zwraca artykuł o wartości identyfikatora {id}.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Nazwa	Ścieżka	Typ	Opis
articleNumber	articleNumber	string
gtin	gtin	string
id	id	string
nuta	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
wersja	version	integer

Pobieranie bonu

Identyfikator operacji:

RetrieveVoucher

Wyświetlanie listy bonów sprzedażowych (np. faktur, przypisów kredytowych)

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Nazwa	Ścieżka	Typ	Opis
data utworzenia	createdDate	date-time
data ukończenia	dueDate	date-time
files	files	array of string
id	id	uuid
identyfikator organizacji	organizationId	uuid
uwaga	remark	string
data wysyłki	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
typ	type	string
zaktualizowana data	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
wersja	version	integer
voucherDate	voucherDate	date-time
voucherItems	voucherItems	array of object
kwota	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Pobieranie faktury

Identyfikator operacji:

RetrieveInvoice

Zwraca fakturę z wartością identyfikatora {id}.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Nazwa	Ścieżka	Typ	Opis
city	address.city	string
Kod kraju	address.countryCode	string
nazwa	address.name	string
ulica	address.street	string
Dodatek	address.supplement	string
zip	address.zip	string
Archiwizowane	archived	boolean
data utworzenia	createdDate	date-time
id	id	uuid
Wprowadzenie	introduction	string
język	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
id	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
nazwa	lineItems.name	string
ilość	lineItems.quantity	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
waluta	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
identyfikator organizacji	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
uwaga	remark	string
data wysyłki	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
waluta	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
zaktualizowana data	updatedDate	date-time
wersja	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Pobieranie faktury za płatność w dół

Identyfikator operacji:

RetrieveDownPaymentInvoice

Zwraca fakturę za płatność w dół z wartością identyfikatora {id}.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Nazwa	Ścieżka	Typ	Opis
city	address.city	string
Kod kraju	address.countryCode	string
nazwa	address.name	string
ulica	address.street	string
Dodatek	address.supplement	string
zip	address.zip	string
Archiwizowane	archived	boolean
closingInvoiceId	closingInvoiceId	uuid
data utworzenia	createdDate	date-time
data ukończenia	dueDate	date-time
documentFileId	files.documentFileId	uuid
id	id	uuid
Wprowadzenie	introduction	string
język	language	string
lineItems	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
nazwa	lineItems.name	string
ilość	lineItems.quantity	number
typ	lineItems.type	string
waluta	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
identyfikator organizacji	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
uwaga	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
waluta	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
zaktualizowana data	updatedDate	date-time
wersja	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Pobieranie i filtrowanie listy kuponów

Identyfikator operacji:

RetrieveAndFilterVoucherlist

Pobierz kupony z listą kuponów (księgowanie) (np. salesinvoices, salescreditnotes), faktury (w tym faktury za płatność w dół), notatki kredytowe, potwierdzenia zamówień, oferty i noty dostawy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Typ kuponu	voucherType	True	string	Określ typ kuponu.
Stan bonu	voucherStatus	True	string	Określ stan kuponu.
Archiwizowane	archived		boolean	Określ zarchiwizowane.
Identyfikator kontaktu	contactId		string	Określ identyfikator kontaktu.
Data kuponu od	voucherDateFrom		string	Określ datę kuponu od.
Data kuponu do	voucherDateTo		string	Określ datę kuponu na.
Data utworzenia od	createdDateFrom		string	Określ utworzoną datę od.
Data utworzenia do	createdDateTo		string	Określ utworzoną datę do.
Data aktualizacji od	updatedDateFrom		string	Określ zaktualizowaną datę od.
Data aktualizacji do	updatedDateTo		string	Określ zaktualizowaną datę do.
Numer kuponu	voucherNumber		string	Podaj numer kuponu.
Strona	page		integer	Określ stronę.
Rozmiar	size		integer	Określ rozmiar.
Sortuj	sort		string	Określ sortowanie.

Zwraca

Body

Response_voucherlist_get

Pobieranie informacji o profilu

Identyfikator operacji:

RetrieveProfileInformation

W poniższym przykładzie pokazano, jak pobrać podstawowe informacje o profilu. Przed wysłaniem żądania wymagane jest zastąpienie symbolu zastępczego {accessToken}.

Zwraca

Body

Response_profile_get

Pobieranie informacji o płatności

Identyfikator operacji:

RetrievePaymentInformation

Punkt końcowy płatności zapewnia dostęp do odczytu do stanu płatności (księgowania lub sprzedaży) bonów, w tym faktur i notatek kredytowych.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator kuponu	voucherId	True	string	Określ identyfikator kuponu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
waluta	currency	string
openAmount	openAmount	string
paymentItems	paymentItems	array of object
kwota	paymentItems.amount	float
waluta	paymentItems.currency	string
paymentItemType	paymentItems.paymentItemType	string
delegowanieDate	paymentItems.postingDate	date-time
status płatności	paymentStatus	string
voucherStatus	voucherStatus	string
voucherType	voucherType	string

Pobieranie kontaktu

Identyfikator operacji:

RetrieveContact

Pobieranie kontaktu według identyfikatora

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Archiwizowane	archived	boolean
id	id	string
identyfikator organizacji	organizationId	string
imię	person.firstName	string
nazwisko	person.lastName	string
Zwrot grzecznościowy	person.salutation	string
Liczba	roles.customer.number	integer
wersja	version	integer

Pobieranie listy kategorii publikowania

Identyfikator operacji:

RetrieveListPostingCategories

Ten punkt końcowy zapewnia dostęp do odczytu do listy kategorii delegowania bonów (księgowania) przychodów lub wydatków, które są obsługiwane w lexoffice.

Zwraca

response

array of Response_posting-categories_get_items

Pobieranie listy krajów

Identyfikator operacji:

RetrieveListCountries

Lista krajów znanych lexoffice.

Zwraca

response

array of Response_countries_get_default

Pobieranie listy warunków płatności

Identyfikator operacji:

RetrieveListOfPaymentConditions

W poniższym przykładzie pokazano, jak pobrać listę aktualnie skonfigurowanych warunków płatności. Przed wysłaniem żądania wymagane jest zastąpienie symbolu zastępczego {accessToken}.

Zwraca

response

array of Response_payment-conditions_get_items

Pobieranie notatki kredytowej

Identyfikator operacji:

RetrieveCreditNote

Ten punkt końcowy zapewnia dostęp do odczytu i zapisu do notatek kredytowych, a także możliwość renderowania dokumentu jako pliku PDF w celu jego pobrania. Notatki kredytowe można utworzyć jako wersję roboczą lub sfinalizowaną w trybie otwierania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Nazwa	Ścieżka	Typ	Opis
city	address.city	string
Kod kraju	address.countryCode	string
nazwa	address.name	string
ulica	address.street	string
Dodatek	address.supplement	string
zip	address.zip	string
Archiwizowane	archived	boolean
data utworzenia	createdDate	date-time
id	id	uuid
Wprowadzenie	introduction	string
język	language	string
lineItems	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
nazwa	lineItems.name	string
ilość	lineItems.quantity	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
waluta	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
identyfikator organizacji	organizationId	uuid
uwaga	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
waluta	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	float
totalNetAmount	totalPrice.totalNetAmount	float
totalTaxAmount	totalPrice.totalTaxAmount	float
zaktualizowana data	updatedDate	date-time
wersja	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Pobieranie notatki o dostawie

Identyfikator operacji:

RetrieveDeliveryNote

Zwraca notatkę dostawy z wartością identyfikatora {id}.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Nazwa	Ścieżka	Typ	Opis
city	address.city	string
Kod kraju	address.countryCode	string
nazwa	address.name	string
ulica	address.street	string
Dodatek	address.supplement	string
zip	address.zip	string
Archiwizowane	archived	boolean
data utworzenia	createdDate	date-time
deliveryTerms	deliveryTerms	string
id	id	uuid
Wprowadzenie	introduction	string
język	language	string
lineItems	lineItems	array of object
nazwa	lineItems.name	string
ilość	lineItems.quantity	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
waluta	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
identyfikator organizacji	organizationId	uuid
uwaga	remark	string
taxType	taxConditions.taxType	string
title	title	string
zaktualizowana data	updatedDate	date-time
wersja	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Pobieranie oferty

Identyfikator operacji:

RetrieveQuotation

Zwraca cudzysłów z wartością identyfikatora {id}. Renderowanie dokumentu cudzysłowu (PDF)

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Nazwa	Ścieżka	Typ	Opis
city	address.city	string
contactId	address.contactId	uuid
Kod kraju	address.countryCode	string
nazwa	address.name	string
ulica	address.street	string
zip	address.zip	string
Archiwizowane	archived	boolean
data utworzenia	createdDate	date-time
data wygaśnięcia	expirationDate	date-time
documentFileId	files.documentFileId	uuid
id	id	uuid
Wprowadzenie	introduction	string
język	language	string
lineItems	lineItems	array of object
alternatywa	lineItems.alternative	boolean
discountPercentage	lineItems.discountPercentage	number
id	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
nazwa	lineItems.name	string
optional	lineItems.optional	boolean
ilość	lineItems.quantity	number
Podelementy	lineItems.subItems	array of object
alternatywa	lineItems.subItems.alternative	boolean
discountPercentage	lineItems.subItems.discountPercentage	number
id	lineItems.subItems.id	uuid
lineItemAmount	lineItems.subItems.lineItemAmount	number
nazwa	lineItems.subItems.name	string
optional	lineItems.subItems.optional	boolean
ilość	lineItems.subItems.quantity	number
typ	lineItems.subItems.type	string
unitName	lineItems.subItems.unitName	string
waluta	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
waluta	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
identyfikator organizacji	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
uwaga	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
waluta	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
zaktualizowana data	updatedDate	date-time
wersja	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Pobieranie pliku

Identyfikator operacji:

DownloadFile_Lexoffice

Użyj tego punktu końcowego, aby pobrać pliki.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pliku	fileId	True	string	Określ identyfikator pliku.
Akceptuj	Accept		string	Określ akceptowanie.

Zwraca

response

file

Pobieranie potwierdzenia zamówienia

Identyfikator operacji:

RetrieveOrderConfirmation

Zwraca potwierdzenie zamówienia z wartością identyfikatora {id}.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Nazwa	Ścieżka	Typ	Opis
city	address.city	string
Kod kraju	address.countryCode	string
nazwa	address.name	string
ulica	address.street	string
Dodatek	address.supplement	string
zip	address.zip	string
Archiwizowane	archived	boolean
data utworzenia	createdDate	date-time
deliveryTerms	deliveryTerms	string
documentFileId	files.documentFileId	uuid
id	id	uuid
Wprowadzenie	introduction	string
język	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
id	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
nazwa	lineItems.name	string
ilość	lineItems.quantity	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
waluta	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
identyfikator organizacji	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
uwaga	remark	string
data wysyłki	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
waluta	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
zaktualizowana data	updatedDate	date-time
wersja	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Pobieranie subskrypcji zdarzeń

Identyfikator operacji:

RetrieveAEventSubscription

Pobieranie subskrypcji zdarzeń

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator subskrypcji	subscriptionId	True	string	Określ identyfikator subskrypcji.

Zwraca

Body

EventSubscriptionResponse

Pobieranie szablonu cyklicznego

Identyfikator operacji:

RetrieveRecurringTemplate

Zwraca szablon cykliczny o wartości identyfikatora {id}.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Nazwa	Ścieżka	Typ	Opis
city	address.city	string
contactId	address.contactId	uuid
Kod kraju	address.countryCode	string
nazwa	address.name	string
ulica	address.street	string
zip	address.zip	string
Archiwizowane	archived	boolean
data utworzenia	createdDate	date-time
id	id	uuid
Wprowadzenie	introduction	string
język	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
nazwa	lineItems.name	string
ilość	lineItems.quantity	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
waluta	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
identyfikator organizacji	organizationId	uuid
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
recurringTemplateSettings	recurringTemplateSettings	object
uwaga	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
waluta	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
zaktualizowana data	updatedDate	date-time
wersja	version	integer

Pobieranie wszystkich kontaktów

Identyfikator operacji:

RetrieveAllContacts

Pobieranie wszystkich kontaktów

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Number	number		integer	Określ liczbę.
Email	email		string	Określ wiadomość e-mail.
Name	name		string	Określ nazwę.
Sprzedawca	vendor		boolean	Określ dostawcę.
Klient	customer		boolean	Określ klienta.
Strona	page		integer	Określ stronę.
Rozmiar	size		integer	Określ rozmiar.
Sortuj	sort		string	Określ sortowanie.

Zwraca

Body

Response_contacts_get

Pobieranie wszystkich subskrypcji zdarzeń

Identyfikator operacji:

RetrieveAllEventSubscriptions

Pobieranie wszystkich subskrypcji zdarzeń

Zwraca

Body

Response_event-subscriptions_get

Pobieranie wszystkich szablonów cyklicznych

Identyfikator operacji:

RetrieveAllRecurringTemplates

Pobieranie kolekcji szablonów cyklicznych. Wynik zwraca tylko część najbardziej odpowiednich danych, do których odwołuje się kontakt (tylko identyfikator i nazwa), łączną cenę, warunki płatności i pełne ustawienia szablonów cyklicznych. Jednak nazewnictwo obiektów i właściwości jest takie samo.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Strona	page		integer	Określ stronę.
Rozmiar	size		integer	Określ rozmiar.
Sortuj	sort		string	Określ sortowanie.

Zwraca

Body

Response_recurring-templates_get

Pobieranie zrzutu

Identyfikator operacji:

RetrieveDunning

Zwraca przebieg z wartością identyfikatora {id}.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Dunningsid	dunningsid	True	string	Określ identyfikator dunningsid.

Zwraca

Nazwa	Ścieżka	Typ	Opis
city	address.city	string
Kod kraju	address.countryCode	string
nazwa	address.name	string
ulica	address.street	string
Dodatek	address.supplement	string
zip	address.zip	string
Archiwizowane	archived	boolean
data utworzenia	createdDate	date-time
id	id	uuid
Wprowadzenie	introduction	string
język	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
nazwa	lineItems.name	string
ilość	lineItems.quantity	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
waluta	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
identyfikator organizacji	organizationId	uuid
relatedVouchers	relatedVouchers	array of object
id	relatedVouchers.id	uuid
voucherNumber	relatedVouchers.voucherNumber	string
voucherType	relatedVouchers.voucherType	string
uwaga	remark	string
data wysyłki	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
waluta	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
zaktualizowana data	updatedDate	date-time
wersja	version	integer
voucherDate	voucherDate	date-time
voucherStatus	voucherStatus	string

Przekazywanie pliku

Identyfikator operacji:

UploadFile_Lexoffice

Ten punkt końcowy służy do przekazywania plików, np. bonów lub faktur.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
File	file	True	file	Plik do przekazania.
Typ	type	True	string	Opis zawartości pliku.

Zwraca

Body

Response_files_post

Przekazywanie pliku do bonu

Identyfikator operacji:

UploadFileVoucher_Lexoffice

Przekaż i przypisz pliki (pdf lub obraz) do bonu zidentyfikowany przez użytkownika {id}.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.
File	file	True	file	Plik do przekazania.

Renderowanie dokumentu cudzysłowu (PDF)

Identyfikator operacji:

RenderQuotationDocument

Aby pobrać plik PDF dokumentu cudzysłowu, potrzebny jest jego identyfikator documentFileId. Ten identyfikator jest zwykle zwracany przez zasób cudzysłowu. Jednak nowo utworzone cudzysłów w stanie otwartym za pośrednictwem interfejsu API muszą wyzwolić renderowanie pliku dokumentu pdf oddzielnie. Można to zrobić za pomocą tego punktu końcowego.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Nazwa	Ścieżka	Typ	Opis
documentFileId	documentFileId	uuid

Renderowanie dokumentu dunning (PDF)

Identyfikator operacji:

RenderDunningDocument

Aby pobrać plik pdf z dokumentem rozpieszanym, potrzebny jest jego identyfikator documentFileId. Ten identyfikator jest zwykle zwracany przez zasób tworzenia zrzutu. Jednak nowo utworzone przebiegi za pośrednictwem interfejsu API muszą wyzwolić renderowanie pliku dokumentu PDF oddzielnie. Można to zrobić za pomocą tego punktu końcowego.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Dunningsid	dunningsid	True	string	Określ identyfikator dunningsid.

Zwraca

Nazwa	Ścieżka	Typ	Opis
documentFileId	documentFileId	uuid

Renderowanie dokumentu faktury (PDF)

Identyfikator operacji:

RenderInvoiceDocument

Aby pobrać plik PDF dokumentu z fakturą, potrzebny jest jego identyfikator documentFileId. Ten identyfikator jest zwykle zwracany przez zasób faktury. Jednak nowo utworzone faktury w stanie otwartym za pośrednictwem interfejsu API muszą wyzwolić renderowanie pliku dokumentu pdf oddzielnie. Można to zrobić za pomocą tego punktu końcowego.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Nazwa	Ścieżka	Typ	Opis
documentFileId	documentFileId	uuid

Renderowanie dokumentu notatki dotyczącej dostarczania (PDF)

Identyfikator operacji:

RenderDeliveryNoteDocument

Ten punkt końcowy zapewnia dostęp do odczytu i zapisu do notatek dostarczania, a także możliwość renderowania dokumentu jako pliku PDF w celu jego pobrania. Notatki dotyczące dostarczania są zawsze tworzone w trybie roboczym i nie muszą być finalizowane.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Noteid dostawy	DeliveryNoteid	True	string	Określ zanotuj dostawę.

Zwraca

Nazwa	Ścieżka	Typ	Opis
city	address.city	string
Kod kraju	address.countryCode	string
nazwa	address.name	string
ulica	address.street	string
Dodatek	address.supplement	string
zip	address.zip	string
Archiwizowane	archived	boolean
data utworzenia	createdDate	date-time
deliveryTerms	deliveryTerms	string
id	id	uuid
Wprowadzenie	introduction	string
język	language	string
lineItems	lineItems	array of object
nazwa	lineItems.name	string
ilość	lineItems.quantity	number
typ	lineItems.type	string
unitName	lineItems.unitName	string
waluta	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
identyfikator organizacji	organizationId	uuid
uwaga	remark	string
taxType	taxConditions.taxType	string
title	title	string
zaktualizowana data	updatedDate	date-time
wersja	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Renderowanie dokumentu notatki kredytowej (PDF)

Identyfikator operacji:

RenderCreditNoteDocument

Aby pobrać plik PDF dokumentu notatki kredytowej, potrzebny jest jego identyfikator documentFileId. Ten identyfikator jest zwykle zwracany przez zasób noty kredytowej. Jednak nowo utworzone notatki kredytowe w stanie otwartym za pośrednictwem interfejsu API muszą wyzwolić renderowanie pliku dokumentu pdf oddzielnie. Można to zrobić za pomocą tego punktu końcowego.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Nazwa	Ścieżka	Typ	Opis
documentFileId	documentFileId	uuid

Renderowanie dokumentu potwierdzenia zamówienia (PDF)

Identyfikator operacji:

RenderOrderConfirmationDocument

Aby pobrać plik PDF dokumentu potwierdzenia zamówienia, potrzebny jest jego identyfikator documentFileId. Ten identyfikator jest zwykle zwracany przez zasób potwierdzenia zamówienia. Jednak nowo utworzone potwierdzenia zamówienia za pośrednictwem interfejsu API muszą wyzwolić renderowanie pliku dokumentu PDF oddzielnie. Można to zrobić za pomocą tego punktu końcowego.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Zwraca

Nazwa	Ścieżka	Typ	Opis
documentFileId	documentFileId	uuid

Tworzenie artykułu

Identyfikator operacji:

CreateArticle

Zawartość artykułu jest oczekiwana w treści żądania jako aplikacja/json.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
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

Zwraca

Body

Response_articles_post

Tworzenie bonu

Identyfikator operacji:

CreateVoucher

Tworzenie bonów (ograniczonych do kuponów sprzedaży)

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
contactId	contactId		string
data ukończenia	dueDate		date
uwaga	remark		string
data wysyłki	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
typ	type	True	string
useCollectiveContact	useCollectiveContact		boolean
voucherDate	voucherDate		date
kwota	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Zwraca

Body

Response_vouchers_post

Tworzenie faktury

Identyfikator operacji:

CreateInvoice

Faktury przesyłane za pośrednictwem interfejsu API są tworzone w trybie roboczym na wartość domyślną. Aby utworzyć sfinalizowaną fakturę ze stanem, należy ustawić opcjonalny parametr zapytania. Nie można zmienić stanu faktury za pośrednictwem interfejsu API.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Poprzedzający identyfikator kuponu sprzedaży	precedingSalesVoucherId		string	Określ poprzedni identyfikator kuponu sprzedaży.
Zakończ	finalize	True	boolean	Określ finalizowanie.

Zwraca

Body

Response_invoices_post

Tworzenie kontaktu

Identyfikator operacji:

CreateContact

Tworzenie nowego kontaktu

Zwraca

Body

Response_contacts_post

Tworzenie kwantowania

Identyfikator operacji:

CreateDunning

Utworzone przebiegi nie będą wyświetlane na głównej liście kuponów w lexoffice, ale zostaną dołączone do faktury i będą tam widoczne. Aby zapewnić klientom dostęp do utworzonego narzędzia dunning, użyj naszej funkcji deeplink.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Poprzedzający identyfikator kuponu sprzedaży	precedingSalesVoucherId		string	Określ poprzedni identyfikator kuponu sprzedaży.

Zwraca

Body

Response_dunnings_post

Tworzenie notatki dotyczącej dostarczania

Identyfikator operacji:

CreateDeliveryNote

Utworzona notatka dostawy zostanie wyświetlona na głównej liście kuponów w lexoffice. Notatki dotyczące dostarczania przesyłane za pośrednictwem interfejsu API są tworzone tylko w trybie roboczym.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Poprzedzający identyfikator kuponu sprzedaży	precedingSalesVoucherId		string	Określ poprzedni identyfikator kuponu sprzedaży.

Zwraca

Body

Response_delivery-notes_post

Tworzenie notatki kredytowej

Identyfikator operacji:

CreateCreditNote

Notatki kredytowe przesyłane za pośrednictwem interfejsu API są tworzone w trybie roboczym na wartość domyślną. Aby utworzyć sfinalizowaną notatkę kredytową ze stanem, należy ustawić opcjonalny parametr zapytania. Nie można zmienić stanu notatki kredytowej za pośrednictwem interfejsu API

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Poprzedzający identyfikator kuponu sprzedaży	precedingSalesVoucherId		string	Określ poprzedni identyfikator kuponu sprzedaży.
Zakończ	finalize	True	boolean	Określ finalizowanie.

Zwraca

Body

Response_credit-notes_post

Tworzenie oferty

Identyfikator operacji:

CreateQuotation

Cudzysłów przesyłanych za pośrednictwem interfejsu API są tworzone w trybie roboczym na wartość domyślną. Aby utworzyć sfinalizowany cudzysłów ze stanem, należy ustawić opcjonalny parametr zapytania. Nie można zmienić stanu cudzysłowu za pośrednictwem interfejsu API.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Zakończ	finalize	True	boolean	Określ finalizowanie.

Zwraca

Body

Response_quotations_post

Tworzenie potwierdzenia zamówienia

Identyfikator operacji:

CreateOrderConfirmation

Ten punkt końcowy zapewnia dostęp do odczytu i zapisu w celu potwierdzenia zamówienia, a także możliwość renderowania dokumentu jako pliku PDF w celu jego pobrania. Potwierdzenia zamówień są zawsze tworzone w trybie roboczym i nie muszą być finalizowane.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Poprzedzający identyfikator kuponu sprzedaży	precedingSalesVoucherId		string	Określ poprzedni identyfikator kuponu sprzedaży.

Zwraca

Body

Response_order-confirmations_post

Usuwanie artykułu

Identyfikator operacji:

DeleteAnArticle

Usuwa artykuł o wartości identyfikatora {id}. Zwraca wartość 204 dla powodzenia lub 404, jeśli identyfikator nie istnieje.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Id	id	True	string	Określ identyfikator.

Usuwanie Event-Subscription

Identyfikator operacji:

DeleteEventSubscription

Usuń element WebHook wyzwalacza

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator subskrypcji	subscriptionId	True	string	Określ identyfikator subskrypcji.

Wyzwalaczy

Wybieranie niestandardowego wyzwalacza

Rejestrowanie nowego wyzwalacza dla punktu końcowego kontaktów

Wybieranie niestandardowego wyzwalacza

Identyfikator operacji:

EventSubscription_Lexoffice

Rejestrowanie nowego wyzwalacza dla punktu końcowego kontaktów

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Typ zdarzenia	eventType	True	string	eventType

Zwraca

Nazwa	Ścieżka	Typ	Opis
eventDate	eventDate	string	eventDate
eventType	eventType	string	eventType
identyfikator organizacji	organizationId	string	identyfikator organizacji
resourceId	resourceId	string	resourceId

Definicje

EventSubscriptionResponse

Nazwa	Ścieżka	Typ	Opis
Identyfikator subskrypcji	subscriptionId	string
eventType	eventType	string
identyfikator organizacji	organizationId	string
data utworzenia	createdDate	date-time
callbackUrl (adres URL wywołania zwrotnego)	callbackUrl	string

Response_articles_get

Nazwa	Ścieżka	Typ	Opis
zawartość	content	array of object	zawartość
articleNumber	content.articleNumber	string	articleNumber
gtin	content.gtin	string	gtin
id	content.id	string	id
nuta	content.note	string	nuta
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
wersja	content.version	integer	wersja
pierwszy	first	boolean	pierwszy
last	last	boolean	last
Liczba	number	integer	Liczba
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sortować	sort	array of object	sortować
rosnący	sort.ascending	boolean	rosnący
kierunek	sort.direction	string	kierunek
ignoreCase (Wielkość liter)	sort.ignoreCase	boolean	ignoreCase (Wielkość liter)
nullHandling	sort.nullHandling	string	nullHandling
właściwość	sort.property	string	właściwość
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_articles_id_get

Nazwa	Ścieżka	Typ	Opis
articleNumber	articleNumber	string	articleNumber
gtin	gtin	string	gtin
id	id	string	id
nuta	note	string	nuta
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
wersja	version	integer	wersja

Response_articles_post

Nazwa	Ścieżka	Typ	Opis
data utworzenia	createdDate	string	data utworzenia
id	id	string	id
resourceUri	resourceUri	string	resourceUri
zaktualizowana data	updatedDate	string	zaktualizowana data
wersja	version	integer	wersja

Response_contacts_get

Nazwa	Ścieżka	Typ	Opis
zawartość	content	array of object	zawartość
rozliczenia	content.addresses.billing	array of object	rozliczenia
city	content.addresses.billing.city	string	city
Kod kraju	content.addresses.billing.countryCode	string	Kod kraju
ulica	content.addresses.billing.street	string	ulica
Dodatek	content.addresses.billing.supplement	string	Dodatek
zip	content.addresses.billing.zip	string	zip
żegluga	content.addresses.shipping	array of object	żegluga
city	content.addresses.shipping.city	string	city
Kod kraju	content.addresses.shipping.countryCode	string	Kod kraju
ulica	content.addresses.shipping.street	string	ulica
Dodatek	content.addresses.shipping.supplement	string	Dodatek
zip	content.addresses.shipping.zip	string	zip
Archiwizowane	content.archived	boolean	Archiwizowane
allowTaxFreeInvoices	content.company.allowTaxFreeInvoices	boolean	allowTaxFreeInvoices
contactPersons	content.company.contactPersons	array of object	contactPersons
adres e-mail	content.company.contactPersons.emailAddress	string	adres e-mail
imię	content.company.contactPersons.firstName	string	imię
nazwisko	content.company.contactPersons.lastName	string	nazwisko
podstawowy	content.company.contactPersons.primary	boolean	podstawowy
Zwrot grzecznościowy	content.company.contactPersons.salutation	string	Zwrot grzecznościowy
nazwa	content.company.name	string	nazwa
Numer podatkowy	content.company.taxNumber	string	Numer podatkowy
vatRegistrationId	content.company.vatRegistrationId	string	vatRegistrationId
biznes	content.emailAddresses.business	array of string	biznes
biuro	content.emailAddresses.office	array of string	biuro
other	content.emailAddresses.other	array of string	other
id	content.id	string	id
nuta	content.note	string	nuta
identyfikator organizacji	content.organizationId	string	identyfikator organizacji
biznes	content.phoneNumbers.business	array of string	biznes
faks	content.phoneNumbers.fax	array of string	faks
biuro	content.phoneNumbers.office	array of string	biuro
other	content.phoneNumbers.other	array of string	other
Liczba	content.roles.customer.number	integer	Liczba
Liczba	content.roles.vendor.number	integer	Liczba
wersja	content.version	integer	wersja
pierwszy	first	boolean	pierwszy
last	last	boolean	last
Liczba	number	integer	Liczba
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sortować	sort	array of object	sortować
rosnący	sort.ascending	boolean	rosnący
kierunek	sort.direction	string	kierunek
ignoreCase (Wielkość liter)	sort.ignoreCase	boolean	ignoreCase (Wielkość liter)
nullHandling	sort.nullHandling	string	nullHandling
właściwość	sort.property	string	właściwość
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_contacts_post

Nazwa	Ścieżka	Typ	Opis
data utworzenia	createdDate	string	data utworzenia
id	id	string	id
resourceUri	resourceUri	string	resourceUri
zaktualizowana data	updatedDate	string	zaktualizowana data
wersja	version	integer	wersja

Response_countries_get_default

Nazwa	Ścieżka	Typ	Opis
Kod kraju	countryCode	string	Kod kraju
countryNameDE	countryNameDE	string	countryNameDE
countryNameEN	countryNameEN	string	countryNameEN
taxClassification	taxClassification	string	taxClassification

Response_credit-notes_post

Nazwa	Ścieżka	Typ	Opis
data utworzenia	createdDate	string	data utworzenia
id	id	string	id
resourceUri	resourceUri	string	resourceUri
zaktualizowana data	updatedDate	string	zaktualizowana data
wersja	version	integer	wersja

Response_delivery-notes_post

Nazwa	Ścieżka	Typ	Opis
data utworzenia	createdDate	string	data utworzenia
id	id	string	id
resourceUri	resourceUri	string	resourceUri
zaktualizowana data	updatedDate	string	zaktualizowana data
wersja	version	integer	wersja

Response_dunnings_post

Nazwa	Ścieżka	Typ	Opis
data utworzenia	createdDate	string	data utworzenia
id	id	string	id
resourceUri	resourceUri	string	resourceUri
zaktualizowana data	updatedDate	string	zaktualizowana data
wersja	version	integer	wersja

Response_event-subscriptions_get

Nazwa	Ścieżka	Typ	Opis
zawartość	content	array of object	zawartość
callbackUrl (adres URL wywołania zwrotnego)	content.callbackUrl	string	callbackUrl (adres URL wywołania zwrotnego)
data utworzenia	content.createdDate	string	data utworzenia
eventType	content.eventType	string	eventType
identyfikator organizacji	content.organizationId	string	identyfikator organizacji
Identyfikator subskrypcji	content.subscriptionId	string	Identyfikator subskrypcji

Response_files_post

Nazwa	Ścieżka	Typ	Opis
id	id	string	id

Response_invoices_post

Nazwa	Ścieżka	Typ	Opis
data utworzenia	createdDate	string	data utworzenia
id	id	string	id
resourceUri	resourceUri	string	resourceUri
zaktualizowana data	updatedDate	string	zaktualizowana data
wersja	version	integer	wersja

Response_order-confirmations_post

Nazwa	Ścieżka	Typ	Opis
data utworzenia	createdDate	string	data utworzenia
id	id	string	id
resourceUri	resourceUri	string	resourceUri
zaktualizowana data	updatedDate	string	zaktualizowana data
wersja	version	integer	wersja

Response_payment-conditions_get_items

Nazwa	Ścieżka	Typ	Opis
id	id	string	id
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

Nazwa	Ścieżka	Typ	Opis
contactRequired	contactRequired	boolean	contactRequired
groupName	groupName	string	groupName
id	id	string	id
nazwa	name	string	nazwa
splitAllowed	splitAllowed	boolean	splitAllowed
typ	type	string	typ

Response_profile_get

Nazwa	Ścieżka	Typ	Opis
businessFeatures	businessFeatures	array of string	businessFeatures
companyName	companyName	string	companyName
identyfikator połączenia	connectionId	string	identyfikator połączenia
date	created.date	string	date
Adres e-mail użytkownika	created.userEmail	string	Adres e-mail użytkownika
userId	created.userId	string	userId
userName	created.userName	string	userName
features	features	array of string	features
identyfikator organizacji	organizationId	string	identyfikator organizacji
Smallbusiness	smallBusiness	boolean	Smallbusiness
subscriptionStatus (status) subskrypcji	subscriptionStatus	string	subscriptionStatus (status) subskrypcji
taxType	taxType	string	taxType

Response_quotations_post

Nazwa	Ścieżka	Typ	Opis
data utworzenia	createdDate	string	data utworzenia
id	id	string	id
resourceUri	resourceUri	string	resourceUri
zaktualizowana data	updatedDate	string	zaktualizowana data
wersja	version	integer	wersja

Response_recurring-templates_get

Nazwa	Ścieżka	Typ	Opis
zawartość	content	array of object	zawartość
contactId	content.address.contactId	string	contactId
nazwa	content.address.name	string	nazwa
data utworzenia	content.createdDate	string	data utworzenia
id	content.id	string	id
identyfikator organizacji	content.organizationId	string	identyfikator organizacji
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
data zakończenia	content.recurringTemplateSettings.endDate	string	data zakończenia
executionInterval	content.recurringTemplateSettings.executionInterval	string	executionInterval
Executionstatus	content.recurringTemplateSettings.executionStatus	string	Executionstatus
Finalize	content.recurringTemplateSettings.finalize	boolean	Finalize
id	content.recurringTemplateSettings.id	string	id
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
waluta	content.totalPrice.currency	string	waluta
totalGrossAmount	content.totalPrice.totalGrossAmount	integer	totalGrossAmount
totalNetAmount	content.totalPrice.totalNetAmount	float	totalNetAmount
zaktualizowana data	content.updatedDate	string	zaktualizowana data
pierwszy	first	boolean	pierwszy
last	last	boolean	last
Liczba	number	integer	Liczba
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sortować	sort	array of object	sortować
rosnący	sort.ascending	boolean	rosnący
kierunek	sort.direction	string	kierunek
ignoreCase (Wielkość liter)	sort.ignoreCase	boolean	ignoreCase (Wielkość liter)
nullHandling	sort.nullHandling	string	nullHandling
właściwość	sort.property	string	właściwość
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_voucherlist_get

Nazwa	Ścieżka	Typ	Opis
zawartość	content	array of object	zawartość
Archiwizowane	content.archived	boolean	Archiwizowane
contactId	content.contactId	string	contactId
contactName (nazwa kontaktu)	content.contactName	string	contactName (nazwa kontaktu)
data utworzenia	content.createdDate	string	data utworzenia
waluta	content.currency	string	waluta
data ukończenia	content.dueDate	string	data ukończenia
id	content.id	string	id
openAmount	content.openAmount	float	openAmount
kwotaCałkowita	content.totalAmount	float	kwotaCałkowita
zaktualizowana data	content.updatedDate	string	zaktualizowana data
voucherDate	content.voucherDate	string	voucherDate
voucherNumber	content.voucherNumber	string	voucherNumber
voucherStatus	content.voucherStatus	string	voucherStatus
voucherType	content.voucherType	string	voucherType
pierwszy	first	boolean	pierwszy
last	last	boolean	last
Liczba	number	integer	Liczba
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sortować	sort	array of object	sortować
rosnący	sort.ascending	boolean	rosnący
kierunek	sort.direction	string	kierunek
ignoreCase (Wielkość liter)	sort.ignoreCase	boolean	ignoreCase (Wielkość liter)
nullHandling	sort.nullHandling	string	nullHandling
właściwość	sort.property	string	właściwość
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_vouchers_post

Nazwa	Ścieżka	Typ	Opis
data utworzenia	createdDate	string	data utworzenia
id	id	string	id
resourceUri	resourceUri	string	resourceUri
zaktualizowana data	updatedDate	string	zaktualizowana data
wersja	version	integer	wersja

Response_contacts_id_put

Nazwa	Ścieżka	Typ	Opis
Archiwizowane	archived	boolean
id	id	uuid
identyfikator organizacji	organizationId	uuid
imię	person.firstName	string
nazwisko	person.lastName	string
Zwrot grzecznościowy	person.salutation	string
Liczba	roles.customer.number	integer
wersja	version	integer

Response_vouchers_id_put

Nazwa	Ścieżka	Typ	Opis
data utworzenia	createdDate	date-time
data ukończenia	dueDate	date-time
files	files	array of object
items	files	object
id	id	uuid
identyfikator organizacji	organizationId	uuid
uwaga	remark	string
data wysyłki	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
typ	type	string
zaktualizowana data	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
wersja	version	integer
voucherDate	voucherDate	date-time
voucherItems	voucherItems	array of object
kwota	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

plik

Jest to podstawowy typ danych "file".