ProBusinessTools


Click here for a complete list of operations.

WorkOrderPayment

This method allows you to enter a customer payment to a specific work order. In the WorkOrderPaymentRequest structure you must include a valid OrderID.

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

<?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>
    <WorkOrderPayment xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <PaymentRequest>
        <OrderID>string</OrderID>
        <PaymentDate>dateTime</PaymentDate>
        <PaymentNumber>string</PaymentNumber>
        <AmountPaid>double</AmountPaid>
        <ChartOfAccountID>int</ChartOfAccountID>
        <CollectionAgent>string</CollectionAgent>
        <PaymentType>None or Cash or Check or CreditCard or Credit or Void or DebitCard</PaymentType>
      </PaymentRequest>
    </WorkOrderPayment>
  </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>
    <WorkOrderPaymentResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <WorkOrderPaymentResult>
        <OrderID>string</OrderID>
        <PaidAmount>double</PaidAmount>
        <Balance>double</Balance>
        <ErrorMessage>
          <ErrorId>string</ErrorId>
          <ErrorMessage>string</ErrorMessage>
          <ReceivedInfoObjectType>string</ReceivedInfoObjectType>
          <ReceivedInfo />
        </ErrorMessage>
      </WorkOrderPaymentResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </WorkOrderPaymentResponse>
  </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>
    <WorkOrderPayment xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <PaymentRequest>
        <OrderID>string</OrderID>
        <PaymentDate>dateTime</PaymentDate>
        <PaymentNumber>string</PaymentNumber>
        <AmountPaid>double</AmountPaid>
        <ChartOfAccountID>int</ChartOfAccountID>
        <CollectionAgent>string</CollectionAgent>
        <PaymentType>None or Cash or Check or CreditCard or Credit or Void or DebitCard</PaymentType>
      </PaymentRequest>
    </WorkOrderPayment>
  </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>
    <WorkOrderPaymentResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <WorkOrderPaymentResult>
        <OrderID>string</OrderID>
        <PaidAmount>double</PaidAmount>
        <Balance>double</Balance>
        <ErrorMessage>
          <ErrorId>string</ErrorId>
          <ErrorMessage>string</ErrorMessage>
          <ReceivedInfoObjectType>string</ReceivedInfoObjectType>
          <ReceivedInfo />
        </ErrorMessage>
      </WorkOrderPaymentResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </WorkOrderPaymentResponse>
  </soap12:Body>
</soap12:Envelope>