ProBusinessTools


Click here for a complete list of operations.

SearchRecurringBillingStatements

Recurring Billing Module Users Only: This method returns three separate data tables with in the StatementSearchResponse structure. The first table consisting of general statement data. The second consisting of detailed multi-record data related to items in the first table. The third table consisting of payment data related to the first table.

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

<?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>
    <SearchRecurringBillingStatements xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <StatementSearchRequest>
        <StatmentID>string</StatmentID>
        <SiteAccountNumber>string</SiteAccountNumber>
        <InternalCustomerID>string</InternalCustomerID>
        <CustomerIDNumber>string</CustomerIDNumber>
        <PayType>Cash or Check or CreditCard or All</PayType>
        <SearchDateRanges>
          <StatementDateBegin>string</StatementDateBegin>
          <StatementDateEnd>string</StatementDateEnd>
          <CycleDateBegin>string</CycleDateBegin>
          <CycleDateEnd>string</CycleDateEnd>
        </SearchDateRanges>
      </StatementSearchRequest>
    </SearchRecurringBillingStatements>
  </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>
    <SearchRecurringBillingStatementsResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <SearchRecurringBillingStatementsResult>
        <RequestStatus>ResultsReturnedNoError or NoResultsErrorReceived</RequestStatus>
        <ErrorMessage>
          <ErrorId>string</ErrorId>
          <ErrorMessage>string</ErrorMessage>
          <ReceivedInfoObjectType>string</ReceivedInfoObjectType>
          <ReceivedInfo />
        </ErrorMessage>
        <StatementData>
          <xsd:schema>schema</xsd:schema>xml</StatementData>
      </SearchRecurringBillingStatementsResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </SearchRecurringBillingStatementsResponse>
  </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>
    <SearchRecurringBillingStatements xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <StatementSearchRequest>
        <StatmentID>string</StatmentID>
        <SiteAccountNumber>string</SiteAccountNumber>
        <InternalCustomerID>string</InternalCustomerID>
        <CustomerIDNumber>string</CustomerIDNumber>
        <PayType>Cash or Check or CreditCard or All</PayType>
        <SearchDateRanges>
          <StatementDateBegin>string</StatementDateBegin>
          <StatementDateEnd>string</StatementDateEnd>
          <CycleDateBegin>string</CycleDateBegin>
          <CycleDateEnd>string</CycleDateEnd>
        </SearchDateRanges>
      </StatementSearchRequest>
    </SearchRecurringBillingStatements>
  </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>
    <SearchRecurringBillingStatementsResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <SearchRecurringBillingStatementsResult>
        <RequestStatus>ResultsReturnedNoError or NoResultsErrorReceived</RequestStatus>
        <ErrorMessage>
          <ErrorId>string</ErrorId>
          <ErrorMessage>string</ErrorMessage>
          <ReceivedInfoObjectType>string</ReceivedInfoObjectType>
          <ReceivedInfo />
        </ErrorMessage>
        <StatementData>
          <xsd:schema>schema</xsd:schema>xml</StatementData>
      </SearchRecurringBillingStatementsResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </SearchRecurringBillingStatementsResponse>
  </soap12:Body>
</soap12:Envelope>