ProBusinessTools


Click here for a complete list of operations.

PaymentReconciliationDetail

Recurring Billing Module Users Only: This method returns an object array of ReconciliationDetail within the ReconciliationDetailResponse structure detailing each payment made to a specific statement or work order. You can specify a date range of payments along with filtering based on the collectionAgent or customerIDNumber.

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

<?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>
    <PaymentReconciliationDetail xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <ReconciliationRequest>
        <StartDateRange>string</StartDateRange>
        <EndDateRange>string</EndDateRange>
        <CollectionAgent>string</CollectionAgent>
        <CustomerIDNumber>string</CustomerIDNumber>
      </ReconciliationRequest>
    </PaymentReconciliationDetail>
  </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>
    <PaymentReconciliationDetailResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <PaymentReconciliationDetailResult>
        <OriginalReconciliationRequest>
          <StartDateRange>string</StartDateRange>
          <EndDateRange>string</EndDateRange>
          <CollectionAgent>string</CollectionAgent>
          <CustomerIDNumber>string</CustomerIDNumber>
        </OriginalReconciliationRequest>
        <Details>
          <ReconciliationDetail>
            <Type>string</Type>
            <RelatedToOrderID>string</RelatedToOrderID>
            <ForStatementNumber>string</ForStatementNumber>
            <EntryDate>dateTime</EntryDate>
            <CustomerName>string</CustomerName>
            <CustomerIDNumber>string</CustomerIDNumber>
            <Amount>double</Amount>
            <CollectionAgent>string</CollectionAgent>
            <WhoAcceptedPayment>string</WhoAcceptedPayment>
            <PaymentType>string</PaymentType>
            <PaymentRefNumber>string</PaymentRefNumber>
          </ReconciliationDetail>
          <ReconciliationDetail>
            <Type>string</Type>
            <RelatedToOrderID>string</RelatedToOrderID>
            <ForStatementNumber>string</ForStatementNumber>
            <EntryDate>dateTime</EntryDate>
            <CustomerName>string</CustomerName>
            <CustomerIDNumber>string</CustomerIDNumber>
            <Amount>double</Amount>
            <CollectionAgent>string</CollectionAgent>
            <WhoAcceptedPayment>string</WhoAcceptedPayment>
            <PaymentType>string</PaymentType>
            <PaymentRefNumber>string</PaymentRefNumber>
          </ReconciliationDetail>
        </Details>
      </PaymentReconciliationDetailResult>
    </PaymentReconciliationDetailResponse>
  </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>
    <PaymentReconciliationDetail xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <ReconciliationRequest>
        <StartDateRange>string</StartDateRange>
        <EndDateRange>string</EndDateRange>
        <CollectionAgent>string</CollectionAgent>
        <CustomerIDNumber>string</CustomerIDNumber>
      </ReconciliationRequest>
    </PaymentReconciliationDetail>
  </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>
    <PaymentReconciliationDetailResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <PaymentReconciliationDetailResult>
        <OriginalReconciliationRequest>
          <StartDateRange>string</StartDateRange>
          <EndDateRange>string</EndDateRange>
          <CollectionAgent>string</CollectionAgent>
          <CustomerIDNumber>string</CustomerIDNumber>
        </OriginalReconciliationRequest>
        <Details>
          <ReconciliationDetail>
            <Type>string</Type>
            <RelatedToOrderID>string</RelatedToOrderID>
            <ForStatementNumber>string</ForStatementNumber>
            <EntryDate>dateTime</EntryDate>
            <CustomerName>string</CustomerName>
            <CustomerIDNumber>string</CustomerIDNumber>
            <Amount>double</Amount>
            <CollectionAgent>string</CollectionAgent>
            <WhoAcceptedPayment>string</WhoAcceptedPayment>
            <PaymentType>string</PaymentType>
            <PaymentRefNumber>string</PaymentRefNumber>
          </ReconciliationDetail>
          <ReconciliationDetail>
            <Type>string</Type>
            <RelatedToOrderID>string</RelatedToOrderID>
            <ForStatementNumber>string</ForStatementNumber>
            <EntryDate>dateTime</EntryDate>
            <CustomerName>string</CustomerName>
            <CustomerIDNumber>string</CustomerIDNumber>
            <Amount>double</Amount>
            <CollectionAgent>string</CollectionAgent>
            <WhoAcceptedPayment>string</WhoAcceptedPayment>
            <PaymentType>string</PaymentType>
            <PaymentRefNumber>string</PaymentRefNumber>
          </ReconciliationDetail>
        </Details>
      </PaymentReconciliationDetailResult>
    </PaymentReconciliationDetailResponse>
  </soap12:Body>
</soap12:Envelope>