機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 定期購買
  4. 製品
  5. 請求明細

サブスクリプション請求明細の更新

patch

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}

リクエスト

パス・パラメータ
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
リクエスト本文 - application/json ()
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ: object
ソースを表示
ネストされたスキーマ : 請求修正
タイプ: array
タイトル: Bill Adjustments
請求修正リソースは、サブスクリプション請求修正詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : subscriptions-products-billLines-billAdjustments-item-patch-request
タイプ: object
ソースを表示
トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : subscriptions-products-billLines-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 請求修正
タイプ: array
タイトル: Bill Adjustments
請求修正リソースは、サブスクリプション請求修正詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : subscriptions-products-billLines-billAdjustments-item-response
タイプ: object
ソースを表示
リンク
billAdjustments
パラメータ:
  • BillLinePuid: $request.path.BillLinePuid
  • SubscriptionNumber: $request.path.SubscriptionNumber
  • SubscriptionProductPuid: $request.path.SubscriptionProductPuid
請求修正
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行して、サブスクリプション請求明細を更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json  https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/GP5678/child/products/GP-5678-PRDT-1/child/billLines/GP-5678-PRDT-1-BILL-309

リクエスト本文の例

次に、JSON形式のリクエスト本文の内容を示します。

{          
"Amount": 2600 
}

レスポンス本文の例

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

{     
"BillLineId": 100100108482104,     
"BillLinePuid": "GP-5678-PRDT-1-BILL-309",     
"SubscriptionId": 300100177254423,     
"SubscriptionProductId": 300100177254429,     
"CoveredLevelId": null,     
"ChargeId": 300100177231506,     
"ChargePuid": null,     
"BillingPeriod": 0,     
"DateToInterface": "2019-06-04",     
"DateBilledFrom": "2019-01-01",     
"DateBilledTo": "2019-12-25",     
"Amount": 2600,     
"RecurringFlag": false,     
"UsageFlag": false,     
"UsageAcquiredFlag": null,     
"UsagePricedFlag": true,     
"InterfacedFlag": false,     
"TransactionClass": "INV",     
"TransactionDate": null,     
"TransactionNumber": null,     
"TransactionTax": null,     
"TransactionAmount": null,    
"InvoiceText": "[$Item Name]: Activation Fee 2019-01-01-2019-12-25",     
"InvoiceBillLineId": null,     
"UsageCaptureDate": null,     
"UsageQuantity": null,     
"ChargePeriod": 0,     
"PricingError": null,     
"ListPrice": 3000,     
"RevenueLineId": null,     
"CreatedBy": "CONMGR",     
"CreationDate": "2019-06-04T13:55:16+00:00",     
"LastUpdatedBy": "CONMGR",     
"LastUpdateDate": "2019-06-04T16:47:10.018+00:00",     
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",    
"TransactionClassMeaning": "Invoice",     
"InvoiceDate": "2019-06-04",     
"NewCreditMemoPUID": null,     
"CreditMemoAmount": null,     
"CreditMemoFlag": null,     
"CreditMemoReason": null,     
... 
}

使用数量のサブスクリプション製品請求明細の更新

次の例は、使用数量のサブスクリプション製品請求明細を更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json  https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/CDRM_700 1/child/products/CDRM_7001-PRDT-7002/child/billLines/CDRM_7001-PRDT-7002-BILL-6072

リクエスト本文の例

次に、JSON形式のリクエスト本文の内容を示します。

{      
"UsageQuantity": 150 
}

レスポンス本文の例

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

{    
"BillLineId": 100100125204770,    
"BillLinePuid": "CDRM_7001-PRDT-7002-BILL-6072",    
"SubscriptionId": 300100184551026,   
"SubscriptionProductId": 300100184551032,    
"CoveredLevelId": null,    
"ChargeId": 300100184551035,    
"ChargePuid": null,    
"BillingPeriod": 1,    
"DateToInterface": "2020-02-01",    
"DateBilledFrom": "2020-01-30",    
"DateBilledTo": "2020-01-31",    
"Amount": 0,    
"RecurringFlag": true,    
"UsageFlag": true,    
"UsageAcquiredFlag": null,    
"UsagePricedFlag": false,    
"InterfacedFlag": false,    
"TransactionClass": "INV",    
"TransactionDate": null,    
"TransactionNumber": null,    
"TransactionTax": null,    
"TransactionAmount": null,    
"InvoiceText": "[$Item Name]: Data_Storage_Fee 2020-01-30-2020-01-31",    
"InvoiceBillLineId": null,    
"ChargeDefinition": "USAGE_OSS_DF", 
"UsageCaptureDate": null,    
"UsageQuantity": 150,    
"ChargePeriod": 1,    
"PricingError": null,    
"ListPrice": 0,    
"RevenueLineId": null,    
"CreatedBy": "CONMGR",    
"CreationDate": "2020-01-30T15:55:19+00:00",    
"LastUpdatedBy": "CONMGR",    
"LastUpdateDate": "2020-01-30T16:52:13+00:00",    
"LastUpdateLogin": "9CD631AD91BF8018E05322EAF40AD740",    
"TransactionClassMeaning": "Invoice",    
"ChargeName": "Data_Storage_Fee",    
"TrxId": null,    
"TrxLineId": null,    
"InvoiceDate": "2020-02-01",    
"NewCreditMemoPUID": null,    
"CreditMemoAmount": null,    
"CreditMemoFlag": null,    
"CreditMemoReason": null,    
"CustomerTrxTypeSequenceId": 806,    
"links": [      
...   
         ] 
}

手数料が定義されていない場合の使用計算の更新

使用量を更新したいが、価格設定がSales Cloudで定義されていないインスタンスがあります。 このシナリオでは、使用料金を外部システムからインポートする必要があります。

そのためには、次を実行する必要があります:

  1. エンドポイントURLを設定します。
    1. サブスクリプションのサード・パーティ・アプリケーションの登録タスクで、追加(+)をクリックして新しい行を追加します。
    2. 新しい行で、次のようにします:
      • アプリケーション・タイプとして価格設定を選択します。
      • アプリケーション名にCPQと入力します。
      • 統合タイプとしてRESTを選択します。
      • 「エンドポイントURL」フィールドにエンドポイントURLを入力します。 エンドポイントURLは、RESTサービスを指すURLです。
      • ユーザー名を入力します。
      • パスワードを入力します。
    3. 「保存」をクリックします。
  2. REST APIを使用してサードパーティ・システムから使用計算値をフェッチします。
  3. サブスクリプション請求明細の更新メソッドを使用して、サードパーティ・システムから受信した計算値を使用して使用計算を更新します。

サブスクリプション請求明細の取得メソッドを使用して、UnitListPriceが更新されていることを確認する必要があります。 値が更新されたことを確認した後、Sales Cloudで更新される値に対して、サブスクリプションの価格設定情報のフェッチおよび請求スケジュールの生成ESSジョブを実行する必要があります。

「トップに戻る」