次の方法で共有

Lexoffice (独立した発行元) (プレビュー)

Lexware API は、記事、連絡先、請求書、注文、ファイル管理などの主要な Lexware ビジネス機能へのプログラムによるアクセスを提供します。 この独立したパブリッシャー コネクタにより、Lexware の REST API との安全な統合が可能になり、ユーザーはビジネス データの作成と取得、プロセスの自動化、Lexware リソースと Power Platform アプリケーションの接続を行うことができます。 コネクタは、セキュリティで保護された認証と API ガイドラインに OAuth 2.0 承認コード フローを使用します。

このコネクタは、次の製品および地域で利用可能です:

サービス クラス リージョン
コピロット スタジオ Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - Azure Government リージョン
     - Azure China リージョン
     - 米国国防総省 (DoD)
Power Apps Premium 次を除くすべての Power Apps リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
Power Automate（パワーオートメート） Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
お問い合わせ
名前 LowCode の調査担当者のサポート
URL https://lowcode-investigator.com/
Email kontakt@lowcodeinvestigator.com
コネクタ メタデータ
パブリッシャー LowCodeInvestigator
Web サイト 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 Apps → パブリック 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 が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ Description 必須
API キー securestring この API の API キー 正しい

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

Event-Subscription を削除する

トリガー WebHook の削除
すべてのイベント サブスクリプションを取得する

すべてのイベント サブスクリプションを取得する
すべての定期的なテンプレートを取得する

定期的なテンプレートのコレクションを取得します。 結果は、参照先の連絡先 (ID と名前のみ)、合計価格、支払条件、完全な定期的なテンプレート設定である最も関連性の高いデータの一部のみを返します。 ただし、オブジェクトとプロパティの名前は同じです。
すべての連絡先を取得する

すべての連絡先を取得する
アーティクルを作成する

この記事の内容は、要求の本文でアプリケーション/json として想定されます。
アーティクルを削除する

ID 値 {id} のアーティクルを削除します。 成功した場合は 204、ID が存在しない場合は 404 を返します。
アーティクルを取得する

ID 値 {id} のアーティクルを返します。
アーティクルを更新する

ペイロードに JSON として指定されたデータを使用して、ID {id} の既存のアーティクルを更新します。 成功した場合のアクションの結果を返します。
イベント サブスクリプションを取得する

イベント サブスクリプションを取得する
クレジット ノート ドキュメントのレンダリング (PDF)

クレジット ノート ドキュメントの PDF ファイルをダウンロードするには、その documentFileId が必要です。 この ID は、通常、クレジット ノート リソースによって返されます。 ただし、API を介して開いている状態で新しく作成されたクレジット ノートは、PDF ドキュメント ファイルのレンダリングを個別にトリガーする必要があります。 これは、このエンドポイントで実行できます。
クレジット ノートを作成する

API 経由で送信されるクレジット ノートは、既定で下書きモードで作成されます。 状態が表示された最終クレジット ノートを作成するには、オプションのクエリ パラメーター finalize を設定する必要があります。 クレジット ノートの状態は、API を使用して変更することはできません
クレジット ノートを取得する

このエンドポイントは、クレジット ノートへの読み取りと書き込みアクセスを提供し、ドキュメントをダウンロードするために PDF としてレンダリングすることもできます。 クレジット ノートは、下書きとして作成することも、オープン モードで確定することもできます。
ファイルをアップロードする

このエンドポイントを使用して、伝票や請求書などのファイルをアップロードします。
ファイルをダウンロードする

このエンドポイントを使用してファイルをダウンロードします。
ファイルを受講券にアップロードする

{id} で識別される伝票にファイル (pdf または画像) をアップロードして割り当てます。
プロファイル情報の取得

次の例は、基本的なプロファイル情報を取得する方法を示しています。 要求を送信する前に、プレースホルダー {accessToken} を置き換える必要があります。
前受金請求書を取得する

ID 値 {id} の前受金請求書を返します。
受講券を作成する

バウチャーの作成 (販売伝票に限定)
受講券を取得する

販売伝票 (請求書、クレジットノーツなど) を一覧表示する
受講券リストを取得してフィルター処理する

伝票一覧 (ブックキーピング) 伝票 (salesinvoices、salescreditnotes など)、請求書 (前受金請求書を含む)、与信票、注文確認、見積書、および出荷伝票を取得します。
国の一覧を取得する

lexoffice に知られている国の一覧。
定期的なテンプレートを取得する

ID 値 {id} を持つ定期的なテンプレートを返します。
支払い情報を取得する

支払いエンドポイントは、請求書やクレジット ノートを含む、(ブックキーピングまたは販売) 伝票の支払状態への読み取りアクセスを提供します。
支払条件の一覧を取得する

次の例は、現在構成されている支払条件の一覧を取得する方法を示しています。 要求を送信する前に、プレースホルダー {accessToken} を置き換える必要があります。
更新プログラムの受講券

受講券を更新する
注文確認の作成

このエンドポイントは、注文確認への読み取りと書き込みアクセスを提供し、ドキュメントをダウンロードするために PDF としてレンダリングすることもできます。 注文確認は常に下書きモードで作成され、確定する必要はありません。
注文確認を取得する

ID 値 {id} で注文確認を返します。
注文確認ドキュメントのレンダリング (PDF)

注文確認ドキュメントの PDF ファイルをダウンロードするには、その documentFileId が必要です。 この ID は通常、注文確認リソースによって返されます。 ただし、API を使用して新しく作成された注文確認では、PDF ドキュメント ファイルのレンダリングを個別にトリガーする必要があります。 これは、このエンドポイントで実行できます。
督促を作成する

作成された督促は lexoffice のメイン伝票一覧には表示されませんが、請求書に添付され、そこで表示されます。 作成された督促へのアクセスを顧客に提供するには、ディープリンク機能を使用してください。
督促を取得する

ID 値 {id} のダンニングを返します。
督促状のレンダリング (PDF)

督促伝票の PDF ファイルをダウンロードするには、その documentFileId が必要です。 この ID は通常、督促リソースによって返されます。 ただし、API を使用して新しく作成された督促は、PDF ドキュメント ファイルのレンダリングを個別にトリガーする必要があります。 これは、このエンドポイントで実行できます。
見積もりを作成する

API 経由で送信される見積もりは、既定で下書きモードで作成されます。 状態を含む最終見積もりを作成するには、オプションのクエリ パラメーター finalize を設定する必要があります。 API を使用して見積もりの状態を変更することはできません。
見積もりを取得する

ID 値 {id} の引用符を返します。 見積もりドキュメントのレンダリング (PDF)
見積もりドキュメントのレンダリング (PDF)

見積もりドキュメントの pdf ファイルをダウンロードするには、その documentFileId が必要です。 この ID は通常、見積もりリソースによって返されます。 ただし、API を介して開いている状態で新しく作成された見積もりは、PDF ドキュメント ファイルのレンダリングを個別にトリガーする必要があります。 これは、このエンドポイントで実行できます。
記事のフィルター処理

ページング メカニズムを使用してfilter_nにfilter_1フィルターによって指定された条件を満たすアーティクルを返します。 複数のフィルターが指定されている場合、論理コネクタは AND になります。 設定されていないフィルターは無視されます。 このエンドポイントの最大ページ サイズを確認するには、「リソースのページング」を参照してください。
請求書を作成する

API 経由で送信される請求書は、既定で下書きモードで作成されます。 状態が表示された最終請求書を作成するには、オプションのクエリ パラメーター finalize を設定する必要があります。 API を使用して請求書の状態を変更することはできません。
請求書を取得する

ID 値 {id} の請求書を返します。
請求書ドキュメントのレンダリング (PDF)

請求書ドキュメントの pdf ファイルをダウンロードするには、その documentFileId が必要です。 この ID は通常、請求書リソースによって返されます。 ただし、API を介して開いている状態で新しく作成された請求書は、PDF ドキュメント ファイルのレンダリングを個別にトリガーする必要があります。 これは、このエンドポイントで実行できます。
転記カテゴリの一覧を取得する

このエンドポイントは、lexoffice でサポートされている (ブックキーピング) 伝票の収益または経費の転記カテゴリの一覧への読み取りアクセスを提供します。
連絡先を作成する

新しい連絡先を作成する
連絡先を取得する

ID で連絡先を取得する
連絡先を更新する

連絡先を更新する
配信ノート ドキュメントをレンダリングする (PDF)

このエンドポイントは、配信ノートへの読み取りと書き込みアクセスを提供し、ドキュメントをダウンロードするために PDF としてレンダリングすることもできます。 配信ノートは常に下書きモードで作成され、確定する必要はありません。
配信ノートを作成する

作成された配送伝票は、lexoffice のメイン伝票一覧に表示されます。 API 経由で送信される配信ノートは、下書きモードでのみ作成されます。
配信ノートを取得する

ID 値 {id} の配信メモを返します。

Event-Subscription を削除する

操作 ID:
DeleteEventSubscription

トリガー WebHook の削除

パラメーター

名前 キー 必須 型 説明
サブスクリプション ID
 subscriptionId True string

サブスクリプション ID を指定します。

すべてのイベント サブスクリプションを取得する

操作 ID:
RetrieveAllEventSubscriptions

すべてのイベント サブスクリプションを取得する

戻り値

Body
Response_event-subscriptions_get

すべての定期的なテンプレートを取得する

操作 ID:
RetrieveAllRecurringTemplates

定期的なテンプレートのコレクションを取得します。 結果は、参照先の連絡先 (ID と名前のみ)、合計価格、支払条件、完全な定期的なテンプレート設定である最も関連性の高いデータの一部のみを返します。 ただし、オブジェクトとプロパティの名前は同じです。

パラメーター

名前 キー 必須 型 説明
ページ
 page integer

ページを指定します。
サイズ
 size integer

サイズを指定します。
ソート
 sort string

並べ替えを指定します。

戻り値

Body
Response_recurring-templates_get

すべての連絡先を取得する

操作 ID:
RetrieveAllContacts

すべての連絡先を取得する

パラメーター

名前 キー 必須 型 説明
Number
 number integer

番号を指定します。
Email
 email string

電子メールを指定します。
名前
 name string

名前を指定します。
売り手
 vendor boolean

ベンダーを指定します。
カスタマー
 customer boolean

顧客を指定します。
ページ
 page integer

ページを指定します。
サイズ
 size integer

サイズを指定します。
ソート
 sort string

並べ替えを指定します。

戻り値

Body
Response_contacts_get

アーティクルを作成する

操作 ID:
CreateArticle

この記事の内容は、要求の本文でアプリケーション/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

アーティクルを削除する

操作 ID:
DeleteAnArticle

ID 値 {id} のアーティクルを削除します。 成功した場合は 204、ID が存在しない場合は 404 を返します。

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。

アーティクルを取得する

操作 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:
UpdateAnArticle

ペイロードに JSON として指定されたデータを使用して、ID {id} の既存のアーティクルを更新します。 成功した場合のアクションの結果を返します。

パラメーター

名前 キー 必須 型 説明
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:
RetrieveAEventSubscription

イベント サブスクリプションを取得する

パラメーター

名前 キー 必須 型 説明
サブスクリプション ID
 subscriptionId True string

サブスクリプション ID を指定します。

戻り値

Body
EventSubscriptionResponse

クレジット ノート ドキュメントのレンダリング (PDF)

操作 ID:
RenderCreditNoteDocument

クレジット ノート ドキュメントの PDF ファイルをダウンロードするには、その documentFileId が必要です。 この ID は、通常、クレジット ノート リソースによって返されます。 ただし、API を介して開いている状態で新しく作成されたクレジット ノートは、PDF ドキュメント ファイルのレンダリングを個別にトリガーする必要があります。 これは、このエンドポイントで実行できます。

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。

戻り値

名前 パス 型 説明
documentFileId
 documentFileId uuid

クレジット ノートを作成する

操作 ID:
CreateCreditNote

API 経由で送信されるクレジット ノートは、既定で下書きモードで作成されます。 状態が表示された最終クレジット ノートを作成するには、オプションのクエリ パラメーター finalize を設定する必要があります。 クレジット ノートの状態は、API を使用して変更することはできません

パラメーター

名前 キー 必須 型 説明
先行する販売伝票 ID
 precedingSalesVoucherId string

前の販売伝票 ID を指定します。
最終決定
 finalize True boolean

最終処理を指定します。

戻り値

Body
Response_credit-notes_post

クレジット ノートを取得する

操作 ID:
RetrieveCreditNote

このエンドポイントは、クレジット ノートへの読み取りと書き込みアクセスを提供し、ドキュメントをダウンロードするために PDF としてレンダリングすることもできます。 クレジット ノートは、下書きとして作成することも、オープン モードで確定することもできます。

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。

戻り値

名前 パス 型 説明
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
 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:
UploadFile_Lexoffice

このエンドポイントを使用して、伝票や請求書などのファイルをアップロードします。

パラメーター

名前 キー 必須 型 説明
File
 file True file

アップロードするファイル。
タイプ
 type True string

ファイルの内容の説明。

戻り値

Body
Response_files_post

ファイルをダウンロードする

操作 ID:
DownloadFile_Lexoffice

このエンドポイントを使用してファイルをダウンロードします。

パラメーター

名前 キー 必須 型 説明
ファイル ID
 fileId True string

ファイル ID を指定します。
同意する
 Accept string

承諾を指定します。

戻り値

response
file

ファイルを受講券にアップロードする

操作 ID:
UploadFileVoucher_Lexoffice

{id} で識別される伝票にファイル (pdf または画像) をアップロードして割り当てます。

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。
File
 file True file

アップロードするファイル。

プロファイル情報の取得

操作 ID:
RetrieveProfileInformation

次の例は、基本的なプロファイル情報を取得する方法を示しています。 要求を送信する前に、プレースホルダー {accessToken} を置き換える必要があります。

戻り値

Body
Response_profile_get

前受金請求書を取得する

操作 ID:
RetrieveDownPaymentInvoice

ID 値 {id} の前受金請求書を返します。

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。

戻り値

名前 パス 型 説明
city
 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:
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:
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:
RetrieveAndFilterVoucherlist

伝票一覧 (ブックキーピング) 伝票 (salesinvoices、salescreditnotes など)、請求書 (前受金請求書を含む)、与信票、注文確認、見積書、および出荷伝票を取得します。

パラメーター

名前 キー 必須 型 説明
伝票の種類
 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

並べ替えを指定します。

戻り値

Body
Response_voucherlist_get

国の一覧を取得する

操作 ID:
RetrieveListCountries

lexoffice に知られている国の一覧。

戻り値

response
array of Response_countries_get_default

定期的なテンプレートを取得する

操作 ID:
RetrieveRecurringTemplate

ID 値 {id} を持つ定期的なテンプレートを返します。

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。

戻り値

名前 パス 型 説明
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
 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:
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
postDate
 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:
UpdateVoucher

受講券を更新する

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。
contactId
 contactId string
dueDate
 dueDate date
files
 files array of string

省略 fileId の一覧
注釈
 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:
CreateOrderConfirmation

このエンドポイントは、注文確認への読み取りと書き込みアクセスを提供し、ドキュメントをダウンロードするために PDF としてレンダリングすることもできます。 注文確認は常に下書きモードで作成され、確定する必要はありません。

パラメーター

名前 キー 必須 型 説明
先行する販売伝票 ID
 precedingSalesVoucherId string

前の販売伝票 ID を指定します。

戻り値

Body
Response_order-confirmations_post

注文確認を取得する

操作 ID:
RetrieveOrderConfirmation

ID 値 {id} で注文確認を返します。

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。

戻り値

名前 パス 型 説明
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
 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

注文確認ドキュメントのレンダリング (PDF)

操作 ID:
RenderOrderConfirmationDocument

注文確認ドキュメントの PDF ファイルをダウンロードするには、その documentFileId が必要です。 この ID は通常、注文確認リソースによって返されます。 ただし、API を使用して新しく作成された注文確認では、PDF ドキュメント ファイルのレンダリングを個別にトリガーする必要があります。 これは、このエンドポイントで実行できます。

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。

戻り値

名前 パス 型 説明
documentFileId
 documentFileId uuid

督促を作成する

操作 ID:
CreateDunning

作成された督促は lexoffice のメイン伝票一覧には表示されませんが、請求書に添付され、そこで表示されます。 作成された督促へのアクセスを顧客に提供するには、ディープリンク機能を使用してください。

パラメーター

名前 キー 必須 型 説明
先行する販売伝票 ID
 precedingSalesVoucherId string

前の販売伝票 ID を指定します。

戻り値

Body
Response_dunnings_post

督促を取得する

操作 ID:
RetrieveDunning

ID 値 {id} のダンニングを返します。

パラメーター

名前 キー 必須 型 説明
Dunningsid
 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
 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

督促状のレンダリング (PDF)

操作 ID:
RenderDunningDocument

督促伝票の PDF ファイルをダウンロードするには、その documentFileId が必要です。 この ID は通常、督促リソースによって返されます。 ただし、API を使用して新しく作成された督促は、PDF ドキュメント ファイルのレンダリングを個別にトリガーする必要があります。 これは、このエンドポイントで実行できます。

パラメーター

名前 キー 必須 型 説明
Dunningsid
 dunningsid True string

dunningsid を指定します。

戻り値

名前 パス 型 説明
documentFileId
 documentFileId uuid

見積もりを作成する

操作 ID:
CreateQuotation

API 経由で送信される見積もりは、既定で下書きモードで作成されます。 状態を含む最終見積もりを作成するには、オプションのクエリ パラメーター finalize を設定する必要があります。 API を使用して見積もりの状態を変更することはできません。

パラメーター

名前 キー 必須 型 説明
最終決定
 finalize True boolean

最終処理を指定します。

戻り値

Body
Response_quotations_post

見積もりを取得する

操作 ID:
RetrieveQuotation

ID 値 {id} の引用符を返します。 見積もりドキュメントのレンダリング (PDF)

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。

戻り値

名前 パス 型 説明
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
 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
任意
 lineItems.optional boolean
量
 lineItems.quantity number
サブアイテム
 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
任意
 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

見積もりドキュメントのレンダリング (PDF)

操作 ID:
RenderQuotationDocument

見積もりドキュメントの pdf ファイルをダウンロードするには、その documentFileId が必要です。 この ID は通常、見積もりリソースによって返されます。 ただし、API を介して開いている状態で新しく作成された見積もりは、PDF ドキュメント ファイルのレンダリングを個別にトリガーする必要があります。 これは、このエンドポイントで実行できます。

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。

戻り値

名前 パス 型 説明
documentFileId
 documentFileId uuid

記事のフィルター処理

操作 ID:
FilteringArticles

ページング メカニズムを使用してfilter_nにfilter_1フィルターによって指定された条件を満たすアーティクルを返します。 複数のフィルターが指定されている場合、論理コネクタは AND になります。 設定されていないフィルターは無視されます。 このエンドポイントの最大ページ サイズを確認するには、「リソースのページング」を参照してください。

パラメーター

名前 キー 必須 型 説明
アーティクル番号
 articleNumber string

アーティクル番号を指定します。
Gtin
 gtin string

gtin を指定します。
タイプ
 type string

型を指定します。
ページ
 page integer

ページを指定します。
サイズ
 size integer

サイズを指定します。
ソート
 sort string

並べ替えを指定します。

戻り値

Body
Response_articles_get

請求書を作成する

操作 ID:
CreateInvoice

API 経由で送信される請求書は、既定で下書きモードで作成されます。 状態が表示された最終請求書を作成するには、オプションのクエリ パラメーター finalize を設定する必要があります。 API を使用して請求書の状態を変更することはできません。

パラメーター

名前 キー 必須 型 説明
先行する販売伝票 ID
 precedingSalesVoucherId string

前の販売伝票 ID を指定します。
最終決定
 finalize True boolean

最終処理を指定します。

戻り値

Body
Response_invoices_post

請求書を取得する

操作 ID:
RetrieveInvoice

ID 値 {id} の請求書を返します。

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。

戻り値

名前 パス 型 説明
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
 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

請求書ドキュメントのレンダリング (PDF)

操作 ID:
RenderInvoiceDocument

請求書ドキュメントの pdf ファイルをダウンロードするには、その documentFileId が必要です。 この ID は通常、請求書リソースによって返されます。 ただし、API を介して開いている状態で新しく作成された請求書は、PDF ドキュメント ファイルのレンダリングを個別にトリガーする必要があります。 これは、このエンドポイントで実行できます。

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。

戻り値

名前 パス 型 説明
documentFileId
 documentFileId uuid

転記カテゴリの一覧を取得する

操作 ID:
RetrieveListPostingCategories

このエンドポイントは、lexoffice でサポートされている (ブックキーピング) 伝票の収益または経費の転記カテゴリの一覧への読み取りアクセスを提供します。

戻り値

response
array of Response_posting-categories_get_items

連絡先を作成する

操作 ID:
CreateContact

新しい連絡先を作成する

戻り値

Body
Response_contacts_post

連絡先を取得する

操作 ID:
RetrieveContact

ID で連絡先を取得する

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。

戻り値

名前 パス 型 説明
アーカイブ
 archived boolean
id
 id string
organizationId
 organizationId string
ファーストネーム
 person.firstName string
苗字
 person.lastName string
挨拶
 person.salutation string
数値
 roles.customer.number integer
バージョン
 version integer

連絡先を更新する

操作 ID:
UpdateContact

連絡先を更新する

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。

戻り値

Body
Response_contacts_id_put

配信ノート ドキュメントをレンダリングする (PDF)

操作 ID:
RenderDeliveryNoteDocument

このエンドポイントは、配信ノートへの読み取りと書き込みアクセスを提供し、ドキュメントをダウンロードするために PDF としてレンダリングすることもできます。 配信ノートは常に下書きモードで作成され、確定する必要はありません。

パラメーター

名前 キー 必須 型 説明
配信に関するメモ
 DeliveryNoteid True string

配信メモ ID を指定します。

戻り値

名前 パス 型 説明
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
 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

配信ノートを作成する

操作 ID:
CreateDeliveryNote

作成された配送伝票は、lexoffice のメイン伝票一覧に表示されます。 API 経由で送信される配信ノートは、下書きモードでのみ作成されます。

パラメーター

名前 キー 必須 型 説明
先行する販売伝票 ID
 precedingSalesVoucherId string

前の販売伝票 ID を指定します。

戻り値

Body
Response_delivery-notes_post

配信ノートを取得する

操作 ID:
RetrieveDeliveryNote

ID 値 {id} の配信メモを返します。

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ID を指定します。

戻り値

名前 パス 型 説明
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
 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:
EventSubscription_Lexoffice

連絡先エンドポイントの新しいトリガーを登録する

パラメーター

名前 キー 必須 型 説明
イベントの種類
 eventType True string

eventType

戻り値

名前 パス 型 説明
eventDate
 eventDate string

eventDate
eventType
 eventType string

eventType
organizationId
 organizationId string

organizationId
resourceId
 resourceId string

resourceId

定義

EventSubscriptionResponse

名前 パス 型 説明
subscriptionId
 subscriptionId string
eventType
 eventType string
organizationId
 organizationId string
作成日
 createdDate date-time
コールバックURL
 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
 first boolean

first
last
 last boolean

last
数値
 number integer

数値
numberOfElements
 numberOfElements integer

numberOfElements
size
 size integer

size
並べ替え
 sort array of object

並べ替え
昇順
 sort.ascending boolean

昇順
方向
 sort.direction string

方向
無視ケース
 sort.ignoreCase boolean

無視ケース
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

請求先
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

アーカイブ
allowTaxFreeInvoices
 content.company.allowTaxFreeInvoices boolean

allowTaxFreeInvoices
contactPersons
 content.company.contactPersons array of object

contactPersons
メールアドレス
 content.company.contactPersons.emailAddress string

メールアドレス
ファーストネーム
 content.company.contactPersons.firstName string

ファーストネーム
苗字
 content.company.contactPersons.lastName string

苗字
主要な
 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
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
オフィス
 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
 numberOfElements integer

numberOfElements
size
 size integer

size
並べ替え
 sort array of object

並べ替え
昇順
 sort.ascending boolean

昇順
方向
 sort.direction string

方向
無視ケース
 sort.ignoreCase boolean

無視ケース
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

コンテンツ
コールバックURL
 content.callbackUrl string

コールバックURL
作成日
 content.createdDate string

作成日
eventType
 content.eventType string

eventType
organizationId
 content.organizationId string

organizationId
subscriptionId
 content.subscriptionId string

subscriptionId

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
Finalize
 content.recurringTemplateSettings.finalize boolean

Finalize
id
 content.recurringTemplateSettings.id string

id
lastExecutionFailed
 content.recurringTemplateSettings.lastExecutionFailed boolean

lastExecutionFailed
nextExecutionDate
 content.recurringTemplateSettings.nextExecutionDate string

nextExecutionDate
shippingType
 content.recurringTemplateSettings.shippingType string

shippingType
startDate
 content.recurringTemplateSettings.startDate string

startDate
title
 content.title string

title
通貨
 content.totalPrice.currency string

通貨
totalGrossAmount
 content.totalPrice.totalGrossAmount integer

totalGrossAmount
totalNetAmount
 content.totalPrice.totalNetAmount float

totalNetAmount
updatedDate
 content.updatedDate string

updatedDate
first
 first boolean

first
last
 last boolean

last
数値
 number integer

数値
numberOfElements
 numberOfElements integer

numberOfElements
size
 size integer

size
並べ替え
 sort array of object

並べ替え
昇順
 sort.ascending boolean

昇順
方向
 sort.direction string

方向
無視ケース
 sort.ignoreCase boolean

無視ケース
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
合計金額
 content.totalAmount float

合計金額
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
 first boolean

first
last
 last boolean

last
数値
 number integer

数値
numberOfElements
 numberOfElements integer

numberOfElements
size
 size integer

size
並べ替え
 sort array of object

並べ替え
昇順
 sort.ascending boolean

昇順
方向
 sort.direction string

方向
無視ケース
 sort.ignoreCase boolean

無視ケース
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
ファーストネーム
 person.firstName string
苗字
 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' です。