Internal API-Guide

GET api/Avalara/Tax

Request Information

URI Parameters

None.

Body Parameters

Collection of WorkOrderBatch
NameDescriptionTypeAdditional information
WorkOrderID

string None.
InvoiceLines

Collection of InvoiceLine None.
RequestType

string None.
RequestCode

string None.
ZipCode

string None.
StateID

string None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "workOrderID": "sample string 1",
    "invoiceLines": [
      {
        "invoiceId": "sample string 1",
        "invoiceLineId": "sample string 2",
        "lineItemTypeID": "sample string 3",
        "laborRateType": "sample string 4",
        "skillLevel": "sample string 5",
        "chargeType": "sample string 6",
        "preMarkupUnitCost": "sample string 7",
        "preMarkupQuantity": "sample string 8",
        "preMarkupLineItemCost": "sample string 9",
        "unitCost": "sample string 10",
        "quantity": "sample string 11",
        "lineItemCost": "sample string 12",
        "taxAmount": "sample string 13",
        "taxRate": "sample string 14",
        "avalaraId": "sample string 15",
        "taxCode": "sample string 16",
        "description": "sample string 17",
        "isMarkupOrTaxationLineItem": "sample string 18"
      },
      {
        "invoiceId": "sample string 1",
        "invoiceLineId": "sample string 2",
        "lineItemTypeID": "sample string 3",
        "laborRateType": "sample string 4",
        "skillLevel": "sample string 5",
        "chargeType": "sample string 6",
        "preMarkupUnitCost": "sample string 7",
        "preMarkupQuantity": "sample string 8",
        "preMarkupLineItemCost": "sample string 9",
        "unitCost": "sample string 10",
        "quantity": "sample string 11",
        "lineItemCost": "sample string 12",
        "taxAmount": "sample string 13",
        "taxRate": "sample string 14",
        "avalaraId": "sample string 15",
        "taxCode": "sample string 16",
        "description": "sample string 17",
        "isMarkupOrTaxationLineItem": "sample string 18"
      }
    ],
    "requestType": "sample string 2",
    "requestCode": "sample string 3",
    "zipCode": "sample string 4",
    "stateID": "sample string 5"
  },
  {
    "workOrderID": "sample string 1",
    "invoiceLines": [
      {
        "invoiceId": "sample string 1",
        "invoiceLineId": "sample string 2",
        "lineItemTypeID": "sample string 3",
        "laborRateType": "sample string 4",
        "skillLevel": "sample string 5",
        "chargeType": "sample string 6",
        "preMarkupUnitCost": "sample string 7",
        "preMarkupQuantity": "sample string 8",
        "preMarkupLineItemCost": "sample string 9",
        "unitCost": "sample string 10",
        "quantity": "sample string 11",
        "lineItemCost": "sample string 12",
        "taxAmount": "sample string 13",
        "taxRate": "sample string 14",
        "avalaraId": "sample string 15",
        "taxCode": "sample string 16",
        "description": "sample string 17",
        "isMarkupOrTaxationLineItem": "sample string 18"
      },
      {
        "invoiceId": "sample string 1",
        "invoiceLineId": "sample string 2",
        "lineItemTypeID": "sample string 3",
        "laborRateType": "sample string 4",
        "skillLevel": "sample string 5",
        "chargeType": "sample string 6",
        "preMarkupUnitCost": "sample string 7",
        "preMarkupQuantity": "sample string 8",
        "preMarkupLineItemCost": "sample string 9",
        "unitCost": "sample string 10",
        "quantity": "sample string 11",
        "lineItemCost": "sample string 12",
        "taxAmount": "sample string 13",
        "taxRate": "sample string 14",
        "avalaraId": "sample string 15",
        "taxCode": "sample string 16",
        "description": "sample string 17",
        "isMarkupOrTaxationLineItem": "sample string 18"
      }
    ],
    "requestType": "sample string 2",
    "requestCode": "sample string 3",
    "zipCode": "sample string 4",
    "stateID": "sample string 5"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfWorkOrderBatch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fmPilot.API.Internal.Models">
  <WorkOrderBatch>
    <InvoiceLines>
      <InvoiceLine>
        <AvalaraId>sample string 15</AvalaraId>
        <ChargeType>sample string 6</ChargeType>
        <Description>sample string 17</Description>
        <InvoiceId>sample string 1</InvoiceId>
        <InvoiceLineId>sample string 2</InvoiceLineId>
        <IsMarkupOrTaxationLineItem>sample string 18</IsMarkupOrTaxationLineItem>
        <LaborRateType>sample string 4</LaborRateType>
        <LineItemCost>sample string 12</LineItemCost>
        <LineItemTypeID>sample string 3</LineItemTypeID>
        <PreMarkupLineItemCost>sample string 9</PreMarkupLineItemCost>
        <PreMarkupQuantity>sample string 8</PreMarkupQuantity>
        <PreMarkupUnitCost>sample string 7</PreMarkupUnitCost>
        <Quantity>sample string 11</Quantity>
        <SkillLevel>sample string 5</SkillLevel>
        <TaxAmount>sample string 13</TaxAmount>
        <TaxCode>sample string 16</TaxCode>
        <TaxRate>sample string 14</TaxRate>
        <UnitCost>sample string 10</UnitCost>
      </InvoiceLine>
      <InvoiceLine>
        <AvalaraId>sample string 15</AvalaraId>
        <ChargeType>sample string 6</ChargeType>
        <Description>sample string 17</Description>
        <InvoiceId>sample string 1</InvoiceId>
        <InvoiceLineId>sample string 2</InvoiceLineId>
        <IsMarkupOrTaxationLineItem>sample string 18</IsMarkupOrTaxationLineItem>
        <LaborRateType>sample string 4</LaborRateType>
        <LineItemCost>sample string 12</LineItemCost>
        <LineItemTypeID>sample string 3</LineItemTypeID>
        <PreMarkupLineItemCost>sample string 9</PreMarkupLineItemCost>
        <PreMarkupQuantity>sample string 8</PreMarkupQuantity>
        <PreMarkupUnitCost>sample string 7</PreMarkupUnitCost>
        <Quantity>sample string 11</Quantity>
        <SkillLevel>sample string 5</SkillLevel>
        <TaxAmount>sample string 13</TaxAmount>
        <TaxCode>sample string 16</TaxCode>
        <TaxRate>sample string 14</TaxRate>
        <UnitCost>sample string 10</UnitCost>
      </InvoiceLine>
    </InvoiceLines>
    <RequestCode>sample string 3</RequestCode>
    <RequestType>sample string 2</RequestType>
    <StateID>sample string 5</StateID>
    <WorkOrderID>sample string 1</WorkOrderID>
    <ZipCode>sample string 4</ZipCode>
  </WorkOrderBatch>
  <WorkOrderBatch>
    <InvoiceLines>
      <InvoiceLine>
        <AvalaraId>sample string 15</AvalaraId>
        <ChargeType>sample string 6</ChargeType>
        <Description>sample string 17</Description>
        <InvoiceId>sample string 1</InvoiceId>
        <InvoiceLineId>sample string 2</InvoiceLineId>
        <IsMarkupOrTaxationLineItem>sample string 18</IsMarkupOrTaxationLineItem>
        <LaborRateType>sample string 4</LaborRateType>
        <LineItemCost>sample string 12</LineItemCost>
        <LineItemTypeID>sample string 3</LineItemTypeID>
        <PreMarkupLineItemCost>sample string 9</PreMarkupLineItemCost>
        <PreMarkupQuantity>sample string 8</PreMarkupQuantity>
        <PreMarkupUnitCost>sample string 7</PreMarkupUnitCost>
        <Quantity>sample string 11</Quantity>
        <SkillLevel>sample string 5</SkillLevel>
        <TaxAmount>sample string 13</TaxAmount>
        <TaxCode>sample string 16</TaxCode>
        <TaxRate>sample string 14</TaxRate>
        <UnitCost>sample string 10</UnitCost>
      </InvoiceLine>
      <InvoiceLine>
        <AvalaraId>sample string 15</AvalaraId>
        <ChargeType>sample string 6</ChargeType>
        <Description>sample string 17</Description>
        <InvoiceId>sample string 1</InvoiceId>
        <InvoiceLineId>sample string 2</InvoiceLineId>
        <IsMarkupOrTaxationLineItem>sample string 18</IsMarkupOrTaxationLineItem>
        <LaborRateType>sample string 4</LaborRateType>
        <LineItemCost>sample string 12</LineItemCost>
        <LineItemTypeID>sample string 3</LineItemTypeID>
        <PreMarkupLineItemCost>sample string 9</PreMarkupLineItemCost>
        <PreMarkupQuantity>sample string 8</PreMarkupQuantity>
        <PreMarkupUnitCost>sample string 7</PreMarkupUnitCost>
        <Quantity>sample string 11</Quantity>
        <SkillLevel>sample string 5</SkillLevel>
        <TaxAmount>sample string 13</TaxAmount>
        <TaxCode>sample string 16</TaxCode>
        <TaxRate>sample string 14</TaxRate>
        <UnitCost>sample string 10</UnitCost>
      </InvoiceLine>
    </InvoiceLines>
    <RequestCode>sample string 3</RequestCode>
    <RequestType>sample string 2</RequestType>
    <StateID>sample string 5</StateID>
    <WorkOrderID>sample string 1</WorkOrderID>
    <ZipCode>sample string 4</ZipCode>
  </WorkOrderBatch>
</ArrayOfWorkOrderBatch>

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 'List`1'.

Response Information

Resource Description

Collection of AvalaraTaxResponse
NameDescriptionTypeAdditional information
WorkOrderID

string None.
InvoiceLines

Collection of AvalaraInvoiceLine None.
Success

string None.
ErrorMessage

string None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "workOrderID": "sample string 1",
    "invoiceLines": [
      {
        "invoiceLineID": "sample string 1",
        "lineItemTypeID": "sample string 2",
        "lineItemCost": "sample string 3",
        "taxAmount": "sample string 4",
        "taxRate": "sample string 5",
        "avalaraID": "sample string 6",
        "taxCode": "sample string 7",
        "description": "sample string 8"
      },
      {
        "invoiceLineID": "sample string 1",
        "lineItemTypeID": "sample string 2",
        "lineItemCost": "sample string 3",
        "taxAmount": "sample string 4",
        "taxRate": "sample string 5",
        "avalaraID": "sample string 6",
        "taxCode": "sample string 7",
        "description": "sample string 8"
      }
    ],
    "success": "sample string 2",
    "errorMessage": "sample string 3"
  },
  {
    "workOrderID": "sample string 1",
    "invoiceLines": [
      {
        "invoiceLineID": "sample string 1",
        "lineItemTypeID": "sample string 2",
        "lineItemCost": "sample string 3",
        "taxAmount": "sample string 4",
        "taxRate": "sample string 5",
        "avalaraID": "sample string 6",
        "taxCode": "sample string 7",
        "description": "sample string 8"
      },
      {
        "invoiceLineID": "sample string 1",
        "lineItemTypeID": "sample string 2",
        "lineItemCost": "sample string 3",
        "taxAmount": "sample string 4",
        "taxRate": "sample string 5",
        "avalaraID": "sample string 6",
        "taxCode": "sample string 7",
        "description": "sample string 8"
      }
    ],
    "success": "sample string 2",
    "errorMessage": "sample string 3"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfAvalaraTaxResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fmPilot.API.Internal.Models">
  <AvalaraTaxResponse>
    <ErrorMessage>sample string 3</ErrorMessage>
    <InvoiceLines>
      <AvalaraInvoiceLine>
        <AvalaraID>sample string 6</AvalaraID>
        <Description>sample string 8</Description>
        <InvoiceLineID>sample string 1</InvoiceLineID>
        <LineItemCost>sample string 3</LineItemCost>
        <LineItemTypeID>sample string 2</LineItemTypeID>
        <TaxAmount>sample string 4</TaxAmount>
        <TaxCode>sample string 7</TaxCode>
        <TaxRate>sample string 5</TaxRate>
      </AvalaraInvoiceLine>
      <AvalaraInvoiceLine>
        <AvalaraID>sample string 6</AvalaraID>
        <Description>sample string 8</Description>
        <InvoiceLineID>sample string 1</InvoiceLineID>
        <LineItemCost>sample string 3</LineItemCost>
        <LineItemTypeID>sample string 2</LineItemTypeID>
        <TaxAmount>sample string 4</TaxAmount>
        <TaxCode>sample string 7</TaxCode>
        <TaxRate>sample string 5</TaxRate>
      </AvalaraInvoiceLine>
    </InvoiceLines>
    <Success>sample string 2</Success>
    <WorkOrderID>sample string 1</WorkOrderID>
  </AvalaraTaxResponse>
  <AvalaraTaxResponse>
    <ErrorMessage>sample string 3</ErrorMessage>
    <InvoiceLines>
      <AvalaraInvoiceLine>
        <AvalaraID>sample string 6</AvalaraID>
        <Description>sample string 8</Description>
        <InvoiceLineID>sample string 1</InvoiceLineID>
        <LineItemCost>sample string 3</LineItemCost>
        <LineItemTypeID>sample string 2</LineItemTypeID>
        <TaxAmount>sample string 4</TaxAmount>
        <TaxCode>sample string 7</TaxCode>
        <TaxRate>sample string 5</TaxRate>
      </AvalaraInvoiceLine>
      <AvalaraInvoiceLine>
        <AvalaraID>sample string 6</AvalaraID>
        <Description>sample string 8</Description>
        <InvoiceLineID>sample string 1</InvoiceLineID>
        <LineItemCost>sample string 3</LineItemCost>
        <LineItemTypeID>sample string 2</LineItemTypeID>
        <TaxAmount>sample string 4</TaxAmount>
        <TaxCode>sample string 7</TaxCode>
        <TaxRate>sample string 5</TaxRate>
      </AvalaraInvoiceLine>
    </InvoiceLines>
    <Success>sample string 2</Success>
    <WorkOrderID>sample string 1</WorkOrderID>
  </AvalaraTaxResponse>
</ArrayOfAvalaraTaxResponse>