POST api/Payment/Update/{employeeNo}

Update a Payment for an Employee. The key for updates is the Pay Element and the Start Date

Request Information

URI Parameters

Name	Description	Type	Additional information
employeeNo	Employee Number	string	Required

Body Parameters

In request Body: Employee Payment Details

PaymentDetail

Name	Description	Type	Additional information
RecordID		integer	None.
PayElement	Must not be archived	string	Required
StartDate		date	Required
EndDate		date	None.
AnnualAmount	AnnualAmount OR PeriodAmount is required	decimal number	None.
PeriodAmount	AnnualAmount OR PeriodAmount is required	decimal number	None.
Balance	Indicates whether the employee payment has an amount outstanding.	decimal number	None.
Applied	Retrieve only. Indicates whether the payment record has been stamped with a period.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
    "RecordID": 2035,
    "PayElement": "Basic",
    "StartDate": "2021-11-08T00:00:00",
    "EndDate": null,
    "AnnualAmount": 144000.0,
    "Balance": null,
    "Applied": false
}

application/xml, text/xml

Sample:

<PaymentDetail>
    <AnnualAmount>144000.0</AnnualAmount>
    <Applied>false</Applied>
    <Balance>null</Balance>
    <EndDate>null</EndDate>
    <PayElement>Basic</PayElement>
    <RecordID>2035</RecordID>
    <StartDate>2021-11-08T00:00:00</StartDate>    
</PaymentDetail>

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>