Create a payment plan assignment
post
/fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanAssignments
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
ParticipantId: integer
(int64)
Title:
Participant Identifier
The unique identifier for a participant. -
ParticipantPaymentPlanId: integer
(int64)
The unique identifier of the payment plan.
-
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.
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-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 : 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.
Links
- ParticipantVO
-
Parameters:
- finder:
SearchActiveParticipant
The list of values containing the unique identifiers of participants.
The following properties are defined on the LOV link relation:- Source Attribute: ParticipantId; Target Attribute: ParticipantId
- Display Attribute: ParticipantName
- finder: