対象レベルの作成
post
/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels
リクエスト
パス・パラメータ
- SubscriptionProductPuid(required): string
サブスクリプション製品の公開一意識別子。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
Address: string
タイトル:
Address
パーティ・サイトの住所。 -
AssetGroupId: integer (int64)
アセット・グループの一意の識別子。
-
AssetGroupName: string
タイトル:
Asset Group Name
アセット・グループの名前。 -
AssetGroupNumber: string
タイトル:
Asset Group Number
アセット・グループの代替識別子。 -
AssetId: integer (int64)
アセットの一意の識別子。
-
AssetName: string
タイトル:
Covered Level Asset Name
アセットの名前。 -
AssetSerialNumber: string
タイトル:
Covered Asset Serial Number
アセットのシリアル番号。 -
billLines: array Bill Lines
タイトル:
Bill Lines
請求明細リソースは、請求期間、請求日:自、請求日:至、金額、定型フラグ、請求書テキスト、使用数量、使用フラグなど、サブスクリプション請求明細詳細の表示、作成、更新および削除に使用されます。 -
CalculatedCreditAmount: number
タイトル:
Calculated Credit Amount
対象レベルの計算済貸方金額。 -
CancelDescription: string
タイトル:
Cancellation Description
最大長:2000
対象レベルに関連付けられた取消摘要。 -
CanceledAmount: number
取り消された金額。
-
CanceledDate: 文字列(日付)
タイトル:
Canceled Date
対象レベルが取り消された日付。 -
CancelReason: string
タイトル:
Cancellation Reason
最大長:30
対象レベルを取り消す事由。 -
charges: array Charges
タイトル:
Charges
手数料リソースは、手数料名、手数料定義、価格タイプ、価格周期性および階層フラグなどのサブスクリプション手数料詳細の表示、作成、更新および削除に使用されます。 -
ClosedAmount: number
対象レベルがクローズされた金額。
-
ClosedDate: 文字列(日付)
タイトル:
Covered Level Close Date
対象レベルがクローズされた日付。 -
CloseDescription: string
タイトル:
Covered Level Close Description
最大長:2000
対象レベルに関連付けられたクローズ摘要。 -
CloseReason: string
タイトル:
Covered Level Close Reason
最大長:30
対象レベルがクローズされた事由です。 -
CorpCurrencyCode: string
最大長:
15
対象レベルに関連付けられた企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 -
CoveredLevelId: integer (int64)
対象レベルの一意の識別子。
-
CoveredLevelName: string
タイトル:
Covered Level Name
最大長:300
対象レベルの名前。 -
CoveredLevelParentPuid: string
対象レベルの親の代替一意識別子。
-
CoveredLevelPuid(required): string
最大長:
120
対象レベルの公開一意識別子。 -
CoveredLevlName: string
タイトル:
Covered Level Name
対象レベルの名前。 -
CoveredLevlNumber: string
タイトル:
Covered Level Number
対象レベルの代替識別子。 -
CreditedAmount: number
貸方記入された金額。
-
CurcyConvRateType: string
最大長:
30
対象レベルに関連付けられた通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 -
CurrencyCode: string
最大長:
15
対象レベルに関連付けられた通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CustomerAccountId: integer (int64)
顧客アカウントの一意の識別子。
-
CustomerName: string
タイトル:
Customer Account
顧客の名前。 -
CustomerNumber: string
タイトル:
Customer Account Number
顧客の代替一意識別子。 -
Description: string
タイトル:
Covered Level Description
対象レベルの簡単な説明。 -
Duration: integer
対象レベルの期間。
-
EndDate: 文字列(日付)
タイトル:
Covered Level End Date
対象レベルが終了する日付。 -
ExplodeAssetHierarchy: string
アセスメント階層を他の階層にコピーする必要があるかどうかを示します。
-
GenerateBillingSchedule: string
請求スケジュールが生成されるかどうかを示します。
-
HierarchyTotal: number
階層の合計対象レベル。
-
InventoryItemId: integer (int64)
在庫品目の一意の識別子。
-
InvoicedAmount: number
請求書が作成された金額。
-
InvoiceText: string
最大長:
2000
請求書に含まれるテキスト。 -
ItemUnitOfMeasure: string
最大長:
15
対象レベルの品目の測定に使用される単位。 -
LineNumber: string
タイトル:
Number
最大長:300
行番号 -
OverrideCreditAmount: number
タイトル:
Override Credit Amount
対象レベルの貸方金額の上書き。 -
ParentCoveredAssetId: integer (int64)
親対象アセットの一意の識別子。
-
ParentCoveredLevelId: integer (int64)
親対象レベルの一意の識別子。
-
PartyId: integer (int64)
パーティの一意識別子
-
PartyName: string
タイトル:
Party Name
パーティの名前。 -
PartyNumber: string
タイトル:
Party Number
パーティの代替識別子。 -
PartySite: string
タイトル:
Party Site Number
パーティ・サイトの名前。 -
PartySiteId: integer (int64)
パーティ・サイトの一意の識別子。
-
Period: string
最大長:
80
対象レベルの期間。 -
PriceAsOf: 文字列(日付)
特定の日付時点での価格。
-
PriceListId: integer (int64)
価格リストの一意の識別子。
-
PriceUnitOfMeasure: string
最大長:
30
価格を示すために使用される単位。 -
PriceUnitOfMeasureName: string
タイトル:
Pricing UOM
単位の表示名。 -
PricingError: string
最大長:
1000
価格設定のエラー(ある場合)。 -
ProductGroupId: integer (int64)
製品グループの一意の識別子。
-
ProductGroupName: string
タイトル:
Product Group Name
製品グループの名前。 -
ProductGroupNumber: string
タイトル:
Product Group Number
製品グループの代替識別子。 -
ProductName: string
タイトル:
Product Name
対象レベルに関連付けられた製品の名前。 -
PutOnHoldFlag: boolean
対象レベルが保留されているかどうかを示します。
-
数量: number
タイトル:
Quantity
デフォルト値:1
対象レベルの数量。 -
relationships: array Relationships
タイトル:
Relationships
関係リソースは、関係タイプ、ソース・サブスクリプション製品PUID、ターゲット・サブスクリプション製品PUIDなど、サブスクリプション製品関係の詳細を表示、作成、更新および削除するために使用されます。 -
RemoveHoldFlag: boolean
対象レベルの保留を削除する必要があるかどうかを示します。
-
RenewalType: string
タイトル:
Renewal Type
最大長:30
対象レベル更改のタイプ。 -
RenewedDate: 文字列(日付)
対象レベルが更改された日付。
-
RepriceFlag: boolean
サブスクリプション対象レベルを再価格設定する必要があるかどうかを示します。 'true'として渡された場合、サブスクリプションの対象レベルとその子対象レベルは価格再設定されます。
-
ReturnCreditMethod: string
タイトル:
Close Credit Method
最大長:230
クレジットを返すメソッド。 -
RollupTotal: number
対象レベルの積上合計。
-
SourceKey: string
最大長:
120
対象レベルのソース・キー。 -
SourceLineKey: string
最大長:
120
対象レベルのソース明細キー。 -
SourceLineNumber: string
最大長:
120
対象レベルのソース明細番号。 -
SourceNumber: string
最大長:
120
対象レベルのソース番号。 -
SourceSystem: string
最大長:
30
対象レベルのソース・システム。 -
StartDate(required): 文字列(日付)
タイトル:
Covered Level Start Date
対象レベルが開始する日付。 -
Status: string
タイトル:
Covered Level Status
最大長:30
対象レベルのステータス。 -
StatusName: string
タイトル:
Status
対象レベルのステータスの意味。 -
SubscriptionId(required): integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId(required): integer (int64)
サブスクリプション製品の一意の識別子。
-
SuppressedCreditAmount: number
抑制されたクレジット金額。
-
SuspendCreditMethod: string
最大長:
30
クレジット・メソッドを休止する必要があるかどうかを示します。 -
SuspendedDate: 文字列(日付)
タイトル:
Covered Level Suspend Date
対象レベルが休止された日付。 -
SuspendReason: string
タイトル:
Covered Level Suspend Reason
最大長:30
対象レベルのクレジット・メソッドの一時停止の事由。 -
TaxAmount: number
トランザクションに課せられた税額です。
-
TaxError: string
最大長:
4000
計算金額の税金エラー(ある場合)。 -
TotalContractValue: number
タイトル:
Covered Level Contract Value
対象レベルに関連付けられた合計契約値。 -
Type(required): string
タイトル:
Type
最大長:30
対象レベルのタイプ。 -
TypeName: string
タイトル:
Covered Level Type
対象レベルのタイプの名前。 -
UnitPrice: number
タイトル:
Unit Price
対象レベルの単価。
ネストされたスキーマ : 請求明細
タイプ:
array
タイトル:
Bill Lines
請求明細リソースは、請求期間、請求日:自、請求日:至、金額、定型フラグ、請求書テキスト、使用数量、使用フラグなど、サブスクリプション請求明細詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 手数料
タイプ:
array
タイトル:
Charges
手数料リソースは、手数料名、手数料定義、価格タイプ、価格周期性および階層フラグなどのサブスクリプション手数料詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 関係
タイプ:
array
タイトル:
Relationships
関係リソースは、関係タイプ、ソース・サブスクリプション製品PUID、ターゲット・サブスクリプション製品PUIDなど、サブスクリプション製品関係の詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
金額: number
タイトル:
Amount
請求が生成される金額。 -
billAdjustments: array Bill Adjustments
タイトル:
Bill Adjustments
請求修正リソースは、調整名、調整値、調整タイプ、事由および有効性などのサブスクリプション請求修正詳細を表示、作成、更新および削除するために使用されます。 -
BillingPeriod(required): number
タイトル:
Sequence
請求が生成される期間。 -
BillLineId: integer (int64)
請求明細の一意の識別子。
-
BillLinePuid(required): string
最大長:
120
請求明細の公開一意識別子。 -
BusinessUnitId: integer
請求明細に関連付けられているビジネス・ユニットのID。
-
ChargeDefinition: string
最大長:
30
手数料の目的を示す定義。 -
ChargeId: integer (int64)
手数料の一意の識別子。
-
ChargeName: string
タイトル:
Charge Name
最大長:120
請求明細に関連付けられた手数料の名前。 -
ChargePeriod: number
タイトル:
Period
請求された使用期間。 -
ChargePeriodFactor: number
請求明細に関連付けられた変更期間ファクタ。
-
CoveredLevelId: integer (int64)
対象レベルの一意の識別子。
-
CreditMemoAmount: number
クレジット・メモの金額。
-
CreditMemoFlag: string
請求明細に関連付けられたクレジット・メモがあるかどうかを示します。
-
CreditMemoReason: string
クレジット・メモを上げる事由。
-
CreditMemoReasonCode: string
最大長:
30
クレジット・メモ事由コードのコード。 -
CustomerTrxTypeSequenceId: integer (int64)
顧客取引タイプ連番ID
-
DateBilledFrom(required): 文字列(日付)
タイトル:
Bill-from Date
請求が生成された日付。 -
DateBilledTo(required): 文字列(日付)
タイトル:
Bill-to Date
請求が生成される最終日。 -
DateToInterface(required): 文字列(日付)
タイトル:
Interface Date
請求明細のインタフェース日。 -
InterfacedFlag: boolean
タイトル:
Interfaced
最大長:1
デフォルト値:false
請求明細がインタフェースされているかどうかを示します。 -
InvoiceBillLineId: integer (int64)
請求書請求明細の一意の識別子。
-
InvoiceDate: 文字列(日付)
請求書が提起された日付。
-
InvoiceText: string
タイトル:
Invoice Text
最大長:240
請求明細請求書のテキスト。 -
ListPrice: number
請求明細に関連付けられた製品の定価。
-
MilestoneEventId: integer (int64)
請求明細に関連付けられたマイルストン・イベントのID。
-
MilestoneEventName: string
請求明細に関連付けられたマイルストン・イベントの名前。
-
NewCreditMemoPUID: string
新規クレジット・メモの一意の公開識別子。
-
PricedQuantity: number
請求明細が請求された数量。
-
PricingError: string
最大長:
1000
価格設定のエラー(ある場合)。 -
RecurringFlag(required): boolean
最大長:
1
明細が固定処理かどうかを示します。 -
RevenueLineId: integer (int64)
収益明細の一意の識別子。
-
SentDate: 文字列(日付)
タイトル:
Sent Date
請求書情報が売掛管理に送信される日付。 -
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
-
TransactionAmount: number
タイトル:
Invoice Amount
トランザクションが発生した金額。 -
TransactionClass: string
タイトル:
Transaction Class
最大長:30
トランザクションのクラス。 -
TransactionClassMeaning: string
タイトル:
Class
トランザクション区分参照の意味。 -
TransactionDate: 文字列(日付)
タイトル:
Invoice Date
トランザクションが発生した日付。 -
TransactionNumber: string
タイトル:
Invoice Number
最大長:30
トランザクションの番号。 -
TransactionTax: number
タイトル:
Tax
トランザクションに課せられた税金です。 -
TransactionTypeName: string
サブスクリプション請求明細のトランザクション・タイプ名。
-
TruedUpYn: string
最大長:
3
請求明細に調整期間があるかどうかを示します。 -
TrxId: integer (int64)
ARトランザクションID。
-
TrxLineId: integer (int64)
ARトランザクション明細ID。
-
UsageAcquiredFlag: boolean
最大長:
1
使用状況が取得されたかどうかを示します。 -
UsageCaptureDate: 文字列(日付)
使用状況が取得された日付。
-
UsageChargeType: string
タイトル:
Usage Charge Type
最大長:30
使用手数料のタイプ。 -
UsageChargeTypeName: string
使用手数料タイプの名前。
-
UsageFlag: boolean
最大長:
1
明細が使用明細かどうかを示します。 -
UsagePricedFlag: boolean
最大長:
1
使用明細が価格設定されているかどうかを示します。 -
UsageQuantity: number
タイトル:
Usage Quantity
使用量の数量。
ネストされたスキーマ : 請求修正
タイプ:
array
タイトル:
Bill Adjustments
請求修正リソースは、調整名、調整値、調整タイプ、事由および有効性などのサブスクリプション請求修正詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-billLines-billAdjustments-item-post-request
タイプ:
ソースを表示
object
-
AdjustmentBasis: string
タイトル:
Basis
最大長:30
請求が調整される基準。 -
AdjustmentName: string
タイトル:
Adjustment
最大長:120
請求修正の名前。 -
AdjustmentReasonCode: string
最大長:
30
調整事由のコード。 -
AdjustmentType: string
タイトル:
Type
最大長:30
請求修正のタイプ。 -
AdjustmentValue: number
タイトル:
Value
請求の調整に使用する値。 -
AutoAdjustmentFlag: boolean
最大長:
3
調整が自動かどうかを示します。 -
BasisEnableFlag: boolean
基準が請求修正に対して有効になっているかどうかを示します。
-
BillAdjustmentId: integer (int64)
請求修正の一意の識別子。
-
BillAdjustmentPuid: string
最大長:
120
請求修正の公開一意識別子。 -
BillLineId: integer (int64)
請求明細の一意の識別子。
-
ChargeAdjustmentId: integer (int64)
手数料修正の一意の識別子です。
-
CurrencyCode: string
請求修正に使用される現在のコード。
-
Effectivity: string
最大長:
30
請求修正の有効性。 -
NumberOfPeriods: number
期間数
-
PeriodFrom: number
請求が調整された期間。
-
PeriodUntil: number
請求が調整されるまでの期間。
-
Reason: string
タイトル:
Reason Details
最大長:120
請求が調整された事由です。 -
SequenceNumber: number
タイトル:
Sequence
請求修正のシーケンス番号。 -
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-item-post-request
タイプ:
ソースを表示
object
-
adjustments: array Adjustments
タイトル:
Adjustments
調整リソースは、調整名、調整タイプ、調整値、調整事由および有効性などのサブスクリプション手数料調整詳細の表示、作成、更新および削除に使用されます。 -
AggregationMethod: string
最大長:
30
手数料に使用される集計メソッド。 -
手当: number
タイトル:
Allowance
手数料の引当金部分。 -
AssetMeterYn: boolean
最大長:
1
アセット・メーターかどうかを示すフラグ。 -
BillLineId: integer (int64)
請求明細の一意の識別子。
-
BlockSize: number
タイトル:
Block Size
料金のブロック・サイズ。 -
ChargeDefinition: string
タイトル:
Charge Name
最大長:30
手数料の目的を示す定義。 -
ChargeDefinitionName: string
手数料定義の名前。
-
ChargeId: integer (int64)
手数料の一意の識別子。
-
chargeMilestoneEvents: array Charge Milestone Events
タイトル:
Charge Milestone Events
手数料マイルストン・イベント・リソースは、サブスクリプションの手数料に関連付けられたマイルストン・イベントを表示、作成、更新および削除するために使用されます。 -
ChargeName: string
タイトル:
Charge Name
最大長:120
手数料の名前。 -
ChargePuid: string
最大長:
120
手数料の公開一意識別子。 -
chargeTiers: array Charge Tiers
タイトル:
Charge Tiers
手数料階層リソースは、階層:自、階層:至、定価など、サブスクリプション手数料階層の詳細を表示、作成、更新および削除するために使用されます。 -
CoveredLevelId: integer (int64)
対象レベルの一意の識別子。
-
EnableProration: string
最大長:
1
按分が使用可能かどうかを示します。 -
EstimatedAmount: number
タイトル:
Estimated Amount
手数料の見積金額。 -
EstimatedMethodName: string
タイトル:
Estimation Method
金額の見積に使用するメソッド。 -
EstimatedQuantity: number
タイトル:
Estimated Quantity
手数料の見積数量。 -
EstimationMethod: string
タイトル:
Estimation Method
最大長:30
金額の見積に使用するメソッド。 -
ExternalKey: string
最大長:
120
手数料の測定に使用される外部キー。 -
ExternalParentKey: string
最大長:
120
外部親キー。 -
InitialMeterReadingId: integer (int64)
初期メーター読取り識別子値。
-
InvoicingRuleId: integer (int64)
請求書ルールのID。
-
InvoicingRuleName: string
タイトル:
Invoicing Rule
請求書ルールの名前。 -
MeterDefinitionId: integer (int64)
手数料に関連付けられたメーター定義の一意の識別子。
-
MeterId: integer (int64)
手数料に関連付けられたメーターの一意の識別子。
-
MilestoneBillingFlag: boolean
請求がマイルストン・イベントの影響を受けるかどうかを示します。
-
MilestoneRevenueFlag: boolean
収益がマイルストン・イベントの影響を受けるかどうかを示します。
-
MilestoneTemplateId: integer (int64)
手数料に関連付けられたマイルストン・イベントのID。
-
MilestoneTemplateName: string
最大長:
120
手数料に関連付けられたマイルストン・テンプレートの名前。 -
MinimumAmount: number
タイトル:
Minimum Amount
請求される最小金額。 -
MinimumQuantity: number
タイトル:
Minimum Quantity
許可される最小数量。 -
PeriodicBillingFlag: string
最大長:
1
定期請求が許可されているかどうかを示します。 -
PeriodicRevenueFlag: string
タイトル:
Enable Periodic Revenue Recognition
最大長:1
単発手数料の定期収益認識を示します。 -
PrePaymentNumber: integer (int64)
タイトル:
Prepayment Number
手数料の前払金番号。 -
PricePeriodicity: string
タイトル:
Periodicity
最大長:30
手数料の価格周期。 課金を適用する必要がある頻度を示します。 -
PricePeriodicityName: string
価格周期の名前。
-
PriceType(required): string
最大長:
30
手数料に関連付けられた価格タイプ。 -
QuotedTcv: number
料金の見積TCV。
-
RollupFlag: boolean
最大長:
1
手数料を積み上げる必要があるかどうかを示します。 -
SequenceNumber: 整数(int32)
手数料の連番。
-
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
-
TieredFlag: boolean
最大長:
3
手数料に階層があるかどうかを示します。 -
TierType: string
タイトル:
Tier Type
最大長:30
手数料階層のタイプです。 -
TrueUpPeriod: string
タイトル:
True Up Period
最大長:30
デフォルト値:ORA_OSS_USAGE_BILLING_PERIOD
調整期間の識別子。 -
TrueUpPeriodName: string
タイトル:
True Up Period
調整期間の名前。 -
UnitListPrice: number
タイトル:
List Price
ユニット・リストの価格。 -
UsagePriceLockFlag: boolean
最大長:
3
使用価格がロックされているかどうかを示します。
ネストされたスキーマ : 調整
タイプ:
array
タイトル:
Adjustments
調整リソースは、調整名、調整タイプ、調整値、調整事由および有効性などのサブスクリプション手数料調整詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 手数料マイルストン・イベント
タイプ:
array
タイトル:
Charge Milestone Events
手数料マイルストン・イベント・リソースは、サブスクリプションの手数料に関連付けられたマイルストン・イベントを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : 手数料階層
タイプ:
array
タイトル:
Charge Tiers
手数料階層リソースは、階層:自、階層:至、定価など、サブスクリプション手数料階層の詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-adjustments-item-post-request
タイプ:
ソースを表示
object
-
AdjustmentBasis: string
タイトル:
Basis
最大長:30
調整の基準。 -
AdjustmentName: string
タイトル:
Adjustment
最大長:120
調整の名前。 -
AdjustmentReasonCode: string
タイトル:
Reason
最大長:30
調整事由のコード。 -
AdjustmentReasonMeaning: string
タイトル:
Reason
換算済修正事由。 -
AdjustmentType: string
タイトル:
Type
最大長:30
調整のタイプ。 -
AdjustmentValue: number
タイトル:
Value
調整の値。 -
AutoAdjustmentFlag: boolean
最大長:
3
調整が自動かどうかを示します。 -
ChargeAdjustmentId: integer (int64)
手数料修正の一意の識別子です。
-
ChargeAdjustmentPuid: string
最大長:
120
手数料修正の公開一意識別子。 -
ChargeId: integer (int64)
手数料の一意の識別子。
-
Effectivity: string
タイトル:
Effectivity
最大長:30
調整の有効性 -
NumberOfPeriods: number
期間数
-
ObjectVersionNumber: 整数(int32)
オプティミスティック・ロックの実装に使用される数。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
-
PeriodFrom: number
調整が開始された期間。
-
PeriodUntil: number
調整が開始されるまでの期間。
-
Reason: string
タイトル:
Reason Description
最大長:120
修正の理由 -
SequenceNumber: 整数(int32)
タイトル:
Sequence
調整の連番。 -
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-post-request
タイプ:
ソースを表示
object
-
BillingOffset: number
マイルストン・イベントに関連付けられた請求オフセット。
-
BillLineId: integer (int64)
マイルストン・イベントに関連付けられた請求明細ID。
-
ChargeId: integer (int64)
マイルストン・イベントが関連付けられている手数料ID。
-
ChargePuid: string
最大長:
120
デフォルト値:Charges.ChargePuid
マイルストン・イベントが関連付けられている手数料のPUID。 -
CompletionDate: 文字列(日付)
マイルストン・イベントの完了日。
-
EventId: integer (int64)
マイルストン・イベントのID。
-
EventSource: string
最大長:
30
マイルストン・イベントのソース。 -
EventSourceReference: string
最大長:
120
マイルストン・イベントのソース参照。 -
EventType: string
最大長:
30
マイルストン・イベントのタイプ。 -
ExpectedCompletionDate: 文字列(日付)
マイルストン・イベントの予定完了日。
-
MilestoneComment: string
最大長:
300
マイルストン・イベント・コメント。 -
MilestoneName: string
最大長:
30
マイルストン・イベントの名前。 -
MilestonePuid: string
最大長:
120
マイルストン・イベントPUID。 -
ObjectVersionNumber: 整数(int32)
マイルストン・イベントのオブジェクト・バージョン番号。
-
パーセント: number
マイルストン・イベントに関連付けられたパーセント。
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-chargeTiers-item-post-request
タイプ:
ソースを表示
object
-
AdditionalNumberFive: number
タイトル:
Additional Number Five
手数料階層の追加番号(ある場合)。 -
AdditionalNumberFour: number
タイトル:
Additional Number Four
手数料階層の追加番号(ある場合)。 -
AdditionalNumberOne: number
タイトル:
Additional Number One
手数料階層の追加番号(ある場合)。 -
AdditionalNumberSix: number
タイトル:
Additional Number Six
手数料階層の追加番号(ある場合)。 -
AdditionalNumberThree: number
タイトル:
Additional Number Three
手数料階層の追加番号(ある場合)。 -
AdditionalNumberTwo: number
タイトル:
Additional Number Two
手数料階層の追加番号(ある場合)。 -
AdditionalTextOne: string
タイトル:
Additional Text One
最大長:4000
手数料階層の追加テキスト(ある場合)。 -
AdditionalTextTwo: string
タイトル:
Additional Text Two
最大長:4000
手数料階層の追加テキスト(ある場合)。 -
AdditionalTimestampOne: string (date-time)
タイトル:
Additional Time-stamp One
課金階層の追加タイムスタンプ(ある場合)。 -
AdditionalTimestampThree: string (date-time)
タイトル:
Additional Time-stamp Three
課金階層の追加タイムスタンプ(ある場合)。 -
AdditionalTimestampTwo: string (date-time)
タイトル:
Additional Time-stamp Two
課金階層の追加タイムスタンプ(ある場合)。 -
AddtionalTextThree: string
タイトル:
Additional Text Three
最大長:4000
手数料階層の追加テキスト(ある場合)。 -
BlockSize: number
タイトル:
Block Size
ブロック・サイズ -
ChargeId: integer (int64)
手数料の一意の識別子。
-
ChargeTierId: integer (int64)
手数料階層の一意の識別子。
-
ChargeTierPuid: string
最大長:
120
手数料階層の公開一意識別子。 -
ListPrice: number
タイトル:
List Price
定価 -
PriceFormat: string
タイトル:
Price Format
最大長:30
価格の表示書式。 -
SequenceNumber: number
連番
-
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
-
TierFrom: number
タイトル:
Tier From
階層:自 -
TierTo: number
タイトル:
Tier To
階層:至
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
OperationLinksPuid: string
最大長:
120
操作リンクの公開一意識別子。 -
RelationshipTypeCode: string
最大長:
30
関係のタイプを示すコード。 -
SourceAssetKey: string
最大長:
120
ソース・アセット・キー -
SourceProdAssociationId: integer (int64)
ソース製品関連の一意の識別子。
-
SourceProdAssociationPuid: string
最大長:
120
ソース製品関連の公開一意識別子。 -
SourceProductPuid: string
最大長:
120
ソース製品の公開一意識別子。 -
SourceRootAssetKey: string
最大長:
120
ソース・ルート・アセット・キー -
TargetProdAssociationId: integer (int64)
ターゲット製品関連の一意の識別子。
-
TargetProdAssociationPuid: string
最大長:
120
ターゲット製品関連の公開一意識別子。 -
TargetProductPuid: string
最大長:
120
ターゲット製品の公開一意識別子。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : subscriptionProducts-coveredLevels-item-response
タイプ:
ソースを表示
object
-
Address: string
タイトル:
Address
パーティ・サイトの住所。 -
AssetGroupId: integer (int64)
アセット・グループの一意の識別子。
-
AssetGroupName: string
タイトル:
Asset Group Name
アセット・グループの名前。 -
AssetGroupNumber: string
タイトル:
Asset Group Number
アセット・グループの代替識別子。 -
AssetId: integer (int64)
アセットの一意の識別子。
-
AssetName: string
タイトル:
Covered Level Asset Name
アセットの名前。 -
AssetSerialNumber: string
タイトル:
Covered Asset Serial Number
アセットのシリアル番号。 -
billLines: array Bill Lines
タイトル:
Bill Lines
請求明細リソースは、請求期間、請求日:自、請求日:至、金額、定型フラグ、請求書テキスト、使用数量、使用フラグなど、サブスクリプション請求明細詳細の表示、作成、更新および削除に使用されます。 -
CalculatedCreditAmount: number
タイトル:
Calculated Credit Amount
対象レベルの計算済貸方金額。 -
CancelDescription: string
タイトル:
Cancellation Description
最大長:2000
対象レベルに関連付けられた取消摘要。 -
CanceledAmount: number
取り消された金額。
-
CanceledDate: 文字列(日付)
タイトル:
Canceled Date
対象レベルが取り消された日付。 -
CancelReason: string
タイトル:
Cancellation Reason
最大長:30
対象レベルを取り消す事由。 -
charges: array Charges
タイトル:
Charges
手数料リソースは、手数料名、手数料定義、価格タイプ、価格周期性および階層フラグなどのサブスクリプション手数料詳細の表示、作成、更新および削除に使用されます。 -
ClosedAmount: number
対象レベルがクローズされた金額。
-
ClosedDate: 文字列(日付)
タイトル:
Covered Level Close Date
対象レベルがクローズされた日付。 -
CloseDescription: string
タイトル:
Covered Level Close Description
最大長:2000
対象レベルに関連付けられたクローズ摘要。 -
CloseReason: string
タイトル:
Covered Level Close Reason
最大長:30
対象レベルがクローズされた事由です。 -
CorpCurrencyCode: string
最大長:
15
対象レベルに関連付けられた企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 -
CoveredLevelId: integer (int64)
対象レベルの一意の識別子。
-
CoveredLevelName: string
タイトル:
Covered Level Name
最大長:300
対象レベルの名前。 -
CoveredLevelParentPuid: string
対象レベルの親の代替一意識別子。
-
CoveredLevelPuid: string
最大長:
120
対象レベルの公開一意識別子。 -
CoveredLevlName: string
タイトル:
Covered Level Name
対象レベルの名前。 -
CoveredLevlNumber: string
タイトル:
Covered Level Number
対象レベルの代替識別子。 -
CreatedBy: string
読取り専用:
true
最大長:64
対象レベルを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
対象レベルが作成された日付。 -
CreditedAmount: number
貸方記入された金額。
-
CurcyConvRateType: string
最大長:
30
対象レベルに関連付けられた通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 -
CurrencyCode: string
最大長:
15
対象レベルに関連付けられた通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CustomerAccountId: integer (int64)
顧客アカウントの一意の識別子。
-
CustomerName: string
タイトル:
Customer Account
顧客の名前。 -
CustomerNumber: string
タイトル:
Customer Account Number
顧客の代替一意識別子。 -
Description: string
タイトル:
Covered Level Description
対象レベルの簡単な説明。 -
Duration: integer
対象レベルの期間。
-
EndDate: 文字列(日付)
タイトル:
Covered Level End Date
対象レベルが終了する日付。 -
ExplodeAssetHierarchy: string
アセスメント階層を他の階層にコピーする必要があるかどうかを示します。
-
GenerateBillingSchedule: string
請求スケジュールが生成されるかどうかを示します。
-
HierarchyTotal: number
階層の合計対象レベル。
-
InventoryItemId: integer (int64)
在庫品目の一意の識別子。
-
InvoicedAmount: number
請求書が作成された金額。
-
InvoiceText: string
最大長:
2000
請求書に含まれるテキスト。 -
ItemUnitOfMeasure: string
最大長:
15
対象レベルの品目の測定に使用される単位。 -
LastUpdateDate: string (date-time)
読取り専用:
true
対象レベルが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
対象レベルを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
対象レベルを最後に更新したユーザーのログイン詳細。 -
LineNumber: string
タイトル:
Number
最大長:300
行番号 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OverrideCreditAmount: number
タイトル:
Override Credit Amount
対象レベルの貸方金額の上書き。 -
ParentCoveredAssetId: integer (int64)
親対象アセットの一意の識別子。
-
ParentCoveredLevelId: integer (int64)
親対象レベルの一意の識別子。
-
PartyId: integer (int64)
パーティの一意識別子
-
PartyName: string
タイトル:
Party Name
パーティの名前。 -
PartyNumber: string
タイトル:
Party Number
パーティの代替識別子。 -
PartySite: string
タイトル:
Party Site Number
パーティ・サイトの名前。 -
PartySiteId: integer (int64)
パーティ・サイトの一意の識別子。
-
Period: string
最大長:
80
対象レベルの期間。 -
PriceAsOf: 文字列(日付)
特定の日付時点での価格。
-
PriceListId: integer (int64)
価格リストの一意の識別子。
-
PriceUnitOfMeasure: string
最大長:
30
価格を示すために使用される単位。 -
PriceUnitOfMeasureName: string
タイトル:
Pricing UOM
単位の表示名。 -
PricingError: string
最大長:
1000
価格設定のエラー(ある場合)。 -
ProductGroupId: integer (int64)
製品グループの一意の識別子。
-
ProductGroupName: string
タイトル:
Product Group Name
製品グループの名前。 -
ProductGroupNumber: string
タイトル:
Product Group Number
製品グループの代替識別子。 -
ProductName: string
タイトル:
Product Name
対象レベルに関連付けられた製品の名前。 -
PutOnHoldFlag: boolean
対象レベルが保留されているかどうかを示します。
-
数量: number
タイトル:
Quantity
デフォルト値:1
対象レベルの数量。 -
relationships: array Relationships
タイトル:
Relationships
関係リソースは、関係タイプ、ソース・サブスクリプション製品PUID、ターゲット・サブスクリプション製品PUIDなど、サブスクリプション製品関係の詳細を表示、作成、更新および削除するために使用されます。 -
RemoveHoldFlag: boolean
対象レベルの保留を削除する必要があるかどうかを示します。
-
RenewalType: string
タイトル:
Renewal Type
最大長:30
対象レベル更改のタイプ。 -
RenewedDate: 文字列(日付)
対象レベルが更改された日付。
-
RepriceFlag: boolean
サブスクリプション対象レベルを再価格設定する必要があるかどうかを示します。 'true'として渡された場合、サブスクリプションの対象レベルとその子対象レベルは価格再設定されます。
-
ReturnCreditMethod: string
タイトル:
Close Credit Method
最大長:230
クレジットを返すメソッド。 -
RollupTotal: number
対象レベルの積上合計。
-
SerialNumber: string
タイトル:
Covered Asset Serial Number
読取り専用:true
最大長:80
対象レベルのシリアル番号。 -
SourceKey: string
最大長:
120
対象レベルのソース・キー。 -
SourceLineKey: string
最大長:
120
対象レベルのソース明細キー。 -
SourceLineNumber: string
最大長:
120
対象レベルのソース明細番号。 -
SourceNumber: string
最大長:
120
対象レベルのソース番号。 -
SourceSystem: string
最大長:
30
対象レベルのソース・システム。 -
StartDate: 文字列(日付)
タイトル:
Covered Level Start Date
対象レベルが開始する日付。 -
Status: string
タイトル:
Covered Level Status
最大長:30
対象レベルのステータス。 -
StatusName: string
タイトル:
Status
対象レベルのステータスの意味。 -
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
-
SuppressedCreditAmount: number
抑制されたクレジット金額。
-
SuspendCreditMethod: string
最大長:
30
クレジット・メソッドを休止する必要があるかどうかを示します。 -
SuspendedDate: 文字列(日付)
タイトル:
Covered Level Suspend Date
対象レベルが休止された日付。 -
SuspendReason: string
タイトル:
Covered Level Suspend Reason
最大長:30
対象レベルのクレジット・メソッドの一時停止の事由。 -
TaxAmount: number
トランザクションに課せられた税額です。
-
TaxError: string
最大長:
4000
計算金額の税金エラー(ある場合)。 -
TotalContractValue: number
タイトル:
Covered Level Contract Value
対象レベルに関連付けられた合計契約値。 -
Type: string
タイトル:
Type
最大長:30
対象レベルのタイプ。 -
TypeName: string
タイトル:
Covered Level Type
対象レベルのタイプの名前。 -
UnitPrice: number
タイトル:
Unit Price
対象レベルの単価。
ネストされたスキーマ : 請求明細
タイプ:
array
タイトル:
Bill Lines
請求明細リソースは、請求期間、請求日:自、請求日:至、金額、定型フラグ、請求書テキスト、使用数量、使用フラグなど、サブスクリプション請求明細詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 手数料
タイプ:
array
タイトル:
Charges
手数料リソースは、手数料名、手数料定義、価格タイプ、価格周期性および階層フラグなどのサブスクリプション手数料詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 関係
タイプ:
array
タイトル:
Relationships
関係リソースは、関係タイプ、ソース・サブスクリプション製品PUID、ターゲット・サブスクリプション製品PUIDなど、サブスクリプション製品関係の詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-billLines-item-response
タイプ:
ソースを表示
object
-
金額: number
タイトル:
Amount
請求が生成される金額。 -
billAdjustments: array Bill Adjustments
タイトル:
Bill Adjustments
請求修正リソースは、調整名、調整値、調整タイプ、事由および有効性などのサブスクリプション請求修正詳細を表示、作成、更新および削除するために使用されます。 -
BillingPeriod: number
タイトル:
Sequence
請求が生成される期間。 -
BillLineId: integer (int64)
請求明細の一意の識別子。
-
BillLinePuid: string
最大長:
120
請求明細の公開一意識別子。 -
BusinessUnitId: integer
請求明細に関連付けられているビジネス・ユニットのID。
-
ChargeDefinition: string
最大長:
30
手数料の目的を示す定義。 -
ChargeId: integer (int64)
手数料の一意の識別子。
-
ChargeName: string
タイトル:
Charge Name
最大長:120
請求明細に関連付けられた手数料の名前。 -
ChargePeriod: number
タイトル:
Period
請求された使用期間。 -
ChargePeriodFactor: number
請求明細に関連付けられた変更期間ファクタ。
-
ChargePuid: string
読取り専用:
true
手数料の公開一意識別子。 -
CoveredLevelId: integer (int64)
対象レベルの一意の識別子。
-
CreatedBy: string
読取り専用:
true
最大長:64
請求明細を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
請求明細が作成された日付。 -
CreditMemoAmount: number
クレジット・メモの金額。
-
CreditMemoFlag: string
請求明細に関連付けられたクレジット・メモがあるかどうかを示します。
-
CreditMemoReason: string
クレジット・メモを上げる事由。
-
CreditMemoReasonCode: string
最大長:
30
クレジット・メモ事由コードのコード。 -
CustomerTrxTypeSequenceId: integer (int64)
顧客取引タイプ連番ID
-
DateBilledFrom: 文字列(日付)
タイトル:
Bill-from Date
請求が生成された日付。 -
DateBilledTo: 文字列(日付)
タイトル:
Bill-to Date
請求が生成される最終日。 -
DateToInterface: 文字列(日付)
タイトル:
Interface Date
請求明細のインタフェース日。 -
InterfacedFlag: boolean
タイトル:
Interfaced
最大長:1
デフォルト値:false
請求明細がインタフェースされているかどうかを示します。 -
InvoiceBillLineId: integer (int64)
請求書請求明細の一意の識別子。
-
InvoiceDate: 文字列(日付)
請求書が提起された日付。
-
InvoiceText: string
タイトル:
Invoice Text
最大長:240
請求明細請求書のテキスト。 -
LastUpdateDate: string (date-time)
読取り専用:
true
請求明細が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
請求明細を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
請求明細を最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ListPrice: number
請求明細に関連付けられた製品の定価。
-
MilestoneEventId: integer (int64)
請求明細に関連付けられたマイルストン・イベントのID。
-
MilestoneEventName: string
請求明細に関連付けられたマイルストン・イベントの名前。
-
NewCreditMemoPUID: string
新規クレジット・メモの一意の公開識別子。
-
PricedQuantity: number
請求明細が請求された数量。
-
PricingError: string
最大長:
1000
価格設定のエラー(ある場合)。 -
RecurringFlag: boolean
最大長:
1
明細が固定処理かどうかを示します。 -
RevenueLineId: integer (int64)
収益明細の一意の識別子。
-
SentDate: 文字列(日付)
タイトル:
Sent Date
請求書情報が売掛管理に送信される日付。 -
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
-
TransactionAmount: number
タイトル:
Invoice Amount
トランザクションが発生した金額。 -
TransactionClass: string
タイトル:
Transaction Class
最大長:30
トランザクションのクラス。 -
TransactionClassMeaning: string
タイトル:
Class
トランザクション区分参照の意味。 -
TransactionDate: 文字列(日付)
タイトル:
Invoice Date
トランザクションが発生した日付。 -
TransactionNumber: string
タイトル:
Invoice Number
最大長:30
トランザクションの番号。 -
TransactionTax: number
タイトル:
Tax
トランザクションに課せられた税金です。 -
TransactionTypeName: string
サブスクリプション請求明細のトランザクション・タイプ名。
-
TruedUpYn: string
最大長:
3
請求明細に調整期間があるかどうかを示します。 -
TrxId: integer (int64)
ARトランザクションID。
-
TrxLineId: integer (int64)
ARトランザクション明細ID。
-
UsageAcquiredFlag: boolean
最大長:
1
使用状況が取得されたかどうかを示します。 -
UsageCaptureDate: 文字列(日付)
使用状況が取得された日付。
-
UsageChargeType: string
タイトル:
Usage Charge Type
最大長:30
使用手数料のタイプ。 -
UsageChargeTypeName: string
使用手数料タイプの名前。
-
UsageFlag: boolean
最大長:
1
明細が使用明細かどうかを示します。 -
UsagePricedFlag: boolean
最大長:
1
使用明細が価格設定されているかどうかを示します。 -
UsageQuantity: number
タイトル:
Usage Quantity
使用量の数量。
ネストされたスキーマ : 請求修正
タイプ:
array
タイトル:
Bill Adjustments
請求修正リソースは、調整名、調整値、調整タイプ、事由および有効性などのサブスクリプション請求修正詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response
タイプ:
ソースを表示
object
-
AdjustmentBasis: string
タイトル:
Basis
最大長:30
請求が調整される基準。 -
AdjustmentName: string
タイトル:
Adjustment
最大長:120
請求修正の名前。 -
AdjustmentReasonCode: string
最大長:
30
調整事由のコード。 -
AdjustmentType: string
タイトル:
Type
最大長:30
請求修正のタイプ。 -
AdjustmentValue: number
タイトル:
Value
請求の調整に使用する値。 -
AutoAdjustmentFlag: boolean
最大長:
3
調整が自動かどうかを示します。 -
BasisEnableFlag: boolean
基準が請求修正に対して有効になっているかどうかを示します。
-
BillAdjustmentId: integer (int64)
請求修正の一意の識別子。
-
BillAdjustmentPuid: string
最大長:
120
請求修正の公開一意識別子。 -
BillLineId: integer (int64)
請求明細の一意の識別子。
-
ChargeAdjustmentId: integer (int64)
手数料修正の一意の識別子です。
-
CreatedBy: string
読取り専用:
true
最大長:64
請求修正を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
請求修正が作成された日付。 -
CurrencyCode: string
請求修正に使用される現在のコード。
-
Effectivity: string
最大長:
30
請求修正の有効性。 -
LastUpdateDate: string (date-time)
読取り専用:
true
請求修正が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
請求修正を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
請求修正を最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
NumberOfPeriods: number
期間数
-
PeriodFrom: number
請求が調整された期間。
-
PeriodUntil: number
請求が調整されるまでの期間。
-
Reason: string
タイトル:
Reason Details
最大長:120
請求が調整された事由です。 -
SequenceNumber: number
タイトル:
Sequence
請求修正のシーケンス番号。 -
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-item-response
タイプ:
ソースを表示
object
-
adjustments: array Adjustments
タイトル:
Adjustments
調整リソースは、調整名、調整タイプ、調整値、調整事由および有効性などのサブスクリプション手数料調整詳細の表示、作成、更新および削除に使用されます。 -
AggregationMethod: string
最大長:
30
手数料に使用される集計メソッド。 -
手当: number
タイトル:
Allowance
手数料の引当金部分。 -
AssetMeterYn: boolean
最大長:
1
アセット・メーターかどうかを示すフラグ。 -
BillLineId: integer (int64)
請求明細の一意の識別子。
-
BlockSize: number
タイトル:
Block Size
料金のブロック・サイズ。 -
ChargeDefinition: string
タイトル:
Charge Name
最大長:30
手数料の目的を示す定義。 -
ChargeDefinitionName: string
手数料定義の名前。
-
ChargeId: integer (int64)
手数料の一意の識別子。
-
chargeMilestoneEvents: array Charge Milestone Events
タイトル:
Charge Milestone Events
手数料マイルストン・イベント・リソースは、サブスクリプションの手数料に関連付けられたマイルストン・イベントを表示、作成、更新および削除するために使用されます。 -
ChargeName: string
タイトル:
Charge Name
最大長:120
手数料の名前。 -
ChargePuid: string
最大長:
120
手数料の公開一意識別子。 -
chargeTiers: array Charge Tiers
タイトル:
Charge Tiers
手数料階層リソースは、階層:自、階層:至、定価など、サブスクリプション手数料階層の詳細を表示、作成、更新および削除するために使用されます。 -
CoveredLevelId: integer (int64)
対象レベルの一意の識別子。
-
CreatedBy: string
読取り専用:
true
最大長:64
手数料を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
手数料が作成された日付。 -
EnableProration: string
最大長:
1
按分が使用可能かどうかを示します。 -
EstimatedAmount: number
タイトル:
Estimated Amount
手数料の見積金額。 -
EstimatedMethodName: string
タイトル:
Estimation Method
金額の見積に使用するメソッド。 -
EstimatedQuantity: number
タイトル:
Estimated Quantity
手数料の見積数量。 -
EstimationMethod: string
タイトル:
Estimation Method
最大長:30
金額の見積に使用するメソッド。 -
ExternalKey: string
最大長:
120
手数料の測定に使用される外部キー。 -
ExternalParentKey: string
最大長:
120
外部親キー。 -
InitialMeterReadingId: integer (int64)
初期メーター読取り識別子値。
-
InvoicingRuleId: integer (int64)
請求書ルールのID。
-
InvoicingRuleName: string
タイトル:
Invoicing Rule
請求書ルールの名前。 -
LastUpdateDate: string (date-time)
読取り専用:
true
手数料が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
手数料を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
料金を最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MeterDefinitionId: integer (int64)
手数料に関連付けられたメーター定義の一意の識別子。
-
MeterId: integer (int64)
手数料に関連付けられたメーターの一意の識別子。
-
MilestoneBillingFlag: boolean
請求がマイルストン・イベントの影響を受けるかどうかを示します。
-
MilestoneRevenueFlag: boolean
収益がマイルストン・イベントの影響を受けるかどうかを示します。
-
MilestoneTemplateId: integer (int64)
手数料に関連付けられたマイルストン・イベントのID。
-
MilestoneTemplateName: string
最大長:
120
手数料に関連付けられたマイルストン・テンプレートの名前。 -
MinimumAmount: number
タイトル:
Minimum Amount
請求される最小金額。 -
MinimumQuantity: number
タイトル:
Minimum Quantity
許可される最小数量。 -
PeriodicBillingFlag: string
最大長:
1
定期請求が許可されているかどうかを示します。 -
PeriodicRevenueFlag: string
タイトル:
Enable Periodic Revenue Recognition
最大長:1
単発手数料の定期収益認識を示します。 -
PrePaymentNumber: integer (int64)
タイトル:
Prepayment Number
手数料の前払金番号。 -
PricePeriodicity: string
タイトル:
Periodicity
最大長:30
手数料の価格周期。 課金を適用する必要がある頻度を示します。 -
PricePeriodicityName: string
価格周期の名前。
-
PriceType: string
最大長:
30
手数料に関連付けられた価格タイプ。 -
QuotedTcv: number
料金の見積TCV。
-
RollupFlag: boolean
最大長:
1
手数料を積み上げる必要があるかどうかを示します。 -
SequenceNumber: 整数(int32)
手数料の連番。
-
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
-
TieredFlag: boolean
最大長:
3
手数料に階層があるかどうかを示します。 -
TierType: string
タイトル:
Tier Type
最大長:30
手数料階層のタイプです。 -
TrueUpPeriod: string
タイトル:
True Up Period
最大長:30
デフォルト値:ORA_OSS_USAGE_BILLING_PERIOD
調整期間の識別子。 -
TrueUpPeriodName: string
タイトル:
True Up Period
調整期間の名前。 -
UnitListPrice: number
タイトル:
List Price
ユニット・リストの価格。 -
UsagePriceLockFlag: boolean
最大長:
3
使用価格がロックされているかどうかを示します。
ネストされたスキーマ : 調整
タイプ:
array
タイトル:
Adjustments
調整リソースは、調整名、調整タイプ、調整値、調整事由および有効性などのサブスクリプション手数料調整詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 手数料マイルストン・イベント
タイプ:
array
タイトル:
Charge Milestone Events
手数料マイルストン・イベント・リソースは、サブスクリプションの手数料に関連付けられたマイルストン・イベントを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : 手数料階層
タイプ:
array
タイトル:
Charge Tiers
手数料階層リソースは、階層:自、階層:至、定価など、サブスクリプション手数料階層の詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-adjustments-item-response
タイプ:
ソースを表示
object
-
AdjustmentBasis: string
タイトル:
Basis
最大長:30
調整の基準。 -
AdjustmentName: string
タイトル:
Adjustment
最大長:120
調整の名前。 -
AdjustmentReasonCode: string
タイトル:
Reason
最大長:30
調整事由のコード。 -
AdjustmentReasonMeaning: string
タイトル:
Reason
換算済修正事由。 -
AdjustmentType: string
タイトル:
Type
最大長:30
調整のタイプ。 -
AdjustmentValue: number
タイトル:
Value
調整の値。 -
AutoAdjustmentFlag: boolean
最大長:
3
調整が自動かどうかを示します。 -
ChargeAdjustmentId: integer (int64)
手数料修正の一意の識別子です。
-
ChargeAdjustmentPuid: string
最大長:
120
手数料修正の公開一意識別子。 -
ChargeId: integer (int64)
手数料の一意の識別子。
-
CreatedBy: string
読取り専用:
true
最大長:64
調整を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
調整が作成された日付。 -
Effectivity: string
タイトル:
Effectivity
最大長:30
調整の有効性 -
LastUpdateDate: string (date-time)
読取り専用:
true
調整が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
調整を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
調整を最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
NumberOfPeriods: number
期間数
-
ObjectVersionNumber: 整数(int32)
オプティミスティック・ロックの実装に使用される数。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
-
PeriodFrom: number
調整が開始された期間。
-
PeriodUntil: number
調整が開始されるまでの期間。
-
Reason: string
タイトル:
Reason Description
最大長:120
修正の理由 -
SequenceNumber: 整数(int32)
タイトル:
Sequence
調整の連番。 -
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-response
タイプ:
ソースを表示
object
-
BillingOffset: number
マイルストン・イベントに関連付けられた請求オフセット。
-
BillLineId: integer (int64)
マイルストン・イベントに関連付けられた請求明細ID。
-
ChargeId: integer (int64)
マイルストン・イベントが関連付けられている手数料ID。
-
ChargePuid: string
最大長:
120
デフォルト値:Charges.ChargePuid
マイルストン・イベントが関連付けられている手数料のPUID。 -
CompletionDate: 文字列(日付)
マイルストン・イベントの完了日。
-
CreatedBy: string
読取り専用:
true
最大長:64
マイルストン・イベントを作成したユーザーのログイン。 -
CreationDate: string (date-time)
読取り専用:
true
マイルストン・イベントが作成された日付。 -
EventId: integer (int64)
マイルストン・イベントのID。
-
EventSource: string
最大長:
30
マイルストン・イベントのソース。 -
EventSourceReference: string
最大長:
120
マイルストン・イベントのソース参照。 -
EventType: string
最大長:
30
マイルストン・イベントのタイプ。 -
ExpectedCompletionDate: 文字列(日付)
マイルストン・イベントの予定完了日。
-
LastUpdateDate: string (date-time)
読取り専用:
true
マイルストン・イベントが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
マイルストン・イベントを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
マイルストン・イベントを最後に更新したログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MilestoneComment: string
最大長:
300
マイルストン・イベント・コメント。 -
MilestoneName: string
最大長:
30
マイルストン・イベントの名前。 -
MilestonePuid: string
最大長:
120
マイルストン・イベントPUID。 -
ObjectVersionNumber: 整数(int32)
マイルストン・イベントのオブジェクト・バージョン番号。
-
パーセント: number
マイルストン・イベントに関連付けられたパーセント。
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-chargeTiers-item-response
タイプ:
ソースを表示
object
-
AdditionalNumberFive: number
タイトル:
Additional Number Five
手数料階層の追加番号(ある場合)。 -
AdditionalNumberFour: number
タイトル:
Additional Number Four
手数料階層の追加番号(ある場合)。 -
AdditionalNumberOne: number
タイトル:
Additional Number One
手数料階層の追加番号(ある場合)。 -
AdditionalNumberSix: number
タイトル:
Additional Number Six
手数料階層の追加番号(ある場合)。 -
AdditionalNumberThree: number
タイトル:
Additional Number Three
手数料階層の追加番号(ある場合)。 -
AdditionalNumberTwo: number
タイトル:
Additional Number Two
手数料階層の追加番号(ある場合)。 -
AdditionalTextOne: string
タイトル:
Additional Text One
最大長:4000
手数料階層の追加テキスト(ある場合)。 -
AdditionalTextTwo: string
タイトル:
Additional Text Two
最大長:4000
手数料階層の追加テキスト(ある場合)。 -
AdditionalTimestampOne: string (date-time)
タイトル:
Additional Time-stamp One
課金階層の追加タイムスタンプ(ある場合)。 -
AdditionalTimestampThree: string (date-time)
タイトル:
Additional Time-stamp Three
課金階層の追加タイムスタンプ(ある場合)。 -
AdditionalTimestampTwo: string (date-time)
タイトル:
Additional Time-stamp Two
課金階層の追加タイムスタンプ(ある場合)。 -
AddtionalTextThree: string
タイトル:
Additional Text Three
最大長:4000
手数料階層の追加テキスト(ある場合)。 -
BlockSize: number
タイトル:
Block Size
ブロック・サイズ -
ChargeId: integer (int64)
手数料の一意の識別子。
-
ChargeTierId: integer (int64)
手数料階層の一意の識別子。
-
ChargeTierPuid: string
最大長:
120
手数料階層の公開一意識別子。 -
CreatedBy: string
読取り専用:
true
最大長:64
手数料階層を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
課金階層が作成された日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
課金階層が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
手数料階層を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
課金階層を最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ListPrice: number
タイトル:
List Price
定価 -
PriceFormat: string
タイトル:
Price Format
最大長:30
価格の表示書式。 -
SequenceNumber: number
連番
-
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
-
TierFrom: number
タイトル:
Tier From
階層:自 -
TierTo: number
タイトル:
Tier To
階層:至
ネストされたスキーマ : subscriptionProducts-coveredLevels-relationships-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
読取り専用:
true
最大長:64
関係を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
関係が作成された日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
関係が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
関係を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
関係を最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
読取り専用:
true
オプティミスティック・ロックの実装に使用される数。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。 -
OperationLinksPuid: string
最大長:
120
操作リンクの公開一意識別子。 -
RelationshipTypeCode: string
最大長:
30
関係のタイプを示すコード。 -
SourceAssetKey: string
最大長:
120
ソース・アセット・キー -
SourceProdAssociationId: integer (int64)
ソース製品関連の一意の識別子。
-
SourceProdAssociationPuid: string
最大長:
120
ソース製品関連の公開一意識別子。 -
SourceProductPuid: string
最大長:
120
ソース製品の公開一意識別子。 -
SourceRootAssetKey: string
最大長:
120
ソース・ルート・アセット・キー -
TargetProdAssociationId: integer (int64)
ターゲット製品関連の一意の識別子。
-
TargetProdAssociationPuid: string
最大長:
120
ターゲット製品関連の公開一意識別子。 -
TargetProductPuid: string
最大長:
120
ターゲット製品の公開一意識別子。
リンク
- billLines
-
パラメータ:
- CoveredLevelPuid:
$request.path.CoveredLevelPuid
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
請求明細ビュー・オブジェクト - CoveredLevelPuid:
- 手数料
-
パラメータ:
- CoveredLevelPuid:
$request.path.CoveredLevelPuid
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
サブスクリプション手数料ビュー・オブジェクト - CoveredLevelPuid:
- 関係
-
パラメータ:
- CoveredLevelPuid:
$request.path.CoveredLevelPuid
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
関係ビュー・オブジェクト - CoveredLevelPuid:
例:
次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行して、対象レベルを作成する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/CDRM_4016-PRDT-2013/child/coveredLevels
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{ "CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1", "LineNumber": "1", "InventoryItemId": 300100118490672, "AssetId": 300100118585763, "AssetName": "zOKC_Auto_Asset1", "ProductName": "ZOKC_Item_001", "Description": "Item", "Type": "ORA_ASSET", "Quantity": 1, "ItemUnitOfMeasure": "Ea", "TotalContractValue": 12361.29, "EndDate": "2020-05-29", "StartDate": "2020-01-01", "PriceAsOf": "2020-01-01", "PriceUnitOfMeasure": "0zE" }
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "CoveredLevelId": 300100192686410, "CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1", "SubscriptionProductId": 300100181994505, "SubscriptionId": 300100181994494, "LineNumber": "1", "InventoryItemId": 300100118490672, "AssetId": 300100118585763, "AssetName": "zOKC_Auto_Asset1", "AssetSerialNumber": null, "ProductName": "ZOKC_Item_001", "Description": "Item", "Type": "ORA_ASSET", "TypeName": "Asset", "Quantity": 1, "ItemUnitOfMeasure": "Ea", "TotalContractValue": 12361.29, "GenerateBillingSchedule": null, "EndDate": "2020-05-29", "StartDate": "2020-01-01", "Duration": 150, "Period": "DY", "Status": "ORA_DRAFT", "StatusName": "Draft", "PriceAsOf": "2020-01-01", "PriceUnitOfMeasure": "0zE", "PriceUnitOfMeasureName": "YEAR", "PriceListId": null, "PricingError": null, "TaxAmount": null, "InvoiceText": "[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]", "CancelReason": null, "CanceledDate": null, "CanceledAmount": null, "ClosedDate": null, "CloseReason": null, "ClosedAmount": null, "ReturnCreditMethod": null, "SuppressedCreditAmount": null, "InvoicedAmount": null, "CreditedAmount": null, "RenewedDate": null, "RenewalType": null, "TaxError": null, "CreatedBy": "SALES_ADMIN", "CreationDate": "2019-08-20T06:55:15+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateDate": "2019-08-20T06:55:15.130+00:00", "LastUpdateLogin": "9062D47DF31EDAF6E0533EFDF40A2696", "CurrencyCode": null, "CorpCurrencyCode": null, "CurcyConvRateType": null, "PutOnHoldFlag": null, "RemoveHoldFlag": null, "links": ... }