POST api/Payment/Delete/{employeeNo}

Remove a Payment from an Employee. A payment can only be deleted if it has never been paid. The start date and the pay element must be specified

Request Information

URI Parameters

Name	Description	Type	Additional information
employeeNo	Employee Number	string	Required

Body Parameters

In the 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	AmountAmount OR PeriodAmount is required	decimal number	None.
PeriodAmount	AmountAmount OR PeriodAmount is required	decimal number	None.
Balance		decimal number	None.
RateEffectiveDate		date	None.
Applied		boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "RecordID": 1,
  "PayElement": "sample string 2",
  "StartDate": "2024-12-23T07:03:33.6304166+00:00",
  "EndDate": "2024-12-23T07:03:33.6304166+00:00",
  "AnnualAmount": 1.0,
  "PeriodAmount": 1.0,
  "Balance": 1.0,
  "RateEffectiveDate": "2024-12-23T07:03:33.6304166+00:00",
  "Applied": true
}

application/xml, text/xml

Sample:

<PaymentDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServicesRESTful.Models">
  <AnnualAmount>1</AnnualAmount>
  <Applied>true</Applied>
  <Balance>1</Balance>
  <EndDate>2024-12-23T07:03:33.6304166+00:00</EndDate>
  <PayElement>sample string 2</PayElement>
  <PeriodAmount>1</PeriodAmount>
  <RateEffectiveDate>2024-12-23T07:03:33.6304166+00:00</RateEffectiveDate>
  <RecordID>1</RecordID>
  <StartDate>2024-12-23T07:03:33.6304166+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>