Get a credit category
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}
Request
Path Parameters
-
PerformanceMeasureCreditCategoryId(required): integer(int64)
The unique identifier representing the credit category for the performance measure.
-
PerformanceMeasureId(required): integer(int64)
The unique identifier for the performance measure.
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CreditCategoryId: integer
(int64)
Title:
Credit Category ID
The unique identifier of the credit category. -
CreditCategoryName: string
Title:
Credit Category Name
Maximum Length:160
The name of the credit category. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PerformanceMeasureCreditCategoriesUpdateFlag: boolean
Read Only:
true
Default Value:false
Indicates whether a credit category can be updated. -
PerformanceMeasureCreditCategoryId: integer
(int64)
The unique identifier representing the credit category for the performance measure.
-
performanceMeasureCreditFactors: array
Credit Factors
Title:
Credit Factors
The credit factors resource is used to view, create, update, and delete the credit factor or earning factor within a credit category associated to a performance measure. The credit factor is used to apply an uplift to the sales credits at the credit category level for a period of time. The earning factor is used to apply an uplift to the sales earning at the credit category level for a period of time. -
PerformanceMeasureId: integer
(int64)
Title:
Performance Measure ID
The unique identifier of a performance measure. -
PerformanceMeasureName: string
Title:
Performance Measure Name
Read Only:true
Maximum Length:80
The name of the performance measure, which is an indicator used to measure the progress toward a specified outcome or goal. -
performanceMeasureTransactionFactors: array
Transaction Factors
Title:
Transaction Factors
The transaction factors resource is used to view, create, update, and delete the transaction factor associated with a performance measure credit category. A transaction factor is used to decide the influence of the sales stage (Invoicing, PO stage, etc.) on the sales credit.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Credit Factors
Type:
array
Title:
Credit Factors
The credit factors resource is used to view, create, update, and delete the credit factor or earning factor within a credit category associated to a performance measure.
The credit factor is used to apply an uplift to the sales credits at the credit category level for a period of time.
The earning factor is used to apply an uplift to the sales earning at the credit category level for a period of time.
Show Source
Nested Schema : Transaction Factors
Type:
array
Title:
Transaction Factors
The transaction factors resource is used to view, create, update, and delete the transaction factor associated with a performance measure credit category. A transaction factor is used to decide the influence of the sales stage (Invoicing, PO stage, etc.) on the sales credit.
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 : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureCreditFactors-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CreditFactor: number
Title:
Credit Factor
Default Value:100
The percentage of uplift applied to transaction credits that is specified at the credit category level, for a period of time. Helps to boost the attainment for a period of time, for certain credit categories. The default value is 100. -
EarningFactor: number
Title:
Earning Factor
Default Value:100
The percentage of uplift applied to earnings that is specified at the credit category level, for a period of time. Helps to boost the earnings for a period of time, for certain credit categories. Default value is 100. -
EndDate: string
(date)
Title:
End Date
The date when the credit factor and earning factor provided for a credit category within a performance measure become inactive. The format is yyyy-mm-dd. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PerformanceMeasureCreditCategoryId: integer
(int64)
The unique identifier of the credit category for the performance measure.
-
PerformanceMeasureCreditFactorId: integer
(int64)
The unique identifier of the credit factors for the performance measure.
-
StartDate: string
(date)
Title:
Start Date
The date when the credit factor and earning factor provided for a credit category within a performance measure become active. The format is yyyy-mm-dd.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureTransactionFactors-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CreditCategoryId: integer
(int64)
The unique identifier for the credit category record.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PerformanceMeasureCreditCategoryId: integer
(int64)
The unique identifier of the credit category for the performance measure.
-
PerformanceMeasureId: integer
(int64)
The unique identifier for the performance measure record.
-
PerformanceMeasureTransactionFactorId: integer
(int64)
The unique identifier for the transaction factor records for the performance measure.
-
TransactionFactor: number
Title:
Factor
Default Value:100
A percentage of transaction amount considered for calculation. It helps to stage sales credit over the life of a sale, assigning percentages to important events in the sales process such as order, invoice, and payment. The default value is 100. -
TransactionType: string
Title:
Transaction Type
Maximum Length:30
The type of transaction. Possible values include CLAWBACK for claw back transaction type, CUSTOMER_SATISFACTION for customer satisfaction transaction type, GRP where the application creates a group by record during the calculation process, INVOICE for invoice transaction type, MANUAL for manual transaction type, ORDER for order transaction type, PAYMENT for payment transaction type, RAM_ADJUSTMENT for accounts receivable revenue adjustment transaction type, and ITD, where the application creates an Interval-to-date record during the calculation process. A list of acceptable values is defined in the lookup CN_TP_TRANSACTION_TYPE. Review and update the value for this attribute 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
Links
- CreditCategoryVO
-
The list of values containing the names of the credit categories given by the user.
The following properties are defined on the LOV link relation:- Source Attribute: CreditCategoryName; Target Attribute: Name
- Display Attribute: Name
- performanceMeasureCreditFactors
-
Parameters:
- PerformanceMeasureCreditCategoryId:
$request.path.PerformanceMeasureCreditCategoryId
- PerformanceMeasureId:
$request.path.PerformanceMeasureId
The credit factors resource is used to view, create, update, and delete the credit factor or earning factor within a credit category associated to a performance measure. The credit factor is used to apply an uplift to the sales credits at the credit category level for a period of time. The earning factor is used to apply an uplift to the sales earning at the credit category level for a period of time. - PerformanceMeasureCreditCategoryId:
- performanceMeasureTransactionFactors
-
Parameters:
- PerformanceMeasureCreditCategoryId:
$request.path.PerformanceMeasureCreditCategoryId
- PerformanceMeasureId:
$request.path.PerformanceMeasureId
The transaction factors resource is used to view, create, update, and delete the transaction factor associated with a performance measure credit category. A transaction factor is used to decide the influence of the sales stage (Invoicing, PO stage, etc.) on the sales credit. - PerformanceMeasureCreditCategoryId: