Jump to

• Request
• Response
• Examples

Create the employee's eligibility check to pay advance.

post

/hcmRestApi/resources/11.13.18.05/payAdvances/action/checkEligibility

Performs a series of checks to ensure the employee satisfies all conditions required to request a pay advance.

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

• assignmentId: number
  Create the employee's eligibility check to pay advance based on unique identifier.
• effectiveDate: string (date)
  Create the employee's eligibility check to pay advance based on effective date.

{
    "type":"object",
    "properties":{
        "assignmentId":{
            "type":"number",
            "description":"Create the employee's eligibility check to pay advance based on unique identifier.",
            "nullable":true
        },
        "effectiveDate":{
            "type":"string",
            "description":"Create the employee's eligibility check to pay advance based on effective date.",
            "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

  Create a return of the maximum amount the employee can request as an advance.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Create a return of the maximum amount the employee can request as an advance."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Create a return of the maximum amount the employee can request as an advance."
}

Create a return of the maximum amount the employee can request as an advance.

Back to Top

Examples

The following example shows how to check the eligibility of an employee by submitting a POST request on the REST resource using cURL. The user can check the eligibility with Net Amount Available and Hours Worked.

curl -u "<user>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" -X POST -d <payload> https://host:port/hcmRestApi/resources/11.13.18.05/payAdvances/action/checkEligibility

Example of Payload

The following is an example of the payload.

{
    "assignmentId" :300100068226459,
    "effectiveDate" : "2021-05-27"
}

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200 OK                                                     
Content-Type : application/vnd.oracle.adf.actionresult+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "result": {
        "Amount": "1021.50",
        "Message": null,
        "DisplayMinimumRequestAmount": "10",
        "DisplayAmount": "1,021.5",
        "MinimumRequestAmount": "10",
        "CompanyPolicy": "Plan Information provided by Muthuganesh",
        "CurrencyCode": "USD",
        "MessageType": "S",
        "CurrencySymbol": "$",
        "NextPayCheckDate": "6/1/21",
        "HoursWorked": "0"
    }
}

Back to Top