Jump to

• Request
• Response
• Examples

Update a transaction factor

patch

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureTransactionFactors/{PerformanceMeasureTransactionFactorId}

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.
• PerformanceMeasureTransactionFactorId(required): integer(int64)
  The unique identifier for the transaction factor records 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: 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.
• 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.

{
    "type":"object",
    "properties":{
        "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"
        },
        "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"
            }
        },
        "PerformanceMeasureCreditCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the credit category for the performance measure.",
            "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-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"
    }
}

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

Links

CnLookupTransactionType

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_TP_TRANSACTION_TYPE

The list of values indicating the type of transaction. Possible values include CLAWBACK for claw back transaction type, CUSTOMER_SATISFACTION for customer satisfaction transaction type, GRP when 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 when the application creates an Interval-to-date record during the calculation process.

The following properties are defined on the LOV link relation:

• Source Attribute: TransactionType; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top

Examples

The following example shows how to update a transaction factor by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/300100090511017/child/performanceMeasureCreditCategories/300100090511047/child/performanceMeasureTransactionFactors/300100090511049

Example of Request Body

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

{
"TransactionFactor" : 90
}

Example of Response Body

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

{
  "PerformanceMeasureTransactionFactorId": 300100090511049,
  "PerformanceMeasureCreditCategoryId": 300100090511047,
  "PerformanceMeasureId": 300100090511017,
  "CreditCategoryId": 300100014492923,
  "TransactionFactor": 90,
  "TransactionType": "MANUAL",
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2017-06-08T11:49:55-07:00",
  "LastUpdateDate": "2017-06-08T11:51:24-07:00",
  "LastUpdateLogin": "516E508C5BC4377FE0532DD6F00A0214",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "links": [
   ...
  ]
}

Back to Top