Update a payment plan
patch
/fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}
Request
Path Parameters
-
PaymentPlanId(required): integer(int64)
The unique identifier of the payment plan.
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
Root Schema : schema
Type:
Show Source
object
-
DelayRecoveryFlag: boolean
Title:
Recovery Start Option
Maximum Length:1
Default Value:false
Indicates whether recovering draw amounts should be delayed for several months after being paid. Valid values are Y and N. If providing the value "Y" to enable delayed recovery, then provide the recovery start and optionally provide a recovery end. If providing the value "N", then the recovery starts immediately in the next subsequent payment. The default value is "N". -
Description: string
Title:
Description
Maximum Length:1000
A brief description of the payment plan. -
DrawEnd: string
Title:
Draw End
Maximum Length:30
The code indicating when the draw calculation for the participant should end. The value is used to determine the relative date after the payment plan assignment start date. Possible values are "-1", to stop the draw after 3 months, "-2", to stop the draw after 6 months, "-3", to stop the draw after 9 months, and "-4", to stop the draw after 12 months. -
EndDate: string
(date)
Title:
End Date
The date when the payment plan becomes inactive. The acceptable format is yyyy-mm-dd. -
FlatMinimumAmount: number
Title:
Flat Minimum Amount to Pay Participant
The minimum amount to pay the participant per the payment interval. The payment process creates a payment adjustment when the total earnings for the pay period are less than the minimum amount. This payment adjustment is often referred to as a draw or a guaranteed minimum. -
MaximumAmount: number
Title:
Maximum Payment
The maximum amount to pay the participant for the payment interval. The payment process creates a payment adjustment when the total earnings for the pay period are more than the maximum amount. This payment adjustment is often referred to as a cap. -
MinimumRecoverFlag: boolean
Title:
Minimum Recovery
Maximum Length:1
Default Value:true
Indicates whether the draw amounts paid to the participant should be recovered in subsequent pay periods. When enabled, the payment process deducts from the payment of earnings over a period of time until the full draw amount is recovered. Valid values are Y and N. The default value is Y. -
OrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit to which the payment plan belongs. Review the business unit ID for a business unit using the Setup and Maintenance, Define Business Units task. If the Business Unit ID column is not displayed, then click the View menu to add the Business Unit ID column. -
PayExcessLaterFlag: boolean
Title:
Carry forward maximum
Maximum Length:1
Default Value:false
Indicates whether the maximum payment adjustment should be carried forward to offset earning short falls in subsequent pay periods. Valid values are Y and N. The default value is N. -
PayIntervalTypeId: integer
(int64)
Title:
Payment Interval
Default Value:-1000
The unique identifier of the business unit interval that defines the frequency of the payment plan draw and cap adjustments. Intervals include period, quarter, annual, and semi annual. The default value is the identifier "-1000" for the period interval. Additional intervals are defined for the business unit using the Setup and Maintenance, Manage Intervals task. Use the finder for this resource to get the unique identifiers for the intervals. -
PaymentPlanAssignments: array
Payment Plans Assignments
Title:
Payment Plans Assignments
The assignments resource is used to view, create, update, or delete an incentive compensation assignment for a payment plan. -
PaymentPlanCategory: string
Title:
Payment Plan Category
Maximum Length:30
Default Value:STANDARD
The code indicating which plan components to apply the draw and cap. The default value is STANDARD. A list of acceptable values is defined in the lookup CN_PAYMENT_PLAN_CATEGORY. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
PaymentPlanName: string
Title:
Name
Maximum Length:160
The name of the payment plan. -
PaymentPlanRoles: array
Payment Plans Roles
Title:
Payment Plans Roles
The roles resource is used to view, create, update, or delete an incentive compensation role assignment for a payment plan. -
RecoverExpressionId: integer
(int64)
Title:
Recovery Method
Default Value:-1001
The unique identifier of the recover expression. Recover expression determines which earnings can be deducted from, to recover a paid draw. The default, and only, valid value is "-1001" to recover against all earnings. -
RecoveryEndIntervalId: integer
(int32)
Title:
Recovery End
The code indicating when draw recovery should end. This value is optional if delayed recovery is enabled. The value is used to determine the relative date after the delayed recovery start. Possible values are "-1" to stop the recovery after 3 months, "-2" to stop the recovery after 6 months, "-3" to stop the recovery after 9 months, and "-4" to stop the recovery after 12 months. -
RecoveryStartIntervalId: integer
(int32)
Title:
Recovery Start
The code indicating when the delayed recovery period ends and the recovery processing should start. This value is required if delayed recovery is enabled. The value is used to determine the relative date after the payment plan assignment start date. Possible values are "-1" to start the recovery after 3 months, "-2" to start the recovery after 6 months, "-3" to start the recovery after 9 months, and "-4" to start the recovery after 12 months. -
StartDate: string
(date)
Title:
Start Date
The date when the payment plan becomes active. The acceptable format is yyyy-mm-dd.
Nested Schema : Payment Plans Assignments
Type:
array
Title:
Payment Plans Assignments
The assignments resource is used to view, create, update, or delete an incentive compensation assignment for a payment plan.
Show Source
Nested Schema : Payment Plans Roles
Type:
array
Title:
Payment Plans Roles
The roles resource is used to view, create, update, or delete an incentive compensation role assignment for a payment plan.
Show Source
Nested Schema : incentiveCompensationPaymentPlans-PaymentPlanAssignments-item-patch-request
Type:
Show Source
object
-
EndDate: string
(date)
Title:
End Date
The date when the assignment for a payment plan becomes inactive. The acceptable format is yyyy-mm-dd. -
FlatMinimumAmount: number
Title:
Flat Minimum Amount to Pay Participant
The minimum amount to pay the participant per the payment interval. The payment process creates a payment adjustment when the total earnings for the pay period are less than the minimum amount. This payment adjustment is often referred to as a draw or a guaranteed minimum. -
MaximumAmount: number
Title:
Maximum Payment
The maximum amount to pay the participant for the payment interval. The payment process creates a payment adjustment when the total earnings for the pay period are more than the maximum amount. This payment adjustment is often referred to as a cap. -
RecoveryEndDate: string
(date)
Title:
Recovery End Date
The date when the recovery of draw owed by the participant ends. -
RecoveryStartDate: string
(date)
Title:
Recovery Start Date
The date when the recovery of draw owed by the participant starts. -
StartDate: string
(date)
Title:
Start Date
The date when the assignment becomes active. The acceptable format is yyyy-mm-dd.
Nested Schema : incentiveCompensationPaymentPlans-PaymentPlanRoles-item-patch-request
Type:
Show Source
object
-
EndDate: string
(date)
Title:
End Date
The date when the role assignment for a payment plan becomes inactive. The acceptable format is yyyy-mm-dd. The date must be equal to or earlier than the payment plan end date. -
PaymentPlanId: integer
(int64)
The unique identifier of the payment plan.
-
RoleId: integer
(int64)
The unique identifier off the payment plan role.
-
StartDate: string
(date)
Title:
Start Date
The date when the role assignment for a payment plan becomes active. The acceptable format is yyyy-mm-dd. The date must be equal to or later than the payment plan start date.
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.
Root Schema : incentiveCompensationPaymentPlans-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the payment plan. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the payment plan is created. -
DelayRecoveryFlag: boolean
Title:
Recovery Start Option
Maximum Length:1
Default Value:false
Indicates whether recovering draw amounts should be delayed for several months after being paid. Valid values are Y and N. If providing the value "Y" to enable delayed recovery, then provide the recovery start and optionally provide a recovery end. If providing the value "N", then the recovery starts immediately in the next subsequent payment. The default value is "N". -
Description: string
Title:
Description
Maximum Length:1000
A brief description of the payment plan. -
DrawEnd: string
Title:
Draw End
Maximum Length:30
The code indicating when the draw calculation for the participant should end. The value is used to determine the relative date after the payment plan assignment start date. Possible values are "-1", to stop the draw after 3 months, "-2", to stop the draw after 6 months, "-3", to stop the draw after 9 months, and "-4", to stop the draw after 12 months. -
EndDate: string
(date)
Title:
End Date
The date when the payment plan becomes inactive. The acceptable format is yyyy-mm-dd. -
FlatMinimumAmount: number
Title:
Flat Minimum Amount to Pay Participant
The minimum amount to pay the participant per the payment interval. The payment process creates a payment adjustment when the total earnings for the pay period are less than the minimum amount. This payment adjustment is often referred to as a draw or a guaranteed minimum. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the payment plan was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the payment plan. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumAmount: number
Title:
Maximum Payment
The maximum amount to pay the participant for the payment interval. The payment process creates a payment adjustment when the total earnings for the pay period are more than the maximum amount. This payment adjustment is often referred to as a cap. -
MinimumRecoverFlag: boolean
Title:
Minimum Recovery
Maximum Length:1
Default Value:true
Indicates whether the draw amounts paid to the participant should be recovered in subsequent pay periods. When enabled, the payment process deducts from the payment of earnings over a period of time until the full draw amount is recovered. Valid values are Y and N. The default value is Y. -
OrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit to which the payment plan belongs. Review the business unit ID for a business unit using the Setup and Maintenance, Define Business Units task. If the Business Unit ID column is not displayed, then click the View menu to add the Business Unit ID column. -
PayExcessLaterFlag: boolean
Title:
Carry forward maximum
Maximum Length:1
Default Value:false
Indicates whether the maximum payment adjustment should be carried forward to offset earning short falls in subsequent pay periods. Valid values are Y and N. The default value is N. -
PayIntervalTypeId: integer
(int64)
Title:
Payment Interval
Default Value:-1000
The unique identifier of the business unit interval that defines the frequency of the payment plan draw and cap adjustments. Intervals include period, quarter, annual, and semi annual. The default value is the identifier "-1000" for the period interval. Additional intervals are defined for the business unit using the Setup and Maintenance, Manage Intervals task. Use the finder for this resource to get the unique identifiers for the intervals. -
PaymentPlanAssignments: array
Payment Plans Assignments
Title:
Payment Plans Assignments
The assignments resource is used to view, create, update, or delete an incentive compensation assignment for a payment plan. -
PaymentPlanCategory: string
Title:
Payment Plan Category
Maximum Length:30
Default Value:STANDARD
The code indicating which plan components to apply the draw and cap. The default value is STANDARD. A list of acceptable values is defined in the lookup CN_PAYMENT_PLAN_CATEGORY. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
PaymentPlanId: integer
(int64)
Title:
Payment Plan
The unique identifier of the payment plan. -
PaymentPlanName: string
Title:
Name
Maximum Length:160
The name of the payment plan. -
PaymentPlanRoles: array
Payment Plans Roles
Title:
Payment Plans Roles
The roles resource is used to view, create, update, or delete an incentive compensation role assignment for a payment plan. -
RecoverExpressionId: integer
(int64)
Title:
Recovery Method
Default Value:-1001
The unique identifier of the recover expression. Recover expression determines which earnings can be deducted from, to recover a paid draw. The default, and only, valid value is "-1001" to recover against all earnings. -
RecoveryEndIntervalId: integer
(int32)
Title:
Recovery End
The code indicating when draw recovery should end. This value is optional if delayed recovery is enabled. The value is used to determine the relative date after the delayed recovery start. Possible values are "-1" to stop the recovery after 3 months, "-2" to stop the recovery after 6 months, "-3" to stop the recovery after 9 months, and "-4" to stop the recovery after 12 months. -
RecoveryStartIntervalId: integer
(int32)
Title:
Recovery Start
The code indicating when the delayed recovery period ends and the recovery processing should start. This value is required if delayed recovery is enabled. The value is used to determine the relative date after the payment plan assignment start date. Possible values are "-1" to start the recovery after 3 months, "-2" to start the recovery after 6 months, "-3" to start the recovery after 9 months, and "-4" to start the recovery after 12 months. -
StartDate: string
(date)
Title:
Start Date
The date when the payment plan becomes active. The acceptable format is yyyy-mm-dd.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Payment Plans Assignments
Type:
array
Title:
Payment Plans Assignments
The assignments resource is used to view, create, update, or delete an incentive compensation assignment for a payment plan.
Show Source
Nested Schema : Payment Plans Roles
Type:
array
Title:
Payment Plans Roles
The roles resource is used to view, create, update, or delete an incentive compensation role assignment for a payment plan.
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 : incentiveCompensationPaymentPlans-PaymentPlanAssignments-item-response
Type:
Show Source
object
-
AnalystId: integer
(int64)
Title:
Analyst
Read Only:true
The unique identifier of the analyst assigned to the payment plan. -
AnalystName: string
Title:
Analyst Name
Read Only:true
Maximum Length:360
The name of the analyst assigned to the payment plan. -
AssignmentType: string
Title:
Assignment Type
Read Only:true
The assignment type for the payment plan. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the payment plan assignment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the payment plan assignment is created. -
EndDate: string
(date)
Title:
End Date
The date when the assignment for a payment plan becomes inactive. The acceptable format is yyyy-mm-dd. -
FlatMinimumAmount: number
Title:
Flat Minimum Amount to Pay Participant
The minimum amount to pay the participant per the payment interval. The payment process creates a payment adjustment when the total earnings for the pay period are less than the minimum amount. This payment adjustment is often referred to as a draw or a guaranteed minimum. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the payment plan assignment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the payment plan assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumAmount: number
Title:
Maximum Payment
The maximum amount to pay the participant for the payment interval. The payment process creates a payment adjustment when the total earnings for the pay period are more than the maximum amount. This payment adjustment is often referred to as a cap. -
ParticipantId: integer
(int64)
Title:
Participant Identifier
The unique identifier for a participant. -
ParticipantName: string
Title:
Participant Name
Read Only:true
Maximum Length:360
The name of the participant in incentive compensation. -
ParticipantPaymentPlanId: integer
(int64)
The unique identifier of the payment plan.
-
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
The Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component. -
RecoveryEndDate: string
(date)
Title:
Recovery End Date
The date when the recovery of draw owed by the participant ends. -
RecoveryStartDate: string
(date)
Title:
Recovery Start Date
The date when the recovery of draw owed by the participant starts. -
RoleId: integer
(int64)
Read Only:
true
The unique identifier off the payment plan role. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:60
The name of the role. -
StartDate: string
(date)
Title:
Start Date
The date when the assignment becomes active. The acceptable format is yyyy-mm-dd.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : incentiveCompensationPaymentPlans-PaymentPlanRoles-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the payment plan role assignment. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the payment plan role assignment is created. -
Description: string
Title:
Role Description
Read Only:true
Maximum Length:120
A brief description of the payment plan role. -
EndDate: string
(date)
Title:
End Date
The date when the role assignment for a payment plan becomes inactive. The acceptable format is yyyy-mm-dd. The date must be equal to or earlier than the payment plan end date. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the payment plan role assignment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the payment plan role assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentPlanId: integer
(int64)
The unique identifier of the payment plan.
-
RoleId: integer
(int64)
The unique identifier off the payment plan role.
-
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:60
The name of the role. -
RolePaymentPlanId: integer
(int64)
The unique identifier of the role associated with a payment plan.
-
StartDate: string
(date)
Title:
Start Date
The date when the role assignment for a payment plan becomes active. The acceptable format is yyyy-mm-dd. The date must be equal to or later than the payment plan start date.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- BusinessUnitPVO
-
The list of values containing the unique identifiers of the business units.
The following properties are defined on the LOV link relation:- Source Attribute: OrgId; Target Attribute: OrganizationId
- Display Attribute: Name
- CnLookupDrawEndVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_DRAW_END
The list of values for the draw end.
The following properties are defined on the LOV link relation:- Source Attribute: DrawEnd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CnLookupPaymentPlanCategoryVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_PAYMENT_PLAN_CATEGORY
The list of values for the payment plan category.
The following properties are defined on the LOV link relation:- Source Attribute: PaymentPlanCategory; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CnLookupRecoveryEndIntervalIdVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_RECOVERY_END_PERIOD
The list of values for the recovery end.
The following properties are defined on the LOV link relation:- Source Attribute: RecoveryEndIntervalId; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CnLookupRecoveryStartIntervalIdVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_RECOVERY_START_PERIOD
The list of values for the recovery start.
The following properties are defined on the LOV link relation:- Source Attribute: RecoveryStartIntervalId; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PayIntervalTypeIdPVO
-
Parameters:
- finder:
BusinessUnitFinder%3BPorgId%3D{OrgId}
The list of values containing the unique identifiers of the payment intervals.
The following properties are defined on the LOV link relation:- Source Attribute: PayIntervalTypeId; Target Attribute: IntervalTypeId
- Display Attribute: IntervalName
- finder:
- PaymentPlanAssignments
-
Parameters:
- PaymentPlanId:
$request.path.PaymentPlanId
The assignments resource is used to view, create, update, or delete an incentive compensation assignment for a payment plan. - PaymentPlanId:
- PaymentPlanRoles
-
Parameters:
- PaymentPlanId:
$request.path.PaymentPlanId
The roles resource is used to view, create, update, or delete an incentive compensation role assignment for a payment plan. - PaymentPlanId: