SOAP API - getPackageTaxAmount

getPackageTaxAmount( ownerID, packageID, country, state, city ) : Double

Since: EngageIP v25.2

Gets a Tax amount for the supplied Package, or throws an error if the package doesn't exist or owner is not branded.

Parameters:

  • ownerID (Integer) - The ID of the owner

  • packageID (String) - The ID of the package to check

  • country (String) - The country to check the taxation for

  • state (String) - The state to check the taxation for

  • city (String) - The city to check the taxation for

Returns:

The total tax as a Double for the billing period of the package for the provided location details

Possible Exceptions:

  • OWNER IS NOT BRANDED

  • INVALID PACKAGE ID


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> <getPackageTaxAmount xmlns="Logisense_EngageIP"> <ownerID>int</ownerID> <packageID>int</packageID> <country>string</country> <state>string</state> <city>string</city> </getPackageTaxAmount> </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> <getPackageTaxAmountResponse xmlns="Logisense_EngageIP"> <getPackageTaxAmountResult>double</getPackageTaxAmountResult> </getPackageTaxAmountResponse> </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: localhost Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "Logisense_EngageIP/getPackageTaxAmount" <?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> <getPackageTaxAmount xmlns="Logisense_EngageIP"> <ownerID>int</ownerID> <packageID>int</packageID> <country>string</country> <state>string</state> <city>string</city> </getPackageTaxAmount> </soap:Body> </soap:Envelope>