GET api/Payment/{employeeNo}

Get a list of all payments for an employee

Request Information

URI Parameters

Name	Description	Type	Additional information
employeeNo	Employee Number	string	Required

Body Parameters

None.

Response Information

Resource Description

All Payment Details

Collection of 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.

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
    },
    {
        "RecordID": 2020,
        "PayElement": "Basic",
        "StartDate": "2021-11-05T00:00:00",
        "EndDate": "2021-11-06T00:00:00",
        "AnnualAmount": 2400.0,
        "PeriodAmount": 200.0,
        "Balance": null,
        "RateEffectiveDate": null,
        "Applied": true
    },
    {
        "RecordID": 1999,
        "PayElement": "Basic",
        "StartDate": "2021-07-01T00:00:00",
        "EndDate": "2021-11-04T00:00:00",
        "AnnualAmount": 17000.0,
        "PeriodAmount": 1416.67,
        "Balance": null,
        "RateEffectiveDate": null,
        "Applied": true
    }
]

application/xml, text/xml

Sample:

<ArrayOfPaymentDetail>
    <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>
    <PaymentDetail>
        <AnnualAmount>2400.0</AnnualAmount>
        <Applied>true</Applied>
        <Balance>null</Balance>
        <EndDate>2021-11-06T00:00:00</EndDate>
        <PayElement>Basic</PayElement>
        <PeriodAmount>200.0</PeriodAmount>
        <RateEffectiveDate>null</RateEffectiveDate>
        <RecordID>2020</RecordID>
        <StartDate>2021-11-05T00:00:00</StartDate>
    </PaymentDetail>
    <PaymentDetail>
        <AnnualAmount>17000.0</AnnualAmount>
        <Applied>true</Applied>
        <Balance>null</Balance>
        <EndDate>2021-11-04T00:00:00</EndDate>
        <PayElement>Basic</PayElement>
        <PeriodAmount>1416.67</PeriodAmount>
        <RateEffectiveDate>null</RateEffectiveDate>
        <RecordID>1999</RecordID>
        <StartDate>2021-07-01T00:00:00</StartDate>
    </PaymentDetail>
</ArrayOfPaymentDetail>