サブスクリプション手数料の取得
get
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}
リクエスト
パス・パラメータ
- ChargePuid(required): string
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
- CoveredLevelPuid(required): string
対象レベルPUID
- SubscriptionNumber(required): string
サブスクリプションの代替識別子。
- SubscriptionProductPuid(required): string
サブスクリプション製品PUID。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : subscriptions-products-coveredLevels-charges-item-response
タイプ:
ソースを表示
object
-
adjustments: array Adjustments
タイトル:
Adjustments
調整リソースは、サブスクリプション料金に対する調整の表示、作成、更新および削除に使用されます。 -
AggregationMethod: string
最大長:
30
手数料に使用される集計メソッド。 -
手当: number
タイトル:
Allowance
手当 -
AssetMeterYn: boolean
最大長:
1
アセット・メーターかどうかを示すフラグ。 -
BillLineId: integer (int64)
請求明細ID
-
BlockSize: number
タイトル:
Block Size
ブロック・サイズ -
ChargeDefinition: string
タイトル:
Charge Name
最大長:30
手数料の目的を示す定義。 -
ChargeDefinitionName: string
手数料定義名
-
ChargeId: integer (int64)
手数料ID
-
chargeMilestoneEvents: array Charge Milestone Events
タイトル:
Charge Milestone Events
手数料マイルストン・イベント・リソースは、サブスクリプションの手数料に関連付けられたマイルストン・イベントを表示、作成、更新および削除するために使用されます。 -
ChargeName: string
タイトル:
Charge Name
最大長:120
手数料名 -
ChargePuid: string
最大長:
120
手数料PUID -
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)
サブスクリプションID
-
SubscriptionProductId: integer (int64)
サブスクリプション製品ID
-
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
タイトル:
Charge Milestone Events
手数料マイルストン・イベント・リソースは、サブスクリプションの手数料に関連付けられたマイルストン・イベントを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : 手数料階層
タイプ:
array
タイトル:
Charge Tiers
手数料階層リソースは、サブスクリプションのサブスクリプション手数料階層詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptions-products-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)
手数料修正ID
-
ChargeAdjustmentPuid: string
最大長:
120
手数料調整PUID -
ChargeId: integer (int64)
手数料ID
-
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)
サブスクリプションID
-
SubscriptionProductId: integer (int64)
サブスクリプション製品ID
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : subscriptions-products-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
マイルストン・イベントに関連付けられたパーセント。
ネストされたスキーマ : subscriptions-products-coveredLevels-charges-chargeTiers-item-response
タイプ:
ソースを表示
object
-
AdditionalNumberFive: number
タイトル:
Additional Number Five
追加番号5 -
AdditionalNumberFour: number
タイトル:
Additional Number Four
追加番号4 -
AdditionalNumberOne: number
タイトル:
Additional Number One
追加番号1 -
AdditionalNumberSix: number
タイトル:
Additional Number Six
追加番号6 -
AdditionalNumberThree: number
タイトル:
Additional Number Three
追加番号3 -
AdditionalNumberTwo: number
タイトル:
Additional Number Two
追加番号2 -
AdditionalTextOne: string
タイトル:
Additional Text One
最大長:4000
追加テキスト1 -
AdditionalTextTwo: string
タイトル:
Additional Text Two
最大長:4000
追加テキスト2 -
AdditionalTimestampOne: string (date-time)
タイトル:
Additional Time-stamp One
追加タイムスタンプ1 -
AdditionalTimestampThree: string (date-time)
タイトル:
Additional Time-stamp Three
追加タイムスタンプ3 -
AdditionalTimestampTwo: string (date-time)
タイトル:
Additional Time-stamp Two
追加タイムスタンプ2 -
AddtionalTextThree: string
タイトル:
Additional Text Three
最大長:4000
追加テキスト3 -
BlockSize: number
タイトル:
Block Size
ブロック・サイズ -
ChargeId: integer (int64)
手数料ID
-
ChargeTierId: integer (int64)
手数料階層ID
-
ChargeTierPuid: string
最大長:
120
手数料階層PUID -
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)
サブスクリプションID
-
SubscriptionProductId: integer (int64)
サブスクリプション製品ID
-
TierFrom: number
タイトル:
Tier From
階層:自 -
TierTo: number
タイトル:
Tier To
階層:至
リンク
- 修正
-
パラメータ:
- ChargePuid2:
$request.path.ChargePuid2
- CoveredLevelPuid:
$request.path.CoveredLevelPuid
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
手数料修正 - ChargePuid2:
- chargeMilestoneEvents
-
パラメータ:
- ChargePuid2:
$request.path.ChargePuid2
- CoveredLevelPuid:
$request.path.CoveredLevelPuid
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
手数料マイルストン・イベント・ビュー・オブジェクト - ChargePuid2:
- chargeTiers
-
パラメータ:
- ChargePuid2:
$request.path.ChargePuid2
- CoveredLevelPuid:
$request.path.CoveredLevelPuid
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
手数料階層 - ChargePuid2: