GET api/Payment/{employeeNo}/{payElement}/{startDate}
Get a specific payment for an employee. The key is the PayElement and the StartDate
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
employeeNo |
Employee Number |
string |
Required |
payElement |
Pay Element |
string |
Required |
startDate |
Start Date |
date |
Required |
Body Parameters
None.
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>