ProBusinessTools Web Service

ProBusinessTools

Click here for a complete list of operations.

CreatePayReport

Creates a completed pay report based on search criteria supplied. userType is "installer" or "subcontractor" searchCriteria.Status allows WildCard(%) search

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 /publicwebservices/probusinesstools.asmx HTTP/1.1
Host: secure.probusinesstools.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://secure.probusinesstools.com/publicWebServices/CreatePayReport"

<?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>
    <CreatePayReport xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <userType>installer or subcontractor</userType>
      <userID>int</userID>
      <searchCriteria>
        <Status>string</Status>
        <OrderType>string</OrderType>
        <CompletedDateBeginRange>string</CompletedDateBeginRange>
        <CompletedDateEndRange>string</CompletedDateEndRange>
        <PaperworkReceived>boolean</PaperworkReceived>
      </searchCriteria>
      <bankingInfo>
        <PaidOnDate>string</PaidOnDate>
        <BankID>string</BankID>
        <CheckNumber>string</CheckNumber>
        <ChartOfAccountID>string</ChartOfAccountID>
      </bankingInfo>
    </CreatePayReport>
  </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>
    <CreatePayReportResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <CreatePayReportResult>
        <xsd:schema>schema</xsd:schema>xml</CreatePayReportResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </CreatePayReportResponse>
  </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 /publicwebservices/probusinesstools.asmx HTTP/1.1
Host: secure.probusinesstools.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>
    <CreatePayReport xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <userType>installer or subcontractor</userType>
      <userID>int</userID>
      <searchCriteria>
        <Status>string</Status>
        <OrderType>string</OrderType>
        <CompletedDateBeginRange>string</CompletedDateBeginRange>
        <CompletedDateEndRange>string</CompletedDateEndRange>
        <PaperworkReceived>boolean</PaperworkReceived>
      </searchCriteria>
      <bankingInfo>
        <PaidOnDate>string</PaidOnDate>
        <BankID>string</BankID>
        <CheckNumber>string</CheckNumber>
        <ChartOfAccountID>string</ChartOfAccountID>
      </bankingInfo>
    </CreatePayReport>
  </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>
    <CreatePayReportResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <CreatePayReportResult>
        <xsd:schema>schema</xsd:schema>xml</CreatePayReportResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </CreatePayReportResponse>
  </soap12:Body>
</soap12:Envelope>