Jump to

• Request
• Response

Update a payment plan assignment

patch

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanAssignments/{ParticipantPaymentPlanId}

Request

Path Parameters

• ParticipantPaymentPlanId(required): integer(int64)
  The unique identifier of the payment plan.
• 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the assignment becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false
        },
        "FlatMinimumAmount":{
            "title":"Flat Minimum Amount to Pay Participant",
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "MaximumAmount":{
            "title":"Maximum Payment",
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "RecoveryStartDate":{
            "title":"Recovery Start Date",
            "type":"string",
            "description":"The date when the recovery of draw owed by the participant starts.",
            "format":"date",
            "nullable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the assignment for a payment plan becomes inactive. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true
        },
        "RecoveryEndDate":{
            "title":"Recovery End Date",
            "type":"string",
            "description":"The date when the recovery of draw owed by the participant ends.",
            "format":"date",
            "nullable":true
        }
    }
}

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 : incentiveCompensationPaymentPlans-PaymentPlanAssignments-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the payment plan assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the payment plan assignment is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the payment plan assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPaymentPlanId":{
            "type":"integer",
            "description":"The unique identifier of the payment plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaximumAmount":{
            "title":"Maximum Payment",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name  of the participant in incentive compensation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier off the payment plan role.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the assignment for a payment plan becomes inactive. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AnalystName":{
            "title":"Analyst Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the analyst assigned to the payment plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier for a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the assignment becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "FlatMinimumAmount":{
            "title":"Flat Minimum Amount to Pay Participant",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnalystId":{
            "title":"Analyst",
            "type":"integer",
            "description":"The unique identifier of the analyst assigned to the payment plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "type":"string",
            "description":"The assignment type for the payment plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecoveryStartDate":{
            "title":"Recovery Start Date",
            "type":"string",
            "description":"The date when the recovery of draw owed by the participant starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the payment plan assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecoveryEndDate":{
            "title":"Recovery End Date",
            "type":"string",
            "description":"The date when the recovery of draw owed by the participant ends.",
            "format":"date",
            "nullable":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

ParticipantVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipantsLOV

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

Back to Top