PUT api/Adjustment/{employeeNo}

Add an adjustment to an Employee

Request Information

URI Parameters

Name	Description	Type	Additional information
employeeNo	Employee Number	string	Required

Body Parameters

In request Body: Employee adjustment detail

AdjustmentDetail

Name	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	External Identifier for adjustment. Max 100 chars.	string	Required
RateName		string	None.
Department	If you wish to attach this adjustment to a department for reporting purposes.	string	None.

Request Formats

application/json, text/json

Sample:

{
    "PayElement": "BasicAdjust",
    "Period": "202108",
    "Date": "2022-02-10T15:51:08.5661755+00:00",
    "Amount": 120.0,
    "ExternalId": "ExtID",
    "RateName": "SampleRate",
    "Department": "TestDepartment"
}

application/xml, text/xml

Sample:

<AdjustmentDetail>
    <Amount>120</Amount>
    <Date>2022-02-10T15:51:08.5661755+00:00</Date>
    <Department>TestDepartment</Department>
    <ExternalId>ExtID</ExternalId>
    <PayElement>BasicAdjust</PayElement>
    <Period>202108</Period>
    <RateName>SampleRate</RateName>
</AdjustmentDetail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result

ResultWithMessage

Name	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>