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

シミュレーション・クレジットの作成

post

/fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits

リクエスト

パス・パラメータ

SimulationId(required): integer(int64)

計算シミュレーションの一意の識別子。
TransactionId(required): integer(int64)

計算シミュレーションのトランザクションの一意の識別子。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
Upsert-Mode:

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

AdjustmentComments: string

最大長: 1000

クレジットが調整された理由を説明するコメント。
AdjustmentStatus: string

最大長: 30

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

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

最大長: 15

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

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

最大長: 30

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

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

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

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

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

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

最大長: 30

デフォルト値: DIRECT

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

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

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

最大長: 1

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

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

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

最大長: 15

参加者のホーム通貨を示すコード。
ObjectStatus: string

最大長: 30

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

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

ビジネス・ユニット営業通貨での貸方金額。
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

処理通貨でのトランザクション金額。
TransactionQuantity: number

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

{
    "type":"object",
    "properties":{
        "CreditDate":{
            "type":"string",
            "description":"The date when the credit receiver should receive the credit. The date is used to determine the credit receivers when processing the credit rules against transactions.",
            "format":"date-time",
            "nullable":true
        },
        "SourceCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code that represents the currency of the monetary transaction amount in the source application.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RollupLevel":{
            "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,
            "x-hints":{
                "precision":18
            }
        },
        "SplitPct":{
            "type":"number",
            "description":"The percent of the transaction amount that the credit receiver received.",
            "nullable":true,
            "default":100
        },
        "HomeCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the participant's home currency.",
            "nullable":true
        },
        "RollupDate":{
            "type":"string",
            "description":"The date used to determine the roll up credit receivers when processing the roll up rules against transactions.",
            "format":"date-time",
            "nullable":true
        },
        "SourceBusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of the source transaction business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CreditAmount":{
            "type":"number",
            "description":"The credit amount in processing currency.",
            "nullable":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,
            "x-hints":{
                "precision":18
            }
        },
        "OperatingConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from source currency to operating currency.",
            "nullable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status 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
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"The quantity for the transaction line item.",
            "nullable":true
        },
        "AdjustmentComments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments explaining why the credit was adjusted.",
            "nullable":true
        },
        "SourceTransactionAmount":{
            "type":"number",
            "description":"The transaction amount in source currency of the transaction.",
            "nullable":true
        },
        "CreditCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the credit category that is used 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
            }
        },
        "CollectionStatus":{
            "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
        },
        "CreditType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the nature of the credit such as Direct, Indirect, or Summarized.",
            "nullable":false,
            "default":"DIRECT"
        },
        "ClsfnRuleId":{
            "type":"integer",
            "description":"The unique identifier of the classification rule used to assign the credit category, to the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DirectParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who is directly involved in the closure of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceCreditId":{
            "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
            }
        },
        "HomeConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from processing currency to home currency.",
            "nullable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier of the role assigned to the credit receiver.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceCreditAmount":{
            "type":"number",
            "description":"The credit amount in source currency of the transaction.",
            "nullable":true
        },
        "CalculationCurrencyCode":{
            "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
        },
        "AdjustmentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status indicating 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
        },
        "TransactionAmount":{
            "type":"number",
            "description":"The transaction amount in processing currency.",
            "nullable":true
        },
        "HomeCreditAmount":{
            "type":"number",
            "description":"The transaction amount in participant's home currency.",
            "nullable":true
        },
        "CreditedParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who owns the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CalculationConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from source currency to processing currency.",
            "nullable":true
        },
        "OperatingCreditAmount":{
            "type":"number",
            "description":"The credit amount in business unit operating currency.",
            "nullable":true
        },
        "SimulationDeleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a credit is deleted during calculation simulation processing.",
            "nullable":false,
            "default":false
        },
        "SimulationId":{
            "type":"integer",
            "description":"The identifier of the simulation to which this simulation credit belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CreditRuleId":{
            "type":"integer",
            "description":"The unique identifier of the credit rule used to create the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "SummaryCreditId":{
            "type":"integer",
            "description":"The unique identifier of the summary credit to which the credit is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "HoldFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the application must exclude the transaction from further processing.",
            "nullable":true
        },
        "RevenueType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the credit, such 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"
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : 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の使用可能な参照コードをレビューします。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code that represents the currency of the monetary transaction amount in the source application.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventDate":{
            "type":"string",
            "description":"The date when the incentive event occurs. 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-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitPct":{
            "type":"number",
            "description":"The percent of the transaction amount that the credit receiver received.",
            "nullable":true,
            "default":100,
            "x-queryable":true
        },
        "RollupDate":{
            "type":"string",
            "description":"The date used to determine the roll up credit receivers when processing the roll up rules against transactions.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceBusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of the source transaction business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditAmount":{
            "type":"number",
            "description":"The credit amount in processing currency.",
            "nullable":true,
            "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,
            "x-hints":{
                "precision":18
            },
            "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":{
            "type":"number",
            "description":"The quantity for the transaction line item.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditId":{
            "type":"integer",
            "description":"The unique identifier of the credit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceTransactionAmount":{
            "type":"number",
            "description":"The transaction amount in source currency of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the credit category that is used 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
        },
        "CollectionStatus":{
            "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,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "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
        },
        "ProcessCode":{
            "maxLength":30,
            "type":"string",
            "description":"The five letter code indicating the combination of Override Classification, Preserve Credits, Do Not Roll Up, and Do Not Calculate values for the transaction.",
            "nullable":true,
            "readOnly":true,
            "default":"CNNEC",
            "x-queryable":true
        },
        "ReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code indicating 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":{
            "type":"number",
            "description":"The credit amount in source currency of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier of the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalculationCurrencyCode":{
            "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,
            "x-queryable":true
        },
        "AdjustmentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status indicating 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,
            "x-queryable":true
        },
        "CalculationConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from source currency to processing currency.",
            "nullable":true,
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"The identifier of the simulation to which this simulation credit belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SummaryCreditId":{
            "type":"integer",
            "description":"The unique identifier of the summary credit to which the credit is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the credit, such 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":{
            "type":"string",
            "description":"The date when the credit receiver should receive the credit. The date is used to determine the credit receivers when processing the credit rules against transactions.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RollupLevel":{
            "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,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionType":{
            "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":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the transaction that users can recognize and search with, for example, an invoice number or order number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedDuring":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup code indicating when this credit record was created. A list of valid values is stored in the lookup CN_TP_CREDIT_CREATED_DURING. Review the available lookup codes using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"SIMULATION",
            "x-queryable":true
        },
        "HomeCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the participant's home currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangedCreditFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the credit is new or modified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperatingConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from source currency to operating currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status 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":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments explaining why the credit was adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the nature of the credit such as Direct, Indirect, or Summarized.",
            "nullable":false,
            "default":"DIRECT",
            "x-queryable":true
        },
        "ClsfnRuleId":{
            "type":"integer",
            "description":"The unique identifier of the classification rule used to assign the credit category, to the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirectParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who is directly involved in the closure of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceCreditId":{
            "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":{
            "type":"number",
            "description":"The exchange rate to convert from processing currency to home currency.",
            "nullable":true,
            "x-queryable":true
        },
        "RoleId":{
            "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":{
            "type":"number",
            "description":"The transaction amount in processing currency.",
            "nullable":true,
            "x-queryable":true
        },
        "HomeCreditAmount":{
            "type":"number",
            "description":"The transaction amount in participant's home currency.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditedParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who owns the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OperatingCreditAmount":{
            "type":"number",
            "description":"The credit amount in business unit operating currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The display label explaining why the credit is in error status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationDeleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a credit is deleted during calculation simulation processing.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CreditRuleId":{
            "type":"integer",
            "description":"The unique identifier of the credit rule used to create the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the reason 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":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the application must exclude the transaction from further processing.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "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."
        }
    }
}

リンク

CreditCategoryVVO

操作: /fscmRestApi/resources/11.13.18.05/creditCategories

クレジット・カテゴリの一意の識別子を含む値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: CreditCategoryId;ターゲット属性: EligibleCatId
表示属性: 名前

CreditRuleVVO

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies

ルールの一意のクレジット識別子を含む値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: CreditRuleId;ターゲット属性: RuleId
表示属性: 名前

CreditTypeVVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DCN_TP_CREDIT_TYPE

クレジットのタイプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: CreditType;ターゲット属性: LookupCode
表示属性: 意味

CurrencyVVO

操作: /fscmRestApi/resources/11.13.18.05/currenciesLOV

パラメータ:

ファインダ: CurrencyCodeFinder

通貨コードを含む値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: SourceCurrencyCode;ターゲット属性: CurrencyCode
表示属性: CurrencyCode、名前

ObjectStatusVVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DCN_TP_CREDIT_OBJECT_STATUS

クレジットのステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ObjectStatus;ターゲット属性: LookupCode
表示属性: 意味

RevenueTypeVVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DCN_RS_REVENUE_TYPE

クレジットのタイプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: RevenueType;ターゲット属性: LookupCode
表示属性: 意味

「トップに戻る」