Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

すべてのクレジットを取得

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/Credits

リクエスト

パス・パラメータ

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>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- PrimaryKey : 指定したレコード識別子を持つトランザクションの貸方を検索します。
  ファインダ変数:
  - CreditId; integer;クレジットの一意の識別子。
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の使用可能な参照コードをレビューします。
- BusinessUnitId; integer;ビジネス・ユニットの一意の識別子。
- BusinessUnitName; string;ビジネス・ユニットの名前。
- 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; ロールアップ階層のロールアップ・ルールのレベル。この値は、積上クレジットの場合に適用できます。
- 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のデフォルト・バージョンを選択します。

ルート・スキーマ : incentiveCompensationTransactions-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"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationTransactions-Credits-item-response"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object incentiveCompensationTransactions-Credits-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationTransactions-Credits-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : incentiveCompensationTransactions-Credits-item-response

タイプ: object

ソースを表示

AdjustmentComments: string

タイトル: Comment

最大長: 1000

クレジットに対する修正のコメントです。
AdjustmentStatus: string

タイトル: Adjustment Status

読取り専用: true

最大長: 30

クレジットの調整状態を示す参照コード。設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_CREDIT_ADJ_STATUSの使用可能な参照コードをレビューします。
BusinessUnitId: integer (int64)

タイトル: Business Unit

読取り専用: true

ビジネス・ユニットの一意の識別子。
BusinessUnitName: string

タイトル: Business Unit

読取り専用: true

最大長: 240

ビジネス・ユニットの名前。
CalculationConversionRate: number

タイトル: Calculation Currency Conversion Rate

読取り専用: true

ソース通貨から処理通貨に換算する換算レート。
CalculationCurrencyCode: string

タイトル: Currency

読取り専用: true

最大長: 15

貸方金額の処理通貨を示すコード。処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
ChangedCreditFlag: boolean

タイトル: Change Indicator

読取り専用: true

最大長: 1

クレジットが新規か変更済かを示します。
ClsfnRuleId: integer (int64)

タイトル: Classification Rule

読取り専用: true

クレジット・カテゴリをクレジットに割り当てるのに使用される分類ルールの一意の識別子です。
CollectionStatus: string

タイトル: Collection Status

読取り専用: true

最大長: 30

収集エラーの事由を示す参照コード。設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_CREDIT_COLL_STATUSの使用可能な参照コードをレビューします。
CreatedBy: string

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreatedDuring: string

タイトル: Credit Process Type

読取り専用: true

最大長: 30

このクレジット・レコードが作成された日を示す参照コード。「設定およびメンテナンス」、「インセンティブ報酬参照の管理」タスクを使用して、使用可能な参照コードCN_TP_CREDIT_CREATED_DURINGをレビューします。
CreationDate: string (date-time)

読取り専用: true

レコードが作成された日付。
CreditAmount: number

タイトル: Credit Amount

処理通貨での貸方金額。
CreditCategoryId: integer (int64)

タイトル: Name

分類プロセスを上書きするときに使用するクレジット・カテゴリの一意のレコード識別子。クレジット・カテゴリは、報酬目的でクレジットを分類するために使用されるユーザー定義のビジネス・カテゴリです。
CreditDate: 文字列(日付)

タイトル: Credit Date

クレジット受領者がクレジットを受け取る日付。この日付は、トランザクションに対するクレジット・ルールの処理時にクレジット受領者を決定するために使用されます。
CreditedParticipantId: integer (int64)

タイトル: Credit Receiver

クレジットを所有する関係者の一意の識別子。
CreditId: integer (int64)

タイトル: Credit ID

読取り専用: true

クレジットの一意の識別子。
CreditRuleId: integer (int64)

タイトル: Credit Rule

読取り専用: true

クレジットの作成に使用されるクレジット・ルールの一意のレコード識別子。
CreditType: string

タイトル: Credit Type

読取り専用: true

最大長: 30

直接、間接、要約など、クレジットの性質を示します。
DirectParticipantId: integer (int64)

タイトル: Direct Participant

読取り専用: true

クローズ・トランザクションに直接関与する関係者の一意の識別子。
DirectRuleId: integer (int64)

読取り専用: true

このクレジットに対応する直接クレジットの作成に使用されるクレジット・ルールの一意の識別子。
ErrorCode: string

読取り専用: true

最大長: 30

貸方がエラー・ステータスの場合の事由コード。設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプORA_CN_PROCESS_ERR_REASON LOOKUP_TYPEに使用可能な参照コードをレビューします。
ErrorMeaning: string

読取り専用: true

最大長: 80

与信がエラー・ステータスである理由を説明する事由。
EventDate: 文字列(日付)

タイトル: Event Date

読取り専用: true

インセンティブ・イベント日。イベント日は、参加者のホーム通貨が処理通貨として使用される場合に、有効な通貨換算レートを決定するために使用されます。
HoldFlag: boolean

タイトル: Hold

最大長: 1

アプリケーションでトランザクションをさらに処理から除外する必要があるかどうかを示します。
HomeConversionRate: number

タイトル: Home Currency Conversion Rate

読取り専用: true

処理通貨からホーム通貨に換算する換算レート。
HomeCreditAmount: number

タイトル: Home Credit Amount

読取り専用: true

参加者のホーム通貨でのトランザクション金額。
HomeCurrencyCode: string

タイトル: Home Currency

読取り専用: true

最大長: 15

参加者のホーム通貨を示すコード。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectStatus: string

タイトル: Process Status

最大長: 30

クレジット、廃止、積上など、クレジットの現在の状態を示す参照コード。設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_CREDIT_OBJECT_STATUSの使用可能な参照コードをレビューします。
OperatingConversionRate: number

タイトル: Operating Currency Conversion Rate

読取り専用: true

ソース通貨から営業通貨に換算する換算レート。
OperatingCreditAmount: number

タイトル: Operating Credit Amount

読取り専用: true

ビジネス・ユニット営業通貨での貸方金額。
OperatingCurrency: string

タイトル: Operating Currency

読取り専用: true

最大長: 10

ビジネス・ユニットの機能通貨を示すコード。
ProcessCode: string

タイトル: Override

最大長: 30

トランザクションに関連付けられたプロセス・コードは、トランザクションの分類上書き、クレジットの保持、ロールアップしない、および計算しないの値の組合せを決定する5文字のコードです。
ReasonCode: string

タイトル: Reason

読取り専用: true

最大長: 30

貸方修正の事由を示す参照コード。 CN_TP_ADJUSTMENT_REASON参照は、設定およびメンテナンス、インセンティブ報酬参照の管理タスクから表示できます。
RevenueType: string

タイトル: Revenue Type

最大長: 30

実績を収益または非収益として分類する参照コード。設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_RS_REVENUE_TYPEの使用可能な参照コードをレビューします。
RoleId: integer (int64)

タイトル: Role

クレジット受領者に割り当てられたロールの一意の識別子。
RollupDate: 文字列(日付)

タイトル: Rollup Date

読取り専用: true

トランザクションに対する積上ルールの処理時に積上クレジット受領者を決定するために使用する日付です。
RollupLevel: integer (int64)

タイトル: Rollup Level

読取り専用: true

積上階層の積上ルールのレベルです。この値は、積上クレジットの場合に適用できます。
SourceBusinessUnitId: integer (int64)

タイトル: Source BU

読取り専用: true

ソース・トランザクション・ビジネス・ユニットの一意の識別子。
SourceCreditAmount: number

タイトル: Source Credit Amount

読取り専用: true

トランザクションのソース通貨での貸方金額。
SourceCreditId: integer (int64)

タイトル: Source Credit ID

積上クレジットが生成されるソース・クレジットまたは集計済クレジット・レコードの一意の識別子。
SourceCurrencyCode: string

タイトル: Source Currency

読取り専用: true

最大長: 15

ソース・アプリケーションの通貨トランザクション金額の通貨を表す通貨コード。
SourceTransactionAmount: number

タイトル: Source Transaction Amount

読取り専用: true

トランザクションのソース通貨でのトランザクション金額。
SplitPct: number

タイトル: Split Percent

クレジット受領者が受領したトランザクション金額のパーセント。
SummaryCreditId: integer (int64)

読取り専用: true

クレジットが関連付けられている要約クレジットの一意の識別子。
TransactionAmount: number

タイトル: Transaction Amount

読取り専用: true

処理通貨でのトランザクション金額。
TransactionId: integer (int64)

タイトル: Transaction ID

読取り専用: true

トランザクションの一意の識別子。
TransactionNumber: string

タイトル: Transaction Number

読取り専用: true

最大長: 30

請求書番号やオーダー番号など、ユーザーが認識して検索できるトランザクション識別子。
TransactionQuantity: number

タイトル: Quantity

読取り専用: true

トランザクション明細アイテムの数量。
TransactionType: string

タイトル: Transaction Type

読取り専用: true

最大長: 30

オーダー、請求書またはクレジット・メモなど、トランザクションのソースを示すトランザクションのタイプ。設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_TRANSACTION_TYPEの使用可能な参照コードをレビューします。

{
    "type":"object",
    "properties":{
        "SourceCurrencyCode":{
            "title":"Source Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code that represents the currency of the monetary transaction amount in the source application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventDate":{
            "title":"Event Date",
            "type":"string",
            "description":"The incentive event date. The event date is used to determine the effective currency conversion rate when the participant's home currency is used as the processing currency.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitPct":{
            "title":"Split Percent",
            "type":"number",
            "description":"The percent of the transaction amount that the credit receiver received.",
            "nullable":true,
            "x-queryable":true
        },
        "RollupDate":{
            "title":"Rollup Date",
            "type":"string",
            "description":"The date used to determine the roll up credit receivers when processing the roll up rules against transactions.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceBusinessUnitId":{
            "title":"Source BU",
            "type":"integer",
            "description":"The unique identifier of the source transaction business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirectRuleId":{
            "type":"integer",
            "description":"The unique identifier of the credit rule used to create the direct credit that corresponds to this credit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditAmount":{
            "title":"Credit Amount",
            "type":"number",
            "description":"The credit amount in processing currency.",
            "nullable":true,
            "x-queryable":true
        },
        "OperatingCurrency":{
            "title":"Operating Currency",
            "maxLength":10,
            "type":"string",
            "description":"The code indicating the functional currency of the business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity for the transaction line item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditId":{
            "title":"Credit ID",
            "type":"integer",
            "description":"The unique identifier of the credit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceTransactionAmount":{
            "title":"Source Transaction Amount",
            "type":"number",
            "description":"The transaction amount in source currency of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CollectionStatus":{
            "title":"Collection Status",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the reason for a collection error. Review the available lookup codes for the lookup type CN_TP_CREDIT_COLL_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditCategoryId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique record identifier for the credit category to use when overriding the classification process. The credit category is a user-defined business category used to classify a credit for compensation purposes.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessCode":{
            "title":"Override",
            "maxLength":30,
            "type":"string",
            "description":"The process code associated to the transaction and is a five letter code that determines the combination of Override Classification, Preserve Credits, Do Not Roll Up, and Do Not Calculate values for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ReasonCode":{
            "title":"Reason",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the reason for adjusting a credit. You can view the CN_TP_ADJUSTMENT_REASON lookup from the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCreditAmount":{
            "title":"Source Credit Amount",
            "type":"number",
            "description":"The credit amount in source currency of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"The unique identifier of the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalculationCurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the processing currency for the credit amount. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentStatus":{
            "title":"Adjustment Status",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the adjustment state of the credit. Review the available lookup codes for the lookup type CN_TP_CREDIT_ADJ_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculationConversionRate":{
            "title":"Calculation Currency Conversion Rate",
            "type":"number",
            "description":"The exchange rate to convert from source currency to processing currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SummaryCreditId":{
            "type":"integer",
            "description":"The unique identifier of the summary credit to which the credit is associated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueType":{
            "title":"Revenue Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that categorizes the credit as revenue or non-revenue. Review the available lookup codes for the lookup type CN_RS_REVENUE_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditDate":{
            "title":"Credit Date",
            "type":"string",
            "description":"The date the credit receiver should receive credit. The date is used to determine the credit receivers when processing the credit rules against transactions.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RollupLevel":{
            "title":"Rollup Level",
            "type":"integer",
            "description":"The level of the rollup rule in the rollup hierarchy. This value is applicable in case of rollup credits.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the transaction indicating the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionNumber":{
            "title":"Transaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The transaction identifier that users can recognize and  search with, for example, an invoice number or order number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HomeCurrencyCode":{
            "title":"Home Currency",
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the participant's home currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedDuring":{
            "title":"Credit Process Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code indicating when this credit record was created. Review the available lookup codes \nCN_TP_CREDIT_CREATED_DURING using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangedCreditFlag":{
            "title":"Change Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the credit is new or modified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperatingConversionRate":{
            "title":"Operating Currency Conversion Rate",
            "type":"number",
            "description":"The exchange rate to convert from source currency to operating currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectStatus":{
            "title":"Process Status",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the current state of the credit such as Credited, Obsolete, or Rolled up. Review the available lookup codes for the lookup type CN_TP_CREDIT_OBJECT_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentComments":{
            "title":"Comment",
            "maxLength":1000,
            "type":"string",
            "description":"The commentary for an adjustment to the credit.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditType":{
            "title":"Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the nature of the credit such as Direct, Indirect or Summarized.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClsfnRuleId":{
            "title":"Classification Rule",
            "type":"integer",
            "description":"The unique identifier of the classification rule used to assign the credit category, to the credit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirectParticipantId":{
            "title":"Direct Participant",
            "type":"integer",
            "description":"The unique identifier of the participant who is directly involved in the closure transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceCreditId":{
            "title":"Source Credit ID",
            "type":"integer",
            "description":"The unique identifier of the source credit or the summarized credit record from which the rollup credit is generated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HomeConversionRate":{
            "title":"Home Currency Conversion Rate",
            "type":"number",
            "description":"The exchange rate to convert from processing currency to home currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Role",
            "type":"integer",
            "description":"The unique identifier of the role assigned to the credit receiver.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionAmount":{
            "title":"Transaction Amount",
            "type":"number",
            "description":"The transaction amount in processing currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HomeCreditAmount":{
            "title":"Home Credit Amount",
            "type":"number",
            "description":"The transaction amount in participant's home currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperatingCreditAmount":{
            "title":"Operating Credit Amount",
            "type":"number",
            "description":"The credit amount in business unit operating currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditedParticipantId":{
            "title":"Credit Receiver",
            "type":"integer",
            "description":"The unique identifier of the participant who owns the credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The reason explaining why the credit is in error status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditRuleId":{
            "title":"Credit Rule",
            "type":"integer",
            "description":"The unique record identifier of the credit rule used to create the credit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorCode":{
            "maxLength":30,
            "type":"string",
            "description":"The reason code if the credit is in error status. Review the available lookup codes for the lookup type ORA_CN_PROCESS_ERR_REASON LOOKUP_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldFlag":{
            "title":"Hold",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the application must exclude the transaction from processing further.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、インセンティブ報酬トランザクションのすべてのクレジットを取得する方法を示しています。

cURLコマンド

curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/10001/child/Credits

レスポンス本文の例

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

{
  "items": [
    {
      "CreditId": 300100186676412,
      "TransactionId": 10001,
      "TransactionNumber": "OTBI001",
      "TransactionType": "MANUAL",
      "CreditDate": "2009-01-01",
      "CreditedParticipantId": 999666333000595,
      "DirectParticipantId": 999666333000586,
      "CreditCategoryId": null,
      "CreditAmount": 10000,
      "SplitPct": 100,
      "CalculationCurrencyCode": "USD",
      "CalculationConversionRate": 1,
      "SourceTransactionAmount": 10000,
      "SourceCurrencyCode": "USD",
      "TransactionAmount": 10000,
      "SourceCreditAmount": 10000,
      "OperatingCreditAmount": 10000,
      "OperatingCurrency": "USD",
      "OperatingConversionRate": 1,
      "HomeCreditAmount": 10000,
      "HomeCurrencyCode": "USD",
      "HomeConversionRate": null,
      "ObjectStatus": "OBSOLETED",
      "ErrorCode": null,
      "ErrorMeaning": null,
      "AdjustmentStatus": "ADJUSTED",
      "CreditRuleId": null,
      "LastUpdatedBy": "OIC_MGR_OPERATIONS",
      "LastUpdateDate": "2020-06-16T11:45:43+00:00",
      "TransactionQuantity": null,
      "RevenueType": "REVENUE",
      "CreditType": "DIRECT",
      "CreatedDuring": "CREDITING",
      "CreatedBy": "OIC_MGR_OPERATIONS",
      "CreationDate": "2020-06-16T09:18:58+00:00",
      "BusinessUnitId": 204,
      "BusinessUnitName": "Vision Operations",
      "AdjustmentComments": "Manual update",
      "ReasonCode": "OTHER",
      "RollupLevel": null,
      "RoleId": null,
      "RollupDate": "2009-01-01",
      "EventDate": "2009-01-01",
      "CollectionStatus": null,
      "HoldFlag": null,
      "ProcessCode": "CCREC",
      "ChangedCreditFlag": null,
      "SourceBusinessUnitId": 204,
      "DirectRuleId": null,
      "SourceCreditId": null,
      "SummaryCreditId": null,
      "LastUpdateLogin": "A6BFDB90D59FD19BE0535498F20A7428",
      "ClsfnRuleId": null,
     
    },
    {
      "CreditId": 300100186684410,
      "TransactionId": 10001,
      "TransactionNumber": "OTBI001",
      "TransactionType": "MANUAL",
      "CreditDate": "2009-01-01",
      "CreditedParticipantId": 999666333000595,
      "DirectParticipantId": 999666333000586,
      "CreditCategoryId": null,
      "CreditAmount": 10000,
      "SplitPct": 100,
      "CalculationCurrencyCode": "USD",
      "CalculationConversionRate": 1,
      "SourceTransactionAmount": 10000,
      "SourceCurrencyCode": "USD",
      "TransactionAmount": 10000,
      "SourceCreditAmount": 10000,
      "OperatingCreditAmount": 10000,
      "OperatingCurrency": "USD",
      "OperatingConversionRate": 1,
      "HomeCreditAmount": 10000,
      "HomeCurrencyCode": "USD",
      "HomeConversionRate": null,
      "ObjectStatus": "CREDITED",
      "ErrorCode": null,
      "ErrorMeaning": null,
      "AdjustmentStatus": "ADJUSTED",
      "CreditRuleId": null,
      "LastUpdatedBy": "OIC_MGR_OPERATIONS",
      "LastUpdateDate": "2020-06-16T11:45:44.516+00:00",
      "TransactionQuantity": null,
      "RevenueType": "REVENUE",
      "CreditType": "DIRECT",
      "CreatedDuring": "CREDITING",
      "CreatedBy": "OIC_MGR_OPERATIONS",
      "CreationDate": "2020-06-16T11:45:43.238+00:00",
      "BusinessUnitId": 204,
      "BusinessUnitName": "Vision Operations",
      "AdjustmentComments": "Credit updated by REST WS",
      "ReasonCode": null,
      "RollupLevel": null,
      "RoleId": null,
      "RollupDate": "2009-01-01",
      "EventDate": "2009-01-01",
      "CollectionStatus": null,
      "HoldFlag": null,
      "ProcessCode": "CCREC",
      "ChangedCreditFlag": true,
      "SourceBusinessUnitId": 204,
      "DirectRuleId": null,
      "SourceCreditId": null,
      "SummaryCreditId": null,
      "LastUpdateLogin": "A6BFDB90D59FD19BE0535498F20A7428",
      "ClsfnRuleId": null,
    }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/10001/child/Credits",
      "name": "Credits",
      "kind": "collection"
    }
  ]
}

「トップに戻る」