すべてのシミュレーション・クレジットを取得
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits
リクエスト
パス・パラメータ
- SimulationId(required): integer(int64)
計算シミュレーションの一意の識別子。
- TransactionId(required): integer(int64)
計算シミュレーションのトランザクションの一意の識別子。
問合せパラメータ
- 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 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- CreditIdFinder : 指定したシミュレーション・クレジット識別子を持つシミュレーション・クレジットを検索します。
ファインダ変数:- CreditId; integer;シミュレーション・クレジットの一意の識別子。
- PrimaryKey : 指定した主キーを持つシミュレーション・クレジットを検索します。
ファインダ変数:- CreditId; integer;シミュレーション・クレジットの一意の識別子。
- SimulationId; integer;計算シミュレーションの一意の識別子。
- CreditIdFinder : 指定したシミュレーション・クレジット識別子を持つシミュレーション・クレジットを検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AdjustmentComments; string;クレジットが調整された理由を説明するコメント。
- AdjustmentStatus; string; クレジットの調整状態を示すステータス。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_CREDIT_ADJ_STATUSの使用可能な参照コードをレビューします。
- CalculationConversionRate; number;ソース通貨から処理通貨に換算する換算レート。
- CalculationCurrencyCode; string;クレジット金額の処理通貨を示すコード。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
- ChangedCreditFlag; boolean。クレジットが新規か変更済かを示します。
- ClsfnRuleId; integer; クレジット・カテゴリをクレジットに割り当てるのに使用される分類ルールの一意の識別子。
- CollectionStatus; string; 収集エラーの理由を示す参照コード。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_CREDIT_COLL_STATUSの使用可能な参照コードをレビューします。
- CreatedBy; string; レコードを作成したユーザー。
- CreatedDuring; string; このクレジット・レコードが作成された日を示す参照コード。 有効な値のリストは、参照CN_TP_CREDIT_CREATED_DURINGに格納されます。 「設定およびメンテナンス」>「インセンティブ報酬参照の管理」タスクを使用して、使用可能な参照コードをレビューします。
- CreationDate; string;レコードが作成された日付。
- CreditAmount; number;処理通貨での貸方金額。
- CreditCategoryId; integer;分類プロセスを上書きする際に使用されるクレジット・カテゴリの一意の識別子。 クレジット・カテゴリは、報酬目的でクレジットを分類するために使用されるユーザー定義のビジネス・カテゴリです。
- CreditDate; string; クレジット受領者がクレジットを受け取る日付。 この日付は、トランザクションに対するクレジット・ルールの処理時にクレジット受領者を決定するために使用されます。
- CreditId; integer;クレジットの一意の識別子。
- CreditRuleId; integer;クレジットの作成に使用されるクレジット・ルールの一意の識別子。
- CreditType; string;直接、間接、要約など、クレジットの性質を示します。
- CreditedParticipantId; integer; クレジットを所有する関係者の一意の識別子。
- DirectParticipantId; integer;トランザクションのクローズに直接関与する関係者の一意の識別子。
- DirectRuleId; integer; このクレジットに対応する直接クレジットを作成するために使用されるクレジット・ルールの一意の識別子。
- ErrorCode; string; クレジットがエラー・ステータスになっている理由を示すコード。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプORA_CN_PROCESS_ERR_REASON LOOKUP_TYPEに使用可能な参照コードをレビューします。
- ErrorMeaning; string;クレジットがエラー・ステータスの理由を説明する表示ラベル。
- EventDate; string;インセンティブ・イベントが発生する日付。 イベント日は、参加者のホーム通貨が処理通貨として使用される場合に、有効な通貨換算レートを決定するために使用されます。
- HoldFlag; boolean;アプリケーションがトランザクションをさらに処理から除外する必要があるかどうかを示します。
- HomeConversionRate; number;処理通貨からホーム通貨に換算する換算レート。
- HomeCreditAmount; number;参加者のホーム通貨でのトランザクション金額。
- HomeCurrencyCode; string; 参加者のホーム通貨を示すコード。
- LastUpdateDate; string; レコードが最後に更新された日付。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- ObjectStatus; string;クレジットのステータス(クレジット、廃止、積上など)。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_CREDIT_OBJECT_STATUSの使用可能な参照コードをレビューします。
- OperatingConversionRate; number;ソース通貨から営業通貨に換算する換算レート。
- OperatingCreditAmount; number;ビジネス・ユニット営業通貨での貸方金額。
- OperatingCurrency; string; ビジネス・ユニットの機能通貨を示すコード。
- ProcessCode; string; トランザクションの分類の上書き、クレジットの保持、ロールアップしない、計算しないの値の組合せを示す5文字のコード。
- ReasonCode; string; クレジットを調整する理由を示すコード。 CN_TP_ADJUSTMENT_REASON参照は、設定およびメンテナンス、インセンティブ報酬参照の管理タスクから表示できます。
- RevenueType; string; 収益や非収益など、クレジットのタイプ。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_RS_REVENUE_TYPEの使用可能な参照コードをレビューします。
- RoleId; integer;クレジット受領者に割り当てられたロールの一意の識別子。
- RollupDate; string; トランザクションに対する積上ルールを処理する際に、積上クレジット受領者を決定するために使用される日付。
- RollupLevel; integer; ロールアップ階層のロールアップ・ルールのレベル。 この値は、積上クレジットの場合に適用できます。
- SimulationDeleteFlag; boolean;計算シミュレーション処理中にクレジットが削除されるかどうかを示します。
- SimulationId; integer; このシミュレーション・クレジットが属するシミュレーションの識別子。
- SourceBusinessUnitId; integer; ソース・トランザクション・ビジネス・ユニットの一意の識別子。
- SourceCreditAmount; number;トランザクションのソース通貨での貸方金額。
- SourceCreditId; integer;ソース・クレジットの一意の識別子またはロールアップ・クレジットが生成される集計済クレジット・レコード。
- SourceCurrencyCode; string; ソース・アプリケーションの通貨トランザクション金額の通貨を表す通貨コード。
- SourceTransactionAmount; number;トランザクションのソース通貨でのトランザクション金額。
- SplitPct; number;クレジット受領者が受け取ったトランザクション金額のパーセント。
- SummaryCreditId; integer; クレジットが関連付けられている要約クレジットの一意の識別子。
- TransactionAmount; number;処理通貨でのトランザクション金額。
- TransactionId; integer;トランザクションの一意の識別子。
- TransactionNumber; string;請求書番号やオーダー番号など、ユーザーが認識および検索できるトランザクションの代替キー識別子。
- TransactionQuantity; number;トランザクション明細アイテムの数量。
- TransactionType; string;オーダー、請求書、クレジット・メモなど、トランザクションのソースを示すトランザクションのタイプ。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_TRANSACTION_TYPEの使用可能な参照コードをレビューします。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : incentiveCompensationCalculationSimulations-Transactions-Credits
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : incentiveCompensationCalculationSimulations-Transactions-Credits-item-response
タイプ:
ソースを表示
object
-
AdjustmentComments: string
最大長:
1000
クレジットが調整された理由を説明するコメント。 -
AdjustmentStatus: string
最大長:
30
クレジットの調整状態を示すステータス。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_CREDIT_ADJ_STATUSの使用可能な参照コードをレビューします。 -
CalculationConversionRate: number
ソース通貨から処理通貨に換算する換算レート。
-
CalculationCurrencyCode: string
最大長:
15
貸方金額の処理通貨を示すコード。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。 -
ChangedCreditFlag: boolean
読取り専用:
true
最大長:1
クレジットが新規か変更済かを示します。 -
ClsfnRuleId: integer (int64)
クレジット・カテゴリをクレジットに割り当てるのに使用される分類ルールの一意の識別子です。
-
CollectionStatus: string
最大長:
30
収集エラーの事由を示す参照コード。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_CREDIT_COLL_STATUSの使用可能な参照コードをレビューします。 -
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザー。 -
CreatedDuring: string
読取り専用:
true
最大長:30
デフォルト値:SIMULATION
このクレジット・レコードが作成された日を示す参照コード。 有効な値のリストは、参照CN_TP_CREDIT_CREATED_DURINGに格納されます。 「設定およびメンテナンス」>「インセンティブ報酬参照の管理」タスクを使用して、使用可能な参照コードをレビューします。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
CreditAmount: number
処理通貨での貸方金額。
-
CreditCategoryId: integer (int64)
分類プロセスを上書きする際に使用されるクレジット・カテゴリの一意の識別子。 クレジット・カテゴリは、報酬目的でクレジットを分類するために使用されるユーザー定義のビジネス・カテゴリです。
-
CreditDate: string (date-time)
クレジット受領者がクレジットを受け取る日付。 この日付は、トランザクションに対するクレジット・ルールの処理時にクレジット受領者を決定するために使用されます。
-
CreditedParticipantId: integer (int64)
クレジットを所有する関係者の一意の識別子。
-
CreditId: integer (int64)
読取り専用:
true
クレジットの一意の識別子。 -
CreditRuleId: integer (int64)
クレジットの作成に使用されるクレジット・ルールの一意の識別子。
-
CreditType: string
最大長:
30
デフォルト値:DIRECT
直接、間接、要約など、クレジットの性質を示します。 -
DirectParticipantId: integer (int64)
トランザクションのクローズに直接関与する関係者の一意の識別子。
-
DirectRuleId: integer (int64)
このクレジットに対応する直接クレジットの作成に使用されるクレジット・ルールの一意の識別子。
-
ErrorCode: string
読取り専用:
true
最大長:30
貸方がエラー・ステータスである事由を示すコード。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプORA_CN_PROCESS_ERR_REASON LOOKUP_TYPEに使用可能な参照コードをレビューします。 -
ErrorMeaning: string
読取り専用:
true
最大長:80
クレジットがエラー・ステータスである理由を説明する表示ラベル。 -
EventDate: string (date-time)
読取り専用:
true
インセンティブ・イベントが発生する日付。 イベント日は、参加者のホーム通貨が処理通貨として使用される場合に、有効な通貨換算レートを決定するために使用されます。 -
HoldFlag: boolean
最大長:
1
アプリケーションでトランザクションをさらに処理から除外する必要があるかどうかを示します。 -
HomeConversionRate: number
処理通貨からホーム通貨に換算する換算レート。
-
HomeCreditAmount: number
参加者のホーム通貨でのトランザクション金額。
-
HomeCurrencyCode: string
最大長:
15
参加者のホーム通貨を示すコード。 -
LastUpdateDate: string (date-time)
読取り専用:
true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectStatus: string
最大長:
30
クレジットのステータス(クレジット、廃止、積上など)。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_CREDIT_OBJECT_STATUSの使用可能な参照コードをレビューします。 -
OperatingConversionRate: number
ソース通貨から営業通貨に換算する換算レート。
-
OperatingCreditAmount: number
ビジネス・ユニット営業通貨での貸方金額。
-
OperatingCurrency: string
タイトル:
Operating Currency
読取り専用:true
最大長:10
ビジネス・ユニットの機能通貨を示すコード。 -
ProcessCode: string
読取り専用:
true
最大長:30
デフォルト値:CNNEC
トランザクションの分類の上書き、クレジットの保持、積上しないおよび計算しないの値の組合せを示す5文字のコード。 -
ReasonCode: string
読取り専用:
true
最大長:30
貸方修正の事由を示すコード。 CN_TP_ADJUSTMENT_REASON参照は、設定およびメンテナンス、インセンティブ報酬参照の管理タスクから表示できます。 -
RevenueType: string
最大長:
30
収益や非収益など、クレジットのタイプ。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_RS_REVENUE_TYPEの使用可能な参照コードをレビューします。 -
RoleId: integer (int64)
クレジット受領者に割り当てられたロールの一意の識別子。
-
RollupDate: string (date-time)
トランザクションに対する積上ルールの処理時に積上クレジット受領者を決定するために使用する日付です。
-
RollupLevel: integer (int64)
積上階層の積上ルールのレベルです。 この値は、積上クレジットの場合に適用できます。
-
SimulationDeleteFlag: boolean
最大長:
1
デフォルト値:false
計算シミュレーション処理中にクレジットが削除されるかどうかを示します。 -
SimulationId: integer (int64)
このシミュレーション・クレジットが属するシミュレーションの識別子。
-
SourceBusinessUnitId: integer (int64)
ソース・トランザクション・ビジネス・ユニットの一意の識別子。
-
SourceCreditAmount: number
トランザクションのソース通貨での貸方金額。
-
SourceCreditId: integer (int64)
積上クレジットが生成されるソース・クレジットまたは集計済クレジット・レコードの一意の識別子。
-
SourceCurrencyCode: string
最大長:
15
ソース・アプリケーションの通貨トランザクション金額の通貨を表す通貨コード。 -
SourceTransactionAmount: number
トランザクションのソース通貨でのトランザクション金額。
-
SplitPct: number
デフォルト値:
100
クレジット受領者が受領したトランザクション金額のパーセント。 -
SummaryCreditId: integer (int64)
クレジットが関連付けられている要約クレジットの一意の識別子。
-
TransactionAmount: number
処理通貨でのトランザクション金額。
-
TransactionId: integer (int64)
読取り専用:
true
トランザクションの一意の識別子。 -
TransactionNumber: string
読取り専用:
true
最大長:30
請求書番号やオーダー番号など、ユーザーが認識して検索できるトランザクションの代替キー識別子。 -
TransactionQuantity: number
トランザクション明細アイテムの数量。
-
TransactionType: string
読取り専用:
true
最大長:30
オーダー、請求書またはクレジット・メモなど、トランザクションのソースを示すトランザクションのタイプ。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_TRANSACTION_TYPEの使用可能な参照コードをレビューします。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。