機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. サブスクリプション製品
  4. 対象レベル
  5. 手数料

すべての手数料の取得

get

/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • ChargePuidAltKey : 指定した課金PUIDを持つサブスクリプション料金を検索します。
      ファインダ変数:
      • ChargePuid; string; 料金の公開一意識別子。
    • PrimaryKey : 指定した課金IDを持つサブスクリプション課金を検索します。
      ファインダ変数:
      • ChargeId; integer; 料金の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AggregationMethod; string; 料金に使用される集計メソッド。
    • 手当;番号;手数料の手当部分。
    • AssetMeterYn; boolean;資産メーターかどうかを示すフラグ。
    • BillLineId; integer;請求明細の一意の識別子。
    • BlockSize; number;料金のブロック・サイズ。
    • ChargeDefinition; string; 料金の目的を示す定義。
    • ChargeDefinitionName; string;料金定義の名前。
    • ChargeId; integer; 料金の一意の識別子。
    • ChargeName; string;チャージの名前。
    • ChargePuid; string; 料金の公開一意識別子。
    • CoveredLevelId; integer;対象レベルの一意の識別子。
    • CreatedBy; string; 料金を作成したユーザー。
    • CreationDate; string; 課金が作成された日付。
    • EnableProration; string;按分が使用可能かどうかを示します。
    • EstimatedAmount; number;料金の見積金額。
    • EstimatedQuantity; number;料金の見積数量。
    • EstimationMethod; string;金額の見積りに使用されるメソッド。
    • ExternalKey; string; 料金の測定に使用される外部キー。
    • ExternalParentKey; string;外部親キー。
    • InitialMeterReadingId; integer;初期メーター読取り識別子値。
    • InvoicingRuleId; integer;請求書ルールのID。
    • LastUpdateDate; string; 料金が最後に更新された日付。
    • LastUpdateLogin; string; 料金を最後に更新したユーザーのログイン詳細。
    • LastUpdatedBy; string; 料金を最後に更新したユーザー。
    • MeterDefinitionId; integer;料金に関連付けられたメーター定義の一意の識別子。
    • MeterId; integer;料金に関連付けられたメーターの一意の識別子。
    • MilestoneBillingFlag; boolean。請求がマイルストン・イベントの影響を受けるかどうかを示します。
    • MilestoneRevenueFlag; boolean;収益がマイルストン・イベントの影響を受けるかどうかを示します。
    • MilestoneTemplateId; integer;料金に関連付けられたマイルストン・イベントのID。
    • MinimumAmount; number;請求される最小金額。
    • MinimumQuantity; number;許可される最小数量。
    • PeriodicBillingFlag; string;定期請求が許可されるかどうかを示します。
    • PeriodicRevenueFlag; string;単発料金の定期収益認識を示します。
    • PrePaymentNumber; integer;手数料の前払番号。
    • PricePeriodicity; string;料金の価格周期。 課金を適用する必要がある頻度を示します。
    • PricePeriodicityName; string;価格周期の名前。
    • PriceType; string; 料金に関連付けられた価格タイプ。
    • QuotedTcv; number;料金の見積TCV。
    • RollupFlag; boolean。料金を積み上げる必要があるかどうかを示します。
    • SequenceNumber; integer; 料金のシーケンス番号。
    • SubscriptionId; integer; サブスクリプションの一意の識別子。
    • SubscriptionProductId; integer;サブスクリプション製品の一意の識別子。
    • TierType; string;課金階層のタイプ。
    • TieredFlag; boolean;料金に階層があるかどうかを示します。
    • TrueUpPeriod; string;調整期間の識別子。
    • UnitListPrice; number;ユニット・リストの価格。
    • UsagePriceLockFlag; boolean;使用価格がロックされているかどうかを示します。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : subscriptionProducts-coveredLevels-charges
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 調整
タイプ: array
タイトル: Adjustments
調整リソースは、調整名、調整タイプ、調整値、調整事由および有効性などのサブスクリプション手数料調整詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : 手数料マイルストン・イベント
タイプ: array
タイトル: Charge Milestone Events
手数料マイルストン・イベント・リソースは、サブスクリプションの手数料に関連付けられたマイルストン・イベントを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : 手数料階層
タイプ: array
タイトル: Charge Tiers
手数料階層リソースは、階層:自、階層:至、定価など、サブスクリプション手数料階層の詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-adjustments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionProducts-coveredLevels-charges-chargeTiers-item-response
タイプ: object
ソースを表示
トップに戻る

例:

次の例では、cURLを使用してRESTリソースに対するgetリクエストを発行して、すべての課金を取得する方法を示します。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "items": [
        {
            "BillLineId": null,
            "ChargeDefinition": "ZOKC_SK_RECURRINGCHARGE",
            "ChargeId": 300100549893998,
            "ChargePuid": "OSS_8cb25640426-PRDT-16050-CHRG-14192",
            "CoveredLevelId": 300100549893995,
            "PrePaymentNumber": null,
            "PricePeriodicity": "0zG",
            "PriceType": "RECURRING",
            "RollupFlag": false,
            "SequenceNumber": 2,
            "SubscriptionId": 300100549819828,
            "SubscriptionProductId": 300100549893990,
            "ChargeName": "ZOKC_SK_RECURRINGCHARGE",
            "ExternalKey": null,
            "ExternalParentKey": null,
            "UnitListPrice": 200,
            "Allowance": null,
            "BlockSize": null,
            "TieredFlag": null,
            "TierType": null,
            "UsagePriceLockFlag": null,
            "PricePeriodicityName": "MONTH",
            "ChargeDefinitionName": null,
            "CreatedBy": "CONMGR",
            "CreationDate": "2021-08-13T03:41:38.615+00:00",
            "LastUpdateDate": "2021-08-13T03:41:38.727+00:00",
            "LastUpdateLogin": "C907025BCC5E3573E0533BFDF40A6826",
            "LastUpdatedBy": "CONMGR",
            "MeterDefinitionId": null,
            "MeterId": null,
            "InitialMeterReadingId": null,
            "AggregationMethod": null,
            "AssetMeterYn": null,
            "TrueUpPeriod": null,
            "TrueUpPeriodName": null,
            "EstimatedAmount": null,
            "EstimatedMethodName": null,
            "EstimatedQuantity": null,
            "EstimationMethod": null,
            "MinimumAmount": null,
            "MinimumQuantity": null,
            "InvoicingRuleId": null,
            "InvoicingRuleName": null,
            "PeriodicBillingFlag": null,
            "PeriodicRevenueFlag": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/OSS_8cb25640426-PRDT-16050/child/coveredLevels/OSS_8cb25640426-PRDT-16050-PASS-16021/child/charges/OSS_8cb25640426-PRDT-16050-CHRG-14192",
                    "name": "charges",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/OSS_8cb25640426-PRDT-16050/child/coveredLevels/OSS_8cb25640426-PRDT-16050-PASS-16021/child/charges/OSS_8cb25640426-PRDT-16050-CHRG-14192",
                    "name": "charges",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/OSS_8cb25640426-PRDT-16050/child/coveredLevels/OSS_8cb25640426-PRDT-16050-PASS-16021",
                    "name": "coveredLevels",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/OSS_8cb25640426-PRDT-16050/child/coveredLevels/OSS_8cb25640426-PRDT-16050-PASS-16021/child/charges/OSS_8cb25640426-PRDT-16050-CHRG-14192/lov/PaymentSetIdVA",
                    "name": "PaymentSetIdVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/OSS_8cb25640426-PRDT-16050/child/coveredLevels/OSS_8cb25640426-PRDT-16050-PASS-16021/child/charges/OSS_8cb25640426-PRDT-16050-CHRG-14192/lov/InvoiceRuleVA",
                    "name": "InvoiceRuleVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/OSS_8cb25640426-PRDT-16050/child/coveredLevels/OSS_8cb25640426-PRDT-16050-PASS-16021/child/charges/OSS_8cb25640426-PRDT-16050-CHRG-14192/lov/TrueUpNameVA",
                    "name": "TrueUpNameVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/OSS_8cb25640426-PRDT-16050/child/coveredLevels/OSS_8cb25640426-PRDT-16050-PASS-16021/child/charges/OSS_8cb25640426-PRDT-16050-CHRG-14192/lov/TierTypePVO",
                    "name": "TierTypePVO",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/OSS_8cb25640426-PRDT-16050/child/coveredLevels/OSS_8cb25640426-PRDT-16050-PASS-16021/child/charges/OSS_8cb25640426-PRDT-16050-CHRG-14192/lov/EstimationMethodNameVA",
                    "name": "EstimationMethodNameVA",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/OSS_8cb25640426-PRDT-16050/child/coveredLevels/OSS_8cb25640426-PRDT-16050-PASS-16021/child/charges/OSS_8cb25640426-PRDT-16050-CHRG-14192/child/adjustments",
                    "name": "adjustments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/OSS_8cb25640426-PRDT-16050/child/coveredLevels/OSS_8cb25640426-PRDT-16050-PASS-16021/child/charges/OSS_8cb25640426-PRDT-16050-CHRG-14192/child/chargeTiers",
                    "name": "chargeTiers",
                    "kind": "collection"
                }
            ]
        },
 ...
}
「トップに戻る」