Zuora Connector 6.0 リファレンス | MuleSoft ドキュメント

設定

名前	型	説明	デフォルト値	必須
Name (名前)	String (文字列)	この設定の名前。コネクタはこの名前の設定を参照します。		x
Connection (接続)	Basic Auth Connection Provider (基本認証接続プロバイダー) Oauth2 Connection Provider (OAuth2 接続プロバイダー)	この設定に指定する接続型。		x
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。	1
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。	MINUTES
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。	AUTO
Name (名前)	String (文字列)	他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。		x
Expiration Policy (有効期限ポリシー)	Expiration Policy (有効期限ポリシー)	動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。必要に応じて、Runtime がインスタンスをパージします。

名前

型

説明

デフォルト値

必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

Basic Auth Connection Provider (基本認証接続プロバイダー)
Oauth2 Connection Provider (OAuth2 接続プロバイダー)

この設定に指定する接続型。

x

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

1

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

MINUTES

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

AUTO

Name (名前)

String (文字列)

他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。

x

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。必要に応じて、Runtime がインスタンスをパージします。

接続種別

Basic Auth Connection Provider (基本認証接続プロバイダー)

ユーザー名とパスワードを使用して接続します。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値
Default Headers (デフォルトヘッダー)	Default Header (デフォルトヘッダー) の配列
Query Parameters (クエリパラメーター)	Default Query Param (デフォルトクエリパラメーター) の配列
Connection Timeout (接続タイムアウト)	Number (数値)	リモートサービスへの接続を確立するためのタイムアウト。	30
Connection Timeout Unit (接続タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	[Connection Timeout (接続タイムアウト)] の時間単位。	SECONDS
Use Persistent Connections (永続接続を使用)	Boolean (ブール)	false の場合、各接続は最初の要求が完了すると終了します。	true
Max Connections (最大接続数)	Number (数値)	同時に開いておくことができるアウトバウンド接続の最大数。	-1
Connection Idle Timeout (接続アイドルタイムアウト)	Number (数値)	接続が終了するまでのアイドル状態を維持できる時間のタイムアウト。	30
Connection Idle Timeout Unit (接続アイドルタイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	[Connection Idle Timeout (接続アイドルタイムアウト)] の時間単位。	SECONDS
Proxy Config (プロキシ設定)	Proxy (プロキシ)	プロキシ経由のアウトバウンド接続の再利用可能な設定要素。
Stream Response (応答のストリーミング)	Boolean (ブール)	受信した応答ストリーミングするかどうか。	false
Response Buffer Size (応答バッファサイズ)	Number (数値)	HTTP 応答が保存されるバッファの領域 (バイト)。	-1
Username (ユーザー名)	String (文字列)	要求を認証するためのユーザー名。
Password (パスワード)	String (文字列)	要求を認証するためのパスワード。
Base Uri (ベース URI)	String (文字列)	パラメーターベース URI。各インスタンスまたはテナントは独自のベース URI を取得します。	`https://rest.apisandbox.zuora.com:443`
TLS Configuration (TLS 設定)	TLS
Reconnection (再接続)	Reconnection (再接続)	アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Default Headers (デフォルトヘッダー)

Default Header (デフォルトヘッダー) の配列

Query Parameters (クエリパラメーター)

Default Query Param (デフォルトクエリパラメーター) の配列

Connection Timeout (接続タイムアウト)

Number (数値)

リモートサービスへの接続を確立するためのタイムアウト。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

[Connection Timeout (接続タイムアウト)] の時間単位。

SECONDS

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

false の場合、各接続は最初の要求が完了すると終了します。

true

Max Connections (最大接続数)

Number (数値)

同時に開いておくことができるアウトバウンド接続の最大数。

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

接続が終了するまでのアイドル状態を維持できる時間のタイムアウト。

30

Connection Idle Timeout Unit (接続アイドルタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

[Connection Idle Timeout (接続アイドルタイムアウト)] の時間単位。

SECONDS

Proxy Config (プロキシ設定)

Proxy (プロキシ)

プロキシ経由のアウトバウンド接続の再利用可能な設定要素。

Stream Response (応答のストリーミング)

Boolean (ブール)

受信した応答ストリーミングするかどうか。

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファの領域 (バイト)。

-1

Username (ユーザー名)

String (文字列)

要求を認証するためのユーザー名。

Password (パスワード)

String (文字列)

要求を認証するためのパスワード。

Base Uri (ベース URI)

String (文字列)

パラメーターベース URI。各インスタンスまたはテナントは独自のベース URI を取得します。

https://rest.apisandbox.zuora.com:443

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Oauth2 Connection Provider (OAuth2 接続プロバイダー)

OAuth 2.0 を使用して、ユーザーアカウントをホストするサービスにユーザー認証を委任します。詳細は、「コネクタの OAuth 2.0 の設定」または「CloudHub でのコネクタの OAuth 2.0 の設定」を参照してください。

クライアントログイン情報許可種別を使用して、クライアント ID、クライアントシークレット、トークン URL を使用して接続します。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Default Headers (デフォルトヘッダー)	Default Header (デフォルトヘッダー) の配列
Query Parameters (クエリパラメーター)	Default Query Param (デフォルトクエリパラメーター) の配列
Connection Timeout (接続タイムアウト)	Number (数値)	リモートサービスへの接続を確立するためのタイムアウト。	30
Connection Timeout Unit (接続タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	[Connection Timeout (接続タイムアウト)] の時間単位。	SECONDS
Use Persistent Connections (永続接続を使用)	Boolean (ブール)	false の場合、各接続は最初の要求が完了すると終了します。	true
Max Connections (最大接続数)	Number (数値)	同時に開いておくことができるアウトバウンド接続の最大数。	-1
Connection Idle Timeout (接続アイドルタイムアウト)	Number (数値)	接続が終了するまでのアイドル状態を維持できる時間のタイムアウト。	30
Connection Idle Timeout Unit (接続アイドルタイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	[Connection Idle Timeout (接続アイドルタイムアウト)] の時間単位。	SECONDS
Proxy Config (プロキシ設定)	Proxy (プロキシ)	プロキシ経由のアウトバウンド接続の再利用可能な設定要素。
Stream Response (応答のストリーミング)	Boolean (ブール)	受信した応答ストリーミングするかどうか。	false
Response Buffer Size (応答バッファサイズ)	Number (数値)	HTTP 応答が保存されるバッファの領域 (バイト)。	-1
Base Uri (ベース URI)	String (文字列)	パラメーターのベース URI。各インスタンスまたはテナントが独自のベース URI を取得します。	`https://rest.apisandbox.zuora.com:443`
TLS Configuration (TLS 設定)	TLS
Reconnection (再接続)	Reconnection (再接続)	アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。
Client ID (クライアント ID)	String (文字列)	サービスプロバイダーに登録されている OAuth クライアント ID。		x
Client Secret (クライアントシークレット)	String (文字列)	サービスプロバイダーに登録されている OAuth クライアントシークレット。		x
Token Url (トークン URL)	String (文字列)	サービスプロバイダーのトークンエンドポイント URL。	`https://rest.apisandbox.zuora.com/oauth/token`
Scopes (スコープ)	String (文字列)	OAuth ダンス時に要求する OAuth スコープ。スコープを指定しないと、アノテーションのスコープが使用されます。
Object Store (オブジェクトストア)	String (文字列)	各リソースオーナー ID のデータの保存に使用するオブジェクトストアへの参照。オブジェクトストアを指定しない場合、Mule では自動的にデフォルトのオブジェクトストアがプロビジョニングされます。

Default Headers (デフォルトヘッダー)

Default Header (デフォルトヘッダー) の配列

Query Parameters (クエリパラメーター)

Default Query Param (デフォルトクエリパラメーター) の配列

Connection Timeout (接続タイムアウト)

Number (数値)

リモートサービスへの接続を確立するためのタイムアウト。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

[Connection Timeout (接続タイムアウト)] の時間単位。

SECONDS

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

false の場合、各接続は最初の要求が完了すると終了します。

true

Max Connections (最大接続数)

Number (数値)

同時に開いておくことができるアウトバウンド接続の最大数。

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

接続が終了するまでのアイドル状態を維持できる時間のタイムアウト。

30

Connection Idle Timeout Unit (接続アイドルタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

[Connection Idle Timeout (接続アイドルタイムアウト)] の時間単位。

SECONDS

Proxy Config (プロキシ設定)

Proxy (プロキシ)

プロキシ経由のアウトバウンド接続の再利用可能な設定要素。

Stream Response (応答のストリーミング)

Boolean (ブール)

受信した応答ストリーミングするかどうか。

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファの領域 (バイト)。

-1

Base Uri (ベース URI)

String (文字列)

パラメーターのベース URI。各インスタンスまたはテナントが独自のベース URI を取得します。

https://rest.apisandbox.zuora.com:443

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Client ID (クライアント ID)

String (文字列)

サービスプロバイダーに登録されている OAuth クライアント ID。

x

Client Secret (クライアントシークレット)

String (文字列)

サービスプロバイダーに登録されている OAuth クライアントシークレット。

x

Token Url (トークン URL)

String (文字列)

サービスプロバイダーのトークンエンドポイント URL。

`https://rest.apisandbox.zuora.com/oauth/token`

Scopes (スコープ)

String (文字列)

OAuth ダンス時に要求する OAuth スコープ。スコープを指定しないと、アノテーションのスコープが使用されます。

Object Store (オブジェクトストア)

String (文字列)

各リソースオーナー ID のデータの保存に使用するオブジェクトストアへの参照。オブジェクトストアを指定しない場合、Mule では自動的にデフォルトのオブジェクトストアがプロビジョニングされます。

サポートされている操作

Create an Event Trigger
Create an Email Template
Create a notification definition
Generate an OAuth Token
Update or Delete Custom Object Records as a Batch
Create Custom Object Definition
Update Custom Object Definition
Create Custom Object Records
Submit Data Query
Submit Multiple Settings Requests as a Batch
Create Accounting Code
Create Accounting Period
Create Account
Create Job to Hard Delete Billing Document Files
Generate Billing Documents by Account
Amend
Create
Delete
Execute
Generate
Query
Query More
Subscribe
Update
Create Order Asynchronously
Preview Order Asynchronously
Add Attachments
Email Billing Documents Generated From Bill Run
Create Billing Preview Run
Perform Mass Action
Multi-entity: Share a Product With an Entity
Establish Connection to Zuora REST API Service
Create Credit Memo from Charge
Email Credit Memo
Upload File for Credit Memo
Create Credit Memo PDF
Refund Credit Memo
Create Taxation Items for Credit Memo
Create Debit Memo from Charge
Email Debit Memo
Upload File for Debit Memo
Create Debit Memo PDF
Create Taxation Items for Debit Memo
Create Document Properties
Multi-entity: Create entity
Multi-entity: Initiate Connection
Reverse Payment
Reject Payment
Settle Payment
Return HMAC signatures
Create Credit Memo from Invoice
Create debit memo from invoice
Email Invoice
Upload File for Invoice
Create Summary Journal Entry
Create Journal Run
CRUD: Create Account
CRUD: Create Bill Run
CRUD: Create Contact
CRUD: Create CreditBalanceAdjustment
CRUD: Create Export
Object POSTFeature
CRUD: Create Import
CRUD: Create InvoiceAdjustment
CRUD: Create InvoicePayment
CRUD: Create payment
CRUD: Create Payment Method
CRUD: Create Product
CRUD: Create ProductRatePlan
CRUD: Create product rate plan charge
CRUD: Create Refund
CRUD: Create TaxationItem
CRUD: Create UnitOfMeasure
CRUD: Create usage
Create Billing Preview
Invoice and Collect
Create Order
Preview Order
Create Payment Method
Create Authorization
Create Credit Card Payment Method
Create Apple Pay Payment Method
Create Stored Credential Profile
Cancel Stored Credential Profile
Expire Stored Credential Profile
Cancel Authorization
Create Payment Run
Create Payment
Refund Payment
Generate Quotes Document
Create Revenue Schedule for Credit Memo Item (manual distribution)
Create Revenue Schedule for Credit Memo Item (distribute by date range)
Create Revenue Schedule for Debit Memo Item (manual distribution)
Create revenue schedule for debit memo item (distribute by date range)
Create revenue schedule for Invoice Item Adjustment (manual distribution)
Create revenue schedule for Invoice Item Adjustment (distribute by
Create revenue schedule for Invoice Item (manual distribution)
Create Revenue Schedule for Invoice Item (distribute by date range)
Create Revenue Schedule on Subscription Charge
Generate RSA signature
Decrypt RSA signature
Create sequence sets
Create subscription
Preview Subscription
Post usage
Import a workflow
Run a workflow
Remove an event trigger
Delete an email template
Delete a notification definition
Delete custom object definition
Delete custom object record
Cancel data query job
Delete Accounting Code
Delete accounting period
Delete attachments
Delete credit memo
Delete debit memo
Delete document properties
Multi-entity: Delete Entity
Delete summary journal entry
Delete journal run
CRUD: Delete account
CRUD: Delete amendment
CRUD: Delete bill run
CRUD: Delete contact
CRUD: Delete Feature
CRUD: Delete InvoiceAdjustment
CRUD: Delete invoice
CRUD: Delete InvoiceItemAdjustment
CRUD: Delete payment
CRUD: Delete payment method
CRUD: Delete Product
CRUD: Delete ProductFeature
CRUD: Delete ProductRatePlan
CRUD: Delete product rate plan charge
CRUD: Delete refund
CRUD: Delete Subscription
CRUD: Delete TaxationItem
CRUD: Delete UnitOfMeasure
CRUD: Delete usage
Delete Order
Delete payment method
Delete payment run
Delete payment
Delete refund
Delete revenue schedule
Delete sequence set
Delete taxation item
Delete a workflow by ID
Query event triggers
Get an event trigger by ID
Query email templates
Get an email template
Query notification definitions
Get a notification definition
Get all custom object definitions
Get custom object definition
Query custom object records
Get custom object record
Get data query jobs
Get data query job
List all settings
Get all Accounting Codes
Query an Accounting Code
Get all accounting periods
Get accounting period
Get job of hard deleting billing document files
Get account
Get account summary
Get amendments by key
Get amendments by subscription ID
Get job status and response
View attachments
View attachments list
Get billing documents
Get Billing Preview Run
Get mass action result
Get product
Get Product Catalog
Get charge summary details by CRS number
Get charge summary details by charge ID
Get Credit Memos
Get credit memo
Get credit Memo Items
Get credit memo item
Get taxation items of credit memo item
Get credit memo parts
Get credit memo part
Get credit memo part items
Get credit memo part item
Get custom foreign currency exchange rates
Get Debit Memos
Get debit memo application parts
Get Debit Memo
Get Debit Memo Items
Get Debit Memo Item
Get taxation items of debit memo item
Describe object
Get document properties
Multi-entity: Get entities
Multi-entity: Get entity by Id
Multi-entity: Get connections
Get files
Return Hosted Pages
Get invoice application parts
Get invoice files
Get invoice items
Get taxation items of invoice item
Get summary journal entry
Get all summary journal entries in a journal run
Get journal run
Get callout notification histories
Get email notification histories
CRUD: Get account
CRUD: Get amendment
CRUD: Get bill run
CRUD: Retrieve CommunicationProfile
CRUD: Get contact
CRUD: Retrieve CreditBalanceAdjustment
CRUD: Retrieve Export
CRUD: Retrieve Feature
CRUD: Retrieve Import
CRUD: Retrieve InvoiceAdjustment
CRUD: Get invoice
CRUD: Retrieve InvoiceItemAdjustment
CRUD: Retrieve InvoiceItem
CRUD: Retrieve InvoicePayment
CRUD: Retrieve InvoiceSplit
CRUD: Retrieve InvoiceSplitItem
CRUD: Get payment
CRUD: Get payment method
CRUD: Get payment method snapshot
CRUD: Retrieve PaymentMethodTransactionLog
CRUD: Get payment transaction log
CRUD: Retrieve Product
CRUD: Retrieve ProductFeature
CRUD: Retrieve ProductRatePlan
CRUD: Get product rate plan charge
CRUD: Retrieve ProductRatePlanChargeTier
CRUD: Retrieve RatePlan
CRUD: Get rate plan charge
CRUD: Retrieve RatePlanChargeTier
CRUD: Get refund
CRUD: Retrieve RefundInvoicePayment
CRUD: Retrieve RefundTransactionLog
CRUD: Retrieve Subscription
CRUD: Retrieve SubscriptionProductFeature
CRUD: Retrieve TaxationItem
CRUD: Retrieve UnitOfMeasure
CRUD: Get usage
Get all orders
Get an order
Get order metrics for evergreen subscription
Get orders by invoice owner
Get orders by subscription number
Get orders by subscription owner
Get term information for subscription
Get credit card payment methods for account
Get stored credential profiles
Get payment runs
Get payment run
Get payment run summary
Get payment gateways
Get all payments
Get payment
Get payment parts
Get payment part
Get payment part items
Get payment part item
Get product rate plans
Get all refunds
Get refund
Get refund parts
Get refund part
Get refund part items
Get refund part item
Get revenue event details
Get revenue events for a revenue schedule
Get revenue items by charge revenue summary number
Get revenue items by revenue event number
Get revenue items by revenue schedule
Get revenue recognition rule by product rate plan charge
Get revenue recognition rule by subscription charge
Get revenue schedule details
Get revenue schedule by credit memo item ID
Get revenue schedule by debit memo item ID
Get revenue schedule by invoice item adjustment
Get revenue schedule by invoice item ID
Get all revenue schedules of product charge by charge ID and billing
Get revenue schedule by subscription charge
Get sequence sets
Get sequence set
Get the revenue automation start date
Get subscriptions by account
Get subscriptions by key
Get subscriptions by key and version
Get taxation item
Get invoices
Get payments
Get usage
Multi-entity: Get entities that a user can access
Get workflows
Get a workflow by ID
Export a workflow
Get workflow task usage
Get tasks
Get a task by ID
Update individual fields in a custom object record
Update an Event Trigger
Update an email template
Update a notification definition
Update custom object record
Activate accounting code
Update an accounting code
Deactivate accounting code
Update accounting period
Close accounting period
Set accounting period to pending close
Re-open accounting period
Run Trial Balance
Update account
Edit Attachments
Stop Mass Action
Scrub Contact
Apply Credit Memo
Update Credit Memo
Cancel Credit Memo
Post credit memo
Unapply credit memo
Unpost credit memo
PUT Batch Update Debit Memos
Update debit memo
Cancel debit memo
Post debit memo
Unpost debit memo
Update document properties
Multi-entity: Update entity
Multi-entity: Provision entity
Multi-entity: Accept connection
Multi-entity: Deny connection
Multi-entity: Disconnect connection
Update invoices
Update invoice
Reverse invoice
Write off invoice
Update basic information of a summary journal entry
Cancel summary journal entry
Cancel Journal Run
CRUD: Update account
CRUD: Update amendment
CRUD: Post or Cancel bill run
CRUD: Update contact
CRUD: Update CreditBalanceAdjustment
Object PUTFeature
CRUD: Update InvoiceAdjustment
CRUD: Update invoice
CRUD: Update InvoicePayment
CRUD: Update payment
CRUD: Update payment method
CRUD: Update Product
CRUD: Update ProductRatePlan
CRUD: Update product rate plan charge
CRUD: Update ProductRatePlanChargeTier
CRUD: Update rate plan charge
CRUD: Update refund
CRUD: Update Subscription
CRUD: Update TaxationItem
CRUD: Update UnitOfMeasure
CRUD: Update usage
Update order custom fields
Update order action trigger dates
Update credit card payment method
Scrub payment method
Verify payment method
Update payment run
Apply payment
Update payment
Cancel payment
Transfer payment
Unapply payment
Update refund
Cancel refund
Update custom fields on revenue items by revenue event number
Update custom fields on revenue items by revenue schedule number
Update revenue schedule basic information
Distribute revenue across accounting periods
Distribute revenue on specific date
Distribute revenue by recognition start and end dates
PUT Rev Pro Accounting Codes
Update Sequence Set
Update subscription
Cancel Subscription
Update Subscription Custom Fields
Renew subscription
Resume Subscription
Suspend subscription
Update subscription custom fields of a specified subscription version
Update taxation item
Multi-entity: Accept user access
Multi-entity: Deny user access
Multi-entity: Send user access requests
Update tasks in batch

操作

Create an Event Trigger

<mule-zuora-connector:create-events-event-triggers>

次のいずれかのオブジェクトに対してイベントトリガーを定義できます。

Account
AccountingCode
AccountingPeriod
Amendment
BillingRun
Contact
CreditBalanceAdjustment
CreditMemo
CreditMemoApplication
CreditMemoApplicationItem
CreditMemoItem
DebitMemo
DebitMemoItem
Feature
Invoice
InvoiceAdjustment
InvoiceItem
InvoiceItemAdjustment
JournalEntry
JournalEntryItem
Order
OrderAction
Payment
PaymentApplication
PaymentMethod
PaymentPart
Product
ProductFeature
ProductRatePlan
ProductRatePlanCharge
RatePlan
RatePlanCharge
Refund
RefundApplication
RevenueEvent
RevenueEventItem
RevenueSchedule
RevenueScheduleItem
Subscription
SubscriptionProductFeature
TaxationItem
Usage

baseObject 項目では、どのオブジェクトに対してトリガーを定義するかを指定します。condition 項目は、イベントをトリガーするタイミングを指定する JEXL 式です。式には、トリガーの定義の対象となるオブジェクトの項目を含めることができます。

条件には、トリガーの定義の対象となるオブジェクトに結合されているデータソースオブジェクトの項目を含めることはできません。たとえば、次の条件では、1,000 を超える金額の請求書が転記されるたびにイベントがトリガーされます。

changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000

各項目は次のとおりです。

changeType は、Invoice オブジェクトで発生した変更の種別を指定するキーワードです。すべてのオブジェクトで、サポートされる changeType の値は INSERT、UPDATE、DELETE です。
Invoice.Status は、変更が発生した後の Invoice オブジェクトの Status 項目の値です。
Invoice.Status_old は、変更が発生する前の Invoice オブジェクトの Status 項目の値です。上記の例では、baseObject の値は Invoice になります。
作成できるイベントトリガーの数は、使用している Zuora Central Platform のエディションによって異なります。この操作では、/events/event-triggers エンドポイントに HTTP POST 要求を行います。 === パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Authorization (認証)	String (文字列)	有効な OAuth トークンの場合は `Bearer {token}`。		x
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。 Zuora Multi-entity を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、トラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません。コロン (`:`) セミコロン (`;`) 二重引用符 (`"`) 引用符 (`'`)。
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求の送信時にストリーミングを使用するかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。 Zuora Multi-entity を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、トラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません。

コロン (:)
セミコロン (;)
二重引用符 (")
引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求の送信時にストリーミングを使用するかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create an Email Template

<mule-zuora-connector:create-notifications-email-templates>

この操作では、メールテンプレートを作成し、/notifications/email-templates エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Authorization (認証)	String (文字列)	有効な OAuth トークンの場合は `Bearer {token}`。Zuora テナントで通知機能と設定可能イベント機能を有効にした後で、OAuth トークンを再生成する必要があります。これらの機能を有効にする前に生成された OAuth トークンは機能しません。		x
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません。コロン (`:`) セミコロン (`;`) 二重引用符 (`"`) 引用符 (`'`)
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ。	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。Zuora テナントで通知機能と設定可能イベント機能を有効にした後で、OAuth トークンを再生成する必要があります。これらの機能を有効にする前に生成された OAuth トークンは機能しません。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません。

コロン (:)
セミコロン (;)
二重引用符 (")
引用符 (')

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create a notification definition

<mule-zuora-connector:create-notifications-notification-definitions>

通知定義を作成します。絞り込みルールが指定されている場合、そのルールが評価され、実行時に受信イベントを処理する資格が通知定義にあるかどうかが確認されます。資格がある場合、通知はメールを送信し、コールアウトを呼び出します (通知にメールテンプレートまたはコールアウトがある場合)。この操作では、/notifications/notification-definitions エンドポイントに対する HTTP POST 要求を行います

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Authorization (認証)	String (文字列)	有効な OAuth トークンの場合は `Bearer {token}`。Zuora テナントで通知機能と設定可能イベント機能を有効にした後で、OAuth トークンを再生成する必要があります。これらの機能を有効にする前に生成された OAuth トークンは機能しません。		x
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。 Zuora Multi-entity を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。Zuora テナントで通知機能と設定可能イベント機能を有効にした後で、OAuth トークンを再生成する必要があります。これらの機能を有効にする前に生成された OAuth トークンは機能しません。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。 Zuora Multi-entity を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Generate an OAuth Token

<mule-zuora-connector:create-oauth-token>

生成されるベアラートークンを使用して OAuth クライアントを Zuora REST API で認証することができます。OAuth クライアントは、Zuora UI を使用して作成する必要があります。詳細は、「認証」を参照してください。

この操作を使用する場合は、Authorization、apiAccessKeyId、apiSecretAccessKey などの認証ヘッダーを設定しないでください。

この操作を使用して短期間に多数のベアラートークンを生成しないでください。各トークンは、有効期限まで使用してください。この操作を使用しているときに 429 Too Many Requests 応答を受け取った場合、要求の頻度を減らしてください。このエンドポイントには IP アドレスに応じたレート制限があります。レート制限は 100 要求/分です。この操作では、/oauth/token エンドポイントに対する HTTP POST 要求を行います

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、トラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません。コロン (`:`) セミコロン (`;`) 二重引用符 (`"`) 引用符 (`'`)。
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、トラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません。

コロン (:)
セミコロン (;)
二重引用符 (")
引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update or Delete Custom Object Records as a Batch

<mule-zuora-connector:create-objects-batch-default-by-object>

この操作では、カスタムオブジェクトレコードの一括更新または一括削除を実行できます。

この操作では、/objects/batch/default/{object} エンドポイントに HTTP POST 要求を行います。

制限事項

このコールには次の制限事項があります。

1 回のコールで更新できるレコードの最大数は 1,000 です。
1 回のコールで削除できるレコードの最大数は 1,000 です。
レコードに空の文字列を保存することはできません。
null 値は、次の例のように書式設定する必要があります。
{ "records": [ { "fieldName__c": null } ] }

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
object	String (文字列)	カスタムオブジェクトの API 参照名をオブジェクトとして指定します。これは大文字と小文字が区別されます。		x
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Authorization (認証)	String (文字列)	有効な OAuth トークンの場合は `Bearer {token}`。		x
Zuora Version (Zuora バージョン)	String (文字列)	応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで `Zuora-Version` を指定してください。
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

object

String (文字列)

カスタムオブジェクトの API 参照名をオブジェクトとして指定します。これは大文字と小文字が区別されます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Version (Zuora バージョン)

String (文字列)

応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで Zuora-Version を指定してください。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Custom Object Definition

<mule-zuora-connector:create-objects-definitions-default>

この操作では、特定の種別のカスタムオブジェクト定義を投稿できます。[label (表示ラベル)] 項目は、カスタムオブジェクトの UI 表示ラベルです。[object (オブジェクト)] 項目には、カスタムオブジェクトの API 参照名が含まれます。

この操作では、/objects/definitions/default エンドポイントに HTTP POST 要求を行います。

制限事項

カスタムオブジェクト定義には次の制限事項があります。

カスタムオブジェクトの API 参照名 (object) の最大文字数は 64 です。
カスタムオブジェクトの表示ラベル (label) の最大文字数は 64 です。
カスタムオブジェクトの説明の最大文字数は 250 です。
カスタムオブジェクト内のカスタム項目の最大数は 50 です。
カスタム項目の API 参照名の最大文字数は 64 です。
カスタム項目の表示ラベル (label) の最大文字数は 64 です。
カスタム項目の説明の最大文字数は 250 です。
選択リストオプションの最大数は 250 です。
テキスト項目のデフォルトの最大文字数は 512 です。

API を使用してカスタムオブジェクト定義を作成または更新する場合、この最大文字数を 4,096 まで設定できます。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Authorization (認証)	String (文字列)	有効な OAuth トークンの場合は `Bearer {token}`。		x
Zuora Version (Zuora バージョン)	String (文字列)	応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで `Zuora-Version` を指定してください。
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Version (Zuora バージョン)

String (文字列)

応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで Zuora-Version を指定してください。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update Custom Object Definition

<mule-zuora-connector:create-objects-migrations>

この操作では、定義の移行を開始する移行リソースを投稿することで、カスタムオブジェクト定義を更新します。

この操作では、/objects/migrations エンドポイントに HTTP POST 要求を行います。

制限事項

カスタム項目定義の更新には次の制限事項があります。

更新要求あたりのアクションの数は 1 つのみです。
レコードを含むカスタムオブジェクト定義から項目定義を削除することはできません。
新しい必須項目を追加することはできません。
省略可能な項目を必須項目に変更することはできません。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Authorization (認証)	String (文字列)	有効な OAuth トークンの場合は `Bearer {token}`。		x
Zuora Version (Zuora バージョン)	String (文字列)	応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで `Zuora-Version` を指定してください。
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Version (Zuora バージョン)

String (文字列)

応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで Zuora-Version を指定してください。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Custom Object Records

<mule-zuora-connector:create-objects-records-default-by-object>

この操作では、特定の種別のカスタムオブジェクトレコードを作成します。カスタムオブジェクト種別のレコードを作成すると、200 応答で次の情報が提供されます。

正常に処理されて保存されたレコードのリスト。
正常に処理されなかったために保存されなかったレコードのリスト。

この操作では、/objects/records/default/{object} エンドポイントに HTTP POST 要求を行います。

制限事項

このコールには次の制限事項があります。

1 回のコールで作成できるレコードの最大数は 1,000 です。
レコードに空の文字列を保存することはできません。
null 値は、次の例のように書式設定する必要があります。
{ "records": [ { "fieldName__c": null } ] }

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
object	String (文字列)	カスタムオブジェクトの API 参照名をオブジェクトとして指定します。これは大文字と小文字が区別されます。		x
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Authorization (認証)	String (文字列)	有効な OAuth トークンの場合は `Bearer {token}`。		x
Zuora Version (Zuora バージョン)	String (文字列)	応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで `Zuora-Version` を指定してください。
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

object

String (文字列)

カスタムオブジェクトの API 参照名をオブジェクトとして指定します。これは大文字と小文字が区別されます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Version (Zuora バージョン)

String (文字列)

応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで Zuora-Version を指定してください。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Submit Data Query

<mule-zuora-connector:create-query-jobs>

この操作では、Zuora により実行されるデータクエリを送信し、クエリジョブを作成します。

Get Data Query Job を使用して、クエリジョブの状況を追跡し、クエリ結果の URL を取得できます。

この操作では、/query/jobs エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Authorization (認証)	String (文字列)	有効な OAuth トークンの場合は `Bearer {token}`。		x
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Submit Multiple Settings Requests as a Batch

<mule-zuora-connector:create-settings-batch-requests>

この操作では、複数の設定の要求をバッチとして送信します。

この操作では、/settings/batch-requests エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Authorization (認証)	String (文字列)	有効な OAuth トークンの場合は `Bearer {token}`。		x
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Accounting Code

<mule-zuora-connector:create-v1-accounting-codes>

このリファレンスでは、REST API を使用して新しいアカウンティングコードを作成する方法について説明します。アカウンティングコードは作成されるとすぐにアクティブになります。

この操作では、/v1/accounting-codes エンドポイントに HTTP POST 要求を行います。

始める前に

Zuora Finance をテナントで有効にしている場合、Configure Accounting Codes 権限が必要です。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Accounting Period

<mule-zuora-connector:create-v1-accounting-periods>

アカウンティング期間を作成します。

この操作では、/v1/accounting-periods エンドポイントに HTTP POST 要求を行います。

始める前に

Zuora Finance をテナントで有効にしている必要があります。
「アカウンティング期間の作成」ユーザー権限が必要です。

制限事項

テナントの最初のアカウンティング期間を作成する場合、開始日はテナントの最も早いトランザクションの日付以前である必要があります。
アカウンティング期間の開始日と終了日は隣接している必要があります。たとえば、1 つのアカウンティング期間が 1 月 31 日に終了する場合、次の期間は 2 月 1 日に開始する必要があります。
収益認識パッケージがあり、「Monthly recognition over time (毎月の継続的な認識)」収益認識モデルを有効にしている場合、アカウンティング期間の開始日と終了日はそれぞれ月の最初の日と最後の日である必要があります。開始日と終了日は必ずしも同じ月である必要はありません。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Account

<mule-zuora-connector:create-v1-accounts>

この操作では、クレジットカード支払い方法、請求先取引先責任者、および販売先取引先責任者 (省略可能) を使用して顧客アカウントを作成します。要求項目と応答項目の説明、およびサンプルコードが提供されています。

この操作を使用して、必要に応じてサブスクリプションを作成し、そのサブスクリプションの請求書を発行し、デフォルトの支払い方法で支払いを収集することができます。トランザクションはアトミックです。つまり、何らかの理由でいずれかの部分が失敗した場合、トランザクション全体がロールバックされます。

この操作は CORS 対応のため、クライアント側の Javascript を使用してコールを呼び出すことができます。

この操作では、/v1/accounts エンドポイントに HTTP POST 要求を行います。

注意事項

アカウントは、アクティブの状況で作成されます。
要求の autoPay 項目が true に設定されている場合、creditCard 項目または hpmCreditCardPaymentMethodId 項目のいずれか (両方ではない) を指定する必要があります。提供された項目のいずれかがこのアカウントのデフォルトの支払い方法になります。クレジットカード情報が拒否されたか、検証できない場合、アカウントは作成されません。
このコールで作成された顧客アカウントは自動的に [Auto Pay (自動支払い)] に設定されます。
workEmail または personalEmail 項目のいずれかが指定されている場合、アカウントのメール配信プリファレンスは自動的に true に設定されます。この場合、メールは workEmail または personalEmail アドレスに送信されます (それらのアドレスが存在する場合)。どちらの項目も指定されていない場合、メール配信プリファレンスは自動的に false に設定されます。

customerAcceptanceDate と serviceActivationDate のデフォルト。customerAcceptanceDate と serviceActivationDate のデフォルト値は次のように設定されます。

serviceActivationDate(SA) が指定されている

serviceActivationDate (SA) が指定されていない

customerAcceptanceDate (CA) が指定されている

SA は要求コールの値を使用します。CA は要求コールの値を使用します。

CA は要求コールの値を使用します。SA は CE をデフォルトとして使用します。

customerAcceptanceDate (CA) が指定されていない

SA は要求コールの値を使用します。CA は SA をデフォルトとして使用します。

SA と CA は CE をデフォルトとして使用します。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Zuora version (Zuora バージョン)	String (文字列)	Zuora REST API のマイナーバージョン。このパラメーターを設定する必要があるのは、次の項目を使用する場合のみです。* invoice * collect * runBilling * targetDate
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。このパラメーターを設定する必要があるのは、次の項目を使用する場合のみです。* invoice * collect * runBilling * targetDate

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Job to Hard Delete Billing Document Files

<mule-zuora-connector:create-v1-accounts-billing-documents-files-deletion-jobs>

この操作では、特定のアカウントのすべての請求ドキュメント PDF ファイルを完全に削除する非同期ジョブを作成します。削除ジョブが完了すると、すべての請求ドキュメント PDF ファイルが完全に削除されます。

削除ジョブの状況を取得するには、[Get job of hard deleting billing document files](https://www.zuora.com/developer/api-reference/#operation/GET_BillingDocumentFilesDeletionJob) をコールします。

この操作は、請求ユーザー権限「請求ドキュメントファイルの完全削除」が有効になっている場合にのみ使用できます。

この操作では、/v1/accounts/billing-documents/files/deletion-jobs エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Generate Billing Documents by Account

<mule-zuora-connector:create-v1-accounts-billing-documents-generate-by-id>

この操作では、指定したアカウントのドラフトまたは転記済みの請求ドキュメントを生成します。

また、指定したアカウントの指定したサブスクリプションの請求ドキュメントを生成することもできます。請求ドキュメントには請求書とクレジットメモが含まれます。

クレジットメモを生成するには、請求書決済機能を有効にしている必要があります。

キャンセルまたは一時停止されたサブスクリプションの請求ドキュメントを生成することはできません。

この操作では、/v1/accounts/{id}/billing-documents/generate エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
id	String (文字列)	請求ドキュメントが生成される顧客アカウントの ID。例: 8a8082e65b27f6c3015ba3e326b26419。		x
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

請求ドキュメントが生成される顧客アカウントの ID。例: 8a8082e65b27f6c3015ba3e326b26419。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Amend

<mule-zuora-connector:create-v1-action-amend>

この操作では、Amendment オブジェクトを作成することでサブスクリプションを変更します。ただし、サブスクリプションの変更にはこの操作ではなく [Update subscription](https://www.zuora.com/developer/api-reference/#operation/PUT_Subscription) を使用することをお勧めします。

この操作を使用して複数のサブスクリプションを更新することはできません。

この操作を使用して、最大 10 個の Amendment オブジェクトを作成できます。

Amendment オブジェクトごとに次の項目を指定する必要があります。

ContractEffectiveDate
Name
SubscriptionId
各 Amendment オブジェクトの SubscriptionId の値は同じである必要があります。
Type

この操作をコールすると、Zuora はリクエストボディで指定された Amendment オブジェクトの順番でサブスクリプションを変更します。この操作をコールして、Zuora が Amendment オブジェクトを作成できない場合、コール全体が失敗します。

この操作では、/v1/action/amend エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Reject Unknown Fields (不明な項目を拒否)	Boolean	リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。`rejectUnknownFields` を `true` に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は `json { "message": "Error - unrecognized fields" }` です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。	false
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
X Zuora WSDL Version (X Zuora WSDL バージョン)	String (文字列)	Zuora WSDL バージョン番号。	79
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

X Zuora WSDL Version (X Zuora WSDL バージョン)

String (文字列)

Zuora WSDL バージョン番号。

79

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create

<mule-zuora-connector:create-v1-action-create>

create コールを使用して、特定の種別の 1 つ以上のオブジェクトを作成します。

create コールごとに異なる種別を指定できますが、各 create コールは 1 つの種別のオブジェクトにのみ適用される必要があります。

制限事項

このコールには次の制限事項があります。

1 回のコールで最大 50 個のオブジェクトがサポートされます。
請求書決済機能はサポートされていません。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。
アクションのデフォルト WSDL バージョンは 79 です。異なる WSDL バージョンに従ってオブジェクトを作成するには、X-Zuora-WSDL-Version ヘッダーを設定します。
特定のオブジェクトまたは項目がどの WSDL バージョンで導入されたかを確認するには、[「Zuora SOAP API Version History (Zuora SOAP API バージョン履歴)」] (https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History) を参照してください。

このコールの使用方法

create は、1 つ以上の zObject の配列に対してコールできます。create は、各オブジェクトの作成の成功または失敗を示す SaveResult の配列を返します。このコールには次の情報が適用されます。

null の zObject を渡すことはできません。
一度に渡すことができる zObject の数は最大 50 個です。
すべてのオブジェクトの種別は同じである必要があります。

create コールと subscribe コールのどちらでも新しいアカウントが作成されます。ただし、これらのコールには相違点があります。サブスクリプションとは無関係にアカウントを作成するには、create コールを使用します。サブスクリプションと初期支払い情報を使用してアカウントを作成するには、subscribe コールを使用します。

この操作では、/v1/action/create エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Reject Unknown Fields (不明な項目を拒否)	Boolean	リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。`rejectUnknownFields` を `true` に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は `json { "message": "Error - unrecognized fields" }` です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。	false
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
X Zuora WSDL Version (X Zuora WSDL バージョン)	String (文字列)	Zuora WSDL バージョン番号。	79
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

X Zuora WSDL Version (X Zuora WSDL バージョン)

String (文字列)

Zuora WSDL バージョン番号。

79

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete

<mule-zuora-connector:create-v1-action-delete>

同じ種別の 1 つ以上のオブジェクトを削除します。この操作では、/v1/action/delete エンドポイントに HTTP POST 要求を行います。

delete コールごとに異なる種別を指定できますが、各 delete コールは 1 つの種別のオブジェクトにのみ適用される必要があります。

このコールには次の情報が適用されます。

まず、削除するオブジェクトの ID を決定する必要があります。
null の ID を渡すことはできません。
特定の delete コール内のすべてのオブジェクトの種別は同じである必要があります。

コールあたりのオブジェクト数

1 回のコールで 50 個のオブジェクトがサポートされます。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Reject Unknown Fields (不明な項目を拒否)	Boolean	リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。`rejectUnknownFields` を `true` に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は `json { "message": "Error - unrecognized fields" }` です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。	false
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
X Zuora WSDL Version (X Zuora WSDL バージョン)	String (文字列)	Zuora WSDL バージョン番号。	79
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

X Zuora WSDL Version (X Zuora WSDL バージョン)

String (文字列)

Zuora WSDL バージョン番号。

79

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Execute

<mule-zuora-connector:create-v1-action-execute>

execute コールを使用して、1 つの請求書を複数の請求書に分割するプロセスを実行します。元の請求書の状況はドラフトである必要があります。結果の請求書は分割請求書と呼ばれます。

この機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

ドラフト請求書を複数の分割請求書に分割する手順は、次のとおりです。

create コールを使用して、元のドラフト請求書から作成する分割請求書ごとに個別の InvoiceSplitItem オブジェクトを作成します。
create コールを使用して、すべての InvoiceSplitItem オブジェクトを収集するための 1 つの InvoiceSplit オブジェクトを作成します。
execute コールを使用して、ドラフト請求書を複数の分割請求書に分割します。

execute コールを使用する前に、InvoiceSplitItem オブジェクトと InvoiceSplit オブジェクトを作成する必要があります。
サポートされるオブジェクト:

InvoiceSplit
非同期プロセス

この操作では、/v1/action/execute エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Reject Unknown Fields (不明な項目を拒否)	Boolean	リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。`rejectUnknownFields` を `true` に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は `json { "message": "Error - unrecognized fields" }` です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。	false
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
X Zuora WSDL Version (X Zuora WSDL バージョン)	String (文字列)	Zuora WSDL バージョン番号。	79
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

X Zuora WSDL Version (X Zuora WSDL バージョン)

String (文字列)

Zuora WSDL バージョン番号。

79

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Generate

<mule-zuora-connector:create-v1-action-generate>

この操作では、特定の顧客のオンデマンド請求書を生成します。これは、Zuora UI で特定の顧客アカウントのアドホック請求実行を作成する方法に似ています。

サポートされるオブジェクト:

Invoice
非同期プロセス: はい

生成された請求書の ID が応答で返されます。複数の請求書が生成された場合、生成された最初の請求書の ID のみが返されます。これが発生するのは、アカウントに複数のサブスクリプションがあり、[invoice subscription separately (サブスクリプションの個別請求書)](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/B_Creating_Subscriptions/Invoicing_Subscriptions_Separately) オプションが有効になっている場合です。

この操作では、/v1/action/generate エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Reject Unknown Fields (不明な項目を拒否)	Boolean	リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。`rejectUnknownFields` を `true` に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は `json { "message": "Error - unrecognized fields" }` です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。	false
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
X Zuora WSDL Version (X Zuora WSDL バージョン)	String (文字列)	Zuora WSDL バージョン番号。	79
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

X Zuora WSDL Version (X Zuora WSDL バージョン)

String (文字列)

Zuora WSDL バージョン番号。

79

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Query

<mule-zuora-connector:create-v1-action-query>

query コールでは、照会するオブジェクトとそのオブジェクトから取得する項目のほか、特定のオブジェクトを照会する必要があるかどうかを決定する検索条件を指定して、クエリ式を送信します。

Zuora Object Query Language (ZOQL) を使用してこのクエリを作成し、queryString を使用してクエリを渡すことができます。コールが実行されると、API は特定のオブジェクトに対してクエリを実行し、クエリレスポンスオブジェクトをアプリケーションに返します。その後、アプリケーションはクエリレスポンス内の行を反復処理して情報を取得することができます。

この操作では、/v1/action/query エンドポイントに HTTP POST 要求を行います。

制限事項

このコールには次の制限事項があります。

すべての ZOQL キーワードは小文字である必要があります。
返されるレコード数は 2,000 レコードに制限されます。
請求書決済機能はサポートされていません。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。
アクションのデフォルト WSDL バージョンは 79 です。異なる WSDL バージョンに従ってオブジェクトまたは項目を照会するには、X-Zuora-WSDL-Version ヘッダーを設定します。特定のオブジェクトまたは項目がどの WSDL バージョンで導入されたかを確認するには、「Zuora Object Query Language」を参照してください。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Reject Unknown Fields (不明な項目を拒否)	Boolean	リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。`rejectUnknownFields` を `true` に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は `json { "message": "Error - unrecognized fields" }` です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。	false
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
X Zuora WSDL Version (X Zuora WSDL バージョン)	String (文字列)	Zuora WSDL バージョン番号。	79
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

X Zuora WSDL Version (X Zuora WSDL バージョン)

String (文字列)

Zuora WSDL バージョン番号。

79

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Query More

<mule-zuora-connector:create-v1-action-query-more>

queryMore を使用して、前回の query コールからの追加の結果を要求します。最初の query コールで 2,000 件を超える結果が返された場合、queryMore を使用して追加の結果を照会できます。2,000 件を超える queryLocator の結果は、Zuora により 5 日間のみ保存された後、削除されます。

最初の query コールで 2,000 件を超える結果が返された場合、クエリから返された queryLocator を使用して次の結果セットを要求できます。

注意: Zuora は queryMore カーソルを 15 分のアクティビティの後、期限切れにします。queryMore を使用するには、まず query コールを作成する必要があります。デフォルトでは、query コールは最大 2,000 件の結果を返します。結果が 2,000 件を超える場合、クエリは false としてマークされたブール型の done と queryLocator (マーカー) を返します。このマーカーを queryMore に渡して次の結果セットを取得できます。

この操作では、/v1/action/queryMore エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Reject Unknown Fields (不明な項目を拒否)	Boolean	リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。`rejectUnknownFields` を `true` に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は `json { "message": "Error - unrecognized fields" }` です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。	false
Zuora Entity Ids (Zuora エンティティ ID)	String (文字列)	エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。
Zuora Track Id (Zuora トラック ID)	String (文字列)	API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (`:`)、セミコロン (`;`)、二重引用符 (`"`)、引用符 (`'`)。
X Zuora WSDL Version (X Zuora WSDL バージョン)	String (文字列)	Zuora WSDL バージョン番号。	79
Content (コンテンツ)	Binary (バイナリ)	使用するコンテンツ	#[payload]
Config Ref (設定参照)	ConfigurationProvider	このコンポーネントを実行するために使用する設定の名前。
Streaming Strategy (ストリーミング戦略)	Repeatable In Memory Stream (反復可能なメモリ内ストリーム) Repeatable File Store Stream (反復可能なファイルストアストリーム) non-repeatable-stream	ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。
Custom Query Parameters (カスタムクエリパラメーター)	Object (オブジェクト)
Custom Headers (カスタムヘッダー)	Object (オブジェクト)
Response Timeout (応答タイムアウト)	Number (数値)	リモートサービスへの要求のタイムアウト。
Response Timeout Unit (応答タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Response Timeout (応答タイムアウト) の時間単位。
Streaming Type (ストリーミング種別)	Enumeration (列挙)。次のいずれかになります。 AUTO ALWAYS NEVER	要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。
Target Variable (対象変数)	String (文字列)	操作の出力を保存する変数の名前。
Target Value (対象値)	String (文字列)	操作の出力を評価する式。式の結果は対象変数に保存されます。	#[payload]
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

X Zuora WSDL Version (X Zuora WSDL バージョン)

String (文字列)

Zuora WSDL バージョン番号。

79

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Subscribe

<mule-zuora-connector:create-v1-action-subscribe>

このコールでは多くのアクションが実行されます。subscribe コールを使用して、1 つ以上の新しいサブスクリプションの作成に必要な情報をバンドルします。このコールでは SubscribeRequests の配列が使用されます。配列が使用されるため、サブスクリプション要求のバッチを一度に送信できます。

1 回の subscribe コールで最大 50 個の異なるサブスクリプションを作成できます。

これは結合されたコールです。このコールを使用して次のすべてのタスクを 1 回のコールで実行できます。

アカウントを作成する
取引先責任者を作成する
外部の支払いオプションを含む支払方法を作成する
サブスクリプションの請求書を作成する
最初の支払いをサブスクリプションに適用する === オブジェクトの制限

1 回のコールで 50 個のオブジェクトがサポートされます。

Effective Date (発効日)

発効日が未来の日付の場合、請求書は生成されず、請求書番号はありません。

サブスクリプション名とサブスクリプション番号

サブスクリプション名は、サブスクリプションの一意の識別子です。名前の値を指定しない場合、名前は Zuora により自動的に作成されます。自動生成された値はサブスクリプション番号 (A-S00000080 など) と呼ばれます。

サブスクリプションの作成後にサブスクリプション名またはサブスクリプション番号を変更することはできません。

サブスクリプション名: サブスクリプションに設定する名前。
サブスクリプション番号: サブスクリプション名を指定しない場合に Zuora により自動的に生成される値。サブスクリプション名とサブスクリプション番号のどちらも一意である必要があります。一意でない場合、エラーが発生します。

サブスクリプション ID

サブスクリプション ID は、「4028xxxx」形式の 32 桁の ID です。これもサブスクリプションの一意の識別子です。この値はシステムにより自動的に生成され、編集または更新できませんが、照会することはできます。1 つのサブスクリプションは、サブスクリプション名またはサブスクリプション番号を 1 つのみ持つことができますが、ID は複数持つことができます。サブスクリプションの各バージョンで ID は異なります。

Subscription オブジェクトには項目 OriginalId と PreviousSubscriptionId が含まれます。OriginalId は、サブスクリプションの最初のバージョンの ID です。 PreviousSubscriptionId は、現在のバージョンの直前に作成されたバージョンの ID です。

サブスクリプションのプレビュー

subscribe コールで生成された請求書をプレビューできます。

サブスクリプションの個別請求書

サブスクリプションの個別請求書機能を有効にしている場合、subscribe コールにより、IsInvoiceSeparate 項目が true に設定されているすべてのサブスクリプションの請求書がサブスクリプションごとに生成されます。

サブスクリプションの個別請求書機能を無効にしている場合、subscribe コールにより、すべてのサブスクリプションに対して 1 つの請求書が生成されます。詳細は、[「Invoicing Subscriptions Separately (サブスクリプションの個別請求書)」](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/B_Creating_Subscriptions/Invoicing_Subscriptions_Separately) を参照してください。

サブスクリプションおよびドラフト請求書

チャージを含むドラフト請求書が顧客アカウントに存在する場合、subscribe コールを使用して新しいサブスクリプションを作成し、請求書を生成すると、新しいサブスクリプションは既存のドラフト請求書に追加されます。次に、Zuora は請求書を転記します。

サブスクリプションに関連付けられたオブジェクト (アカウント、取引先責任者など) を作成するには、subscribe コールまたは create コールのいずれかを使用できます。これらのコールには違いがありますが、どちらか一方に適した状況があります。

subscribe コールでは、サブスクリプションに必要なすべての情報がバンドルされます。必要なすべての情報がある場合、新しいサブスクリプションを作成するには、subscribe コールを使用します。subscribe コールでは、BillTo、SoldTo、および Account オブジェクトを更新できません。

既存のアカウント ID がコールに含まれる場合、支払い情報オブジェクトを更新できません。このオブジェクトは subscribe コールではサポートされていません。

create コールの使用

段階的な開発を行う場合は create コールが役立ちます。たとえば、最初にアカウントを作成し、その後、取引先責任者などを作成する場合があります。一部の情報を使用できない場合、create コールを使用します。サブスクリプションを作成するには、subscribe コールを呼び出してアカウントをアクティブ化し、ドラフトの状況からアクティブの状況にする必要があります。

この操作では、/v1/action/subscribe エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

X Zuora WSDL Version (X Zuora WSDL バージョン)

String (文字列)

Zuora WSDL バージョン番号。

79

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update

<mule-zuora-connector:create-v1-action-update>

同じ種別の 1 つ以上のオブジェクトの情報を更新します。

update コールごとに異なる種別のオブジェクトを指定できますが、特定の各 update コールは 1 つの種別のオブジェクトにのみ適用される必要があります。

1 つ以上の zObject の配列を更新できます。各オブジェクトの更新の成功または失敗を示す SaveResult の配列を返します。

このコールには次の情報が適用されます。

null の zObject を渡すことはできません。
一度に渡すことができる zObject の数は最大 50 個です。
すべてのオブジェクトの種別は同じである必要があります。
各オブジェクトの項目ごとに、そのオブジェクトの ID を決定する必要があります。次に、更新する項目に新しい情報を入力します。
Zuora は、update コール内で認識されない項目を無視します。
たとえば、省略可能な項目のスペルが誤っていたり、存在しない項目が指定されていたりした場合、Zuora はその項目を無視してコールの処理を続行します。認識されない項目については、エラーメッセージは返されません。

制限事項

このコールには次の制限事項があります。

1 回のコールで最大 50 個のオブジェクトがサポートされます。
請求書決済機能はサポートされていません。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。
アクションのデフォルト WSDL バージョンは 79 です。異なる WSDL バージョンに従ってオブジェクトまたは項目を更新するには、X-Zuora-WSDL-Version ヘッダーを設定します。特定のオブジェクトまたは項目がどの WSDL バージョンで導入されたかを確認するには、[「Zuora SOAP API Version History (Zuora SOAP API バージョン履歴)」] (https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History) を参照してください。

この操作では、/v1/action/update エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

X Zuora WSDL Version (X Zuora WSDL バージョン)

String (文字列)

Zuora WSDL バージョン番号。

79

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Order Asynchronously

<mule-zuora-connector:create-v1-async-orders>

この操作は、注文機能を有効にしている場合にのみ使用できます。この操作は使用制限されています。

通常の「Create Order」操作コールがタイムアウトすることが多い場合は、代わりにこの操作を使用して注文を非同期で作成してください。注文を非同期で作成する場合、ジョブは注文をバックエンドで作成し、ジョブの状況と結果を追跡するためのジョブ ID が返されます。

この操作では、/v1/async/orders エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Return Ids (ID を返す)

Boolean (ブール)

[Get job status and response](https://www.zuora.com/developer/api-reference/#operation/GET_JobStatusAndResponse) 操作で ID を返すかどうかを指定します。このクエリパラメーターを true に設定した場合、対応する ID (この操作で返される数値に関連付けられます) を「Get job status and response」レスポンスボディで返すことができます。

false

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。このパラメーターを設定する必要があるのは、次の項目を使用する場合です。* subscriptions * subscriptionNumbers * subscriptionIds (returnId クエリパラメーターが true に設定されている場合)

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Preview Order Asynchronously

<mule-zuora-connector:create-v1-async-orders-preview>

この操作は、 Zuora 注文機能を有効にしている場合にのみ使用できます。

この操作は使用制限されています。

通常の「Preview Order」操作コールがタイムアウトすることが多い場合は、代わりにこの操作を使用して注文を非同期でプレビューしてください。この操作を使用する場合、ジョブは注文をバックエンドでプレビューするため、ジョブの状況と結果を追跡するためのジョブ ID が返されます。

この操作では、/v1/async/orders/preview エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Add Attachments

<mule-zuora-connector:create-v1-attachments>

Add Attachment REST 要求をマルチパート/フォームデータと共に使用して、ドキュメントファイルをアカウント、サブスクリプション、または請求書に添付します。この操作では、/v1/attachments エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

description (説明)

String (文字列)

添付ファイルドキュメントの説明。

Associated Object Type (関連付けられたオブジェクト型)

String (文字列)

次のいずれかの値を指定: Account (アカウント)、Subscription (サブスクリプション)、Invoice (請求書)。

x

Associated Object Key (関連付けられたオブジェクトキー)

String (文字列)

[Subscription (サブスクリプション)] 型の場合、[Subscription Number (サブスクリプション番号)] を指定する。添付ファイルは [Subscription Number (サブスクリプション番号)] に関連付けられているため、すべてのサブスクリプションバージョンで表示可能です。[Account (アカウント)] および [Invoice (請求書)] の場合、id を指定します。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

File Content (ファイルのコンテンツ)

String (文字列)

「File」部分のコンテンツ。

#[payload]

File Filename (ファイルのファイル名)

String (文字列)

「File」部分のファイル名 (ファイル名のみ、パスを含まない)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Email Billing Documents Generated From Bill Run

<mule-zuora-connector:create-v1-bill-runs-emails-by-bill-run-id>

指定した請求実行から生成されたすべての請求ドキュメントを顧客に手動でメール送信します。請求実行では、請求書およびクレジットメモの生成ルールに基づいて請求書とクレジットメモを生成できます。クレジットメモは、請求書決済機能を有効にしている場合にのみ使用できます。この API 操作を使用すると、メールテンプレートの [To Email (メールの送信先)] 項目で指定したメールアドレスに請求ドキュメントが送信されます。各請求ドキュメントで使用するメールテンプレートは、Zuora UI から [Edit notification (通知を編集)] ダイアログの [Delivery Options (配信オプション)] パネルで設定します。メールテンプレートの [To Email (メールの送信先)] 項目の編集方法についての詳細は、「Edit Email Templates (メールテンプレートの編集)」を参照してください。

注意事項

リクエストボディに項目は不要ですが、要求には {} を指定する必要があります。指定しない場合、エラーが返されます。
転記済み請求ドキュメントのみをメール送信できます。
請求書とクレジットメモをメール送信する前に、次の通知をアクティブ化する必要があります。+ [Manual Email For Invoice (請求書の手動メール)] | [Manual Email For Invoice - Email Credit Memo (請求書の手動メール - クレジットメモをメール送信)] | [Manually email Credit Memo (クレジットメモを手動でメール送信)]
請求書 PDF をメールに含めるには、Zuora UI から [Edit notification (通知を編集)] ダイアログで [Include Invoice PDF (請求書 PDF を含める)] チェックボックスをオンにします。クレジットメモ PDF をメールに含めるには、Zuora UI から [Edit notification (通知を編集)] ダイアログで [Include Credit Memo PDF (クレジットメモ PDF を含める)] チェックボックスをオンにします。詳細は、[「Create and Edit Notifications (通知の作成と編集)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) を参照してください。
Zuora は、設定されたメールテンプレートに基づいてメールメッセージを送信します。
使用するメールテンプレートは、Zuora UI から [Edit notification (通知を編集)] ダイアログの [Delivery Options (配信オプション)] パネルで設定できます。デフォルトでは、請求ドキュメントでは次のテンプレートが使用されます。
- 請求書: Invoice Posted Default Email Template (転記済み請求書のデフォルトメールテンプレート)
- クレジットメモ: Manual Email for Credit Memo Default Template (クレジットメモの手動メールのデフォルトテンプレート)
  詳細は、[「Create and Edit Email Templates (メールテンプレートの作成と編集)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information を参照してください。

この操作では、/v1/bill-runs/{billRunId}/emails エンドポイントに対する HTTP POST 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Bill Run Id (請求実行 ID)

String (文字列)

請求実行の ID。例: 2c92c8f95d0c886e015d11287a8f0f8b。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Billing Preview Run

<mule-zuora-connector:create-v1-billing-preview-runs>

この機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。複数の顧客アカウントの請求プレビュー実行を作成します。

最大 10 個の請求プレビューをバッチで同時に実行できます。顧客アカウントの 1 つのバッチには請求プレビュー実行を一度に 1 つのみ含めることができます。したがって、最大 10 個のバッチを同時に実行できます。すべての顧客バッチの請求プレビュー実行を作成した場合、そのプレビュー実行が完了するまで別の請求プレビュー実行を作成できません。

この操作では、/v1/billing-preview-runs エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Perform Mass Action

<mule-zuora-connector:create-v1-bulk>

このリファレンスでは、REST API を使用してマスアクションを実行する方法について説明します。この API メソッドを使用して、実行するマスアクションに関するデータを含む .csv ファイルを含むマルチパート/フォームデータ要求を送信します。Zuora はキーを返した後、マスアクションを非同期で処理します。

このキーを使用して、マスアクションの結果に関する詳細を取得できます。この操作では、/v1/bulk エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

File Content (ファイルのコンテンツ)

String (文字列)

「File」部分のコンテンツ。

#[payload]

File Filename (ファイルのファイル名)

String (文字列)

「File」部分のファイル名 (ファイル名のみ、パスを含まない)。

x

Params Content (パラメーターのコンテンツ)

String (文字列)

「parameters」部分のコンテンツ。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Share a Product With an Entity

<mule-zuora-connector:create-v1-catalog-products-share-by-product-id>

Multi-entity 機能は使用制限されています。この機能にアクセスしたい場合は、Zuora グローバルサポートに要求を送信してください。製品を対象エンティティと共有します。共有後に Zuora は共有した製品を対象エンティティと同期します。製品共有についての詳細は、[Products Sharing Across Entities (エンティティ間の製品共有)](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/C_Business_Objects_Sharing_Across_Entities/B_Products_Sharing_Across_Entities) を参照してください。

製品を他のエンティティと共有するには、すべての前提条件を満足する必要があります。

ソースエンティティのシステム管理者のみに、製品を他のエンティティと共有する権限があります。

ソースエンティティのシステム管理者としてコールを実行する必要があります。- 現在、製品は一度に 1 つのエンティティとのみ共有できます。製品を複数のエンティティと共有しようとすると、エラーが発生します。

この操作では、/v1/catalog/products/{product-id}/share エンドポイントに対する HTTP POST 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Product id (製品 ID)

String (文字列)

共有する製品の一意の ID。例: 8a808255575bdae4015774e9602e16fe。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Establish Connection to Zuora REST API Service

<mule-zuora-connector:create-v1-connections>

有効なユーザーログイン情報に基づいて、Zuora REST API サービスへの接続を確立します。 注意: これは従来の REST API です。Zuora は代わりに [OAuth](https://www.zuora.com/developer/api-reference/#section/Authentication/OAuth-v2.0) を使用して認証することを推奨しています。このコールはユーザーを認証し、API セッション Cookie を返します。この Cookie を使用して、REST API への後続のコールを認証します。ログイン情報は、API サービスへのアクセス権限を持つユーザーアカウントに属している必要があります。他の場所で説明されているとおり、Zuora API アクティビティで使用するアカウントを Zuora UI へのログインに使用しないことを強くお勧めします。UI へのログインにアカウントが使用されると、パスワードの変更が定期的に強制される場合があり、最終的に API の使用時に認証エラーになることがあります。

この操作では、/v1/connections エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Api Access Key Id (Api アクセスキー ID)

String (文字列)

アカウントのユーザー名。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Api Secret Access Key (Api シークレットアクセスキー)

String (文字列)

アカウントのパスワード。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content Type (コンテンツタイプ)

String (文字列)

「application/json」に設定する必要があります。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Credit Memo from Charge

<mule-zuora-connector:create-v1-creditmemos>

請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。製品料金プランチャージからアドホッククレジットメモを作成します。Zuora では、任意の種別の製品料金プランチャージからクレジットメモを作成できます。チャージには任意の金額と、割引チャージモデルを除く任意のチャージモデルを含めることもできます。

該当のユーザー権限を持っている場合のみ、クレジットメモを作成できます。詳細は、[「Billing Roles (請求ロール)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) を参照してください。

この操作では、/v1/creditmemos エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。REST API バージョン管理については、[「Minor Version (マイナーバージョン)」](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) を参照してください。このヘッダーは、次の要求項目の可用性に影響します。* charges > amount * charges > memoItemAmount * charges > chargeId * charges > productRatePlanChargeId * charges > comment * charges > description

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Email Credit Memo

<mule-zuora-connector:create-v1-creditmemos-emails-by-credit-memo-id>

請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作では、指定したメールアドレスに転記済みクレジットメモを手動で送信します。

注意事項

クレジットメモをメール送信する前に、[Email Credit Memo (クレジットメモをメール送信)] | [Manually email Credit Memo (クレジットメモを手動でメール送信)] 通知をアクティブ化する必要があります。クレジットメモ PDF をメールに含めるには、Zuora UI から [Edit notification (通知を編集)] ダイアログで [Include Credit Memo PDF (クレジットメモ PDF を含める)] チェックボックスをオンにします。詳細は、[「Create and Edit Notifications (通知の作成と編集)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) を参照してください。
Zuora は、設定されたメールテンプレートに基づいてメールメッセージを送信します。
使用するメールテンプレートは、Zuora UI から [Edit notification (通知を編集)] ダイアログの [Delivery Options (配信オプション)] パネルで設定できます。デフォルトでは、[Manual Email for Credit Memo Default Template (クレジットメモの手動メールのデフォルトテンプレート)] テンプレートが使用されます。詳細は、[「Create and Edit Email Templates (メールテンプレートの作成と編集)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information を参照してください。
クレジットメモは、次のすべての条件が満たされている場合のみ、請求先取引先責任者の仕事用メールアドレスまたは個人用メールアドレスに送信されます。
- useEmailTemplateSetting 項目が false に設定されている。
- emailAddresses 項目でメールアドレスが指定されていない。

この操作では、/v1/creditmemos/{creditMemoId}/emails エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

転記済みクレジットメモの ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Upload File for Credit Memo

<mule-zuora-connector:create-v1-creditmemos-files-by-credit-memo-id>

請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作では、外部で生成された、[Draft (ドラフト)] または [Posted (転記済み)] 状況のクレジットメモの PDF ファイルをアップロードします。この操作には次の制限があります。

PDF ファイル形式のみがサポートされます。
アップロードする PDF ファイルの最大サイズは 4 MB です。
1 つのクレジットメモに対して最大 50 個の PDF ファイルをアップロードできます。

この操作では、/v1/creditmemos/{creditMemoId}/files エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

どのクレジットメモの PDF ファイルをアップロードするかを示すクレジットメモの ID。例: 402890555a7e9791015a879f064a0054.

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

File Content (ファイルのコンテンツ)

String (文字列)

「File」部分のコンテンツ。

#[payload]

File Filename (ファイルのファイル名)

String (文字列)

「File」部分のファイル名 (ファイル名のみ、パスを含まない)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Credit Memo PDF

<mule-zuora-connector:create-v1-creditmemos-pdfs-by-credit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作は、指定したクレジットメモの PDF ファイルを作成します。生成された PDF ファイルにアクセスするには、Zuora UI を介してクレジットメモの詳細ページで [View PDF (PDF を表示)] をクリックして、PDF ファイルをダウンロードできます。請求ユーザー権限「PDF の再生成」が有効になっている場合のみ、この REST API 操作を使用できます。

この操作では、/v1/creditmemos/{creditMemoId}/pdfs エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

どのクレジットメモの PDF ファイルを作成するかを示すクレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Refund Credit Memo

<mule-zuora-connector:create-v1-creditmemos-refunds-by-creditmemo-id>

請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作は、転記済みクレジットメモの全額または一部を顧客に返金します。未適用部分の金額のみを返金できます。

該当のユーザー権限を持っている場合のみ、クレジットメモを返金できます。詳細は、「Billing Roles (請求ロール)」を参照してください。

この操作では、/v1/creditmemos/{creditmemoId}/refunds エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Creditmemo Id (Creditmemo ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Taxation Items for Credit Memo

<mule-zuora-connector:create-v1-creditmemos-taxationitems-by-credit-memo-id>

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作は、クレジットメモに対して課税項目を作成し、/v1/creditmemos/{creditMemoId}/taxationitems エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Debit Memo from Charge

<mule-zuora-connector:create-v1-debitmemos>

請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作は、製品料金プランチャージからアドホックデビットメモを作成します。Zuora では、任意の種別の製品料金プランチャージからデビットメモを作成できます。チャージには任意の金額と、割引チャージモデルを除く任意のチャージモデルを含めることもできます。

該当のユーザー権限を持っている場合のみ、デビットメモを作成できます。詳細は、「Billing Roles (請求ロール)」を参照してください。

この操作では、/v1/debitmemos エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。REST API バージョン管理については「Minor Version (マイナーバージョン)」を参照してください。このヘッダーは、次の要求項目の可用性に影響します。

charges > amount
charges > memoItemAmount
charges > chargeId
charges > productRatePlanChargeId
charges > comment
charges > description

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Email Debit Memo

<mule-zuora-connector:create-v1-debitmemos-emails-by-debit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。指定したメールアドレスに転記済みデビットメモを手動で送信します。

注意事項

デビットメモをメール送信する前に、[Email Debit Memo (デビットメモをメール送信)] | [Manually email Debit Memo (デビットメモを手動でメール送信)] 通知をアクティブ化する必要があります。デビットメモ PDF をメールに含めるには、Zuora UI から [Edit notification (通知を編集)] ダイアログで [Include Debit Memo PDF (デビットメモ PDF を含める)] チェックボックスをオンにします。詳細は、[「Create and Edit Notifications (通知の作成と編集)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) を参照してください。
Zuora は、設定されたメールテンプレートに基づいてメールメッセージを送信します。
使用するメールテンプレートは、Zuora UI から [Edit notification (通知を編集)] ダイアログの [Delivery Options (配信オプション)] パネルで設定できます。デフォルトでは、[Manual Email for Debit Memo Default Template (デビットメモの手動メールのデフォルトテンプレート)] テンプレートが使用されます。詳細は、[「Create and Edit Email Templates (メールテンプレートの作成と編集)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information を参照してください。
デビットメモは、次のすべての条件が満たされている場合のみ、請求先取引先責任者の仕事用メールアドレスまたは個人用メールアドレスに送信されます。
- useEmailTemplateSetting 項目が false に設定されている。
- emailAddresses 項目でメールアドレスが指定されていない。

この操作では、/v1/debitmemos/{debitMemoId}/emails エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Debit Memo Id (デビットメモ ID)

String (文字列)

転記済みデビットメモの ID。例: 8a8082e65b27f6c3015ba419f3c2644e。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Upload File for Debit Memo

<mule-zuora-connector:create-v1-debitmemos-files-by-debit-memo-id>

請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作では、外部で生成された、[Draft (ドラフト)] または [Posted (転記済み)] 状況のデビットメモの PDF ファイルをアップロードします。この操作には次の制限があります。

PDF ファイル形式のみがサポートされます。
アップロードする PDF ファイルの最大サイズは 4 MB です。
1 つのデビットメモに対して最大 50 個の PDF ファイルをアップロードできます。

この操作では、/v1/debitmemos/{debitMemoId}/files エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Debit Memo Id (デビットメモ ID)

String (文字列)

どのデビットメモの PDF ファイルをアップロードするかを示すデビットメモの ID。例: 402890555a87d7f5015a8919e4fe002e。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

File Content (ファイルのコンテンツ)

String (文字列)

「File」部分のコンテンツ。

#[payload]

File Filename (ファイルのファイル名)

String (文字列)

「File」部分のファイル名 (ファイル名のみ、パスを含まない)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Debit Memo PDF

<mule-zuora-connector:create-v1-debitmemos-pdfs-by-debit-memo-id>

請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

指定したデビットメモの PDF ファイルを作成します。生成された PDF ファイルにアクセスするには、Zuora UI を介してデビットメモの詳細ページで [View PDF (PDF を表示)] をクリックして、PDF ファイルをダウンロードできます。

請求ユーザー権限「PDF の再生成」が有効になっている場合のみ、この REST API 操作を使用できます。

この操作では、/v1/debitmemos/{debitMemoId}/pdfs エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Debit Memo Id (デビットメモ ID)

String (文字列)

どのデビットメモの PDF ファイルを作成するかを示すデビットメモの一意の ID。例: 8a8082e65b27f6c3015ba419f3c2644e。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Taxation Items for Debit Memo

<mule-zuora-connector:create-v1-debitmemos-taxationitems-by-debit-memo-id>

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作は、デビットメモに対して課税項目を作成し、/v1/debitmemos/{debitMemoId}/taxationitems エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Debit Memo Id (デビットメモ ID)

String (文字列)

デビットメモの一意の ID。例: 8a8082e65b27f6c3015ba419f3c2644e。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Document Properties

<mule-zuora-connector:create-v1-document-properties>

この機能は、請求ドキュメントプロパティセットアップ機能を有効にしている場合のみ使用できます。請求ドキュメントプロパティのセットアップ機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作では、請求ドキュメントのカスタムドキュメントプロパティを作成します。たとえば、1 つのドキュメントプロパティがあります。カスタム名を、請求ドキュメント用に生成されたファイルで使用することができます。請求ドキュメントには、請求書、クレジットメモ、およびデビットメモがあります。API 操作を使用して作成した請求ドキュメントにカスタムファイル名を設定する場合、請求ドキュメントを転記する前にこの操作をコールする必要があります。

請求書決済機能を有効にしている場合のみ、クレジットメモとデビットメモのドキュメントプロパティを作成できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作では、/v1/document-properties エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Create entity

<mule-zuora-connector:create-v1-entities>

Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

グローバルエンティティのシステム管理者としてコールを実行する必要があります。

注意事項

デフォルトでは、グローバルエンティティのシステム管理者がアクセスできるエンティティは自分で作成したエンティティのみのため、エンティティ階層を管理するためのシステム管理者を 1 人のみ割り当てることが最良の手段です。

この操作では、/v1/entities エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Initiate Connection

<mule-zuora-connector:create-v1-entity-connections>

Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作では、ソースエンティティから対象エンティティへの接続要求を開始します。

ユーザーアクセス権限

ソースエンティティのシステム管理者としてコールを実行する必要があります。また、このシステム管理者には、対象エンティティにアクセスするための権限が必要です。

この操作では、/v1/entity-connections エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Reverse Payment

<mule-zuora-connector:create-v1-gateway-settlement-payments-chargeback-by-payment-id>

支払い状況を [Reversed (逆転済み)] に設定し、要求で指定された金額の返金を作成して、Refund オブジェクトを応答として返します。

この操作では、/v1/gateway-settlement/payments/{payment-id}/chargeback エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment id (支払い ID)

String (文字列)

支払いの一意の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Reject Payment

<mule-zuora-connector:create-v1-gateway-settlement-payments-reject-by-payment-id>

支払い状況を [Rejected (拒否済み)] に設定し、支払い金額の返金を作成して、Refund オブジェクトを応答として返します。

この操作では、/v1/gateway-settlement/payments/{payment-id}/reject エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment id (支払い ID)

String (文字列)

支払いの一意の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Settle Payment

<mule-zuora-connector:create-v1-gateway-settlement-payments-settle-by-payment-id>

支払い状況を [Settled (決済済み)] に設定し、Payment オブジェクトを応答として返します。

この操作では、/v1/gateway-settlement/payments/{payment-id}/settle エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment id (支払い ID)

String (文字列)

支払いの一意の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Return HMAC signatures

<mule-zuora-connector:create-v1-hmac-signatures>

この REST API リファレンスでは、CORS 対応の API コールの処理に使用する一意の署名値およびトークン値を返す方法について説明します。この操作では、/v1/hmac-signatures エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Credit Memo from Invoice

<mule-zuora-connector:create-v1-invoices-creditmemos-by-invoice-id>

この操作は、請求書からアドホッククレジットメモを作成します。

請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

該当のユーザー権限を持っている場合のみ、クレジットメモを請求書から作成できます。詳細は、「Billing Roles (請求ロール)」を参照してください。

この操作では、/v1/invoices/{invoiceId}/creditmemos エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice Id (請求書 ID)

String (文字列)

クレジットメモの作成元の請求書の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。REST API バージョン管理については、[「Minor Version (マイナーバージョン)」](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) を参照してください。このヘッダーは、次の要求項目の可用性に影響します。* items > comment * items > description

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create debit memo from invoice

<mule-zuora-connector:create-v1-invoices-debitmemos-by-invoice-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。請求書からアドホックデビットメモを作成します。該当のユーザー権限を持っている場合のみ、デビットメモを請求書から作成できます。詳細は、[「Billing Roles (請求ロール)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) を参照してください。この操作では、/v1/invoices/{invoiceId}/debitmemos エンドポイントに対する HTTP POST 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice Id (請求書 ID)

String (文字列)

デビットメモの作成元の請求書の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。REST API バージョン管理については、[「Minor Version (マイナーバージョン)」](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) を参照してください。このヘッダーは、次の要求項目の可用性に影響します。* items > comment * items > description

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Email Invoice

<mule-zuora-connector:create-v1-invoices-emails-by-invoice-id>

指定したメールアドレスに転記済み請求書を手動で送信します。

注意事項

請求書をメール送信する前に、[Manual Email For Invoice (請求書の手動メール)] | [Manual Email For Invoice (請求書の手動メール)] 通知をアクティブ化する必要があります。請求書 PDF をメールに含めるには、Zuora UI から [Edit notification (通知を編集)] ダイアログで [Include Invoice PDF (請求書 PDF を含める)] チェックボックスをオンにします。詳細は、[「Create and Edit Notifications (通知の作成と編集)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) を参照してください。
Zuora は、設定されたメールテンプレートに基づいてメールメッセージを送信します。
使用するメールテンプレートは、Zuora UI から [Edit notification (通知を編集)] ダイアログの [Delivery Options (配信オプション)] パネルで設定できます。デフォルトでは、[Invoice Posted Default Email Template (転記済み請求書のデフォルトメールテンプレート)] テンプレートが使用されます。詳細は、[「Create and Edit Email Templates (メールテンプレートの作成と編集)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information を参照してください。
請求書は、次のすべての条件が満たされている場合のみ、請求先取引先責任者の仕事用メールアドレスまたは個人用メールアドレスに送信されます。
- useEmailTemplateSetting 項目が false に設定されている。
- emailAddresses 項目でメールアドレスが指定されていない。

この操作では、/v1/invoices/{invoiceId}/emails エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice Id (請求書 ID)

String (文字列)

請求書の ID。例: 2c92c8955bd63cc1015bd7c151af02ab。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Upload File for Invoice

<mule-zuora-connector:create-v1-invoices-files-by-invoice-id>

外部で生成された、[Draft (ドラフト)] または [Posted (転記済み)] 状況の請求書の PDF ファイルをアップロードします。この操作には次の制限があります。- PDF ファイル形式のみがサポートされます。- アップロードする PDF ファイルの最大サイズは 4 MB です。- 1 つの請求書に対して最大 50 個の PDF ファイルをアップロードできます。この操作では、/v1/invoices/{invoiceId}/files エンドポイントに対する HTTP POST 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice Id (請求書 ID)

String (文字列)

どの請求書の PDF ファイルをアップロードするかを示す請求書の ID。例: 2c92c8955bd63cc1015bd7c151af02ab。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

File Content (ファイルのコンテンツ)

String (文字列)

「File」部分のコンテンツ。

#[payload]

File Filename (ファイルのファイル名)

String (文字列)

「File」部分のファイル名 (ファイル名のみ、パスを含まない)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Summary Journal Entry

<mule-zuora-connector:create-v1-journal-entries>

この REST API リファレンスでは、サマリージャーナルエントリを手動で作成する方法について説明します。要求項目と応答項目の説明、およびサンプルコードが提供されています。

要件

デビットの合計はサマリージャーナルエントリ内のクレジットの合計と等しい必要があります。
外貨換算を使用する場合のみ、以下が適用されます。
- [Aggregate transactions with different currencies during a Journal Run (ジャーナル実行中に異なる通貨のトランザクションを集約)] を [Yes (はい)] に設定している場合、[currency (通貨)] 項目の値はテナントのホーム通貨と同じである必要があります。つまり、ホーム通貨を使用してジャーナルエントリを作成する必要があります。
- アカウンティング期間内のジャーナルエントリは、すべて集約されているか、すべて集約されていない必要があります。同じアカウンティング期間内で、集約されたジャーナルエントリと集約されていないジャーナルエントリを混合することはできません。

この操作では、/v1/journal-entries エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Journal Run

<mule-zuora-connector:create-v1-journal-runs>

この REST API リファレンスでは、ジャーナル実行を作成する方法について説明します。要求項目と応答項目の説明、およびサンプルコードが提供されています。

この操作では、/v1/journal-runs エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create Account

<mule-zuora-connector:create-v1-object-account>

関連付けられたオブジェクト (サブスクリプションなど) を作成せずにアカウントを作成します。この操作では、/v1/object/account エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create Bill Run

<mule-zuora-connector:create-v1-object-bill-run>

この機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作は、1 つのアカウントまたは複数の顧客アカウントのアドホック請求実行を作成します。1 つのアカウントのアドホック請求実行を作成する場合、要求に AccountId を含め、Batch または BillCycleDay を含めないでください。この操作を使用して作成した 500 件を超える請求実行が [Pending (待機中)] 状況になっている場合、それ以上の請求実行をこの操作で作成することはできません。

この操作では、/v1/object/bill-run エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create Contact

<mule-zuora-connector:create-v1-object-contact>

指定したアカウントの取引先責任者を作成します。

この操作では、/v1/object/contact エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create CreditBalanceAdjustment

<mule-zuora-connector:create-v1-object-credit-balance-adjustment>

CRUD: Create CreditBalanceAdjustment この操作では、/v1/object/credit-balance-adjustment エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create Export

<mule-zuora-connector:create-v1-object-export>

この操作を使用して、データソースエクスポートを作成します。データソースエクスポートを作成したら、[CRUD: Retrieve Export] (https://www.zuora.com/developer/api-reference/#operation/Object_GETExport) を使用して、データソースエクスポートの状況を確認し、エクスポートしたデータにアクセスします。Zuora からデータをエクスポートしたら、エクスポートした各ファイルは 7 日間ダウンロード可能です。データソースエクスポート (Export オブジェクト) は 90 日を超えると自動的に削除されます。 注意: この操作では、[Export ZOQL](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL) クエリ言語がサポートされます。ただし、この操作では、一部のデータソース、オブジェクト、項目を Export ZOQL クエリで使用することはできません。Export ZOQL との完全な互換性を確保するには、Zuora はこの操作の代わりに [AQuA API](https://knowledgecenter.zuora.com/DC_Developers/T_Aggregate_Query_API) を使用することを推奨しています。この操作では、/v1/object/export エンドポイントに対する HTTP POST 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Object POSTFeature

<mule-zuora-connector:create-v1-object-feature>

この操作では、/v1/object/feature エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create Import

<mule-zuora-connector:create-v1-object-import>

データインポートを作成します。この操作では、/v1/object/import エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Import Type Content (インポート種別のコンテンツ)

String (文字列)

「Import type」部分のコンテンツ。

#[payload]

Name Content (名前のコンテンツ)

String (文字列)

「Name」部分のコンテンツ。

x

File Content (ファイルのコンテンツ)

String (文字列)

「File」部分のコンテンツ。

x

File Filename (ファイルのファイル名)

String (文字列)

「File」部分のファイル名 (ファイル名のみ、パスを含まない)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create InvoiceAdjustment

<mule-zuora-connector:create-v1-object-invoice-adjustment>

CRUD: Create InvoiceAdjustment この操作では、/v1/object/invoice-adjustment エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create InvoicePayment

<mule-zuora-connector:create-v1-object-invoice-payment>

CRUD: Create InvoicePayment この操作では、/v1/object/invoice-payment エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create payment

<mule-zuora-connector:create-v1-object-payment>

支払いを作成します。 注意: 請求書決済機能を有効にしている場合、この操作を使用して支払いを作成することはできません。この操作では、/v1/object/payment エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create Payment Method

<mule-zuora-connector:create-v1-object-payment-method>

この CRUD 操作では、/v1/object/payment-method エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create Product

<mule-zuora-connector:create-v1-object-product>

この CRUD 操作では、/v1/object/product エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create ProductRatePlan

<mule-zuora-connector:create-v1-object-product-rate-plan>

この CRUD 操作では、/v1/object/product-rate-plan エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create product rate plan charge

<mule-zuora-connector:create-v1-object-product-rate-plan-charge>

指定した料金プランチャージの製品料金プランチャージを作成します。製品料金プランチャージでは、1 回限りの料金、定期的な料金、および使用量料金の 3 つの種別を使用できます。

この操作では、/v1/object/product-rate-plan-charge エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create Refund

<mule-zuora-connector:create-v1-object-refund>

この CRUD 操作では、/v1/object/refund エンドポイントに対する HTTP POST 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create TaxationItem

<mule-zuora-connector:create-v1-object-taxation-item>

この CRUD 操作では、/v1/object/taxation-item の課税項目エンドポイントに対する HTTP POST 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create UnitOfMeasure

<mule-zuora-connector:create-v1-object-unit-of-measure>

この CRUD 操作では、/v1/object/unit-of-measure エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Create usage

<mule-zuora-connector:create-v1-object-usage>

この CRUD 操作では、/v1/object/usage エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Billing Preview

<mule-zuora-connector:create-v1-operations-billing-preview>

請求プレビュー機能は使用制限されています。この機能にアクセスするには、Zuora グローバルサポートに要求を送信してください。

この操作では、1 つの顧客アカウントの将来の請求書項目のプレビューを生成します。BillingPreview コールを使用して、最後の請求書日付から将来の特定の期間終了日付までの 1 つの顧客の請求書金額を計算します。また、BillingPreview サービスを使用して、個々の顧客の使用量消費に関するリアルタイムデータにアクセスすることもできます。BillingPreview コールでは、サブスクリプション内のチャージに対する税金は計算されません。

請求書決済機能を有効にしている場合、1 つの顧客アカウントの将来のクレジットメモ項目のプレビューも生成できます。請求書決済機能は使用制限されています。この機能にアクセスするには、Zuora グローバルサポートに要求を送信してください。

この操作では、/v1/operations/billing-preview エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Invoice and Collect

<mule-zuora-connector:create-v1-operations-invoice-collect>

請求書とクレジットメモを生成および転記して、転記済み請求書の支払いを収集します。クレジットメモは、請求書決済機能を有効にしていて、マイナスのチャージが存在する場合にのみ使用できます。クレジットメモは請求書に適用されません。

この操作の実行時にドラフトの請求書とクレジットメモが存在する場合、その請求書とクレジットメモはこの操作で転記されます。ただし、請求書または製品料金プランチャージから作成されたドラフトクレジットメモは転記されません。

この操作を使用して、請求書を生成し、転記済み請求書の支払いを収集することができます。または、単に、指定した既存の請求書の支払いを収集することもできます。顧客のデフォルトの支払い方法が使用され、未払い額の全額が収集されます。操作は、指定されたパラメーターに依存します。

該当の顧客の 1 つ以上の新しい請求書を生成し、生成された請求書と他の未払い請求書の支払いを収集するには、invoiceId 項目を空のままにします。
既存の請求書の支払いを収集するには、請求書 ID を指定します。操作はアトミックです。つまり、いずれかの部分が失敗した場合、操作全体がロールバックされます。エラーが発生した場合、ゲートウェイ理由コードとエラーメッセージがこの操作のエラー応答で返されます。

いくつかのゲートウェイ応答コードの例を次に示します。 * Orbital: 05 Do Not Honor、14 Invalid Credit Card Number * Vantiv: 301 Invalid Account Number、304 Lost/Stolen Card * CyberSource2: 202 Expired card、231 Invalid account number

理由コードの詳細は、対応する支払ゲートウェイのドキュメントを参照してください。

サブスクリプション数が非常に多いアカウントでこの方法を使用すると、タイムアウトが発生する場合があります。

この操作では、/v1/operations/invoice-collect エンドポイントに HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。このパラメーターを設定する必要があるのは、次の項目を使用する場合です。* documentDate * targetDate。請求書決済機能を有効にしている場合、このパラメーターを指定する必要があります。それ以外の場合、エラーが返されます。詳細は、[「Zuora REST API Versions (Zuora REST API バージョン)」](https://www.zuora.com/developer/api-reference/#section/API-Versions) を参照してください。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Order

<mule-zuora-connector:create-v1-orders>

この操作は、注文機能を有効にしている場合にのみ使用できます。注文への移行は使用制限されています。正式リリースの前に、小規模の早期導入ユーザーからのフィードバックが積極的に求められています。

この操作を使用して注文を作成することで、サブスクリプションの作成と変更ができます。次のチュートリアルは、この操作の使用方法を示しています。

ドラフト注文の作成は、現時点ではサポートされていません。その他の制限については、「Known Limitations in Orders (注文に関する既知の制限)」を参照してください。

注意事項

suspend 注文アクションを使用してサブスクリプションを一時停止し、同じ「Create Order」コール内で、一時停止したサブスクリプションに対して他の後続の注文アクションを実行する場合は、まず resume 注文アクションを使用してサブスクリプションを再開する必要があります。
この操作を使用して 1 回のコールでアカウントの作成、サブスクリプションの作成、請求の実行、支払いの収集を行ったときに、支払処理に失敗した場合、他のすべてのステップはロールバックされます。つまり、請求書は生成されず、サブスクリプションは作成されず、アカウントは作成されません。

制限

パフォーマンスの低下を防ぐため、Zuora には注文に関する次の制限があります。

1 回の「Create Order」操作コールで最大 50 個のサブスクリプションが許可されます。
1 回の「Create Order」操作コールで最大 50 個の注文アクションが許可されます。
「Create Order」操作コール内の 1 つのサブスクリプションに対して最大 50 個の注文アクションが許可されます。

制限の増加を要求するには、Zuora グローバルサポートに要求を送信してください。

この操作では、/v1/orders エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Return Ids (ID を返す)

Boolean (ブール)

Create Order 操作で返される番号に関連付けられた ID を返すかどうかを指定します。

false

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。このパラメーターを設定する必要があるのは、次の項目を使用する場合です。* subscriptions * subscriptionNumbers

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Preview Order

<mule-zuora-connector:create-v1-orders-preview>

この操作は、注文機能を有効にしている場合にのみ使用できます。

注文への移行は使用制限されています。正式リリースの前に、小規模の早期導入ユーザーからのフィードバックが積極的に求められています。

この操作は、指定した注文のチャージメトリクスと請求書項目のプレビューを取得します。この操作は単なる注文プレビューです。注文は作成されません。

制限

パフォーマンスの低下を防ぐため、Zuora には注文に関する次の制限があります。

1 回の「Preview Order」操作コールで最大 50 個のサブスクリプションが許可されます。
1 回の「Preview Order」操作コールで最大 50 個の注文アクションが許可されます。
「Preview Order」操作コール内の 1 つのサブスクリプションに対して最大 50 個の注文アクションが許可されます。

制限の増加を要求するには、Zuora グローバルサポートに要求を送信してください。

この操作では、/v1/orders/preview エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Payment Method

<mule-zuora-connector:create-v1-payment-methods>

この操作を使用して、顧客アカウントの支払い方法を作成できます。

この操作では、次の支払い方法がサポートされます。

PayPal Express Checkout
次の必須リクエストボディ項目はこの支払方法に固有の項目です。
- BAID (必須)
- email (必須)
PayPal Native Express Checkout
次の必須リクエストボディ項目はこの支払方法に固有の項目です。
- BAID (必須)
- email (省略可能)
PayPal Adaptive
次の必須リクエストボディ項目はこの支払方法に固有の項目です。
- preapprovalKey (必須)
- email (必須)
クレジットカード
この機能は使用制限されています。正式リリースの前に、小規模の早期導入ユーザーからのフィードバックが積極的に求められています。
次のリクエストボディ項目はこの支払方法に固有の項目です。
- cardHolderInfo (cardHolderName が必要)
- cardNumber (必須)
- cardType (必須)
- expirationMonth (必須)
- expirationYear (必須)
- mitConsentAgreementRef
- mitConsentAgreementSrc
- mitNetworkTransactionId
- mitProfileAction
- mitProfileType
- mitProfileAgreedOn
- securityCode
- checkDuplicated
ACH
次のリクエストボディ項目はこの支払方法に適用されます。
- bankABACode (必須)
- bankAccountName (必須)
- bankAccountNumber (必須)
- bankAccountType (必須)
- bankName (必須)
- addressLine1
- addressLine2
- phone
- email
- city
- country
- state
- zipCode
SEPA

次のリクエストボディ項目はこの支払方法に適用されます。
- IBAN (必須)
- accountHolderInfo (必須)
- businessIdentificationCode
Betalingsservice (Direct Debit DK)
次のリクエストボディ項目はこの支払方法に適用されます。
- accountNumber (必須)
- identityNumber (必須)
- bankCode (必須)
- accountHolderInfo (必須)
Autogiro (Direct Debit SE)
次のリクエストボディ項目はこの支払方法に適用されます。
- accountNumber (必須)
- identityNumber (必須)
- branchCode (必須)
- accountHolderInfo (必須)
Bacs (Direct Debit UK)
次のリクエストボディ項目はこの支払方法に適用されます。
- accountNumber (必須)
- bankCode (必須)
- accountHolderInfo (必須)

この操作では、/v1/payment-methods エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Authorization

<mule-zuora-connector:create-v1-payment-methods-authorize-by-payment-method-id>

この機能を有効にする必要がある場合は、Zuora グローバルサポートに要求を送信してください。

この操作は、トランザクションに対する資金の可用性を認証しながら、資金の捕捉を後の時点まで遅らせることができます。その後、 CRUD: Create payment または Create payment を使用して認証された資金を捕捉するか、もしくは Cancel authorization を使用して認証をキャンセルします。

この操作をサポートする支払いゲートウェイには、Verifi、CyberSource 1.28、CyberSource 1.97、Chase Paymentech Orbital、Ingenico ePayments があります。

請求書決済機能を有効にしている場合は、 Create payment 操作ではなく CRUD: Create payment 操作を使用して資金を捕捉してください。

この操作では、/v1/payment-methods/{payment-method-id}/authorize エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment method id (支払い方法 ID)

String (文字列)

認証を作成する支払い方法の一意の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Credit Card Payment Method

<mule-zuora-connector:create-v1-payment-methods-credit-cards>

この REST API リファレンスでは、顧客アカウントの新しいクレジットカード支払方法を作成する方法について説明します。この API コールは CORS 対応です。クライアント側の Javascript を使用してコールを呼び出します。

ホストされる支払ページの iFrame を使用する代わりにこの操作を使用してクレジットカード支払い方法を作成する場合は、PCI 準拠の監査要件に従う必要があります。

この操作では、/v1/payment-methods/credit-cards エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Apple Pay Payment Method

<mule-zuora-connector:create-v1-payment-methods-decryption>

復号化 API エンドポイントは、1 つのアトミックコールで条件に応じて 3 つのタスクを実行できます。

Apple Pay 支払いトークンを復号化する
復号化された Apple Pay 情報を使用して、Zuora でクレジットカード支払い方法を作成する
指定された請求書の支払いを処理する (省略可能)

この操作では、/v1/payment-methods/decryption エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Stored Credential Profile

<mule-zuora-connector:create-v1-payment-methods-profiles-by-payment-method-id>

支払い方法内に保存されるログイン情報プロファイルを作成します。保存されたログイン情報プロファイルは、顧客と確立した同意契約を表します。トランザクションでこの支払方法を使用すると、Zuora は保存されたログイン情報プロファイルからの情報を含めて、トランザクションが顧客との既存の同意契約に関連していることを支払いプロセッサーに伝えることができます。

この機能は使用制限されています。正式リリースの前に、小規模の早期導入ユーザーからのフィードバックが積極的に求められています。

この操作では、/v1/payment-methods/{payment-method-id}/profiles エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment method id (支払い方法 ID)

String (文字列)

支払い方法の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Cancel Stored Credential Profile

<mule-zuora-connector:create-v1-payment-methods-profiles-cancel-by-payment-method-id-profile-number>

支払い方法内に保存されたログイン情報プロファイルをキャンセルします。保存されたログイン情報プロファイルをキャンセルすることは、保存されたログイン情報が顧客の要求に従って無効になることを示します。保存されたログイン情報プロファイルをキャンセルすると、そのログイン情報プロファイルを再アクティブ化することはできません。

この機能は使用制限されています。正式リリースの前に、小規模の早期導入ユーザーからのフィードバックが積極的に求められています。

この操作では、/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment method id (支払い方法 ID)

String (文字列)

支払い方法の ID。

x

Profile number (プロファイル番号)

Number (数値)

支払い方法内に保存されたログイン情報プロファイルを識別する番号。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に割り当てられます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Expire Stored Credential Profile

<mule-zuora-connector:create-v1-payment-methods-profiles-expire-by-payment-method-id-profile-number>

支払い方法内に保存されたログイン情報プロファイルを期限切れにします。保存されたログイン情報プロファイルを期限切れにすることは、保存されたログイン情報が、保存されたログイン情報トランザクションフレームワークの有効期限ポリシーに従って無効になることを示します。保存されたログイン情報プロファイルが期限切れになると、そのログイン情報プロファイルを再アクティブ化することはできません。

この機能は使用制限されています。正式リリースの前に、小規模の早期導入ユーザーからのフィードバックが積極的に求められています。

この操作では、/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire エンドポイントに対する HTTP POST 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment method id (支払い方法 ID)

String (文字列)

支払い方法の ID。

x

Profile number (プロファイル番号)

Number (数値)

支払い方法内に保存されたログイン情報プロファイルを識別する番号。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。 Zuora Multi-entity を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Cancel Authorization

<mule-zuora-connector:create-v1-payment-methods-void-authorize-by-payment-method-id>

この機能を有効にする必要がある場合は、Zuora グローバルサポートに要求を送信してください。

この操作により、認証をキャンセルできます。この操作をサポートする支払いゲートウェイには、Verifi、CyberSource 1.28、CyberSource 1.97、Chase Paymentech Orbital、Ingenico ePayments があります。

この操作では、/v1/payment-methods/{payment-method-id}/voidAuthorize エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment method id (支払い方法 ID)

String (文字列)

認証をキャンセルする支払い方法の一意の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Payment Run

<mule-zuora-connector:create-v1-payment-runs>

支払い実行を作成します。支払い実行を作成して作成直後に実行したり、スケジュールされた支払い実行を作成して後で実行したりできます。accountId、batch、billCycleDay、currency、paymentGatewayId、および billingRunId 項目を使用して、支払実行で支払われる売掛金を決定できます。このどの項目もリクエストボディで指定されていない場合、対応する支払い実行ですべてのアカウントの支払いが収集されます。

この操作では、/v1/payment-runs エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Payment

<mule-zuora-connector:create-v1-payments>

請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作では、次のシナリオの支払いを作成します。

請求書またはデビットメモの全額支払い
一部支払い
複数の請求書およびデビットメモの支払い
未適用の支払い。支払いがどの顧客アカウントに属しているかが不明な場合は、顧客アカウントを指定せずに支払いを作成できます。

支払を作成する場合、支払が適用される請求書とデビットメモの合計数は 1,000 件以下である必要があります。

比例配分適用ルールを使用する場合、支払を作成するときに、次の数量が 10,000 以下である必要があります:
(number of invoice items + number of debit memo items) * number of payment items

それ以外の場合、比例配分ルールの代わりに先入れ先出しルールが使用されます。

詳細は、「Create Payments (支払いの作成)」および「Create Payments Without Specifying Customer Accounts (顧客アカウントを指定しない支払いの作成)」を参照してください。

この操作では、/v1/payments エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Refund Payment

<mule-zuora-connector:create-v1-payments-refunds-by-payment-id>

請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作は、未適用の支払いの全額または一部を顧客に返金します。適用済みの支払いを返金するには、請求書またはデビットメモから適用済みの支払いを適用解除してから、未適用になった支払いを顧客に返金します。

この操作では、/v1/payments/{paymentId}/refunds エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment Id (支払い ID)

String (文字列)

未適用の支払いの一意の ID。例: 8a8082e65b27f6c3015b89e4344c16b1。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Generate Quotes Document

<mule-zuora-connector:create-v1-quotes-document>

document コールでは、見積ドキュメントが生成され、生成されたドキュメントの URL が返されます。生成された見積ファイルには、返された URL から直接アクセスできます。document コールは Zuora 見積からのみ使用する必要があります。

ファイルサイズの制限

最大エクスポートファイルサイズは 2047MB です。この制限を超える大きなデータ要求がある場合、403 HTTP 応答コード (security:max-object-size>2047MB) を Zuora から受け取ります。

大きいファイルの最適化を行う必要があるかどうかを判断するための助言を得るには、Zuora グローバルサポートに要求を送信してください。

この操作では、/v1/quotes/document エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Revenue Schedule for Credit Memo Item (manual distribution)

<mule-zuora-connector:create-v1-revenue-schedules-credit-memo-items-by-cmi-id>

この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作は、クレジットメモ項目に対して収益スケジュールを作成して収益を分配し、/v1/revenue-schedules/credit-memo-items/{cmi-id} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Cmi id (Cmi ID)

String (文字列)

クレジットメモ項目の一意の ID。クレジットメモ項目 ID は [Get credit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoItems) の応答から取得できます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Revenue Schedule for Credit Memo Item (distribute by date range)

<mule-zuora-connector:create-v1-revenue-schedules-credit-memo-items-distribute-revenue-with-date-range-by-cmi-id>

クレジットメモ項目の収益スケジュールを作成し、認識の開始日と終了日を指定して収益を自動的に分配します。

この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作では、/v1/revenue-schedules/credit-memo-items/{cmi-id}/distribute-revenue-with-date-range エンドポイントに対する HTTP POST 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Cmi id (Cmi ID)

String (文字列)

クレジットメモ項目の一意の ID。クレジットメモ項目 ID は [Get credit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoItems) の応答から取得できます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Revenue Schedule for Debit Memo Item (manual distribution)

<mule-zuora-connector:create-v1-revenue-schedules-debit-memo-items-by-dmi-id>

デビットメモ項目の収益を手動で分配するための収益スケジュールを作成します。

この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作では、/v1/revenue-schedules/debit-memo-items/{dmi-id} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Dmi id (Dmi ID)

String (文字列)

デビットメモ項目の一意の ID。デビットメモ項目 ID は [Get debit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems) の応答から取得できます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create revenue schedule for debit memo item (distribute by date range)

<mule-zuora-connector:create-v1-revenue-schedules-debit-memo-items-distribute-revenue-with-date-range-by-dmi-id>

デビットメモ項目の収益スケジュールを作成し、認識の開始日と終了日を指定して収益を自動的に分配します。

この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作では、/v1/revenue-schedules/debit-memo-items/{dmi-id}/distribute-revenue-with-date-range エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Dmi id (Dmi ID)

String (文字列)

デビットメモ項目の一意の ID。デビットメモ項目 ID は [Get debit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems) の応答から取得できます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create revenue schedule for Invoice Item Adjustment (manual distribution)

<mule-zuora-connector:create-v1-revenue-schedules-invoice-item-adjustments-by-invoice-item-adj-key>

請求書項目調整の収益スケジュールを作成し、収益を手動で分配します。この操作では、/v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice item adj key (請求書項目調整キー)

String (文字列)

請求書項目調整の ID または番号。例: e20b07fd416dcfcf0141c81164fd0a72。指定された請求書項目調整がすでに収益スケジュールに関連付けられている場合、コールに失敗します。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create revenue schedule for Invoice Item Adjustment (distribute by

<mule-zuora-connector:create-v1-revenue-schedules-invoice-item-adjustments-distribute-revenue-with-date-range-by-invoice-item-adj-key>

請求書項目調整の収益スケジュールを作成し、認識の開始日と終了日を指定して収益を分配します。この操作では、/v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key}/distribute-revenue-with-date-range エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice item adj key (請求書項目調整キー)

String (文字列)

請求書項目調整の ID または番号。例: e20b07fd416dcfcf0141c81164fd0a72。指定された請求書項目調整がすでに収益スケジュールに関連付けられている場合、コールに失敗します。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create revenue schedule for Invoice Item (manual distribution)

<mule-zuora-connector:create-v1-revenue-schedules-invoice-items-by-invoice-item-id>

請求書項目の収益スケジュールを作成し、収益を手動で分配します。この操作では、/v1/revenue-schedules/invoice-items/{invoice-item-id} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice item id (請求書項目 ID)

String (文字列)

請求書項目の ID。例: e20b07fd416dcfcf0141c81164fd0a75。指定された請求書項目がすでに収益スケジュールに関連付けられている場合、コールに失敗します。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Revenue Schedule for Invoice Item (distribute by date range)

<mule-zuora-connector:create-v1-revenue-schedules-invoice-items-distribute-revenue-with-date-range-by-invoice-item-id>

請求書項目の収益スケジュールを作成し、認識の開始日と終了日を指定して収益を分配します。この操作では、/v1/revenue-schedules/invoice-items/{invoice-item-id}/distribute-revenue-with-date-range エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice item id (請求書項目 ID)

String (文字列)

請求書項目の ID。例: e20b07fd416dcfcf0141c81164fd0a75。指定された請求書項目がすでに収益スケジュールに関連付けられている場合、コールに失敗します。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create Revenue Schedule on Subscription Charge

<mule-zuora-connector:create-v1-revenue-schedules-subscription-charges-by-charge-key>

サブスクリプションチャージを指定して、収益スケジュールを作成します。この方法は、カスタムの無制限の収益認識専用の方法です。

サブスクリプションチャージあたり最大 3,000 個の収益スケジュールを作成できます。

この操作では、/v1/revenue-schedules/subscription-charges/{charge-key} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Charge key (チャージキー)

String (文字列)

サブスクリプション料金プランチャージの ID。例: 402892793e173340013e173b81000012。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Generate RSA signature

<mule-zuora-connector:create-v1-rsa-signatures>

支払いページ 2.0 で使用する REST API は CORS (クロスオリジンリソース共有) 対応のため、デジタル署名を必要とします。POST rsa_signatures コールでは、支払いページ 2.0 形式の必須のデジタル署名とトークンが生成され、返されます。生成された署名をクライアントに渡し、クライアントが支払いページ 2.0 にアクセスできるようにする必要があります。REST サービスは、支払いページ 2.0 を実装する場合にのみ使用する必要があります。

クレジットカードの偽装攻撃を防止するため、クライアント側のデジタル署名とトークンを発行する前に、支払いページをなりすましユーザーによるアクセスから保護してください。詳細は、「トークン発行を管理する」を参照してください。

この操作では、/v1/rsa-signatures エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Decrypt RSA signature

<mule-zuora-connector:create-v1-rsa-signatures-decrypt>

支払いページ 2.0 で使用する REST API は CORS (クロスオリジンリソース共有) 対応のため、デジタル署名を必要とします。rsa_signatures を使用して、支払いページ 2.0 形式の必須のデジタル署名とトークンを生成した後、decrypt REST サービスを使用して署名を復号化し、署名とキーを検証します。REST サービスは、支払いページ 2.0 を実装する場合にのみ使用する必要があります。

この操作では、/v1/rsa-signatures/decrypt エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create sequence sets

<mule-zuora-connector:create-v1-sequence-sets>

シーケンスセットを作成することで、請求ドキュメント、支払い、返金ごとにギャップのない番号付けシーケンスを設定できます。請求ドキュメントには、請求書、クレジットメモ、およびデビットメモがあります。1 つの要求で最大 100 件のシーケンスセットを作成できます。シーケンスセットは、生成する請求ドキュメントと作成する支払いや返金で使用されるカスタムプレフィックスと開始番号のセットで構成されます。制限についての詳細は、「請求ドキュメントのプレフィックスと番号付けの設定」を参照してください。

クレジットメモとデビットメモ機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作では、/v1/sequence-sets エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Create subscription

<mule-zuora-connector:create-v1-subscriptions>

この REST API リファレンスでは、既存の顧客アカウントの新しいサブスクリプションを作成する方法について説明します。

注意

請求書決済機能を有効にしている場合、zuora-version パラメーターを 211.0 以降に設定することがベストプラクティスです。追加しないと、エラーが生じます。invoiceCollect が true の場合、サブスクリプション、請求、支払のすべてが成功でない限り、このコールで success = true は返されません。

この API 操作では、保留中のサブスクリプションの作成はサポートされていません。

customerAcceptanceDate および serviceActivationDate のデフォルト値は次のように設定されます。

serviceActivationDate(SA) が指定されている

serviceActivationDate (SA) が指定されていない

customerAcceptanceDate (CA) が指定されている

SA は要求コールの値を使用します。CA は要求コールの値を使用します。

CA は要求コールの値を使用します。SA は CE をデフォルトとして使用します。

customerAcceptanceDate (CA) が指定されていない

SA は要求コールの値を使用します。CA は SA をデフォルトとして使用します。

SA と CA は CE をデフォルトとして使用します。

この操作では、/v1/subscriptions エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。このパラメーターを設定する必要があるのは、次の項目を使用する場合のみです。* invoice * collect * runBilling * targetDate

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Preview Subscription

<mule-zuora-connector:create-v1-subscriptions-preview>

この REST API リファレンスでは、プレビューモードで新しいサブスクリプションを作成する方法について説明します。このコールには有効な顧客アカウントは必要ありません。アカウントを作成する前に完全な詳細および料金を含むサブスクリプションのプレビューを新規の見込み客に表示するため、またはコミットする前に既存の顧客にすべての料金を含むサブスクリプションのプレビューをさせるために使用できます。

注意事項

Preview Subscription コールの応答は、リクエストヘッダーで設定した REST API マイナーバージョンに基づきます。使用しているマイナーバージョン番号が異なる場合、応答の構造が異なる場合があります。
請求書決済機能を有効にしている場合、zuora-version パラメーターを 207.0 以降に設定することをお勧めします。それ以外の場合、エラーが返されます。
customerAcceptanceDate および serviceActivationDate のデフォルト値は次のように設定されます。

serviceActivationDate(SA) が指定されている

serviceActivationDate (SA) が指定されていない

customerAcceptanceDate (CA) が指定されている

SA は要求コールの値を使用します。CA は要求コールの値を使用します。

CA は要求コールの値を使用します。SA は CE をデフォルトとして使用します。

customerAcceptanceDate (CA) が指定されていない

SA は要求コールの値を使用します。CA は SA をデフォルトとして使用します。

SA と CA は CE をデフォルトとして使用します。

この操作では、/v1/subscriptions/preview エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。このパラメーターを設定する必要があるのは、次の項目を使用する場合です。* targetDate * includeExistingDraftDocItems * previewType。請求書決済機能を有効にしている場合、このパラメーターを指定する必要があります。それ以外の場合、エラーが返されます。詳細は、[「Zuora REST API Versions (Zuora REST API バージョン)」](https://www.zuora.com/developer/api-reference/#section/API-Versions) を参照してください。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Post usage

<mule-zuora-connector:create-v1-usage>

この REST API リファレンスでは、1 つ以上のアカウントの使用状況データを CSV 形式で投稿またはインポートする方法について説明します。パスまたはクエリパラメーターはありません。データは HTTP multipart/form-data POST メソッドを使用してアップロードされ、ユーザーのテナントに適用されます。

この REST API コールのしくみ

アップロードされた使用状況ファイルのコンテンツは、UI インポートツールで使用する形式に従う必要があります。カンマ区切り (CSV) ファイルで、対応する .csv 拡張子を付ける必要があります。ファイル名の長さは 50 文字以内にする必要があります。ファイルサイズは 4MB 以内にする必要があります。使用状況ファイルテンプレートのダウンロード方法については、「使用量テンプレートのダウンロード」を参照してください。

アップロードが完了したら、ファイルのコンテンツが処理される前に、API によって、受信したファイルのバイト数およびインポートプロセスの状況を確認するための URL が含まれる応答が返されます。その URL に表示される可能性がある 5 つの結果 (Pending (保留中)、Processing (処理中)、Completed (完了)、Canceled (キャンセル)、Failed (失敗)) のうち、インポートが成功したことを示すのは Completed (完了) 状況のみです。

この操作はアトミックであるため、いずれかのレコードが失敗すると、ファイルは拒否されます。レコードが失敗した場合、インポート全体がロールバックされ、保存されているすべてのデータがその元の状態に戻されます。実際のインポート状況を表示するには、POSTMAN などのツールを使用して、checkImportStatus 応答からの結果の状況の URL を入力します。この追加手順により、インポートが失敗した理由に関する詳細が得られます。アップロードの成功後の情報を管理するには、Web ベースの UI を使用します。

使用状況ファイルの形式

使用状況ファイルでは次の見出しを使用します。

Heading 説明必須

ACCOUNT_ID

たとえばデフォルトのアカウント番号 (A00000001 など) やカスタムアカウント番号などのアカウント番号を入力します。この項目には Account_Id といラベルが付きますが、実際のアカウント ID やアカウント名ではありません。

はい

UOM

測定単位を入力します。これは、使用状況の測定単位に一致する必要があります。

はい

QTY

数量を入力します。

はい

STARTDATE

使用状況の開始日を入力します。この日付により、関連付けられた使用状況が請求される請求書項目のサービス期間が決まります。日付形式は現在のユーザーのロケールに基づきます。デフォルトの日付形式: MM/DD/YYYY。

はい

ENDDATE

使用状況の終了日を入力します。これは、使用状況の請求の計算には使用されず、省略可能です。日付形式は現在のユーザーのロケールに基づきます。デフォルトの日付形式: MM/DD/YYYY。注意: この列の値は省略可能ですが、列ヘッダーは必須です。

いいえ

SUBSCRIPTION_ID

サブスクリプション番号またはサブスクリプション名を入力します。Zuora アプリケーションでサブスクリプションを作成した場合、Zuora によって A-S00000001 のような形式で番号が自動的に作成されます。この項目の値を指定しない場合、関連付けられた使用状況がこの測定単位を使用する指定されたアカウントのすべてのサブスクリプションに追加されます。アカウントに複数のサブスクリプションを追加できるが、使用状況を 2 回または 3 回数えることを望まない場合、各使用状況レコードでサブスクリプションまたはチャージ ID を指定する必要があります。 注意: この列の値は省略可能ですが、列ヘッダーは必須です。

いいえ

CHARGE_ID

チャージ番号を入力します (チャージ名ではありません)。チャージ ID (C-00000001 など) は、料金プランをサブスクリプションに追加するときや個別のチャージを表示するときに確認できます。アカウントに複数のサブスクリプションを追加できるが、使用状況を 2 回または 3 回数えることを望まない場合、各使用状況レコードで特定のサブスクリプションまたはチャージ ID を指定する必要があります。この項目はサブスクリプション料金プランのチャージ番号に関連しています。 注意: この列の値は省略可能ですが、列ヘッダーは必須です。

いいえ

DESCRIPTION

チャージの説明を入力します。

いいえ

この操作では、/v1/usage エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

File Content (ファイルのコンテンツ)

String (文字列)

「File」部分のコンテンツ。

#[payload]

File Filename (ファイルのファイル名)

String (文字列)

「File」部分のファイル名 (ファイル名のみ、パスを含まない)。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Import a workflow

<mule-zuora-connector:create-workflows-import>

元のワークフローのエクスポートされた JSON ドキュメントを使用してワークフローのコピーが作成されます。この操作では、/workflows/import エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Run a workflow

<mule-zuora-connector:create-workflows-run-by-workflow-id>

指定されたワークフローを実行します。リクエストボディで、ワークフローに渡すパラメーターを含めることができます。ワークフローのタスクによって認識され、選択されるパラメーターについては、最初にパラメーターを定義する必要があります。パラメーターの定義方法については、[「Configure the settings of a workflow (ワークフローの設定の構成)」](https://knowledgecenter.zuora.com/CE_Workflow/Using_Workflow/B_Configure_a_Workflow) を参照してください。この操作では、/workflows/{workflow_id}/run エンドポイントに対する HTTP POST 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Workflow id (ワークフロー ID)

Number (数値)

実行するワークフローの ID。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Remove an event trigger

<mule-zuora-connector:delete-events-event-triggers-by-id>

イベントトリガーを削除します。この操作では、/events/event-triggers/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

id

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete an email template

<mule-zuora-connector:delete-notifications-email-templates-by-id>

メールテンプレートを削除します。この操作では、/notifications/email-templates/{id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

削除するメールテンプレートの ID。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。Zuora テナントで通知機能と設定可能イベント機能を有効にした後で、OAuth トークンを再生成する必要があります。これらの機能を有効にする前に生成された OAuth トークンは機能しません。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete a notification definition

<mule-zuora-connector:delete-notifications-notification-definitions-by-id>

通知定義を削除します。この操作では、/notifications/notification-definitions/{id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

削除する通知定義の ID。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。Zuora テナントで通知機能と設定可能イベント機能を有効にした後で、OAuth トークンを再生成する必要があります。これらの機能を有効にする前に生成された OAuth トークンは機能しません。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete custom object definition

<mule-zuora-connector:delete-objects-definitions-default-by-object>

指定された種別のカスタムオブジェクト定義を削除します。 注意: カスタムオブジェクト定義は、そのカスタムオブジェクト種別のレコードが存在しない場合にのみ削除できます。この操作では、/objects/definitions/default/{object} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

object

String (文字列)

カスタムオブジェクトの API 参照名をオブジェクトとして指定します。これは大文字と小文字が区別されます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Version (Zuora バージョン)

String (文字列)

応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで Zuora-Version を指定してください。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete custom object record

<mule-zuora-connector:delete-objects-records-default-by-object-id>

指定された種別と ID のカスタムオブジェクトレコードを削除します。次のいずれかの状況では 200 応答が返されます。

レコードが特定されて正常に削除された
レコードが見つからなかった。

正常に削除された場合は、レコードは直ちに削除され、復元することはできません。

この操作では、/objects/records/default/{object}/{id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

object

String (文字列)

カスタムオブジェクトの API 参照名をオブジェクトとして指定します。これは大文字と小文字が区別されます。

x

id

String (文字列)

uuid 形式の ID 識別子。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Version (Zuora バージョン)

String (文字列)

応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで Zuora-Version を指定してください。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Cancel data query job

<mule-zuora-connector:delete-query-jobs-by-job-id>

データクエリジョブをキャンセルし、Zuora によってクエリが実行されるのを防ぎます。この操作は、クエリジョブの状況が accepted または in_progress の場合のみ適用されます。

この操作では、/query/jobs/{job-id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Job id (ジョブ ID)

String (文字列)

クエリジョブの内部識別子。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete Accounting Code

<mule-zuora-connector:delete-v1-accounting-codes-by-ac-id>

この操作では、/v1/accounting-codes/{ac-id} エンドポイントに対する HTTP DELETE 要求を行います。

このリファレンスでは、REST API を使用して勘定コードを削除する方法について説明します。

始める前に

テナントで Zuora Finance を有効にしている場合、「Delete Unused Accounting Code (未使用の勘定コードの削除)」権限が必要です。

制限事項

削除できるのは、トランザクションに関連付けられたことがない勘定コードのみです。勘定コードは、削除する前に無効化する必要があります。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ac id (Ac ID)

String (文字列)

削除する勘定コードの ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete accounting period

<mule-zuora-connector:delete-v1-accounting-periods-by-ap-id>

会計期間を削除します。この操作では、/v1/accounting-periods/{ap-id} エンドポイントに対する HTTP DELETE 要求を行います。

始める前に

Zuora Finance をテナントで有効にしている必要があります。
「Delete Accounting Period (会計期間の削除)」ユーザー権限が必要です。
「会計・経理ロール」を参照してください。

制限事項

削除する会計期間は、次の条件に従う必要があります。

直近の会計期間である
終了していない会計期間である
分配された収益がない
アクティブなジャーナルエントリがない
終了が決まっていない会計期間ではない
試算表の実行中ではない

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ap id (Ap ID)

String (文字列)

削除するアカウンティング期間の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete attachments

<mule-zuora-connector:delete-v1-attachments-by-attachment-id>

Delete Attachment REST 要求を使用して、Zuora オブジェクトから添付ファイルを削除します。この操作では、/v1/attachments/{attachment-id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Attachment id (アタッチメント ID)

String (文字列)

削除する添付ファイルの ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete credit memo

<mule-zuora-connector:delete-v1-creditmemos-by-credit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。クレジットメモを削除します。削除できるのは、状況が [Cancelled (キャンセル)] のクレジットメモのみです。クレジットメモは、ユーザー権限を持っている場合のみ削除できます。詳細は、[「Billing Roles (請求ロール)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) を参照してください。この操作では、/v1/creditmemos/{creditMemoId} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete debit memo

<mule-zuora-connector:delete-v1-debitmemos-by-debit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。デビットメモを削除します。削除できるのは、状況が [Cancelled (キャンセル)] のデビットメモのみです。デビットメモは、ユーザー権限を持っている場合のみ削除できます。詳細は、[「Billing Roles (請求ロール)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) を参照してください。この操作では、/v1/debitmemos/{debitMemoId} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Debit Memo Id (デビットメモ ID)

String (文字列)

デビットメモの一意の ID。例: 8a8082e65b27f6c3015ba419f3c2644e。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete document properties

<mule-zuora-connector:delete-v1-document-properties-by-document-properties-id>

注意: この機能は、請求ドキュメントプロパティセットアップ機能を有効にしている場合のみ使用できます。請求ドキュメントプロパティのセットアップ機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。請求ドキュメントの特定の ID を持つドキュメントプロパティを削除します。請求ドキュメントには、請求書、クレジットメモ、およびデビットメモがあります。 注意: クレジットメモおよびデビットメモのドキュメントプロパティは、請求書決済機能を有効にしている場合のみ削除できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。この操作では、/v1/document-properties/{documentPropertiesId} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Document Properties Id (ドキュメントプロパティ ID)

String (文字列)

ドキュメントプロパティの一意の ID。例: 402892c74c9193cd014c96bbe7c101f9。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Delete Entity

<mule-zuora-connector:delete-v1-entities-by-id>

注意: Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作は、マルチエンティティ階層からエンティティおよびそのサブエンティティを削除します。削除できるのは、プロビジョニングされていないエンティティのみです。プロビジョニングされたエンティティを削除すると、エラーが発生します。

ユーザーアクセス権限

グローバルエンティティのシステム管理者としてコールを実行する必要があります。

この操作では、/v1/entities/{id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

削除するエンティティの ID を指定します。エンティティ ID は GET Entities コールから取得できます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete summary journal entry

<mule-zuora-connector:delete-v1-journal-entries-by-je-number>

このリファレンスでは、REST API を使用してサマリージャーナルエントリを削除する方法について説明します。サマリージャーナルエントリを削除するには、「Delete Cancelled Journal Entry (キャンセルされたジャーナルエントリの削除)」ユーザー権限が必要です。サマリージャーナルエントリは、削除する前にキャンセルする必要があります。この操作では、/v1/journal-entries/{je-number} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Je number (Je 番号)

String (文字列)

JE-00000001 の形式のジャーナルエントリ番号。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete journal run

<mule-zuora-connector:delete-v1-journal-runs-by-jr-number>

このリファレンスでは、REST API を使用してジャーナル実行を削除する方法について説明します。削除できるのは、すでにキャンセルされているジャーナル実行のみです。ジャーナル実行を削除するには、「Delete Cancelled Journal Run (キャンセルされたジャーナル実行の削除)」 Zuora Finance ユーザー権限が必要です。この操作では、/v1/journal-runs/{jr-number} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Jr number (Jr 番号)

String (文字列)

ジャーナル実行番号。JR-00000001 の形式の有効なジャーナル実行番号である必要があります。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete account

<mule-zuora-connector:delete-v1-object-account-by-id>

特定のアカウントを非同期で削除します。 Note: [注文](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) が有効である場合は、顧客アカウントを削除する前に、このアカウントがサブスクリプションまたは請求書のオーナーとして参照されているすべての関連注文と関連サブスクリプションを削除する必要があります。この操作では、/v1/object/account/{id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete amendment

<mule-zuora-connector:delete-v1-object-amendment-by-id>

請求書に記載された修正は通常削除できません。このルールの例外の 1 つは、自動更新修正です。請求書が生成されている場合であっても、前回の自動更新修正は削除できます。この操作では、/v1/object/amendment/{id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete bill run

<mule-zuora-connector:delete-v1-object-bill-run-by-id>

注意: この機能は使用制限されています。この機能にアクセスしたい場合は、Zuora グローバルサポートに要求を送信してください。請求実行を削除する場合、ロジックは UI を使用して請求実行を削除する場合と同じです。唯一の必須パラメーターは BillRunId です。請求実行を削除するには、請求実行の状況が Canceled である必要があります。この操作では、/v1/object/bill-run/{id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete contact

<mule-zuora-connector:delete-v1-object-contact-by-id>

取引先責任者を削除します。この操作では、/v1/object/contact/{id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete Feature

<mule-zuora-connector:delete-v1-object-feature-by-id>

CRUD: Delete Feature。この操作では、/v1/object/feature/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete InvoiceAdjustment

<mule-zuora-connector:delete-v1-object-invoice-adjustment-by-id>

CRUD: Delete InvoiceAdjustment。この操作では、/v1/object/invoice-adjustment/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete invoice

<mule-zuora-connector:delete-v1-object-invoice-by-id>

CRUD: Delete invoice。この操作では、/v1/object/invoice/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete InvoiceItemAdjustment

<mule-zuora-connector:delete-v1-object-invoice-item-adjustment-by-id>

この CRUD 操作では、/v1/object/invoice-item-adjustment/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete payment

<mule-zuora-connector:delete-v1-object-payment-by-id>

支払を削除します。削除できるのは、状況が [Cancelled (キャンセル)] の支払のみです。この操作では、/v1/object/payment/{id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

削除する支払の一意の ID。例: 2c92c0f85d4e95ae015d4f7e5d690622。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete payment method

<mule-zuora-connector:delete-v1-object-payment-method-by-id>

CRUD: Delete payment method。この操作では、/v1/object/payment-method/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete Product

<mule-zuora-connector:delete-v1-object-product-by-id>

CRUD: Delete Product。この操作では、/v1/object/product/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete ProductFeature

<mule-zuora-connector:delete-v1-object-product-feature-by-id>

CRUD: Delete ProductFeature。この操作では、/v1/object/product-feature/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete ProductRatePlan

<mule-zuora-connector:delete-v1-object-product-rate-plan-by-id>

CRUD: Delete ProductRatePlan。この操作では、/v1/object/product-rate-plan/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete product rate plan charge

<mule-zuora-connector:delete-v1-object-product-rate-plan-charge-by-id>

製品料金プランチャージを削除します。この操作では、/v1/object/product-rate-plan-charge/{id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

削除する製品料金プランチャージの一意の ID。例: 2c93808457d787030157e031fcd34e19。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete refund

<mule-zuora-connector:delete-v1-object-refund-by-id>

CRUD: Delete refund。この操作では、/v1/object/refund/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete Subscription

<mule-zuora-connector:delete-v1-object-subscription-by-id>

CRUD: Delete Subscription。この操作では、/v1/object/subscription/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete TaxationItem

<mule-zuora-connector:delete-v1-object-taxation-item-by-id>

CRUD: Delete TaxationItem。この操作では、/v1/object/taxation-item/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete UnitOfMeasure

<mule-zuora-connector:delete-v1-object-unit-of-measure-by-id>

CRUD: Delete UnitOfMeasure。この操作では、/v1/object/unit-of-measure/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Delete usage

<mule-zuora-connector:delete-v1-object-usage-by-id>

CRUD: Delete usage。この操作では、/v1/object/usage/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete Order

<mule-zuora-connector:delete-v1-orders-by-order-number>

この操作は、指定された注文を削除します。この注文によって変更されるすべてのサブスクリプションが削除されます。削除後、サブスクリプションは以前のバージョンに戻ります。この注文によって発生している料金が請求中である場合は、注文を削除することはできません。この操作では、/v1/orders/{orderNumber} エンドポイントに対する HTTP DELETE 要求を行います。

注意: この操作は、注文機能を有効にしている場合にのみ使用できます。

注文への移行は使用制限されています。正式リリースの前に、小規模の早期導入ユーザーからのフィードバックが積極的に求められています。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Order Number (注文番号)

String (文字列)

削除する注文の番号。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete payment method

<mule-zuora-connector:delete-v1-payment-methods-by-payment-method-id>

指定された顧客アカウントからクレジットカード支払方法を削除します。指定された支払方法がアカウントのデフォルトの支払方法である場合、要求に失敗します。その場合、最初にその顧客の別の支払方法をデフォルトに指定する必要があります。この操作では、/v1/payment-methods/{payment-method-id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment method id (支払い方法 ID)

String (文字列)

支払方法の一意の識別子。(この ID は一意であり、システムの顧客アカウントにリンクされているため、顧客の識別子は必要ありません)。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete payment run

<mule-zuora-connector:delete-v1-payment-runs-by-payment-run-id>

支払実行を削除します。削除できるのは、状況が [Cancelled (キャンセル)] または [Error (エラー)] の支払実行のみです。この操作では、/v1/payment-runs/{paymentRunId} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment Run Id (支払い実行 ID)

String (文字列)

支払実行の一意の ID。例: 402890245f097f39015f0f074a2e0566。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete payment

<mule-zuora-connector:delete-v1-payments-by-payment-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。支払を削除します。削除できるのは、状況が [Cancelled (キャンセル)] の支払のみです。請求書決済機能を有効にしている場合、クレジット残高に適用される支払超過は削除できません。この操作では、/v1/payments/{paymentId} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment Id (支払い ID)

String (文字列)

未適用の支払いの一意の ID。例: 8a8082e65b27f6c3015b89e4344c16b1。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete refund

<mule-zuora-connector:delete-v1-refunds-by-refund-id>

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。払い戻しを削除します。状況が [Canceled (キャンセル)] または [Error (エラー)] の払い戻しを削除できます。請求書決済機能を有効にしている場合、クレジット残高に適用される払い戻しは削除できません。この操作では、/v1/refunds/{refundId} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Refund Id (払い戻し ID)

String (文字列)

払い戻しの一意の ID。例: 4028905f5a87c0ff015a889e590e00c9。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete revenue schedule

<mule-zuora-connector:delete-v1-revenue-schedules-by-rs-number>

その収益スケジュール番号を指定して収益スケジュールを削除します。## 前提条件 Zuora Finance の「Delete Custom Revenue Schedule (カスタム収益スケジュールの削除)」権限が必要です。この操作では、/v1/revenue-schedules/{rs-number} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Rs number (Rs 番号)

String (文字列)

削除する収益スケジュールの収益スケジュール番号。例: RS-00000256。収益スケジュールを削除するには、次の条件を満たしている必要があります。* カスタムの無制限の認識ルールを使用している。 *クローズ済みのアカウンティング期間に収益がない。 *サマリージャーナルエントリに含まれていない。 *クローズ済みのアカウンティング期間に収益スケジュール日がない。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete sequence set

<mule-zuora-connector:delete-v1-sequence-sets-by-id>

請求ドキュメント、支払い、返金に対して設定されている特定のシーケンスセットを削除します。請求ドキュメントには、請求書、クレジットメモ、およびデビットメモがあります。 注意: クレジットメモとデビットメモ機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。この操作では、/v1/sequence-sets/{id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

削除するシーケンスセットの ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete taxation item

<mule-zuora-connector:delete-v1-taxationitems-by-id>

ID を基準に特定の課税項目を削除します。この操作では、/v1/taxationitems/{id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

課税項目の一意の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Delete a workflow by ID

<mule-zuora-connector:delete-workflows-by-workflow-id>

その ID を基準に特定のワークフローを削除します。この操作では、/workflows/{workflow_id} エンドポイントに対する HTTP DELETE 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Workflow id (ワークフロー ID)

String (文字列)

ワークフローの一意の ID。たとえば、19080 です。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Query event triggers

<mule-zuora-connector:get-events-event-triggers>

イベントトリガーを照会します。この操作では、/events/event-triggers エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Event Type Name (イベント種別名)

String (文字列)

イベント種別名。次のパターンで指定する必要があります。^[A-Za-z]{1,}[\w\-]*$

Base Object (ベースオブジェクト)

String (文字列)

トリガー条件が定義されている Zuora オブジェクト。次のパターンで指定する必要があります: ^[A-Z][\\w\\-]*$

start (開始)

Number (数値)

クエリ結果の最初のインデックス。指定しない場合のデフォルトは 0、最小は 0 です。

0

limit (制限)

Number (数値)

返されるデータレコードの最大数。指定しない場合のデフォルトは 10 です。

10

active (アクティブ)

String (文字列)

イベントトリガーの状況。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get an event trigger by ID

<mule-zuora-connector:get-events-event-triggers-by-id>

イベントトリガーを ID で取得します。この操作では、/events/event-triggers/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

id

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Query email templates

<mule-zuora-connector:get-notifications-email-templates>

メールテンプレートを照会します。この操作では、/notifications/email-templates エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

start (開始)

Number (数値)

クエリ結果の最初のインデックス。

1

limit (制限)

Number (数値)

クエリが返す結果の最大数。

20

Event Type Name (イベント種別名)

String (文字列)

イベントの名前。

name (名前)

String (文字列)

メールテンプレートの名前。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。Zuora テナントで通知機能と設定可能イベント機能を有効にした後で、OAuth トークンを再生成する必要があります。これらの機能を有効にする前に生成された OAuth トークンは機能しません。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get an email template

<mule-zuora-connector:get-notifications-email-templates-by-id>

指定された ID のメールテンプレートを照会します。この操作では、/notifications/email-templates/{id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

メールテンプレートの ID。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。Zuora テナントで通知機能と設定可能イベント機能を有効にした後で、OAuth トークンを再生成する必要があります。これらの機能を有効にする前に生成された OAuth トークンは機能しません。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Query notification definitions

<mule-zuora-connector:get-notifications-notification-definitions>

指定された検索条件の通知定義を照会します。この操作では、/notifications/notification-definitions エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Profile Id (プロファイル ID)

String (文字列)

プロファイルの ID。

Event Type Name (イベント種別名)

String (文字列)

イベントの名前。

start (開始)

Number (数値)

クエリ結果の最初のインデックス。

1

limit (制限)

Number (数値)

クエリが返す結果の最大数。

20

Email Template Id (メールテンプレート ID)

String (文字列)

メールテンプレートの ID。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。Zuora テナントで通知機能と設定可能イベント機能を有効にした後で、OAuth トークンを再生成する必要があります。これらの機能を有効にする前に生成された OAuth トークンは機能しません。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get a notification definition

<mule-zuora-connector:get-notifications-notification-definitions-by-id>

指定された ID の通知定義を照会します。この操作では、/notifications/notification-definitions/{id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

通知定義の ID。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。Zuora テナントで通知機能と設定可能イベント機能を有効にした後で、OAuth トークンを再生成する必要があります。これらの機能を有効にする前に生成された OAuth トークンは機能しません。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get all custom object definitions

<mule-zuora-connector:get-objects-definitions-default>

Get all custom object definitions。この操作では、/objects/definitions/default/ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

選択

Enumeration (列挙)。次のいずれかになります。

TYPE

select を type に設定した場合、応答には各カスタムオブジェクトの type のみが含まれます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Version (Zuora バージョン)

String (文字列)

応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで Zuora-Version を指定してください。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get custom object definition

<mule-zuora-connector:get-objects-definitions-default-by-object>

指定されたテナントのカスタムオブジェクト定義を種別ごとに取得します。この操作では、/objects/definitions/default/{object} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

object

String (文字列)

カスタムオブジェクトの API 参照名をオブジェクトとして指定します。これは大文字と小文字が区別されます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Version (Zuora バージョン)

String (文字列)

応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで Zuora-Version を指定してください。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Query custom object records

<mule-zuora-connector:get-objects-records-default-by-object>

指定された種別のカスタムオブジェクトをすべて取得します。q クエリパラメーターを使用して、出力されるレコードを絞り込むこともできます。## 制限このコールには次の制限があります。* レコードの作成後、そのレコードを検索できるようになるまでには少し時間が掛かります。たとえば、5 件のレコードを作成した後に、ある程度の時間が経過しないと、それらの 5 件が満足する条件でクエリを実行しても、クエリ結果にはそれらのレコードは返されません。この操作では、/objects/records/default/{object} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

object

String (文字列)

カスタムオブジェクトの API 参照名をオブジェクトとして指定します。これは大文字と小文字が区別されます。

x

q

String (文字列)

カスタムオブジェクトのレコードを絞り込むためのクエリ文字列。詳細は、[「Query syntax of custom object records (カスタムオブジェクトレコードのクエリ構文)」](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Data_Model/Custom_object_records/Query_syntax_of_custom_object_records) を参照してください。

ids (ID)

String (文字列)

照会するレコードの UUID。例: GET /objects/records/default/passenger?ids=258d65b2-7bc6-4142-88bc-5184931af493&ids=82ecc9f7-b192-4f88-a4a3-4b2af6c750a1

Page Size (ページサイズ)

Number (数値)

ページのサイズ。値は 1 ～ 1000 である必要があります。

cursor (カーソル)

String (文字列)

cursor は、前回の結果セットの最後のレコードを参照します。cursor レコードは、クエリ結果には含まれません。cursor が指定されず、pageSize が有効である場合、コールでは最初のページが返されます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Version (Zuora バージョン)

String (文字列)

応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで Zuora-Version を指定してください。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get custom object record

<mule-zuora-connector:get-objects-records-default-by-object-id>

指定された種別のレコードを ID で取得します。この操作では、/objects/records/default/{object}/{id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

object

String (文字列)

カスタムオブジェクトの API 参照名をオブジェクトとして指定します。これは大文字と小文字が区別されます。

x

id

String (文字列)

uuid 形式の ID 識別子。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Version (Zuora バージョン)

String (文字列)

応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで Zuora-Version を指定してください。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get data query jobs

<mule-zuora-connector:get-query-jobs>

Zuora テナントで作成された[データクエリ](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) ジョブのリストを返します。リストを状況で絞り込むことができます。管理者であれば、テナントのすべてのクエリジョブを取得できます。そうでなければ、自分自身のクエリジョブのみを取得できます。この操作では、/query/jobs エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Query Status (クエリ状況)

Enumeration (列挙)。次のいずれかになります。

ACCEPTED
IN_PROGRESS
COMPLETED
FAILED
CANCELLED

クエリジョブのリストを状況で絞り込みます。

Page Size (ページサイズ)

Number (数値)

返すクエリジョブの最大数を指定します。

20

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get data query job

<mule-zuora-connector:get-query-jobs-by-job-id>

[データクエリ](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) ジョブを取得します。この操作を使用して、クエリジョブの状況を追跡してクエリ結果の URL を取得できます。管理者であれば、テナントのすべてのクエリジョブを取得できます。管理者以外のユーザーが、自分がオーナーではないクエリジョブを取得しようとすると、403 応答が返され、そのジョブの表示が禁止されていることが示されます。管理者以外のユーザーは、自分自身のクエリジョブのみを取得できます。この操作では、/query/jobs/{job-id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Job id (ジョブ ID)

String (文字列)

クエリジョブの内部識別子。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

List all settings

<mule-zuora-connector:get-settings-listing>

テナントで使用可能なすべての設定のリストを取得します。

応答メッセージは、デフォルトでは JSON 形式です。使用可能なすべての設定を CSV 形式で受け取るには、ヘッダーのパラメーターに Accept を含めて application/csv に設定してください。

自分のテナントで使用可能な設定項目の特定の操作は、このコールの 200 レスポンスボディに示されています。

特定の設定項目の使い方は、以下の設定 API のチュートリアルを参照してください。

この操作では、/settings/listing エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get all Accounting Codes

<mule-zuora-connector:get-v1-accounting-codes>

このリファレンスでは、REST API を使用してアカウントのチャートですべての勘定コードを照会する方法について説明します。この操作では、/v1/accounting-codes エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

300

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Query an Accounting Code

<mule-zuora-connector:get-v1-accounting-codes-by-ac-id>

このリファレンスでは、REST API を使用して勘定コードを照会する方法について説明します。この操作では、/v1/accounting-codes/{ac-id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ac id (Ac ID)

String (文字列)

照会する勘定コードの ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get all accounting periods

<mule-zuora-connector:get-v1-accounting-periods>

テナントですべての会計期間を取得します。この操作では、/v1/accounting-periods エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

300

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get accounting period

<mule-zuora-connector:get-v1-accounting-periods-by-ap-id>

会計期間を取得します。この操作では、/v1/accounting-periods/{ap-id} エンドポイントに対する HTTP GET 要求を行います。

始める前に

Zuora Finance をテナントで有効にしている必要があります。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ap id (Ap ID)

String (文字列)

取得する会計期間の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get job of hard deleting billing document files

<mule-zuora-connector:get-v1-accounts-billing-documents-files-deletion-jobs-by-job-id>

特定のアカウントのすべての請求ドキュメント PDF ファイルを永久に削除する非同期ジョブに関する情報を取得します。注意: この操作は、請求ユーザー権限「Hard Delete Billing Document Files (請求ドキュメントファイルの物理削除)」を有効にしている場合のみ使用できます。この操作では、/v1/accounts/billing-documents/files/deletion-jobs/{jobId} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Job id (ジョブ ID)

String (文字列)

請求ドキュメントファイル削除ジョブの一意の ID。例: 2c92c8f83dc4f752013dc72c24ee016c。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get account

<mule-zuora-connector:get-v1-accounts-by-account-key>

顧客アカウントに関する基本情報を取得します。この操作は簡易取得であり、アカウントのサブスクリプション、請求書、支払、または使用状況の詳細は含まれません。アカウントに関する詳細情報を取得するには、Get account summary を使用します。この操作では、/v1/accounts/{account-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account key (アカウントキー)

String (文字列)

アカウント番号またはアカウント ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get account summary

<mule-zuora-connector:get-v1-accounts-summary-by-account-key>

指定された顧客アカウントに関する詳細情報を取得します。応答にはアカウント情報と、アカウントのサブスクリプション、請求書、支払、および最近更新された 6 件のサブスクリプションの使用状況のサマリーが含まれます。## 注意: サブスクリプションの updatedDate に基づいて直近の 6 件のサブスクリプションのみを返します。これらのサブスクリプション内に、多数の料金プランおよび料金プランチャージがある可能性があります。これらの項目は、配列サイズの上限の影響を受けます。この操作では、/v1/accounts/{account-key}/summary エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account key (アカウントキー)

String (文字列)

アカウント番号またはアカウント ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get amendments by key

<mule-zuora-connector:get-v1-amendments-by-amendment-key>

指定されたサブスクリプション修正に関する詳細情報を取得します。この操作では、/v1/amendments/{amendment-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Amendment key (修正キー)

String (文字列)

修正 ID または修正コードを使用できます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get amendments by subscription ID

<mule-zuora-connector:get-v1-amendments-subscriptions-by-subscription-id>

指定されたサブスクリプションを含む修正に関する詳細情報を取得します。この操作では、/v1/amendments/subscriptions/{subscription-id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription id (サブスクリプション ID)

String (文字列)

修正変更を取得するサブスクリプションの ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get job status and response

<mule-zuora-connector:get-v1-async-jobs-by-job-id>

注意: この操作は、[注文](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) 機能を有効にしている場合にのみ使用できます。この操作は使用制限されています。非同期ジョブの状況と応答を取得します。現在のところ、「Create order asynchronously」または「Preview order asynchronously」によって作成された非同期ジョブがサポートされています。この操作では、/v1/async-jobs/{jobId} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Job id (ジョブ ID)

String (文字列)

非同期 API 操作によって作成された非同期ジョブの UUID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

View attachments

<mule-zuora-connector:get-v1-attachments-by-attachment-id>

View Attachment REST 要求を使用して、添付ファイルドキュメントに関する情報を取得します。この操作では、/v1/attachments/{attachment-id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Attachment id (アタッチメント ID)

String (文字列)

表示する添付ファイルの ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

View attachments list

<mule-zuora-connector:get-v1-attachments-by-object-type-object-key>

View Attachment REST 要求を使用して、アカウント、請求書、またはサブスクリプションの添付ファイルのリストを取得します。この操作では、/v1/attachments/{object-type}/{object-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Object type (オブジェクト種別)

Enumeration (列挙)。次のいずれかになります。

ACCOUNT
INVOICE
SUBSCRIPTION (サブスクリプション)

添付ファイルをリストするオブジェクトの種別。

x

Object key (オブジェクトキー)

String (文字列)

添付ファイルをリストするオブジェクトの ID。- object-type が account の場合、アカウント ID を指定します。- object-type が invoice の場合、請求書 ID を指定します。- object-type が subscription の場合、サブスクリプション番号を指定します。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get billing documents

<mule-zuora-connector:get-v1-billing-documents>

指定されたアカウントに関連付けられたすべての請求ドキュメントに関する情報を取得します。請求ドキュメントには、請求書、クレジットメモ、デビットメモが含まれます。クレジットメモおよびデビットメモに関する情報を取得するには、請求書決済機能を有効にしている必要があります。クエリパラメーターを使用して、応答で返されるデータを制限できます。例: - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&sort=+documentDate - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&status=Posted。この操作では、/v1/billing-documents エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account Id (アカウント ID)

String (文字列)

請求ドキュメントが関連付けられている顧客アカウントの ID。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

status (状況)

Enumeration (列挙)。次のいずれかになります。

DRAFT
POSTED (転記済み)
CANCELED
ERROR

請求ドキュメントの状況。

Document Date (ドキュメント日付)

String (文字列)

請求ドキュメントの日付。請求書の請求日、クレジットメモのクレジットメモ日、デビットメモのデビットメモ日を表します。

sort (並び替え)

String (文字列)

このパラメーターにより、応答で返されるデータの順序が制限されます。このパラメーターを使用して、並べ替える次元を指定できます。並び替え可能な項目を指定しない場合、応答データは documentDate 項目によって降順で並び替えられます。ソート可能な項目は次の形式になります: operator field_name 1 つの URL パスで使用できるソート可能な項目は最大 2 つです。ソート可能な項目を区切るにはカンマを使用します。例: operator field_name, operator field_name operator はシーケンスの順序をマークするために使用します。オペレーターは省略可能です。オペレーターを付けずに並び替え可能な項目のみを指定した場合、応答データはこの項目によって降順で並び替えられます。- - オペレーターは昇順を示します。- + オペレーターは降順を示します。 field_name はソート可能な項目の名前を示します。この操作のサポートされる並び替え可能な項目は次のとおりです: - documentDate - documentType。例: - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1 &sort=+documentDate,-documentType - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1 &status=Posted&sort=+documentDate&page=2&pageSize=15

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get Billing Preview Run

<mule-zuora-connector:get-v1-billing-preview-runs-by-billing-preview-run-id>

注意: この機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。請求プレビュー実行を介して複数の顧客アカウントの将来の請求書項目のプレビューを取得します。請求書決済機能を有効にしている場合、将来のクレジットメモ項目のプレビューも取得できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。請求プレビュー実行により、顧客アカウントのバッチの請求書項目データおよびクレジットメモ項目データのプレビューが含まれるダウンロード可能な CSV ファイルが非同期で生成されます。この操作では、/v1/billing-preview-runs/{billingPreviewRunId} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Billing Preview Run Id (請求プレビュー実行 ID)

String (文字列)

請求書プレビュー実行の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get mass action result

<mule-zuora-connector:get-v1-bulk-by-bulk-key>

このリファレンスでは、REST API を使用してマスアクションの結果に関する情報を取得する方法について説明します。この操作では、/v1/bulk/{bulk-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Bulk key (バルクキー)

String (文字列)

マスアクションを識別する 32 文字の文字列。バルクキーは REST API を使用してマスアクションを実行した後で取得します。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get product

<mule-zuora-connector:get-v1-catalog-product-by-product-id>

その製品料金プランおよびチャージに関する情報を含めて、特定の製品に関する詳細情報を取得します。この操作では、/v1/catalog/product/{product-id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Product id (製品 ID)

String (文字列)

取得する製品の一意の ID。例: 8a808255575bdae4015774e9602e16fe。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。このパラメーターを設定する必要があるのは、productRatePlans 項目を使用する場合のみです。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get Product Catalog

<mule-zuora-connector:get-v1-catalog-products>

すべての製品、機能、および対応する製品料金プラン、チャージを含めて、製品カタログ全体を取得します。製品は UpdatedDate 項目で新しいものから順に返されます。製品料金プランおよび料金プランチャージにより、REST API は配列サイズが最大になります。この操作では、/v1/catalog/products エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

10

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。このパラメーターを設定する必要があるのは、productRatePlans 項目を使用する場合のみです。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get charge summary details by CRS number

<mule-zuora-connector:get-v1-charge-revenue-summaries-by-crs-number>

この REST API リファレンスでは、チャージ収益サマリー番号を指定してチャージ収益サマリーの詳細を取得する方法について説明します。応答には、チャージ収益サマリーに関連付けられたすべての収益項目が含まれます。この操作では、/v1/charge-revenue-summaries/{crs-number} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Crs number (Crs 番号)

String (文字列)

チャージ収益サマリー番号。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get charge summary details by charge ID

<mule-zuora-connector:get-v1-charge-revenue-summaries-subscription-charges-by-charge-key>

この REST API リファレンスでは、サブスクリプションチャージ ID を指定してチャージ収益サマリーの詳細を取得する方法について説明します。この応答では、チャージ収益サマリーに関連付けられたすべての収益項目を取得します。この操作では、/v1/charge-revenue-summaries/subscription-charges/{charge-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Charge key (チャージキー)

String (文字列)

サブスクリプション料金プランチャージの ID。例: 402892793e173340013e173b81000012。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get Credit Memos

<mule-zuora-connector:get-v1-creditmemos>

すべてのクレジットメモに関する情報を取得します。

請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

絞り込み

クエリパラメーターを使用して、応答で返されるデータを制限できます。各クエリパラメーターはレスポンスボディの 1 つの項目に対応しています。絞り込み可能な項目の値が文字列の場合、絞り込むときに対応するクエリパラメーターを null に設定します。この場合、この項目値が null の応答データを取得できます。

例:

/v1/creditmemos?status=Processed
/v1/creditmemos?referredInvoiceId=null&status=Draft
/v1/creditmemos?status=Processed&type=External&sort=+number

この操作では、/v1/creditmemos エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Auto Apply Upon Posting (投稿時に自動適用)

Boolean (ブール)

このパラメーターは autoApplyUponPosting 項目に基づいて応答を絞り込みます。

false

Target Date (対象日付)

String (文字列)

このパラメーターは targetDate 項目に基づいて応答を絞り込みます。

Unapplied Amount (適用されない額)

Number (数値)

このパラメーターは unappliedAmount 項目に基づいて応答を絞り込みます。

number (数値)

String (文字列)

このパラメーターは number 項目に基づいて応答を絞り込みます。

Created By Id (作成者 ID)

String (文字列)

このパラメーターは createdById 項目に基づいて応答を絞り込みます。

Referred Invoice Id (参照される請求書 ID)

String (文字列)

このパラメーターは referredInvoiceId 項目に基づいて応答を絞り込みます。

Transferred To Accounting (会計に振り替え済み)

Enumeration (列挙)。次のいずれかになります。

PROCESSING
YES
NO
ERROR
IGNORE

このパラメーターは transferredToAccounting 項目に基づいて応答を絞り込みます。

Applied Amount (適用される額)

Number (数値)

このパラメーターは appliedAmount 項目に基づいて応答を絞り込みます。

Account Id (アカウント ID)

String (文字列)

このパラメーターは accountId 項目に基づいて応答を絞り込みます。

amount (金額)

Number (数値)

このパラメーターは amount 項目に基づいて応答を絞り込みます。

Tax Amount (税額)

Number (数値)

このパラメーターは taxAmount 項目に基づいて応答を絞り込みます。

Exclude From Auto Apply Rules (自動適用ルールから除外)

Boolean (ブール)

このパラメーターは excludeFromAutoApplyRules 項目に基づいて応答を絞り込みます。

false

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

status (状況)

Enumeration (列挙)。次のいずれかになります。

DRAFT
POSTED
CANCELED
ERROR
PENDING_FOR_TAX
GENERATING (生成中)
CANCEL_IN_PROGRESS

このパラメーターは status 項目に基づいて応答を絞り込みます。

currency (通貨)

String (文字列)

このパラメーターは currency 項目に基づいて応答を絞り込みます。

Refund Amount (払い戻し額)

Number (数値)

このパラメーターは refundAmount 項目に基づいて応答を絞り込みます。

Updated By Id (更新者 ID)

String (文字列)

このパラメーターは updatedById 項目に基づいて応答を絞り込みます。

Credit Memo Date (クレジットメモ日)

String (文字列)

このパラメーターは creditMemoDate 項目に基づいて応答を絞り込みます。

sort (並び替え)

String (文字列)

このパラメーターにより、応答で返されるデータの順序が制限されます。このパラメーターを使用して、並べ替える次元を指定できます。ソート可能な項目は次の形式になります: operator field_name 1 つの URL パスで使用できるソート可能な項目は最大 2 つです。ソート可能な項目を区切るにはカンマを使用します。例: operator field_name, operator field_name operator はシーケンスの順序をマークするために使用します。オペレーターは省略可能です。オペレーターを付けずに並び替え可能な項目のみを指定した場合、応答データはこの項目によって降順で並び替えられます。- - オペレーターは昇順を示します。- + オペレーターは降順を示します。デフォルトでは、応答データはクレジットメモ番号によって降順で表示されます。 field_name はソート可能な項目の名前を示します。この操作のサポートされる並び替え可能な項目は次のとおりです: - accountId - amount - appliedAmount - createdById - createdDate - creditMemoDate - number - referredInvoiceId - refundAmount - status - targetDate - taxAmount - totalTaxExemptAmount - transferredToAccounting - unappliedAmount - updatedDate。例: - /v1/creditmemos?sort=+number - /v1/creditmemos?status=Processed&sort=-number,+amount

Total Tax Exempt Amount (合計税金控除額)

Number (数値)

このパラメーターは totalTaxExemptAmount 項目に基づいて応答を絞り込みます。

Updated (更新日)

String (文字列)

このパラメーターは updatedDate 項目に基づいて応答を絞り込みます。

Created Date (作成日)

String (文字列)

このパラメーターは createdDate 項目に基づいて応答を絞り込みます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get credit memo

<mule-zuora-connector:get-v1-creditmemos-by-credit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。特定のクレジットメモに関する情報を取得します。この操作では、/v1/creditmemos/{creditMemoId} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get credit Memo Items

<mule-zuora-connector:get-v1-creditmemos-items-by-credit-memo-id>

請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。クレジットメモのすべての項目に関する情報を取得します。クレジットメモ項目とは、クレジットメモの 1 つの品目です。

絞り込み

クエリパラメーターを使用して、応答で返されるデータを制限できます。各クエリパラメーターはレスポンスボディの 1 つの項目に対応しています。絞り込み可能な項目の値が文字列の場合、絞り込むときに対応するクエリパラメーターを null に設定します。この場合、この項目値が null の応答データを取得できます。

例:

/v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100
/v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate

この操作では、/v1/creditmemos/{creditMemoId}/items エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Service End Date (サービス終了日)

String (文字列)

このパラメーターは serviceEndDate 項目に基づいて応答を絞り込みます。

Created By Id (作成者 ID)

String (文字列)

このパラメーターは createdById 項目に基づいて応答を絞り込みます。

sku (SKU)

String (文字列)

このパラメーターは sku 項目に基づいて応答を絞り込みます。

Sku Name (SKU 名)

String (文字列)

このパラメーターは skuName 項目に基づいて応答を絞り込みます。

Source Item Id (ソース項目 ID)

String (文字列)

このパラメーターは sourceItemId 項目に基づいて応答を絞り込みます。

Service Start Date (サービス開始日)

String (文字列)

このパラメーターは serviceStartDate 項目に基づいて応答を絞り込みます。

Subscription Id (サブスクリプション ID)

String (文字列)

このパラメーターは subscriptionId 項目に基づいて応答を絞り込みます。

Applied Amount (適用される額)

Number (数値)

このパラメーターは appliedAmount 項目に基づいて応答を絞り込みます。

amount (金額)

Number (数値)

このパラメーターは amount 項目に基づいて応答を絞り込みます。

id

String (文字列)

このパラメーターは id 項目に基づいて応答を絞り込みます。

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Refund Amount (払い戻し額)

Number (数値)

このパラメーターは refundAmount 項目に基づいて応答を絞り込みます。

Updated By Id (更新者 ID)

String (文字列)

このパラメーターは updatedById 項目に基づいて応答を絞り込みます。

sort (並び替え)

String (文字列)

このパラメーターにより、応答で返されるデータの順序が制限されます。このパラメーターを使用して、並べ替える次元を指定できます。ソート可能な項目は次の形式になります: operator field_name 1 つの URL パスで使用できるソート可能な項目は最大 2 つです。ソート可能な項目を区切るにはカンマを使用します。例: operator field_name, operator field_name operator はシーケンスの順序をマークするために使用します。オペレーターは省略可能です。オペレーターを付けずに並び替え可能な項目のみを指定した場合、応答データはこの項目によって降順で並び替えられます。- - オペレーターは昇順を示します。- + オペレーターは降順を示します。デフォルトでは、応答データは更新日によって降順で表示されます。 field_name はソート可能な項目の名前を示します。この操作のサポートされる並び替え可能な項目は次のとおりです: - amount - appliedAmount - createdById - createdDate - id - refundAmount - serviceEndDate - serviceStartDate - sku - skuName - sourceItemId - subscriptionId - updatedById - updatedDate。例: - /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate - /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate

Updated (更新日)

String (文字列)

このパラメーターは updatedDate 項目に基づいて応答を絞り込みます。

Created Date (作成日)

String (文字列)

このパラメーターは createdDate 項目に基づいて応答を絞り込みます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。REST API バージョン管理については、[「Minor Version (マイナーバージョン)」](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) を参照してください。このヘッダーは、次の応答項目の可用性に影響します: * items > creditTaxItems * items > taxationItems * items > comment * items > description

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get credit memo item

<mule-zuora-connector:get-v1-creditmemos-items-by-credit-memo-id-cmitemid>

請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

クレジットメモの特定の項目に関する情報を取得します。クレジットメモ項目とは、クレジットメモの 1 つの品目です。この操作では、/v1/creditmemos/{creditMemoId}/items/{cmitemid} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

cmitemid

String (文字列)

クレジットメモ項目の一意の ID。クレジットメモ項目 ID は [Get credit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoItems) の応答から取得できます。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。REST API バージョン管理については、[「Minor Version (マイナーバージョン)」](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) を参照してください。このヘッダーは、次の応答項目の可用性に影響します: * creditTaxItems * taxationItems * comment * description

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get taxation items of credit memo item

<mule-zuora-connector:get-v1-creditmemos-items-taxation-items-by-credit-memo-id-cmitemid>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。特定のクレジットメモ項目の課税項目に関する情報を取得します。この操作では、/v1/creditmemos/{creditMemoId}/items/{cmitemid}/taxation-items エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

cmitemid

String (文字列)

クレジットメモ項目の一意の ID。クレジットメモ項目 ID は [Get credit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoItems) の応答から取得できます。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型	Array of String (文字列の配列)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get credit memo parts

<mule-zuora-connector:get-v1-creditmemos-parts-by-credit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。クレジットメモのすべてのパートに関する情報を取得します。クレジットメモは未適用のパートと、請求書およびデビットメモに適用済みの複数のパートで構成される場合があります。この操作を使用して、クレジットメモの適用済みのパートと未適用のパートをすべて取得できます。この操作では、/v1/creditmemos/{creditMemoId}/parts エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get credit memo part

<mule-zuora-connector:get-v1-creditmemos-parts-by-credit-memo-id-partid>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。特定のクレジットメモパートに関する情報を取得します。クレジットメモは未適用のパートと、請求書およびデビットメモに適用済みの複数のパートで構成される場合があります。この操作では、/v1/creditmemos/{creditMemoId}/parts/{partid} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

partid

String (文字列)

特定のクレジットメモパートの一意の ID。クレジットメモパート ID は [Get credit memo parts](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoParts) の応答から取得できます。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get credit memo part items

<mule-zuora-connector:get-v1-creditmemos-parts-itemparts-by-credit-memo-id-partid>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。クレジットメモパートのすべての項目に関する情報を取得します。クレジットメモパート項目とは、クレジットメモパートの 1 つの品目です。クレジットメモパートは、複数の異なる種別の項目で構成される場合があります。この操作では、/v1/creditmemos/{creditMemoId}/parts/{partid}/itemparts エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

partid

String (文字列)

特定のクレジットメモパートの一意の ID。クレジットメモパート ID は [Get credit memo parts](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoParts) の応答から取得できます。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get credit memo part item

<mule-zuora-connector:get-v1-creditmemos-parts-itemparts-by-credit-memo-id-partid-itempartid>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。特定のクレジットメモパート項目に関する情報を取得します。クレジットメモパート項目とは、クレジットメモパートの 1 つの品目です。クレジットメモパートは、複数の異なる種別の項目で構成される場合があります。この操作では、/v1/creditmemos/{creditMemoId}/parts/{partid}/itemparts/{itempartid} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

partid

String (文字列)

特定のクレジットメモパートの一意の ID。クレジットメモパート ID は [Get credit memo parts](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoParts) の応答から取得できます。

x

itempartid

String (文字列)

特定のクレジットメモパート項目の一意の ID。クレジットメモパート項目 ID は [Get credit memo part items](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoItemParts) の応答から取得できます。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get custom foreign currency exchange rates

<mule-zuora-connector:get-v1-custom-exchange-rates-by-currency>

この機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。このリファレンスでは、Zuora からカスタム外国為替レートを照会する方法について説明します。この API メソッドを使用して為替レートを照会できるのは、カスタム為替レートプロバイダーを使用していて、Import Foreign Exchange Rates マスアクションを使用してレートをアップロードしている場合のみです。この操作では、/v1/custom-exchange-rates/{currency} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

currency (通貨)

String (文字列)

テナントの対象基準通貨。応答の為替レートは、対象通貨に関して計算されます。値は 3 文字の通貨コードである必要があります。例: USD。

x

Start Date (開始日)

String (文字列)

為替レートを取得する日付範囲の開始日。日付は yyyy-mm-dd 形式である必要があります。例: 2016-01-15。開始日は終了日より後にはできません。

x

End Date (終了日)

String (文字列)

為替レートを取得する日付範囲の終了日。日付は yyyy-mm-dd 形式である必要があります。例: 2016-01-16。終了日は開始日の最大 90 日後にできます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get Debit Memos

<mule-zuora-connector:get-v1-debitmemos>

すべての顧客アカウントに関連付けられたすべてのデビットメモに関する情報を取得します。

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。 === 絞り込み

クエリパラメーターを使用して、応答で返されるデータを制限できます。各クエリパラメーターはレスポンスボディの 1 つの項目に対応しています。絞り込み可能な項目の値が文字列の場合、絞り込むときに対応するクエリパラメーターを null に設定します。この場合、この項目値が null の応答データを取得できます。

例:

/v1/debitmemos?status=Processed
/v1/debitmemos?referredInvoiceId=null&status=Draft
/v1/debitmemos?status=Processed&type=External&sort=+number

この操作では、/v1/debitmemos エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Target Date (対象日付)

String (文字列)

このパラメーターは targetDate 項目に基づいて応答を絞り込みます。

number (数値)

String (文字列)

このパラメーターは number 項目に基づいて応答を絞り込みます。

Be Applied Amount (適用される額)

Number (数値)

このパラメーターは beAppliedAmount 項目に基づいて応答を絞り込みます。

Created By Id (作成者 ID)

String (文字列)

このパラメーターは createdById 項目に基づいて応答を絞り込みます。

Referred Invoice Id (参照される請求書 ID)

String (文字列)

このパラメーターは referredInvoiceId 項目に基づいて応答を絞り込みます。

Debit Memo Date (デビットメモ日)

String (文字列)

このパラメーターは debitMemoDate 項目に基づいて応答を絞り込みます。

balance (残高)

Number (数値)

このパラメーターは balance 項目に基づいて応答を絞り込みます。

Account Id (アカウント ID)

String (文字列)

このパラメーターは accountId 項目に基づいて応答を絞り込みます。

amount (金額)

Number (数値)

このパラメーターは amount 項目に基づいて応答を絞り込みます。

Tax Amount (税額)

Number (数値)

このパラメーターは taxAmount 項目に基づいて応答を絞り込みます。

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

status (状況)

Enumeration (列挙)。次のいずれかになります。

DRAFT
POSTED
CANCELED
ERROR
PENDING_FOR_TAX
GENERATING
CANCEL_IN_PROGRESS

このパラメーターは status 項目に基づいて応答を絞り込みます。

Due Date (期日)

String (文字列)

このパラメーターは dueDate 項目に基づいて応答を絞り込みます。

currency (通貨)

String (文字列)

このパラメーターは currency 項目に基づいて応答を絞り込みます。

Updated By Id (更新者 ID)

String (文字列)

このパラメーターは updatedById 項目に基づいて応答を絞り込みます。

sort (並び替え)

String (文字列)

このパラメーターにより、応答で返されるデータの順序が制限されます。このパラメーターを使用して、並べ替える次元を指定できます。ソート可能な項目は次の形式になります: operator field_name 1 つの URL パスで使用できるソート可能な項目は最大 2 つです。ソート可能な項目を区切るにはカンマを使用します。例: operator field_name, operator field_name operator はシーケンスの順序をマークするために使用します。オペレーターは省略可能です。オペレーターを付けずに並び替え可能な項目のみを指定した場合、応答データはこの項目によって降順で並び替えられます。- - オペレーターは昇順を示します。- + オペレーターは降順を示します。デフォルトでは、応答データはデビットメモ番号によって降順で表示されます。 field_name はソート可能な項目の名前を示します。この操作のサポートされる並び替え可能な項目は次のとおりです: - number - accountId - debitMemoDate - targetDate - dueDate - amount - taxAmount - totalTaxExemptAmount - balance - beAppliedAmount - referredInvoiceId - createdDate - createdById - updatedDate - updatedById。例: - /v1/debitmemos?sort=+number - /v1/debitmemos?status=Processed&sort=-number,+amount

Total Tax Exempt Amount (合計税金控除額)

Number (数値)

このパラメーターは totalTaxExemptAmount 項目に基づいて応答を絞り込みます。

Updated (更新日)

String (文字列)

このパラメーターは updatedDate 項目に基づいて応答を絞り込みます。

Created Date (作成日)

String (文字列)

このパラメーターは createdDate 項目に基づいて応答を絞り込みます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get debit memo application parts

<mule-zuora-connector:get-v1-debitmemos-application-parts-by-debit-memo-id>

この機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

特定のデビットメモに適用される支払いまたはクレジットメモに関する情報を取得します。

この操作では、/v1/debitmemos/{debitMemoId}/application-parts エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Debit Memo Id (デビットメモ ID)

String (文字列)

デビットメモの一意の ID。例: 8a8082e65b27f6c3015ba419f3c2644e。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get Debit Memo

<mule-zuora-connector:get-v1-debitmemos-by-debit-memo-id>

この機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

特定のデビットメモに関する情報を取得します。

この操作では、/v1/debitmemos/{debitMemoId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Debit Memo Id (デビットメモ ID)

String (文字列)

デビットメモの一意の ID。例: 8a8082e65b27f6c3015ba419f3c2644e。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get Debit Memo Items

<mule-zuora-connector:get-v1-debitmemos-items-by-debit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

デビットメモのすべての項目に関する情報を取得します。デビットメモ項目とは、デビットメモの 1 つの品目です。

絞り込み

クエリパラメーターを使用して、応答で返されるデータを制限できます。各クエリパラメーターはレスポンスボディの 1 つの項目に対応しています。絞り込み可能な項目の値が文字列の場合、絞り込むときに対応するクエリパラメーターを null に設定します。この場合、この項目値が null の応答データを取得できます。

例:

/v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100
/v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate

この操作では、/v1/debitmemos/{debitMemoId}/items エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Debit Memo Id (デビットメモ ID)

String (文字列)

デビットメモの一意の ID。例: 8a8082e65b27f6c3015ba419f3c2644e。

x

Service End Date (サービス終了日)

String (文字列)

このパラメーターは serviceEndDate 項目に基づいて応答を絞り込みます。

Be Applied Amount (適用される額)

Number (数値)

このパラメーターは beAppliedAmount 項目に基づいて応答を絞り込みます。

Created By Id (作成者 ID)

String (文字列)

このパラメーターは createdById 項目に基づいて応答を絞り込みます。

sku (SKU)

String (文字列)

このパラメーターは sku 項目に基づいて応答を絞り込みます。

Sku Name (SKU 名)

String (文字列)

このパラメーターは skuName 項目に基づいて応答を絞り込みます。

Source Item Id (ソース項目 ID)

String (文字列)

このパラメーターは sourceItemId 項目に基づいて応答を絞り込みます。

Service Start Date (サービス開始日)

String (文字列)

このパラメーターは serviceStartDate 項目に基づいて応答を絞り込みます。

Subscription Id (サブスクリプション ID)

String (文字列)

このパラメーターは subscriptionId 項目に基づいて応答を絞り込みます。

amount (金額)

Number (数値)

このパラメーターは amount 項目に基づいて応答を絞り込みます。

id

String (文字列)

このパラメーターは id 項目に基づいて応答を絞り込みます。

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Updated By Id (更新者 ID)

String (文字列)

このパラメーターは updatedById 項目に基づいて応答を絞り込みます。

sort (並び替え)

String (文字列)

このパラメーターにより、応答で返されるデータの順序が制限されます。このパラメーターを使用して、並べ替える次元を指定できます。ソート可能な項目は次の形式になります: operator field_name 1 つの URL パスで使用できるソート可能な項目は最大 2 つです。ソート可能な項目を区切るにはカンマを使用します。例: operator field_name, operator field_name operator はシーケンスの順序をマークするために使用します。オペレーターは省略可能です。オペレーターを付けずに並び替え可能な項目のみを指定した場合、応答データはこの項目によって降順で並び替えられます。- - オペレーターは昇順を示します。- + オペレーターは降順を示します。デフォルトでは、応答データは更新日によって降順で表示されます。 field_name はソート可能な項目の名前を示します。この操作のサポートされる並び替え可能な項目は次のとおりです: - id - amount - beAppliedAmount - sku - skuName - serviceStartDate - serviceEndDate - sourceItemId - createdDate - createdById - updatedDate - updatedById - subscriptionId。例: - /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate - /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate

Updated (更新日)

String (文字列)

このパラメーターは updatedDate 項目に基づいて応答を絞り込みます。

Created Date (作成日)

String (文字列)

このパラメーターは createdDate 項目に基づいて応答を絞り込みます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。REST API バージョン管理については、[「Minor Version (マイナーバージョン)」](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) を参照してください。このヘッダーは、次の応答項目の可用性に影響します: * items > taxItems * items > taxationItems * items > comment * items > description

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get Debit Memo Item

<mule-zuora-connector:get-v1-debitmemos-items-by-debit-memo-id-dmitemid>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

デビットメモの特定の項目に関する情報を取得します。デビットメモ項目とは、デビットメモの 1 つの品目です。

この操作では、/v1/debitmemos/{debitMemoId}/items/{dmitemid} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

dmitemid

String (文字列)

デビットメモ項目の一意の ID。デビットメモ項目 ID は [Get debit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems) の応答から取得できます。

x

Debit Memo Id (デビットメモ ID)

String (文字列)

デビットメモの一意の ID。例: 8a8082e65b27f6c3015ba419f3c2644e。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。REST API バージョン管理については、[「Minor Version (マイナーバージョン)」](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) を参照してください。このヘッダーは、次の応答項目の可用性に影響します: * taxItems * taxationItems * comment * description

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get taxation items of debit memo item

<mule-zuora-connector:get-v1-debitmemos-items-taxation-items-by-debit-memo-id-dmitemid>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。特定のデビットメモ項目の課税項目に関する情報を取得します。この操作では、/v1/debitmemos/{debitMemoId}/items/{dmitemid}/taxation-items エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

dmitemid

String (文字列)

デビットメモ項目の一意の ID。デビットメモ項目 ID は [Get debit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems) の応答から取得できます。

x

Debit Memo Id (デビットメモ ID)

String (文字列)

デビットメモの一意の ID。例: 8a8082e65b27f6c3015ba419f3c2644e。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型	Array of String (文字列の配列)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Describe object

<mule-zuora-connector:get-v1-describe-by-object>

Zuora テナントで使用可能な各オブジェクトのリファレンスリストを提供します。このコールによって返される情報は、 CRUD: Create Export または AQuA API を使用してデータソースエクスポートを作成している場合に役立ちます。詳細は、「ZOQL をエクスポート」を参照してください。

Response (応答)

応答には、指定されたオブジェクトの項目をリストした XML ドキュメントが含まれます。各オブジェクトの項目は、XML ドキュメントの要素によって表されます。各項目の要素には次の要素が含まれます。

要素

説明

<name>

項目の API 参照名。

<label>

Zuora ユーザーインターフェースの項目の名前。

<type>

項目のデータ型。有効なデータ型は、boolean、date、datetime、decimal、integer、picklist、text、timestamp、ZOQL です。データ型が picklist の場合、<field> 要素には項目の有効な値をリストした <options> 要素が含まれます。

<contexts>

項目の可用性を指定します。<contexts> 要素で export コンテキストがリストされる場合、項目はデータソースエクスポートに使用できます。

<field> 要素には、項目に関する従来の情報を提供する別の要素が含まれます。この情報は、REST API には直接関連していません。

応答のサンプル:

<?xml version="1.0" encoding="UTF-8"?>
<object>
  <name>ProductRatePlanCharge</name>
  <label>Product Rate Plan Charge</label>
  <fields>
    ...
    <field>
      <name>TaxMode</name>
      <label>Tax Mode</label>
      <type>picklist</type>
      <options>
        <option>TaxExclusive</option>
        <option>TaxInclusive</option>
      </options>
      <contexts>
        <context>export</context>
      </contexts>
      ...
    </field>
    ...
  </fields>
</object>

統合で応答の <contexts> 要素をチェックすることを強くお勧めします。統合で <contexts> 要素をチェックしない場合、データソースエクスポートに使用できない項目を処理してしまう可能性があります。詳細は、「Changes to the Describe API (Describe API に対する変更)」を参照してください。

この操作では、/v1/describe/{object} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

object

String (文字列)

Zuora テナントのオブジェクトの API 名。例: InvoiceItem。有効なオブジェクト名のリストについては、[「Zuora Object Model (Zuora オブジェクトモデル)」](https://www.zuora.com/developer/api-reference/#section/Zuora-Object-Model) を参照してください。Zuora テナントで有効にしている機能に応じて、一部のオブジェクトの項目をリストできない場合があります。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get document properties

<mule-zuora-connector:get-v1-document-properties-by-document-type-document-id>

請求ドキュメントプロパティのセットアップ機能を有効にしている場合のみ、この機能を使用できます。請求ドキュメントプロパティのセットアップ機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

請求ドキュメントのドキュメントプロパティに関する情報を取得できます。請求ドキュメントには、請求書、クレジットメモ、およびデビットメモがあります。 注意: クレジットメモおよびデビットメモのドキュメントプロパティに関する情報は、請求書決済機能を有効にしている場合のみ取得できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作では、/v1/document-properties/{documentType}/{documentId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Document Type (ドキュメント種別)

Enumeration (列挙)。次のいずれかになります。

INVOICE
CREDIT_MEMO
DEBIT_MEMO

請求ドキュメントの種別。

x

Document Id (ドキュメント ID)

String (文字列)

取得するドキュメントプロパティの一意の ID。例: 402892c74c9193cd014c96bbe7c101f9。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Get entities

<mule-zuora-connector:get-v1-entities>

Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

マルチエンティティ階層の特定のエンティティの詳細情報を取得します。

以下を取得できます。

プロビジョニングされたエンティティ
プロビジョニング解除されたエンティティ
プロビジョニングされたエンティティとプロビジョニング解除されたエンティティの両方

ユーザーアクセス権限

任意のエンティティユーザーとしてコールを行うことができます。

この操作では、/v1/entities エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

provisioned (プロビジョニング)

String (文字列)

プロビジョニングされたエンティティを取得するかプロビジョニングされていないエンティティを取得するかを指定します: - true: プロビジョニングされたエンティティ - false: プロビジョニングされていないエンティティ。要求でこの項目を指定しない場合、プロビジョニングされたエンティティとプロビジョニングされていないエンティティの両方が返されます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Get entity by Id

<mule-zuora-connector:get-v1-entities-by-id>

Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

指定されたエンティティに関する詳細情報を取得します。

ユーザーアクセス権限

任意のエンティティユーザーとしてコールを行うことができます。

この操作では、/v1/entities/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

取得するエンティティの ID を指定します。エンティティ ID は GET Entities コールから取得できます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Get connections

<mule-zuora-connector:get-v1-entity-connections>

Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

指定されたエンティティの特定の接続に関する情報を取得します。取得するエンティティは Zuora-Entity-Ids リクエストヘッダーで指定できます。

以下を取得できます。

インバウンド接続
アウトバウンド接続
インバウンド接続とアウトバウンド接続の両方

ユーザーアクセス権限

任意のエンティティユーザーとしてコールを行うことができます。

この操作では、/v1/entity-connections エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

30

Type (型)

Enumeration (列挙)。次のいずれかになります。

INBOUND
OUTBOUND

エンティティのインバウンド接続とアウトバウンド接続のどちらを取得するかを指定します。可能な値: - inbound: エンティティに対するすべての着信接続。- outbound: エンティティからのすべての発信接続。要求でこの項目を指定しない場合、インバウンド接続とアウトバウンド接続の両方が返されます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get files

<mule-zuora-connector:get-v1-files-by-file-id>

エクスポート結果、請求書、会計期間レポートなどのファイルを取得します。

最大ファイルサイズは 2047MB です。この制限を超えるデータ要求があると、Zuora によって次の 403 応答が返されます: 2047MB。大きいファイルの最適化を行う必要があるかどうかを判断するには、Zuora グローバルサポートに要求を送信してください。

この操作では、/v1/files/{file-id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

File id (ファイル ID)

String (文字列)

取得するファイルの Zuora ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Return Hosted Pages

<mule-zuora-connector:get-v1-hostedpages>

支払ページの設定メタデータを返します。具体的には、ページ ID、ページバージョン、支払方法種別です。

次に、支払ページのページ固有および全般的な REST 要求を示します。

支払ページ 1.0 の設定情報の要求:
GET /hostedpages?version=1
支払ページ 2.0 の設定情報の要求:
GET /hostedpages?version=2
すべてのバージョンの支払ページの設定情報の要求:
GET /hostedpages

注意事項

対応するテナント設定を有効にしていない場合 (たとえば、支払ページ 2.0 設定を使用して 2 に設定された要求 version パラメーターが無効になっている)、エラーが発生します。

この操作では、/v1/hostedpages エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Version Number (バージョン番号)

String (文字列)

設定情報を取得する支払ページのバージョン。支払ページ 1.0 の場合は 1 と、支払ページ 2.0 の場合は 2 と指定します。省略した場合、すべてのバージョンの支払ページの情報が返されます。応答は、支払ページ 1.0 と支払ページ 2.0 のテナント設定によっても異なります。たとえば、支払ページ 2.0 のテナント設定が有効な場合、このパラメーターを省略した場合でも、応答には支払ページ 2.0 フォームの情報のみが含まれます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get invoice application parts

<mule-zuora-connector:get-v1-invoices-application-parts-by-invoice-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスしたい場合は、Zuora グローバルサポートに要求を送信してください。特定の請求書に適用される支払いまたはクレジットメモに関する情報を取得します。この操作では、/v1/invoices/{invoiceId}/application-parts エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice Id (請求書 ID)

String (文字列)

請求書の一意の ID。例: 2c92c8955bd63cc1015bd7c151af02ab。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get invoice files

<mule-zuora-connector:get-v1-invoices-files-by-invoice-id>

指定された請求書のすべての PDF ファイルに関する情報を取得します。請求書の PDF ファイルは versionNumber 項目の値を基準に新しいものから順に返されます。この操作では、/v1/invoices/{invoiceId}/files エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice Id (請求書 ID)

String (文字列)

請求書の一意の ID。例: 2c92c8955bd63cc1015bd7c151af02ab。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get invoice items

<mule-zuora-connector:get-v1-invoices-items-by-invoice-id>

指定された請求書のすべての項目に関する情報を取得します。この操作では、/v1/invoices/{invoiceId}/items エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice Id (請求書 ID)

String (文字列)

請求書の一意の ID。例: 2c92c8955bd63cc1015bd7c151af02ab。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get taxation items of invoice item

<mule-zuora-connector:get-v1-invoices-items-taxation-items-by-invoice-id-item-id>

特定の請求書項目の課税項目に関する情報を取得します。この操作では、/v1/invoices/{invoiceId}/items/{itemId}/taxation-items エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice Id (請求書 ID)

String (文字列)

請求書の一意の ID。例: 2c92c8955bd63cc1015bd7c151af02ab。

x

Item Id (項目 ID)

String (文字列)

請求書項目の一意の ID。例: 2c86c8955bd63cc1015bd7c151af02ef。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get summary journal entry

<mule-zuora-connector:get-v1-journal-entries-by-je-number>

この REST API リファレンスでは、そのジャーナルエントリ番号によってサマリージャーナルエントリに関する情報を取得する方法について説明します。この操作では、/v1/journal-entries/{je-number} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Je number (Je 番号)

String (文字列)

Je number (Je 番号)

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get all summary journal entries in a journal run

<mule-zuora-connector:get-v1-journal-entries-journal-runs-by-jr-number>

この REST API リファレンスでは、ジャーナル実行のすべてのサマリージャーナルエントリに関する情報を取得する方法について説明します。この操作では、/v1/journal-entries/journal-runs/{jr-number} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Jr number (Jr 番号)

String (文字列)

ジャーナル実行番号。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

8

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get journal run

<mule-zuora-connector:get-v1-journal-runs-by-jr-number>

この REST API リファレンスでは、ジャーナル実行に関する情報を取得する方法について説明します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/journal-runs/{jr-number} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Jr number (Jr 番号)

String (文字列)

ジャーナル実行番号。JR-00000001 の形式の有効なジャーナル実行番号である必要があります。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get callout notification histories

<mule-zuora-connector:get-v1-notification-history-callout>

この REST API リファレンスでは、コールアウトの通知履歴を取得する方法について説明します。この操作では、/v1/notification-history/callout エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start Time (開始時刻)

String (文字列)

返されるレコードの開始日時。デフォルトは (終了時間 - 1 日) です。yyyy-MM-ddTHH:mm:ss の形式を使用します。

Event Category (イベントカテゴリ)

String (文字列)

イベントカテゴリによって返されるレコードのカテゴリ。次の形式がサポートされています。* {Event Type Namespace}:{Event Type Name} (Zuora テナントで設定可能イベント機能を有効にしている場合)。例: user.notification:NewSubscriptionCreated。 *それ以外の場合、イベントカテゴリの数値コード。たとえば、1210 です。詳細は、[「Event Categories for Notifications (通知のイベントカテゴリ)」](https://knowledgecenter.zuora.com/DC_Developers/AA_REST_API/Event_Categories_for_Notification_Histories) を参照してください。

Failed Only (失敗のみ)

Boolean (ブール)

true の場合、失敗したレコードのみを返します。false の場合、指定された日付範囲のすべてのレコードを返します。デフォルト値は true です。

false

End Time (終了時刻)

String (文字列)

返されるレコードの最終日時。デフォルトは現在です。yyyy-MM-ddTHH:mm:ss の形式を使用します。

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

オブジェクト ID

String (文字列)

コールアウト通知をトリガーしたオブジェクトの ID。

Include Response Content (応答コンテンツを含む)

Boolean (ブール)

Include Response Content (応答コンテンツを含む)

false

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get email notification histories

<mule-zuora-connector:get-v1-notification-history-email>

この REST API リファレンスでは、通知メールの通知履歴を取得する方法について説明します。## 注意: 要求パラメーターおよびその値では、次の HTTPS GET 要求に続いて「?」が付加される場合があります。追加の要求パラメーターは「&」で区切られます。例: GET https://rest.zuora.com/v1/notification-history/email?startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000&pageSize=1。この操作では、/v1/notification-history/email エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start Time (開始時刻)

String (文字列)

返されるレコードの開始日時。デフォルトは (終了時間 - 1 日) です。yyyy-MM-ddTHH:mm:ss の形式を使用します。最大日付範囲 (endTime - startTime) は 3 日です。

Event Category (イベントカテゴリ)

String (文字列)

イベントカテゴリによって返されるレコードのカテゴリ。次の形式がサポートされています。* {Event Type Namespace}:{Event Type Name} (Zuora テナントで設定可能イベント機能を有効にしている場合)。例: user.notification:NewSubscriptionCreated。 *それ以外の場合、イベントカテゴリの数値コード。たとえば、1210 です。詳細は、[「Event Categories for Notifications (通知のイベントカテゴリ)」](https://knowledgecenter.zuora.com/DC_Developers/AA_REST_API/Event_Categories_for_Notification_Histories) を参照してください。

Failed Only (失敗のみ)

Boolean (ブール)

true の場合、失敗したレコードのみを返します。false の場合、指定された日付範囲のすべてのレコードを返します。指定しない場合のデフォルトは true です。

false

End Time (終了時刻)

String (文字列)

返されるレコードの最終日時。デフォルトは現在です。yyyy-MM-ddTHH:mm:ss の形式を使用します。最大日付範囲 (endTime - startTime) は 3 日です。

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

オブジェクト ID

String (文字列)

メール通知をトリガーしたオブジェクトの ID。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Get account

<mule-zuora-connector:get-v1-object-account-by-id>

1 つの特定のアカウントに関する情報を取得します。この操作では、/v1/object/account/{id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Get amendment

<mule-zuora-connector:get-v1-object-amendment-by-id>

CRUD: Get amendment。この操作では、/v1/object/amendment/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Get bill run

<mule-zuora-connector:get-v1-object-bill-run-by-id>

注意: この機能は使用制限されています。この機能にアクセスしたい場合は、Zuora グローバルサポートに要求を送信してください。請求実行の完了に依存する営業活動は、請求実行クエリで PostInProgress が返される間は使用できません。請求実行の完了時に、クエリで Posted が返されます。この操作では、/v1/object/bill-run/{id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve CommunicationProfile

<mule-zuora-connector:get-v1-object-communication-profile-by-id>

CRUD: Retrieve CommunicationProfile。この操作では、/v1/object/communication-profile/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Get contact

<mule-zuora-connector:get-v1-object-contact-by-id>

特定の取引先責任者に関する詳細情報を取得します。この操作では、/v1/object/contact/{id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve CreditBalanceAdjustment

<mule-zuora-connector:get-v1-object-credit-balance-adjustment-by-id>

CRUD: Retrieve CreditBalanceAdjustment。この操作では、/v1/object/credit-balance-adjustment/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve Export

<mule-zuora-connector:get-v1-object-export-by-id>

この操作を使用して、データソースエクスポートのの状況を確認してエクスポートされたデータにアクセスします。Zuora からデータをエクスポートしたら、エクスポートした各ファイルは 7 日間ダウンロード可能です。データソースエクスポート (Export オブジェクト) は 90 日を超えると自動的に削除されます。この操作では、/v1/object/export/{id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve Feature

<mule-zuora-connector:get-v1-object-feature-by-id>

CRUD: Retrieve Feature。この操作では、/v1/object/feature/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve Import

<mule-zuora-connector:get-v1-object-import-by-id>

CRUD: Retrieve Import。この操作では、/v1/object/import/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve InvoiceAdjustment

<mule-zuora-connector:get-v1-object-invoice-adjustment-by-id>

CRUD: Retrieve InvoiceAdjustment。この操作では、/v1/object/invoice-adjustment/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Get invoice

<mule-zuora-connector:get-v1-object-invoice-by-id>

CRUD: Get invoice。この操作では、/v1/object/invoice/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve InvoiceItemAdjustment

<mule-zuora-connector:get-v1-object-invoice-item-adjustment-by-id>

CRUD: Retrieve InvoiceItemAdjustment。この操作では、/v1/object/invoice-item-adjustment/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve InvoiceItem

<mule-zuora-connector:get-v1-object-invoice-item-by-id>

CRUD: Retrieve InvoiceItem。この操作では、/v1/object/invoice-item/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve InvoicePayment

<mule-zuora-connector:get-v1-object-invoice-payment-by-id>

CRUD: Retrieve InvoicePayment。この操作では、/v1/object/invoice-payment/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve InvoiceSplit

<mule-zuora-connector:get-v1-object-invoice-split-by-id>

CRUD: Retrieve InvoiceSplit。この操作では、/v1/object/invoice-split/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve InvoiceSplitItem

<mule-zuora-connector:get-v1-object-invoice-split-item-by-id>

CRUD: Retrieve InvoiceSplitItem。この操作では、/v1/object/invoice-split-item/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Get payment

<mule-zuora-connector:get-v1-object-payment-by-id>

1 つの特定の支払に関する情報を取得します。この操作では、/v1/object/payment/{id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

支払の一意の ID。例: 2c92c095592623ea01596621ada84352。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Get payment method

<mule-zuora-connector:get-v1-object-payment-method-by-id>

CRUD: Get payment method。この操作では、/v1/object/payment-method/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Get payment method snapshot

<mule-zuora-connector:get-v1-object-payment-method-snapshot-by-id>

この REST API リファレンスでは、支払方法スナップショットを取得する方法について説明します。支払方法スナップショットとは、トランザクションで使用される特定の支払方法のコピーです。支払方法を削除しても、支払方法スナップショットでは過去のそれぞれのトランザクションで使用されるデータが保持されます。## 注意: 次の支払方法項目は支払方法スナップショットでは使用できません: * Active * AchAddress1 * AchAddress2 * CreatedById * CreatedDate * UpdatedById * UpdatedDate。支払方法スナップショット項目 PaymentMethodId は支払方法では使用できません。この操作では、/v1/object/payment-method-snapshot/{id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve PaymentMethodTransactionLog

<mule-zuora-connector:get-v1-object-payment-method-transaction-log-by-id>

CRUD: Retrieve PaymentMethodTransactionLog。この操作では、/v1/object/payment-method-transaction-log/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Get payment transaction log

<mule-zuora-connector:get-v1-object-payment-transaction-log-by-id>

特定の支払トランザクションログに関する情報を取得します。この操作では、/v1/object/payment-transaction-log/{id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

支払トランザクションログの ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve Product

<mule-zuora-connector:get-v1-object-product-by-id>

CRUD: Retrieve Product。この操作では、/v1/object/product/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve ProductFeature

<mule-zuora-connector:get-v1-object-product-feature-by-id>

CRUD: Retrieve ProductFeature。この操作では、/v1/object/product-feature/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve ProductRatePlan

<mule-zuora-connector:get-v1-object-product-rate-plan-by-id>

CRUD: Retrieve ProductRatePlan。この操作では、/v1/object/product-rate-plan/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Get product rate plan charge

<mule-zuora-connector:get-v1-object-product-rate-plan-charge-by-id>

CRUD: Get product rate plan charge。この操作では、/v1/object/product-rate-plan-charge/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

取得する製品料金プランチャージの一意の ID。例: 2c93808457d787030157e031fcd34e19。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve ProductRatePlanChargeTier

<mule-zuora-connector:get-v1-object-product-rate-plan-charge-tier-by-id>

CRUD: Retrieve ProductRatePlanChargeTier。この操作では、/v1/object/product-rate-plan-charge-tier/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve RatePlan

<mule-zuora-connector:get-v1-object-rate-plan-by-id>

CRUD: Retrieve RatePlan。この操作では、/v1/object/rate-plan/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Get rate plan charge

<mule-zuora-connector:get-v1-object-rate-plan-charge-by-id>

CRUD: Get rate plan charge。この操作では、/v1/object/rate-plan-charge/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve RatePlanChargeTier

<mule-zuora-connector:get-v1-object-rate-plan-charge-tier-by-id>

CRUD: Retrieve RatePlanChargeTier。この操作では、/v1/object/rate-plan-charge-tier/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Get refund

<mule-zuora-connector:get-v1-object-refund-by-id>

CRUD: Get refund。この操作では、/v1/object/refund/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve RefundInvoicePayment

<mule-zuora-connector:get-v1-object-refund-invoice-payment-by-id>

CRUD: Retrieve RefundInvoicePayment。この操作では、/v1/object/refund-invoice-payment/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve RefundTransactionLog

<mule-zuora-connector:get-v1-object-refund-transaction-log-by-id>

CRUD: Retrieve RefundTransactionLog。この操作では、/v1/object/refund-transaction-log/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve Subscription

<mule-zuora-connector:get-v1-object-subscription-by-id>

CRUD: Retrieve Subscription。この操作では、/v1/object/subscription/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve SubscriptionProductFeature

<mule-zuora-connector:get-v1-object-subscription-product-feature-by-id>

CRUD: Retrieve SubscriptionProductFeature。この操作では、/v1/object/subscription-product-feature/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve TaxationItem

<mule-zuora-connector:get-v1-object-taxation-item-by-id>

CRUD: Retrieve TaxationItem。この操作では、/v1/object/taxation-item/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Retrieve UnitOfMeasure

<mule-zuora-connector:get-v1-object-unit-of-measure-by-id>

CRUD: Retrieve UnitOfMeasure。この操作では、/v1/object/unit-of-measure/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Get usage

<mule-zuora-connector:get-v1-object-usage-by-id>

CRUD: Get usage。この操作では、/v1/object/usage/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

fields

String (文字列)

返すオブジェクト項目。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get all orders

<mule-zuora-connector:get-v1-orders>

注意: この機能は、[注文メトリクス](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) 機能を有効にしている場合のみ使用できます。注文メトリクスへの移行は [Limited Availability (限定利用)] にあります。私たちは正式リリースの前に小数の早期導入ユーザーからのフィードバックを積極的に求めています。[注文](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) 機能を有効にしている場合、すでに注文メトリクス機能は有効になっています。テナントのすべての注文に関する情報を取得します。デフォルトでは、注文の最初のページが返されます。この操作では、/v1/orders エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

End Date (終了日)

String (文字列)

結果には dateFilterOption の日付がこの日付以前の注文のみが含まれます。

Date Filter Option (日付検索条件オプション)

String (文字列)

絞り込みの基準となる日付種別。この項目値は orderDate または updatedDate です。デフォルトは orderDate です。

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Start Date (開始日)

String (文字列)

結果には dateFilterOption の日付がこの日付以降の注文のみが含まれます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get an order

<mule-zuora-connector:get-v1-orders-by-order-number>

注意: この機能は、[注文メトリクス](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) 機能を有効にしている場合のみ使用できます。注文メトリクスへの移行は [Limited Availability (限定利用)] にあります。私たちは正式リリースの前に小数の早期導入ユーザーからのフィードバックを積極的に求めています。[注文](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) 機能を有効にしている場合、すでに注文メトリクス機能は有効になっています。指定された注文に関する詳細情報を取得します。この操作では、/v1/orders/{orderNumber} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Order Number (注文番号)

String (文字列)

取得する注文番号。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get order metrics for evergreen subscription

<mule-zuora-connector:get-v1-orders-evergreen-metrics-by-order-number-subscription-number>

注意: この機能は、[注文メトリクス](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) 機能を有効にしている場合のみ使用できます。注文メトリクスへの移行は [Limited Availability (限定利用)] にあります。私たちは正式リリースの前に小数の早期導入ユーザーからのフィードバックを積極的に求めています。[注文](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) 機能を有効にしている場合、すでに注文メトリクス機能は有効になっています。指定された注文のエバーグリーンサブスクリプションのメトリクスを取得します。この操作では、/v1/orders/{orderNumber}/evergreenMetrics/{subscriptionNumber} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Order Number (注文番号)

String (文字列)

注文番号。

x

Subscription Number (サブスクリプション番号)

String (文字列)

メトリクスを取得するサブスクリプション番号。

x

Start Date (開始日)

String (文字列)

メトリクスを取得する日付範囲の開始日。日付は yyyy-mm-dd 形式である必要があります。たとえば、2017-12-03 です。

x

End Date (終了日)

String (文字列)

メトリクスを取得する日付範囲の終了日。日付は yyyy-mm-dd 形式である必要があります。たとえば、2017-12-03 です。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get orders by invoice owner

<mule-zuora-connector:get-v1-orders-invoice-owner-by-account-number>

注意: この機能は、[注文メトリクス](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) 機能を有効にしている場合のみ使用できます。注文メトリクスへの移行は [Limited Availability (限定利用)] にあります。私たちは正式リリースの前に小数の早期導入ユーザーからのフィードバックを積極的に求めています。[注文](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) 機能を有効にしている場合、すでに注文メトリクス機能は有効になっています。指定された請求書オーナーのすべての注文に関する詳細情報を取得します。この操作では、/v1/orders/invoiceOwner/{accountNumber} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account Number (アカウント番号)

String (文字列)

請求書オーナーのアカウント番号。

x

End Date (終了日)

String (文字列)

結果には dateFilterOption の日付がこの日付以前の注文のみが含まれます。

Date Filter Option (日付検索条件オプション)

String (文字列)

絞り込みの基準となる日付種別。この項目値は orderDate または updatedDate です。デフォルトは orderDate です。

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Start Date (開始日)

String (文字列)

結果には dateFilterOption の日付がこの日付以降の注文のみが含まれます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型	Array of String (文字列の配列)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get orders by subscription number

<mule-zuora-connector:get-v1-orders-subscription-by-subscription-number>

注意: この機能は、[注文メトリクス](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) 機能を有効にしている場合のみ使用できます。注文メトリクスへの移行は [Limited Availability (限定利用)] にあります。私たちは正式リリースの前に小数の早期導入ユーザーからのフィードバックを積極的に求めています。[注文](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) 機能を有効にしている場合、すでに注文メトリクス機能は有効になっています。指定されたサブスクリプションのすべての注文に関する詳細情報を取得します。指定されたサブスクリプションに対する変更が含まれているすべての注文が返されます。この操作では、/v1/orders/subscription/{subscriptionNumber} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription Number (サブスクリプション番号)

String (文字列)

サブスクリプション番号。

x

End Date (終了日)

String (文字列)

結果には dateFilterOption の日付がこの日付以前の注文のみが含まれます。

Date Filter Option (日付検索条件オプション)

String (文字列)

絞り込みの基準となる日付種別。この項目値は「orderDate」または「updatedDate」です。デフォルトは orderDate です。

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Start Date (開始日)

String (文字列)

結果には dateFilterOption の日付がこの日付以降の注文のみが含まれます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型	Array of String (文字列の配列)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get orders by subscription owner

<mule-zuora-connector:get-v1-orders-subscription-owner-by-account-number>

注意: この機能は、[注文メトリクス](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) 機能を有効にしている場合のみ使用できます。注文メトリクスへの移行は [Limited Availability (限定利用)] にあります。私たちは正式リリースの前に小数の早期導入ユーザーからのフィードバックを積極的に求めています。[注文](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) 機能を有効にしている場合、すでに注文メトリクス機能は有効になっています。指定されたサブスクリプションオーナーのすべての注文に関する詳細情報を取得します。このアカウントが所有するサブスクリプションに対する変更が含まれているすべての注文が返されます。この操作では、/v1/orders/subscriptionOwner/{accountNumber} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account Number (アカウント番号)

String (文字列)

サブスクリプションオーナーのアカウント番号。

x

End Date (終了日)

String (文字列)

結果には dateFilterOption の日付がこの日付以前の注文のみが含まれます。

Date Filter Option (日付検索条件オプション)

String (文字列)

絞り込みの基準となる日付種別。この項目値は「orderDate」または「updatedDate」です。デフォルトは orderDate です。

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Start Date (開始日)

String (文字列)

結果には dateFilterOption の日付がこの日付以降の注文のみが含まれます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型	Array of String (文字列の配列)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get term information for subscription

<mule-zuora-connector:get-v1-orders-term-by-subscription-number>

注意: この機能は、[注文メトリクス](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) 機能を有効にしている場合のみ使用できます。注文メトリクスへの移行は [Limited Availability (限定利用)] にあります。私たちは正式リリースの前に小数の早期導入ユーザーからのフィードバックを積極的に求めています。[注文](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) 機能を有効にしている場合、すでに注文メトリクス機能は有効になっています。指定されたサブスクリプションの条件を取得します。この操作では、/v1/orders/term/{subscriptionNumber} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription Number (サブスクリプション番号)

String (文字列)

期間を取得するサブスクリプションの番号。例: A-S00000001。

x

version

Number (数値)

期間を取得するサブスクリプションのバージョン。このパラメーターを指定しない場合、Zuora はサブスクリプションの最新バージョンの期間を返します。

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型	Array of String (文字列の配列)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get credit card payment methods for account

<mule-zuora-connector:get-v1-payment-methods-credit-cards-accounts-by-account-key>

この REST API リファレンスでは、指定された顧客アカウントのすべてのクレジットカード情報を取得する方法について説明します。## 注意応答には、指定された顧客アカウントのクレジットカードまたはデビットカードの詳細が含まれます。カード番号は「**1234」のようにマスクされます。カードは最終更新を基準に新しいものから順に返されます。銀行振替または ACH 種別の支払方法の要求を送信できます。ただし、応答にはこれらの支払方法の有効な詳細が含まれません。この操作では、/v1/payment-methods/credit-cards/accounts/{account-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account key (アカウントキー)

String (文字列)

アカウント番号またはアカウント ID。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get stored credential profiles

<mule-zuora-connector:get-v1-payment-methods-profiles-by-payment-method-id>

支払方法内に保存されたログイン情報プロファイルを取得します。 注意: この機能は使用制限されています。私たちは正式リリースの前に小数の早期導入ユーザーからのフィードバックを積極的に求めています。この操作では、/v1/payment-methods/{payment-method-id}/profiles エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment method id (支払い方法 ID)

String (文字列)

支払い方法の ID。

x

Include All (すべて含む)

Boolean (ブール)

支払方法内に保存されたログイン情報プロファイルをすべて取得するかどうかを指定します。デフォルトでは、Zuora は状況が Agreed または Active の保存されたログイン情報プロファイルのみを返します。このパラメーターを true に設定すると、Zuora は保存されたログイン情報プロファイルをすべて返します。

false

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get payment runs

<mule-zuora-connector:get-v1-payment-runs>

すべての支払実行に関する情報を取得します。絞り込み可能な項目を定義して、応答で返されるデータを制限できます。# 絞り込みクエリパラメーターを使用して、応答で返されるデータを制限できます。各クエリパラメーターはレスポンスボディの 1 つの項目に対応しています。絞り込み可能な項目の値が文字列の場合、絞り込むときに対応するクエリパラメーターを null に設定します。この場合、この項目値が null の応答データを取得できます。例: - /v1/payment-runs?status=Processed - /v1/payment-runs?targetDate=2017-10-10&status=Pending - /v1/payment-runs?status=Completed&sort=+updatedDate この操作では、/v1/payment-runs エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Target Date (対象日付)

String (文字列)

このパラメーターは targetDate 項目に基づいて応答を絞り込みます。

Created By Id (作成者 ID)

String (文字列)

このパラメーターは createdById 項目に基づいて応答を絞り込みます。

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

status (状況)

Enumeration (列挙)。次のいずれかになります。

PENDING
PROCESSING
COMPLETED
ERROR
CANCELED

このパラメーターは status 項目に基づいて応答を絞り込みます。

Updated By Id (更新者 ID)

String (文字列)

このパラメーターは updatedById 項目に基づいて応答を絞り込みます。

sort (並び替え)

String (文字列)

このパラメーターにより、応答で返されるデータの順序が制限されます。このパラメーターを使用して、並べ替える次元を指定できます。ソート可能な項目は次の形式になります: operator field_name 1 つの URL パスで使用できるソート可能な項目は最大 2 つです。ソート可能な項目を区切るにはカンマを使用します。例: operator field_name, operator field_name operator はシーケンスの順序をマークするために使用します。オペレーターは省略可能です。オペレーターを付けずに並び替え可能な項目のみを指定した場合、応答データはこの項目によって降順で並び替えられます。- - オペレーターは昇順を示します。- + オペレーターは降順を示します。デフォルトでは、応答データは支払実行番号によって降順で表示されます。 field_name はソート可能な項目の名前を示します。この操作のサポートされる並び替え可能な項目は次のとおりです: - targetDate - status - createdDate - createdById - updatedDate - updatedById。例: - /v1/payment-runs?sort=+createdDate - /v1/payment-runs?status=Processing&sort=-createdById,+targetDate

Updated (更新日)

String (文字列)

このパラメーターは updatedDate 項目に基づいて応答を絞り込みます。

Created Date (作成日)

String (文字列)

このパラメーターは createdDate 項目に基づいて応答を絞り込みます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get payment run

<mule-zuora-connector:get-v1-payment-runs-by-payment-run-id>

特定の支払実行に関する情報を取得します。この操作では、/v1/payment-runs/{paymentRunId} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment Run Id (支払い実行 ID)

String (文字列)

支払実行の一意の ID。例: 402890245f097f39015f0f074a2e0566。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get payment run summary

<mule-zuora-connector:get-v1-payment-runs-summary-by-payment-run-id>

支払実行のサマリーを取得します。この操作では、/v1/payment-runs/{paymentRunId}/summary エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment Run Id (支払い実行 ID)

String (文字列)

支払実行の一意の ID。例: 402890245f097f39015f0f074a2e0566。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get payment gateways

<mule-zuora-connector:get-v1-paymentgateways>

すべての支払ゲートウェイに関する基本情報を取得します。この操作では、/v1/paymentgateways エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get all payments

<mule-zuora-connector:get-v1-payments>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。すべての顧客アカウントからのすべての支払に関する情報を取得します。# 絞り込みクエリパラメーターを使用して、応答で返されるデータを制限できます。各クエリパラメーターはレスポンスボディの 1 つの項目に対応しています。絞り込み可能な項目の値が文字列の場合、絞り込むときに対応するクエリパラメーターを null に設定します。この場合、この項目値が null の応答データを取得できます。例: - /v1/payments?status=Processed - /v1/payments?currency=USD&status=Processed - /v1/payments?status=Processed&type=External&sort=+number この操作では、/v1/payments エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Unapplied Amount (適用されない額)

Number (数値)

このパラメーターは unappliedAmount 項目に基づいて応答を絞り込みます。

number (数値)

String (文字列)

このパラメーターは number 項目に基づいて応答を絞り込みます。

Created By Id (作成者 ID)

String (文字列)

このパラメーターは createdById 項目に基づいて応答を絞り込みます。

Applied Amount (適用される額)

Number (数値)

このパラメーターは appliedAmount 項目に基づいて応答を絞り込みます。

Account Id (アカウント ID)

String (文字列)

このパラメーターは accountId 項目に基づいて応答を絞り込みます。

Credit Balance Amount (クレジット差額)

Number (数値)

このパラメーターは creditBalanceAmount 項目に基づいて応答を絞り込みます。

amount (金額)

Number (数値)

このパラメーターは amount 項目に基づいて応答を絞り込みます。

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

status (状況)

Enumeration (列挙)。次のいずれかになります。

DRAFT
PROCESSING
PROCESSED (処理済み)
ERROR
CANCELED
POSTED

このパラメーターは status 項目に基づいて応答を絞り込みます。

Effective Date (発効日)

String (文字列)

このパラメーターは effectiveDate 項目に基づいて応答を絞り込みます。

currency (通貨)

String (文字列)

このパラメーターは currency 項目に基づいて応答を絞り込みます。

Refund Amount (払い戻し額)

Number (数値)

このパラメーターは refundAmount 項目に基づいて応答を絞り込みます。

Updated By Id (更新者 ID)

String (文字列)

このパラメーターは updatedById 項目に基づいて応答を絞り込みます。

sort (並び替え)

String (文字列)

このパラメーターにより、応答で返されるデータの順序が制限されます。このパラメーターを使用して、並べ替える次元を指定できます。ソート可能な項目は次の形式になります: operator field_name 1 つの URL パスで使用できるソート可能な項目は最大 2 つです。ソート可能な項目を区切るにはカンマを使用します。例: operator field_name, operator field_name operator はシーケンスの順序をマークするために使用します。オペレーターは省略可能です。オペレーターを付けずに並び替え可能な項目のみを指定した場合、応答データはこの項目によって降順で並び替えられます。- - オペレーターは昇順を示します。- + オペレーターは降順を示します。デフォルトでは、応答データは支払番号によって降順で表示されます。 field_name はソート可能な項目の名前を示します。この操作のサポートされる並び替え可能な項目は次のとおりです: - number - accountId - amount - appliedAmount - unappliedAmount - refundAmount - creditBalanceAmount - effectiveDate - createdDate - createdById - updatedDate - updatedById。例: - /v1/payments?sort=+number - /v1/payments?status=Processed&sort=-number,+amount

Type (型)

Enumeration (列挙)。次のいずれかになります。

EXTERNAL
ELECTRONIC (電子)

このパラメーターは type 項目に基づいて応答を絞り込みます。

Updated (更新日)

String (文字列)

このパラメーターは updatedDate 項目に基づいて応答を絞り込みます。

Created Date (作成日)

String (文字列)

このパラメーターは createdDate 項目に基づいて応答を絞り込みます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get payment

<mule-zuora-connector:get-v1-payments-by-payment-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。1 つの特定の支払に関する情報を取得します。この操作では、/v1/payments/{paymentId} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment Id (支払い ID)

String (文字列)

支払の一意の ID。例: 8a8082e65b27f6c3015b89e4344c16b1。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get payment parts

<mule-zuora-connector:get-v1-payments-parts-by-payment-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。支払のすべてのパートに関する情報を取得します。支払は未適用のパートと、請求書およびデビットメモに適用済みの複数のパートで構成される場合があります。この操作を使用して、支払の適用済みのパートと未適用のパートをすべて取得できます。この操作では、/v1/payments/{paymentId}/parts エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment Id (支払い ID)

String (文字列)

支払の一意の ID。例: 8a8082e65b27f6c3015b89e4344c16b1。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get payment part

<mule-zuora-connector:get-v1-payments-parts-by-payment-id-partid>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。特定の支払パートに関する情報を取得します。支払は未適用のパートと、請求書およびデビットメモに適用済みの複数のパートで構成される場合があります。この操作では、/v1/payments/{paymentId}/parts/{partid} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

partid

String (文字列)

特定の支払パートの一意の ID。支払パート ID は [Get payment parts](https://www.zuora.com/developer/api-reference/#operation/GET_PaymentParts) の応答から取得できます。

x

Payment Id (支払い ID)

String (文字列)

支払の一意の ID。例: 8a8082e65b27f6c3015b89e4344c16b1。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get payment part items

<mule-zuora-connector:get-v1-payments-parts-itemparts-by-payment-id-partid>

注意: 請求書項目決済機能は [Limited Availability (限定利用)] にあり、他の請求書決済機能 (未適用の支払、クレジットおよびデビットメモ) と一緒に使用する必要があります。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。支払パートのすべての項目に関する情報を取得します。支払パート項目とは、支払パートの 1 つの品目です。支払パートは、複数の異なる種別の項目で構成される場合があります。この操作では、/v1/payments/{paymentId}/parts/{partid}/itemparts エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

partid

String (文字列)

特定の支払パートの一意の ID。支払パート ID は [Get payment parts](https://www.zuora.com/developer/api-reference/#operation/GET_PaymentParts) の応答から取得できます。

x

Payment Id (支払い ID)

String (文字列)

支払の一意の ID。例: 8a8082e65b27f6c3015b89e4344c16b1。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get payment part item

<mule-zuora-connector:get-v1-payments-parts-itemparts-by-payment-id-partid-itempartid>

注意: 請求書項目決済機能は [Limited Availability (限定利用)] にあり、他の請求書決済機能 (未適用の支払、クレジットおよびデビットメモ) と一緒に使用する必要があります。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。特定の支払パート項目に関する情報を取得します。支払パート項目とは、支払パートの 1 つの品目です。支払パートは、複数の異なる種別の項目で構成される場合があります。この操作では、/v1/payments/{paymentId}/parts/{partid}/itemparts/{itempartid} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

partid

String (文字列)

特定の支払パートの一意の ID。支払パート ID は [Get payment parts](https://www.zuora.com/developer/api-reference/#operation/GET_PaymentParts) の応答から取得できます。

x

itempartid

String (文字列)

特定の支払パート項目の一意の ID。支払パート項目 ID は [Get payment part items](https://www.zuora.com/developer/api-reference/#operation/GET_PaymentItemParts) の応答から取得できます。

x

Payment Id (支払い ID)

String (文字列)

支払の一意の ID。例: 8a8082e65b27f6c3015b89e4344c16b1。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get product rate plans

<mule-zuora-connector:get-v1-rateplan-product-rate-plan-by-product-id>

特定の製品のすべての製品料金プランに関する情報を取得します。この操作では、/v1/rateplan/{product_id}/productRatePlan エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Product id (製品 ID)

String (文字列)

製品の一意の ID。例: 2c92c0f96487e16a016487f663c71a61。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get all refunds

<mule-zuora-connector:get-v1-refunds>

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。すべての払い戻しに関する情報を取得します。電子払い戻しと外部払い戻しの 2 つの種別の払い戻しが使用できます。# 絞り込みクエリパラメーターを使用して、応答で返されるデータを制限できます。各クエリパラメーターはレスポンスボディの 1 つの項目に対応しています。絞り込み可能な項目の値が文字列の場合、絞り込むときに対応するクエリパラメーターを null に設定します。この場合、この項目値が null の応答データを取得できます。例: - /v1/refunds?status=Processed - /v1/refunds?amount=4&status=Processed - /v1/refunds?status=Processed&type=External&sort=+number この操作では、/v1/refunds エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

number (数値)

String (文字列)

このパラメーターは number 項目に基づいて応答を絞り込みます。

Created By Id (作成者 ID)

String (文字列)

このパラメーターは createdById 項目に基づいて応答を絞り込みます。

Payment Id (支払い ID)

String (文字列)

このパラメーターは paymentId 項目に基づいて応答を絞り込みます。

Account Id (アカウント ID)

String (文字列)

このパラメーターは accountId 項目に基づいて応答を絞り込みます。

amount (金額)

Number (数値)

このパラメーターは amount 項目に基づいて応答を絞り込みます。

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Method Type (メソッドのタイプ)

Enumeration (列挙)。次のいずれかになります。

ACH
CASH (現金)
CHECK
CREDIT_CARD
PAY_PAL
WIRE_TRANSFER
DEBIT_CARD
CREDIT_CARD_REFERENCE_TRANSACTION
BANK_TRANSFER
OTHER

このパラメーターは methodType 項目に基づいて応答を絞り込みます。

status (状況)

Enumeration (列挙)。次のいずれかになります。

PROCESSED
CANCELED
ERROR
PROCESSING

このパラメーターは status 項目に基づいて応答を絞り込みます。

Updated By Id (更新者 ID)

String (文字列)

このパラメーターは updatedById 項目に基づいて応答を絞り込みます。

Refund Date (払い戻し日)

String (文字列)

このパラメーターは refundDate 項目に基づいて応答を絞り込みます。

sort (並び替え)

String (文字列)

このパラメーターにより、応答で返されるデータの順序が制限されます。このパラメーターを使用して、並べ替える次元を指定できます。ソート可能な項目は次の形式になります: operator field_name 1 つの URL パスで使用できるソート可能な項目は最大 2 つです。ソート可能な項目を区切るにはカンマを使用します。例: operator field_name, operator field_name operator はシーケンスの順序をマークするために使用します。オペレーターは省略可能です。オペレーターを付けずに並び替え可能な項目のみを指定した場合、応答データはこの項目によって降順で並び替えられます。- - オペレーターは昇順を示します。- + オペレーターは降順を示します。デフォルトでは、応答データは払い戻し番号によって降順で表示されます。 field_name はソート可能な項目の名前を示します。この操作のサポートされる並び替え可能な項目は次のとおりです: - number - accountId - amount - refundDate - paymentId - createdDate - createdById - updatedDate - updatedById。例: - /v1/refunds?sort=+number - /v1/refunds?status=Processed&sort=-number,+amount

Type (型)

Enumeration (列挙)。次のいずれかになります。

EXTERNAL
ELECTRONIC

このパラメーターは type 項目に基づいて応答を絞り込みます。

Updated (更新日)

String (文字列)

このパラメーターは updatedDate 項目に基づいて応答を絞り込みます。

Created Date (作成日)

String (文字列)

このパラメーターは createdDate 項目に基づいて応答を絞り込みます。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get refund

<mule-zuora-connector:get-v1-refunds-by-refund-id>

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。特定の払い戻しに関する情報を取得します。この操作では、/v1/refunds/{refundId} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Refund Id (払い戻し ID)

String (文字列)

払い戻しの一意の ID。例: 4028905f5a87c0ff015a889e590e00c9。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get refund parts

<mule-zuora-connector:get-v1-refunds-parts-by-refund-id>

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。払い戻しのすべてのパートに関する情報を取得します。この操作では、/v1/refunds/{refundId}/parts エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Refund Id (払い戻し ID)

String (文字列)

払い戻しの一意の ID。例: 4028905f5a87c0ff015a889e590e00c9。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get refund part

<mule-zuora-connector:get-v1-refunds-parts-by-refund-id-refundpartid>

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。特定の払い戻しパートに関する情報を取得します。この操作では、/v1/refunds/{refundId}/parts/{refundpartid} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

refundpartid

String (文字列)

特定の払い戻しパートの一意の ID。払い戻しパート ID は [Get refund parts](https://www.zuora.com/developer/api-reference/#operation/GET_RefundParts) の応答から取得できます。

x

Refund Id (払い戻し ID)

String (文字列)

払い戻しの一意の ID。例: 4028905f5a87c0ff015a889e590e00c9。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get refund part items

<mule-zuora-connector:get-v1-refunds-parts-itemparts-by-refund-id-refundpartid>

注意: 請求書項目決済機能は [Limited Availability (限定利用)] にあります。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。払い戻しパートのすべての項目に関する情報を取得します。払い戻しパート項目とは、払い戻しパートの 1 つの品目です。払い戻しパートは、複数の異なる種別の項目で構成される場合があります。この操作では、/v1/refunds/{refundId}/parts/{refundpartid}/itemparts エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

refundpartid

String (文字列)

特定の払い戻しパートの一意の ID。払い戻しパート ID は [Get refund parts](https://www.zuora.com/developer/api-reference/#operation/GET_RefundParts) の応答から取得できます。

x

Refund Id (払い戻し ID)

String (文字列)

払い戻しの一意の ID。例: 4028905f5a87c0ff015a889e590e00c9。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get refund part item

<mule-zuora-connector:get-v1-refunds-parts-itemparts-by-refund-id-refundpartid-itempartid>

注意: 請求書項目決済機能は [Limited Availability (限定利用)] にあります。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。特定の払い戻しパート項目に関する情報を取得します。払い戻しパート項目とは、払い戻しパートの 1 つの品目です。払い戻しパートは、複数の異なる種別の項目で構成される場合があります。この操作では、/v1/refunds/{refundId}/parts/{refundpartid}/itemparts/{itempartid} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

itempartid

String (文字列)

特定の払い戻しパート項目の一意の ID。払い戻しパート項目 ID は [Get refund part items](https://www.zuora.com/developer/api-reference/#operation/GET_RefundItemParts) の応答から取得できます。

x

refundpartid

String (文字列)

特定の払い戻しパートの一意の ID。払い戻しパート ID は [Get refund parts](https://www.zuora.com/developer/api-reference/#operation/GET_RefundParts) の応答から取得できます。

x

Refund Id (払い戻し ID)

String (文字列)

払い戻しの一意の ID。例: 4028905f5a87c0ff015a889e590e00c9。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get revenue event details

<mule-zuora-connector:get-v1-revenue-events-by-event-number>

この REST API リファレンスでは、収益イベント番号を指定して収益イベントの詳細を取得する方法について説明します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/revenue-events/{event-number} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Event number (イベント番号)

String (文字列)

収益イベントに関連付けられた番号。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get revenue events for a revenue schedule

<mule-zuora-connector:get-v1-revenue-events-revenue-schedules-by-rs-number>

この REST API リファレンスでは、収益スケジュール番号を指定して収益スケジュールのすべての収益イベントを取得する方法について説明します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/revenue-events/revenue-schedules/{rs-number} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Rs number (Rs 番号)

String (文字列)

収益スケジュール番号。収益スケジュール番号には必ず「RS」というプレフィックスが付きます。例: 「RS-00000001」。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

8

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get revenue items by charge revenue summary number

<mule-zuora-connector:get-v1-revenue-items-charge-revenue-summaries-by-crs-number>

この REST API リファレンスでは、チャージ収益サマリー番号を指定してチャージ収益サマリーの各収益項目の詳細を取得する方法について説明します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/revenue-items/charge-revenue-summaries/{crs-number} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Crs number (Crs 番号)

String (文字列)

チャージ収益サマリー番号。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

300

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get revenue items by revenue event number

<mule-zuora-connector:get-v1-revenue-items-revenue-events-by-event-number>

この REST API リファレンスでは、収益イベント番号を指定して収益イベントの各収益項目の詳細を取得する方法について説明します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/revenue-items/revenue-events/{event-number} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Event number (イベント番号)

String (文字列)

収益イベントに関連付けられた番号。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

300

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get revenue items by revenue schedule

<mule-zuora-connector:get-v1-revenue-items-revenue-schedules-by-rs-number>

この REST API リファレンスでは、収益スケジュール番号を指定して収益スケジュールの各収益項目の詳細を取得する方法について説明します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/revenue-items/revenue-schedules/{rs-number} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Rs number (Rs 番号)

String (文字列)

収益スケジュール番号。収益スケジュール番号には必ず「RS」というプレフィックスが付きます。例: 「RS-00000001」。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

300

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get revenue recognition rule by product rate plan charge

<mule-zuora-connector:get-v1-revenue-recognition-rules-product-charges-by-charge-key>

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。チャージ ID を指定して製品料金プランチャージに関連付けられた収益認識ルールを取得します。この操作では、/v1/revenue-recognition-rules/product-charges/{charge-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Charge key (チャージキー)

String (文字列)

製品料金プランチャージの一意の ID。例: 8a8082e65ba86084015bb323d3c61d82。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get revenue recognition rule by subscription charge

<mule-zuora-connector:get-v1-revenue-recognition-rules-subscription-charges-by-charge-key>

チャージ ID を指定してサブスクリプションチャージに関連付けられた収益認識ルールを取得します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/revenue-recognition-rules/subscription-charges/{charge-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Charge key (チャージキー)

String (文字列)

サブスクリプション料金プランチャージの一意の ID。例: 402892793e173340013e173b81000012。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get revenue schedule details

<mule-zuora-connector:get-v1-revenue-schedules-by-rs-number>

収益スケジュール番号を指定して収益スケジュールの詳細を取得します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/revenue-schedules/{rs-number} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Rs number (Rs 番号)

String (文字列)

収益スケジュール番号。収益スケジュール番号には必ず「RS」というプレフィックスが付きます。例: 「RS-00000001」。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get revenue schedule by credit memo item ID

<mule-zuora-connector:get-v1-revenue-schedules-credit-memo-items-by-cmi-id>

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。有効なクレジットメモ項目 ID を指定して収益スケジュールに関する詳細情報を取得します。この操作では、/v1/revenue-schedules/credit-memo-items/{cmi-id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Cmi id (Cmi ID)

String (文字列)

クレジットメモ項目の一意の ID。クレジットメモ項目 ID は [Get credit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoItems) の応答から取得できます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get revenue schedule by debit memo item ID

<mule-zuora-connector:get-v1-revenue-schedules-debit-memo-items-by-dmi-id>

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。有効なデビットメモ項目 ID を指定して収益スケジュールに関する詳細を取得します。この操作では、/v1/revenue-schedules/debit-memo-items/{dmi-id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Dmi id (Dmi ID)

String (文字列)

デビットメモ項目の一意の ID。デビットメモ項目 ID は [Get debit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems) の応答から取得できます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get revenue schedule by invoice item adjustment

<mule-zuora-connector:get-v1-revenue-schedules-invoice-item-adjustments-by-invoice-item-adj-key>

有効な請求書項目調整識別子を指定して収益スケジュールの詳細を取得します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice item adj key (請求書項目調整キー)

String (文字列)

請求書項目調整の ID。例: e20b07fd416dcfcf0141c81164fd0a72。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get revenue schedule by invoice item ID

<mule-zuora-connector:get-v1-revenue-schedules-invoice-items-by-invoice-item-id>

請求書項目 ID を指定して収益スケジュールの詳細を取得します。この操作では、/v1/revenue-schedules/invoice-items/{invoice-item-id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice item id (請求書項目 ID)

String (文字列)

有効な請求書項目 ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get all revenue schedules of product charge by charge ID and billing

<mule-zuora-connector:get-v1-revenue-schedules-product-charges-by-charge-key-account-key>

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。チャージ ID と請求アカウント ID を指定して製品料金プランチャージのすべての収益スケジュールに関する詳細を取得します。この操作では、/v1/revenue-schedules/product-charges/{charge-key}/{account-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account key (アカウントキー)

String (文字列)

アカウント番号またはアカウント ID。

x

Charge key (チャージキー)

String (文字列)

製品料金プランチャージの一意の ID。例: 8a8082e65ba86084015bb323d3c61d82。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

8

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get revenue schedule by subscription charge

<mule-zuora-connector:get-v1-revenue-schedules-subscription-charges-by-charge-key>

サブスクリプションチャージ ID を指定して収益スケジュールの詳細を取得します。要求と応答項目の説明およびサンプルコードが提供されます。この操作では、/v1/revenue-schedules/subscription-charges/{charge-key} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Charge key (チャージキー)

String (文字列)

サブスクリプション料金プランチャージの ID。例: 402892793e173340013e173b81000012。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

8

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get sequence sets

<mule-zuora-connector:get-v1-sequence-sets>

請求ドキュメント、支払い、返金に対して設定されているすべてのシーケンスセットに関する情報を取得します。請求ドキュメントには、請求書、クレジットメモ、およびデビットメモがあります。クエリパラメーターを使用して、応答で返されるデータを制限できます。 注意: クレジットメモとデビットメモ機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。この操作では、/v1/sequence-sets エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

name (名前)

String (文字列)

特定のシーケンスセットの名前。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get sequence set

<mule-zuora-connector:get-v1-sequence-sets-by-id>

請求ドキュメント、支払い、返金に対して設定されている特定のシーケンスセットに関する情報を取得します。請求ドキュメントには、請求書、クレジットメモ、およびデビットメモがあります。注意: クレジットメモとデビットメモ機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。この操作では、/v1/sequence-sets/{id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

情報を取得するシーケンスセットの ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get the revenue automation start date

<mule-zuora-connector:get-v1-settings-finance-revenue-automation-start-date>

この REST API リファレンスでは、収益自動化の開始日を取得する方法について説明します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/settings/finance/revenue-automation-start-date エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get subscriptions by account

<mule-zuora-connector:get-v1-subscriptions-accounts-by-account-key>

指定されたアカウントに関連付けられたすべてのサブスクリプションを取得します。Zuora では、最新バージョンのサブスクリプションのみが返されます。サブスクリプションデータは、updatedDate に基づいて新しいものから順に返されます。この操作では、/v1/subscriptions/accounts/{account-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account key (アカウントキー)

String (文字列)

可能な値: * アカウント番号 * アカウント ID

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Charge detail (チャージ詳細)

String (文字列)

セグメント化された料金プランチャージ。修正の結果がチャージに対する変更になる場合、Zuora はセグメント化された料金プランチャージを作成します。この項目を使用して、セグメントのチャージを追跡します。可能な値: * last-segment: (デフォルト) サブスクリプションの前回の料金プランチャージ。前回の料金プランチャージとは、サブスクリプションで最後に変更されたチャージではなく、サブスクリプションで時間順に最後のチャージです。 *current-segment: 今日の日付でアクティブなセグメント化されたチャージ (effectiveStartDate ⇐ 今日の日付 < effectiveEndDate)。 *all-segments: すべてのセグメント化されたチャージ。chargeSegments 項目は応答で返されます。chargeSegments 項目にはすべてのチャージセグメントのチャージ情報の配列が含まれます。 *specific-segment&as-of-date=date: 指定した日付でアクティブなセグメント化されたチャージ (effectiveStartDate <= 指定日 < effectiveEndDate)。日付の形式は yyyy-mm-dd です。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get subscriptions by key

<mule-zuora-connector:get-v1-subscriptions-by-subscription-key>

この REST API リファレンスでは、最新バージョンの指定されたサブスクリプションに関する詳細情報を取得する方法について説明します。この操作では、/v1/subscriptions/{subscription-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription key (サブスクリプションキー)

String (文字列)

可能な値: * サブスクリプション番号 * サブスクリプション ID

x

Charge detail (チャージ詳細)

String (文字列)

セグメント化された料金プランチャージ。修正の結果がチャージに対する変更になる場合、Zuora はセグメント化された料金プランチャージを作成します。この項目を使用して、セグメントのチャージを追跡します。可能な値: * last-segment: (デフォルト) サブスクリプションの前回の料金プランチャージ。前回の料金プランチャージとは、サブスクリプションで最後に変更されたチャージではなく、サブスクリプションで時間順に最後のチャージです。 *current-segment: 今日の日付でアクティブなセグメント化されたチャージ (effectiveStartDate ⇐ 今日の日付 < effectiveEndDate)。 *all-segments: すべてのセグメント化されたチャージ。chargeSegments 項目は応答で返されます。chargeSegments 項目にはすべてのチャージセグメントのチャージ情報の配列が含まれます。 *specific-segment&as-of-date=date: 指定した日付でアクティブなセグメント化されたチャージ指定日 = effectiveStartDate) OR (effectiveStartDate < 指定日 < effectiveEndDate。日付の形式は yyyy-mm-dd です。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get subscriptions by key and version

<mule-zuora-connector:get-v1-subscriptions-versions-by-subscription-key-version>

この REST API リファレンスでは、指定されたバージョンの指定されたサブスクリプションに関する詳細情報を取得する方法について説明します。サブスクリプション修正を作成するときに、新しいバージョンのサブスクリプションを作成します。このメソッドを使用して、任意のバージョンのサブスクリプションに関する情報を取得できます。この操作では、/v1/subscriptions/{subscription-key}/versions/{version} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription key (サブスクリプションキー)

String (文字列)

サブスクリプション番号。たとえば、A-S00000135 です。

x

version

String (文字列)

サブスクリプションバージョン。たとえば、1 です。

x

Charge detail (チャージ詳細)

String (文字列)

セグメント化された料金プランチャージ。修正の結果がチャージに対する変更になる場合、Zuora はセグメント化された料金プランチャージを作成します。この項目を使用して、セグメントのチャージを追跡します。可能な値: * last-segment: (デフォルト) サブスクリプションの前回の料金プランチャージ。前回の料金プランチャージとは、サブスクリプションで最後に変更されたチャージではなく、サブスクリプションで時間順に最後のチャージです。 *current-segment: 今日の日付でアクティブなセグメント化されたチャージ (effectiveStartDate ⇐ 今日の日付 < effectiveEndDate)。 *all-segments: すべてのセグメント化されたチャージ。chargeSegments 項目は応答で返されます。chargeSegments 項目にはすべてのチャージセグメントのチャージ情報の配列が含まれます。 *specific-segment&as-of-date=date: 指定した日付でアクティブなセグメント化されたチャージ (effectiveStartDate <= 指定日 < effectiveEndDate)。日付の形式は yyyy-mm-dd です。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get taxation item

<mule-zuora-connector:get-v1-taxationitems-by-id>

ID を基準に特定の課税項目に関する情報を取得します。この操作では、/v1/taxationitems/{id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

課税項目の一意の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get invoices

<mule-zuora-connector:get-v1-transactions-invoices-accounts-by-account-key>

指定されたアカウントの請求書を取得します。請求書は、updatedDate を基準に新しいものから順に返されます。この操作では、/v1/transactions/invoices/accounts/{account-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account key (アカウントキー)

String (文字列)

アカウント番号またはアカウント ID。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get payments

<mule-zuora-connector:get-v1-transactions-payments-accounts-by-account-key>

指定されたアカウントの支払を取得します。支払は、updatedDate を基準に新しいものから順に返されます。この操作では、/v1/transactions/payments/accounts/{account-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account key (アカウントキー)

String (文字列)

アカウント番号またはアカウント ID。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get usage

<mule-zuora-connector:get-v1-usage-accounts-by-account-key>

この REST API リファレンスでは、アカウントの使用状況の詳細を取得する方法について説明します。使用状況データは、新しいものから順に返されます。この操作では、/v1/usage/accounts/{account-key} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account key (アカウントキー)

String (文字列)

アカウント番号またはアカウント ID。

x

Page Size (ページサイズ)

Number (数値)

ページごとに返される行数。

20

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求で取得する初期ページ。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
non-repeatable-iterable

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Get entities that a user can access

<mule-zuora-connector:get-v1-users-accessible-entities-by-username>

注意: Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。ユーザーがアクセスする権限を持つすべてのエンティティに関する詳細情報を取得します。## ユーザーアクセス権限任意のエンティティユーザーとしてコールを行うことができます。この操作では、/v1/users/{username}/accessible-entities エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

username (ユーザー名)

String (文字列)

取得するログインユーザー名を指定します。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get workflows

<mule-zuora-connector:get-workflows>

Zuora テナントで使用可能なワークフローのリストを取得します。この操作では、/workflows エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

name (名前)

String (文字列)

指定した場合、この操作では指定された名前に含まれるワークフローを取得します。

Callout trigger (コールアウトトリガー)

Boolean (ブール)

true に設定した場合、この操作ではコールアウトトリガーが有効になっているワークフローを取得します。false に設定した場合、この操作ではコールアウトトリガーが無効になっているワークフローを取得します。指定しない場合、この操作ではこの検索条件を使用しません。

false

page (ページ)

Number (数値)

特定のページのワークフローのみを取得するには、クエリで page 番号を指定できます。

1

interval (間隔)

String (文字列)

スケジュールを指定する CRON 式 (例: 0 0 * * *)。指定した場合、この操作では指定されたスケジュールに基づいて実行されるワークフローを取得します。

Ondemand trigger (オンデマンドトリガー)

Boolean (ブール)

true に設定した場合、この操作ではオンデマンドトリガーが有効になっているワークフローを取得します。false に設定した場合、この操作ではオンデマンドトリガーが無効になっているワークフローを取得します。指定しない場合、この操作ではこの検索条件を使用しません。

false

Page length (ページの長さ)

Number (数値)

1 回のコールに表示されるワークフローの数。page パラメーターが指定されていない場合、この操作では結果の最初のページのみが返されます。複数のページの結果がある場合、page パラメーターと一緒に使用して以降のページの結果を取得します。

20

Scheduled trigger (スケジュール済みトリガー)

Boolean (ブール)

true に設定した場合、この操作ではスケジュール済みトリガーが有効になっているワークフローを取得します。false に設定した場合、この操作ではスケジュール済みトリガーが無効になっているワークフローを取得します。指定しない場合、この操作ではこの検索条件を使用しません。

false

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get a workflow by ID

<mule-zuora-connector:get-workflows-by-workflow-id>

その ID を基準に特定のワークフローに関する情報を取得します。この操作では、/workflows/{workflow_id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Workflow id (ワークフロー ID)

String (文字列)

ワークフローの一意の ID。たとえば、19080 です。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Export a workflow

<mule-zuora-connector:get-workflows-export-by-workflow-id>

JSON ドキュメントのワークフローをエクスポートします。このドキュメントを使用して、このワークフローのコピーを作成できます。この操作では、/workflows/{workflow_id}/export エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Workflow id (ワークフロー ID)

Number (数値)

エクスポートするワークフローの ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get workflow task usage

<mule-zuora-connector:get-workflows-metricsjson>

指定された期間内でのワークフロータスクの日別使用状況を取得します。この操作では、/workflows/metrics.json エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Start Date (開始日)

String (文字列)

取得する使用状況データの開始日。たとえば、2019-01-01 です。

x

End Date (終了日)

String (文字列)

取得する使用状況データの終了日。たとえば、2019-12-31 です。

x

メトリクス

String (文字列)

取得するメトリクスの種別。現在、taskCount のみがサポートされています。 taskCount は、タスク実行回数です。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get tasks

<mule-zuora-connector:get-workflows-tasks>

Zuora テナントで使用可能なワークフロータスクのリストを取得します。この操作では、/workflows/tasks エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

name (名前)

String (文字列)

指定された名前に含まれるタスクを取得します。

Call type (コール種別)

String (文字列)

指定された API コール種別が使用されているタスクを取得します。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Get a task by ID

<mule-zuora-connector:get-workflows-tasks-by-task-id>

その ID を基準に特定のワークフローを取得します。この操作では、/workflows/tasks/{task_id} エンドポイントに対する HTTP GET 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Task id (タスク ID)

String (文字列)

タスクの一意の ID。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update individual fields in a custom object record

<mule-zuora-connector:patch-objects-records-default-by-object-id>

カスタムオブジェクトレコードの 1 つ以上の項目を更新します。パッチ更新では、 RFC 7386 で指定された JSON マージパッチを使用します。

制限事項

レコードに空の文字列を保存することはできません。
null 値は、次の例のように書式設定する必要があります。
{ "records": [ { "fieldName__c": null } ] }

この操作では、/objects/records/default/{object}/{id} エンドポイントに対する HTTP PATCH 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

object

String (文字列)

カスタムオブジェクトの API 参照名をオブジェクトとして指定します。これは大文字と小文字が区別されます。

x

id

String (文字列)

uuid 形式の ID 識別子。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。 Zuora Multi-entity を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}

x

Zuora Version (Zuora バージョン)

String (文字列)

応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで Zuora-Version を指定してください。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update an Event Trigger

<mule-zuora-connector:update-events-event-triggers-by-id>

イベントトリガーを更新します。この操作では、/events/event-triggers/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

id

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update an email template

<mule-zuora-connector:update-notifications-email-templates-by-id>

メールテンプレートを更新します。この操作では、/notifications/email-templates/{id} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

更新するメールテンプレートの ID。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。Zuora テナントで通知機能と設定可能イベント機能を有効にした後で、OAuth トークンを再生成する必要があります。これらの機能を有効にする前に生成された OAuth トークンは機能しません。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update a notification definition

<mule-zuora-connector:update-notifications-notification-definitions-by-id>

通知定義を更新します。この操作では、/notifications/notification-definitions/{id} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

更新する通知定義の ID。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。Zuora テナントで通知機能と設定可能イベント機能を有効にした後で、OAuth トークンを再生成する必要があります。これらの機能を有効にする前に生成された OAuth トークンは機能しません。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update custom object record

<mule-zuora-connector:update-objects-records-default-by-object-id>

指定された種別と ID のレコードを更新します。 ## 制限: * レコードの空の文字列のストレージはサポートされません。 *null 値は次の例のような形式にする必要があります。{ "records": [ { "fieldName__c": null } ] }。この操作では、/objects/records/default/{object}/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

object

String (文字列)

カスタムオブジェクトの API 参照名をオブジェクトとして指定します。これは大文字と小文字が区別されます。

x

id

String (文字列)

uuid 形式の ID 識別子。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Version (Zuora バージョン)

String (文字列)

応答スキーマを決定する API バージョン。このパラメーターが省略された場合はデフォルトバージョンが使用されます。特定の応答スキーマを想定する場合は、リクエストヘッダーで Zuora-Version を指定してください。

If Match (一致する場合)

String (文字列)

リソースの期待される ETag。このヘッダーを使用して条件付き要求を実行できます。リソースの ETag がこのヘッダーの値と一致しない場合、Zuora は「412 Precondition Failed (412 前提条件失敗)」で応答します。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Activate accounting code

<mule-zuora-connector:update-v1-accounting-codes-activate-by-ac-id>

このリファレンスでは、REST API を使用して勘定コードを有効化する方法について説明します。前提条件 ------------- テナントで Zuora Finance を有効にしている場合、「Manage Accounting Code (勘定コードの管理)」権限が必要です。この操作では、/v1/accounting-codes/{ac-id}/activate エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ac id (Ac ID)

String (文字列)

有効化する勘定コードの ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update an accounting code

<mule-zuora-connector:update-v1-accounting-codes-by-ac-id>

このリファレンスでは、REST API を使用して既存の勘定コードを更新する方法について説明します。前提条件: テナントで Zuora Finance を有効にしている場合、「Manage Accounting Code (勘定コードの管理)」権限が必要です。制限更新できるのは、まだトランザクションに関連付けられていない勘定コードのみです。この操作では、/v1/accounting-codes/{ac-id} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ac id (Ac ID)

String (文字列)

更新するアカウンティングコードの ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Deactivate accounting code

<mule-zuora-connector:update-v1-accounting-codes-deactivate-by-ac-id>

このリファレンスでは、REST API を使用して勘定コードを無効化する方法について説明します。

始める前に

テナントで Zuora Finance を有効にしている場合、「Manage Accounting Code (勘定コードの管理)」権限が必要です。

制限事項

無効化できるのは、トランザクションに関連付けられていない勘定コードのみです。AccountsReceivable 種別の勘定コードは無効にできません。

この操作では、/v1/accounting-codes/{ac-id}/deactivate エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ac id (Ac ID)

String (文字列)

無効化する勘定コードの ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update accounting period

<mule-zuora-connector:update-v1-accounting-periods-by-ap-id>

会計期間を更新します。この操作では、/v1/accounting-periods/{ap-id} エンドポイントに対する HTTP PUT 要求を行います。

始める前に

Zuora Finance をテナントで有効にしている必要があります。
「アカウンティング期間の作成」ユーザー権限が必要です。[「Finance Roles (Finance ロール)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles) を参照してください。

制限事項

更新できるのは、テナントの最も早い会計期間の開始日のみです。
後の期間の開始日は更新できません。 *最も早い会計期間を更新する場合、開始日はテナントの最も早いトランザクションの日付以前である必要があります。
アカウンティング期間の開始日と終了日は隣接している必要があります。たとえば、1 つのアカウンティング期間が 1 月 31 日に終了する場合、次の期間は 2 月 1 日に開始する必要があります。
収益認識パッケージがあり、「Monthly recognition over time (毎月の継続的な認識)」収益認識モデルを有効にしている場合、アカウンティング期間の開始日と終了日はそれぞれ月の最初の日と最後の日である必要があります。開始日と終了日は必ずしも同じ月である必要はありません。
次の場合、会計期間の開始日または終了日を更新できません。
- 収益が期間に分配されている。
- 期間にアクティブなジャーナルエントリがある。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ap id (Ap ID)

String (文字列)

更新する会計期間の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Close accounting period

<mule-zuora-connector:update-v1-accounting-periods-close-by-ap-id>

会計期間 ID によって会計期間をクローズします。この操作では、/v1/accounting-periods/{ap-id}/close エンドポイントに対する HTTP PUT 要求を行います

始める前に

Zuora Finance をテナントで有効にしている必要があります。
「Manage Close Process (クローズプロセスの管理)」ユーザー権限と「Run Trial Balance (試算表の実行)」ユーザー権限が必要です。

制限事項

すでにクローズされている会計期間はクローズすることはできません。
試算表の実行中である会計期間はクローズすることはできません。
以前の会計期間はすべてクローズする必要があります。
会計期間に必須のアクション項目があってはいけません。詳細は「Reconcile Transactions Before Closing an Accounting Period (会計期間をクローズする前のトランザクションの消し込み)」を参照してください。

注意事項

Zuora で会計期間をクローズする場合、試算表がその期間について自動的に実行されます。正常な応答が意味するのは、会計期間がクローズされたことのみであり、試算表の実行が正常に完了したことではありません。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ap id (Ap ID)

String (文字列)

クローズする会計期間の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Set accounting period to pending close

<mule-zuora-connector:update-v1-accounting-periods-pending-close-by-ap-id>

会計期間をクローズ待機中に設定します。この操作では、/v1/accounting-periods/{ap-id}/pending-close エンドポイントに対する HTTP PUT 要求を行います

始める前に

Zuora Finance をテナントで有効にしている必要があります。
「Manage Close Process (クローズプロセスの管理)」ユーザー権限と「Run Trial Balance (試算表の実行)」ユーザー権限が必要です。

制限事項

会計期間をクローズしたり、クローズ待機中にしたりすることはできません。
試算表の実行中である会計期間はクローズすることはできません。
以前の会計期間はすべてクローズする必要があります。

注意事項

Zuora で会計期間をクローズ待機中に設定する場合、試算表がその期間について自動的に実行されます。{ "success": true } の応答が意味するのは、会計期間の状況がクローズ待機中になったことのみであり、試算表の実行が正常に完了したことではありません。

Get Accounting Period REST API コールを使用して、試算表の結果に関する詳細を表示できます。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ap id (Ap ID)

String (文字列)

クローズ待機中に設定する会計期間の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Re-open accounting period

<mule-zuora-connector:update-v1-accounting-periods-reopen-by-ap-id>

会計期間を再度開きます。この操作では、/v1/accounting-periods/{ap-id}/reopen エンドポイントに対する HTTP PUT 要求を行います。

始める前に

Zuora Finance をテナントで有効にしている必要があります。
「Manage Close Process (クローズプロセスの管理)」ユーザー権限と「Run Trial Balance (試算表の実行)」ユーザー権限が必要です。

制限事項

会計期間をクローズかクローズ待機中にする必要があります。
再オープンできるのは、オープン期間の直前の会計期間のみです。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ap id (Ap ID)

String (文字列)

再オープンする会計期間の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Run Trial Balance

<mule-zuora-connector:update-v1-accounting-periods-run-trial-balance-by-ap-id>

会計期間の試算表を実行します。この操作では、/v1/accounting-periods/{ap-id}/run-trial-balance エンドポイントに対する HTTP PUT 要求を行います

始める前に

Zuora Finance をテナントで有効にしている必要があります。
「Manage Close Process (クローズプロセスの管理)」ユーザー権限と「Run Trial Balance (試算表の実行)」ユーザー権限が必要です。[「Finance Roles (Finance ロール)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles) を参照してください。

制限事項

会計期間は開いている必要があります。
すでに試算表の実行中である会計期間は閉じることができません。

注意事項

試算表は非同期で実行されます。{ "success": true } の応答が意味するのは、試算表の処理が開始されたことのみであり、試算表の実行が正常に完了したことではありません。

[Get Accounting Period](https://www.zuora.com/developer/api-reference/#operation/GET_AccountingPeriod) REST API コールを使用して、試算表の結果に関する詳細を表示できます。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ap id (Ap ID)

String (文字列)

試算表を実行する会計期間の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update account

<mule-zuora-connector:update-v1-accounts-by-account-key>

アカウントキーを指定して顧客アカウントを更新します。

注意事項

指定する必要があるのは変更する項目のみです。リクエストボディに含まれない項目は変更されません。
この操作で空白の項目が送信された場合、アカウントの対応する項目は空白になります。
メールアドレス: メールアドレスを指定しない場合、ファイルのメールアドレスまたはメール配信設定に対する変更は行われません。personalEmail と workEmail のいずれか (または両方) を指定した場合、システムによってファイルの対応するメールアドレスが更新され、メール配信設定が true に設定されます。(この場合、メールは workEmail アドレスが存在する場合はこのアドレスに配信され、存在しない場合は personalEmail アドレスに配信されます)。
一方、このコールの結果としてアカウントの両方のメールアドレスが空になった場合、メール配信設定は false に設定されます。
配信先取引先責任者と販売先取引先責任者は個別のデータエンティティです。一方を更新してももう一方は更新されません。この操作では、/v1/accounts/{account-key} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Account key (アカウントキー)

String (文字列)

アカウント番号またはアカウント ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Edit Attachments

<mule-zuora-connector:update-v1-attachments-by-attachment-id>

Edit Attachment REST 要求を使用して、説明やファイル名など、添付ファイルの説明的な項目に対する変更を行います。

Zuora では添付されたファイルの実際のコンテンツは変更できません。実際のコンテンツを変更する必要がある場合、添付ファイルを削除して更新済みのファイルを新しい添付ファイルとして追加する必要があります。

この操作では、/v1/attachments/{attachment-id} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Attachment id (アタッチメント ID)

String (文字列)

更新する添付ファイルの ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Stop Mass Action

<mule-zuora-connector:update-v1-bulk-stop-by-bulk-key>

このリファレンスでは、REST API を使用してマスアクションを停止する方法について説明します。

マスアクションは、その状況が [Pending (保留中)] または [Processing (処理中)] の場合に停止できます。マスアクションを停止した後で、マスアクションの結果を取得してマスアクションの詳細を確認できます。

その状況が [Pending (保留中)] の場合にマスアクションを停止した場合、レコードが処理されていないため、応答ファイルは生成されません。
その状況が [Processing (処理中)] の場合にマスアクションを停止した場合、応答ファイルが生成されます。

応答ファイルを確認して、処理されたレコードと処理されていないレコードを確認できます。応答ファイルで、処理済みのレコードでは [Success (成功)] 列の値が Y (成功) または N (失敗) になり、未処理のレコードでは空白値になります。マスアクションが停止された時点で処理済みのレコードはロールバックされません。

この操作では、/v1/bulk/{bulk-key}/stop エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Bulk key (バルクキー)

String (文字列)

マスアクションを識別する 32 文字の文字列。バルクキーは REST API を使用してマスアクションを実行した後で取得します。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Scrub Contact

<mule-zuora-connector:update-v1-contacts-scrub-by-contact-id>

特定の取引先責任者の機密データを無効にします。

この操作を使用して、取引先責任者のすべての機密データおよび関連する取引先責任者スナップショットをダミーの値に置き換えて Zuora データベースに保存することができます。取引先責任者を無効にした後で、削除することをお勧めします。削除しないと、以降の操作でエラーが発生する場合もあります。

注意: この操作を使用するには、ユーザーロールで「Scrub Sensitive Data of Contact (取引先責任者の機密データの無効化)」請求権限を有効にしている必要があります。この権限を有効にするには、テナント管理者に連絡してください。詳細は、[「Scrub Contacts (取引先責任者の無効化)」](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/A_How_to_Manage_Customer_Accounts/B_Key_Contacts/Scrub_Contacts) を参照してください。

この操作では、/v1/contacts/{contactId}/scrub エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Contact Id (取引先責任者 ID)

String (文字列)

機密データを無効にする取引先責任者の ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Apply Credit Memo

<mule-zuora-connector:update-v1-creditmemos-apply-by-credit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。投稿されたクレジットメモを 1 件以上の請求書およびデビットメモに適用します。

クレジットメモを請求書またはデビットメモに適用できるのは、ユーザー権限を持っている場合のみです。詳細は、[「Billing Roles (請求ロール)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) を参照してください。クレジットメモを適用する場合、クレジットメモが適用される請求書とデビットメモの合計数は 1,000 件以下である必要があります。比例配分適用ルールを使用する場合、クレジットメモを適用するときに、次の数量が 10,000 以下である必要があります: (請求書項目の数 + デビットメモ項目の数) * クレジットメモ項目の数。それ以外の場合、比例配分ルールの代わりに先入れ先出しルールが使用されます。

この操作では、/v1/creditmemos/{creditMemoId}/apply エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update Credit Memo

<mule-zuora-connector:update-v1-creditmemos-by-credit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスしたい場合は、Zuora グローバルサポートに要求を送信してください。クレジットメモに関する基本情報および金融情報を更新します。現在のところ、Zuora では外税のメモ項目の更新はサポートされていますが、内税のメモ項目の更新はサポートされていません。

メモ項目の金額が更新された場合、税金は次の条件で再計算されます。

メモは製品料金プランチャージから作成され、税金の計算には Avalara を使用します。 *メモは請求書から作成され、税金の計算には Avalara または Zuora Tax を使用します。

クレジットメモは、ユーザー権限を持っている場合のみ更新できます。詳細は、[「Billing Roles (請求ロール)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) を参照してください。

この操作では、/v1/creditmemos/{creditMemoId} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Cancel Credit Memo

<mule-zuora-connector:update-v1-creditmemos-cancel-by-credit-memo-id>

請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

クレジットメモをキャンセルします。キャンセルできるのは、状況が [Draft (下書き)] のクレジットメモのみです。

クレジットメモは、ユーザー権限を持っている場合のみキャンセルできます。詳細は、[「Billing Roles (請求ロール)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) を参照してください。

この操作では、/v1/creditmemos/{creditMemoId}/cancel エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Post credit memo

<mule-zuora-connector:update-v1-creditmemos-post-by-credit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

クレジットメモを転記して有効化します。

クレジットメモは、請求権限を持っている場合のみ転記できます。

この操作では、/v1/creditmemos/{creditMemoId}/post エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Unapply credit memo

<mule-zuora-connector:update-v1-creditmemos-unapply-by-credit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。適用されたクレジットメモを 1 件以上の請求書およびデビットメモから適用解除します。請求書およびデビットメモからの適用済みの全金額がクレジットメモの適用解除済みの金額に振り替えられます。クレジットメモを請求書またはデビットメモから適用解除できるのは、ユーザー権限を持っている場合のみです。詳細は、[「Billing Roles (請求ロール)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) を参照してください。クレジットメモを適用解除する場合、クレジットメモが適用解除される請求書とデビットメモの合計数は 1,000 件以下である必要があります。比例配分適用ルールを使用する場合、クレジットメモを適用解除するときに、次の数量が 10,000 以下である必要があります: (請求書項目の数 + デビットメモ項目の数) * クレジットメモ項目の数。それ以外の場合、比例配分ルールの代わりに先入れ先出しルールが使用されます。この操作では、/v1/creditmemos/{creditMemoId}/unapply エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Unpost credit memo

<mule-zuora-connector:update-v1-creditmemos-unpost-by-credit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。状況が [Posted (転記済み)] のクレジットメモの転記を取り消します。クレジットメモが適用されているか払い戻されている場合、転記を取り消すことはできません。クレジットメモの転記を取り消すと、その状況が [Draft (下書き)] になります。クレジットメモは、[請求権限](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions) を持っている場合のみ転記を取り消すことができます。この操作では、/v1/creditmemos/{creditMemoId}/unpost エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Credit Memo Id (クレジットメモ ID)

String (文字列)

クレジットメモの一意の ID。例: 8a8082e65b27f6c3015ba45ff82c7172。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

PUT Batch Update Debit Memos

<mule-zuora-connector:update-v1-debitmemos>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。1 回のコールで複数のデビットメモの期日を一括で更新します。この操作では、/v1/debitmemos エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update debit memo

<mule-zuora-connector:update-v1-debitmemos-by-debit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。デビットメモに関する基本情報および金融情報を更新します。現在のところ、Zuora では外税のメモ項目の更新はサポートされていますが、内税のメモ項目の更新はサポートされていません。メモ項目の金額が更新された場合、税金は次の条件で再計算されます: - メモは製品料金プランチャージから作成され、税金の計算には Avalara を使用します。- メモは請求書から作成され、税金の計算には Avalara または Zuora Tax を使用します。デビットメモは、ユーザー権限を持っている場合のみ更新できます。詳細は、[「Billing Roles (請求ロール)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) を参照してください。この操作では、/v1/debitmemos/{debitMemoId} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Debit Memo Id (デビットメモ ID)

String (文字列)

デビットメモの一意の ID。例: 8a8082e65b27f6c3015ba419f3c2644e。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Cancel debit memo

<mule-zuora-connector:update-v1-debitmemos-cancel-by-debit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。デビットメモをキャンセルします。キャンセルできるのは、状況が [Draft (下書き)] のデビットメモのみです。デビットメモは、ユーザー権限を持っている場合のみキャンセルできます。詳細は、[「Billing Roles (請求ロール)」](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) を参照してください。この操作では、/v1/debitmemos/{debitMemoId}/cancel エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Debit Memo Id (デビットメモ ID)

String (文字列)

デビットメモの一意の ID。例: 8a8082e65b27f6c3015ba419f3c2644e。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Post debit memo

<mule-zuora-connector:update-v1-debitmemos-post-by-debit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。デビットメモを転記して有効化します。デビットメモは、[請求権限](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions) を持っている場合のみ転記できます。この操作では、/v1/debitmemos/{debitMemoId}/post エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Debit Memo Id (デビットメモ ID)

String (文字列)

デビットメモの一意の ID。例: 8a8082e65b27f6c3015ba419f3c2644e。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Unpost debit memo

<mule-zuora-connector:update-v1-debitmemos-unpost-by-debit-memo-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。状況が [Posted (転記済み)] のデビットメモの転記を取り消します。デビットメモにクレジットメモまたは支払が適用されているか払い戻されている場合、デビットメモの転記を取り消すことはできません。デビットメモの転記を取り消すと、その状況が [Draft (下書き)] になります。デビットメモは、[請求権限](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions) を持っている場合のみ転記を取り消すことができます。この操作では、/v1/debitmemos/{debitMemoId}/unpost エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Debit Memo Id (デビットメモ ID)

String (文字列)

デビットメモの一意の ID。例: 8a8082e65b27f6c3015ba419f3c2644e。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update document properties

<mule-zuora-connector:update-v1-document-properties-by-document-properties-id>

注意: この機能は、請求ドキュメントプロパティセットアップ機能を有効にしている場合のみ使用できます。請求ドキュメントプロパティのセットアップ機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。請求ドキュメントの特定の ID を持つドキュメントプロパティを更新します。請求ドキュメントには、請求書、クレジットメモ、およびデビットメモがあります。 注意: クレジットメモおよびデビットメモのドキュメントプロパティは、請求書決済機能を有効にしている場合のみ更新できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。この操作では、/v1/document-properties/{documentPropertiesId} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Document Properties Id (ドキュメントプロパティ ID)

String (文字列)

更新するドキュメントプロパティの一意の ID。例: 402892c74c9193cd014c96bbe7c101f9。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Update entity

<mule-zuora-connector:update-v1-entities-by-id>

注意: Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

プロビジョニング解除されたエンティティに関する次の情報を編集します。

Name (名前)
Display name (表示名) *Locale (ロケール)
Timezone (タイムゾーン)

ユーザーアクセス権限

グローバルエンティティのシステム管理者としてコールを実行する必要があります。

注意事項

REST API を使用してプロビジョニングされたエンティティのロケールおよびタイムゾーンを編集することはできません。
グローバルエンティティの表示名を編集することはできません。

この操作では、/v1/entities/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

編集するエンティティの ID。エンティティ ID は GET Entities コールから取得できます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Provision entity

<mule-zuora-connector:update-v1-entities-provision-by-id>

この操作はエンティティをプロビジョニングします。

注意: Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

エンティティをプロビジョニングできるのは、親エンティティがプロビジョニングされている場合のみです。

ユーザーアクセス権限

グローバルエンティティのシステム管理者としてコールを実行する必要があります。

注意事項

Zuora では、プロビジョニングされたエンティティをマルチエンティティ階層から削除することはできません。そのため、エンティティをプロビジョニングする前に、必ずエンティティをマルチエンティティ階層の正しい場所に配置してください。

この操作では、/v1/entities/{id}/provision エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

プロビジョニングするエンティティの ID を指定します。エンティティ ID は GET Entities コールから取得できます。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Accept connection

<mule-zuora-connector:update-v1-entity-connections-accept-by-connection-id>

この操作は、接続要求を受け入れます。この操作では、/v1/entity-connections/{connection-id}/accept エンドポイントに対する HTTP PUT 要求を行います。

注意: Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

ユーザーアクセス権限

接続要求を受け入れるには、エンティティ管理者としてコールを行う必要があります。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Connection id (接続 ID)

String (文字列)

受け入れる接続の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Deny connection

<mule-zuora-connector:update-v1-entity-connections-deny-by-connection-id>

この操作は、接続要求を拒否します。この操作では、/v1/entity-connections/{connection-id}/deny エンドポイントに対する HTTP PUT 要求を行います。

注意: Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

ユーザーアクセス権限

接続要求を拒否するには、エンティティ管理者としてコールを行う必要があります。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Connection id (接続 ID)

String (文字列)

拒否する接続の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Disconnect connection

<mule-zuora-connector:update-v1-entity-connections-disconnect-by-connection-id>

この操作は、確立された接続を切断します。この操作では、/v1/entity-connections/{connection-id}/disconnect エンドポイントに対する HTTP PUT 要求を行います。

注意: Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

確立された接続を切断します。グローバルエンティティから対象エンティティにオブジェクトを共有している場合、接続を切断すると、これらのエンティティ間の対応関係が壊され、後から回復することはできません。

ユーザーアクセス権限

対象エンティティまたはソースエンティティの管理者としてコールを行う必要があります。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Connection id (接続 ID)

String (文字列)

切断する接続の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update invoices

<mule-zuora-connector:update-v1-invoices>

1 回のコールで複数の請求書を一括で更新します。この操作では、/v1/invoices エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update invoice

<mule-zuora-connector:update-v1-invoices-by-invoice-id>

特定の請求書を更新します。この操作では、/v1/invoices/{invoiceId} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice Id (請求書 ID)

String (文字列)

請求書の ID。例: 2c92c8955bd63cc1015bd7c151af02ab。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Reverse invoice

<mule-zuora-connector:update-v1-invoices-reverse-by-invoice-id>

この操作は、転記済みの請求書を破棄します。

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

制限

次のいずれかの制限を満たす場合、請求書を破棄することはできません。

支払とクレジットカードメモが請求書に適用されている。
請求書が分割されている。
請求書の状況が [Posted (転記済み)] ではない。
請求書の合計金額が 0 未満である (マイナスの請求書)。
税金の計算に Tax Connector for Extension Platform を使用している。詳細は、[「Reverse Posted Invoices (転記済みの請求書の破棄)」](https://knowledgecenter.zuora.com/CB_Billing/IA_Invoices/Reverse_Posted_Invoices) を参照してください。この操作では、/v1/invoices/{invoiceId}/reverse エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice Id (請求書 ID)

String (文字列)

請求書の ID。例: 2c92c8955bd63cc1015bd7c151af02ab。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Write off invoice

<mule-zuora-connector:update-v1-invoices-write-off-by-invoice-id>

この操作は、転記済みの請求書を損金処理します。この操作では、/v1/invoices/{invoiceId}/write-off エンドポイントに対する HTTP PUT 要求を行います。

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

請求書を損金処理することで、クレジットメモが作成されて請求書に適用されます。生成されたクレジットメモ項目およびクレジットメモ課税項目は、設定されたデフォルトの適用ルールに基づいて請求書項目および請求書課税項目に適用されます。請求書を損金処理する場合、各請求書項目および請求書課税項目の残高は 0 である必要があります。[Create credit memos mirroring invoice items billing rule (請求書項目の請求ルールを反映したクレジットメモを作成する)] を [Yes (はい)] に設定すると、すべての項目の残高が 0 である請求書であっても損金処理することができます。

制限

次のいずれかの制限を満たす場合、請求書を損金処理することはできません。

請求書決済機能が有効化される前に請求書の残高が変更されている。
たとえば、請求書決済機能が有効化される前に、クレジット残高調整、請求書項目調整、または請求書調整がインボイスに適用されている場合です。
請求項目、割引項目、課税項目を含めたインボイスの項目数の合計が 750 を超えている。
詳細は、「請求書帳消し」を参照してください。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Invoice Id (請求書 ID)

String (文字列)

請求書の一意の ID。例: 2c92c8955bd63cc1015bd7c151af02ab。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update basic information of a summary journal entry

<mule-zuora-connector:update-v1-journal-entries-basic-information-by-je-number>

この REST API リファレンスでは、サマリージャーナルエントリの基本情報を更新する方法について説明します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/journal-entries/{je-number}/basic-information エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Je number (Je 番号)

String (文字列)

JE-00000001 の形式のジャーナルエントリ番号。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Cancel summary journal entry

<mule-zuora-connector:update-v1-journal-entries-cancel-by-je-number>

このリファレンスでは、REST API を使用してサマリージャーナルエントリをキャンセルする方法について説明します。サマリージャーナルエントリをキャンセルするには、「Cancel Journal Entry (ジャーナルエントリのキャンセル)」ユーザー権限を有効にしている必要があります。サマリージャーナルエントリは、その「Transferred To Accounting (会計に振り替え済み)」の状況が [Yes (はい)] または [Processing (処理中)] の場合、キャンセルできません。この操作では、/v1/journal-entries/{je-number}/cancel エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Je number (Je 番号)

String (文字列)

JE-00000001 の形式のジャーナルエントリ番号。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Cancel Journal Run

<mule-zuora-connector:update-v1-journal-runs-cancel-by-jr-number>

このリファレンスでは、REST API を使用してジャーナル実行をキャンセルする方法について説明します。ジャーナル実行のサマリージャーナルエントリは非同期でキャンセルされます。詳細は、下記の「例」セクションを参照してください。

ジャーナル実行をキャンセルするには、「Cancel Journal Run (ジャーナル実行のキャンセル)」 Zuora Finance ユーザー権限を有効にしている必要があります。

注意事項

ジャーナル実行をキャンセルすると、そのジャーナル実行に関連付けられたサマリージャーナルエントリは非同期でキャンセルされます。{ "success": true } の応答が意味するのは、指定されたジャーナル実行の状況が [Pending (保留中)]、[Error (エラー)]、または [Completed (完了)] であるためキャンセルできることのみであり、ジャーナル実行全体が正常にキャンセルされたことではありません。たとえば、ジャーナル実行 JR-00000075 をキャンセルするとします。このジャーナル実行の状況は [Completed (完了)] であり、10 件のジャーナルエントリが含まれています。ジャーナルエントリの 1 つはその「Transferred To Accounting (会計に振り替え済み)」の状況が [Yes (はい)] に設定されています。つまり、このエントリはキャンセルできません。ワークフローは次のように進む場合もあります。

ジャーナル実行をキャンセルするための API コールを行います。
このジャーナル実行の状況は [Completed (完了)] であるため、{ "success": true } の応答を受信します。
Zuora によってジャーナル実行に関連付けられたジャーナルエントリの非同期でのキャンセルが開始されます。「Transferred To Accounting (会計に振り替え済み)」の状況が [Yes (はい)] のジャーナルエントリはキャンセルに失敗します。キャンセルプロセスが続行され、他のジャーナルエントリが正常にキャンセルされます。
ジャーナル実行の状況は [Completed (完了)] のままになります。ジャーナル実行には引き続きキャンセルされていないジャーナルエントリが含まれるため、状況は [Canceled (キャンセル)] に変更されません。

この操作では、/v1/journal-runs/{jr-number}/cancel エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Jr number (Jr 番号)

String (文字列)

ジャーナル実行番号。JR-00000001 の形式の有効なジャーナル実行番号である必要があります。キャンセルできるのは、状況が [Pending (保留中)]、[Error (エラー)]、または [Completed (完了)] のジャーナル実行のみです。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update account

<mule-zuora-connector:update-v1-object-account-by-id>

アカウントを更新します。この操作では、/v1/object/account/{id} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update amendment

<mule-zuora-connector:update-v1-object-amendment-by-id>

CRUD: Update amendment。この操作では、/v1/object/amendment/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Post or Cancel bill run

<mule-zuora-connector:update-v1-object-bill-run-by-id>

注意: この機能は使用制限されています。この機能にアクセスしたい場合は、Zuora グローバルサポートに要求を送信してください。請求実行の転記: 請求実行の転記は非同期操作です。請求実行を転記するには、現在の請求実行の状況が Completed である必要があります。請求実行が転記されると、その状況は PostInProgress に変更されます。この請求実行のすべての請求書が転記されると、その状況は Posted に変更されます。請求実行を転記して請求実行の状況を照会すると、PostInProgress、Completed、Posted のいずれかの結果が得られます。請求実行のすべての請求書が転記されると、請求実行の状況は Posted になります。1 件以上の請求書の転記に失敗すると、その状況は Completed に戻され、請求実行をもう一度転記する必要があります。請求実行のキャンセル: 請求実行のキャンセルは非同期操作です。請求実行をキャンセルする場合、ロジックは UI を使用して請求実行をキャンセルする場合と同じです。BillRunId を指定して、[Status (状況)] を Canceled に設定する必要があります。請求実行をキャンセルするときは、次の点を考慮してください。* [Completed (完了)] 状況の請求実行のキャンセル。 *キャンセルされるのは現在の請求実行のみです。 *[Pending (保留中)] 状況の請求実行のキャンセル。 *アドホック請求実行をキャンセルするときは、現在の請求実行のみがキャンセルされます。 *スケジュール済み請求をキャンセルするときは、すべてのスケジュール済み請求実行がキャンセルされます。キャンセル操作は成功しない場合があります。成功するかどうかは、その現在のビジネス検証に応じて異なります。キャンセルできるのは転記済みの請求書がない請求実行のみです。転記済みの請求書が請求実行に含まれる場合、無効な値の例外が発生し、「The Bill Run cannot be Cancelled, There are Posted invoices. (請求実行をキャンセルできません。転記済みの請求書があります。)」というメッセージが表示されます。この操作では、/v1/object/bill-run/{id} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update contact

<mule-zuora-connector:update-v1-object-contact-by-id>

指定されたアカウントの取引先責任者を更新します。キャンセルされたアカウントの取引先責任者を更新できます。この操作では、/v1/object/contact/{id} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update CreditBalanceAdjustment

<mule-zuora-connector:update-v1-object-credit-balance-adjustment-by-id>

この CRUD 操作では、/v1/object/credit-balance-adjustment/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Object PUTFeature

<mule-zuora-connector:update-v1-object-feature-by-id>

Object PUTFeature この操作では、/v1/object/feature/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update InvoiceAdjustment

<mule-zuora-connector:update-v1-object-invoice-adjustment-by-id>

CRUD: Update InvoiceAdjustment。この操作では、/v1/object/invoice-adjustment/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update invoice

<mule-zuora-connector:update-v1-object-invoice-by-id>

CRUD: Update invoice。この操作では、/v1/object/invoice/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update InvoicePayment

<mule-zuora-connector:update-v1-object-invoice-payment-by-id>

CRUD: Update InvoicePayment。この操作では、/v1/object/invoice-payment/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update payment

<mule-zuora-connector:update-v1-object-payment-by-id>

支払を更新します。この操作では、/v1/object/payment/{id} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

支払の一意の ID。例: 2c92c095592623ea01596621ada84352。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update payment method

<mule-zuora-connector:update-v1-object-payment-method-by-id>

CRUD: Update payment method。この操作では、/v1/object/payment-method/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update Product

<mule-zuora-connector:update-v1-object-product-by-id>

CRUD: Update Product。この操作では、/v1/object/product/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update ProductRatePlan

<mule-zuora-connector:update-v1-object-product-rate-plan-by-id>

CRUD: Update ProductRatePlan。この操作では、/v1/object/product-rate-plan/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update product rate plan charge

<mule-zuora-connector:update-v1-object-product-rate-plan-charge-by-id>

製品料金プランチャージに関する情報を更新します。この操作では、/v1/object/product-rate-plan-charge/{id} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

更新する製品料金プランチャージの一意の ID。例: 2c93808457d787030157e031fcd34e19。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update ProductRatePlanChargeTier

<mule-zuora-connector:update-v1-object-product-rate-plan-charge-tier-by-id>

製品料金プランチャージ層の価格を更新します。製品料金プランチャージ層をさらに更新するには、[CRUD: Update product rate plan charge](https://www.zuora.com/developer/api-reference/#operation/Object_PUTProductRatePlanCharge) を使用してリクエストボディで ProductRatePlanChargeTierData を指定します。この操作では、/v1/object/product-rate-plan-charge-tier/{id} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

更新する製品料金プランチャージ層の一意の ID。例: 2c92c0f86c85891e016c88d55a6e543b。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update rate plan charge

<mule-zuora-connector:update-v1-object-rate-plan-charge-by-id>

CRUD: Update rate plan charge。この操作では、/v1/object/rate-plan-charge/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update refund

<mule-zuora-connector:update-v1-object-refund-by-id>

CRUD: Update refund。この操作では、/v1/object/refund/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update Subscription

<mule-zuora-connector:update-v1-object-subscription-by-id>

CRUD: Update Subscription。この操作では、/v1/object/subscription/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update TaxationItem

<mule-zuora-connector:update-v1-object-taxation-item-by-id>

CRUD: Update TaxationItem。この操作では、/v1/object/taxation-item/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update UnitOfMeasure

<mule-zuora-connector:update-v1-object-unit-of-measure-by-id>

CRUD: Update UnitOfMeasure。この操作では、/v1/object/unit-of-measure/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

CRUD: Update usage

<mule-zuora-connector:update-v1-object-usage-by-id>

CRUD: Update usage。この操作では、/v1/object/usage/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

オブジェクト ID。

x

Reject Unknown Fields (不明な項目を拒否)

Boolean

リクエストボディに不明な項目が含まれている場合にコールが失敗するかどうかを指定します。rejectUnknownFields を true に設定すると、リクエストボディに不明な項目が含まれている場合には Zuora から 400 応答が返されます。400 応答の本文は json { "message": "Error - unrecognized fields" } です。デフォルトでは、Zuora はリクエストボディに含まれている不明な項目を無視します。

false

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update order custom fields

<mule-zuora-connector:update-v1-orders-custom-fields-by-order-number>

注意: この機能は、[注文メトリクス](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) 機能を有効にしている場合のみ使用できます。注文メトリクスへの移行は [Limited Availability (限定利用)] にあります。私たちは正式リリースの前に小数の早期導入ユーザーからのフィードバックを積極的に求めています。[注文](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) 機能を有効にしている場合、すでに注文メトリクス機能は有効になっています。指定された注文のカスタム項目を更新します。この操作では、/v1/orders/{orderNumber}/customFields エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Order Number (注文番号)

String (文字列)

注文番号。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update order action trigger dates

<mule-zuora-connector:update-v1-orders-trigger-dates-by-order-number>

注意: この操作は、[注文](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) 機能を有効にしている場合にのみ使用できます。注文への移行は使用制限されています。私たちは正式リリースの前に小数の早期導入ユーザーからのフィードバックを積極的に求めています。次のいずれかの注文アクションのトリガー日を更新します。* CreateSubscription * AddProduct * UpdateProduct * RemoveProduct * RenewSubscription * TermsAndConditions この操作では、/v1/orders/{orderNumber}/triggerDates エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Order Number (注文番号)

String (文字列)

注文アクションのトリガー日を更新する保留中の注文の注文番号。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update credit card payment method

<mule-zuora-connector:update-v1-payment-methods-credit-cards-by-payment-method-id>

指定された顧客アカウントの既存のクレジットカード支払方法を更新します。この操作では、/v1/payment-methods/credit-cards/{payment-method-id} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment method id (支払い方法 ID)

String (文字列)

更新する支払方法の一意の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Scrub payment method

<mule-zuora-connector:update-v1-payment-methods-scrub-by-payment-method-id>

この操作を使用して、支払方法のすべての機密データ、関連する支払方法スナップショットテーブル、4 つの関連するログテーブルをダミーの値に置き換えて Zuora データベースに保存することができます。この操作により、機密データが無効化され、同時に指定された支払方法が論理削除されます。Zuora の個人データを削除または匿名化する場合は、関連付けられたアカウントおよび取引先責任者を匿名化する前に支払方法を無効化する必要があります。詳細は、[「Delete or anonymize personal data (個人データの削除または匿名化)」](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Responding_to_individual_requests_for_access%2C_correction%2C_and_deletion_of_data_under_applicable_privacy_laws#Edit_and_correct_personal_data) を参照してください。注意: この操作を使用するには、ユーザーロールで「Scrub Sensitive Data of Specific Payment Method payments (特定の支払方法の機密データの無効化)」権限を有効する必要があります。この権限を有効にするには、テナント管理者に連絡してください。詳細は、[「Scrub Payment Methods (支払方法の無効化)」](https://knowledgecenter.zuora.com/CB_Billing/L_Payment_Methods/Scrub_Payment_Methods) を参照してください。この操作では、/v1/payment-methods/{payment-method-id}/scrub エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment method id (支払い方法 ID)

String (文字列)

機密データを無効化する支払方法の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Verify payment method

<mule-zuora-connector:update-v1-payment-methods-verify-by-payment-method-id>

支払方法に対する変更が行われていない場合であっても、支払方法を検証するために対応する支払ゲートウェイに認証要求を送信します。サポートされる支払方法はクレジットカードと Paypal です。Zuora では、クレジットカードのスタンドアロンの 0 ドル検証または 1 ドル認証の実行がサポートされるようになります。また、PayPal 支払方法での請求同意状況チェックもサポートされています。支払方法がホストされる支払ページによって作成され、請求アカウントに割り当てられていない場合、この操作を使用して支払方法を検証することはできません。この操作では、/v1/payment-methods/{payment-method-id}/verify エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment method id (支払い方法 ID)

String (文字列)

検証する支払方法の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update payment run

<mule-zuora-connector:update-v1-payment-runs-by-payment-run-id>

未実行の支払実行に関する情報を更新します。更新できるのは保留中の支払実行のみです。accountId 項目、batch 項目、billCycleDay 項目、currency 項目、paymentGatewayId 項目、billingRunId 項目のいずれもリクエストボディで指定されていない場合、対応する支払実行によってすべてのアカウントの支払が収集されます。この操作では、/v1/payment-runs/{paymentRunId} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment Run Id (支払い実行 ID)

String (文字列)

支払実行の一意の ID。例: 402890245f097f39015f0f074a2e0566。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Apply payment

<mule-zuora-connector:update-v1-payments-apply-by-payment-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。未適用の支払を請求書およびデビットメモに適用します。支払を適用する場合、支払が適用される請求書とデビットメモの合計数は 1,000 件以下である必要があります。按分適用ルールを使用する場合、支払いの適用時に「(請求書項目の数 + デビットメモ項目の数) * 支払い項目の数」が 10,000 以下である必要があります。それ以外の場合、按分ルールの代わりに先入れ先出しルールが使用されます。詳細は、[「Apply Unapplied Payments to Invoices and Debit Memos (請求書およびデビットメモへの未適用の支払の適用)」](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Apply_Unapplied_Payments_to_Invoices_and_Debit_Memos) を参照してください。この操作では、/v1/payments/{paymentId}/apply エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment Id (支払い ID)

String (文字列)

未適用の支払いの一意の ID。例: 8a8082e65b27f6c3015b89e4344c16b1。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update payment

<mule-zuora-connector:update-v1-payments-by-payment-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。支払を更新します。この操作では、/v1/payments/{paymentId} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment Id (支払い ID)

String (文字列)

未適用の支払いの一意の ID。例: 8a8082e65b27f6c3015b89e4344c16b1。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Cancel payment

<mule-zuora-connector:update-v1-payments-cancel-by-payment-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。支払をキャンセルします。請求書決済機能を有効にしている場合、クレジット残高に適用される支払超過はキャンセルできません。この操作では、/v1/payments/{paymentId}/cancel エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment Id (支払い ID)

String (文字列)

未適用の支払いの一意の ID。例: 8a8082e65b27f6c3015b89e4344c16b1。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Transfer payment

<mule-zuora-connector:update-v1-payments-transfer-by-payment-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。未適用の支払を振り替えます。詳細は、[「Transfer Unapplied Payments (未適用の支払の振り替え)」](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Transfer_Unapplied_Payments) を参照してください。この操作では、/v1/payments/{paymentId}/transfer エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment Id (支払い ID)

String (文字列)

未適用の支払いの一意の ID。例: 8a8082e65b27f6c3015b89e4344c16b1。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Unapply payment

<mule-zuora-connector:update-v1-payments-unapply-by-payment-id>

注意: 請求書決済機能は使用制限されています。この機能には、未適用の支払い、クレジットメモとデビットメモ、請求書項目決済が含まれます。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。請求書およびデビットメモから適用済みの支払を適用解除します。詳細は、[「Unapply Payments from Invoices and Debit Memos (請求書およびデビットメモからの支払の適用解除)」](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Unapply_Payments_from_Invoices_and_Debit_Memos) を参照してください。この操作では、/v1/payments/{paymentId}/unapply エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Payment Id (支払い ID)

String (文字列)

適用済みの支払の一意の ID。例: 8a8082e65b27f6c3015b89e4344c16b1。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update refund

<mule-zuora-connector:update-v1-refunds-by-refund-id>

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。払い戻しに関する基本情報および金融情報を更新します。この操作では、/v1/refunds/{refundId} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Refund Id (払い戻し ID)

String (文字列)

払い戻しの一意の ID。例: 4028905f5a87c0ff015a889e590e00c9。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Cancel refund

<mule-zuora-connector:update-v1-refunds-cancel-by-refund-id>

注意: この機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。払い戻しをキャンセルします。請求書決済機能を有効にしている場合、クレジット残高に適用される払い戻しはキャンセルできません。この操作では、/v1/refunds/{refundId}/cancel エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Refund Id (払い戻し ID)

String (文字列)

払い戻しの一意の ID。例: 4028905f5a87c0ff015a889e590e00c9。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update custom fields on revenue items by revenue event number

<mule-zuora-connector:update-v1-revenue-items-revenue-events-by-event-number>

この REST API リファレンスでは、収益イベント番号を指定して収益項目のカスタム項目を更新する方法について説明します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/revenue-items/revenue-events/{event-number} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Event number (イベント番号)

String (文字列)

収益イベントに関連付けられた番号。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update custom fields on revenue items by revenue schedule number

<mule-zuora-connector:update-v1-revenue-items-revenue-schedules-by-rs-number>

この REST API リファレンスでは、収益スケジュール番号を指定して収益項目のカスタム項目を更新する方法について説明します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/revenue-items/revenue-schedules/{rs-number} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Rs number (Rs 番号)

String (文字列)

収益スケジュール番号。収益スケジュール番号には必ず「RS」というプレフィックスが付きます。例: 「RS-00000001」。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update revenue schedule basic information

<mule-zuora-connector:update-v1-revenue-schedules-basic-information-by-rs-number>

収益スケジュール番号を指定して収益スケジュールの基本情報を取得します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/revenue-schedules/{rs-number}/basic-information エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Rs number (Rs 番号)

String (文字列)

収益スケジュール番号。収益スケジュール番号には必ず「RS」というプレフィックスが付きます。例: 「RS-00000001」。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Distribute revenue across accounting periods

<mule-zuora-connector:update-v1-revenue-schedules-distribute-revenue-across-accounting-periods-by-rs-number>

収益スケジュール番号を指定して収益を分配します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/revenue-schedules/{rs-number}/distribute-revenue-across-accounting-periods エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Rs number (Rs 番号)

String (文字列)

収益スケジュール番号。収益スケジュール番号には必ず「RS」というプレフィックスが付きます。例: 「RS-00000001」。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Distribute revenue on specific date

<mule-zuora-connector:update-v1-revenue-schedules-distribute-revenue-on-specific-date-by-rs-number>

特定の認識日で収益を分配します。要求項目と応答項目の説明、およびサンプルコードが提供されています。

この操作では、/v1/revenue-schedules/{rs-number}/distribute-revenue-on-specific-date エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Rs number (Rs 番号)

String (文字列)

収益スケジュール番号。収益スケジュール番号には必ず「RS」というプレフィックスが付きます。例: 「RS-00000001」。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Distribute revenue by recognition start and end dates

<mule-zuora-connector:update-v1-revenue-schedules-distribute-revenue-with-date-range-by-rs-number>

認識の開始日と終了日を指定して収益を分配します。要求項目と応答項目の説明、およびサンプルコードが提供されています。この操作では、/v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Rs number (Rs 番号)

String (文字列)

収益スケジュール番号。収益を分配する収益スケジュールを指定します。収益スケジュール番号には必ず「RS」というプレフィックスが付きます。例: 「RS-00000001」。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

PUT Rev Pro Accounting Codes

<mule-zuora-connector:update-v1-revpro-accounting-codes>

Zuora 請求の特定の製品料金プランチャージ ID に対応する Zuora 収益勘定コードを更新します。この操作では、/v1/revpro-accounting-codes エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update Sequence Set

<mule-zuora-connector:update-v1-sequence-sets-by-id>

請求ドキュメント、支払い、返金に対して設定されている特定のシーケンスセットを更新します。請求ドキュメントには、請求書、クレジットメモ、およびデビットメモがあります。

クレジットメモとデビットメモ機能は、請求書決済機能を有効にしている場合にのみ使用できます。請求書決済機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。

この操作では、/v1/sequence-sets/{id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

更新するシーケンスセットの ID。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update subscription

<mule-zuora-connector:update-v1-subscriptions-by-subscription-key>

このコールを使用して、サブスクリプションに対して次のような変更を行います。* ノートを追加する * 更新期間または自動更新フラグを変更する * 期間の長さを変更するか、エバーグリーンと期間調整の間で切り替える * 新しい製品料金プランを追加する * 既存のサブスクリプション料金プランを削除する * 既存のサブスクリプション料金プランの数量または価格を変更する注意 * Update Subscription コールによって作成される新しいサブスクリプションでは、サブスクリプション番号は古いままですがサブスクリプション ID は新しくなります。古いサブスクリプションはキャンセルされますが、システムには残ります。 1 回の要求でこのコールを使用して行うことができる内容: * 最大 9 回の変更の追加、更新、および削除 * 契約条件を変更できるのは 1 回のみです。 更新は次の順序で実行されます。1.要求があった場合は、最初に既存のサブスクリプションのノートを変更します。2.次に、要求があった場合は契約条件を変更します。3.続いて、指定された発効日に基づいて残りの修正を実行します。複数の修正で契約発効日が同じである場合、更新の前に追加を実行し、削除の前に更新を実行します。更新操作はアトミックです。いずれかの更新に失敗すると、操作全体がロールバックされます。 *Update Subscription コールの応答は、リクエストヘッダーで設定した REST API マイナーバージョンに基づきます。使用しているマイナーバージョン番号が異なる場合、応答の構造が異なる場合があります。 *請求書決済機能を有効にしている場合、zuora-version パラメーターを 211.0 以降に設定することがベストプラクティスです。追加しないと、エラーが生じます。 積み上げ価格の上書き積み上げ価格を上書きする方法は次の 2 つです。 Override a specific tier number For example: tiers[{tier:1,price:8},{tier:2,price:6}] * 層構造全体を上書きする。例: tiers[{tier:1,price:8,startingUnit:1,endingUnit:100,priceFormat:"FlatFee"}, {tier:2,price:6,startingUnit:101,priceFormat:"FlatFee"}] 特定の層のみを上書きする場合、要求に startingUnit 項目を含めないでください。この操作では、/v1/subscriptions/{subscription-key} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription key (サブスクリプションキー)

String (文字列)

サブスクリプション番号または ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。このパラメーターを設定する必要があるのは、次の項目を使用する場合です。* collect * invoice * includeExistingDraftDocItems * previewType * runBilling * targetDate。請求書決済機能を有効にしている場合、このパラメーターを指定する必要があります。それ以外の場合、エラーが返されます。詳細は、[「Zuora REST API Versions (Zuora REST API バージョン)」](https://www.zuora.com/developer/api-reference/#section/API-Versions) を参照してください。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Cancel Subscription

<mule-zuora-connector:update-v1-subscriptions-cancel-by-subscription-key>

この REST API リファレンスでは、アクティブなサブスクリプションをキャンセルする方法について説明します。 注意: 請求書決済機能を有効にしている場合、zuora-version パラメーターを 211.0 以降に設定することをお勧めします。追加しないと、エラーが生じます。この操作では、/v1/subscriptions/{subscription-key}/cancel エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription key (サブスクリプションキー)

String (文字列)

サブスクリプション番号または ID。サブスクリプションの状況は [Active (アクティブ)] である必要があります。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。このパラメーターを設定する必要があるのは、次の項目を使用する場合のみです。* invoice * collect * runBilling * targetDate

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update Subscription Custom Fields

<mule-zuora-connector:update-v1-subscriptions-custom-fields-by-subscription-number>

注意: この操作は、[注文](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) 機能を有効にしている場合にのみ使用できます。注文への移行は使用制限されています。私たちは正式リリースの前に小数の早期導入ユーザーからのフィードバックを積極的に求めています。指定されたサブスクリプションのカスタム項目を更新します。この操作では、/v1/subscriptions/{subscriptionNumber}/customFields エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription Number (サブスクリプション番号)

String (文字列)

更新するサブスクリプション番号。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Renew subscription

<mule-zuora-connector:update-v1-subscriptions-renew-by-subscription-key>

既存の更新期間を使用して期間調整されるサブスクリプションを更新します。 注意: 請求書決済機能を有効にしている場合、zuora-version パラメーターを 211.0 以降に設定することをお勧めします。追加しないと、エラーが生じます。この操作では、/v1/subscriptions/{subscription-key}/renew エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription key (サブスクリプションキー)

String (文字列)

サブスクリプション番号または ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。このパラメーターを設定する必要があるのは、次の項目を使用する場合のみです。* invoice * collect * runBilling * targetDate

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Resume Subscription

<mule-zuora-connector:update-v1-subscriptions-resume-by-subscription-key>

この REST API リファレンスでは、サスペンドされたサブスクリプションを再開する方法について説明します。 注意: 請求書決済機能を有効にしている場合、zuora-version パラメーターを 211.0 以降に設定することをお勧めします。追加しないと、エラーが生じます。

この操作では、/v1/subscriptions/{subscription-key}/resume エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription key (サブスクリプションキー)

String (文字列)

サブスクリプション番号または ID。サブスクリプションの状況は [Active (アクティブ)] である必要があります。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。このパラメーターを設定する必要があるのは、次の項目を使用する場合のみです。* invoice * collect * runBilling * targetDate

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Suspend subscription

<mule-zuora-connector:update-v1-subscriptions-suspend-by-subscription-key>

この REST API リファレンスでは、アクティブなサブスクリプションをサスペンドする方法について説明します。 注意: 請求書決済機能を有効にしている場合、zuora-version パラメーターを 211.0 以降に設定することをお勧めします。追加しないと、エラーが生じます。この操作では、/v1/subscriptions/{subscription-key}/suspend エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription key (サブスクリプションキー)

String (文字列)

サブスクリプション番号または ID。サブスクリプションの状況は [Active (アクティブ)] である必要があります。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora version (Zuora バージョン)

String (文字列)

Zuora REST API のマイナーバージョン。このパラメーターを設定する必要があるのは、次の項目を使用する場合のみです。* invoice * collect * runBilling * targetDate

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update subscription custom fields of a specified subscription version

<mule-zuora-connector:update-v1-subscriptions-versions-custom-fields-by-subscription-number-version>

指定されたバージョンのカスタム項目を更新します。この操作では、/v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Subscription Number (サブスクリプション番号)

String (文字列)

更新するサブスクリプション番号。

x

version

String (文字列)

更新するサブスクリプションバージョン。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update taxation item

<mule-zuora-connector:update-v1-taxationitems-by-id>

ID を基準に特定の課税項目を更新します。この操作では、/v1/taxationitems/{id} エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

課税項目の一意の ID。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Accept user access

<mule-zuora-connector:update-v1-users-accept-access-by-username>

注意: Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。エンティティに対するユーザーアクセスを受け入れます。## ユーザーアクセス権限コールは、ユーザーアクセスを受け入れるエンティティの管理者として行う必要があります。この操作では、/v1/users/{username}/accept-access エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

username (ユーザー名)

String (文字列)

アクセス要求を受け入れるユーザーのログイン名を指定します。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Deny user access

<mule-zuora-connector:update-v1-users-deny-access-by-username>

注意: Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。エンティティに対するユーザーアクセスを拒否します。## ユーザーアクセス権限コールは、ユーザーアクセスを拒否するエンティティの管理者として行う必要があります。この操作では、/v1/users/{username}/deny-access エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

username (ユーザー名)

String (文字列)

アクセスを拒否するユーザーのログイン名を指定します。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Multi-entity: Send user access requests

<mule-zuora-connector:update-v1-users-request-access-by-username>

注意: Multi-entity 機能は使用制限されています。この機能にアクセスする場合は、Zuora グローバルサポートに要求を送信してください。ユーザーがアクセスを希望するエンティティへのアクセス要求を送信します。## ユーザーアクセス権限コールは、要求ユーザーが作成されるエンティティの管理者として行う必要があります。また、この管理者は要求ユーザーがアクセスを希望するエンティティにアクセスする権限を持っている必要もあります。この操作では、/v1/users/{username}/request-access エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

username (ユーザー名)

String (文字列)

他のエンティティへのアクセスを希望するユーザーのログイン名を指定します。

x

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Update tasks in batch

<mule-zuora-connector:update-workflows-tasks-batch-update>

ワークフロータスクのグループを更新します。この操作では、/workflows/tasks/batch_update エンドポイントに対する HTTP PUT 要求を行います

パラメーター

名前型説明デフォルト値必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Authorization (認証)

String (文字列)

有効な OAuth トークンの場合は Bearer {token}。

x

Zuora Entity Ids (Zuora エンティティ ID)

String (文字列)

エンティティ ID。[Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) を有効化し、複数のエンティティに対して OAuth トークンを有効にしている場合、このヘッダーを使用して、どのエンティティで操作を実行するかを指定する必要があります。 1 つのエンティティに対してのみ OAuth トークンを有効にしている場合や、Zuora Multi-entity を有効化していない場合、このヘッダーを設定する必要はありません。

Zuora Track Id (Zuora トラック ID)

String (文字列)

API コールをトレースするためのカスタム識別子。このヘッダーの値を設定すると、Zuora はレスポンスヘッダーで同じ値を返します。このヘッダーにより、システムプロセス識別子を Zuora API コールと関連付けて、問題が発生した場合のトラブルシューティングに役立てることができます。この項目の値では US-ASCII 文字セットを使用する必要があり、次の文字はいずれも使用できません: コロン (:)、セミコロン (;)、二重引用符 (")、引用符 (')。

Content (コンテンツ)

Binary (バイナリ)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
Repeatable File Store Stream (反復可能なファイルストアストリーム)
non-repeatable-stream

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Response Timeout (応答タイムアウト) の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

AUTO
ALWAYS
NEVER

要求をストリーミングで送信する必要があるかどうかを定義します。値を AUTO に設定すると、要求のコンテンツに基づいて最適な戦略が自動的に定義されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

設定

スロー

MULE-ZUORA-CONNECTOR:BAD_REQUEST
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
MULE-ZUORA-CONNECTOR:CONNECTIVITY
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
MULE-ZUORA-CONNECTOR:NOT_FOUND
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
MULE-ZUORA-CONNECTOR:SERVER_ERROR
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
MULE-ZUORA-CONNECTOR:TIMEOUT
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

型

Default Header (デフォルトヘッダー)

項目

型

説明

デフォルト値

必須

Key (キー)

String (文字列)

x

Value (値)

String (文字列)

x

Default Query Param (デフォルトクエリパラメーター)

項目

型

説明

デフォルト値

必須

Key (キー)

String (文字列)

x

Value (値)

String (文字列)

x

Proxy (プロキシ)

項目

型

説明

デフォルト値

必須

Host (ホスト)

String (文字列)

x

Port (ポート)

Number (数値)

x

Username (ユーザー名)

String (文字列)

Password (パスワード)

String (文字列)

Non Proxy Hosts (非プロキシホスト)

String (文字列)

TLS

項目

型

説明

デフォルト値

必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

Trust Store (トラストストア)

トラストストア

Key Store (キーストア)

Key Store (キーストア)

Revocation Check (取り消し確認)

Standard Revocation Check (標準の取り消し確認)
Custom Ocsp Responder (カスタム Ocsp レスポンダー)
Crl File (Crl ファイル)

トラストストア

項目

型

説明

デフォルト値

必須

Path (パス)

String (文字列)

トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。

Key Store (キーストア)

項目

型

説明

デフォルト値

必須

Path (パス)

String (文字列)

キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーがある場合、この属性は、使用する鍵の別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。

Standard Revocation Check (標準の取り消し確認)

項目

型

説明

デフォルト値

必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

Custom Ocsp Responder (カスタム Ocsp レスポンダー)

項目

型

説明

デフォルト値

必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。

Crl File (Crl ファイル)

項目

型

説明

デフォルト値

必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

項目

型

説明

デフォルト値

必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

使用する再接続戦略。

Reconnect (再接続)

項目

型

説明

デフォルト値

必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Count (数)

Number (数値)

再接続の試行回数。

Reconnect Forever (繰り返し再接続)

項目

型

説明

デフォルト値

必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Expiration Policy (有効期限ポリシー)

項目

型

説明

デフォルト値

必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

maxIdleTime 属性の時間単位

Http Response Attributes (HTTP 応答属性)

項目

型

説明

デフォルト値

必須

Status Code (状況コード)

Number (数値)

x

Headers (ヘッダー)

Object (オブジェクト)

x

Reason Phrase (理由を示す語句)

String (文字列)

x

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

項目

型

説明

デフォルト値

必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームをコンシュームし、ストリームへのランダムアクセスを提供する目的で割り当てられるメモリの容量。ストリームに含まれているデータがこのバッファに適合できる量を超えている場合、bufferSizeIncrement 属性に従ってバッファが拡張され、上限は maxInMemorySize となります。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、STREAM_MAXIMUM_SIZE_EXCEEDED エラーが発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、STREAM_MAXIMUM_SIZE_EXCEEDED エラーが発生します。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

BYTE (バイト)
KB
MB
GB

これらのすべての属性の単位

Repeatable File Store Stream (反復可能なファイルストアストリーム)

項目

型

説明

デフォルト値

必須

In Memory Size (メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

BYTE (バイト)
KB
MB
GB

maxInMemorySize で表される単位

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)

項目

型

説明

デフォルト値

必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームをコンシュームし、ランダムアクセスを提供するために初期状態でメモリ内に保持が許容されるインスタンスの量。ストリームのデータ量がこのバッファサイズを超える場合は、bufferSizeIncrement 属性に従って、maxInMemorySize を上限としてバッファが拡張されます。デフォルト値は 100 インスタンスです。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、STREAM_MAXIMUM_SIZE_EXCEEDED エラーが発生します。デフォルト値は 100 インスタンスです。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、STREAM_MAXIMUM_SIZE_EXCEEDED エラーが発生します。0 以下の値は無制限を意味します。

Repeatable File Store Iterable (反復可能なファイルストアイテラブル)

項目

型

説明

デフォルト値

必須

In Memory Objects (メモリ内オブジェクト)

Number (数値)

メモリ内に保持されるインスタンスの最大量。これ以上の量が必要な場合、コンテンツはディスク上にバッファされます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

BYTE (バイト)
KB
MB
GB

maxInMemorySize で表される単位