SOAP API - GetUserBalanceDue

GetUserBalanceDue( username, dueDate ) : Double

Since: EngageIP v25.2

Returns a user's balance on closed Invoices which are due as of supplied dueDate, or throws an exception if the user does not exist.

Parameters:

  • username (String) - The username for which to retrieve the current balance.  An exception will be thrown if the username does not exist.

  • dueDate (DateTime) - The date for which to get the balance due.

Returns:

The user's current balance due as a Double at the specified date

Possible Exceptions:

  • INVALID USERNAME

  • INVALID DATE


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: localhost 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> <GetUserBalanceDue xmlns="Logisense_EngageIP"> <username>string</username> <dueDate>dateTime</dueDate> </GetUserBalanceDue> </soap12:Body> </soap12:Envelope>
POST /AdminPortal/webservice.asmx/GetUserBalanceDue HTTP/1.1 Host: localhost Content-Type: application/x-www-form-urlencoded Content-Length: length username=string&dueDate=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <double xmlns="Logisense_EngageIP">double</double>



SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.