Get all transactions
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- InDatesFinder: Finds the transactions with the specified date range.
Finder Variables:- bFromDate; string; The date when the range begins.
- bToDate; string; The date when the range ends.
- LatestVersionFinder: Finds the latest transaction record with the specified transaction number and type.
Finder Variables:- bTransactionNumber; string; The unique identifier of the transaction that users can recognize and search with.
- bTransactionType; string; The lookup code of the type of transaction.
- PrimaryKey: Finds a transaction with the specified record identifier.
Finder Variables:- TransactionId; integer; The unique identifier of the transaction.
- InDatesFinder: Finds the transactions with the specified date range.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AdjustmentComments; string; The commentary for an adjustment to the transaction.
- AdjustmentStatus; string; The lookup code that indicates the adjustment state of the transaction. Review the available lookup codes for the lookup type CN_TP_BASETRANS_ADJ_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
- BookedDate; string; The date when the sales order was booked in the order management application.
- BusinessUnitId; integer; The unique identifier of the business unit.
- BusinessUnitName; string; The name of the business unit.
- ChangedTrxFlag; boolean; Indicates whether the transaction is a new transaction or a modified transaction.
- ClsfnRuleId; integer; The unique identifier of the classification rule used to assign the credit category to the transaction.
- CollectionStatus; string; The lookup code that indicates the reason for a collection error. Review the available lookup codes for the lookup type CN_TP_BASETRANS_COLL_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
- ConversionRate; number; The exchange rate to convert from source system currency to operating currency.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- CreditDate; string; 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.
- DirectParticipantId; integer; The unique identifier of the participant who is directly involved in the closure transaction.
- DiscountPercentage; number; The percentage of the transaction amount that depicts the net amount to be paid by the buyer.
- EligibleCatId; integer; The unique identifier of the credit category to use when overriding the classification process. The credit category is a user-defined business category used to classify a transaction for compensation purposes.
- ErrorCode; string; The code indicating the reason a transaction 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; The reason explaining why the credit is in error status.
- EventDate; string; 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. The date must be within a defined Incentive Compensation calendar period where the period has an Open status and the calendar is defined for the same business unit as the transaction's business unit. If the value does not meet these requirements, the transaction process status is updated to Error.
- HoldFlag; boolean; Indicates whether the application must exclude the transaction from processing further. The transaction will not be processed further if this flag is set to Y.
- InvoiceDate; string; The invoice date for the transaction in the source application.
- InvoiceNumber; string; The unique identifier of the invoice associated with the transaction.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdateLogin; string; The login of the user who last updated the record.
- LastUpdatedBy; string; The user who last updated the record.
- MarginPercentage; number; The percentage of the transaction amount that depicts the profit of the sale.
- ObjectStatus; string; The lookup code that indicates the current state of the transaction, such as New, Obsolete, or Collection Error. Review the available lookup codes for the lookup type CN_TP_BASETRANS_OBJECT_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
- OrderNumber; string; The sales order number in the source application associated with the transaction.
- PreserveCreditFlag; boolean; Indicates whether any of the manually created or adjusted credits for the transaction are not to be modified by the credit process.
- ProcessCode; string; The process code is a five letter code that indicates the combination of Override Classification, Preserve Credits, Do Not Roll Up, and Do Not Calculate values for the transaction. For example, the default value of the process code CCREC indicates that the Override Classification, Preserve Credits, and Do Not Roll Up check boxes are not checked and the normal calculation processing will occur. The first letter determines the Override Classification setting. Valid values are N and C. Enter a code starting with N to check the Override Classification checkbox. You must also provide a credit category to avoid the collection error status. For regular classification processing, enter a code starting with C. The second letter determines the Preserve Credits setting. Valid values are N and C. Enter a code with N as the second letter to check the Preserve Credits checkbox. For regular credit processing, enter C. The third letter determines the Do Not Rollup setting. Valid values are N and R. Enter a code with N as the third letter to check the Do Not Rollup checkbox. To allow rollup credit processing, enter R. The last two letters indicate earnings edibility and calculation. Valid values are EC, EN,NN, and NC. Enter a code with the value of N in either or both of the fourth and fifth position to exclude the credit from calculation. For regular calculation processing, enter EC.
- ReasonCode; string; The lookup code that indicates the reason for adjusting a transaction. You can view the CN_TP_ADJUSTMENT_REASON lookup from the Setup and Maintenance, Manage Incentive Compensation Lookups task.
- RoleId; integer; The unique identifier of the compensation role assigned to the direct participant.
- RollupDate; string; The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
- SourceBusinessUnitId; integer; The unique identifier of the source transaction business unit record.
- SourceCurrencyCode; string; The currency code that indicates the currency of the monetary transaction amount in the source application.
- SourceEventPeriodId; integer; The unique identifier of the period to which the source event belongs.
- SourceTrxId; integer; The unique identifier of the transaction in the source application.
- SourceTrxLineId; integer; The unique identifier of the transaction line in the source application.
- SourceTrxSalesLineId; integer; The unique identifier of the transaction credit in the source application.
- TerrId; integer; The unique identifier of the territory to which the transaction belongs.
- TerrName; string; The name of the territory to which the transaction belongs.
- TransactionAmountFunc; number; The transaction amount in operating currency.
- TransactionAmountSource; number; The transaction amount in source currency.
- TransactionId; integer; The unique identifier of the transaction.
- TransactionNumber; string; The transaction identifier that users can recognize and search with, for example, an invoice number or an order number. If adjusting a transaction, the combination of the business unit, transaction number, and the transaction type uniquely identify an existing transaction.
- TransactionQuantity; number; The quantity of the transaction line item.
- TransactionType; string; 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.
- UOMCode; string; The code indicating the unit of measure for the transaction line item. Review the available lookup codes for the lookup type ORA_CN_TP_TRANSACTION_UOM using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
- WorkerId; integer; The batch number assigned to the transaction. This is applicable if the batch processing in the system parameters page is set to "Use batch information provided at transaction level".
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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 : incentiveCompensationTransactions
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : incentiveCompensationTransactions-item-response
Type:
Show Source
object
-
AdjustmentComments: string
Title:
Comment
Maximum Length:1000
The commentary for an adjustment to the transaction. -
AdjustmentStatus: string
Title:
Adjustment Status
Read Only:true
Maximum Length:30
The lookup code that indicates the adjustment state of the transaction. Review the available lookup codes for the lookup type CN_TP_BASETRANS_ADJ_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
BookedDate: string
(date)
Title:
Book Date
The date when the sales order was booked in the order management application. -
BusinessUnitId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit. -
BusinessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:960
The name of the business unit. -
CalculateFlag: boolean
Indicates whether the transaction should be processed by the calculation process. The CalculateFlag would need to be set at import of transaction. Each Update to a transaction will create an adjusted transaction which will then be reverted and calculation run. If the flag is set to 'N' then a valid credit receiver should be provided.
-
ChangedTrxFlag: boolean
Title:
Change Indicator
Maximum Length:1
Default Value:false
Indicates whether the transaction is a new transaction or a modified transaction. -
ClassificationFlag: boolean
Maximum Length:
255
Indicates whether the transaction should be processed by the classification process. If the flag is set to 'N' then a valid credit category should be provided. -
ClsfnRuleId: integer
(int64)
Title:
Classification Rule
The unique identifier of the classification rule used to assign the credit category to the transaction. -
CollectionStatus: string
Title:
Collection Status
Read Only:true
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_BASETRANS_COLL_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
ConversionRate: number
Title:
Conversion Rate
Read Only:true
The exchange rate to convert from source system currency to operating currency. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CreditDate: string
(date)
Title:
Credit Date
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. -
CreditFlag: boolean
Indicates if the transaction should be processed by the crediting process. If the flag is set to 'N' then a valid credit receiver should be provided.
-
Credits: array
Credits
Title:
Credits
The credits resource is used to view, create, and update the credits for a transaction. -
DirectParticipantId: integer
(int64)
Title:
Direct Participant
The unique identifier of the participant who is directly involved in the closure transaction. -
DiscountPercentage: number
Title:
Discount Percentage
The percentage of the transaction amount that depicts the net amount to be paid by the buyer. -
EligibleCatId: integer
(int64)
Title:
Credit Category
The unique identifier of the credit category to use when overriding the classification process. The credit category is a user-defined business category used to classify a transaction for compensation purposes. -
EligibleFlag: boolean
Indicates if the transaction should be processed by the calculation process.
-
ErrorCode: string
Maximum Length:
30
The code indicating the reason a transaction 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 reason explaining why the credit is in error status. -
EventDate: string
(date)
Title:
Event Date
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. The date must be within a defined Incentive Compensation calendar period where the period has an Open status and the calendar is defined for the same business unit as the transaction's business unit. If the value does not meet these requirements, the transaction process status is updated to Error. -
HoldFlag: boolean
Title:
Hold
Maximum Length:1
Indicates whether the application must exclude the transaction from processing further. The transaction will not be processed further if this flag is set to Y. -
InvoiceDate: string
(date)
Title:
Invoice Date
The invoice date for the transaction in the source application. -
InvoiceNumber: string
Title:
Invoice Number
Maximum Length:30
The unique identifier of the invoice associated with the transaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
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. -
MarginPercentage: number
Title:
Margin Percentage
The percentage of the transaction amount that depicts the profit of the sale. -
ObjectStatus: string
Title:
Process Status
Maximum Length:30
The lookup code that indicates the current state of the transaction, such as New, Obsolete, or Collection Error. Review the available lookup codes for the lookup type CN_TP_BASETRANS_OBJECT_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
OrderNumber: string
Title:
Order Number
Maximum Length:30
The sales order number in the source application associated with the transaction. -
PreserveCreditFlag: boolean
Title:
Preserve credits
Maximum Length:1
Indicates whether any of the manually created or adjusted credits for the transaction are not to be modified by the credit process. -
ProcessCode: string
Title:
Override
Maximum Length:30
The process code is a five letter code that indicates the combination of Override Classification, Preserve Credits, Do Not Roll Up, and Do Not Calculate values for the transaction. For example, the default value of the process code CCREC indicates that the Override Classification, Preserve Credits, and Do Not Roll Up check boxes are not checked and the normal calculation processing will occur. The first letter determines the Override Classification setting. Valid values are N and C. Enter a code starting with N to check the Override Classification checkbox. You must also provide a credit category to avoid the collection error status. For regular classification processing, enter a code starting with C. The second letter determines the Preserve Credits setting. Valid values are N and C. Enter a code with N as the second letter to check the Preserve Credits checkbox. For regular credit processing, enter C. The third letter determines the Do Not Rollup setting. Valid values are N and R. Enter a code with N as the third letter to check the Do Not Rollup checkbox. To allow rollup credit processing, enter R. The last two letters indicate earnings edibility and calculation. Valid values are EC, EN,NN, and NC. Enter a code with the value of N in either or both of the fourth and fifth position to exclude the credit from calculation. For regular calculation processing, enter EC. -
ReasonCode: string
Title:
Reason
Maximum Length:30
The lookup code that indicates the reason for adjusting a transaction. You can view the CN_TP_ADJUSTMENT_REASON lookup from the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
RoleId: integer
(int64)
Title:
Role
The unique identifier of the compensation role assigned to the direct participant. -
RollupDate: string
(date)
Title:
Rollup Date
The date used to determine the roll up credit receivers when processing the roll up rules against transactions. -
RollupFlag: boolean
Indicates whether the transaction should be processed by the rollup process.
-
SourceBusinessUnitId: integer
(int64)
Title:
Source BU
The unique identifier of the source transaction business unit record. -
SourceCurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code that indicates the currency of the monetary transaction amount in the source application. -
SourceEventPeriodId: integer
(int64)
Title:
Event Period
Read Only:true
The unique identifier of the period to which the source event belongs. -
SourceTrxId: integer
(int64)
Title:
Transaction ID
The unique identifier of the transaction in the source application. -
SourceTrxLineId: integer
(int64)
Title:
Line Number
The unique identifier of the transaction line in the source application. -
SourceTrxSalesLineId: integer
(int64)
Title:
Line
The unique identifier of the transaction credit in the source application. -
SrpRollupFlag: boolean
Indicates if the rollup is enabled for the business unit of the credit.
-
TerrId: integer
(int64)
Title:
Territory ID
The unique identifier of the territory to which the transaction belongs. -
TerrName: string
Title:
Territory Name
Maximum Length:1000
The name of the territory to which the transaction belongs. -
TransactionAmountFunc: number
Title:
Operating Currency Amount
Read Only:true
The transaction amount in operating currency. -
TransactionAmountSource: number
Title:
Transaction Amount
The transaction amount in source currency. -
TransactionId: integer
(int64)
Title:
Transaction ID
The unique identifier of the transaction. -
TransactionNumber: string
Title:
Transaction Number
Maximum Length:30
The transaction identifier that users can recognize and search with, for example, an invoice number or an order number. If adjusting a transaction, the combination of the business unit, transaction number, and the transaction type uniquely identify an existing transaction. -
TransactionQuantity: number
Title:
Quantity
The quantity of the transaction line item. -
TransactionsDFF: array
Transaction Descriptive Flex Fields
Title:
Transaction Descriptive Flex Fields
The transaction descriptive flex fields resource is used to view, create, and update additional attributes of the transaction that are used for classification, crediting, calculating, and reporting. -
TransactionType: string
Title:
Transaction Type
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. -
UOMCode: string
Title:
UOM
Maximum Length:10
The code indicating the unit of measure for the transaction line item. Review the available lookup codes for the lookup type ORA_CN_TP_TRANSACTION_UOM using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
WorkerId: integer
(int64)
The batch number assigned to the transaction. This is applicable if the batch processing in the system parameters page is set to "Use batch information provided at transaction level".
Nested Schema : Credits
Type:
array
Title:
Credits
The credits resource is used to view, create, and update the credits for a transaction.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Transaction Descriptive Flex Fields
Type:
array
Title:
Transaction Descriptive Flex Fields
The transaction descriptive flex fields resource is used to view, create, and update additional attributes of the transaction that are used for classification, crediting, calculating, and reporting.
Show Source
Nested Schema : incentiveCompensationTransactions-Credits-item-response
Type:
Show Source
object
-
AdjustmentComments: string
Title:
Comment
Maximum Length:1000
The commentary for an adjustment to the credit. -
AdjustmentStatus: string
Title:
Adjustment Status
Read Only:true
Maximum Length:30
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. -
BusinessUnitId: integer
(int64)
Title:
Business Unit
Read Only:true
The unique identifier of the business unit. -
BusinessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
The name of the business unit. -
CalculationConversionRate: number
Title:
Calculation Currency Conversion Rate
Read Only:true
The exchange rate to convert from source currency to processing currency. -
CalculationCurrencyCode: string
Title:
Currency
Read Only:true
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
Title:
Change Indicator
Read Only:true
Maximum Length:1
Indicates if the credit is new or modified. -
ClsfnRuleId: integer
(int64)
Title:
Classification Rule
Read Only:true
The unique identifier of the classification rule used to assign the credit category, to the credit. -
CollectionStatus: string
Title:
Collection Status
Read Only:true
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
Title:
Credit Process Type
Read Only:true
Maximum Length:30
The lookup code indicating when this credit record was created. Review the available lookup codes CN_TP_CREDIT_CREATED_DURING 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
Title:
Credit Amount
The credit amount in processing currency. -
CreditCategoryId: integer
(int64)
Title:
Name
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. -
CreditDate: string
(date)
Title:
Credit Date
The date the credit receiver should receive credit. The date is used to determine the credit receivers when processing the credit rules against transactions. -
CreditedParticipantId: integer
(int64)
Title:
Credit Receiver
The unique identifier of the participant who owns the credit. -
CreditId: integer
(int64)
Title:
Credit ID
Read Only:true
The unique identifier of the credit. -
CreditRuleId: integer
(int64)
Title:
Credit Rule
Read Only:true
The unique record identifier of the credit rule used to create the credit. -
CreditType: string
Title:
Credit Type
Read Only:true
Maximum Length:30
Indicates the nature of the credit such as Direct, Indirect or Summarized. -
DirectParticipantId: integer
(int64)
Title:
Direct Participant
Read Only:true
The unique identifier of the participant who is directly involved in the closure transaction. -
DirectRuleId: integer
(int64)
Read Only:
true
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 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. -
ErrorMeaning: string
Read Only:
true
Maximum Length:80
The reason explaining why the credit is in error status. -
EventDate: string
(date)
Title:
Event Date
Read Only:true
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. -
HoldFlag: boolean
Title:
Hold
Maximum Length:1
Indicates whether the application must exclude the transaction from processing further. -
HomeConversionRate: number
Title:
Home Currency Conversion Rate
Read Only:true
The exchange rate to convert from processing currency to home currency. -
HomeCreditAmount: number
Title:
Home Credit Amount
Read Only:true
The transaction amount in participant's home currency. -
HomeCurrencyCode: string
Title:
Home Currency
Read Only:true
Maximum Length:15
The code indicating the participant's home currency. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
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
Title:
Process Status
Maximum Length:30
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. -
OperatingConversionRate: number
Title:
Operating Currency Conversion Rate
Read Only:true
The exchange rate to convert from source currency to operating currency. -
OperatingCreditAmount: number
Title:
Operating Credit Amount
Read Only:true
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
Title:
Override
Maximum Length:30
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. -
ReasonCode: string
Title:
Reason
Read Only:true
Maximum Length:30
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. -
RevenueType: string
Title:
Revenue Type
Maximum Length:30
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. -
RoleId: integer
(int64)
Title:
Role
The unique identifier of the role assigned to the credit receiver. -
RollupDate: string
(date)
Title:
Rollup Date
Read Only:true
The date used to determine the roll up credit receivers when processing the roll up rules against transactions. -
RollupLevel: integer
(int64)
Title:
Rollup Level
Read Only:true
The level of the rollup rule in the rollup hierarchy. This value is applicable in case of rollup credits. -
SourceBusinessUnitId: integer
(int64)
Title:
Source BU
Read Only:true
The unique identifier of the source transaction business unit. -
SourceCreditAmount: number
Title:
Source Credit Amount
Read Only:true
The credit amount in source currency of the transaction. -
SourceCreditId: integer
(int64)
Title:
Source Credit ID
The unique identifier of the source credit or the summarized credit record from which the rollup credit is generated. -
SourceCurrencyCode: string
Title:
Source Currency
Read Only:true
Maximum Length:15
The currency code that represents the currency of the monetary transaction amount in the source application. -
SourceTransactionAmount: number
Title:
Source Transaction Amount
Read Only:true
The transaction amount in source currency of the transaction. -
SplitPct: number
Title:
Split Percent
The percent of the transaction amount that the credit receiver received. -
SummaryCreditId: integer
(int64)
Read Only:
true
The unique identifier of the summary credit to which the credit is associated. -
TransactionAmount: number
Title:
Transaction Amount
Read Only:true
The transaction amount in processing currency. -
TransactionId: integer
(int64)
Title:
Transaction ID
Read Only:true
The unique identifier of the transaction. -
TransactionNumber: string
Title:
Transaction Number
Read Only:true
Maximum Length:30
The transaction identifier that users can recognize and search with, for example, an invoice number or order number. -
TransactionQuantity: number
Title:
Quantity
Read Only:true
The quantity for the transaction line item. -
TransactionType: string
Title:
Transaction Type
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.
Nested Schema : incentiveCompensationTransactions-TransactionsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Business Unit Context for Base Transaction Attributes
Maximum Length:30
The context segment for the descriptive flex field. -
__FLEX_Context_DisplayValue: string
Title:
Business Unit Context for Base Transaction Attributes
-
_Area_Code: string
Title:
Area Code
Maximum Length:360
The geographic transaction attribute for the area code. The area code is a component of a phone number and is usually a 3-digit number that identifies each telephone service area in a country. -
_Billing_Address: number
Title:
Customer Billing Address Location
The unique identifier of the customer billing location. -
_Billing_Contact: number
Title:
Customer Billing Contact
The unique identifier of the contact person at the bill-to location. -
_City: string
Title:
City
Maximum Length:360
The name of the city. -
_City_Display: string
Title:
City
-
_Country: string
Title:
Country
Maximum Length:360
The name of the country. -
_Country_Display: string
Title:
Country
-
_Postal_Code: string
Title:
Postal Code
Maximum Length:360
The postal code of the address. -
_Product_Item_ID: number
Title:
Line Item ID
The unique identifier of the inventory item. -
_Product_Item_ID_Display: string
Title:
Line Item ID
-
_Province: string
Title:
Province
Maximum Length:360
The name of the province. -
_Sales_Channel: string
Title:
Sales Channel
Maximum Length:30
The sales channel represents how the transaction was sold. For example, indirect or direct. -
_Shipping_Address: number
Title:
Shipping Address Location
The unique identifier of the customer's ship-to location. -
_Shipping_Contact: number
Title:
Customer Shipping Contact
The unique identifier of the contact person at the ship-to location. -
_Sold_To_Customer: number
Title:
Customer
The unique identifier of customer who purchased the items or services listed on the transaction. -
_Sold_To_Customer_Display: string
Title:
Customer
The name of the sold-to customer. -
_State: string
Title:
State
Maximum Length:360
The name of the state. -
_State_Display: string
Title:
State
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionId: integer
(int64)
Title:
Transaction ID
The unique identifier of the transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get all incentive compensation transactions by submitting a GET request on the REST resource using cURL.
cURL Command
curl --user
sales_cloud_user https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "TransactionId": 100000015464011, "TransactionNumber": "OTBI004", "BusinessUnitId": 204, "BusinessUnitName": "Vision Operations", "TransactionType": "MANUAL", "EventDate": "2009-01-01", "SourceEventPeriodId": 2009001, "DirectParticipantId": null, "EligibleCatId": null, "TransactionAmountSource": 9999, "SourceCurrencyCode": "USD", "ConversionRate": 1, "TransactionAmountFunc": 9999, "CreditDate": "2009-01-01", "RollupDate": "2009-01-01", "HoldFlag": false, "PreserveCreditFlag": false, "AdjustmentComments": null, "ReasonCode": null, "ObjectStatus": "CLASSIFICATION_ERROR", "ErrorCode": null, "ErrorMeaning": null, "AdjustmentStatus": "NONE", "CollectionStatus": null, "TerrId": null, "TerrName": null, "RoleId": null, "TransactionQuantity": null, "UOMCode": null, "DiscountPercentage": null, "MarginPercentage": null, "OrderNumber": null, "InvoiceNumber": null, "InvoiceDate": null, "BookedDate": null, "ChangedTrxFlag": false, "ProcessCode": "CCREC", "SourceBusinessUnitId": 204, "SourceTrxId": null, "SourceTrxLineId": null, "SourceTrxSalesLineId": null, "CreatedBy": "OPERATIONS", "CreationDate": "2010-01-17T22:42:55.716+00:00", "LastUpdatedBy": "8381FCACB5D3660664E60F8C139D37D3", "LastUpdateDate": "2010-01-28T01:46:16+00:00", "LastUpdateLogin": "7E35217F76A3A74BE04044987CF055EE", "SrpRollupFlag": null, "ClassificationFlag": true, "CreditFlag": true, "RollupFlag": true, "EligibleFlag": true, "CalculateFlag": true, "WorkerId": null, "ClsfnRuleId": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/100000015464011", "name": "incentiveCompensationTransactions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/100000015464011", "name": "incentiveCompensationTransactions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/100000015464011/lov/BusinessUnitVVO", "name": "BusinessUnitVVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/100000015464011/lov/EligibleCategoryVVO", "name": "EligibleCategoryVVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/100000015464011/lov/ObjectStatusVVO", "name": "ObjectStatusVVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.comfscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/100000015464011/lov/UOMCodeVVO", "name": "UOMCodeVVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/100000015464011/lov/TransactionTypeVVO", "name": "TransactionTypeVVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/100000015464011/lov/ReasonCodeVVO", "name": "ReasonCodeVVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/100000015464011/lov/ClassificationRuleVVO", "name": "ClassificationRuleVVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/100000015464011/lov/CurrencyVVO", "name": "CurrencyVVO", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/100000015464011/child/Credits", "name": "Credits", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/100000015464011/child/TransactionsDFF", "name": "TransactionsDFF", "kind": "collection" } ] }, ... }