Create a simulation credit
post
/fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits
Request
Path Parameters
-
SimulationId(required): integer(int64)
The unique identifier of the calculation simulation.
-
TransactionId(required): integer(int64)
The unique identifier of the transaction in a calculation simulation.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AdjustmentComments: string
Maximum Length:
1000
The comments explaining why the credit was adjusted. -
AdjustmentStatus: string
Maximum Length:
30
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. -
CalculationConversionRate: number
The exchange rate to convert from source currency to processing currency.
-
CalculationCurrencyCode: string
Maximum Length:
15
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. -
ClsfnRuleId: integer
(int64)
The unique identifier of the classification rule used to assign the credit category, to the credit.
-
CollectionStatus: string
Maximum Length:
30
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. -
CreditAmount: number
The credit amount in processing currency.
-
CreditCategoryId: integer
(int64)
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.
-
CreditDate: string
(date-time)
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.
-
CreditedParticipantId: integer
(int64)
The unique identifier of the participant who owns the credit.
-
CreditRuleId: integer
(int64)
The unique identifier of the credit rule used to create the credit.
-
CreditType: string
Maximum Length:
30
Default Value:DIRECT
Indicates the nature of the credit such as Direct, Indirect, or Summarized. -
DirectParticipantId: integer
(int64)
The unique identifier of the participant who is directly involved in the closure of the transaction.
-
DirectRuleId: integer
(int64)
The unique identifier of the credit rule used to create the direct credit that corresponds to this credit.
-
HoldFlag: boolean
Maximum Length:
1
Indicates whether the application must exclude the transaction from further processing. -
HomeConversionRate: number
The exchange rate to convert from processing currency to home currency.
-
HomeCreditAmount: number
The transaction amount in participant's home currency.
-
HomeCurrencyCode: string
Maximum Length:
15
The code indicating the participant's home currency. -
ObjectStatus: string
Maximum Length:
30
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. -
OperatingConversionRate: number
The exchange rate to convert from source currency to operating currency.
-
OperatingCreditAmount: number
The credit amount in business unit operating currency.
-
RevenueType: string
Maximum Length:
30
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. -
RoleId: integer
(int64)
The unique identifier of the role assigned to the credit receiver.
-
RollupDate: string
(date-time)
The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
-
RollupLevel: integer
(int64)
The level of the rollup rule in the rollup hierarchy. This value is applicable in case of rollup credits.
-
SimulationDeleteFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether a credit is deleted during calculation simulation processing. -
SimulationId: integer
(int64)
The identifier of the simulation to which this simulation credit belongs.
-
SourceBusinessUnitId: integer
(int64)
The unique identifier of the source transaction business unit.
-
SourceCreditAmount: number
The credit amount in source currency of the transaction.
-
SourceCreditId: integer
(int64)
The unique identifier of the source credit or the summarized credit record from which the rollup credit is generated.
-
SourceCurrencyCode: string
Maximum Length:
15
The currency code that represents the currency of the monetary transaction amount in the source application. -
SourceTransactionAmount: number
The transaction amount in source currency of the transaction.
-
SplitPct: number
Default Value:
100
The percent of the transaction amount that the credit receiver received. -
SummaryCreditId: integer
(int64)
The unique identifier of the summary credit to which the credit is associated.
-
TransactionAmount: number
The transaction amount in processing currency.
-
TransactionQuantity: number
The quantity for the transaction line item.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : incentiveCompensationCalculationSimulations-Transactions-Credits-item-response
Type:
Show Source
object
-
AdjustmentComments: string
Maximum Length:
1000
The comments explaining why the credit was adjusted. -
AdjustmentStatus: string
Maximum Length:
30
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. -
CalculationConversionRate: number
The exchange rate to convert from source currency to processing currency.
-
CalculationCurrencyCode: string
Maximum Length:
15
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. -
ChangedCreditFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if the credit is new or modified. -
ClsfnRuleId: integer
(int64)
The unique identifier of the classification rule used to assign the credit category, to the credit.
-
CollectionStatus: string
Maximum Length:
30
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. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreatedDuring: string
Read Only:
true
Maximum Length:30
Default Value:SIMULATION
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. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CreditAmount: number
The credit amount in processing currency.
-
CreditCategoryId: integer
(int64)
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.
-
CreditDate: string
(date-time)
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.
-
CreditedParticipantId: integer
(int64)
The unique identifier of the participant who owns the credit.
-
CreditId: integer
(int64)
Read Only:
true
The unique identifier of the credit. -
CreditRuleId: integer
(int64)
The unique identifier of the credit rule used to create the credit.
-
CreditType: string
Maximum Length:
30
Default Value:DIRECT
Indicates the nature of the credit such as Direct, Indirect, or Summarized. -
DirectParticipantId: integer
(int64)
The unique identifier of the participant who is directly involved in the closure of the transaction.
-
DirectRuleId: integer
(int64)
The unique identifier of the credit rule used to create the direct credit that corresponds to this credit.
-
ErrorCode: string
Read Only:
true
Maximum Length:30
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. -
ErrorMeaning: string
Read Only:
true
Maximum Length:80
The display label explaining why the credit is in error status. -
EventDate: string
(date-time)
Read Only:
true
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. -
HoldFlag: boolean
Maximum Length:
1
Indicates whether the application must exclude the transaction from further processing. -
HomeConversionRate: number
The exchange rate to convert from processing currency to home currency.
-
HomeCreditAmount: number
The transaction amount in participant's home currency.
-
HomeCurrencyCode: string
Maximum Length:
15
The code indicating the participant's home currency. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectStatus: string
Maximum Length:
30
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. -
OperatingConversionRate: number
The exchange rate to convert from source currency to operating currency.
-
OperatingCreditAmount: number
The credit amount in business unit operating currency.
-
OperatingCurrency: string
Title:
Operating Currency
Read Only:true
Maximum Length:10
The code indicating the functional currency of the business unit. -
ProcessCode: string
Read Only:
true
Maximum Length:30
Default Value:CNNEC
The five letter code indicating the combination of Override Classification, Preserve Credits, Do Not Roll Up, and Do Not Calculate values for the transaction. -
ReasonCode: string
Read Only:
true
Maximum Length:30
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. -
RevenueType: string
Maximum Length:
30
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. -
RoleId: integer
(int64)
The unique identifier of the role assigned to the credit receiver.
-
RollupDate: string
(date-time)
The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
-
RollupLevel: integer
(int64)
The level of the rollup rule in the rollup hierarchy. This value is applicable in case of rollup credits.
-
SimulationDeleteFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether a credit is deleted during calculation simulation processing. -
SimulationId: integer
(int64)
The identifier of the simulation to which this simulation credit belongs.
-
SourceBusinessUnitId: integer
(int64)
The unique identifier of the source transaction business unit.
-
SourceCreditAmount: number
The credit amount in source currency of the transaction.
-
SourceCreditId: integer
(int64)
The unique identifier of the source credit or the summarized credit record from which the rollup credit is generated.
-
SourceCurrencyCode: string
Maximum Length:
15
The currency code that represents the currency of the monetary transaction amount in the source application. -
SourceTransactionAmount: number
The transaction amount in source currency of the transaction.
-
SplitPct: number
Default Value:
100
The percent of the transaction amount that the credit receiver received. -
SummaryCreditId: integer
(int64)
The unique identifier of the summary credit to which the credit is associated.
-
TransactionAmount: number
The transaction amount in processing currency.
-
TransactionId: integer
(int64)
Read Only:
true
The unique identifier of the transaction. -
TransactionNumber: string
Read Only:
true
Maximum Length:30
The alternate key identifier of the transaction that users can recognize and search with, for example, an invoice number or order number. -
TransactionQuantity: number
The quantity for the transaction line item.
-
TransactionType: string
Read Only:
true
Maximum Length:30
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- CreditCategoryVVO
-
The list of values containing the unique identifiers of the credit categories.
The following properties are defined on the LOV link relation:- Source Attribute: CreditCategoryId; Target Attribute: EligibleCatId
- Display Attribute: Name
- CreditRuleVVO
-
The list of values containing the unique credit identifiers of the rules.
The following properties are defined on the LOV link relation:- Source Attribute: CreditRuleId; Target Attribute: RuleId
- Display Attribute: Name
- CreditTypeVVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_TP_CREDIT_TYPE
The list of values indicating the type of the credit.
The following properties are defined on the LOV link relation:- Source Attribute: CreditType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CurrencyVVO
-
Parameters:
- finder:
CurrencyCodeFinder
The list of values containing the currency codes.
The following properties are defined on the LOV link relation:- Source Attribute: SourceCurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode, Name
- finder:
- ObjectStatusVVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_TP_CREDIT_OBJECT_STATUS
The list of values indicating the status of the credit.
The following properties are defined on the LOV link relation:- Source Attribute: ObjectStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RevenueTypeVVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_RS_REVENUE_TYPE
The list of values indicating the type of the credit.
The following properties are defined on the LOV link relation:- Source Attribute: RevenueType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: