ProBusinessTools Web Service

ProBusinessTools

Click here for a complete list of operations.

SearchCustomerSchedules

Recurring Billing Module Users Only: This method Returns an object array of your customer billing schedules.

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/SearchCustomerSchedules"

<?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>
    <SearchCustomerSchedules xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <csRequest>
        <CustomerIDNumber>string</CustomerIDNumber>
        <AccountNumber>string</AccountNumber>
        <JobNumber>string</JobNumber>
        <CustomerFirstName>string</CustomerFirstName>
        <CustomerLastName>string</CustomerLastName>
        <PlanName>string</PlanName>
        <CustPlanAccountNumber>string</CustPlanAccountNumber>
        <BillingScheduleStartDateRange>
          <StartDate>string</StartDate>
          <EndDate>string</EndDate>
        </BillingScheduleStartDateRange>
        <BillingScheduleEndDateRange>
          <StartDate>string</StartDate>
          <EndDate>string</EndDate>
        </BillingScheduleEndDateRange>
      </csRequest>
    </SearchCustomerSchedules>
  </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>
    <SearchCustomerSchedulesResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <SearchCustomerSchedulesResult>
        <SearchCustomerScheduleResponse>
          <InternalCustScheduleID>string</InternalCustScheduleID>
          <StartDate>string</StartDate>
          <EndDate>string</EndDate>
          <CustomerName>string</CustomerName>
          <AccountNumber>string</AccountNumber>
          <CycleEndDay>string</CycleEndDay>
          <BillDay>string</BillDay>
          <InternalPlanID>string</InternalPlanID>
          <PlanName>string</PlanName>
          <AssociatedJobNumber>string</AssociatedJobNumber>
          <ScheduleDetails>
            <CustomerScheduleSearchDetails xsi:nil="true" />
            <CustomerScheduleSearchDetails xsi:nil="true" />
          </ScheduleDetails>
        </SearchCustomerScheduleResponse>
        <SearchCustomerScheduleResponse>
          <InternalCustScheduleID>string</InternalCustScheduleID>
          <StartDate>string</StartDate>
          <EndDate>string</EndDate>
          <CustomerName>string</CustomerName>
          <AccountNumber>string</AccountNumber>
          <CycleEndDay>string</CycleEndDay>
          <BillDay>string</BillDay>
          <InternalPlanID>string</InternalPlanID>
          <PlanName>string</PlanName>
          <AssociatedJobNumber>string</AssociatedJobNumber>
          <ScheduleDetails>
            <CustomerScheduleSearchDetails xsi:nil="true" />
            <CustomerScheduleSearchDetails xsi:nil="true" />
          </ScheduleDetails>
        </SearchCustomerScheduleResponse>
      </SearchCustomerSchedulesResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </SearchCustomerSchedulesResponse>
  </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>
    <SearchCustomerSchedules xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <csRequest>
        <CustomerIDNumber>string</CustomerIDNumber>
        <AccountNumber>string</AccountNumber>
        <JobNumber>string</JobNumber>
        <CustomerFirstName>string</CustomerFirstName>
        <CustomerLastName>string</CustomerLastName>
        <PlanName>string</PlanName>
        <CustPlanAccountNumber>string</CustPlanAccountNumber>
        <BillingScheduleStartDateRange>
          <StartDate>string</StartDate>
          <EndDate>string</EndDate>
        </BillingScheduleStartDateRange>
        <BillingScheduleEndDateRange>
          <StartDate>string</StartDate>
          <EndDate>string</EndDate>
        </BillingScheduleEndDateRange>
      </csRequest>
    </SearchCustomerSchedules>
  </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>
    <SearchCustomerSchedulesResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <SearchCustomerSchedulesResult>
        <SearchCustomerScheduleResponse>
          <InternalCustScheduleID>string</InternalCustScheduleID>
          <StartDate>string</StartDate>
          <EndDate>string</EndDate>
          <CustomerName>string</CustomerName>
          <AccountNumber>string</AccountNumber>
          <CycleEndDay>string</CycleEndDay>
          <BillDay>string</BillDay>
          <InternalPlanID>string</InternalPlanID>
          <PlanName>string</PlanName>
          <AssociatedJobNumber>string</AssociatedJobNumber>
          <ScheduleDetails>
            <CustomerScheduleSearchDetails xsi:nil="true" />
            <CustomerScheduleSearchDetails xsi:nil="true" />
          </ScheduleDetails>
        </SearchCustomerScheduleResponse>
        <SearchCustomerScheduleResponse>
          <InternalCustScheduleID>string</InternalCustScheduleID>
          <StartDate>string</StartDate>
          <EndDate>string</EndDate>
          <CustomerName>string</CustomerName>
          <AccountNumber>string</AccountNumber>
          <CycleEndDay>string</CycleEndDay>
          <BillDay>string</BillDay>
          <InternalPlanID>string</InternalPlanID>
          <PlanName>string</PlanName>
          <AssociatedJobNumber>string</AssociatedJobNumber>
          <ScheduleDetails>
            <CustomerScheduleSearchDetails xsi:nil="true" />
            <CustomerScheduleSearchDetails xsi:nil="true" />
          </ScheduleDetails>
        </SearchCustomerScheduleResponse>
      </SearchCustomerSchedulesResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </SearchCustomerSchedulesResponse>
  </soap12:Body>
</soap12:Envelope>