SOAP API - AddPayment

AddPayment( username, amount, detail, paymenttype, paymentDate, isAutoDisperse, cardType, CheckNumber) : void

Since: EngageIP v25.2

Adds a payment to the specified user

Parameters:

username (String) - The username of the user in which to add the payment. An exception will be thrown if the username does not exist.
amount (Double) - The amount of the payment. An exception will be thrown if this value <= zero.
detail (String) - Details to be noted about the payment.
paymentype (String) - The type of payment made. An exception will be thrown if this payment type does not exist.
paymentDate (DateTime) - The date of the payment
isAutoDisperse (Boolean) - Should this be dispersed automatically. NOTE: Payments are dispersed by oldest invoice with an outstanding balance first.
cardType (String) - Type of credit card if payment type is credit card.
CheckNumber (Integer) - The check number if payment type is check.

Possible Exceptions:

INVALID USERNAME
INVALID AMOUNT
INVALID PAYMENT TYPE
USER STATUS DOES NOT ALLOW PAYMENT
INVALID CARD TYPE
INVALID CHECK NUMBER

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 /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.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:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <AddPayment xmlns="Logisense_EngageIP">
      <username>string</username>
      <amount>double</amount>
      <detail>string</detail>
      <paymenttype>string</paymenttype>
      <paymentDate>dateTime</paymentDate>
      <isAutoDisburse>boolean</isAutoDisburse>
      <cardType>string</cardType>
      <CheckNumber>int</CheckNumber>
    </AddPayment>
  </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>
    <AddCountryResponse xmlns="Logisense_EngageIP" />
  </soap12:Body>
</soap12:Envelope>

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 /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/AddPayment"

<?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:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <AddPayment xmlns="Logisense_EngageIP">
      <username>string</username>
      <amount>double</amount>
      <detail>string</detail>
      <paymenttype>string</paymenttype>
      <paymentDate>dateTime</paymentDate>
      <isAutoDisburse>boolean</isAutoDisburse>
      <cardType>string</cardType>
      <CheckNumber>int</CheckNumber>
    </AddPayment>
  </soap:Body>
</soap:Envelope>