サブスクリプション請求調整の取得
get
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
リクエスト
パス・パラメータ
- BillAdjustmentPuid(required): string
請求修正PUID
- BillLinePuid(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-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)
請求修正ID
-
BillAdjustmentPuid: string
最大長:
120
請求修正PUID -
BillLineId: integer (int64)
請求明細ID
-
ChargeAdjustmentId: integer (int64)
手数料修正ID
-
CreatedBy: string
読取り専用:
true
最大長:64
作成者 -
CreationDate: string (date-time)
読取り専用:
true
作成日 -
CurrencyCode: string
通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
-
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)
サブスクリプション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値を変更します。
例:
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、サブスクリプション請求調整を取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/GP-7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-5/child/billLines/GP-7788-PRDT-13-BILL-931/child/billAdjustments/GP-7788-PRDT-13-BILL-931-BADJ-38
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "BillAdjustmentId": 100100108507147, "SubscriptionId": 300100177232478, "SubscriptionProductId": 300100177232481, "BillLineId": 100100108507019, "BillAdjustmentPuid": "GP-7788-PRDT-13-BILL-931-BADJ-38", "ChargeAdjustmentId": 300100177232518, "AdjustmentName": "One time discount", "AdjustmentValue": 50, "AdjustmentType": "ORA_DISCOUNT_AMOUNT", "AdjustmentBasis": null, "Reason": null, "Effectivity": "ORA_ALL_TERM", "NumberOfPeriods": null, "PeriodFrom": null, "PeriodUntil": null, "SequenceNumber": 1, "AutoAdjustmentFlag": false, "CreatedBy": "CONMGR", "CreationDate": "2019-06-05T10:58:18+00:00", "LastUpdatedBy": "CONMGR", "LastUpdateDate": "2019-06-05T10:58:18+00:00", "LastUpdateLogin": "8A568A61F0F3BE1AE05323EAF40A9340", "CurrencyCode": null, "BasisEnableFlag": "false", ... }