POST api/Payment/Get/{employeeNo}
Get a specific payment for an employee. The key is the PayElement and the StartDate from the request body
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
employeeNo |
Employee Number |
string |
Required |
Body Parameters
In request Body: Employee Payment Details
PaymentDetailName | 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:01:54.6762793+00:00", "EndDate": "2024-12-23T07:01:54.6762793+00:00", "AnnualAmount": 1.0, "PeriodAmount": 1.0, "Balance": 1.0, "RateEffectiveDate": "2024-12-23T07:01:54.6762793+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:01:54.6762793+00:00</EndDate> <PayElement>sample string 2</PayElement> <PeriodAmount>1</PeriodAmount> <RateEffectiveDate>2024-12-23T07:01:54.6762793+00:00</RateEffectiveDate> <RecordID>1</RecordID> <StartDate>2024-12-23T07:01:54.6762793+00:00</StartDate> </PaymentDetail>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Payment
PaymentDetailName | 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. |
Response Formats
application/json, text/json
Sample:
{ "RecordID": 2035, "PayElement": "Basic", "StartDate": "2021-11-08T00:00:00", "EndDate": null, "AnnualAmount": 144000.0, "PeriodAmount": 12000.0, "Balance": null, "RateEffectiveDate": 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> <PeriodAmount>12000.0</PeriodAmount> <RateEffectiveDate>null</RateEffectiveDate> <RecordID>2035</RecordID> <StartDate>2021-11-08T00:00:00</StartDate> </PaymentDetail>