SOAP API - GetRenderedInvoice

GetRenderedInvoice( invoiceID ) : String

Since: EngageIP v25.2

Returns the html version of the rendered invoice or throws exception if the invoice does not exist.

The results could be HTML or plain text. If the invoice has not already been rendered, it will now be rendered.

Parameters:

username (String) - The user for whom to retrieve the list of invoices. An exception will be thrown if the user name does not exist.

Returns:

An string containing the html representation of the invoice. Please note it will contain escape characters for quotations and new lines.

Possible Exceptions:

INVALID INVOICE

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>
    <GetRenderedInvoice xmlns="Logisense_EngageIP">
      <invoiceID>int</invoiceID>
    </GetRenderedInvoice>
  </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>
    <GetRenderedInvoiceResponse xmlns="Logisense_EngageIP">
      <GetRenderedInvoiceResult>string</GetRenderedInvoiceResult>
    </GetRenderedInvoiceResponse>
  </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/GetRenderedInvoice"

<?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>
    <GetRenderedInvoice xmlns="Logisense_EngageIP">
      <invoiceID>int</invoiceID>
    </GetRenderedInvoice>
  </soap:Body>
</soap:Envelope>