Jump to

• Request
• Response
• Examples

Get all credits

get

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

Request

Path Parameters

• TransactionId(required): integer(int64)
  The unique identifier of the transaction.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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:
  
  

  • PrimaryKey: Finds the credits for a transaction with the specified record identifier.
    Finder Variables:
    • CreditId; integer; The unique identifier of the credit.
• 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 credit.
  • AdjustmentStatus; string; 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; The unique identifier of the business unit.
  • BusinessUnitName; string; The name of the business unit.
  • CalculationConversionRate; number; The exchange rate to convert from source currency to processing currency.
  • CalculationCurrencyCode; string; 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; Indicates if the credit is new or modified.
  • ClsfnRuleId; integer; The unique identifier of the classification rule used to assign the credit category, to the credit.
  • CollectionStatus; string; 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; The user who created the record.
  • CreatedDuring; string; 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; The date when the record was created.
  • CreditAmount; number; The credit amount in processing currency.
  • CreditCategoryId; integer; 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; The date the credit receiver should receive credit. The date is used to determine the credit receivers when processing the credit rules against transactions.
  • CreditId; integer; The unique identifier of the credit.
  • CreditRuleId; integer; The unique record identifier of the credit rule used to create the credit.
  • CreditType; string; Indicates the nature of the credit such as Direct, Indirect or Summarized.
  • CreditedParticipantId; integer; The unique identifier of the participant who owns the credit.
  • DirectParticipantId; integer; The unique identifier of the participant who is directly involved in the closure transaction.
  • DirectRuleId; integer; The unique identifier of the credit rule used to create the direct credit that corresponds to this credit.
  • ErrorCode; string; 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; 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.
  • HoldFlag; boolean; Indicates whether the application must exclude the transaction from processing further.
  • 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; The code indicating the participant's home currency.
  • 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.
  • ObjectStatus; string; 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; The exchange rate to convert from source currency to operating currency.
  • OperatingCreditAmount; number; The credit amount in business unit operating currency.
  • OperatingCurrency; string; The code indicating the functional currency of the business unit.
  • ProcessCode; string; 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; 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; 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; The unique identifier of the role assigned to the credit receiver.
  • RollupDate; string; The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
  • RollupLevel; integer; The level of the rollup rule in the rollup hierarchy. This value is applicable in case of rollup credits.
  • SourceBusinessUnitId; integer; The unique identifier of the source transaction business unit.
  • SourceCreditAmount; number; The credit amount in source currency of the transaction.
  • SourceCreditId; integer; The unique identifier of the source credit or the summarized credit record from which the rollup credit is generated.
  • SourceCurrencyCode; string; 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; The percent of the transaction amount that the credit receiver received.
  • SummaryCreditId; integer; The unique identifier of the summary credit to which the credit is associated.
  • TransactionAmount; number; The transaction amount in processing 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 order number.
  • TransactionQuantity; number; The quantity for 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.
• 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 Top

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.

Body ()

Root Schema : incentiveCompensationTransactions-Credits

Type: object

Show Source

• 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.

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object incentiveCompensationTransactions-Credits-item-response

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : incentiveCompensationTransactions-Credits-item-response

Type: object

Show Source

• 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.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• 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.

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

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

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

Back to Top

Examples

The following example shows how to get all credits for incentive compensation transaction 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/10001/child/Credits

Example of Response Body

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

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

Back to Top