機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. サブスクリプション製品
  4. 請求明細

すべての請求明細の取得

get

/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines

リクエスト

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

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

    • BillLinePuid : 指定された請求明細PUIDを持つサブスクリプション請求明細を検索します。
      ファインダ変数:
      • BillLinePuid; string; 請求明細の公開一意識別子。
    • PrimaryKey : 指定した請求明細IDを持つサブスクリプション請求明細を検索します。
      ファインダ変数:
      • BillLineId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • 金額、番号。請求が生成される金額。
    • BillLineId; integer;請求明細の一意の識別子。
    • BillLinePuid; string; 請求明細の公開一意識別子。
    • BillingPeriod; number;請求が生成される期間。
    • ChargeDefinition; string; 料金の目的を示す定義。
    • ChargeId; integer; 料金の一意の識別子。
    • ChargeName; string; 請求明細に関連付けられた手数料の名前。
    • ChargePeriod; number。課金された使用期間。
    • ChargePeriodFactor; number;請求明細に関連付けられた変更期間係数。
    • ChargePuid; string; 料金の公開一意識別子。
    • CoveredLevelId; integer;対象レベルの一意の識別子。
    • CreatedBy; string; 請求明細を作成したユーザー。
    • CreationDate; string; 請求明細が作成された日付。
    • CreditMemoReasonCode; string;クレジット・メモ事由コードのコード。
    • CustomerTrxTypeSequenceId;整数;顧客取引タイプ連番ID
    • DateBilledFrom; string;請求が生成された日付。
    • DateBilledTo; string; 請求が生成されるまでの日付。
    • DateToInterface; string; 請求明細のインタフェースとなる日付。
    • InterfacedFlag; boolean;請求明細がインタフェースされているかどうかを示します。
    • InvoiceBillLineId; integer;請求書請求明細の一意の識別子。
    • InvoiceDate; string;請求書が提起された日付。
    • InvoiceText; string; 請求明細請求書のテキスト。
    • LastUpdateDate; string; 請求明細が最後に更新された日付。
    • LastUpdateLogin; string; 請求行を最後に更新したユーザーのログイン詳細。
    • LastUpdatedBy; string; 請求明細を最後に更新したユーザー。
    • ListPrice; number;請求明細に関連付けられた製品の定価。
    • MilestoneEventId; integer;請求明細に関連付けられたマイルストン・イベントのID。
    • PricedQuantity; number;請求明細が請求された数量。
    • PricingError; string;価格設定中のエラー(ある場合)。
    • RecurringFlag; boolean。行が繰り返されるかどうかを示します。
    • RevenueLineId; integer;収益明細の一意の識別子。
    • SentDate; string;請求書情報が売掛管理に送信される日付。
    • SubscriptionId; integer; サブスクリプションの一意の識別子。
    • SubscriptionProductId; integer;サブスクリプション製品の一意の識別子。
    • TransactionAmount; number;トランザクションが発生した金額。
    • TransactionClass; string;トランザクションのクラス。
    • TransactionClassMeaning; string; トランザクション・クラス参照の意味。
    • TransactionDate; string;トランザクションが発生した日付。
    • TransactionNumber; string;トランザクションの番号。
    • TransactionTax; number;トランザクションに課せられた税金。
    • TruedUpYn; string; 請求明細に調整期間があるかどうかを示します。
    • TrxId; integer; ARトランザクションID。
    • TrxLineId; integer; ARトランザクション明細ID。
    • UsageAcquiredFlag; boolean。使用状況が取得されたかどうかを示します。
    • UsageCaptureDate; string;使用状況が取得された日付。
    • UsageChargeType; string;使用料金のタイプ。
    • UsageChargeTypeName; string;使用料金タイプの名前。
    • UsageFlag; boolean;行が使用行かどうかを示します。
    • UsagePricedFlag; boolean。使用明細が価格設定されているかどうかを示します。
    • UsageQuantity; number;使用量。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : subscriptionProducts-billLines
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : subscriptionProducts-billLines-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 請求修正
タイプ: array
タイトル: Bill Adjustments
請求修正リソースは、調整名、調整値、調整タイプ、事由および有効性などのサブスクリプション請求修正詳細を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : subscriptionProducts-billLines-billAdjustments-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/300100182015426/child/billLines

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
  "items": [
    {
      "BillLineId": 300100192686411,
      "BillLinePuid": "GP-5678-PRDT-1-BILL-309",
      "SubscriptionId": 300100181994494,
      "SubscriptionProductId": 300100192686405,
      "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": "SALES_ADMIN",
      "CreationDate": "2019-08-20T07:24:12+00:00",
      "LastUpdatedBy": "SALES_ADMIN",
      "LastUpdateDate": "2019-08-20T07:24:12.100+00:00",
      "LastUpdateLogin": "9062D47DF31EDAF6E0533EFDF40A2696",
      "TransactionClassMeaning": "Invoice",
      "InvoiceDate": null,
      "NewCreditMemoPUID": null,
      "CreditMemoAmount": null,
      "CreditMemoFlag": null,
      "CreditMemoReason": null,
      "links": 
	...
},
...
「トップに戻る」