ProBusinessTools Web Service

ProBusinessTools

Click here for a complete list of operations.

AddExtraTransaction

Recurring Billing Module Users Only: This method allows you to add a transaction to the customer’s scheduled billing statement OR as a "one-off" transaction against the customer’s account number. This is determined by what you provide in the AddTransactionRequest structure. If you provide a value in the StatementID property then the transaction will be appended to the statement corresponding with that ID number. If you provide no StatementID and have an AccountID, the transaction will be added to the table as a "one-off" transaction. Method returns True or False based on successful addition.

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

<?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>
    <AddExtraTransaction xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <AddTransRequest>
        <StatementID>string</StatementID>
        <AccountNumber>string</AccountNumber>
        <DateOfTrans>dateTime</DateOfTrans>
        <UnitDescription>string</UnitDescription>
        <Description>string</Description>
        <Quantity>float</Quantity>
        <Amount>float</Amount>
      </AddTransRequest>
    </AddExtraTransaction>
  </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>
    <AddExtraTransactionResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <AddExtraTransactionResult>boolean</AddExtraTransactionResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </AddExtraTransactionResponse>
  </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>
    <AddExtraTransaction xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <AddTransRequest>
        <StatementID>string</StatementID>
        <AccountNumber>string</AccountNumber>
        <DateOfTrans>dateTime</DateOfTrans>
        <UnitDescription>string</UnitDescription>
        <Description>string</Description>
        <Quantity>float</Quantity>
        <Amount>float</Amount>
      </AddTransRequest>
    </AddExtraTransaction>
  </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>
    <AddExtraTransactionResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <AddExtraTransactionResult>boolean</AddExtraTransactionResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </AddExtraTransactionResponse>
  </soap12:Body>
</soap12:Envelope>