POST api/Adjustment/{employeeNo}
Update an Adjustment for an Employee.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
employeeNo |
Employee Number |
string |
Required |
Body Parameters
In request Body: Employee Adjustment Details
AdjustmentDetailName | Description | Type | Additional information |
---|---|---|---|
PayElement | string |
Required |
|
Period |
OPTIONAL - The period the payment will be made in (defaults to the current period) |
string |
None. |
Date |
OPTIONAL - The date the payment will be made |
date |
None. |
Amount |
Amount OR Rate is required |
decimal number |
None. |
Rate |
Amount OR Rate is required |
decimal number |
None. |
Units | decimal number |
None. |
|
ExternalId | string |
Required |
|
RateName | string |
None. |
|
Department | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "PayElement": "sample string 1", "Period": "sample string 2", "Date": "2024-12-23T06:44:20.8062902+00:00", "Amount": 1.0, "Rate": 1.0, "Units": 1.0, "ExternalId": "sample string 3", "RateName": "sample string 4", "Department": "sample string 5" }
application/xml, text/xml
Sample:
<AdjustmentDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServicesRESTful.Models"> <Amount>1</Amount> <Date>2024-12-23T06:44:20.8062902+00:00</Date> <Department>sample string 5</Department> <ExternalId>sample string 3</ExternalId> <PayElement>sample string 1</PayElement> <Period>sample string 2</Period> <Rate>1</Rate> <RateName>sample string 4</RateName> <Units>1</Units> </AdjustmentDetail>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Result
ResultWithMessageName | Description | Type | Additional information |
---|---|---|---|
result |
'OK', 'Error' |
string |
None. |
message |
Returns if result is Error |
string |
None. |
returnValue | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "result": "OK" } { "result": "Error", "message": "Unable to save: the..." }
application/xml, text/xml
Sample:
<ResultWithMessage> <result>OK</result> </ResultWithMessage> <ResultWithMessage> <result>Error</result> <message>Unable to save: the...</message> </ResultWithMessage>