Jump to

• Request
• Response

Get all payment plans

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a payment plan with the specified primary key.
    Finder Variables:
    • PaymentPlanId; integer; The unique identifier of the payment plan.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CreatedBy; string; The user who created the payment plan.
  • CreationDate; string; The date and time when the payment plan is created.
  • DelayRecoveryFlag; boolean; 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; A brief description of the payment plan.
  • DrawEnd; string; 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; The date when the payment plan becomes inactive. The acceptable format is yyyy-mm-dd.
  • FlatMinimumAmount; number; 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; The date and time when the payment plan was last updated.
  • LastUpdatedBy; string; The user who last updated the payment plan.
  • MaximumAmount; number; 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; 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; 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; 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; 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.
  • PaymentPlanCategory; string; 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; The unique identifier of the payment plan.
  • PaymentPlanName; string; The name of the payment plan.
  • RecoverExpressionId; integer; 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; 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; 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; The date when the payment plan becomes active. The acceptable format is yyyy-mm-dd.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPaymentPlans-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object incentiveCompensationPaymentPlans-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPaymentPlans-item-response"
    }
}

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

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the payment plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumRecoverFlag":{
            "title":"Minimum Recovery",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "RecoveryEndIntervalId":{
            "title":"Recovery End",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"1"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the payment plan is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the payment plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"A brief description of the payment plan.",
            "nullable":true,
            "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
        },
        "DrawEnd":{
            "title":"Draw End",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PayExcessLaterFlag":{
            "title":"Carry forward maximum",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the payment plan becomes inactive. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RecoverExpressionId":{
            "title":"Recovery Method",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "default":"-1001",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentPlanRoles":{
            "title":"Payment Plans Roles",
            "type":"array",
            "description":"The roles resource is used to view, create, update, or delete an incentive compensation role assignment for a payment plan.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPaymentPlans-PaymentPlanRoles-item-response"
            }
        },
        "PaymentPlanAssignments":{
            "title":"Payment Plans Assignments",
            "type":"array",
            "description":"The assignments resource is used to view, create, update, or delete an incentive compensation assignment for a payment plan.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPaymentPlans-PaymentPlanAssignments-item-response"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the payment plan becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "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":false,
            "x-queryable":true
        },
        "PaymentPlanCategory":{
            "title":"Payment Plan Category",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"STANDARD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PaymentPlanName":{
            "title":"Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name of the payment plan.",
            "nullable":false,
            "x-queryable":true
        },
        "PayIntervalTypeId":{
            "title":"Payment Interval",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "default":"-1000",
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "OrgId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecoveryStartIntervalId":{
            "title":"Recovery Start",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"1"
            },
            "x-queryable":true
        },
        "PaymentPlanId":{
            "title":"Payment Plan",
            "type":"integer",
            "description":"The unique identifier of the payment plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the payment plan was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DelayRecoveryFlag":{
            "title":"Recovery Start Option",
            "maxLength":"1",
            "type":"boolean",
            "description":"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\".",
            "nullable":true,
            "default":false,
            "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 : 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

• Array of: object incentiveCompensationPaymentPlans-PaymentPlanAssignments-item-response

{
    "title":"Payment Plans Assignments",
    "type":"array",
    "description":"The assignments resource is used to view, create, update, or delete an incentive compensation assignment for a payment plan.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPaymentPlans-PaymentPlanAssignments-item-response"
    }
}

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

• Array of: object incentiveCompensationPaymentPlans-PaymentPlanRoles-item-response

{
    "title":"Payment Plans Roles",
    "type":"array",
    "description":"The roles resource is used to view, create, update, or delete an incentive compensation role assignment for a payment plan.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPaymentPlans-PaymentPlanRoles-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 : 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 : incentiveCompensationPaymentPlans-PaymentPlanRoles-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the payment plan role assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the payment plan role assignment is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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
        },
        "Description":{
            "title":"Role Description",
            "maxLength":"120",
            "type":"string",
            "description":"A brief description of the payment plan role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the payment plan role assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RolePaymentPlanId":{
            "type":"integer",
            "description":"The unique identifier of the role associated with a payment plan.",
            "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"
            }
        },
        "PaymentPlanId":{
            "type":"integer",
            "description":"The unique identifier of the payment plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier off the payment plan role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the payment plan role assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

Back to Top