Jump to

• Request
• Response

Enter an override payment percentage for an absence

post

/hcmRestApi/resources/11.13.18.05/absences/action/overridePaymentPercentageEntitlement

Enters an override payment percentage to override the plan payment percentage for that absence.

Request

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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• endDate: string (date)
  End date within the duration of the absence when the payment percentage is overridden.
• perAbsenceEntryId: number
  Absence entry identifier associated with the override payment percentage.
• planActivity: string
  Plan activity for the override payment percentage.
• planId: number
  Plan identifier to override payment percentage.
• pmtPercent: string
  Percentage value that overrides the payment percentage of the plan of the worker for a given absence duration.
• reason: string
  Reason for override payment percentage.
• startDate: string (date)
  Start date within the duration of the absence when the payment percentage is overridden.

{
    "type":"object",
    "properties":{
        "pmtPercent":{
            "type":"string",
            "description":"Percentage value that overrides the payment percentage of the plan of the worker for a given absence duration.",
            "nullable":true
        },
        "reason":{
            "type":"string",
            "description":"Reason for override payment percentage.",
            "nullable":true
        },
        "endDate":{
            "type":"string",
            "description":"End date within the duration of the absence when the payment percentage is overridden.",
            "format":"date",
            "nullable":true
        },
        "perAbsenceEntryId":{
            "type":"number",
            "description":"Absence entry identifier associated with the override payment percentage.",
            "nullable":true
        },
        "planId":{
            "type":"number",
            "description":"Plan identifier to override payment percentage.",
            "nullable":true
        },
        "planActivity":{
            "type":"string",
            "description":"Plan activity for the override payment percentage.",
            "nullable":true
        },
        "startDate":{
            "type":"string",
            "description":"Start date within the duration of the absence when the payment percentage is overridden.",
            "format":"date",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Indicates whether the override payment percentage was applied or not.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Indicates whether the override payment percentage was applied or not."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Indicates whether the override payment percentage was applied or not."
}

Indicates whether the override payment percentage was applied or not.

Back to Top