Lexoffice (Bağımsız Yayımcı) (Önizleme)

Lexware API'si makaleler, kişiler, faturalar, siparişler ve dosya yönetimi gibi temel Lexware iş işlevlerine programlı erişim sağlar. Bu Bağımsız Yayımcı bağlayıcısı, Lexware'in REST API'siyle güvenli tümleştirme sağlar ve kullanıcıların iş verileri oluşturup almasına, süreçleri otomatikleştirmesine ve Lexware kaynaklarını Power Platform uygulamalarına bağlamasına olanak tanır. Bağlayıcı, güvenli kimlik doğrulaması ve API yönergeleri için OAuth 2.0 Yetkilendirme Kodu Akışı'nı kullanır.

Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:

Hizmet	Class	Bölgeler
Copilot Studio	Premium	Aşağıdakiler dışında tüm Power Automate bölgeleri :      - ABD Kamu (GCC)      - US Government (GCC High)      - 21Vianet tarafından işletilen Çin Bulutu      - ABD Savunma Bakanlığı (DoD)
Logic Apps	Standart	Aşağıdakiler dışında tüm Logic Apps bölgeleri :      - Azure Kamu bölgeleri      - Azure Çin bölgeleri      - ABD Savunma Bakanlığı (DoD)
Power Apps	Premium	Aşağıdakiler dışında tüm Power Apps bölgeleri :      - ABD Kamu (GCC)      - US Government (GCC High)      - 21Vianet tarafından işletilen Çin Bulutu      - ABD Savunma Bakanlığı (DoD)
Power Automate	Premium	Aşağıdakiler dışında tüm Power Automate bölgeleri :      - ABD Kamu (GCC)      - US Government (GCC High)      - 21Vianet tarafından işletilen Çin Bulutu      - ABD Savunma Bakanlığı (DoD)

İletişim
İsim	LowCode Araştırmacı Desteği
URL	https://lowcode-investigator.com/
E-posta	kontakt@lowcodeinvestigator.com

Bağlayıcı Meta Verileri
Publisher	LowCodeInvestigator
Web sitesi	https://office.lexware.de/
Gizlilik ilkesi	https://office.lexware.de/datenschutz/
Kategoriler	İş Yönetimi; Maliye

Lexware API Bağlayıcısı (Bağımsız Yayımcı)

Lexware API,geliştiricilerin kişiler, faturalar, makaleler ve dosyalar gibi Lexware iş işlevlerini kendi uygulamalarıyla tümleştirmesine olanak sağlayan bir RESTful arabirimidir. Bu bağlayıcı güvenli, kimliği doğrulanmış API istekleri aracılığıyla bu kaynaklarla doğrudan etkileşime olanak tanır.

Yayımcı: Bağımsız Yayımcı

Önkoşullar

• Kayıtlı bir Lexware hesabı ve uygun bir lisans
• Lexware Geliştirici Portalı aracılığıyla alınan geçerli bir API anahtarı (erişim belirteci)
• Kimlik doğrulaması için OAuth 2.0 Yetkilendirme Kodu Akışı gereklidir

Desteklenen İşlemler

Bu bağlayıcı aşağıdaki Lexware API uç noktalarını destekler:

• Makaleler: Makale oluşturma, alma, güncelleştirme, silme ve filtreleme makaleleri
• İlgili Kişiler: Müşteri ve satıcı verilerini yönetme
• Faturalar: PDF'leri işleme de dahil olmak üzere fatura verilerini oluşturma ve alma
• Kredi Notları, Teslim Notları, Siparişler, Teklifler ve Fişler
• Ülkeler, Ödeme Koşulları, Yazdırma Düzenleri ve Profiller
• Olay Abonelikleri ve Dosyaları
• Belgelenen tam liste: Lexware API Belgeleri

Kimlik Bilgilerini Alma

Lexware API'sini çağırmak için bir API anahtarı gerekir:

1. Lexware Office hesabınızda oturum açın.
2. Weitere Apps → Genel API → Uzantılar'a gidin veya
   Lexware Geliştirici Portalı doğrudan.
3. İstenen izinlere sahip yeni bir API anahtarı oluşturun.
4. Oluşturulan API anahtarını kopyalayın. Bu değer bağlayıcıda olduğu gibi accessToken kullanılır.

API Ağ Geçidi

Lütfen yeni Lexware API ağ geçidini kullanın:

https://api.lexware.io

Hız Sınırları

• En fazla 2 istek/saniye
• Bu sınırı aşan istekler HTTP alır 429 Too Many Requests
• Önerilen: Belirteç demet algoritması veya üstel geri alma kullanma

Authentication

Lexware API'sinde OAuth 2.0 Yetkilendirme Kodu Akışı kullanılır. Belirteci her isteğin Authorization: Bearer {accessToken} üst bilgisine ekleyin.

Örnek Kullanım

Makale oluşturma:

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

Bilinen Sorunlar ve Sınırlamalar

• En fazla 2 istek/saniye
• Bazı uç noktalar için ek izinler veya roller gerekir

API Belgeleri

Tam API başvurusuna şu konumdan ulaşabilirsiniz:
https://developers.lexware.io/docs/

Bağlantı oluşturma

Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:

Varsayılan	Bağlantı oluşturmak için parametreler.	Tüm bölgeler	Paylaşılamaz

Temerrüt

Geçerli: Tüm bölgeler

Bağlantı oluşturmak için parametreler.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

İsim	Türü	Description	Gerekli
API Anahtarı	securestring	Bu API için API Anahtarı	Doğru

Azaltma Sınırları

Name	Çağrılar	Yenileme Dönemi
Bağlantı başına API çağrıları	100	60 saniye

Eylemler

Bir Dosya Yükle	Fişler veya faturalar gibi dosyaları karşıya yüklemek için bu uç noktayı kullanın.
Deftere Nakil Kategorilerinin Listesini Alma	Bu uç nokta, lexoffice'te desteklenen (muhasebe) fiş geliri veya giderleri için deftere nakil kategorileri listesine okuma erişimi sağlar.
Dosya İndirme	Dosyaları indirmek için bu uç noktayı kullanın.
Dunning alma	Kimlik değeri {id} olan dunning değerini döndürür.
Dunning oluşturma	Oluşturulan dunning, Lexoffice'teki ana fiş listesinde gösterilmez, ancak bir faturaya eklenir ve orada görünür. Müşterilerinize oluşturulan dunning erişimi sağlamak için lütfen deeplink işlevimizi kullanın.
Event-Subscription silme	Tetikleyici Web Kancasını Sil
Fatura Alma	{id} kimlik değerine sahip faturayı döndürür.
Fatura Belgesini İşleme (PDF)	Bir fatura belgesinin pdf dosyasını indirmek için documentFileId değeri gerekir. Bu kimlik genellikle fatura kaynağı tarafından döndürülür. Ancak, API aracılığıyla açık durumda yeni oluşturulan faturaların pdf belge dosyasının işlenmesini ayrı olarak tetiklemeleri gerekir. Bu, bu uç noktayla yapılabilir.
Fatura Oluşturma	API aracılığıyla iletilen faturalar varsayılan olarak taslak modunda oluşturulur. Durumu açık olan bir son haline getirilmiş fatura oluşturmak için isteğe bağlı sorgu parametresinin son halinin ayarlanması gerekir. Faturanın durumu API aracılığıyla değiştirilemez.
Fiş Listesini Alma ve Filtreleme	Kupon listesi (muhasebe) kuponları (örneğin salesinvoices, salescreditnotes), faturalar (peşinat faturaları dahil), alacak dekontları, sipariş onayları, teklifler ve teslim notlarını alın.
Kişi Alma	Kimliğine göre kişi alma
Kişi Oluşturma	Yeni kişi oluşturma
Kişiyi Güncelleştirme	Kişiyi güncelleştirme
Kredi Notu Alma	Bu uç nokta, kredi notlarına okuma ve yazma erişimi ve ayrıca belgeyi indirmek için PDF olarak işleme olanağı sağlar. Kredi notları taslak olarak oluşturulabilir veya açık modda sonlandırılabilir.
Kredi Notu Belgesi İşleme (PDF)	Kredi notu belgesinin pdf dosyasını indirmek için documentFileId değeri gerekir. Bu kimlik genellikle kredi notu kaynağı tarafından döndürülür. Ancak, API aracılığıyla açılan durumda yeni oluşturulan kredi notlarının pdf belge dosyasının işlenmesini ayrı olarak tetiklemeleri gerekir. Bu, bu uç noktayla yapılabilir.
Kredi Notu Oluşturma	API aracılığıyla iletilen kredi notları varsayılan olarak taslak modunda oluşturulur. Durumu açık olan son haline getirilmiş bir kredi notu oluşturmak için isteğe bağlı sorgu parametresinin son halinin ayarlanması gerekir. Kredi notunun durumu API aracılığıyla değiştirilemez
Kupon Alma	Satış fişlerini listeleme (örn. faturalar, kredi notları)
Kupon Oluşturma	Fiş oluşturma (satış fişleriyle sınırlı)
Kupona dosya yükleme	{id} tarafından tanımlanan kupona dosya (pdf veya resim) yükleyin ve atayın.
Makale Alma	{id} kimlik değerine sahip makaleyi döndürür.
Makale Oluşturma	Makalenin içeriği isteğin gövdesinde uygulama/json olarak beklenir.
Makale Silme	{id} kimlik değerine sahip makaleyi siler. Başarı durumunda 204 veya kimlik yoksa 404 döndürür.
Makaleleri Filtreleme	Bir disk belleği mekanizması kullanarak filter_n filter_1 filtreler tarafından verilen ölçütleri karşılayan makaleleri döndürür. Birden fazla filtre verilirse mantıksal bağlayıcı AND olur. Ayarlı olmayan filtreler yoksayılır. Bu uç noktanın en büyük sayfa boyutunu denetlemek için bkz. Kaynakların Sayfalaması.
Makaleyi Güncelleştirme	{id} kimliğine sahip mevcut bir makaleyi yükte JSON olarak verilen verilerle güncelleştirin. Başarılı olduğunda bir eylem sonucu döndürür.
Makbuzu Güncelleştir	Kuponu güncelleştirme
Olay Aboneliği Alma	Olay Aboneliği Alma
Peşin ödeme faturası alma	{id} kimlik değerine sahip peşinat faturasını döndürür.
Profil Bilgilerini Alma	Aşağıdaki örnekte, temel profil bilgilerinizin nasıl alınacakları gösterilmektedir. İsteği göndermeden önce {accessToken} yer tutucusunun değiştirilmesi gerekir.
Sipariş Onay Belgesi İşleme (PDF)	Bir sipariş onay belgesinin pdf dosyasını indirmek için documentFileId değeri gerekir. Bu kimlik genellikle sipariş onay kaynağı tarafından döndürülür. Ancak, API aracılığıyla yeni oluşturulan sipariş onaylarının pdf belge dosyasını ayrı olarak işlemeyi tetiklemesi gerekir. Bu, bu uç noktayla yapılabilir.
Sipariş Onayı Alma	{id} kimlik değeriyle sipariş onayını döndürür.
Sipariş Onayı Oluşturma	Bu uç nokta, sipariş onaylarına okuma ve yazma erişimi ve ayrıca belgeyi indirmek için PDF olarak işleme olanağı sağlar. Sipariş onayları her zaman taslak modunda oluşturulur ve son halinin alınması gerekmez.
Smaç Oluşturma Belgesi (PDF)	Bir dunning belgesinin pdf dosyasını indirmek için documentFileId değeri gerekir. Bu kimlik genellikle dunning kaynağı tarafından döndürülür. Ancak API aracılığıyla yeni oluşturulan dunnings, pdf belge dosyasının işlenmesini ayrı olarak tetiklemektedir. Bu, bu uç noktayla yapılabilir.
Teklif Alma	{id} kimlik değerine sahip teklifi döndürür. Teklif Belgesi İşleme (PDF)
Teklif Belgesi İşleme (PDF)	Bir teklif belgesinin pdf dosyasını indirmek için documentFileId değeri gerekir. Bu kimlik genellikle teklif kaynağı tarafından döndürülür. Ancak, API aracılığıyla açık durumda yeni oluşturulan teklifler, pdf belge dosyasının işlenmesini ayrı olarak tetiklemektedir. Bu, bu uç noktayla yapılabilir.
Teklif Oluşturma	API aracılığıyla iletilen tırnak işaretleri varsayılan olarak taslak modunda oluşturulur. Durumu açık olan son haline getirilmiş bir teklif oluşturmak için isteğe bağlı sorgu parametresinin son halinin ayarlanması gerekir. Bir teklifin durumu api aracılığıyla değiştirilemez.
Teslim Notu Alma	{id} kimlik değerine sahip teslim notunu döndürür.
Teslim Notu Belgesini İşleme (PDF)	Bu uç nokta, teslim notlarına okuma ve yazma erişimi ve ayrıca belgeyi indirmek için PDF olarak işleme olanağı sağlar. Teslim notları her zaman taslak modunda oluşturulur ve son halinin alınması gerekmez.
Teslim Notu Oluşturma	Oluşturulan teslimat notu, Lexoffice'teki ana fiş listesinde gösterilir. API aracılığıyla iletilen teslim notları yalnızca taslak modunda oluşturulur.
Tüm Kişileri Al	Tüm Kişileri Al
Tüm Olay Aboneliklerini Alma	Tüm Olay Aboneliklerini Alma
Tüm Yinelenen Şablonları Alma	Yinelenen şablonlardan oluşan bir koleksiyon alın. Sonuç, başvurulan kişi (yalnızca kimlik ve ad), toplam fiyat, ödeme koşulları ve yinelenen şablonların tam ayarları olan en ilgili verilerin yalnızca bir bölümünü döndürür. Ancak, nesnelerin ve özelliklerin adlandırması aynıdır.
Yinelenen Şablon Alma	{id} kimlik değerine sahip yinelenen şablonu döndürür.
Ödeme Bilgilerini Alma	Ödemeler uç noktası, faturalar ve alacak dekontları dahil olmak üzere fişlerin ödeme durumuna (muhasebe veya satış) okuma erişimi sağlar.
Ödeme Koşullarının Listesini Al	Aşağıdaki örnekte, yapılandırılmış olan ödeme koşullarının listesinin nasıl alın aldığı gösterilmektedir. İsteği göndermeden önce {accessToken} yer tutucusunun değiştirilmesi gerekir.
Ülkelerin Listesini Al	Lexoffice tarafından bilinen ülkelerin listesi.

Bir Dosya Yükle

İşlem Kimliği:

UploadFile_Lexoffice

Fişler veya faturalar gibi dosyaları karşıya yüklemek için bu uç noktayı kullanın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Dosya	file	True	file	Karşıya yüklenecek dosya.
Türü	type	True	string	Dosya içeriğinin açıklaması.

Döndürülenler

Body

Response_files_post

Deftere Nakil Kategorilerinin Listesini Alma

İşlem Kimliği:

RetrieveListPostingCategories

Bu uç nokta, lexoffice'te desteklenen (muhasebe) fiş geliri veya giderleri için deftere nakil kategorileri listesine okuma erişimi sağlar.

Döndürülenler

response

array of Response_posting-categories_get_items

Dosya İndirme

İşlem Kimliği:

DownloadFile_Lexoffice

Dosyaları indirmek için bu uç noktayı kullanın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Dosya Kimliği	fileId	True	string	Dosya kimliğini belirtin.
Kabul etmek	Accept		string	Kabul et değerini belirtin.

Döndürülenler

response

file

Dunning alma

İşlem Kimliği:

RetrieveDunning

Kimlik değeri {id} olan dunning değerini döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Dunningsid	dunningsid	True	string	Dunningsid değerini belirtin.

Döndürülenler

Name	Yol	Tür	Description
city	address.city	string
ülke kodu	address.countryCode	string
name	address.name	string
sokak	address.street	string
Ek	address.supplement	string
Zip dosyası	address.zip	string
Arşivlenmiş	archived	boolean
oluşturulmaTarihi	createdDate	date-time
kimlik	id	uuid
Giriş	introduction	string
language	language	string
satır öğeleri	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
name	lineItems.name	string
miktar	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
kuruluş Kimliği	organizationId	uuid
relatedVouchers	relatedVouchers	array of object
kimlik	relatedVouchers.id	uuid
voucherNumber	relatedVouchers.voucherNumber	string
voucherType	relatedVouchers.voucherType	string
Açıklama	remark	string
shippingDate	shippingConditions.shippingDate	date-time
shippingType	shippingConditions.shippingType	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherStatus	voucherStatus	string

Dunning oluşturma

İşlem Kimliği:

CreateDunning

Oluşturulan dunning, Lexoffice'teki ana fiş listesinde gösterilmez, ancak bir faturaya eklenir ve orada görünür. Müşterilerinize oluşturulan dunning erişimi sağlamak için lütfen deeplink işlevimizi kullanın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Önceki Satış Fişi Kimliği	precedingSalesVoucherId		string	Önceki satış fişi kimliğini belirtin.

Döndürülenler

Body

Response_dunnings_post

Event-Subscription silme

İşlem Kimliği:

DeleteEventSubscription

Tetikleyici Web Kancasını Sil

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Abonelik Kimliği	subscriptionId	True	string	Abonelik kimliğini belirtin.

Fatura Alma

İşlem Kimliği:

RetrieveInvoice

{id} kimlik değerine sahip faturayı döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Name	Yol	Tür	Description
city	address.city	string
ülke kodu	address.countryCode	string
name	address.name	string
sokak	address.street	string
Ek	address.supplement	string
Zip dosyası	address.zip	string
Arşivlenmiş	archived	boolean
oluşturulmaTarihi	createdDate	date-time
kimlik	id	uuid
Giriş	introduction	string
language	language	string
satır öğeleri	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
kimlik	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
name	lineItems.name	string
miktar	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
kuruluş Kimliği	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
Açıklama	remark	string
shippingDate	shippingConditions.shippingDate	date-time
shippingType	shippingConditions.shippingType	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Fatura Belgesini İşleme (PDF)

İşlem Kimliği:

RenderInvoiceDocument

Bir fatura belgesinin pdf dosyasını indirmek için documentFileId değeri gerekir. Bu kimlik genellikle fatura kaynağı tarafından döndürülür. Ancak, API aracılığıyla açık durumda yeni oluşturulan faturaların pdf belge dosyasının işlenmesini ayrı olarak tetiklemeleri gerekir. Bu, bu uç noktayla yapılabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Name	Yol	Tür	Description
documentFileId	documentFileId	uuid

Fatura Oluşturma

İşlem Kimliği:

CreateInvoice

API aracılığıyla iletilen faturalar varsayılan olarak taslak modunda oluşturulur. Durumu açık olan bir son haline getirilmiş fatura oluşturmak için isteğe bağlı sorgu parametresinin son halinin ayarlanması gerekir. Faturanın durumu API aracılığıyla değiştirilemez.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Önceki Satış Fişi Kimliği	precedingSalesVoucherId		string	Önceki satış fişi kimliğini belirtin.
Sonuçlandır	finalize	True	boolean	Son halini belirtin.

Döndürülenler

Body

Response_invoices_post

Fiş Listesini Alma ve Filtreleme

İşlem Kimliği:

RetrieveAndFilterVoucherlist

Kupon listesi (muhasebe) kuponları (örneğin salesinvoices, salescreditnotes), faturalar (peşinat faturaları dahil), alacak dekontları, sipariş onayları, teklifler ve teslim notlarını alın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Fiş Türü	voucherType	True	string	Fiş türünü belirtin.
Fiş Durumu	voucherStatus	True	string	Fiş durumunu belirtin.
Arşivlenmiş	archived		boolean	Arşivleneni belirtin.
İrtibat Numarası	contactId		string	Kişi kimliğini belirtin.
Fiş Tarihi	voucherDateFrom		string	Fiş tarihini belirtin.
Fiş Tarihi	voucherDateTo		string	Fiş tarihini belirtin.
Oluşturma Tarihi	createdDateFrom		string	Oluşturma tarihini belirtin.
Oluşturulma Tarihi:	createdDateTo		string	Oluşturulacak tarihi belirtin.
Güncelleştirme Tarihi	updatedDateFrom		string	Güncelleştirme tarihini belirtin.
Güncelleştirme Tarihi:	updatedDateTo		string	Güncelleştirilecek tarihi belirtin.
Fiş Numarası	voucherNumber		string	Fiş numarasını belirtin.
Sayfa	page		integer	Sayfayı belirtin.
Boyut	size		integer	Boyutu belirtin.
Sırala	sort		string	Sıralamayı belirtin.

Döndürülenler

Body

Response_voucherlist_get

Kişi Alma

İşlem Kimliği:

RetrieveContact

Kimliğine göre kişi alma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Name	Yol	Tür	Description
Arşivlenmiş	archived	boolean
kimlik	id	string
kuruluş Kimliği	organizationId	string
ön ad	person.firstName	string
soyadı	person.lastName	string
Selamlama	person.salutation	string
Numara	roles.customer.number	integer
version	version	integer

Kişi Oluşturma

İşlem Kimliği:

CreateContact

Yeni kişi oluşturma

Döndürülenler

Body

Response_contacts_post

Kişiyi Güncelleştirme

İşlem Kimliği:

UpdateContact

Kişiyi güncelleştirme

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Body

Response_contacts_id_put

Kredi Notu Alma

İşlem Kimliği:

RetrieveCreditNote

Bu uç nokta, kredi notlarına okuma ve yazma erişimi ve ayrıca belgeyi indirmek için PDF olarak işleme olanağı sağlar. Kredi notları taslak olarak oluşturulabilir veya açık modda sonlandırılabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Name	Yol	Tür	Description
city	address.city	string
ülke kodu	address.countryCode	string
name	address.name	string
sokak	address.street	string
Ek	address.supplement	string
Zip dosyası	address.zip	string
Arşivlenmiş	archived	boolean
oluşturulmaTarihi	createdDate	date-time
kimlik	id	uuid
Giriş	introduction	string
language	language	string
satır öğeleri	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
name	lineItems.name	string
miktar	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
kuruluş Kimliği	organizationId	uuid
Açıklama	remark	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	float
totalNetAmount	totalPrice.totalNetAmount	float
totalTaxAmount	totalPrice.totalTaxAmount	float
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Kredi Notu Belgesi İşleme (PDF)

İşlem Kimliği:

RenderCreditNoteDocument

Kredi notu belgesinin pdf dosyasını indirmek için documentFileId değeri gerekir. Bu kimlik genellikle kredi notu kaynağı tarafından döndürülür. Ancak, API aracılığıyla açılan durumda yeni oluşturulan kredi notlarının pdf belge dosyasının işlenmesini ayrı olarak tetiklemeleri gerekir. Bu, bu uç noktayla yapılabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Name	Yol	Tür	Description
documentFileId	documentFileId	uuid

Kredi Notu Oluşturma

İşlem Kimliği:

CreateCreditNote

API aracılığıyla iletilen kredi notları varsayılan olarak taslak modunda oluşturulur. Durumu açık olan son haline getirilmiş bir kredi notu oluşturmak için isteğe bağlı sorgu parametresinin son halinin ayarlanması gerekir. Kredi notunun durumu API aracılığıyla değiştirilemez

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Önceki Satış Fişi Kimliği	precedingSalesVoucherId		string	Önceki satış fişi kimliğini belirtin.
Sonuçlandır	finalize	True	boolean	Son halini belirtin.

Döndürülenler

Body

Response_credit-notes_post

Kupon Alma

İşlem Kimliği:

RetrieveVoucher

Satış fişlerini listeleme (örn. faturalar, kredi notları)

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Name	Yol	Tür	Description
oluşturulmaTarihi	createdDate	date-time
dueDate	dueDate	date-time
files	files	array of string
kimlik	id	uuid
kuruluş Kimliği	organizationId	uuid
Açıklama	remark	string
shippingDate	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
type	type	string
updatedDate	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
version	version	integer
voucherDate	voucherDate	date-time
voucherItems	voucherItems	array of object
miktar	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Kupon Oluşturma

İşlem Kimliği:

CreateVoucher

Fiş oluşturma (satış fişleriyle sınırlı)

Parametreler

Name	Anahtar	Gerekli	Tür	Description
contactId	contactId		string
dueDate	dueDate		date
Açıklama	remark		string
shippingDate	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
type	type	True	string
useCollectiveContact	useCollectiveContact		boolean
voucherDate	voucherDate		date
miktar	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Döndürülenler

Body

Response_vouchers_post

Kupona dosya yükleme

İşlem Kimliği:

UploadFileVoucher_Lexoffice

{id} tarafından tanımlanan kupona dosya (pdf veya resim) yükleyin ve atayın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.
Dosya	file	True	file	Karşıya yüklenecek dosya.

Makale Alma

İşlem Kimliği:

RetrieveAnArticle

{id} kimlik değerine sahip makaleyi döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Name	Yol	Tür	Description
articleNumber	articleNumber	string
gtin	gtin	string
kimlik	id	string
not	note	string
grossPrice	price.grossPrice	float
leadingPrice	price.leadingPrice	string
netPrice	price.netPrice	float
taxRate	price.taxRate	float
title	title	string
type	type	string
unitName	unitName	string
version	version	integer

Makale Oluşturma

İşlem Kimliği:

CreateArticle

Makalenin içeriği isteğin gövdesinde uygulama/json olarak beklenir.

Parametreler

Name	Anahtar	Gerekli	Tür	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
type	type		string	type
unitName	unitName		string	unitName

Döndürülenler

Body

Response_articles_post

Makale Silme

İşlem Kimliği:

DeleteAnArticle

{id} kimlik değerine sahip makaleyi siler. Başarı durumunda 204 veya kimlik yoksa 404 döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Makaleleri Filtreleme

İşlem Kimliği:

FilteringArticles

Bir disk belleği mekanizması kullanarak filter_n filter_1 filtreler tarafından verilen ölçütleri karşılayan makaleleri döndürür. Birden fazla filtre verilirse mantıksal bağlayıcı AND olur. Ayarlı olmayan filtreler yoksayılır. Bu uç noktanın en büyük sayfa boyutunu denetlemek için bkz. Kaynakların Sayfalaması.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Makale Numarası	articleNumber		string	Makale numarasını belirtin.
Gtin	gtin		string	Gtin değerini belirtin.
Türü	type		string	Türünü belirtin.
Sayfa	page		integer	Sayfayı belirtin.
Boyut	size		integer	Boyutu belirtin.
Sırala	sort		string	Sıralamayı belirtin.

Döndürülenler

Body

Response_articles_get

Makaleyi Güncelleştirme

İşlem Kimliği:

UpdateAnArticle

{id} kimliğine sahip mevcut bir makaleyi yükte JSON olarak verilen verilerle güncelleştirin. Başarılı olduğunda bir eylem sonucu döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.
articleNumber	articleNumber		string	articleNumber
gtin	gtin		string	gtin
not	note		string	not
grossPrice	grossPrice	True	float	grossPrice
leadingPrice	leadingPrice	True	string	leadingPrice
netPrice	netPrice	True	float	netPrice
taxRate	taxRate		float	taxRate
title	title		string	title
type	type	True	string	type
unitName	unitName	True	string	unitName
version	version	True	integer	version

Döndürülenler

Body

Response_articles_id_get

Makbuzu Güncelleştir

İşlem Kimliği:

UpdateVoucher

Kuponu güncelleştirme

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.
contactId	contactId		string
dueDate	dueDate		date
files	files		array of string	fileId'lerin atlanmış listesi
Açıklama	remark		string
shippingDate	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
type	type	True	string
useCollectiveContact	useCollectiveContact		boolean
version	version		integer
voucherDate	voucherDate		date
miktar	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Döndürülenler

Body

Response_vouchers_id_put

Olay Aboneliği Alma

İşlem Kimliği:

RetrieveAEventSubscription

Olay Aboneliği Alma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Abonelik Kimliği	subscriptionId	True	string	Abonelik kimliğini belirtin.

Döndürülenler

Body

EventSubscriptionResponse

Peşin ödeme faturası alma

İşlem Kimliği:

RetrieveDownPaymentInvoice

{id} kimlik değerine sahip peşinat faturasını döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Name	Yol	Tür	Description
city	address.city	string
ülke kodu	address.countryCode	string
name	address.name	string
sokak	address.street	string
Ek	address.supplement	string
Zip dosyası	address.zip	string
Arşivlenmiş	archived	boolean
closingInvoiceId	closingInvoiceId	uuid
oluşturulmaTarihi	createdDate	date-time
dueDate	dueDate	date-time
documentFileId	files.documentFileId	uuid
kimlik	id	uuid
Giriş	introduction	string
language	language	string
satır öğeleri	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
name	lineItems.name	string
miktar	lineItems.quantity	number
type	lineItems.type	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
kuruluş Kimliği	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
Açıklama	remark	string
shippingType	shippingConditions.shippingType	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Profil Bilgilerini Alma

İşlem Kimliği:

RetrieveProfileInformation

Aşağıdaki örnekte, temel profil bilgilerinizin nasıl alınacakları gösterilmektedir. İsteği göndermeden önce {accessToken} yer tutucusunun değiştirilmesi gerekir.

Döndürülenler

Body

Response_profile_get

Sipariş Onay Belgesi İşleme (PDF)

İşlem Kimliği:

RenderOrderConfirmationDocument

Bir sipariş onay belgesinin pdf dosyasını indirmek için documentFileId değeri gerekir. Bu kimlik genellikle sipariş onay kaynağı tarafından döndürülür. Ancak, API aracılığıyla yeni oluşturulan sipariş onaylarının pdf belge dosyasını ayrı olarak işlemeyi tetiklemesi gerekir. Bu, bu uç noktayla yapılabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Name	Yol	Tür	Description
documentFileId	documentFileId	uuid

Sipariş Onayı Alma

İşlem Kimliği:

RetrieveOrderConfirmation

{id} kimlik değeriyle sipariş onayını döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Name	Yol	Tür	Description
city	address.city	string
ülke kodu	address.countryCode	string
name	address.name	string
sokak	address.street	string
Ek	address.supplement	string
Zip dosyası	address.zip	string
Arşivlenmiş	archived	boolean
oluşturulmaTarihi	createdDate	date-time
deliveryTerms	deliveryTerms	string
documentFileId	files.documentFileId	uuid
kimlik	id	uuid
Giriş	introduction	string
language	language	string
satır öğeleri	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
kimlik	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
name	lineItems.name	string
miktar	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
kuruluş Kimliği	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
Açıklama	remark	string
shippingDate	shippingConditions.shippingDate	date-time
shippingType	shippingConditions.shippingType	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Sipariş Onayı Oluşturma

İşlem Kimliği:

CreateOrderConfirmation

Bu uç nokta, sipariş onaylarına okuma ve yazma erişimi ve ayrıca belgeyi indirmek için PDF olarak işleme olanağı sağlar. Sipariş onayları her zaman taslak modunda oluşturulur ve son halinin alınması gerekmez.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Önceki Satış Fişi Kimliği	precedingSalesVoucherId		string	Önceki satış fişi kimliğini belirtin.

Döndürülenler

Body

Response_order-confirmations_post

Smaç Oluşturma Belgesi (PDF)

İşlem Kimliği:

RenderDunningDocument

Bir dunning belgesinin pdf dosyasını indirmek için documentFileId değeri gerekir. Bu kimlik genellikle dunning kaynağı tarafından döndürülür. Ancak API aracılığıyla yeni oluşturulan dunnings, pdf belge dosyasının işlenmesini ayrı olarak tetiklemektedir. Bu, bu uç noktayla yapılabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Dunningsid	dunningsid	True	string	Dunningsid değerini belirtin.

Döndürülenler

Name	Yol	Tür	Description
documentFileId	documentFileId	uuid

Teklif Alma

İşlem Kimliği:

RetrieveQuotation

{id} kimlik değerine sahip teklifi döndürür. Teklif Belgesi İşleme (PDF)

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Name	Yol	Tür	Description
city	address.city	string
contactId	address.contactId	uuid
ülke kodu	address.countryCode	string
name	address.name	string
sokak	address.street	string
Zip dosyası	address.zip	string
Arşivlenmiş	archived	boolean
oluşturulmaTarihi	createdDate	date-time
son kullanma tarihi	expirationDate	date-time
documentFileId	files.documentFileId	uuid
kimlik	id	uuid
Giriş	introduction	string
language	language	string
satır öğeleri	lineItems	array of object
alternatif	lineItems.alternative	boolean
discountPercentage	lineItems.discountPercentage	number
kimlik	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
name	lineItems.name	string
optional	lineItems.optional	boolean
miktar	lineItems.quantity	number
Alt	lineItems.subItems	array of object
alternatif	lineItems.subItems.alternative	boolean
discountPercentage	lineItems.subItems.discountPercentage	number
kimlik	lineItems.subItems.id	uuid
lineItemAmount	lineItems.subItems.lineItemAmount	number
name	lineItems.subItems.name	string
optional	lineItems.subItems.optional	boolean
miktar	lineItems.subItems.quantity	number
type	lineItems.subItems.type	string
unitName	lineItems.subItems.unitName	string
currency	lineItems.subItems.unitPrice.currency	string
grossAmount	lineItems.subItems.unitPrice.grossAmount	number
netAmount	lineItems.subItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.subItems.unitPrice.taxRatePercentage	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
kuruluş Kimliği	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
Açıklama	remark	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Teklif Belgesi İşleme (PDF)

İşlem Kimliği:

RenderQuotationDocument

Bir teklif belgesinin pdf dosyasını indirmek için documentFileId değeri gerekir. Bu kimlik genellikle teklif kaynağı tarafından döndürülür. Ancak, API aracılığıyla açık durumda yeni oluşturulan teklifler, pdf belge dosyasının işlenmesini ayrı olarak tetiklemektedir. Bu, bu uç noktayla yapılabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Name	Yol	Tür	Description
documentFileId	documentFileId	uuid

Teklif Oluşturma

İşlem Kimliği:

CreateQuotation

API aracılığıyla iletilen tırnak işaretleri varsayılan olarak taslak modunda oluşturulur. Durumu açık olan son haline getirilmiş bir teklif oluşturmak için isteğe bağlı sorgu parametresinin son halinin ayarlanması gerekir. Bir teklifin durumu api aracılığıyla değiştirilemez.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sonuçlandır	finalize	True	boolean	Son halini belirtin.

Döndürülenler

Body

Response_quotations_post

Teslim Notu Alma

İşlem Kimliği:

RetrieveDeliveryNote

{id} kimlik değerine sahip teslim notunu döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Name	Yol	Tür	Description
city	address.city	string
ülke kodu	address.countryCode	string
name	address.name	string
sokak	address.street	string
Ek	address.supplement	string
Zip dosyası	address.zip	string
Arşivlenmiş	archived	boolean
oluşturulmaTarihi	createdDate	date-time
deliveryTerms	deliveryTerms	string
kimlik	id	uuid
Giriş	introduction	string
language	language	string
satır öğeleri	lineItems	array of object
name	lineItems.name	string
miktar	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
kuruluş Kimliği	organizationId	uuid
Açıklama	remark	string
taxType	taxConditions.taxType	string
title	title	string
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Teslim Notu Belgesini İşleme (PDF)

İşlem Kimliği:

RenderDeliveryNoteDocument

Bu uç nokta, teslim notlarına okuma ve yazma erişimi ve ayrıca belgeyi indirmek için PDF olarak işleme olanağı sağlar. Teslim notları her zaman taslak modunda oluşturulur ve son halinin alınması gerekmez.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Teslimat Not Kimliği	DeliveryNoteid	True	string	Teslim not kimliğini belirtin.

Döndürülenler

Name	Yol	Tür	Description
city	address.city	string
ülke kodu	address.countryCode	string
name	address.name	string
sokak	address.street	string
Ek	address.supplement	string
Zip dosyası	address.zip	string
Arşivlenmiş	archived	boolean
oluşturulmaTarihi	createdDate	date-time
deliveryTerms	deliveryTerms	string
kimlik	id	uuid
Giriş	introduction	string
language	language	string
satır öğeleri	lineItems	array of object
name	lineItems.name	string
miktar	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
kuruluş Kimliği	organizationId	uuid
Açıklama	remark	string
taxType	taxConditions.taxType	string
title	title	string
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Teslim Notu Oluşturma

İşlem Kimliği:

CreateDeliveryNote

Oluşturulan teslimat notu, Lexoffice'teki ana fiş listesinde gösterilir. API aracılığıyla iletilen teslim notları yalnızca taslak modunda oluşturulur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Önceki Satış Fişi Kimliği	precedingSalesVoucherId		string	Önceki satış fişi kimliğini belirtin.

Döndürülenler

Body

Response_delivery-notes_post

Tüm Kişileri Al

İşlem Kimliği:

RetrieveAllContacts

Tüm Kişileri Al

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sayı	number		integer	Sayıyı belirtin.
E-posta	email		string	E-postayı belirtin.
İsim	name		string	Adı belirtin.
Satıcı	vendor		boolean	Satıcıyı belirtin.
Müşteri	customer		boolean	Müşteriyi belirtin.
Sayfa	page		integer	Sayfayı belirtin.
Boyut	size		integer	Boyutu belirtin.
Sırala	sort		string	Sıralamayı belirtin.

Döndürülenler

Body

Response_contacts_get

Tüm Olay Aboneliklerini Alma

İşlem Kimliği:

RetrieveAllEventSubscriptions

Tüm Olay Aboneliklerini Alma

Döndürülenler

Body

Response_event-subscriptions_get

Tüm Yinelenen Şablonları Alma

İşlem Kimliği:

RetrieveAllRecurringTemplates

Yinelenen şablonlardan oluşan bir koleksiyon alın. Sonuç, başvurulan kişi (yalnızca kimlik ve ad), toplam fiyat, ödeme koşulları ve yinelenen şablonların tam ayarları olan en ilgili verilerin yalnızca bir bölümünü döndürür. Ancak, nesnelerin ve özelliklerin adlandırması aynıdır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sayfa	page		integer	Sayfayı belirtin.
Boyut	size		integer	Boyutu belirtin.
Sırala	sort		string	Sıralamayı belirtin.

Döndürülenler

Body

Response_recurring-templates_get

Yinelenen Şablon Alma

İşlem Kimliği:

RetrieveRecurringTemplate

{id} kimlik değerine sahip yinelenen şablonu döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Kimliği belirtin.

Döndürülenler

Name	Yol	Tür	Description
city	address.city	string
contactId	address.contactId	uuid
ülke kodu	address.countryCode	string
name	address.name	string
sokak	address.street	string
Zip dosyası	address.zip	string
Arşivlenmiş	archived	boolean
oluşturulmaTarihi	createdDate	date-time
kimlik	id	uuid
Giriş	introduction	string
language	language	string
satır öğeleri	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
name	lineItems.name	string
miktar	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
kuruluş Kimliği	organizationId	uuid
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
recurringTemplateSettings	recurringTemplateSettings	object
Açıklama	remark	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer

Ödeme Bilgilerini Alma

İşlem Kimliği:

RetrievePaymentInformation

Ödemeler uç noktası, faturalar ve alacak dekontları dahil olmak üzere fişlerin ödeme durumuna (muhasebe veya satış) okuma erişimi sağlar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Fiş Kimliği	voucherId	True	string	Fiş kimliğini belirtin.

Döndürülenler

Name	Yol	Tür	Description
currency	currency	string
openAmount	openAmount	string
paymentItems	paymentItems	array of object
miktar	paymentItems.amount	float
currency	paymentItems.currency	string
paymentItemType	paymentItems.paymentItemType	string
postingDate	paymentItems.postingDate	date-time
ödemeDurumu	paymentStatus	string
voucherStatus	voucherStatus	string
voucherType	voucherType	string

Ödeme Koşullarının Listesini Al

İşlem Kimliği:

RetrieveListOfPaymentConditions

Aşağıdaki örnekte, yapılandırılmış olan ödeme koşullarının listesinin nasıl alın aldığı gösterilmektedir. İsteği göndermeden önce {accessToken} yer tutucusunun değiştirilmesi gerekir.

Döndürülenler

response

array of Response_payment-conditions_get_items

Ülkelerin Listesini Al

İşlem Kimliği:

RetrieveListCountries

Lexoffice tarafından bilinen ülkelerin listesi.

Döndürülenler

response

array of Response_countries_get_default

Tetikleyiciler

Özel Tetikleyicinizi seçin

Kişiler uç noktası için yeni bir tetikleyici kaydetme

Özel Tetikleyicinizi seçin

İşlem Kimliği:

EventSubscription_Lexoffice

Kişiler uç noktası için yeni bir tetikleyici kaydetme

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Olay Türü	eventType	True	string	eventType

Döndürülenler

Name	Yol	Tür	Description
eventDate	eventDate	string	eventDate
eventType	eventType	string	eventType
kuruluş Kimliği	organizationId	string	kuruluş Kimliği
resourceId	resourceId	string	resourceId

Tanımlar

EventSubscriptionResponse

Name	Yol	Tür	Description
subscriptionId	subscriptionId	string
eventType	eventType	string
kuruluş Kimliği	organizationId	string
oluşturulmaTarihi	createdDate	date-time
callbackUrl	callbackUrl	string

Response_articles_get

Name	Yol	Tür	Description
içerik	content	array of object	içerik
articleNumber	content.articleNumber	string	articleNumber
gtin	content.gtin	string	gtin
kimlik	content.id	string	kimlik
not	content.note	string	not
grossPrice	content.price.grossPrice	float	grossPrice
leadingPrice	content.price.leadingPrice	string	leadingPrice
netPrice	content.price.netPrice	float	netPrice
taxRate	content.price.taxRate	float	taxRate
title	content.title	string	title
type	content.type	string	type
unitName	content.unitName	string	unitName
version	content.version	integer	version
birinci	first	boolean	birinci
last	last	boolean	last
Numara	number	integer	Numara
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
yükselen	sort.ascending	boolean	yükselen
yön	sort.direction	string	yön
yoksayVaka	sort.ignoreCase	boolean	yoksayVaka
nullHandling	sort.nullHandling	string	nullHandling
property	sort.property	string	property
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_articles_id_get

Name	Yol	Tür	Description
articleNumber	articleNumber	string	articleNumber
gtin	gtin	string	gtin
kimlik	id	string	kimlik
not	note	string	not
grossPrice	price.grossPrice	float	grossPrice
leadingPrice	price.leadingPrice	string	leadingPrice
netPrice	price.netPrice	float	netPrice
taxRate	price.taxRate	float	taxRate
title	title	string	title
type	type	string	type
unitName	unitName	string	unitName
version	version	integer	version

Response_articles_post

Name	Yol	Tür	Description
oluşturulmaTarihi	createdDate	string	oluşturulmaTarihi
kimlik	id	string	kimlik
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_contacts_get

Name	Yol	Tür	Description
içerik	content	array of object	içerik
Fatura	content.addresses.billing	array of object	Fatura
city	content.addresses.billing.city	string	city
ülke kodu	content.addresses.billing.countryCode	string	ülke kodu
sokak	content.addresses.billing.street	string	sokak
Ek	content.addresses.billing.supplement	string	Ek
Zip dosyası	content.addresses.billing.zip	string	Zip dosyası
Nakliye	content.addresses.shipping	array of object	Nakliye
city	content.addresses.shipping.city	string	city
ülke kodu	content.addresses.shipping.countryCode	string	ülke kodu
sokak	content.addresses.shipping.street	string	sokak
Ek	content.addresses.shipping.supplement	string	Ek
Zip dosyası	content.addresses.shipping.zip	string	Zip dosyası
Arşivlenmiş	content.archived	boolean	Arşivlenmiş
allowTaxFreeInvoices	content.company.allowTaxFreeInvoices	boolean	allowTaxFreeInvoices
contactPersons	content.company.contactPersons	array of object	contactPersons
e-posta adresi	content.company.contactPersons.emailAddress	string	e-posta adresi
ön ad	content.company.contactPersons.firstName	string	ön ad
soyadı	content.company.contactPersons.lastName	string	soyadı
birincil	content.company.contactPersons.primary	boolean	birincil
Selamlama	content.company.contactPersons.salutation	string	Selamlama
name	content.company.name	string	name
vergi numarası	content.company.taxNumber	string	vergi numarası
vatRegistrationId	content.company.vatRegistrationId	string	vatRegistrationId
iş	content.emailAddresses.business	array of string	iş
büro	content.emailAddresses.office	array of string	büro
other	content.emailAddresses.other	array of string	other
kimlik	content.id	string	kimlik
not	content.note	string	not
kuruluş Kimliği	content.organizationId	string	kuruluş Kimliği
iş	content.phoneNumbers.business	array of string	iş
faks	content.phoneNumbers.fax	array of string	faks
büro	content.phoneNumbers.office	array of string	büro
other	content.phoneNumbers.other	array of string	other
Numara	content.roles.customer.number	integer	Numara
Numara	content.roles.vendor.number	integer	Numara
version	content.version	integer	version
birinci	first	boolean	birinci
last	last	boolean	last
Numara	number	integer	Numara
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
yükselen	sort.ascending	boolean	yükselen
yön	sort.direction	string	yön
yoksayVaka	sort.ignoreCase	boolean	yoksayVaka
nullHandling	sort.nullHandling	string	nullHandling
property	sort.property	string	property
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_contacts_post

Name	Yol	Tür	Description
oluşturulmaTarihi	createdDate	string	oluşturulmaTarihi
kimlik	id	string	kimlik
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_countries_get_default

Name	Yol	Tür	Description
ülke kodu	countryCode	string	ülke kodu
countryNameDE	countryNameDE	string	countryNameDE
countryNameEN	countryNameEN	string	countryNameEN
taxClassification	taxClassification	string	taxClassification

Response_credit-notes_post

Name	Yol	Tür	Description
oluşturulmaTarihi	createdDate	string	oluşturulmaTarihi
kimlik	id	string	kimlik
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_delivery-notes_post

Name	Yol	Tür	Description
oluşturulmaTarihi	createdDate	string	oluşturulmaTarihi
kimlik	id	string	kimlik
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_dunnings_post

Name	Yol	Tür	Description
oluşturulmaTarihi	createdDate	string	oluşturulmaTarihi
kimlik	id	string	kimlik
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_event-subscriptions_get

Name	Yol	Tür	Description
içerik	content	array of object	içerik
callbackUrl	content.callbackUrl	string	callbackUrl
oluşturulmaTarihi	content.createdDate	string	oluşturulmaTarihi
eventType	content.eventType	string	eventType
kuruluş Kimliği	content.organizationId	string	kuruluş Kimliği
subscriptionId	content.subscriptionId	string	subscriptionId

Response_files_post

Name	Yol	Tür	Description
kimlik	id	string	kimlik

Response_invoices_post

Name	Yol	Tür	Description
oluşturulmaTarihi	createdDate	string	oluşturulmaTarihi
kimlik	id	string	kimlik
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_order-confirmations_post

Name	Yol	Tür	Description
oluşturulmaTarihi	createdDate	string	oluşturulmaTarihi
kimlik	id	string	kimlik
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_payment-conditions_get_items

Name	Yol	Tür	Description
kimlik	id	string	kimlik
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	Yol	Tür	Description
contactRequired	contactRequired	boolean	contactRequired
groupName	groupName	string	groupName
kimlik	id	string	kimlik
name	name	string	name
splitAllowed	splitAllowed	boolean	splitAllowed
type	type	string	type

Response_profile_get

Name	Yol	Tür	Description
businessFeatures	businessFeatures	array of string	businessFeatures
companyName	companyName	string	companyName
connectionId	connectionId	string	connectionId
date	created.date	string	date
kullanıcı e-postası	created.userEmail	string	kullanıcı e-postası
userId	created.userId	string	userId
kullanıcı adı	created.userName	string	kullanıcı adı
features	features	array of string	features
kuruluş Kimliği	organizationId	string	kuruluş Kimliği
Smallbusiness	smallBusiness	boolean	Smallbusiness
abonelikDurum	subscriptionStatus	string	abonelikDurum
taxType	taxType	string	taxType

Response_quotations_post

Name	Yol	Tür	Description
oluşturulmaTarihi	createdDate	string	oluşturulmaTarihi
kimlik	id	string	kimlik
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_recurring-templates_get

Name	Yol	Tür	Description
içerik	content	array of object	içerik
contactId	content.address.contactId	string	contactId
name	content.address.name	string	name
oluşturulmaTarihi	content.createdDate	string	oluşturulmaTarihi
kimlik	content.id	string	kimlik
kuruluş Kimliği	content.organizationId	string	kuruluş Kimliği
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
Bitiş Tarihi	content.recurringTemplateSettings.endDate	string	Bitiş Tarihi
executionInterval	content.recurringTemplateSettings.executionInterval	string	executionInterval
executionStatus	content.recurringTemplateSettings.executionStatus	string	executionStatus
finalize et	content.recurringTemplateSettings.finalize	boolean	finalize et
kimlik	content.recurringTemplateSettings.id	string	kimlik
lastExecutionFailed	content.recurringTemplateSettings.lastExecutionFailed	boolean	lastExecutionFailed
nextExecutionDate	content.recurringTemplateSettings.nextExecutionDate	string	nextExecutionDate
shippingType	content.recurringTemplateSettings.shippingType	string	shippingType
startDate	content.recurringTemplateSettings.startDate	string	startDate
title	content.title	string	title
currency	content.totalPrice.currency	string	currency
totalGrossAmount	content.totalPrice.totalGrossAmount	integer	totalGrossAmount
totalNetAmount	content.totalPrice.totalNetAmount	float	totalNetAmount
updatedDate	content.updatedDate	string	updatedDate
birinci	first	boolean	birinci
last	last	boolean	last
Numara	number	integer	Numara
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
yükselen	sort.ascending	boolean	yükselen
yön	sort.direction	string	yön
yoksayVaka	sort.ignoreCase	boolean	yoksayVaka
nullHandling	sort.nullHandling	string	nullHandling
property	sort.property	string	property
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_voucherlist_get

Name	Yol	Tür	Description
içerik	content	array of object	içerik
Arşivlenmiş	content.archived	boolean	Arşivlenmiş
contactId	content.contactId	string	contactId
contactName (İletişim Adı)	content.contactName	string	contactName (İletişim Adı)
oluşturulmaTarihi	content.createdDate	string	oluşturulmaTarihi
currency	content.currency	string	currency
dueDate	content.dueDate	string	dueDate
kimlik	content.id	string	kimlik
openAmount	content.openAmount	float	openAmount
toplamTutar	content.totalAmount	float	toplamTutar
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
birinci	first	boolean	birinci
last	last	boolean	last
Numara	number	integer	Numara
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
yükselen	sort.ascending	boolean	yükselen
yön	sort.direction	string	yön
yoksayVaka	sort.ignoreCase	boolean	yoksayVaka
nullHandling	sort.nullHandling	string	nullHandling
property	sort.property	string	property
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_vouchers_post

Name	Yol	Tür	Description
oluşturulmaTarihi	createdDate	string	oluşturulmaTarihi
kimlik	id	string	kimlik
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_contacts_id_put

Name	Yol	Tür	Description
Arşivlenmiş	archived	boolean
kimlik	id	uuid
kuruluş Kimliği	organizationId	uuid
ön ad	person.firstName	string
soyadı	person.lastName	string
Selamlama	person.salutation	string
Numara	roles.customer.number	integer
version	version	integer

Response_vouchers_id_put

Name	Yol	Tür	Description
oluşturulmaTarihi	createdDate	date-time
dueDate	dueDate	date-time
files	files	array of object
items	files	object
kimlik	id	uuid
kuruluş Kimliği	organizationId	uuid
Açıklama	remark	string
shippingDate	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
type	type	string
updatedDate	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
version	version	integer
voucherDate	voucherDate	date-time
voucherItems	voucherItems	array of object
miktar	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

file

Bu, 'file' temel veri türüdür.