POST TaxRate/GetTaxRate

Returns a list of Tax Rates.

Request Information

URI Parameters

Body Parameters

List of Products and Customers to retrieve tax rates for.

Name	Description	Type	Additional Information
ShipTo	The ship to address to use for tax rates	string
LocationId	The location Id to use for tax rates	string	Required Max length: 6
Products	The list of products to use in the tax rate lookup	Collection of ClsTaxRateProductRequest	List cannot be empty
Customers	The list of customers to use in the tax rate lookup	Collection of ClsTaxRateCustomerRequest	List cannot be empty Maximum of 8 allowed

Request Formats

application/json, text/json

Sample:

{
  "ShipTo": "sample string 5",
  "LocationId": "sample string 6",
  "Products": [
    {
      "DeptId": "sample string 1",
      "ProdId": "sample string 2"
    },
    {
      "DeptId": "sample string 1",
      "ProdId": "sample string 2"
    }
  ],
  "Customers": [
    {
      "CustomerId": "sample string 1"
    },
    {
      "CustomerId": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<clsAPITaxRate.ClsTaxRateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI">
  <Customers>
    <clsAPITaxRate.ClsTaxRateRequest.ClsTaxRateCustomerRequest>
      <CustomerId>sample string 1</CustomerId>
    </clsAPITaxRate.ClsTaxRateRequest.ClsTaxRateCustomerRequest>
    <clsAPITaxRate.ClsTaxRateRequest.ClsTaxRateCustomerRequest>
      <CustomerId>sample string 1</CustomerId>
    </clsAPITaxRate.ClsTaxRateRequest.ClsTaxRateCustomerRequest>
  </Customers>
  <LocationId>sample string 6</LocationId>
  <Products>
    <clsAPITaxRate.ClsTaxRateRequest.ClsTaxRateProductRequest>
      <DeptId>sample string 1</DeptId>
      <ProdId>sample string 2</ProdId>
    </clsAPITaxRate.ClsTaxRateRequest.ClsTaxRateProductRequest>
    <clsAPITaxRate.ClsTaxRateRequest.ClsTaxRateProductRequest>
      <DeptId>sample string 1</DeptId>
      <ProdId>sample string 2</ProdId>
    </clsAPITaxRate.ClsTaxRateRequest.ClsTaxRateProductRequest>
  </Products>
  <ShipTo>sample string 5</ShipTo>
</clsAPITaxRate.ClsTaxRateRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsTaxRateRequest'.

Response Information

Resource Description

Returns a list of Tax Rates.

AgvTaxRate

Name	Description	Type
Status	0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.	string
Message	Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.	string
Count	Number of results returned.	string
TaxRateCustomers	List of Properties and Values returned for each Customer's Tax Rate Information.	Collection of clsAPITaxRate

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "TaxRateCustomers": [
    {
      "CustId": "sample string 6",
      "CustomerName": "sample string 7",
      "CustTaxable": true,
      "CustReason": "sample string 9",
      "TaxRateProducts": [
        {
          "DeptId": "sample string 1",
          "ProdId": "sample string 2",
          "ProductName": "sample string 3",
          "ProductTaxable": true,
          "DefaultTaxable": true,
          "TaxRateList": [
            {
              "TaxRate": 1.1,
              "StateCode": "sample string 2",
              "StateRate": 3.1,
              "StateCap": 4.1,
              "AdjCode": "sample string 5",
              "AdjRate": 6.1,
              "AdjCap": 7.1,
              "TaxString": "sample string 8",
              "ExemptReason": "sample string 9",
              "Message": "sample string 10",
              "CustomerClass": "sample string 11",
              "ProductClass": "sample string 12"
            },
            {
              "TaxRate": 1.1,
              "StateCode": "sample string 2",
              "StateRate": 3.1,
              "StateCap": 4.1,
              "AdjCode": "sample string 5",
              "AdjRate": 6.1,
              "AdjCap": 7.1,
              "TaxString": "sample string 8",
              "ExemptReason": "sample string 9",
              "Message": "sample string 10",
              "CustomerClass": "sample string 11",
              "ProductClass": "sample string 12"
            }
          ]
        },
        {
          "DeptId": "sample string 1",
          "ProdId": "sample string 2",
          "ProductName": "sample string 3",
          "ProductTaxable": true,
          "DefaultTaxable": true,
          "TaxRateList": [
            {
              "TaxRate": 1.1,
              "StateCode": "sample string 2",
              "StateRate": 3.1,
              "StateCap": 4.1,
              "AdjCode": "sample string 5",
              "AdjRate": 6.1,
              "AdjCap": 7.1,
              "TaxString": "sample string 8",
              "ExemptReason": "sample string 9",
              "Message": "sample string 10",
              "CustomerClass": "sample string 11",
              "ProductClass": "sample string 12"
            },
            {
              "TaxRate": 1.1,
              "StateCode": "sample string 2",
              "StateRate": 3.1,
              "StateCap": 4.1,
              "AdjCode": "sample string 5",
              "AdjRate": 6.1,
              "AdjCap": 7.1,
              "TaxString": "sample string 8",
              "ExemptReason": "sample string 9",
              "Message": "sample string 10",
              "CustomerClass": "sample string 11",
              "ProductClass": "sample string 12"
            }
          ]
        }
      ]
    },
    {
      "CustId": "sample string 6",
      "CustomerName": "sample string 7",
      "CustTaxable": true,
      "CustReason": "sample string 9",
      "TaxRateProducts": [
        {
          "DeptId": "sample string 1",
          "ProdId": "sample string 2",
          "ProductName": "sample string 3",
          "ProductTaxable": true,
          "DefaultTaxable": true,
          "TaxRateList": [
            {
              "TaxRate": 1.1,
              "StateCode": "sample string 2",
              "StateRate": 3.1,
              "StateCap": 4.1,
              "AdjCode": "sample string 5",
              "AdjRate": 6.1,
              "AdjCap": 7.1,
              "TaxString": "sample string 8",
              "ExemptReason": "sample string 9",
              "Message": "sample string 10",
              "CustomerClass": "sample string 11",
              "ProductClass": "sample string 12"
            },
            {
              "TaxRate": 1.1,
              "StateCode": "sample string 2",
              "StateRate": 3.1,
              "StateCap": 4.1,
              "AdjCode": "sample string 5",
              "AdjRate": 6.1,
              "AdjCap": 7.1,
              "TaxString": "sample string 8",
              "ExemptReason": "sample string 9",
              "Message": "sample string 10",
              "CustomerClass": "sample string 11",
              "ProductClass": "sample string 12"
            }
          ]
        },
        {
          "DeptId": "sample string 1",
          "ProdId": "sample string 2",
          "ProductName": "sample string 3",
          "ProductTaxable": true,
          "DefaultTaxable": true,
          "TaxRateList": [
            {
              "TaxRate": 1.1,
              "StateCode": "sample string 2",
              "StateRate": 3.1,
              "StateCap": 4.1,
              "AdjCode": "sample string 5",
              "AdjRate": 6.1,
              "AdjCap": 7.1,
              "TaxString": "sample string 8",
              "ExemptReason": "sample string 9",
              "Message": "sample string 10",
              "CustomerClass": "sample string 11",
              "ProductClass": "sample string 12"
            },
            {
              "TaxRate": 1.1,
              "StateCode": "sample string 2",
              "StateRate": 3.1,
              "StateCap": 4.1,
              "AdjCode": "sample string 5",
              "AdjRate": 6.1,
              "AdjCap": 7.1,
              "TaxString": "sample string 8",
              "ExemptReason": "sample string 9",
              "Message": "sample string 10",
              "CustomerClass": "sample string 11",
              "ProductClass": "sample string 12"
            }
          ]
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<AgvTaxRate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Inventory.SalesOrder">
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <TaxRateCustomers xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI">
    <d2p1:clsAPITaxRate>
      <d2p1:CustId>sample string 6</d2p1:CustId>
      <d2p1:CustReason>sample string 9</d2p1:CustReason>
      <d2p1:CustTaxable>true</d2p1:CustTaxable>
      <d2p1:CustomerName>sample string 7</d2p1:CustomerName>
      <d2p1:TaxRateProducts>
        <d2p1:clsAPITaxRate.ClsTaxRateProductInfo>
          <d2p1:DefaultTaxable>true</d2p1:DefaultTaxable>
          <d2p1:DeptId>sample string 1</d2p1:DeptId>
          <d2p1:ProdId>sample string 2</d2p1:ProdId>
          <d2p1:ProductName>sample string 3</d2p1:ProductName>
          <d2p1:ProductTaxable>true</d2p1:ProductTaxable>
          <d2p1:TaxRateList>
            <d2p1:clsAPITaxRate.ClsTaxRateInfo>
              <d2p1:AdjCap>7.1</d2p1:AdjCap>
              <d2p1:AdjCode>sample string 5</d2p1:AdjCode>
              <d2p1:AdjRate>6.1</d2p1:AdjRate>
              <d2p1:CustomerClass>sample string 11</d2p1:CustomerClass>
              <d2p1:ExemptReason>sample string 9</d2p1:ExemptReason>
              <d2p1:Message>sample string 10</d2p1:Message>
              <d2p1:ProductClass>sample string 12</d2p1:ProductClass>
              <d2p1:StateCap>4.1</d2p1:StateCap>
              <d2p1:StateCode>sample string 2</d2p1:StateCode>
              <d2p1:StateRate>3.1</d2p1:StateRate>
              <d2p1:TaxRate>1.1</d2p1:TaxRate>
              <d2p1:TaxString>sample string 8</d2p1:TaxString>
            </d2p1:clsAPITaxRate.ClsTaxRateInfo>
            <d2p1:clsAPITaxRate.ClsTaxRateInfo>
              <d2p1:AdjCap>7.1</d2p1:AdjCap>
              <d2p1:AdjCode>sample string 5</d2p1:AdjCode>
              <d2p1:AdjRate>6.1</d2p1:AdjRate>
              <d2p1:CustomerClass>sample string 11</d2p1:CustomerClass>
              <d2p1:ExemptReason>sample string 9</d2p1:ExemptReason>
              <d2p1:Message>sample string 10</d2p1:Message>
              <d2p1:ProductClass>sample string 12</d2p1:ProductClass>
              <d2p1:StateCap>4.1</d2p1:StateCap>
              <d2p1:StateCode>sample string 2</d2p1:StateCode>
              <d2p1:StateRate>3.1</d2p1:StateRate>
              <d2p1:TaxRate>1.1</d2p1:TaxRate>
              <d2p1:TaxString>sample string 8</d2p1:TaxString>
            </d2p1:clsAPITaxRate.ClsTaxRateInfo>
          </d2p1:TaxRateList>
        </d2p1:clsAPITaxRate.ClsTaxRateProductInfo>
        <d2p1:clsAPITaxRate.ClsTaxRateProductInfo>
          <d2p1:DefaultTaxable>true</d2p1:DefaultTaxable>
          <d2p1:DeptId>sample string 1</d2p1:DeptId>
          <d2p1:ProdId>sample string 2</d2p1:ProdId>
          <d2p1:ProductName>sample string 3</d2p1:ProductName>
          <d2p1:ProductTaxable>true</d2p1:ProductTaxable>
          <d2p1:TaxRateList>
            <d2p1:clsAPITaxRate.ClsTaxRateInfo>
              <d2p1:AdjCap>7.1</d2p1:AdjCap>
              <d2p1:AdjCode>sample string 5</d2p1:AdjCode>
              <d2p1:AdjRate>6.1</d2p1:AdjRate>
              <d2p1:CustomerClass>sample string 11</d2p1:CustomerClass>
              <d2p1:ExemptReason>sample string 9</d2p1:ExemptReason>
              <d2p1:Message>sample string 10</d2p1:Message>
              <d2p1:ProductClass>sample string 12</d2p1:ProductClass>
              <d2p1:StateCap>4.1</d2p1:StateCap>
              <d2p1:StateCode>sample string 2</d2p1:StateCode>
              <d2p1:StateRate>3.1</d2p1:StateRate>
              <d2p1:TaxRate>1.1</d2p1:TaxRate>
              <d2p1:TaxString>sample string 8</d2p1:TaxString>
            </d2p1:clsAPITaxRate.ClsTaxRateInfo>
            <d2p1:clsAPITaxRate.ClsTaxRateInfo>
              <d2p1:AdjCap>7.1</d2p1:AdjCap>
              <d2p1:AdjCode>sample string 5</d2p1:AdjCode>
              <d2p1:AdjRate>6.1</d2p1:AdjRate>
              <d2p1:CustomerClass>sample string 11</d2p1:CustomerClass>
              <d2p1:ExemptReason>sample string 9</d2p1:ExemptReason>
              <d2p1:Message>sample string 10</d2p1:Message>
              <d2p1:ProductClass>sample string 12</d2p1:ProductClass>
              <d2p1:StateCap>4.1</d2p1:StateCap>
              <d2p1:StateCode>sample string 2</d2p1:StateCode>
              <d2p1:StateRate>3.1</d2p1:StateRate>
              <d2p1:TaxRate>1.1</d2p1:TaxRate>
              <d2p1:TaxString>sample string 8</d2p1:TaxString>
            </d2p1:clsAPITaxRate.ClsTaxRateInfo>
          </d2p1:TaxRateList>
        </d2p1:clsAPITaxRate.ClsTaxRateProductInfo>
      </d2p1:TaxRateProducts>
    </d2p1:clsAPITaxRate>
    <d2p1:clsAPITaxRate>
      <d2p1:CustId>sample string 6</d2p1:CustId>
      <d2p1:CustReason>sample string 9</d2p1:CustReason>
      <d2p1:CustTaxable>true</d2p1:CustTaxable>
      <d2p1:CustomerName>sample string 7</d2p1:CustomerName>
      <d2p1:TaxRateProducts>
        <d2p1:clsAPITaxRate.ClsTaxRateProductInfo>
          <d2p1:DefaultTaxable>true</d2p1:DefaultTaxable>
          <d2p1:DeptId>sample string 1</d2p1:DeptId>
          <d2p1:ProdId>sample string 2</d2p1:ProdId>
          <d2p1:ProductName>sample string 3</d2p1:ProductName>
          <d2p1:ProductTaxable>true</d2p1:ProductTaxable>
          <d2p1:TaxRateList>
            <d2p1:clsAPITaxRate.ClsTaxRateInfo>
              <d2p1:AdjCap>7.1</d2p1:AdjCap>
              <d2p1:AdjCode>sample string 5</d2p1:AdjCode>
              <d2p1:AdjRate>6.1</d2p1:AdjRate>
              <d2p1:CustomerClass>sample string 11</d2p1:CustomerClass>
              <d2p1:ExemptReason>sample string 9</d2p1:ExemptReason>
              <d2p1:Message>sample string 10</d2p1:Message>
              <d2p1:ProductClass>sample string 12</d2p1:ProductClass>
              <d2p1:StateCap>4.1</d2p1:StateCap>
              <d2p1:StateCode>sample string 2</d2p1:StateCode>
              <d2p1:StateRate>3.1</d2p1:StateRate>
              <d2p1:TaxRate>1.1</d2p1:TaxRate>
              <d2p1:TaxString>sample string 8</d2p1:TaxString>
            </d2p1:clsAPITaxRate.ClsTaxRateInfo>
            <d2p1:clsAPITaxRate.ClsTaxRateInfo>
              <d2p1:AdjCap>7.1</d2p1:AdjCap>
              <d2p1:AdjCode>sample string 5</d2p1:AdjCode>
              <d2p1:AdjRate>6.1</d2p1:AdjRate>
              <d2p1:CustomerClass>sample string 11</d2p1:CustomerClass>
              <d2p1:ExemptReason>sample string 9</d2p1:ExemptReason>
              <d2p1:Message>sample string 10</d2p1:Message>
              <d2p1:ProductClass>sample string 12</d2p1:ProductClass>
              <d2p1:StateCap>4.1</d2p1:StateCap>
              <d2p1:StateCode>sample string 2</d2p1:StateCode>
              <d2p1:StateRate>3.1</d2p1:StateRate>
              <d2p1:TaxRate>1.1</d2p1:TaxRate>
              <d2p1:TaxString>sample string 8</d2p1:TaxString>
            </d2p1:clsAPITaxRate.ClsTaxRateInfo>
          </d2p1:TaxRateList>
        </d2p1:clsAPITaxRate.ClsTaxRateProductInfo>
        <d2p1:clsAPITaxRate.ClsTaxRateProductInfo>
          <d2p1:DefaultTaxable>true</d2p1:DefaultTaxable>
          <d2p1:DeptId>sample string 1</d2p1:DeptId>
          <d2p1:ProdId>sample string 2</d2p1:ProdId>
          <d2p1:ProductName>sample string 3</d2p1:ProductName>
          <d2p1:ProductTaxable>true</d2p1:ProductTaxable>
          <d2p1:TaxRateList>
            <d2p1:clsAPITaxRate.ClsTaxRateInfo>
              <d2p1:AdjCap>7.1</d2p1:AdjCap>
              <d2p1:AdjCode>sample string 5</d2p1:AdjCode>
              <d2p1:AdjRate>6.1</d2p1:AdjRate>
              <d2p1:CustomerClass>sample string 11</d2p1:CustomerClass>
              <d2p1:ExemptReason>sample string 9</d2p1:ExemptReason>
              <d2p1:Message>sample string 10</d2p1:Message>
              <d2p1:ProductClass>sample string 12</d2p1:ProductClass>
              <d2p1:StateCap>4.1</d2p1:StateCap>
              <d2p1:StateCode>sample string 2</d2p1:StateCode>
              <d2p1:StateRate>3.1</d2p1:StateRate>
              <d2p1:TaxRate>1.1</d2p1:TaxRate>
              <d2p1:TaxString>sample string 8</d2p1:TaxString>
            </d2p1:clsAPITaxRate.ClsTaxRateInfo>
            <d2p1:clsAPITaxRate.ClsTaxRateInfo>
              <d2p1:AdjCap>7.1</d2p1:AdjCap>
              <d2p1:AdjCode>sample string 5</d2p1:AdjCode>
              <d2p1:AdjRate>6.1</d2p1:AdjRate>
              <d2p1:CustomerClass>sample string 11</d2p1:CustomerClass>
              <d2p1:ExemptReason>sample string 9</d2p1:ExemptReason>
              <d2p1:Message>sample string 10</d2p1:Message>
              <d2p1:ProductClass>sample string 12</d2p1:ProductClass>
              <d2p1:StateCap>4.1</d2p1:StateCap>
              <d2p1:StateCode>sample string 2</d2p1:StateCode>
              <d2p1:StateRate>3.1</d2p1:StateRate>
              <d2p1:TaxRate>1.1</d2p1:TaxRate>
              <d2p1:TaxString>sample string 8</d2p1:TaxString>
            </d2p1:clsAPITaxRate.ClsTaxRateInfo>
          </d2p1:TaxRateList>
        </d2p1:clsAPITaxRate.ClsTaxRateProductInfo>
      </d2p1:TaxRateProducts>
    </d2p1:clsAPITaxRate>
  </TaxRateCustomers>
</AgvTaxRate>