API12
Click here for a complete list of operations.
GetFinalizedPayroll
Gets a single FinalizedPayroll from TimeWorksPlus as a large XML document, marking it as Accepted if it is not yet accepted (which prevents the client from unfinalizing it through the web interface). You need to provide a SessionID (which you'll get from CreateSession or CreateSessionSelectClient) and a FinalizedPayPeriodRecordNumber (which you'll get from GetListOfFinalizedPayrolls). A finalized payroll is our internal representation of a single pay period worth of data, and is very comprehensive, including punches with full auditing information, overtime calculation, employee roster, accrual balances, etc.
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /pg/api12.asmx HTTP/1.1
Host: www.payrollservers.us
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://mc2cs.com/GetFinalizedPayroll"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetFinalizedPayroll xmlns="http://mc2cs.com/">
<sessionID>string</sessionID>
<FinalizedPayPeriodRecordNumber>long</FinalizedPayPeriodRecordNumber>
</GetFinalizedPayroll>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetFinalizedPayrollResponse xmlns="http://mc2cs.com/">
<GetFinalizedPayrollResult>
<FinalizedPayrollDocument>xml</FinalizedPayrollDocument>
</GetFinalizedPayrollResult>
</GetFinalizedPayrollResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /pg/api12.asmx HTTP/1.1
Host: www.payrollservers.us
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetFinalizedPayroll xmlns="http://mc2cs.com/">
<sessionID>string</sessionID>
<FinalizedPayPeriodRecordNumber>long</FinalizedPayPeriodRecordNumber>
</GetFinalizedPayroll>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetFinalizedPayrollResponse xmlns="http://mc2cs.com/">
<GetFinalizedPayrollResult>
<FinalizedPayrollDocument>xml</FinalizedPayrollDocument>
</GetFinalizedPayrollResult>
</GetFinalizedPayrollResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /pg/api12.asmx/GetFinalizedPayroll?sessionID=string&FinalizedPayPeriodRecordNumber=string HTTP/1.1 Host: www.payrollservers.us
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <GetFinalizedPayrollResult xmlns="http://mc2cs.com/"> <FinalizedPayrollDocument>xml</FinalizedPayrollDocument> </GetFinalizedPayrollResult>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /pg/api12.asmx/GetFinalizedPayroll HTTP/1.1 Host: www.payrollservers.us Content-Type: application/x-www-form-urlencoded Content-Length: length sessionID=string&FinalizedPayPeriodRecordNumber=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <GetFinalizedPayrollResult xmlns="http://mc2cs.com/"> <FinalizedPayrollDocument>xml</FinalizedPayrollDocument> </GetFinalizedPayrollResult>