ws Web Service

Click here for a complete list of operations.

GetPayrollBatchDetails

Test

The test form is only available for requests from the local machine.

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 /Integration/ENT/V1.8/ws.asmx HTTP/1.1
Host: implementation.hhaexchange.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.hhaexchange.com/apis/hhaws.integration/GetPayrollBatchDetails"

<?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>
    <GetPayrollBatchDetails xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <BatchID>int</BatchID>
      <CaregiverID>int</CaregiverID>
      <ExcludeZeroAmount>string</ExcludeZeroAmount>
      <GroupByVisit>string</GroupByVisit>
    </GetPayrollBatchDetails>
  </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>
    <GetPayrollBatchDetailsResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetPayrollBatchDetailsResult>
        <PayrollBatchDetails>
          <BatchDetail>
            <BatchID>int</BatchID>
            <BatchNumber>string</BatchNumber>
            <BatchDate>string</BatchDate>
            <CaregiverID>int</CaregiverID>
            <CaregiverCode>string</CaregiverCode>
            <CaregiverFirstName>string</CaregiverFirstName>
            <CaregiverLastName>string</CaregiverLastName>
            <AdmissionID>string</AdmissionID>
            <PatientID>int</PatientID>
            <VisitID>int</VisitID>
            <VisitDate>string</VisitDate>
            <VisitStartTime>string</VisitStartTime>
            <VisitEndTime>string</VisitEndTime>
            <RegularHours>int</RegularHours>
            <RegularPayRate>string</RegularPayRate>
            <RegularPayCode>string</RegularPayCode>
            <RegularAmount>string</RegularAmount>
            <OverTimeHours>int</OverTimeHours>
            <OverTimeAmount>string</OverTimeAmount>
            <OverTimePayrate>string</OverTimePayrate>
            <OverTimePayCode>string</OverTimePayCode>
            <HolidayHours>int</HolidayHours>
            <HolidayPayRate>string</HolidayPayRate>
            <HolidayAmount>string</HolidayAmount>
            <HolidayPayCode>string</HolidayPayCode>
            <PayType>string</PayType>
            <OriginalPayType>string</OriginalPayType>
            <PayrollWeekendingDate>string</PayrollWeekendingDate>
            <WeekNumber>int</WeekNumber>
            <DifferentialHours>int</DifferentialHours>
            <DifferentialRate>string</DifferentialRate>
            <DifferentialAmount>string</DifferentialAmount>
            <DisplayPatientOnStub>string</DisplayPatientOnStub>
          </BatchDetail>
          <BatchDetail>
            <BatchID>int</BatchID>
            <BatchNumber>string</BatchNumber>
            <BatchDate>string</BatchDate>
            <CaregiverID>int</CaregiverID>
            <CaregiverCode>string</CaregiverCode>
            <CaregiverFirstName>string</CaregiverFirstName>
            <CaregiverLastName>string</CaregiverLastName>
            <AdmissionID>string</AdmissionID>
            <PatientID>int</PatientID>
            <VisitID>int</VisitID>
            <VisitDate>string</VisitDate>
            <VisitStartTime>string</VisitStartTime>
            <VisitEndTime>string</VisitEndTime>
            <RegularHours>int</RegularHours>
            <RegularPayRate>string</RegularPayRate>
            <RegularPayCode>string</RegularPayCode>
            <RegularAmount>string</RegularAmount>
            <OverTimeHours>int</OverTimeHours>
            <OverTimeAmount>string</OverTimeAmount>
            <OverTimePayrate>string</OverTimePayrate>
            <OverTimePayCode>string</OverTimePayCode>
            <HolidayHours>int</HolidayHours>
            <HolidayPayRate>string</HolidayPayRate>
            <HolidayAmount>string</HolidayAmount>
            <HolidayPayCode>string</HolidayPayCode>
            <PayType>string</PayType>
            <OriginalPayType>string</OriginalPayType>
            <PayrollWeekendingDate>string</PayrollWeekendingDate>
            <WeekNumber>int</WeekNumber>
            <DifferentialHours>int</DifferentialHours>
            <DifferentialRate>string</DifferentialRate>
            <DifferentialAmount>string</DifferentialAmount>
            <DisplayPatientOnStub>string</DisplayPatientOnStub>
          </BatchDetail>
        </PayrollBatchDetails>
      </GetPayrollBatchDetailsResult>
    </GetPayrollBatchDetailsResponse>
  </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 /Integration/ENT/V1.8/ws.asmx HTTP/1.1
Host: implementation.hhaexchange.com
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>
    <GetPayrollBatchDetails xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <BatchID>int</BatchID>
      <CaregiverID>int</CaregiverID>
      <ExcludeZeroAmount>string</ExcludeZeroAmount>
      <GroupByVisit>string</GroupByVisit>
    </GetPayrollBatchDetails>
  </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>
    <GetPayrollBatchDetailsResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetPayrollBatchDetailsResult>
        <PayrollBatchDetails>
          <BatchDetail>
            <BatchID>int</BatchID>
            <BatchNumber>string</BatchNumber>
            <BatchDate>string</BatchDate>
            <CaregiverID>int</CaregiverID>
            <CaregiverCode>string</CaregiverCode>
            <CaregiverFirstName>string</CaregiverFirstName>
            <CaregiverLastName>string</CaregiverLastName>
            <AdmissionID>string</AdmissionID>
            <PatientID>int</PatientID>
            <VisitID>int</VisitID>
            <VisitDate>string</VisitDate>
            <VisitStartTime>string</VisitStartTime>
            <VisitEndTime>string</VisitEndTime>
            <RegularHours>int</RegularHours>
            <RegularPayRate>string</RegularPayRate>
            <RegularPayCode>string</RegularPayCode>
            <RegularAmount>string</RegularAmount>
            <OverTimeHours>int</OverTimeHours>
            <OverTimeAmount>string</OverTimeAmount>
            <OverTimePayrate>string</OverTimePayrate>
            <OverTimePayCode>string</OverTimePayCode>
            <HolidayHours>int</HolidayHours>
            <HolidayPayRate>string</HolidayPayRate>
            <HolidayAmount>string</HolidayAmount>
            <HolidayPayCode>string</HolidayPayCode>
            <PayType>string</PayType>
            <OriginalPayType>string</OriginalPayType>
            <PayrollWeekendingDate>string</PayrollWeekendingDate>
            <WeekNumber>int</WeekNumber>
            <DifferentialHours>int</DifferentialHours>
            <DifferentialRate>string</DifferentialRate>
            <DifferentialAmount>string</DifferentialAmount>
            <DisplayPatientOnStub>string</DisplayPatientOnStub>
          </BatchDetail>
          <BatchDetail>
            <BatchID>int</BatchID>
            <BatchNumber>string</BatchNumber>
            <BatchDate>string</BatchDate>
            <CaregiverID>int</CaregiverID>
            <CaregiverCode>string</CaregiverCode>
            <CaregiverFirstName>string</CaregiverFirstName>
            <CaregiverLastName>string</CaregiverLastName>
            <AdmissionID>string</AdmissionID>
            <PatientID>int</PatientID>
            <VisitID>int</VisitID>
            <VisitDate>string</VisitDate>
            <VisitStartTime>string</VisitStartTime>
            <VisitEndTime>string</VisitEndTime>
            <RegularHours>int</RegularHours>
            <RegularPayRate>string</RegularPayRate>
            <RegularPayCode>string</RegularPayCode>
            <RegularAmount>string</RegularAmount>
            <OverTimeHours>int</OverTimeHours>
            <OverTimeAmount>string</OverTimeAmount>
            <OverTimePayrate>string</OverTimePayrate>
            <OverTimePayCode>string</OverTimePayCode>
            <HolidayHours>int</HolidayHours>
            <HolidayPayRate>string</HolidayPayRate>
            <HolidayAmount>string</HolidayAmount>
            <HolidayPayCode>string</HolidayPayCode>
            <PayType>string</PayType>
            <OriginalPayType>string</OriginalPayType>
            <PayrollWeekendingDate>string</PayrollWeekendingDate>
            <WeekNumber>int</WeekNumber>
            <DifferentialHours>int</DifferentialHours>
            <DifferentialRate>string</DifferentialRate>
            <DifferentialAmount>string</DifferentialAmount>
            <DisplayPatientOnStub>string</DisplayPatientOnStub>
          </BatchDetail>
        </PayrollBatchDetails>
      </GetPayrollBatchDetailsResult>
    </GetPayrollBatchDetailsResponse>
  </soap12:Body>
</soap12:Envelope>