機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 請求修正

すべての請求修正を取得

get

/crmRestApi/resources/11.13.18.05/billingAdjustments

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • PrimaryKey : 指定された主キーを持つ請求修正を検索します。
      ファインダ変数:
      • BillAdjustmentRequestsId; integer; 請求調整の一意の識別子。
    • RowFinder : 指定された代替主キーを持つ請求修正を検索します。
      ファインダ変数:
      • BillAdjustmentRequestsNumber; string; 請求調整の代替の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AdditionalComments; string; この調整に対する追加の承認または拒否コメント。
    • AdjustmentReason; string;請求調整の理由。
    • AdjustmentType; string; 請求、アイテム、イベント・レベルの調整など、調整リクエストのタイプ。
    • AdjustmentUnitOfMeasure; string;請求調整の単位。
    • AmountDue; number;実際の支払金額。
    • ApproveAmount; number;調整が承認される金額。
    • ApprovePercent; number;調整が承認された金額の割合。
    • ApprovedByPartyId; integer; 調整リクエストを承認したユーザーの一意の識別子。
    • ApprovedByPartyName; string;調整リクエストを承認したユーザーの名前。
    • ApprovedByPartyNumber; string;調整リクエストを承認したユーザーの公開一意識別子。
    • AssigneePersonName; string;割当て先の名前。
    • AssigneeResourceId; integer; サービス・リクエストに割り当てられたリソースの一意の識別子。
    • AssigneeResourceNumber; string;割当て先の公開一意識別子。
    • BillAdjustmentRequestsId; integer;請求修正リクエストの一意の識別子。
    • BillAdjustmentRequestsNumber; string; 請求修正リクエスト・レコードの一意の識別子。
    • CategoryId; integer; 請求調整に関連付けられたサービス・リクエスト・カテゴリ。
    • CategoryName; string; 請求調整に関連付けられたサービス・リクエスト・カテゴリ名。
    • CategoryShortName; string; サービス・リクエスト・カテゴリの短縮名。
    • コメント、文字列。この調整に関するコメント。
    • CorpCurrencyCode; string; 請求修正リクエストの企業通貨コード。
    • CreatedBy; string; 行を作成したユーザー。
    • CreationDate; string;行の作成日時。
    • CurcyConvRateType; string;通貨換算のレート・タイプ。
    • CurrencyCode; string; 請求修正リクエストの通貨コード。
    • ExternalAdjustmentId; string;外部請求システムからの調整ID。
    • ExternalAdjustmentNumber; string;外部請求システムからの調整の公開一意識別子。
    • ExternalBalanceGroupId; string;外部請求システムからの非通貨の残高グループの一意の識別子。
    • ExternalBalanceGroupNumber; string;外部請求システムからの非通貨の残高グループの公開一意識別子。
    • ExternalBillId; string;外部請求システムからの請求ID。
    • ExternalBillItemId; string;外部請求システムからの請求アイテムID。
    • ExternalBillItemNumber; string; 外部請求システムからの請求アイテムの公開一意識別子。
    • ExternalBillNumber; string;外部請求システムからの請求の公開一意識別子。
    • ExternalBillUnitId; string; 調整リクエストの請求単位の一意の識別子。
    • ExternalBillUnitNumber; string; 調整リクエストの請求単位の公開一意識別子。
    • ExternalServiceId; string;外部請求システムからのサービスID。
    • ExternalServiceNumber; string;外部請求システムからのサービスの公開一意識別子。
    • ExternalServiceType; string;非通貨調整リクエストの調整済リソースのタイプ。
    • LastUpdateDate; string;行に対して最後に行われた更新の日時。
    • LastUpdateLogin; string; 行を最後に更新したユーザーに関連付けられたセッション・ログイン。
    • LastUpdatedBy; string; 行を最後に更新したユーザー。
    • NonCurrencyAdjustmentFlag; boolean。調整リクエストが通貨値用か非通貨用かを示します。
    • NonCurrencyAdjustmentType; string; 非通貨調整の請求単位やイベント・レベルなど、調整リクエストのタイプ。
    • NonCurrencyUsageAmount; number;調整前の実際の非通貨使用。
    • PartyName; string; サービス・リクエストに割り当てられたリソースの名前。
    • PrimaryContactPartyId; integer; 調整リクエストを最初にレポートしたユーザーの一意の識別子。
    • PrimaryContactPartyName; string; 調整リクエストのプライマリ担当者の名前。
    • PrimaryContactPartyNumber; string;関連付けられたプライマリ担当者の公開一意識別子。
    • QueueId; integer; サービス・リクエストに割り当てられたキューの一意の識別子。
    • QueueName; string; サービス・リクエスト・キューを示します。
    • QueueNumber; string;キュー識別子の代替キー。
    • RejectReason; string; 調整を拒否する理由。
    • RejectedByPartyId; integer; 調整リクエストを拒否したユーザーの一意の識別子。
    • RejectedByPartyName; string;調整リクエストを拒否したユーザーの名前。
    • RejectedByPartyNumber; string;調整リクエストを拒否したユーザーの公開一意識別子。
    • ReportedByPartyName; string; 調整リクエストを報告したユーザー。
    • RequestAmount; number;調整が要求される金額。
    • RequestPercent; number;調整が要求される金額の割合。
    • SrId; integer; サービス・リクエスト・レコードの一意の識別子。
    • SrNumber; string; 請求調整に関連付けられているサービス・リクエスト参照番号。
    • StatusCode; string;調整リクエストのステータス。
    • SubmittedByPartyId; integer; 調整リクエストを発行したユーザーの一意のID。
    • SubmittedByPartyName; string; 調整リクエストを発行したユーザー。
    • SubmittedByPartyNumber; string;調整リクエストを発行したユーザーの公開一意識別子。
    • TaxTreatment; string; 税金が請求調整に含まれるかどうかを示します。
    • タイトル、文字列、サービス・リクエストのタイトル。
    • ValidFrom; string;非通貨調整の有効性が開始する日付。
    • ValidTo; string; 非通貨調整の有効期間が終了する日付。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

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