1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Incentive Compensation Transactions

Update a transaction

patch

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

Request

Path Parameters
Header Parameters
  • 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".
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Comment
    Maximum Length: 1000
    The commentary for an adjustment to the transaction.
  • Title: Book Date
    The date when the sales order was booked in the order management application.
  • 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.
  • Title: Change Indicator
    Maximum Length: 1
    Default Value: false
    Indicates whether the transaction is a new transaction or a modified transaction.
  • 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.
  • Title: Classification Rule
    The unique identifier of the classification rule used to assign the credit category to the transaction.
  • 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.
  • 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
    Title: Credits
    The credits resource is used to view, create, and update the credits for a transaction.
  • Title: Direct Participant
    The unique identifier of the participant who is directly involved in the closure transaction.
  • Title: Discount Percentage
    The percentage of the transaction amount that depicts the net amount to be paid by the buyer.
  • 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.
  • Indicates if the transaction should be processed by the calculation process.
  • 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.
  • 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.
  • 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.
  • Title: Invoice Date
    The invoice date for the transaction in the source application.
  • Title: Invoice Number
    Maximum Length: 30
    The unique identifier of the invoice associated with the transaction.
  • Title: Margin Percentage
    The percentage of the transaction amount that depicts the profit of the sale.
  • 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.
  • Title: Order Number
    Maximum Length: 30
    The sales order number in the source application associated with the transaction.
  • 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.
  • 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.
  • 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.
  • Title: Role
    The unique identifier of the compensation role assigned to the direct participant.
  • Title: Rollup Date
    The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
  • Indicates whether the transaction should be processed by the rollup process.
  • Title: Source BU
    The unique identifier of the source transaction business unit record.
  • Title: Currency
    Maximum Length: 15
    The currency code that indicates the currency of the monetary transaction amount in the source application.
  • Title: Transaction ID
    The unique identifier of the transaction in the source application.
  • Title: Line Number
    The unique identifier of the transaction line in the source application.
  • Title: Line
    The unique identifier of the transaction credit in the source application.
  • Indicates if the rollup is enabled for the business unit of the credit.
  • Title: Territory ID
    The unique identifier of the territory to which the transaction belongs.
  • Title: Territory Name
    Maximum Length: 1000
    The name of the territory to which the transaction belongs.
  • Title: Transaction Amount
    The transaction amount in source currency.
  • Title: Quantity
    The quantity of the transaction line item.
  • 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.
  • 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.
  • 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 : 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 : schema
Type: object
Show Source
  • Title: Comment
    Maximum Length: 1000
    The commentary for an adjustment to the credit.
  • Title: Credit Amount
    The credit amount in processing currency.
  • 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.
  • Title: Credit Receiver
    The unique identifier of the participant who owns the credit.
  • Title: Hold
    Maximum Length: 1
    Indicates whether the application must exclude the transaction from processing further.
  • 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.
  • 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.
  • Title: Role
    The unique identifier of the role assigned to the credit receiver.
  • Title: Split Percent
    The percent of the transaction amount that the credit receiver received.
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : incentiveCompensationTransactions-item-response
Type: object
Show Source
  • Title: Comment
    Maximum Length: 1000
    The commentary for an adjustment to the transaction.
  • 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.
  • Title: Book Date
    The date when the sales order was booked in the order management application.
  • Title: Business Unit
    The unique identifier of the business unit.
  • Title: Business Unit
    Read Only: true
    Maximum Length: 960
    The name of the business unit.
  • 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.
  • Title: Change Indicator
    Maximum Length: 1
    Default Value: false
    Indicates whether the transaction is a new transaction or a modified transaction.
  • 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.
  • Title: Classification Rule
    The unique identifier of the classification rule used to assign the credit category to the transaction.
  • 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.
  • Title: Conversion Rate
    Read Only: true
    The exchange rate to convert from source system currency to operating currency.
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date when the record was created.
  • 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.
  • 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
    Title: Credits
    The credits resource is used to view, create, and update the credits for a transaction.
  • Title: Direct Participant
    The unique identifier of the participant who is directly involved in the closure transaction.
  • Title: Discount Percentage
    The percentage of the transaction amount that depicts the net amount to be paid by the buyer.
  • 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.
  • Indicates if the transaction should be processed by the calculation process.
  • 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.
  • Read Only: true
    Maximum Length: 80
    The reason explaining why the credit is in error status.
  • 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.
  • 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.
  • Title: Invoice Date
    The invoice date for the transaction in the source application.
  • Title: Invoice Number
    Maximum Length: 30
    The unique identifier of the invoice associated with the transaction.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Margin Percentage
    The percentage of the transaction amount that depicts the profit of the sale.
  • 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.
  • Title: Order Number
    Maximum Length: 30
    The sales order number in the source application associated with the transaction.
  • 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.
  • 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.
  • 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.
  • Title: Role
    The unique identifier of the compensation role assigned to the direct participant.
  • Title: Rollup Date
    The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
  • Indicates whether the transaction should be processed by the rollup process.
  • Title: Source BU
    The unique identifier of the source transaction business unit record.
  • Title: Currency
    Maximum Length: 15
    The currency code that indicates the currency of the monetary transaction amount in the source application.
  • Title: Event Period
    Read Only: true
    The unique identifier of the period to which the source event belongs.
  • Title: Transaction ID
    The unique identifier of the transaction in the source application.
  • Title: Line Number
    The unique identifier of the transaction line in the source application.
  • Title: Line
    The unique identifier of the transaction credit in the source application.
  • Indicates if the rollup is enabled for the business unit of the credit.
  • Title: Territory ID
    The unique identifier of the territory to which the transaction belongs.
  • Title: Territory Name
    Maximum Length: 1000
    The name of the territory to which the transaction belongs.
  • Title: Operating Currency Amount
    Read Only: true
    The transaction amount in operating currency.
  • Title: Transaction Amount
    The transaction amount in source currency.
  • Title: Transaction ID
    The unique identifier of the transaction.
  • 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.
  • Title: Quantity
    The quantity of the transaction line item.
  • 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.
  • 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.
  • 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.
  • 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 : 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: object
Show Source
  • Title: Comment
    Maximum Length: 1000
    The commentary for an adjustment to the credit.
  • 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.
  • Title: Business Unit
    Read Only: true
    The unique identifier of the business unit.
  • Title: Business Unit
    Read Only: true
    Maximum Length: 240
    The name of the business unit.
  • Title: Calculation Currency Conversion Rate
    Read Only: true
    The exchange rate to convert from source currency to processing currency.
  • 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.
  • Title: Change Indicator
    Read Only: true
    Maximum Length: 1
    Indicates if the credit is new or modified.
  • Title: Classification Rule
    Read Only: true
    The unique identifier of the classification rule used to assign the credit category, to the credit.
  • 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.
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • 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.
  • Read Only: true
    The date when the record was created.
  • Title: Credit Amount
    The credit amount in processing currency.
  • 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.
  • 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.
  • Title: Credit Receiver
    The unique identifier of the participant who owns the credit.
  • Title: Credit ID
    Read Only: true
    The unique identifier of the credit.
  • Title: Credit Rule
    Read Only: true
    The unique record identifier of the credit rule used to create the credit.
  • Title: Credit Type
    Read Only: true
    Maximum Length: 30
    Indicates the nature of the credit such as Direct, Indirect or Summarized.
  • Title: Direct Participant
    Read Only: true
    The unique identifier of the participant who is directly involved in the closure transaction.
  • Read Only: true
    The unique identifier of the credit rule used to create the direct credit that corresponds to this credit.
  • 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.
  • Read Only: true
    Maximum Length: 80
    The reason explaining why the credit is in error status.
  • 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.
  • Title: Hold
    Maximum Length: 1
    Indicates whether the application must exclude the transaction from processing further.
  • Title: Home Currency Conversion Rate
    Read Only: true
    The exchange rate to convert from processing currency to home currency.
  • Title: Home Credit Amount
    Read Only: true
    The transaction amount in participant's home currency.
  • Title: Home Currency
    Read Only: true
    Maximum Length: 15
    The code indicating the participant's home currency.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • 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.
  • Title: Operating Currency Conversion Rate
    Read Only: true
    The exchange rate to convert from source currency to operating currency.
  • Title: Operating Credit Amount
    Read Only: true
    The credit amount in business unit operating currency.
  • Title: Operating Currency
    Read Only: true
    Maximum Length: 10
    The code indicating the functional currency of the business unit.
  • 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.
  • 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.
  • 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.
  • Title: Role
    The unique identifier of the role assigned to the credit receiver.
  • Title: Rollup Date
    Read Only: true
    The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
  • 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.
  • Title: Source BU
    Read Only: true
    The unique identifier of the source transaction business unit.
  • Title: Source Credit Amount
    Read Only: true
    The credit amount in source currency of the transaction.
  • Title: Source Credit ID
    The unique identifier of the source credit or the summarized credit record from which the rollup credit is generated.
  • 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.
  • Title: Source Transaction Amount
    Read Only: true
    The transaction amount in source currency of the transaction.
  • Title: Split Percent
    The percent of the transaction amount that the credit receiver received.
  • Read Only: true
    The unique identifier of the summary credit to which the credit is associated.
  • Title: Transaction Amount
    Read Only: true
    The transaction amount in processing currency.
  • Title: Transaction ID
    Read Only: true
    The unique identifier of the transaction.
  • 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.
  • Title: Quantity
    Read Only: true
    The quantity for the transaction line item.
  • 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 : incentiveCompensationTransactions-TransactionsDFF-item-response
Type: object
Show Source
Links
BusinessUnitVVO
The following properties are defined on the LOV link relation:
  • Source Attribute: BusinessUnitId; Target Attribute: OrganizationId
  • Display Attribute: Name
Credits
Parameters:
  • TransactionId: $request.path.TransactionId
The credits resource is used to view, create, and update the credits for a transaction.
TransactionsDFF
Parameters:
  • TransactionId: $request.path.TransactionId
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.
Back to Top

Examples

The following example shows how to update an incentive compensation transaction by submitting a PATCH 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/100000015464011

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
    "AdjustmentComments": "Transaction updated by REST WS TEST"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "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": "Manual update",
  "ReasonCode": "OTHER",
  "ObjectStatus": "OBSOLETED",
  "ErrorCode": "",
  "ErrorMeaning": null,
  "AdjustmentStatus": "ADJUSTED",
  "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": "OIC_MGR_OPERATIONS",
  "LastUpdateDate": "2020-06-16T08:21:46+00:00",
  "LastUpdateLogin": "A6BFDADFB661D1A4E0535498F20AE4CC",
  "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    },
    {
      "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.com/fscmRestApi/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"
    }
  ]
}
Back to Top