ProBusinessTools


Click here for a complete list of operations.

SearchRecurringBillingTransactions

Recurring Billing Module Users Only: This method returns an object array of the rbTransactionSearchResponse structure within the TransactionSearchResults structure.

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

<?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>
    <SearchRecurringBillingTransactions xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <TransactionSearchRequest>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <AccountNumber>string</AccountNumber>
        <GroupPlanName>string</GroupPlanName>
        <JobNumber>string</JobNumber>
        <RecordType>string</RecordType>
        <TransactionDateBegin>dateTime</TransactionDateBegin>
        <TransactionDateEnd>dateTime</TransactionDateEnd>
        <UnitType>string</UnitType>
      </TransactionSearchRequest>
    </SearchRecurringBillingTransactions>
  </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>
    <SearchRecurringBillingTransactionsResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <SearchRecurringBillingTransactionsResult>
        <RequestStatus>ResultsReturnedNoError or NoResultsErrorReceived</RequestStatus>
        <ErrorMessage>
          <ErrorId>string</ErrorId>
          <ErrorMessage>string</ErrorMessage>
          <ReceivedInfoObjectType>string</ReceivedInfoObjectType>
          <ReceivedInfo />
        </ErrorMessage>
        <Results>
          <TransactionSearchResponse>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <RecordType>string</RecordType>
            <MainAcctNumber>string</MainAcctNumber>
            <SubAcctNumber>string</SubAcctNumber>
            <GroupPlanName>string</GroupPlanName>
            <UnitType>string</UnitType>
            <UnitQty>double</UnitQty>
            <VendorPrice>double</VendorPrice>
            <TransactionDate>dateTime</TransactionDate>
            <Desc xsi:nil="true" />
          </TransactionSearchResponse>
          <TransactionSearchResponse>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <RecordType>string</RecordType>
            <MainAcctNumber>string</MainAcctNumber>
            <SubAcctNumber>string</SubAcctNumber>
            <GroupPlanName>string</GroupPlanName>
            <UnitType>string</UnitType>
            <UnitQty>double</UnitQty>
            <VendorPrice>double</VendorPrice>
            <TransactionDate>dateTime</TransactionDate>
            <Desc xsi:nil="true" />
          </TransactionSearchResponse>
        </Results>
      </SearchRecurringBillingTransactionsResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </SearchRecurringBillingTransactionsResponse>
  </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>
    <SearchRecurringBillingTransactions xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <TransactionSearchRequest>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <AccountNumber>string</AccountNumber>
        <GroupPlanName>string</GroupPlanName>
        <JobNumber>string</JobNumber>
        <RecordType>string</RecordType>
        <TransactionDateBegin>dateTime</TransactionDateBegin>
        <TransactionDateEnd>dateTime</TransactionDateEnd>
        <UnitType>string</UnitType>
      </TransactionSearchRequest>
    </SearchRecurringBillingTransactions>
  </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>
    <SearchRecurringBillingTransactionsResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <SearchRecurringBillingTransactionsResult>
        <RequestStatus>ResultsReturnedNoError or NoResultsErrorReceived</RequestStatus>
        <ErrorMessage>
          <ErrorId>string</ErrorId>
          <ErrorMessage>string</ErrorMessage>
          <ReceivedInfoObjectType>string</ReceivedInfoObjectType>
          <ReceivedInfo />
        </ErrorMessage>
        <Results>
          <TransactionSearchResponse>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <RecordType>string</RecordType>
            <MainAcctNumber>string</MainAcctNumber>
            <SubAcctNumber>string</SubAcctNumber>
            <GroupPlanName>string</GroupPlanName>
            <UnitType>string</UnitType>
            <UnitQty>double</UnitQty>
            <VendorPrice>double</VendorPrice>
            <TransactionDate>dateTime</TransactionDate>
            <Desc xsi:nil="true" />
          </TransactionSearchResponse>
          <TransactionSearchResponse>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <RecordType>string</RecordType>
            <MainAcctNumber>string</MainAcctNumber>
            <SubAcctNumber>string</SubAcctNumber>
            <GroupPlanName>string</GroupPlanName>
            <UnitType>string</UnitType>
            <UnitQty>double</UnitQty>
            <VendorPrice>double</VendorPrice>
            <TransactionDate>dateTime</TransactionDate>
            <Desc xsi:nil="true" />
          </TransactionSearchResponse>
        </Results>
      </SearchRecurringBillingTransactionsResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </SearchRecurringBillingTransactionsResponse>
  </soap12:Body>
</soap12:Envelope>