Create a pay advance request.
post
/hcmRestApi/resources/11.13.18.05/payAdvances/action/requestAdvance
Create a pay advance request for an employee.
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
Root Schema : schema
Type:
Show Source
object
-
amount: number
Create a pay advance request for the requested amount.
-
assignmentId: number
Create a pay advance request based on a unique identifier.
-
effectiveDate: string
(date)
Create a pay advance request based on effective date.
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): object
result
Additional Properties Allowed: additionalPropertiesCreate a return for the pay advance request.
Nested Schema : result
Type:
object
Additional Properties Allowed
Show Source
Create a return for the pay advance request.
Examples
The following example shows how to get a pay advance by submitting a POST request on the REST resource using cURL. The user can request amount based on the Net Amount Available from eligibility.
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/requestAdvance
Example of Payload
The following is an example of the
payload.
{
"assignmentId" : 300100068226459,
"effectiveDate" : "2021-05-27",
"amount" : 500
}
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": { "Message": "Your request was submitted successfully. (PAY-1636570)", "MessageType": "S" } }