Jump to

• Request
• Response

Create a credit category

post

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories

Request

Path Parameters

• PerformanceMeasureId(required): integer(int64)
  The unique identifier for the performance measure.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CreditCategoryId(required): integer (int64)
  Title: Credit Category ID

  The unique identifier of the credit category.
• CreditCategoryName(required): string
  Title: Credit Category Name

  Maximum Length: 160

  The name of the credit category.
• 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(required): integer (int64)
  Title: Performance Measure ID

  The unique identifier of a performance measure.
• 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.

{
    "required":[
        "CreditCategoryId",
        "CreditCategoryName",
        "PerformanceMeasureId"
    ],
    "type":"object",
    "properties":{
        "CreditCategoryId":{
            "title":"Credit Category ID",
            "type":"integer",
            "description":"The unique identifier of the credit category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "performanceMeasureTransactionFactors":{
            "title":"Transaction Factors",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureTransactionFactors-item-post-request"
            }
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The unique identifier of a performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PerformanceMeasureCreditCategoryId":{
            "type":"integer",
            "description":"The unique identifier representing the credit category for the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreditCategoryName":{
            "title":"Credit Category Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name of the credit category.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "performanceMeasureCreditFactors":{
            "title":"Credit Factors",
            "type":"array",
            "description":"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.\nThe credit factor is used to apply an uplift to the sales credits at the credit category level for a period of time. \nThe earning factor is used to apply an uplift to the sales earning at the credit category level for a period of time.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureCreditFactors-item-post-request"
            }
        }
    }
}

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

• Array of: object incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureCreditFactors-item-post-request

{
    "title":"Credit Factors",
    "type":"array",
    "description":"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.\nThe credit factor is used to apply an uplift to the sales credits at the credit category level for a period of time. \nThe earning factor is used to apply an uplift to the sales earning at the credit category level for a period of time.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureCreditFactors-item-post-request"
    }
}

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

• Array of: object incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureTransactionFactors-item-post-request

{
    "title":"Transaction Factors",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureTransactionFactors-item-post-request"
    }
}

Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureCreditFactors-item-post-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":false
        },
        "PerformanceMeasureCreditFactorId":{
            "type":"integer",
            "description":"The unique identifier of the credit factors for the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PerformanceMeasureCreditCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the credit category for the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreditFactor":{
            "title":"Credit Factor",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "default":"100"
        },
        "EarningFactor":{
            "title":"Earning Factor",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "default":"100"
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true
        }
    }
}

Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureTransactionFactors-item-post-request

Type: object

Show Source

• CreditCategoryId: integer (int64)
  The unique identifier for the credit category record.
• 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.

{
    "type":"object",
    "properties":{
        "PerformanceMeasureTransactionFactorId":{
            "type":"integer",
            "description":"The unique identifier for the transaction factor records for the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionFactor":{
            "title":"Factor",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "default":"100"
        },
        "PerformanceMeasureCreditCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the credit category for the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreditCategoryId":{
            "type":"integer",
            "description":"The unique identifier for the credit category record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier for the performance measure record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureName":{
            "title":"Performance Measure Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the performance measure, which is an indicator used to measure the progress toward a specified outcome or goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "performanceMeasureTransactionFactors":{
            "title":"Transaction Factors",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureTransactionFactors-item-response"
            }
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The unique identifier of a performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "performanceMeasureCreditFactors":{
            "title":"Credit Factors",
            "type":"array",
            "description":"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.\nThe credit factor is used to apply an uplift to the sales credits at the credit category level for a period of time. \nThe earning factor is used to apply an uplift to the sales earning at the credit category level for a period of time.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureCreditFactors-item-response"
            }
        },
        "PerformanceMeasureCreditCategoryId":{
            "type":"integer",
            "description":"The unique identifier representing the credit category for the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PerformanceMeasureCreditCategoriesUpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether a credit category can be updated.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditCategoryId":{
            "title":"Credit Category ID",
            "type":"integer",
            "description":"The unique identifier of the credit category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreditCategoryName":{
            "title":"Credit Category Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name of the credit category.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "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 : 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

• Array of: object incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureCreditFactors-item-response

{
    "title":"Credit Factors",
    "type":"array",
    "description":"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.\nThe credit factor is used to apply an uplift to the sales credits at the credit category level for a period of time. \nThe earning factor is used to apply an uplift to the sales earning at the credit category level for a period of time.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureCreditFactors-item-response"
    }
}

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

• Array of: object incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureTransactionFactors-item-response

{
    "title":"Transaction Factors",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureTransactionFactors-item-response"
    }
}

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."
        }
    }
}

Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureCreditFactors-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureCreditFactorId":{
            "type":"integer",
            "description":"The unique identifier of the credit factors for the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PerformanceMeasureCreditCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the credit category for the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditFactor":{
            "title":"Credit Factor",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "default":"100",
            "x-queryable":true
        },
        "EarningFactor":{
            "title":"Earning Factor",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "default":"100",
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "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 : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureTransactionFactors-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureTransactionFactorId":{
            "type":"integer",
            "description":"The unique identifier for the transaction factor records for the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionFactor":{
            "title":"Factor",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "default":"100",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureCreditCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the credit category for the performance measure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditCategoryId":{
            "type":"integer",
            "description":"The unique identifier for the credit category record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier for the performance measure record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "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"
    }
}

Links

CreditCategoryVO

Operation: /fscmRestApi/resources/11.13.18.05/creditCategories

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

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/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.

performanceMeasureTransactionFactors

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/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.

Back to Top