Jump to

• Request
• Response

Update a carried interest penalty

patch

/fscmRestApi/resources/11.13.18.05/carriedInterestPenalties/{penaltyId}

Request

Path Parameters

• penaltyId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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

• penaltyDescription: string
  Title: Description

  Maximum Length: 240

  The description of the carried interest penalty.
• penaltyPercentages: array Penalty Percentages
  Title: Penalty Percentages

  The penalty percentages resource is used to view, create, update, or delete penalty percentages for a carried interest penalty.
• status: string
  Title: Status

  Maximum Length: 80

  The status of the carried interest penalty.

{
    "type":"object",
    "properties":{
        "penaltyDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the carried interest penalty.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "penaltyPercentages":{
            "title":"Penalty Percentages",
            "type":"array",
            "description":"The penalty percentages resource is used to view, create, update, or delete penalty percentages for a carried interest penalty.",
            "items":{
                "$ref":"#/components/schemas/carriedInterestPenalties-penaltyPercentages-item-patch-request"
            }
        },
        "status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the carried interest penalty.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeStatus"
                ]
            }
        }
    }
}

Nested Schema : Penalty Percentages

Type: array

Title: Penalty Percentages

The penalty percentages resource is used to view, create, update, or delete penalty percentages for a carried interest penalty.

Show Source

• Array of: object schema

{
    "title":"Penalty Percentages",
    "type":"array",
    "description":"The penalty percentages resource is used to view, create, update, or delete penalty percentages for a carried interest penalty.",
    "items":{
        "$ref":"#/components/schemas/carriedInterestPenalties-penaltyPercentages-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• accountSet: string
  Title: Account Set

  Maximum Length: 80

  The unique name of the account set.
• category: string
  Title: Category

  Maximum Length: 80

  The category of the penalty percentage.
• name: string
  Title: Name

  Maximum Length: 30

  The name of the penalty percentage.
• percentage: number
  Title: Percentage

  The percentage used in the penalty calculation.
• projectSet: string
  Title: Project Set

  Maximum Length: 80

  The name of the project set.
• recalculatePenaltyFlag: boolean
  Title: Recalculate

  Maximum Length: 1

  A flag indicating whether the penalty percentage requires recalculation.

{
    "type":"object",
    "properties":{
        "accountSet":{
            "title":"Account Set",
            "maxLength":80,
            "type":"string",
            "description":"The unique name of the account set.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "accountSetIdAS"
                ]
            }
        },
        "category":{
            "title":"Category",
            "maxLength":80,
            "type":"string",
            "description":"The category of the penalty percentage.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeCategory"
                ]
            }
        },
        "name":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the penalty percentage.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "percentage":{
            "title":"Percentage",
            "type":"number",
            "description":"The percentage used in the penalty calculation.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "projectSet":{
            "title":"Project Set",
            "maxLength":80,
            "type":"string",
            "description":"The name of the project set.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "projectSetIdPS"
                ]
            }
        },
        "recalculatePenaltyFlag":{
            "title":"Recalculate",
            "maxLength":1,
            "type":"boolean",
            "description":"A flag indicating whether the penalty percentage requires recalculation.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_WHEREATTR_ADDL":"LookupType",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.fnd.applcore.lookups.model.publicView.CommonLookupPVO",
                "fnd:FND_AUDIT_VALUE_ADDL":"'YES_NO_NOT_SPECIFIED'",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Meaning",
                "fnd:FND_AUDIT_FK_WHEREATTR":"LookupCode"
            }
        }
    }
}

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 : carriedInterestPenalties-item-response

Type: object

Show Source

• agreement: string
  Title: Agreement

  Maximum Length: 30

  The name of the carried interest agreement.
• agreementDescription: string
  Title: Description

  Read Only: true

  The description of the carried interest agreement.
• consentingStakeholder: string
  Title: Consenting Stakeholder

  Maximum Length: 30

  The name of the consenting stakeholder assuming the interest of a nonconsenting stakeholder.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the resource item.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the resource item was created.
• jointVenture: string
  Title: Joint Venture

  Maximum Length: 30

  The name of the joint venture.
• jointVentureDescription: string
  Title: Description

  Read Only: true

  The description of the joint venture.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the resource item was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the resource item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• nonConsentingStakeholder: string
  Title: Nonconsenting Stakeholder

  Maximum Length: 30

  The name of the nonconsenting stakeholder.
• penalty: string
  Title: Penalty Definition

  Maximum Length: 30

  The unique name of the carried interest penalty.
• penaltyDescription: string
  Title: Description

  Maximum Length: 240

  The description of the carried interest penalty.
• penaltyId: integer (int64)
  Title: Penalty Definition ID

  Read Only: true

  The unique identifier of the carried interest penalty.
• penaltyPercentages: array Penalty Percentages
  Title: Penalty Percentages

  The penalty percentages resource is used to view, create, update, or delete penalty percentages for a carried interest penalty.
• selectionMethod: string
  Title: Selection Method

  Maximum Length: 80

  The selection method of the carried interest penalty.
• status: string
  Title: Status

  Maximum Length: 80

  The status of the carried interest penalty.

{
    "type":"object",
    "properties":{
        "agreement":{
            "title":"Agreement",
            "maxLength":30,
            "type":"string",
            "description":"The name of the carried interest agreement.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "agreementIdCA"
                ]
            },
            "x-queryable":true
        },
        "agreementDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the carried interest agreement.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "agreementIdCA"
                ]
            },
            "x-queryable":true
        },
        "consentingStakeholder":{
            "title":"Consenting Stakeholder",
            "maxLength":30,
            "type":"string",
            "description":"The name of the consenting stakeholder assuming the interest of a nonconsenting stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "stakeholderIdCS"
                ]
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resource item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVenture":{
            "title":"Joint Venture",
            "maxLength":30,
            "type":"string",
            "description":"The name of the joint venture.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "jointVentureIdJV"
                ]
            },
            "x-queryable":true
        },
        "jointVentureDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "jointVentureIdJV"
                ]
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "nonConsentingStakeholder":{
            "title":"Nonconsenting Stakeholder",
            "maxLength":30,
            "type":"string",
            "description":"The name of the nonconsenting stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "stakeholderIdNCS"
                ]
            },
            "x-queryable":true
        },
        "penalty":{
            "title":"Penalty Definition",
            "maxLength":30,
            "type":"string",
            "description":"The unique name of the carried interest penalty.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "penaltyDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the carried interest penalty.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "penaltyId":{
            "title":"Penalty Definition ID",
            "type":"integer",
            "description":"The unique identifier of the carried interest penalty.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "penaltyPercentages":{
            "title":"Penalty Percentages",
            "type":"array",
            "description":"The penalty percentages resource is used to view, create, update, or delete penalty percentages for a carried interest penalty.",
            "items":{
                "$ref":"#/components/schemas/carriedInterestPenalties-penaltyPercentages-item-response"
            }
        },
        "selectionMethod":{
            "title":"Selection Method",
            "maxLength":80,
            "type":"string",
            "description":"The selection method of the carried interest penalty.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeSelectionMethod"
                ]
            },
            "x-queryable":true
        },
        "status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the carried interest penalty.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeStatus"
                ]
            },
            "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 : Penalty Percentages

Type: array

Title: Penalty Percentages

The penalty percentages resource is used to view, create, update, or delete penalty percentages for a carried interest penalty.

Show Source

• Array of: object carriedInterestPenalties-penaltyPercentages-item-response

{
    "title":"Penalty Percentages",
    "type":"array",
    "description":"The penalty percentages resource is used to view, create, update, or delete penalty percentages for a carried interest penalty.",
    "items":{
        "$ref":"#/components/schemas/carriedInterestPenalties-penaltyPercentages-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 : carriedInterestPenalties-penaltyPercentages-item-response

Type: object

Show Source

• accountSet: string
  Title: Account Set

  Maximum Length: 80

  The unique name of the account set.
• accountSetDescription: string
  Title: Description

  Read Only: true

  The description of the account set.
• category: string
  Title: Category

  Maximum Length: 80

  The category of the penalty percentage.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the resource item.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the resource item was created.
• distributionsExistFlag: boolean
  Title: Distributions Exist

  Read Only: true

  Maximum Length: 1

  Indicates whether carried interest distributions have been assigned the carried interest penalty percentage.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the resource item was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the resource item.
• lineNumber: integer (int64)
  Title: Line Number

  The line number of the penalty percentage
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• name: string
  Title: Name

  Maximum Length: 30

  The name of the penalty percentage.
• percentage: number
  Title: Percentage

  The percentage used in the penalty calculation.
• percentageId: integer (int64)
  Title: Penalty Percentage ID

  Read Only: true

  The unique identifier of the penalty percentage.
• projectSet: string
  Title: Project Set

  Maximum Length: 80

  The name of the project set.
• projectSetDescription: string
  Title: Description

  Read Only: true

  The description of the project set.
• recalculatePenaltyFlag: boolean
  Title: Recalculate

  Maximum Length: 1

  A flag indicating whether the penalty percentage requires recalculation.

{
    "type":"object",
    "properties":{
        "accountSet":{
            "title":"Account Set",
            "maxLength":80,
            "type":"string",
            "description":"The unique name of the account set.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "accountSetIdAS"
                ]
            },
            "x-queryable":true
        },
        "accountSetDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the account set.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "accountSetIdAS"
                ]
            },
            "x-queryable":true
        },
        "category":{
            "title":"Category",
            "maxLength":80,
            "type":"string",
            "description":"The category of the penalty percentage.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeCategory"
                ]
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resource item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionsExistFlag":{
            "title":"Distributions Exist",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether carried interest distributions have been assigned the carried interest penalty percentage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"The line number of the penalty percentage",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "name":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the penalty percentage.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "percentage":{
            "title":"Percentage",
            "type":"number",
            "description":"The percentage used in the penalty calculation.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "percentageId":{
            "title":"Penalty Percentage ID",
            "type":"integer",
            "description":"The unique identifier of the penalty percentage.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "projectSet":{
            "title":"Project Set",
            "maxLength":80,
            "type":"string",
            "description":"The name of the project set.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "projectSetIdPS"
                ]
            },
            "x-queryable":true
        },
        "projectSetDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the project set.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "projectSetIdPS"
                ]
            },
            "x-queryable":true
        },
        "recalculatePenaltyFlag":{
            "title":"Recalculate",
            "maxLength":1,
            "type":"boolean",
            "description":"A flag indicating whether the penalty percentage requires recalculation.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_WHEREATTR_ADDL":"LookupType",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.fnd.applcore.lookups.model.publicView.CommonLookupPVO",
                "fnd:FND_AUDIT_VALUE_ADDL":"'YES_NO_NOT_SPECIFIED'",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Meaning",
                "fnd:FND_AUDIT_FK_WHEREATTR":"LookupCode"
            },
            "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

penaltyPercentages

Operation: /fscmRestApi/resources/11.13.18.05/carriedInterestPenalties/{penaltyId}/child/penaltyPercentages

Parameters:

• penaltyId: $request.path.penaltyId

The penalty percentages resource is used to view, create, update, or delete penalty percentages for a carried interest penalty.

Back to Top