PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getTaxCode

Returns the tax code information for the specified tax code.

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 /PIP/PublicAPIService.asmx HTTP/1.1
Host: lbm-sharp.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/getTaxCode"

<?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>
    <getTaxCode xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <TaxCode>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </TaxCode>
    </getTaxCode>
  </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>
    <getTaxCodeResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getTaxCodeResult>
        <TaxCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TaxCode>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <TaxRate>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </TaxRate>
        <Active>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Active>
        <optState>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optState>
        <optCounty>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optCounty>
        <optCity>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optCity>
        <Authorities>
          <TaxAuthorityData>
            <TaxAuthority xsi:nil="true" />
            <Description xsi:nil="true" />
            <Rate xsi:nil="true" />
            <Type xsi:nil="true" />
            <Active xsi:nil="true" />
            <optState xsi:nil="true" />
          </TaxAuthorityData>
          <TaxAuthorityData>
            <TaxAuthority xsi:nil="true" />
            <Description xsi:nil="true" />
            <Rate xsi:nil="true" />
            <Type xsi:nil="true" />
            <Active xsi:nil="true" />
            <optState xsi:nil="true" />
          </TaxAuthorityData>
        </Authorities>
      </getTaxCodeResult>
    </getTaxCodeResponse>
  </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 /PIP/PublicAPIService.asmx HTTP/1.1
Host: lbm-sharp.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>
    <getTaxCode xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <TaxCode>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </TaxCode>
    </getTaxCode>
  </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>
    <getTaxCodeResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getTaxCodeResult>
        <TaxCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TaxCode>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <TaxRate>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </TaxRate>
        <Active>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Active>
        <optState>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optState>
        <optCounty>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optCounty>
        <optCity>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optCity>
        <Authorities>
          <TaxAuthorityData>
            <TaxAuthority xsi:nil="true" />
            <Description xsi:nil="true" />
            <Rate xsi:nil="true" />
            <Type xsi:nil="true" />
            <Active xsi:nil="true" />
            <optState xsi:nil="true" />
          </TaxAuthorityData>
          <TaxAuthorityData>
            <TaxAuthority xsi:nil="true" />
            <Description xsi:nil="true" />
            <Rate xsi:nil="true" />
            <Type xsi:nil="true" />
            <Active xsi:nil="true" />
            <optState xsi:nil="true" />
          </TaxAuthorityData>
        </Authorities>
      </getTaxCodeResult>
    </getTaxCodeResponse>
  </soap12:Body>
</soap12:Envelope>