Lexoffice（獨立出版社）（預覽）

Lexware API 提供程式化存取 Lexware 核心業務功能，如文章、聯絡人、發票、訂單及檔案管理。此獨立出版商連接器可安全整合 Lexware 的 REST API，讓使用者能建立與檢索業務資料、自動化流程，並將 Lexware 資源與 Power Platform 應用程式連結。連接器使用 OAuth 2.0 授權碼流程（OAuth 2.0 Authorization Code Flow）以提供安全的認證與 API 指引。

此連接器適用於以下產品和區域：

服務	Class	Regions
副駕駛工作室	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
邏輯應用程式	標準	所有 Logic Apps 區域，但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部（DoD）
Power Apps	進階	除下列區域外的所有 Power Apps 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
Power Automate（自動化服務）	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）

連絡人
名稱	低代碼調查員支援
URL	https://lowcode-investigator.com/
Email	kontakt@lowcodeinvestigator.com

連接器中繼資料
Publisher	低代碼調查員
網站	https://office.lexware.de/
隱私策略	https://office.lexware.de/datenschutz/
類別	商業管理;財政

Lexware API 連接器（獨立出版商）

Lexware API 是一個 RESTful 介面，允許開發者將 Lexware 的商業功能，如聯絡人、發票、文章和檔案整合到自己的應用程式中。此連接器透過安全且認證的 API 請求，使資源能直接互動。

出版社：獨立出版社

先決條件

註冊的 Lexware 帳號和正式授權
透過 Lexware 開發者入口網站取得的有效 API 金鑰（存取權杖）
驗證必須使用 OAuth 2.0 授權碼流程

支援的作業

此連接器支援以下 Lexware API 端點：

文章：建立、檢索、更新、刪除及篩選文章
聯絡人：管理客戶與供應商資料
發票：建立與檢索發票資料，包括渲染 PDF
信用票據、交車票據、訂單、報價單與憑證
國家、付款條件、印刷版面與簡介
活動訂閱與檔案
完整清單可於 Lexware API 文件中記錄

取得憑證

要呼叫 Lexware API，你需要一個 API 金鑰：

登入您的 Lexware Office 帳號。
可從 公開 API → → Weitere Apps 的擴充 功能導航至
直接使用 Lexware 開發者入口網站。
建立一個新的 API 金鑰，並取得所需的權限。
複製產生的 API 金鑰。這個數值會像 accessToken 連接器一樣使用。

API 閘道

請使用新的 Lexware API 閘道器：

https://api.lexware.io

速率限制

每秒最多 2 次請求
超過此限制的請求會接收 HTTP 429 Too Many Requests
建議：使用代幣桶演算法或指數退讓

Authentication

Lexware API 採用 OAuth 2.0 授權碼流程。請將該標記包含在 Authorization: Bearer {accessToken} 每個請求的標頭中。

範例使用方式

撰寫文章：

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

已知問題和限制

每秒最多 2 次請求
部分端點需要額外權限或角色

API 文件

完整的 API 參考資料可於以下網站取得：
https://developers.lexware.io/docs/

建立連線

連接器支援下列驗證類型：


預設值	建立連線的參數。	所有區域	不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱	類型	Description	為必填項目
API 金鑰	安全字串	此 API 的 API 金鑰	對

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

上傳檔案	使用此端點上傳檔案，例如憑證或發票。
下載檔案	利用這個端點下載檔案。
刪除 Event-Subscription	刪除觸發器 WebHook
刪除文章	刪除 id 值為 {id} 的文章。成功時回傳 204，若不存在則回傳 404。
取回一筆 dunning	回傳帶有 id 值 {id} 的 dunning。
取回交付通知	回傳帶有 id 值 {id} 的交付便條。
取回憑證	列出銷售憑證（例如發票、信用註解）
取回所有重複出現的範本	取得一組重複出現的範本。結果只會回傳部分最相關的資料，包括參考的聯絡人（僅有 ID 和姓名）、總價、付款條件以及完整的重複範本設定。不過物件和屬性的命名方式是一樣的。
取回發票	回傳發票，並附有 id 值 {id}。
取回聯絡人	以 id 檢索聯絡人
取回頭期款發票	退回帶有 ID 值 {id} 的頭期款發票。
取得付款條件清單	以下範例展示了如何取得目前設定的付款條件清單。在發送請求前，必須替換佔位符 {accessToken}。
取得信用票據	此端點提供信用筆記的讀寫權限，並可將文件呈現為 PDF 以便下載。信用票據可以以草稿形式建立，也可以以開放模式完成。
取得個人資料資訊	以下範例展示了如何取得您的基本個人資料資訊。在發送請求前，必須替換佔位符 {accessToken}。
取得所有活動訂閱	取得所有活動訂閱
取得活動訂閱	取得活動訂閱
取得訂單確認	回傳以 ID 值 {id} 的訂單確認。
取得重複出現的範本	回傳帶有 id 值 {id} 的重複範本。
報價文件（PDF）	要下載報價文件的 PDF 檔案，你需要它的 documentFileId。這個 ID 通常由報價資源回傳。然而，透過 API 開啟狀態的新引文必須觸發 pdf 文件的獨立渲染。這可以用這個端點來完成。
將檔案上傳到憑證	上傳並指派檔案（pdf或圖片）至由 {id} 標示的憑證。
建立一篇文章	文章內容預期會以應用程式/json 形式出現在請求的主體中。
建立交付便條	所產生的交付單會顯示在 LexOffice 的主憑證清單中。透過 API 傳送的交付便條僅以草稿模式產生。
建立信用票據	透過 API 傳送的信用票據預設會以草稿模式產生。若要建立狀態開啟的最終信用註解，必須設定可選的查詢參數 finalize。信用報告的狀態無法透過 API 更改
建立催眠室	所建立的債務不會顯示在 LexOffice 的主憑證清單中，而是會附加在發票上，並在那裡可見。若要讓您的客戶存取已建立的催收帳，請使用我們的深層連結功能。
建立報價	透過 API 傳送的報價預設會以草稿模式建立。要建立狀態開啟的最終報價，必須設定可選的查詢參數 finalize。報價的狀態無法透過 API 變更。
建立憑證	建立代金券（僅限銷售代金券）
建立發票	透過 API 傳送的發票預設以草稿模式建立。要建立狀態開啟的最終發票，必須設定可選的查詢參數 finalize。發票狀態無法透過 API 變更。
建立聯絡人	建立新聯絡人
建立訂單確認	此端點提供訂單確認的讀寫權限，並可將文件呈現為 PDF 以便下載。訂單確認總是在草稿模式下產生，不需要最終定稿。
提供信用說明文件（PDF）	要下載信用備註文件的 PDF 檔案，您需要其 documentFileId。這個 ID 通常會由信用票據資源回傳。然而，透過 API 開啟狀態的新建立信用註解必須單獨觸發 PDF 文件的渲染。這可以用這個端點來完成。
更新憑證	更新憑證
更新文章	更新帶有 ID {id} 的現有文章，並使用有效載荷中提供的 JSON 資料。成功後返回行動結果。
更新聯絡人	更新聯絡人
檢索付款資訊	支付端點提供讀取（簿記或銷售）憑證的付款狀態，包括發票與信用票據。
檢索國家列表	LexOffice 已知國家列表。
檢索引文	回傳 id 值 {id} 的引號。報價文件（PDF）
檢索所有聯絡人	檢索所有聯絡人
檢索文章	回傳 id 值為 {id} 的文章。
檢索發布分類列表	此端點提供閱讀存取（簿記）憑證收入或支出的帳單類別清單，這些分類在 LexOffice 中皆支援。
檢索與篩選憑證表	取得憑證清單（簿記）憑證（例如銷售發票、銷售信用票據）、發票（包括頭期款發票）、信用憑證、訂單確認、報價單及交貨單據。
渲染dunning文件（PDF）	要下載dunning文件的pdf檔，你需要它的documentFileId。這個 id 通常由 dunning 資源回傳。不過，透過 API 新建立的 dunning 必須單獨觸發 pdf 文件的渲染。這可以用這個端點來完成。
製作交付便條文件（PDF）	此端點提供送達筆記的讀寫權限，並可將文件呈現為 PDF 以便下載。交付便條總是在草稿模式下產生，不需要最終定稿。
製作發票文件（PDF）	要下載發票文件的 PDF 檔案，你需要它的 documentFileId。這個 ID 通常會由發票資源回傳。然而，透過 API 開啟狀態的新發票必須單獨觸發 PDF 文件的渲染。這可以用這個端點來完成。
製作訂單確認文件（PDF）	要下載訂單確認文件的 PDF 檔，你需要它的 documentFileId。此 ID 通常由訂單確認資源回傳。然而，透過 API 新建立的訂單確認必須單獨觸發 PDF 文件的渲染。這可以用這個端點來完成。
過濾條目	回傳符合篩選條件的文章，filter_1透過分頁機制filter_n。若有多個濾波器，邏輯連接器為 AND。未設定的過濾器會被忽略。要檢查此端點的最大頁面大小，請參閱資源分頁。

上傳檔案

作業識別碼：: UploadFile_Lexoffice

使用此端點上傳檔案，例如憑證或發票。

參數

名稱	機碼	必要	類型	Description
檔案	file	True	file	要上傳的檔案。
類型	type	True	string	檔案內容描述。

傳回

身體: Response_files_post

下載檔案

作業識別碼：: DownloadFile_Lexoffice

利用這個端點下載檔案。

參數

名稱	機碼	必要	類型	Description
檔案標識碼	fileId	True	string	請指定檔案 ID。
接受	Accept		string	請指定接受。

傳回

response: file

刪除 Event-Subscription

作業識別碼：: DeleteEventSubscription

刪除觸發器 WebHook

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscriptionId	True	string	請指定訂閱 ID。

刪除文章

作業識別碼：: DeleteAnArticle

刪除 id 值為 {id} 的文章。成功時回傳 204，若不存在則回傳 404。

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

取回一筆 dunning

作業識別碼：: RetrieveDunning

回傳帶有 id 值 {id} 的 dunning。

參數

名稱	機碼	必要	類型	Description
鄧寧斯德	dunningsid	True	string	指定 dunningsid。

傳回

名稱	路徑	類型
city	address.city	string
countryCode	address.countryCode	string
名稱	address.name	string
街道	address.street	string
補充資料	address.supplement	string
壓縮檔	address.zip	string
已存檔	archived	boolean
建立日期	createdDate	date-time
識別碼	id	uuid
簡介	introduction	string
語言	language	string
明細項目	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
行項金額	lineItems.lineItemAmount	number
名稱	lineItems.name	string
數量	lineItems.quantity	number
型別	lineItems.type	string
單位名稱	lineItems.unitName	string
貨幣	lineItems.unitPrice.currency	string
總金額	lineItems.unitPrice.grossAmount	number
淨金額	lineItems.unitPrice.netAmount	number
稅率百分比	lineItems.unitPrice.taxRatePercentage	number
組織ID	organizationId	uuid
相關憑證	relatedVouchers	array of object
識別碼	relatedVouchers.id	uuid
憑證號碼	relatedVouchers.voucherNumber	string
代金券類型	relatedVouchers.voucherType	string
備註	remark	string
出貨日期	shippingConditions.shippingDate	date-time
航運類型	shippingConditions.shippingType	string
稅款金額	taxAmounts	array of object
淨金額	taxAmounts.netAmount	number
稅額	taxAmounts.taxAmount	number
稅率百分比	taxAmounts.taxRatePercentage	number
稅項類型	taxConditions.taxType	string
title	title	string
貨幣	totalPrice.currency	string
總額	totalPrice.totalGrossAmount	number
總淨額	totalPrice.totalNetAmount	number
總稅額	totalPrice.totalTaxAmount	number
更新日期	updatedDate	date-time
版本	version	integer
代金券日期	voucherDate	date-time
憑證狀態	voucherStatus	string

取回交付通知

作業識別碼：: RetrieveDeliveryNote

回傳帶有 id 值 {id} 的交付便條。

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

名稱	路徑	類型
city	address.city	string
countryCode	address.countryCode	string
名稱	address.name	string
街道	address.street	string
補充資料	address.supplement	string
壓縮檔	address.zip	string
已存檔	archived	boolean
建立日期	createdDate	date-time
交付條款	deliveryTerms	string
識別碼	id	uuid
簡介	introduction	string
語言	language	string
明細項目	lineItems	array of object
名稱	lineItems.name	string
數量	lineItems.quantity	number
型別	lineItems.type	string
單位名稱	lineItems.unitName	string
貨幣	lineItems.unitPrice.currency	string
總金額	lineItems.unitPrice.grossAmount	number
淨金額	lineItems.unitPrice.netAmount	number
稅率百分比	lineItems.unitPrice.taxRatePercentage	number
組織ID	organizationId	uuid
備註	remark	string
稅項類型	taxConditions.taxType	string
title	title	string
更新日期	updatedDate	date-time
版本	version	integer
代金券日期	voucherDate	date-time
憑證號碼	voucherNumber	string
憑證狀態	voucherStatus	string

取回憑證

作業識別碼：: RetrieveVoucher

列出銷售憑證（例如發票、信用註解）

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

名稱	路徑	類型
建立日期	createdDate	date-time
截止日期	dueDate	date-time
files	files	array of string
識別碼	id	uuid
組織ID	organizationId	uuid
備註	remark	string
出貨日期	shippingDate	date-time
稅項類型	taxType	string
總額	totalGrossAmount	number
總稅額	totalTaxAmount	number
型別	type	string
更新日期	updatedDate	date-time
使用集體聯絡	useCollectiveContact	boolean
版本	version	integer
代金券日期	voucherDate	date-time
憑證項目	voucherItems	array of object
金額	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
稅額	voucherItems.taxAmount	number
稅率百分比	voucherItems.taxRatePercent	number
憑證號碼	voucherNumber	string
憑證狀態	voucherStatus	string

取回所有重複出現的範本

作業識別碼：: RetrieveAllRecurringTemplates

取得一組重複出現的範本。結果只會回傳部分最相關的資料，包括參考的聯絡人（僅有 ID 和姓名）、總價、付款條件以及完整的重複範本設定。不過物件和屬性的命名方式是一樣的。

參數

名稱	機碼	類型	Description
頁面	page	integer	請指定頁面。
大小	size	integer	請指定尺寸。
排序	sort	string	請指定分類。

傳回

身體: Response_recurring-templates_get

取回發票

作業識別碼：: RetrieveInvoice

回傳發票，並附有 id 值 {id}。

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

名稱	路徑	類型
city	address.city	string
countryCode	address.countryCode	string
名稱	address.name	string
街道	address.street	string
補充資料	address.supplement	string
壓縮檔	address.zip	string
已存檔	archived	boolean
建立日期	createdDate	date-time
識別碼	id	uuid
簡介	introduction	string
語言	language	string
明細項目	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
識別碼	lineItems.id	uuid
行項金額	lineItems.lineItemAmount	number
名稱	lineItems.name	string
數量	lineItems.quantity	number
型別	lineItems.type	string
單位名稱	lineItems.unitName	string
貨幣	lineItems.unitPrice.currency	string
總金額	lineItems.unitPrice.grossAmount	number
淨金額	lineItems.unitPrice.netAmount	number
稅率百分比	lineItems.unitPrice.taxRatePercentage	number
組織ID	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
折扣範圍	paymentConditions.paymentDiscountConditions.discountRange	integer
付款期限期限	paymentConditions.paymentTermDuration	integer
付款條款標籤	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
備註	remark	string
出貨日期	shippingConditions.shippingDate	date-time
航運類型	shippingConditions.shippingType	string
稅款金額	taxAmounts	array of object
淨金額	taxAmounts.netAmount	number
稅額	taxAmounts.taxAmount	number
稅率百分比	taxAmounts.taxRatePercentage	number
稅項類型	taxConditions.taxType	string
title	title	string
貨幣	totalPrice.currency	string
總額	totalPrice.totalGrossAmount	number
總淨額	totalPrice.totalNetAmount	number
總稅額	totalPrice.totalTaxAmount	number
更新日期	updatedDate	date-time
版本	version	integer
代金券日期	voucherDate	date-time
憑證號碼	voucherNumber	string
憑證狀態	voucherStatus	string

取回聯絡人

作業識別碼：: RetrieveContact

以 id 檢索聯絡人

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

名稱	路徑	類型
已存檔	archived	boolean
識別碼	id	string
組織ID	organizationId	string
名字	person.firstName	string
lastName	person.lastName	string
稱呼	person.salutation	string
數字	roles.customer.number	integer
版本	version	integer

取回頭期款發票

作業識別碼：: RetrieveDownPaymentInvoice

退回帶有 ID 值 {id} 的頭期款發票。

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

名稱	路徑	類型
city	address.city	string
countryCode	address.countryCode	string
名稱	address.name	string
街道	address.street	string
補充資料	address.supplement	string
壓縮檔	address.zip	string
已存檔	archived	boolean
結案發票	closingInvoiceId	uuid
建立日期	createdDate	date-time
截止日期	dueDate	date-time
documentFileID	files.documentFileId	uuid
識別碼	id	uuid
簡介	introduction	string
語言	language	string
明細項目	lineItems	array of object
行項金額	lineItems.lineItemAmount	number
名稱	lineItems.name	string
數量	lineItems.quantity	number
型別	lineItems.type	string
貨幣	lineItems.unitPrice.currency	string
總金額	lineItems.unitPrice.grossAmount	number
淨金額	lineItems.unitPrice.netAmount	number
稅率百分比	lineItems.unitPrice.taxRatePercentage	number
組織ID	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
折扣範圍	paymentConditions.paymentDiscountConditions.discountRange	integer
付款期限期限	paymentConditions.paymentTermDuration	integer
付款條款標籤	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
備註	remark	string
航運類型	shippingConditions.shippingType	string
稅款金額	taxAmounts	array of object
淨金額	taxAmounts.netAmount	number
稅額	taxAmounts.taxAmount	number
稅率百分比	taxAmounts.taxRatePercentage	number
稅項類型	taxConditions.taxType	string
title	title	string
貨幣	totalPrice.currency	string
總額	totalPrice.totalGrossAmount	number
總淨額	totalPrice.totalNetAmount	number
總稅額	totalPrice.totalTaxAmount	number
更新日期	updatedDate	date-time
版本	version	integer
代金券日期	voucherDate	date-time
憑證號碼	voucherNumber	string
憑證狀態	voucherStatus	string

取得付款條件清單

作業識別碼：: RetrieveListOfPaymentConditions

以下範例展示了如何取得目前設定的付款條件清單。在發送請求前，必須替換佔位符 {accessToken}。

傳回

response: array of Response_payment-conditions_get_items

取得信用票據

作業識別碼：: RetrieveCreditNote

此端點提供信用筆記的讀寫權限，並可將文件呈現為 PDF 以便下載。信用票據可以以草稿形式建立，也可以以開放模式完成。

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

名稱	路徑	類型
city	address.city	string
countryCode	address.countryCode	string
名稱	address.name	string
街道	address.street	string
補充資料	address.supplement	string
壓縮檔	address.zip	string
已存檔	archived	boolean
建立日期	createdDate	date-time
識別碼	id	uuid
簡介	introduction	string
語言	language	string
明細項目	lineItems	array of object
行項金額	lineItems.lineItemAmount	number
名稱	lineItems.name	string
數量	lineItems.quantity	number
型別	lineItems.type	string
單位名稱	lineItems.unitName	string
貨幣	lineItems.unitPrice.currency	string
總金額	lineItems.unitPrice.grossAmount	float
淨金額	lineItems.unitPrice.netAmount	float
稅率百分比	lineItems.unitPrice.taxRatePercentage	number
組織ID	organizationId	uuid
備註	remark	string
稅款金額	taxAmounts	array of object
淨金額	taxAmounts.netAmount	number
稅額	taxAmounts.taxAmount	number
稅率百分比	taxAmounts.taxRatePercentage	number
稅項類型	taxConditions.taxType	string
title	title	string
貨幣	totalPrice.currency	string
總額	totalPrice.totalGrossAmount	float
總淨額	totalPrice.totalNetAmount	float
總稅額	totalPrice.totalTaxAmount	float
更新日期	updatedDate	date-time
版本	version	integer
代金券日期	voucherDate	date-time
憑證號碼	voucherNumber	string
憑證狀態	voucherStatus	string

取得個人資料資訊

作業識別碼：: RetrieveProfileInformation

以下範例展示了如何取得您的基本個人資料資訊。在發送請求前，必須替換佔位符 {accessToken}。

傳回

身體: Response_profile_get

取得所有活動訂閱

作業識別碼：: RetrieveAllEventSubscriptions

取得所有活動訂閱

傳回

身體: Response_event-subscriptions_get

取得活動訂閱

作業識別碼：: RetrieveAEventSubscription

取得活動訂閱

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscriptionId	True	string	請指定訂閱 ID。

傳回

身體: EventSubscriptionResponse

取得訂單確認

作業識別碼：: RetrieveOrderConfirmation

回傳以 ID 值 {id} 的訂單確認。

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

名稱	路徑	類型
city	address.city	string
countryCode	address.countryCode	string
名稱	address.name	string
街道	address.street	string
補充資料	address.supplement	string
壓縮檔	address.zip	string
已存檔	archived	boolean
建立日期	createdDate	date-time
交付條款	deliveryTerms	string
documentFileID	files.documentFileId	uuid
識別碼	id	uuid
簡介	introduction	string
語言	language	string
明細項目	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
識別碼	lineItems.id	uuid
行項金額	lineItems.lineItemAmount	number
名稱	lineItems.name	string
數量	lineItems.quantity	number
型別	lineItems.type	string
單位名稱	lineItems.unitName	string
貨幣	lineItems.unitPrice.currency	string
總金額	lineItems.unitPrice.grossAmount	number
淨金額	lineItems.unitPrice.netAmount	number
稅率百分比	lineItems.unitPrice.taxRatePercentage	number
組織ID	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
折扣範圍	paymentConditions.paymentDiscountConditions.discountRange	integer
付款期限期限	paymentConditions.paymentTermDuration	integer
付款條款標籤	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
備註	remark	string
出貨日期	shippingConditions.shippingDate	date-time
航運類型	shippingConditions.shippingType	string
稅款金額	taxAmounts	array of object
淨金額	taxAmounts.netAmount	number
稅額	taxAmounts.taxAmount	number
稅率百分比	taxAmounts.taxRatePercentage	number
稅項類型	taxConditions.taxType	string
title	title	string
貨幣	totalPrice.currency	string
總額	totalPrice.totalGrossAmount	number
總淨額	totalPrice.totalNetAmount	number
總稅額	totalPrice.totalTaxAmount	number
更新日期	updatedDate	date-time
版本	version	integer
代金券日期	voucherDate	date-time
憑證號碼	voucherNumber	string
憑證狀態	voucherStatus	string

取得重複出現的範本

作業識別碼：: RetrieveRecurringTemplate

回傳帶有 id 值 {id} 的重複範本。

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

名稱	路徑	類型
city	address.city	string
contactId	address.contactId	uuid
countryCode	address.countryCode	string
名稱	address.name	string
街道	address.street	string
壓縮檔	address.zip	string
已存檔	archived	boolean
建立日期	createdDate	date-time
識別碼	id	uuid
簡介	introduction	string
語言	language	string
明細項目	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
行項金額	lineItems.lineItemAmount	number
名稱	lineItems.name	string
數量	lineItems.quantity	number
型別	lineItems.type	string
單位名稱	lineItems.unitName	string
貨幣	lineItems.unitPrice.currency	string
總金額	lineItems.unitPrice.grossAmount	number
淨金額	lineItems.unitPrice.netAmount	number
稅率百分比	lineItems.unitPrice.taxRatePercentage	number
組織ID	organizationId	uuid
付款期限期限	paymentConditions.paymentTermDuration	integer
付款條款標籤	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
recurringTemplateSettings	recurringTemplateSettings	object
備註	remark	string
稅款金額	taxAmounts	array of object
淨金額	taxAmounts.netAmount	number
稅額	taxAmounts.taxAmount	number
稅率百分比	taxAmounts.taxRatePercentage	number
稅項類型	taxConditions.taxType	string
title	title	string
貨幣	totalPrice.currency	string
總額	totalPrice.totalGrossAmount	number
總淨額	totalPrice.totalNetAmount	number
總稅額	totalPrice.totalTaxAmount	number
更新日期	updatedDate	date-time
版本	version	integer

報價文件（PDF）

作業識別碼：: RenderQuotationDocument

要下載報價文件的 PDF 檔案，你需要它的 documentFileId。這個 ID 通常由報價資源回傳。然而，透過 API 開啟狀態的新引文必須觸發 pdf 文件的獨立渲染。這可以用這個端點來完成。

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

名稱	路徑	類型	Description
documentFileID	documentFileId	uuid

將檔案上傳到憑證

作業識別碼：: UploadFileVoucher_Lexoffice

上傳並指派檔案（pdf或圖片）至由 {id} 標示的憑證。

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。
檔案	file	True	file	要上傳的檔案。

建立一篇文章

作業識別碼：: CreateArticle

文章內容預期會以應用程式/json 形式出現在請求的主體中。

參數

名稱	機碼	類型	Description
文章編號	articleNumber	string	文章編號
總價	grossPrice	float	總價
領先價格	leadingPrice	string	領先價格
淨價	netPrice	float	淨價
稅率	taxRate	float	稅率
title	title	string	title
型別	type	string	型別
單位名稱	unitName	string	單位名稱

傳回

身體: Response_articles_post

建立交付便條

作業識別碼：: CreateDeliveryNote

所產生的交付單會顯示在 LexOffice 的主憑證清單中。透過 API 傳送的交付便條僅以草稿模式產生。

參數

名稱	機碼	必要	類型	Description
前置銷售憑證ID	precedingSalesVoucherId		string	請指定前述的銷售憑證ID。

傳回

身體: Response_delivery-notes_post

建立信用票據

作業識別碼：: CreateCreditNote

透過 API 傳送的信用票據預設會以草稿模式產生。若要建立狀態開啟的最終信用註解，必須設定可選的查詢參數 finalize。信用報告的狀態無法透過 API 更改

參數

名稱	機碼	必要	類型	Description
前置銷售憑證ID	precedingSalesVoucherId		string	請指定前述的銷售憑證ID。
完成	finalize	True	boolean	具體說明最終決定。

傳回

身體: Response_credit-notes_post

建立催眠室

作業識別碼：: CreateDunning

所建立的債務不會顯示在 LexOffice 的主憑證清單中，而是會附加在發票上，並在那裡可見。若要讓您的客戶存取已建立的催收帳，請使用我們的深層連結功能。

參數

名稱	機碼	必要	類型	Description
前置銷售憑證ID	precedingSalesVoucherId		string	請指定前述的銷售憑證ID。

傳回

身體: Response_dunnings_post

建立報價

作業識別碼：: CreateQuotation

透過 API 傳送的報價預設會以草稿模式建立。要建立狀態開啟的最終報價，必須設定可選的查詢參數 finalize。報價的狀態無法透過 API 變更。

參數

名稱	機碼	必要	類型	Description
完成	finalize	True	boolean	具體說明最終決定。

傳回

身體: Response_quotations_post

建立憑證

作業識別碼：: CreateVoucher

建立代金券（僅限銷售代金券）

參數

名稱	機碼	必要	類型
contactId	contactId		string
截止日期	dueDate		date
備註	remark		string
出貨日期	shippingDate		date
稅項類型	taxType	True	string
總額	totalGrossAmount		float
總稅額	totalTaxAmount		float
型別	type	True	string
使用集體聯絡	useCollectiveContact		boolean
代金券日期	voucherDate		date
金額	amount		float
categoryId	categoryId		string
稅額	taxAmount		float
稅率百分比	taxRatePercent		integer
憑證號碼	voucherNumber		string
憑證狀態	voucherStatus		string

傳回

身體: Response_vouchers_post

建立發票

作業識別碼：: CreateInvoice

透過 API 傳送的發票預設以草稿模式建立。要建立狀態開啟的最終發票，必須設定可選的查詢參數 finalize。發票狀態無法透過 API 變更。

參數

名稱	機碼	必要	類型	Description
前置銷售憑證ID	precedingSalesVoucherId		string	請指定前述的銷售憑證ID。
完成	finalize	True	boolean	具體說明最終決定。

傳回

身體: Response_invoices_post

建立聯絡人

作業識別碼：: CreateContact

建立新聯絡人

傳回

身體: Response_contacts_post

建立訂單確認

作業識別碼：: CreateOrderConfirmation

此端點提供訂單確認的讀寫權限，並可將文件呈現為 PDF 以便下載。訂單確認總是在草稿模式下產生，不需要最終定稿。

參數

名稱	機碼	必要	類型	Description
前置銷售憑證ID	precedingSalesVoucherId		string	請指定前述的銷售憑證ID。

傳回

身體: Response_order-confirmations_post

提供信用說明文件（PDF）

作業識別碼：: RenderCreditNoteDocument

要下載信用備註文件的 PDF 檔案，您需要其 documentFileId。這個 ID 通常會由信用票據資源回傳。然而，透過 API 開啟狀態的新建立信用註解必須單獨觸發 PDF 文件的渲染。這可以用這個端點來完成。

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

名稱	路徑	類型	Description
documentFileID	documentFileId	uuid

更新憑證

作業識別碼：: UpdateVoucher

更新憑證

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。
contactId	contactId		string
截止日期	dueDate		date
files	files		array of string	省略檔案Id列表
備註	remark		string
出貨日期	shippingDate		date
稅項類型	taxType	True	string
總額	totalGrossAmount		float
總稅額	totalTaxAmount		float
型別	type	True	string
使用集體聯絡	useCollectiveContact		boolean
版本	version		integer
代金券日期	voucherDate		date
金額	amount		float
categoryId	categoryId		string
稅額	taxAmount		float
稅率百分比	taxRatePercent		integer
憑證號碼	voucherNumber		string
憑證狀態	voucherStatus		string

傳回

身體: Response_vouchers_id_put

更新文章

作業識別碼：: UpdateAnArticle

更新帶有 ID {id} 的現有文章，並使用有效載荷中提供的 JSON 資料。成功後返回行動結果。

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。
文章編號	articleNumber		string	文章編號
GTIN	gtin		string	GTIN
注意	note		string	注意
總價	grossPrice	True	float	總價
領先價格	leadingPrice	True	string	領先價格
淨價	netPrice	True	float	淨價
稅率	taxRate		float	稅率
title	title		string	title
型別	type	True	string	型別
單位名稱	unitName	True	string	單位名稱
版本	version	True	integer	版本

傳回

身體: Response_articles_id_get

更新聯絡人

作業識別碼：: UpdateContact

更新聯絡人

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

身體: Response_contacts_id_put

檢索付款資訊

作業識別碼：: RetrievePaymentInformation

支付端點提供讀取（簿記或銷售）憑證的付款狀態，包括發票與信用票據。

參數

名稱	機碼	必要	類型	Description
憑證ID	voucherId	True	string	請指定代金券編號。

傳回

名稱	路徑	類型
貨幣	currency	string
openAmount	openAmount	string
付款項目	paymentItems	array of object
金額	paymentItems.amount	float
貨幣	paymentItems.currency	string
付款項目類型	paymentItems.paymentItemType	string
發佈日期	paymentItems.postingDate	date-time
付款狀態	paymentStatus	string
憑證狀態	voucherStatus	string
代金券類型	voucherType	string

檢索國家列表

作業識別碼：: RetrieveListCountries

LexOffice 已知國家列表。

傳回

response: array of Response_countries_get_default

檢索引文

作業識別碼：: RetrieveQuotation

回傳 id 值 {id} 的引號。報價文件（PDF）

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

名稱	路徑	類型
city	address.city	string
contactId	address.contactId	uuid
countryCode	address.countryCode	string
名稱	address.name	string
街道	address.street	string
壓縮檔	address.zip	string
已存檔	archived	boolean
建立日期	createdDate	date-time
到期日期	expirationDate	date-time
documentFileID	files.documentFileId	uuid
識別碼	id	uuid
簡介	introduction	string
語言	language	string
明細項目	lineItems	array of object
另類	lineItems.alternative	boolean
discountPercentage	lineItems.discountPercentage	number
識別碼	lineItems.id	uuid
行項金額	lineItems.lineItemAmount	number
名稱	lineItems.name	string
optional	lineItems.optional	boolean
數量	lineItems.quantity	number
子項目	lineItems.subItems	array of object
另類	lineItems.subItems.alternative	boolean
discountPercentage	lineItems.subItems.discountPercentage	number
識別碼	lineItems.subItems.id	uuid
行項金額	lineItems.subItems.lineItemAmount	number
名稱	lineItems.subItems.name	string
optional	lineItems.subItems.optional	boolean
數量	lineItems.subItems.quantity	number
型別	lineItems.subItems.type	string
單位名稱	lineItems.subItems.unitName	string
貨幣	lineItems.subItems.unitPrice.currency	string
總金額	lineItems.subItems.unitPrice.grossAmount	number
淨金額	lineItems.subItems.unitPrice.netAmount	number
稅率百分比	lineItems.subItems.unitPrice.taxRatePercentage	number
型別	lineItems.type	string
單位名稱	lineItems.unitName	string
貨幣	lineItems.unitPrice.currency	string
總金額	lineItems.unitPrice.grossAmount	number
淨金額	lineItems.unitPrice.netAmount	number
稅率百分比	lineItems.unitPrice.taxRatePercentage	number
組織ID	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
折扣範圍	paymentConditions.paymentDiscountConditions.discountRange	integer
付款期限期限	paymentConditions.paymentTermDuration	integer
付款條款標籤	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
備註	remark	string
稅款金額	taxAmounts	array of object
淨金額	taxAmounts.netAmount	number
稅額	taxAmounts.taxAmount	number
稅率百分比	taxAmounts.taxRatePercentage	number
稅項類型	taxConditions.taxType	string
title	title	string
貨幣	totalPrice.currency	string
總額	totalPrice.totalGrossAmount	number
總淨額	totalPrice.totalNetAmount	number
總稅額	totalPrice.totalTaxAmount	number
更新日期	updatedDate	date-time
版本	version	integer
代金券日期	voucherDate	date-time
憑證號碼	voucherNumber	string
憑證狀態	voucherStatus	string

檢索所有聯絡人

作業識別碼：: RetrieveAllContacts

檢索所有聯絡人

參數

名稱	機碼	類型	Description
Number	number	integer	請指定數字。
Email	email	string	請指定電子郵件。
名稱	name	string	請指定名稱。
供應商	vendor	boolean	請指定供應商。
客戶	customer	boolean	請指定客戶。
頁面	page	integer	請指定頁面。
大小	size	integer	請指定尺寸。
排序	sort	string	請指定分類。

傳回

身體: Response_contacts_get

檢索文章

作業識別碼：: RetrieveAnArticle

回傳 id 值為 {id} 的文章。

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

名稱	路徑	類型
文章編號	articleNumber	string
GTIN	gtin	string
識別碼	id	string
注意	note	string
總價	price.grossPrice	float
領先價格	price.leadingPrice	string
淨價	price.netPrice	float
稅率	price.taxRate	float
title	title	string
型別	type	string
單位名稱	unitName	string
版本	version	integer

檢索發布分類列表

作業識別碼：: RetrieveListPostingCategories

此端點提供閱讀存取（簿記）憑證收入或支出的帳單類別清單，這些分類在 LexOffice 中皆支援。

傳回

response: array of Response_posting-categories_get_items

檢索與篩選憑證表

作業識別碼：: RetrieveAndFilterVoucherlist

取得憑證清單（簿記）憑證（例如銷售發票、銷售信用票據）、發票（包括頭期款發票）、信用憑證、訂單確認、報價單及交貨單據。

參數

名稱	機碼	必要	類型	Description
憑證類型	voucherType	True	string	請指定代金券類型。
代金券狀態	voucherStatus	True	string	請說明代金券狀態。
Archived	archived		boolean	請指定已存檔的。
聯絡人 ID	contactId		string	請指定聯絡人ID。
憑證日期來自	voucherDateFrom		string	請指定從哪個憑證日期開始。
代金券日期	voucherDateTo		string	請指定代金券日期。
建立日期	createdDateFrom		string	請指定建立日期。
建立日期至	createdDateTo		string	請指定建立日期。
更新日期	updatedDateFrom		string	請指定更新日期。
更新日期至	updatedDateTo		string	請指定更新日期。
憑證號碼	voucherNumber		string	請指定代金券號碼。
頁面	page		integer	請指定頁面。
大小	size		integer	請指定尺寸。
排序	sort		string	請指定分類。

傳回

身體: Response_voucherlist_get

渲染dunning文件（PDF）

作業識別碼：: RenderDunningDocument

要下載dunning文件的pdf檔，你需要它的documentFileId。這個 id 通常由 dunning 資源回傳。不過，透過 API 新建立的 dunning 必須單獨觸發 pdf 文件的渲染。這可以用這個端點來完成。

參數

名稱	機碼	必要	類型	Description
鄧寧斯德	dunningsid	True	string	指定 dunningsid。

傳回

名稱	路徑	類型	Description
documentFileID	documentFileId	uuid

製作交付便條文件（PDF）

作業識別碼：: RenderDeliveryNoteDocument

此端點提供送達筆記的讀寫權限，並可將文件呈現為 PDF 以便下載。交付便條總是在草稿模式下產生，不需要最終定稿。

參數

名稱	機碼	必要	類型	Description
交付註記	DeliveryNoteid	True	string	請指定 delivery noteid。

傳回

名稱	路徑	類型
city	address.city	string
countryCode	address.countryCode	string
名稱	address.name	string
街道	address.street	string
補充資料	address.supplement	string
壓縮檔	address.zip	string
已存檔	archived	boolean
建立日期	createdDate	date-time
交付條款	deliveryTerms	string
識別碼	id	uuid
簡介	introduction	string
語言	language	string
明細項目	lineItems	array of object
名稱	lineItems.name	string
數量	lineItems.quantity	number
型別	lineItems.type	string
單位名稱	lineItems.unitName	string
貨幣	lineItems.unitPrice.currency	string
總金額	lineItems.unitPrice.grossAmount	float
淨金額	lineItems.unitPrice.netAmount	float
稅率百分比	lineItems.unitPrice.taxRatePercentage	number
組織ID	organizationId	uuid
備註	remark	string
稅項類型	taxConditions.taxType	string
title	title	string
更新日期	updatedDate	date-time
版本	version	integer
代金券日期	voucherDate	date-time
憑證號碼	voucherNumber	string
憑證狀態	voucherStatus	string

製作發票文件（PDF）

作業識別碼：: RenderInvoiceDocument

要下載發票文件的 PDF 檔案，你需要它的 documentFileId。這個 ID 通常會由發票資源回傳。然而，透過 API 開啟狀態的新發票必須單獨觸發 PDF 文件的渲染。這可以用這個端點來完成。

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

名稱	路徑	類型	Description
documentFileID	documentFileId	uuid

製作訂單確認文件（PDF）

作業識別碼：: RenderOrderConfirmationDocument

要下載訂單確認文件的 PDF 檔，你需要它的 documentFileId。此 ID 通常由訂單確認資源回傳。然而，透過 API 新建立的訂單確認必須單獨觸發 PDF 文件的渲染。這可以用這個端點來完成。

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	string	請指定識別碼。

傳回

名稱	路徑	類型	Description
documentFileID	documentFileId	uuid

過濾條目

作業識別碼：: FilteringArticles

回傳符合篩選條件的文章，filter_1透過分頁機制filter_n。若有多個濾波器，邏輯連接器為 AND。未設定的過濾器會被忽略。要檢查此端點的最大頁面大小，請參閱資源分頁。

參數

名稱	機碼	類型	Description
條文編號	articleNumber	string	請指定文章編號。
GTIN	gtin	string	指定 GTIN。
類型	type	string	請指定類型。
頁面	page	integer	請指定頁面。
大小	size	integer	請指定尺寸。
排序	sort	string	請指定分類。

傳回

身體: Response_articles_get

觸發程序

選擇你自訂的觸發器

註冊一個新的聯絡端點觸發器

選擇你自訂的觸發器

作業識別碼：: EventSubscription_Lexoffice

註冊一個新的聯絡端點觸發器

參數

名稱	機碼	必要	類型	Description
事件類型	eventType	True	string	eventType

傳回

名稱	路徑	類型	Description
事件日期	eventDate	string	事件日期
eventType	eventType	string	eventType
組織ID	organizationId	string	組織ID
resourceId	resourceId	string	resourceId

定義

活動訂閱回應

名稱	路徑	類型
subscriptionId	subscriptionId	string
eventType	eventType	string
組織ID	organizationId	string
建立日期	createdDate	date-time
回調網址	callbackUrl	string

Response_articles_get

名稱	路徑	類型	Description
內容	content	array of object	內容
文章編號	content.articleNumber	string	文章編號
GTIN	content.gtin	string	GTIN
識別碼	content.id	string	識別碼
注意	content.note	string	注意
總價	content.price.grossPrice	float	總價
領先價格	content.price.leadingPrice	string	領先價格
淨價	content.price.netPrice	float	淨價
稅率	content.price.taxRate	float	稅率
title	content.title	string	title
型別	content.type	string	型別
單位名稱	content.unitName	string	單位名稱
版本	content.version	integer	版本
first	first	boolean	first
last	last	boolean	last
數字	number	integer	數字
元素數	numberOfElements	integer	元素數
size	size	integer	size
排序	sort	array of object	排序
上升	sort.ascending	boolean	上升
方向	sort.direction	string	方向
ignoreCase 的	sort.ignoreCase	boolean	ignoreCase 的
nullHandling	sort.nullHandling	string	nullHandling
屬性	sort.property	string	屬性
總元素	totalElements	integer	總元素
總頁數	totalPages	integer	總頁數

Response_articles_id_get

名稱	路徑	類型	Description
文章編號	articleNumber	string	文章編號
GTIN	gtin	string	GTIN
識別碼	id	string	識別碼
注意	note	string	注意
總價	price.grossPrice	float	總價
領先價格	price.leadingPrice	string	領先價格
淨價	price.netPrice	float	淨價
稅率	price.taxRate	float	稅率
title	title	string	title
型別	type	string	型別
單位名稱	unitName	string	單位名稱
版本	version	integer	版本

Response_articles_post

名稱	路徑	類型	Description
建立日期	createdDate	string	建立日期
識別碼	id	string	識別碼
resourceUri	resourceUri	string	resourceUri
更新日期	updatedDate	string	更新日期
版本	version	integer	版本

Response_contacts_get

名稱	路徑	類型	Description
內容	content	array of object	內容
帳單	content.addresses.billing	array of object	帳單
city	content.addresses.billing.city	string	city
countryCode	content.addresses.billing.countryCode	string	countryCode
街道	content.addresses.billing.street	string	街道
補充資料	content.addresses.billing.supplement	string	補充資料
壓縮檔	content.addresses.billing.zip	string	壓縮檔
運送	content.addresses.shipping	array of object	運送
city	content.addresses.shipping.city	string	city
countryCode	content.addresses.shipping.countryCode	string	countryCode
街道	content.addresses.shipping.street	string	街道
補充資料	content.addresses.shipping.supplement	string	補充資料
壓縮檔	content.addresses.shipping.zip	string	壓縮檔
已存檔	content.archived	boolean	已存檔
允許免稅發票	content.company.allowTaxFreeInvoices	boolean	允許免稅發票
聯絡人	content.company.contactPersons	array of object	聯絡人
電子郵件地址	content.company.contactPersons.emailAddress	string	電子郵件地址
名字	content.company.contactPersons.firstName	string	名字
lastName	content.company.contactPersons.lastName	string	lastName
主要	content.company.contactPersons.primary	boolean	主要
稱呼	content.company.contactPersons.salutation	string	稱呼
名稱	content.company.name	string	名稱
稅號	content.company.taxNumber	string	稅號
vatRegistrationId	content.company.vatRegistrationId	string	vatRegistrationId
商	content.emailAddresses.business	array of string	商
辦公室	content.emailAddresses.office	array of string	辦公室
other	content.emailAddresses.other	array of string	other
識別碼	content.id	string	識別碼
注意	content.note	string	注意
組織ID	content.organizationId	string	組織ID
商	content.phoneNumbers.business	array of string	商
傳真	content.phoneNumbers.fax	array of string	傳真
辦公室	content.phoneNumbers.office	array of string	辦公室
other	content.phoneNumbers.other	array of string	other
數字	content.roles.customer.number	integer	數字
數字	content.roles.vendor.number	integer	數字
版本	content.version	integer	版本
first	first	boolean	first
last	last	boolean	last
數字	number	integer	數字
元素數	numberOfElements	integer	元素數
size	size	integer	size
排序	sort	array of object	排序
上升	sort.ascending	boolean	上升
方向	sort.direction	string	方向
ignoreCase 的	sort.ignoreCase	boolean	ignoreCase 的
nullHandling	sort.nullHandling	string	nullHandling
屬性	sort.property	string	屬性
總元素	totalElements	integer	總元素
總頁數	totalPages	integer	總頁數

Response_contacts_post

名稱	路徑	類型	Description
建立日期	createdDate	string	建立日期
識別碼	id	string	識別碼
resourceUri	resourceUri	string	resourceUri
更新日期	updatedDate	string	更新日期
版本	version	integer	版本

Response_countries_get_default

名稱	路徑	類型	Description
countryCode	countryCode	string	countryCode
countryNameDE	countryNameDE	string	countryNameDE
countryNameEN	countryNameEN	string	countryNameEN
稅務分類	taxClassification	string	稅務分類

Response_credit notes_post

名稱	路徑	類型	Description
建立日期	createdDate	string	建立日期
識別碼	id	string	識別碼
resourceUri	resourceUri	string	resourceUri
更新日期	updatedDate	string	更新日期
版本	version	integer	版本

Response_delivery notes_post

名稱	路徑	類型	Description
建立日期	createdDate	string	建立日期
識別碼	id	string	識別碼
resourceUri	resourceUri	string	resourceUri
更新日期	updatedDate	string	更新日期
版本	version	integer	版本

Response_dunnings_post

名稱	路徑	類型	Description
建立日期	createdDate	string	建立日期
識別碼	id	string	識別碼
resourceUri	resourceUri	string	resourceUri
更新日期	updatedDate	string	更新日期
版本	version	integer	版本

Response_event subscriptions_get

名稱	路徑	類型	Description
內容	content	array of object	內容
回調網址	content.callbackUrl	string	回調網址
建立日期	content.createdDate	string	建立日期
eventType	content.eventType	string	eventType
組織ID	content.organizationId	string	組織ID
subscriptionId	content.subscriptionId	string	subscriptionId

Response_files_post

名稱	路徑	類型	Description
識別碼	id	string	識別碼

Response_invoices_post

名稱	路徑	類型	Description
建立日期	createdDate	string	建立日期
識別碼	id	string	識別碼
resourceUri	resourceUri	string	resourceUri
更新日期	updatedDate	string	更新日期
版本	version	integer	版本

Response_order confirmations_post

名稱	路徑	類型	Description
建立日期	createdDate	string	建立日期
識別碼	id	string	識別碼
resourceUri	resourceUri	string	resourceUri
更新日期	updatedDate	string	更新日期
版本	version	integer	版本

Response_payment conditions_get_items

名稱	路徑	類型	Description
識別碼	id	string	識別碼
組織預設	organizationDefault	boolean	組織預設
discountPercentage	paymentDiscountConditions.discountPercentage	integer	discountPercentage
折扣範圍	paymentDiscountConditions.discountRange	integer	折扣範圍
付款期限期限	paymentTermDuration	integer	付款期限期限
paymentTermLabelTemplate	paymentTermLabelTemplate	string	paymentTermLabelTemplate

Response_posting categories_get_items

名稱	路徑	類型	Description
聯絡人	contactRequired	boolean	聯絡人
groupName	groupName	string	groupName
識別碼	id	string	識別碼
名稱	name	string	名稱
分裂允許	splitAllowed	boolean	分裂允許
型別	type	string	型別

Response_profile_get

名稱	路徑	類型	Description
商業特色	businessFeatures	array of string	商業特色
companyName	companyName	string	companyName
connectionId	connectionId	string	connectionId
date	created.date	string	date
使用者郵箱	created.userEmail	string	使用者郵箱
userId	created.userId	string	userId
使用者名稱	created.userName	string	使用者名稱
features	features	array of string	features
組織ID	organizationId	string	組織ID
小型企業	smallBusiness	boolean	小型企業
subscriptionStatus 訂閱狀態	subscriptionStatus	string	subscriptionStatus 訂閱狀態
稅項類型	taxType	string	稅項類型

Response_quotations_post

名稱	路徑	類型	Description
建立日期	createdDate	string	建立日期
識別碼	id	string	識別碼
resourceUri	resourceUri	string	resourceUri
更新日期	updatedDate	string	更新日期
版本	version	integer	版本

Response_recurring templates_get

名稱	路徑	類型	Description
內容	content	array of object	內容
contactId	content.address.contactId	string	contactId
名稱	content.address.name	string	名稱
建立日期	content.createdDate	string	建立日期
識別碼	content.id	string	識別碼
組織ID	content.organizationId	string	組織ID
discountPercentage	content.paymentConditions.paymentDiscountConditions.discountPercentage	integer	discountPercentage
折扣範圍	content.paymentConditions.paymentDiscountConditions.discountRange	integer	折扣範圍
付款期限期限	content.paymentConditions.paymentTermDuration	integer	付款期限期限
付款條款標籤	content.paymentConditions.paymentTermLabel	string	付款條款標籤
paymentTermLabelTemplate	content.paymentConditions.paymentTermLabelTemplate	string	paymentTermLabelTemplate
結束日期	content.recurringTemplateSettings.endDate	string	結束日期
執行區間	content.recurringTemplateSettings.executionInterval	string	執行區間
執行狀態	content.recurringTemplateSettings.executionStatus	string	執行狀態
最終完成	content.recurringTemplateSettings.finalize	boolean	最終完成
識別碼	content.recurringTemplateSettings.id	string	識別碼
最後執行失敗	content.recurringTemplateSettings.lastExecutionFailed	boolean	最後執行失敗
下一個執行日期	content.recurringTemplateSettings.nextExecutionDate	string	下一個執行日期
航運類型	content.recurringTemplateSettings.shippingType	string	航運類型
startDate	content.recurringTemplateSettings.startDate	string	startDate
title	content.title	string	title
貨幣	content.totalPrice.currency	string	貨幣
總額	content.totalPrice.totalGrossAmount	integer	總額
總淨額	content.totalPrice.totalNetAmount	float	總淨額
更新日期	content.updatedDate	string	更新日期
first	first	boolean	first
last	last	boolean	last
數字	number	integer	數字
元素數	numberOfElements	integer	元素數
size	size	integer	size
排序	sort	array of object	排序
上升	sort.ascending	boolean	上升
方向	sort.direction	string	方向
ignoreCase 的	sort.ignoreCase	boolean	ignoreCase 的
nullHandling	sort.nullHandling	string	nullHandling
屬性	sort.property	string	屬性
總元素	totalElements	integer	總元素
總頁數	totalPages	integer	總頁數

Response_voucherlist_get

名稱	路徑	類型	Description
內容	content	array of object	內容
已存檔	content.archived	boolean	已存檔
contactId	content.contactId	string	contactId
聯繫人名稱	content.contactName	string	聯繫人名稱
建立日期	content.createdDate	string	建立日期
貨幣	content.currency	string	貨幣
截止日期	content.dueDate	string	截止日期
識別碼	content.id	string	識別碼
openAmount	content.openAmount	float	openAmount
總金額	content.totalAmount	float	總金額
更新日期	content.updatedDate	string	更新日期
代金券日期	content.voucherDate	string	代金券日期
憑證號碼	content.voucherNumber	string	憑證號碼
憑證狀態	content.voucherStatus	string	憑證狀態
代金券類型	content.voucherType	string	代金券類型
first	first	boolean	first
last	last	boolean	last
數字	number	integer	數字
元素數	numberOfElements	integer	元素數
size	size	integer	size
排序	sort	array of object	排序
上升	sort.ascending	boolean	上升
方向	sort.direction	string	方向
ignoreCase 的	sort.ignoreCase	boolean	ignoreCase 的
nullHandling	sort.nullHandling	string	nullHandling
屬性	sort.property	string	屬性
總元素	totalElements	integer	總元素
總頁數	totalPages	integer	總頁數

Response_vouchers_post

名稱	路徑	類型	Description
建立日期	createdDate	string	建立日期
識別碼	id	string	識別碼
resourceUri	resourceUri	string	resourceUri
更新日期	updatedDate	string	更新日期
版本	version	integer	版本

Response_contacts_id_put

名稱	路徑	類型
已存檔	archived	boolean
識別碼	id	uuid
組織ID	organizationId	uuid
名字	person.firstName	string
lastName	person.lastName	string
稱呼	person.salutation	string
數字	roles.customer.number	integer
版本	version	integer

Response_vouchers_id_put

名稱	路徑	類型
建立日期	createdDate	date-time
截止日期	dueDate	date-time
files	files	array of object
items	files	object
識別碼	id	uuid
組織ID	organizationId	uuid
備註	remark	string
出貨日期	shippingDate	date-time
稅項類型	taxType	string
總額	totalGrossAmount	number
總稅額	totalTaxAmount	number
型別	type	string
更新日期	updatedDate	date-time
使用集體聯絡	useCollectiveContact	boolean
版本	version	integer
代金券日期	voucherDate	date-time
憑證項目	voucherItems	array of object
金額	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
稅額	voucherItems.taxAmount	number
稅率百分比	voucherItems.taxRatePercent	number
憑證號碼	voucherNumber	string
憑證狀態	voucherStatus	string

檔案

這是基本資料類型「檔案」。

共用方式為

Lexoffice（獨立出版社）（預覽）

Lexware API 連接器（獨立出版商）

出版社：獨立出版社

先決條件

支援的作業

取得憑證

API 閘道

速率限制

Authentication

範例使用方式

已知問題和限制

API 文件

建立連線

預設

節流限制

動作

上傳檔案

參數

傳回

下載檔案

參數

傳回

刪除 Event-Subscription

參數

刪除文章

參數

取回一筆 dunning

參數

傳回

取回交付通知

參數

傳回

取回憑證

參數

傳回

取回所有重複出現的範本

參數

傳回

取回發票

參數

傳回

取回聯絡人

參數

傳回

取回頭期款發票

參數

傳回

取得付款條件清單

傳回

取得信用票據

參數

傳回

取得個人資料資訊

傳回

取得所有活動訂閱

傳回

取得活動訂閱

參數

傳回

取得訂單確認

參數

傳回

取得重複出現的範本

參數

傳回

報價文件（PDF）

參數

傳回

將檔案上傳到憑證

參數

建立一篇文章

參數

傳回

建立交付便條

參數

傳回

建立信用票據

參數

傳回