POST api/{programid}/Employee/GetPayStub
Get pay stub as EmployeePayStubResponse class.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
programid | string |
Required |
Body Parameters
EmployeePayStubRequestParamsName | Description | Type | Additional information |
---|---|---|---|
ProviderId | string |
None. |
|
PayStubNo | string |
None. |
|
CheckStubShowEmployer | boolean |
None. |
|
ShowConsumersOnCheck | boolean |
None. |
|
DisallowOvertimeOnCheckstub | boolean |
None. |
|
ShowPayPeriod | boolean |
None. |
|
ShowRate | boolean |
None. |
|
PayStubContent | Collection of byte |
None. |
Request Formats
application/json, text/json
Sample:
{ "ProviderId": "sample string 1", "PayStubNo": "sample string 2", "CheckStubShowEmployer": true, "ShowConsumersOnCheck": true, "DisallowOvertimeOnCheckstub": true, "ShowPayPeriod": true, "ShowRate": true, "PayStubContent": "QEA=" }
application/xml, text/xml
Sample:
<EmployeePayStubRequestParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Employee"> <CheckStubShowEmployer>true</CheckStubShowEmployer> <DisallowOvertimeOnCheckstub>true</DisallowOvertimeOnCheckstub> <PayStubContent>QEA=</PayStubContent> <PayStubNo>sample string 2</PayStubNo> <ProviderId>sample string 1</ProviderId> <ShowConsumersOnCheck>true</ShowConsumersOnCheck> <ShowPayPeriod>true</ShowPayPeriod> <ShowRate>true</ShowRate> </EmployeePayStubRequestParams>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
EmployeePayStubResponseName | Description | Type | Additional information |
---|---|---|---|
ProviderId | string |
None. |
|
PayStubNo | string |
None. |
|
PayStubContent | Collection of byte |
None. |
|
PayStubDataSet | DataSet |
None. |
Response Formats
application/json, text/json
Sample:
{ "ProviderId": "sample string 1", "PayStubNo": "sample string 2", "PayStubContent": "QEA=", "PayStubDataSet": null }
application/xml, text/xml
Sample:
<EmployeePayStubResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Employee"> <PayStubContent>QEA=</PayStubContent> <PayStubDataSet i:nil="true" /> <PayStubNo>sample string 2</PayStubNo> <ProviderId>sample string 1</ProviderId> </EmployeePayStubResponse>