通过

Lexoffice （独立出版商） （预览版）

Lexware API 提供对核心 Lexware 业务功能（如文章、联系人、发票、订单和文件管理）的编程访问。 此独立发布服务器连接器支持与 Lexware 的 REST API 的安全集成，使用户能够创建和检索业务数据、自动化流程以及将 Lexware 资源与 Power Platform 应用程序连接。 连接器使用 OAuth 2.0 授权代码流进行安全身份验证和 API 准则。

此连接器在以下产品和区域中可用：

服务 Class 区域
Copilot Studio 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域 ：
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部（DoD）
Power Apps 高级 除以下各项外的所有 Power Apps 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
Power Automate 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
联系人​​
Name LowCode 调查人员支持
URL https://lowcode-investigator.com/
Email kontakt@lowcodeinvestigator.com
连接器元数据
发布者 LowCodeInvestigator
网站 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 Docs

获取凭据

若要调用 Lexware API，需要一个 API 密钥：

  1. 登录到 Lexware Office 帐户。
  2. 导航到 Weitere 应用→公共 API 或打开的扩展→
    Lexware 开发人员门户 直接。
  3. 使用所需的权限创建新的 API 密钥。
  4. 复制生成的 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 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name 类型 Description 必选
API 密钥 securestring 此 API 的 API 密钥 True

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

上传文件

使用此终结点上传文件，例如凭证或发票。
下载文件

使用此终结点下载文件。
创建传递说明

创建的交付说明将显示在 lexoffice 的主凭证列表中。 通过 API 传输的传递说明仅在草稿模式下创建。
创建信用额度说明

通过 API 传输的信用额度是默认在草稿模式下创建的。 若要创建状态为“完成的信用额度”，必须设置可选的查询参数终结。 无法通过 API 更改信用额度的状态
创建凭证

创建凭证（仅限销售凭证）
创建发票

默认情况下，通过 API 传输的发票以草稿模式创建。 若要创建状态为“已完成”的发票，必须设置可选的查询参数终结。 无法通过 API 更改发票的状态。
创建扣篮

创建的扣篮不会显示在 lexoffice 的主凭证列表中，但会附加到发票上，并且将显示在该处。 若要让客户访问创建的扣篮，请使用我们的深层链接功能。
创建报价

默认情况下，通过 API 传输的报价以草稿模式创建。 若要创建具有状态的终结引号，必须设置可选的查询参数终结。 无法通过 API 更改报价的状态。
创建联系人

创建新联系人
创建订单确认

此终结点提供对订单确认的读取和写入访问权限，以及将文档呈现为 PDF 以下载文档的可能性。 订单确认始终在草稿模式下创建，无需最终确定。
创建项目

项目的内容应以 application/json 形式出现在请求正文中。
删除 Event-Subscription

删除触发器 WebHook
删除项目

删除 ID 值为 {id} 的文章。 如果 ID 不存在，则返回 204。如果 ID 不存在，则返回 404。
呈现交付说明文档（PDF）

此终结点提供对送达笔记的读取和写入访问权限，还可以将文档呈现为 PDF，以便下载文档。 传递笔记始终在草稿模式下创建，无需最终确定。
呈现信用说明文档（PDF）

若要下载信用说明文档的 pdf 文件，需要其 documentFileId。 此 ID 通常由信用额度笔记资源返回。 但是，通过 API 打开状态中新建的信用额度必须单独触发 PDF 文档文件呈现。 这可以通过此终结点完成。
呈现发票文档（PDF）

若要下载发票文档的 pdf 文件，需要其 documentFileId。 此 ID 通常由发票资源返回。 但是，通过 API 打开状态中新建的发票必须单独触发 pdf 文档文件呈现。 这可以通过此终结点完成。
呈现扣篮文档 （PDF）

若要下载删除文档的 pdf 文件，需要其 documentFileId。 此 ID 通常由扣篮资源返回。 但是，通过 API 新建的扣篮必须单独触发 pdf 文档文件呈现。 这可以通过此终结点完成。
呈现报价文档 （PDF）

若要下载报价文档的 pdf 文件，需要其 documentFileId。 此 ID 通常由报价资源返回。 但是，通过 API 打开的状态中新建的报价必须单独触发 PDF 文档文件呈现。 这可以通过此终结点完成。
呈现订单确认文档（PDF）

若要下载订单确认文档的 pdf 文件，需要其 documentFileId。 此 ID 通常由订单确认资源返回。 但是，通过 API 新建的订单确认必须单独触发 pdf 文档文件呈现。 这可以通过此终结点完成。
将文件上传到凭证

将文件（pdf 或图像）上传到 {id} 标识的凭证。
更新凭证

更新凭证
更新文章

使用在有效负载中提供的数据更新 ID 为 {id} 的现有项目作为 JSON。 返回成功作结果。
更新联系人

更新联系人
检索事件订阅

检索事件订阅
检索付款信息

付款终结点提供对（记帐或销售）凭证（包括发票和信用单）付款状态的读取访问权限。
检索付款条件列表

以下示例演示如何检索当前配置的付款条件列表。 在发送请求之前，需要替换占位符 {accessToken} 。
检索信用额度说明

此终结点提供对信用额度笔记的读取和写入访问权限，以及将文档呈现为 PDF 以下载文档的可能性。 信用额度可以创建为草稿，也可以在打开模式下完成。
检索凭证

列出销售凭证（例如发票、信用额度）
检索发布类别列表

此终结点提供对在 lexoffice 中支持的（记帐）凭证收入或费用的发布类别列表的读取访问权限。
检索发票

返回 ID 值为 {id} 的发票。
检索和筛选凭证列表

获取代金券列表（例如 salesinvoices、salescreditnotes）、发票（包括首付发票）、信用单、订单确认、报价和送货单。
检索国家/地区列表

lexoffice 已知的国家/地区列表。
检索定期模板

返回 ID 值为 {id} 的定期模板。
检索引号

返回 ID 值为 {id} 的引号。 呈现报价文档 （PDF）
检索所有事件订阅

检索所有事件订阅
检索所有定期模板

检索定期模板的集合。 结果仅返回引用的联系人（仅 ID 和姓名）、总价格、付款条件和完整的定期模板设置的一部分相关数据。 不过，对象的命名和属性是相同的。
检索所有联系人

检索所有联系人
检索扣篮

返回 ID 值为 {id} 的扣篮。
检索联系人

按 ID 检索联系人
检索订单确认

返回 ID 值为 {id} 的订单确认。
检索送达说明

返回 ID 值为 {id} 的传递说明。
检索配置文件信息

以下示例演示如何检索基本配置文件信息。 在发送请求之前，需要替换占位符 {accessToken} 。
检索项目

返回 ID 值为 {id} 的文章。
检索首付发票

返回 ID 值为 {id} 的首付发票。
筛选文章

返回满足筛选器filter_1 filter_n使用分页机制的条件的项目。 如果给定了多个筛选器，则逻辑连接器为 AND。 未设置的筛选器将被忽略。 若要查看此终结点的最大页面大小，请参阅“资源分页”。

上传文件

操作 ID:
UploadFile_Lexoffice

使用此终结点上传文件，例如凭证或发票。

参数

名称 密钥 必需 类型 说明
文件
 file True file

要上传的文件。
类型
 type True string

文件内容的说明。

返回

Body
Response_files_post

下载文件

操作 ID:
DownloadFile_Lexoffice

使用此终结点下载文件。

参数

名称 密钥 必需 类型 说明
文件 ID
 fileId True string

指定文件 ID。
接受
 Accept string

指定接受。

返回

response
file

创建传递说明

操作 ID:
CreateDeliveryNote

创建的交付说明将显示在 lexoffice 的主凭证列表中。 通过 API 传输的传递说明仅在草稿模式下创建。

参数

名称 密钥 必需 类型 说明
前面的销售凭证 ID
 precedingSalesVoucherId string

指定前面的销售凭证 ID。

返回

Body
Response_delivery-notes_post

创建信用额度说明

操作 ID:
CreateCreditNote

通过 API 传输的信用额度是默认在草稿模式下创建的。 若要创建状态为“完成的信用额度”，必须设置可选的查询参数终结。 无法通过 API 更改信用额度的状态

参数

名称 密钥 必需 类型 说明
前面的销售凭证 ID
 precedingSalesVoucherId string

指定前面的销售凭证 ID。
完成
 finalize True boolean

指定终结。

返回

Body
Response_credit-notes_post

创建凭证

操作 ID:
CreateVoucher

创建凭证（仅限销售凭证）

参数

名称 密钥 必需 类型 说明
contactId
 contactId string
dueDate
 dueDate date
注解
 remark string
shippingDate
 shippingDate date
taxType
 taxType True string
totalGrossAmount
 totalGrossAmount float
totalTaxAmount
 totalTaxAmount float
类型
 type True string
useCollectiveContact
 useCollectiveContact boolean
voucherDate
 voucherDate date
量
 amount float
categoryId
 categoryId string
taxAmount
 taxAmount float
taxRatePercent
 taxRatePercent integer
voucherNumber
 voucherNumber string
voucherStatus
 voucherStatus string

返回

Body
Response_vouchers_post

创建发票

操作 ID:
CreateInvoice

默认情况下，通过 API 传输的发票以草稿模式创建。 若要创建状态为“已完成”的发票，必须设置可选的查询参数终结。 无法通过 API 更改发票的状态。

参数

名称 密钥 必需 类型 说明
前面的销售凭证 ID
 precedingSalesVoucherId string

指定前面的销售凭证 ID。
完成
 finalize True boolean

指定终结。

返回

Body
Response_invoices_post

创建扣篮

操作 ID:
CreateDunning

创建的扣篮不会显示在 lexoffice 的主凭证列表中，但会附加到发票上，并且将显示在该处。 若要让客户访问创建的扣篮，请使用我们的深层链接功能。

参数

名称 密钥 必需 类型 说明
前面的销售凭证 ID
 precedingSalesVoucherId string

指定前面的销售凭证 ID。

返回

Body
Response_dunnings_post

创建报价

操作 ID:
CreateQuotation

默认情况下，通过 API 传输的报价以草稿模式创建。 若要创建具有状态的终结引号，必须设置可选的查询参数终结。 无法通过 API 更改报价的状态。

参数

名称 密钥 必需 类型 说明
完成
 finalize True boolean

指定终结。

返回

Body
Response_quotations_post

创建联系人

操作 ID:
CreateContact

创建新联系人

返回

Body
Response_contacts_post

创建订单确认

操作 ID:
CreateOrderConfirmation

此终结点提供对订单确认的读取和写入访问权限，以及将文档呈现为 PDF 以下载文档的可能性。 订单确认始终在草稿模式下创建，无需最终确定。

参数

名称 密钥 必需 类型 说明
前面的销售凭证 ID
 precedingSalesVoucherId string

指定前面的销售凭证 ID。

返回

Body
Response_order-confirmations_post

创建项目

操作 ID:
CreateArticle

项目的内容应以 application/json 形式出现在请求正文中。

参数

名称 密钥 必需 类型 说明
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 string

类型
unitName
 unitName string

unitName

返回

Body
Response_articles_post

删除 Event-Subscription

操作 ID:
DeleteEventSubscription

删除触发器 WebHook

参数

名称 密钥 必需 类型 说明
订阅 ID
 subscriptionId True string

指定订阅 ID。

删除项目

操作 ID:
DeleteAnArticle

删除 ID 值为 {id} 的文章。 如果 ID 不存在，则返回 204。如果 ID 不存在，则返回 404。

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

呈现交付说明文档（PDF）

操作 ID:
RenderDeliveryNoteDocument

此终结点提供对送达笔记的读取和写入访问权限，还可以将文档呈现为 PDF，以便下载文档。 传递笔记始终在草稿模式下创建，无需最终确定。

参数

名称 密钥 必需 类型 说明
Delivery Noteid
 DeliveryNoteid True string

指定传递注释。

返回

名称 路径 类型 说明
城市
 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
 deliveryTerms string
id
 id uuid
简介
 introduction string
语言
 language string
lineItems
 lineItems array of object
姓名
 lineItems.name string
数量
 lineItems.quantity number
类型
 lineItems.type string
unitName
 lineItems.unitName string
货币
 lineItems.unitPrice.currency string
grossAmount
 lineItems.unitPrice.grossAmount float
netAmount
 lineItems.unitPrice.netAmount float
taxRatePercentage
 lineItems.unitPrice.taxRatePercentage number
organizationId
 organizationId uuid
注解
 remark string
taxType
 taxConditions.taxType string
title
 title string
updatedDate
 updatedDate date-time
版本
 version integer
voucherDate
 voucherDate date-time
voucherNumber
 voucherNumber string
voucherStatus
 voucherStatus string

呈现信用说明文档（PDF）

操作 ID:
RenderCreditNoteDocument

若要下载信用说明文档的 pdf 文件，需要其 documentFileId。 此 ID 通常由信用额度笔记资源返回。 但是，通过 API 打开状态中新建的信用额度必须单独触发 PDF 文档文件呈现。 这可以通过此终结点完成。

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

名称 路径 类型 说明
documentFileId
 documentFileId uuid

呈现发票文档（PDF）

操作 ID:
RenderInvoiceDocument

若要下载发票文档的 pdf 文件，需要其 documentFileId。 此 ID 通常由发票资源返回。 但是，通过 API 打开状态中新建的发票必须单独触发 pdf 文档文件呈现。 这可以通过此终结点完成。

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

名称 路径 类型 说明
documentFileId
 documentFileId uuid

呈现扣篮文档 （PDF）

操作 ID:
RenderDunningDocument

若要下载删除文档的 pdf 文件，需要其 documentFileId。 此 ID 通常由扣篮资源返回。 但是，通过 API 新建的扣篮必须单独触发 pdf 文档文件呈现。 这可以通过此终结点完成。

参数

名称 密钥 必需 类型 说明
邓宁西德
 dunningsid True string

指定 dunningsid。

返回

名称 路径 类型 说明
documentFileId
 documentFileId uuid

呈现报价文档 （PDF）

操作 ID:
RenderQuotationDocument

若要下载报价文档的 pdf 文件，需要其 documentFileId。 此 ID 通常由报价资源返回。 但是，通过 API 打开的状态中新建的报价必须单独触发 PDF 文档文件呈现。 这可以通过此终结点完成。

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

名称 路径 类型 说明
documentFileId
 documentFileId uuid

呈现订单确认文档（PDF）

操作 ID:
RenderOrderConfirmationDocument

若要下载订单确认文档的 pdf 文件，需要其 documentFileId。 此 ID 通常由订单确认资源返回。 但是，通过 API 新建的订单确认必须单独触发 pdf 文档文件呈现。 这可以通过此终结点完成。

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

名称 路径 类型 说明
documentFileId
 documentFileId uuid

将文件上传到凭证

操作 ID:
UploadFileVoucher_Lexoffice

将文件（pdf 或图像）上传到 {id} 标识的凭证。

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。
文件
 file True file

要上传的文件。

更新凭证

操作 ID:
UpdateVoucher

更新凭证

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。
contactId
 contactId string
dueDate
 dueDate date
files
 files array of string

省略 fileIds 列表
注解
 remark string
shippingDate
 shippingDate date
taxType
 taxType True string
totalGrossAmount
 totalGrossAmount float
totalTaxAmount
 totalTaxAmount float
类型
 type True string
useCollectiveContact
 useCollectiveContact boolean
版本
 version integer
voucherDate
 voucherDate date
量
 amount float
categoryId
 categoryId string
taxAmount
 taxAmount float
taxRatePercent
 taxRatePercent integer
voucherNumber
 voucherNumber string
voucherStatus
 voucherStatus string

返回

Body
Response_vouchers_id_put

更新文章

操作 ID:
UpdateAnArticle

使用在有效负载中提供的数据更新 ID 为 {id} 的现有项目作为 JSON。 返回成功作结果。

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。
articleNumber
 articleNumber string

articleNumber
gtin
 gtin string

gtin
注意
 note string

注意
grossPrice
 grossPrice True float

grossPrice
leadingPrice
 leadingPrice True string

leadingPrice
netPrice
 netPrice True float

netPrice
taxRate
 taxRate float

taxRate
title
 title string

title
类型
 type True string

类型
unitName
 unitName True string

unitName
版本
 version True integer

版本

返回

Body
Response_articles_id_get

更新联系人

操作 ID:
UpdateContact

更新联系人

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

Body
Response_contacts_id_put

检索事件订阅

操作 ID:
RetrieveAEventSubscription

检索事件订阅

参数

名称 密钥 必需 类型 说明
订阅 ID
 subscriptionId True string

指定订阅 ID。

返回

Body
EventSubscriptionResponse

检索付款信息

操作 ID:
RetrievePaymentInformation

付款终结点提供对（记帐或销售）凭证（包括发票和信用单）付款状态的读取访问权限。

参数

名称 密钥 必需 类型 说明
代金券 ID
 voucherId True string

指定代金券 ID。

返回

名称 路径 类型 说明
货币
 currency string
openAmount
 openAmount string
paymentItems
 paymentItems array of object
量
 paymentItems.amount float
货币
 paymentItems.currency string
paymentItemType
 paymentItems.paymentItemType string
postingDate
 paymentItems.postingDate date-time
paymentStatus
 paymentStatus string
voucherStatus
 voucherStatus string
voucherType
 voucherType string

检索付款条件列表

操作 ID:
RetrieveListOfPaymentConditions

以下示例演示如何检索当前配置的付款条件列表。 在发送请求之前，需要替换占位符 {accessToken} 。

返回

response
array of Response_payment-conditions_get_items

检索信用额度说明

操作 ID:
RetrieveCreditNote

此终结点提供对信用额度笔记的读取和写入访问权限，以及将文档呈现为 PDF 以下载文档的可能性。 信用额度可以创建为草稿，也可以在打开模式下完成。

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

名称 路径 类型 说明
城市
 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
 id uuid
简介
 introduction string
语言
 language string
lineItems
 lineItems array of object
lineItemAmount
 lineItems.lineItemAmount number
姓名
 lineItems.name string
数量
 lineItems.quantity number
类型
 lineItems.type string
unitName
 lineItems.unitName string
货币
 lineItems.unitPrice.currency string
grossAmount
 lineItems.unitPrice.grossAmount float
netAmount
 lineItems.unitPrice.netAmount float
taxRatePercentage
 lineItems.unitPrice.taxRatePercentage number
organizationId
 organizationId uuid
注解
 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
货币
 totalPrice.currency string
totalGrossAmount
 totalPrice.totalGrossAmount float
totalNetAmount
 totalPrice.totalNetAmount float
totalTaxAmount
 totalPrice.totalTaxAmount float
updatedDate
 updatedDate date-time
版本
 version integer
voucherDate
 voucherDate date-time
voucherNumber
 voucherNumber string
voucherStatus
 voucherStatus string

检索凭证

操作 ID:
RetrieveVoucher

列出销售凭证（例如发票、信用额度）

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

名称 路径 类型 说明
创建日期
 createdDate date-time
dueDate
 dueDate date-time
files
 files array of string
id
 id uuid
organizationId
 organizationId uuid
注解
 remark string
shippingDate
 shippingDate date-time
taxType
 taxType string
totalGrossAmount
 totalGrossAmount number
totalTaxAmount
 totalTaxAmount number
类型
 type string
updatedDate
 updatedDate date-time
useCollectiveContact
 useCollectiveContact boolean
版本
 version integer
voucherDate
 voucherDate date-time
voucherItems
 voucherItems array of object
量
 voucherItems.amount number
categoryId
 voucherItems.categoryId uuid
taxAmount
 voucherItems.taxAmount number
taxRatePercent
 voucherItems.taxRatePercent number
voucherNumber
 voucherNumber string
voucherStatus
 voucherStatus string

检索发布类别列表

操作 ID:
RetrieveListPostingCategories

此终结点提供对在 lexoffice 中支持的（记帐）凭证收入或费用的发布类别列表的读取访问权限。

返回

response
array of Response_posting-categories_get_items

检索发票

操作 ID:
RetrieveInvoice

返回 ID 值为 {id} 的发票。

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

名称 路径 类型 说明
城市
 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
 id uuid
简介
 introduction string
语言
 language string
lineItems
 lineItems array of object
discountPercentage
 lineItems.discountPercentage number
id
 lineItems.id uuid
lineItemAmount
 lineItems.lineItemAmount number
姓名
 lineItems.name string
数量
 lineItems.quantity number
类型
 lineItems.type string
unitName
 lineItems.unitName string
货币
 lineItems.unitPrice.currency string
grossAmount
 lineItems.unitPrice.grossAmount number
netAmount
 lineItems.unitPrice.netAmount number
taxRatePercentage
 lineItems.unitPrice.taxRatePercentage number
organizationId
 organizationId uuid
discountPercentage
 paymentConditions.paymentDiscountConditions.discountPercentage number
discountRange
 paymentConditions.paymentDiscountConditions.discountRange integer
paymentTermDuration
 paymentConditions.paymentTermDuration integer
paymentTermLabel
 paymentConditions.paymentTermLabel string
paymentTermLabelTemplate
 paymentConditions.paymentTermLabelTemplate string
注解
 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
货币
 totalPrice.currency string
totalGrossAmount
 totalPrice.totalGrossAmount number
totalNetAmount
 totalPrice.totalNetAmount number
totalTaxAmount
 totalPrice.totalTaxAmount number
updatedDate
 updatedDate date-time
版本
 version integer
voucherDate
 voucherDate date-time
voucherNumber
 voucherNumber string
voucherStatus
 voucherStatus string

检索和筛选凭证列表

操作 ID:
RetrieveAndFilterVoucherlist

获取代金券列表（例如 salesinvoices、salescreditnotes）、发票（包括首付发票）、信用单、订单确认、报价和送货单。

参数

名称 密钥 必需 类型 说明
凭证类型
 voucherType True string

指定代金券类型。
凭证状态
 voucherStatus True string

指定凭证状态。
已存档
 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

指定排序。

返回

Body
Response_voucherlist_get

检索国家/地区列表

操作 ID:
RetrieveListCountries

lexoffice 已知的国家/地区列表。

返回

response
array of Response_countries_get_default

检索定期模板

操作 ID:
RetrieveRecurringTemplate

返回 ID 值为 {id} 的定期模板。

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

名称 路径 类型 说明
城市
 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
 id uuid
简介
 introduction string
语言
 language string
lineItems
 lineItems array of object
discountPercentage
 lineItems.discountPercentage number
lineItemAmount
 lineItems.lineItemAmount number
姓名
 lineItems.name string
数量
 lineItems.quantity number
类型
 lineItems.type string
unitName
 lineItems.unitName string
货币
 lineItems.unitPrice.currency string
grossAmount
 lineItems.unitPrice.grossAmount number
netAmount
 lineItems.unitPrice.netAmount number
taxRatePercentage
 lineItems.unitPrice.taxRatePercentage number
organizationId
 organizationId uuid
paymentTermDuration
 paymentConditions.paymentTermDuration integer
paymentTermLabel
 paymentConditions.paymentTermLabel string
paymentTermLabelTemplate
 paymentConditions.paymentTermLabelTemplate string
recurringTemplateSettings
 recurringTemplateSettings object
注解
 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
货币
 totalPrice.currency string
totalGrossAmount
 totalPrice.totalGrossAmount number
totalNetAmount
 totalPrice.totalNetAmount number
totalTaxAmount
 totalPrice.totalTaxAmount number
updatedDate
 updatedDate date-time
版本
 version integer

检索引号

操作 ID:
RetrieveQuotation

返回 ID 值为 {id} 的引号。 呈现报价文档 （PDF）

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

名称 路径 类型 说明
城市
 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
 id uuid
简介
 introduction string
语言
 language string
lineItems
 lineItems array of object
替代方法
 lineItems.alternative boolean
discountPercentage
 lineItems.discountPercentage number
id
 lineItems.id uuid
lineItemAmount
 lineItems.lineItemAmount number
姓名
 lineItems.name string
optional
 lineItems.optional boolean
数量
 lineItems.quantity number
subItems
 lineItems.subItems array of object
替代方法
 lineItems.subItems.alternative boolean
discountPercentage
 lineItems.subItems.discountPercentage number
id
 lineItems.subItems.id uuid
lineItemAmount
 lineItems.subItems.lineItemAmount number
姓名
 lineItems.subItems.name string
optional
 lineItems.subItems.optional boolean
数量
 lineItems.subItems.quantity number
类型
 lineItems.subItems.type string
unitName
 lineItems.subItems.unitName string
货币
 lineItems.subItems.unitPrice.currency string
grossAmount
 lineItems.subItems.unitPrice.grossAmount number
netAmount
 lineItems.subItems.unitPrice.netAmount number
taxRatePercentage
 lineItems.subItems.unitPrice.taxRatePercentage number
类型
 lineItems.type string
unitName
 lineItems.unitName string
货币
 lineItems.unitPrice.currency string
grossAmount
 lineItems.unitPrice.grossAmount number
netAmount
 lineItems.unitPrice.netAmount number
taxRatePercentage
 lineItems.unitPrice.taxRatePercentage number
organizationId
 organizationId uuid
discountPercentage
 paymentConditions.paymentDiscountConditions.discountPercentage number
discountRange
 paymentConditions.paymentDiscountConditions.discountRange integer
paymentTermDuration
 paymentConditions.paymentTermDuration integer
paymentTermLabel
 paymentConditions.paymentTermLabel string
paymentTermLabelTemplate
 paymentConditions.paymentTermLabelTemplate string
注解
 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
货币
 totalPrice.currency string
totalGrossAmount
 totalPrice.totalGrossAmount number
totalNetAmount
 totalPrice.totalNetAmount number
totalTaxAmount
 totalPrice.totalTaxAmount number
updatedDate
 updatedDate date-time
版本
 version integer
voucherDate
 voucherDate date-time
voucherNumber
 voucherNumber string
voucherStatus
 voucherStatus string

检索所有事件订阅

操作 ID:
RetrieveAllEventSubscriptions

检索所有事件订阅

返回

Body
Response_event-subscriptions_get

检索所有定期模板

操作 ID:
RetrieveAllRecurringTemplates

检索定期模板的集合。 结果仅返回引用的联系人（仅 ID 和姓名）、总价格、付款条件和完整的定期模板设置的一部分相关数据。 不过，对象的命名和属性是相同的。

参数

名称 密钥 必需 类型 说明
页
 page integer

指定页面。
尺寸
 size integer

指定大小。
排序
 sort string

指定排序。

返回

Body
Response_recurring-templates_get

检索所有联系人

操作 ID:
RetrieveAllContacts

检索所有联系人

参数

名称 密钥 必需 类型 说明
编号
 number integer

指定数字。
Email
 email string

指定电子邮件。
Name
 name string

指定名称。
供应商
 vendor boolean

指定供应商。
客户
 customer boolean

指定客户。
页
 page integer

指定页面。
尺寸
 size integer

指定大小。
排序
 sort string

指定排序。

返回

Body
Response_contacts_get

检索扣篮

操作 ID:
RetrieveDunning

返回 ID 值为 {id} 的扣篮。

参数

名称 密钥 必需 类型 说明
邓宁西德
 dunningsid True string

指定 dunningsid。

返回

名称 路径 类型 说明
城市
 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
 id uuid
简介
 introduction string
语言
 language string
lineItems
 lineItems array of object
discountPercentage
 lineItems.discountPercentage number
lineItemAmount
 lineItems.lineItemAmount number
姓名
 lineItems.name string
数量
 lineItems.quantity number
类型
 lineItems.type string
unitName
 lineItems.unitName string
货币
 lineItems.unitPrice.currency string
grossAmount
 lineItems.unitPrice.grossAmount number
netAmount
 lineItems.unitPrice.netAmount number
taxRatePercentage
 lineItems.unitPrice.taxRatePercentage number
organizationId
 organizationId uuid
relatedVouchers
 relatedVouchers array of object
id
 relatedVouchers.id uuid
voucherNumber
 relatedVouchers.voucherNumber string
voucherType
 relatedVouchers.voucherType string
注解
 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
货币
 totalPrice.currency string
totalGrossAmount
 totalPrice.totalGrossAmount number
totalNetAmount
 totalPrice.totalNetAmount number
totalTaxAmount
 totalPrice.totalTaxAmount number
updatedDate
 updatedDate date-time
版本
 version integer
voucherDate
 voucherDate date-time
voucherStatus
 voucherStatus string

检索联系人

操作 ID:
RetrieveContact

按 ID 检索联系人

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

名称 路径 类型 说明
存档
 archived boolean
id
 id string
organizationId
 organizationId string
firstName
 person.firstName string
lastName
 person.lastName string
称呼
 person.salutation string
数字
 roles.customer.number integer
版本
 version integer

检索订单确认

操作 ID:
RetrieveOrderConfirmation

返回 ID 值为 {id} 的订单确认。

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

名称 路径 类型 说明
城市
 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
 deliveryTerms string
documentFileId
 files.documentFileId uuid
id
 id uuid
简介
 introduction string
语言
 language string
lineItems
 lineItems array of object
discountPercentage
 lineItems.discountPercentage number
id
 lineItems.id uuid
lineItemAmount
 lineItems.lineItemAmount number
姓名
 lineItems.name string
数量
 lineItems.quantity number
类型
 lineItems.type string
unitName
 lineItems.unitName string
货币
 lineItems.unitPrice.currency string
grossAmount
 lineItems.unitPrice.grossAmount number
netAmount
 lineItems.unitPrice.netAmount number
taxRatePercentage
 lineItems.unitPrice.taxRatePercentage number
organizationId
 organizationId uuid
discountPercentage
 paymentConditions.paymentDiscountConditions.discountPercentage number
discountRange
 paymentConditions.paymentDiscountConditions.discountRange integer
paymentTermDuration
 paymentConditions.paymentTermDuration integer
paymentTermLabel
 paymentConditions.paymentTermLabel string
paymentTermLabelTemplate
 paymentConditions.paymentTermLabelTemplate string
注解
 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
货币
 totalPrice.currency string
totalGrossAmount
 totalPrice.totalGrossAmount number
totalNetAmount
 totalPrice.totalNetAmount number
totalTaxAmount
 totalPrice.totalTaxAmount number
updatedDate
 updatedDate date-time
版本
 version integer
voucherDate
 voucherDate date-time
voucherNumber
 voucherNumber string
voucherStatus
 voucherStatus string

检索送达说明

操作 ID:
RetrieveDeliveryNote

返回 ID 值为 {id} 的传递说明。

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

名称 路径 类型 说明
城市
 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
 deliveryTerms string
id
 id uuid
简介
 introduction string
语言
 language string
lineItems
 lineItems array of object
姓名
 lineItems.name string
数量
 lineItems.quantity number
类型
 lineItems.type string
unitName
 lineItems.unitName string
货币
 lineItems.unitPrice.currency string
grossAmount
 lineItems.unitPrice.grossAmount number
netAmount
 lineItems.unitPrice.netAmount number
taxRatePercentage
 lineItems.unitPrice.taxRatePercentage number
organizationId
 organizationId uuid
注解
 remark string
taxType
 taxConditions.taxType string
title
 title string
updatedDate
 updatedDate date-time
版本
 version integer
voucherDate
 voucherDate date-time
voucherNumber
 voucherNumber string
voucherStatus
 voucherStatus string

检索配置文件信息

操作 ID:
RetrieveProfileInformation

以下示例演示如何检索基本配置文件信息。 在发送请求之前，需要替换占位符 {accessToken} 。

返回

Body
Response_profile_get

检索项目

操作 ID:
RetrieveAnArticle

返回 ID 值为 {id} 的文章。

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

名称 路径 类型 说明
articleNumber
 articleNumber string
gtin
 gtin string
id
 id string
注意
 note string
grossPrice
 price.grossPrice float
leadingPrice
 price.leadingPrice string
netPrice
 price.netPrice float
taxRate
 price.taxRate float
title
 title string
类型
 type string
unitName
 unitName string
版本
 version integer

检索首付发票

操作 ID:
RetrieveDownPaymentInvoice

返回 ID 值为 {id} 的首付发票。

参数

名称 密钥 必需 类型 说明
Id
 id True string

指定 ID。

返回

名称 路径 类型 说明
城市
 address.city string
countryCode
 address.countryCode string
姓名
 address.name string
街道
 address.street string
补充
 address.supplement string
压缩包
 address.zip string
存档
 archived boolean
closingInvoiceId
 closingInvoiceId uuid
创建日期
 createdDate date-time
dueDate
 dueDate date-time
documentFileId
 files.documentFileId uuid
id
 id uuid
简介
 introduction string
语言
 language string
lineItems
 lineItems array of object
lineItemAmount
 lineItems.lineItemAmount number
姓名
 lineItems.name string
数量
 lineItems.quantity number
类型
 lineItems.type string
货币
 lineItems.unitPrice.currency string
grossAmount
 lineItems.unitPrice.grossAmount number
netAmount
 lineItems.unitPrice.netAmount number
taxRatePercentage
 lineItems.unitPrice.taxRatePercentage number
organizationId
 organizationId uuid
discountPercentage
 paymentConditions.paymentDiscountConditions.discountPercentage number
discountRange
 paymentConditions.paymentDiscountConditions.discountRange integer
paymentTermDuration
 paymentConditions.paymentTermDuration integer
paymentTermLabel
 paymentConditions.paymentTermLabel string
paymentTermLabelTemplate
 paymentConditions.paymentTermLabelTemplate string
注解
 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
货币
 totalPrice.currency string
totalGrossAmount
 totalPrice.totalGrossAmount number
totalNetAmount
 totalPrice.totalNetAmount number
totalTaxAmount
 totalPrice.totalTaxAmount number
updatedDate
 updatedDate date-time
版本
 version integer
voucherDate
 voucherDate date-time
voucherNumber
 voucherNumber string
voucherStatus
 voucherStatus string

筛选文章

操作 ID:
FilteringArticles

返回满足筛选器filter_1 filter_n使用分页机制的条件的项目。 如果给定了多个筛选器，则逻辑连接器为 AND。 未设置的筛选器将被忽略。 若要查看此终结点的最大页面大小，请参阅“资源分页”。

参数

名称 密钥 必需 类型 说明
项目编号
 articleNumber string

指定项目编号。
Gtin
 gtin string

指定 gtin。
类型
 type string

指定类型。
页
 page integer

指定页面。
尺寸
 size integer

指定大小。
排序
 sort string

指定排序。

返回

Body
Response_articles_get

触发器

选择自定义触发器

为联系人终结点注册新触发器

选择自定义触发器

操作 ID:
EventSubscription_Lexoffice

为联系人终结点注册新触发器

参数

名称 密钥 必需 类型 说明
事件类型
 eventType True string

eventType

返回

名称 路径 类型 说明
eventDate
 eventDate string

eventDate
eventType
 eventType string

eventType
organizationId
 organizationId string

organizationId
resourceId
 resourceId string

resourceId

定义

EventSubscriptionResponse

名称 路径 类型 说明
订阅编号
 subscriptionId string
eventType
 eventType string
organizationId
 organizationId string
创建日期
 createdDate date-time
回调网址
 callbackUrl string

Response_articles_get

名称 路径 类型 说明
内容
 content array of object

内容
articleNumber
 content.articleNumber string

articleNumber
gtin
 content.gtin string

gtin
id
 content.id string

id
注意
 content.note string

注意
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
类型
 content.type string

类型
unitName
 content.unitName string

unitName
版本
 content.version integer

版本
第一
 first boolean

第一
last
 last boolean

last
数字
 number integer

数字
numberOfElements
 numberOfElements integer

numberOfElements
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
 totalElements integer

totalElements
totalPages
 totalPages integer

totalPages

Response_articles_id_get

名称 路径 类型 说明
articleNumber
 articleNumber string

articleNumber
gtin
 gtin string

gtin
id
 id string

id
注意
 note string

注意
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 string

类型
unitName
 unitName string

unitName
版本
 version integer

版本

Response_articles_post

名称 路径 类型 说明
创建日期
 createdDate string

创建日期
id
 id string

id
resourceUri
 resourceUri string

resourceUri
updatedDate
 updatedDate string

updatedDate
版本
 version integer

版本

Response_contacts_get

名称 路径 类型 说明
内容
 content array of object

内容
账单
 content.addresses.billing array of object

账单
城市
 content.addresses.billing.city string

城市
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

航运
城市
 content.addresses.shipping.city string

城市
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

存档
allowTaxFreeInvoices
 content.company.allowTaxFreeInvoices boolean

allowTaxFreeInvoices
contactPersons
 content.company.contactPersons array of object

contactPersons
电子邮件地址
 content.company.contactPersons.emailAddress string

电子邮件地址
firstName
 content.company.contactPersons.firstName string

firstName
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

业务
office
 content.emailAddresses.office array of string

office
other
 content.emailAddresses.other array of string

other
id
 content.id string

id
注意
 content.note string

注意
organizationId
 content.organizationId string

organizationId
业务
 content.phoneNumbers.business array of string

业务
fax
 content.phoneNumbers.fax array of string

fax
office
 content.phoneNumbers.office array of string

office
other
 content.phoneNumbers.other array of string

other
数字
 content.roles.customer.number integer

数字
数字
 content.roles.vendor.number integer

数字
版本
 content.version integer

版本
第一
 first boolean

第一
last
 last boolean

last
数字
 number integer

数字
numberOfElements
 numberOfElements integer

numberOfElements
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
 totalElements integer

totalElements
totalPages
 totalPages integer

totalPages

Response_contacts_post

名称 路径 类型 说明
创建日期
 createdDate string

创建日期
id
 id string

id
resourceUri
 resourceUri string

resourceUri
updatedDate
 updatedDate string

updatedDate
版本
 version integer

版本

Response_countries_get_default

名称 路径 类型 说明
countryCode
 countryCode string

countryCode
countryNameDE
 countryNameDE string

countryNameDE
countryNameEN
 countryNameEN string

countryNameEN
taxClassification
 taxClassification string

taxClassification

Response_credit-notes_post

名称 路径 类型 说明
创建日期
 createdDate string

创建日期
id
 id string

id
resourceUri
 resourceUri string

resourceUri
updatedDate
 updatedDate string

updatedDate
版本
 version integer

版本

Response_delivery-notes_post

名称 路径 类型 说明
创建日期
 createdDate string

创建日期
id
 id string

id
resourceUri
 resourceUri string

resourceUri
updatedDate
 updatedDate string

updatedDate
版本
 version integer

版本

Response_dunnings_post

名称 路径 类型 说明
创建日期
 createdDate string

创建日期
id
 id string

id
resourceUri
 resourceUri string

resourceUri
updatedDate
 updatedDate string

updatedDate
版本
 version integer

版本

Response_event-subscriptions_get

名称 路径 类型 说明
内容
 content array of object

内容
回调网址
 content.callbackUrl string

回调网址
创建日期
 content.createdDate string

创建日期
eventType
 content.eventType string

eventType
organizationId
 content.organizationId string

organizationId
订阅编号
 content.subscriptionId string

订阅编号

Response_files_post

名称 路径 类型 说明
id
 id string

id

Response_invoices_post

名称 路径 类型 说明
创建日期
 createdDate string

创建日期
id
 id string

id
resourceUri
 resourceUri string

resourceUri
updatedDate
 updatedDate string

updatedDate
版本
 version integer

版本

Response_order-confirmations_post

名称 路径 类型 说明
创建日期
 createdDate string

创建日期
id
 id string

id
resourceUri
 resourceUri string

resourceUri
updatedDate
 updatedDate string

updatedDate
版本
 version integer

版本

Response_payment-conditions_get_items

名称 路径 类型 说明
id
 id string

id
organizationDefault
 organizationDefault boolean

organizationDefault
discountPercentage
 paymentDiscountConditions.discountPercentage integer

discountPercentage
discountRange
 paymentDiscountConditions.discountRange integer

discountRange
paymentTermDuration
 paymentTermDuration integer

paymentTermDuration
paymentTermLabelTemplate
 paymentTermLabelTemplate string

paymentTermLabelTemplate

Response_posting-categories_get_items

名称 路径 类型 说明
contactRequired
 contactRequired boolean

contactRequired
groupName
 groupName string

groupName
id
 id string

id
姓名
 name string

姓名
splitAllowed
 splitAllowed boolean

splitAllowed
类型
 type string

类型

Response_profile_get

名称 路径 类型 说明
businessFeatures
 businessFeatures array of string

businessFeatures
companyName
 companyName string

companyName
connectionId
 connectionId string

connectionId
date
 created.date string

date
userEmail
 created.userEmail string

userEmail
userId
 created.userId string

userId
用户名
 created.userName string

用户名
features
 features array of string

features
organizationId
 organizationId string

organizationId
smallBusiness
 smallBusiness boolean

smallBusiness
subscriptionStatus 订阅状态
 subscriptionStatus string

subscriptionStatus 订阅状态
taxType
 taxType string

taxType

Response_quotations_post

名称 路径 类型 说明
创建日期
 createdDate string

创建日期
id
 id string

id
resourceUri
 resourceUri string

resourceUri
updatedDate
 updatedDate string

updatedDate
版本
 version integer

版本

Response_recurring templates_get

名称 路径 类型 说明
内容
 content array of object

内容
contactId
 content.address.contactId string

contactId
姓名
 content.address.name string

姓名
创建日期
 content.createdDate string

创建日期
id
 content.id string

id
organizationId
 content.organizationId string

organizationId
discountPercentage
 content.paymentConditions.paymentDiscountConditions.discountPercentage integer

discountPercentage
discountRange
 content.paymentConditions.paymentDiscountConditions.discountRange integer

discountRange
paymentTermDuration
 content.paymentConditions.paymentTermDuration integer

paymentTermDuration
paymentTermLabel
 content.paymentConditions.paymentTermLabel string

paymentTermLabel
paymentTermLabelTemplate
 content.paymentConditions.paymentTermLabelTemplate string

paymentTermLabelTemplate
结束日期
 content.recurringTemplateSettings.endDate string

结束日期
executionInterval
 content.recurringTemplateSettings.executionInterval string

executionInterval
executionStatus
 content.recurringTemplateSettings.executionStatus string

executionStatus
完成
 content.recurringTemplateSettings.finalize boolean

完成
id
 content.recurringTemplateSettings.id string

id
lastExecutionFailed
 content.recurringTemplateSettings.lastExecutionFailed boolean

lastExecutionFailed
nextExecutionDate
 content.recurringTemplateSettings.nextExecutionDate string

nextExecutionDate
shippingType
 content.recurringTemplateSettings.shippingType string

shippingType
startDate
 content.recurringTemplateSettings.startDate string

startDate
title
 content.title string

title
货币
 content.totalPrice.currency string

货币
totalGrossAmount
 content.totalPrice.totalGrossAmount integer

totalGrossAmount
totalNetAmount
 content.totalPrice.totalNetAmount float

totalNetAmount
updatedDate
 content.updatedDate string

updatedDate
第一
 first boolean

第一
last
 last boolean

last
数字
 number integer

数字
numberOfElements
 numberOfElements integer

numberOfElements
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
 totalElements integer

totalElements
totalPages
 totalPages integer

totalPages

Response_voucherlist_get

名称 路径 类型 说明
内容
 content array of object

内容
存档
 content.archived boolean

存档
contactId
 content.contactId string

contactId
联系人名称
 content.contactName string

联系人名称
创建日期
 content.createdDate string

创建日期
货币
 content.currency string

货币
dueDate
 content.dueDate string

dueDate
id
 content.id string

id
openAmount
 content.openAmount float

openAmount
totalAmount
 content.totalAmount float

totalAmount
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
第一
 first boolean

第一
last
 last boolean

last
数字
 number integer

数字
numberOfElements
 numberOfElements integer

numberOfElements
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
 totalElements integer

totalElements
totalPages
 totalPages integer

totalPages

Response_vouchers_post

名称 路径 类型 说明
创建日期
 createdDate string

创建日期
id
 id string

id
resourceUri
 resourceUri string

resourceUri
updatedDate
 updatedDate string

updatedDate
版本
 version integer

版本

Response_contacts_id_put

名称 路径 类型 说明
存档
 archived boolean
id
 id uuid
organizationId
 organizationId uuid
firstName
 person.firstName string
lastName
 person.lastName string
称呼
 person.salutation string
数字
 roles.customer.number integer
版本
 version integer

Response_vouchers_id_put

名称 路径 类型 说明
创建日期
 createdDate date-time
dueDate
 dueDate date-time
files
 files array of object
items
 files object
id
 id uuid
organizationId
 organizationId uuid
注解
 remark string
shippingDate
 shippingDate date-time
taxType
 taxType string
totalGrossAmount
 totalGrossAmount number
totalTaxAmount
 totalTaxAmount number
类型
 type string
updatedDate
 updatedDate date-time
useCollectiveContact
 useCollectiveContact boolean
版本
 version integer
voucherDate
 voucherDate date-time
voucherItems
 voucherItems array of object
量
 voucherItems.amount number
categoryId
 voucherItems.categoryId uuid
taxAmount
 voucherItems.taxAmount number
taxRatePercent
 voucherItems.taxRatePercent number
voucherNumber
 voucherNumber string
voucherStatus
 voucherStatus string

文件

这是基本数据类型“file”。