GET api/taxing/lookup/{filter}?matchPartial={matchPartial}&startingRowNumber={startingRowNumber}&rowCount={rowCount}&businessUnitId={businessUnitId}&customerId={customerId}&effectiveDate={effectiveDate}

Filter the available sales tax codes by code or description.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
filter

The text you are looking for.

string

Required

matchPartial

Allow partial match.

boolean

Default value is False

startingRowNumber

Starting row number.

integer

Default value is 0

rowCount

Maximum number of rows to return.

integer

Default value is 50

businessUnitId

A number identifying the business unit to filter results by. (Takes priority over customerId.)

integer

None.

customerId

A number identifying the customer to filter results by. (Superseded by businessUnitId.)

integer

None.

effectiveDate

The date for which to filter results by. Defaults to today.

date

None.

Body Parameters

None.

Response Information

Resource Description

An array of objects describing tax codes with their current rates.

Collection of TaxDetail
NameDescriptionTypeAdditional information
Code

Code

string

None.

Description

Description

string

None.

Rate

Tax rate as a percentage

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Rate": 3.0
  },
  {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Rate": 3.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfTaxDetail xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <TaxDetail>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <Rate>3</Rate>
  </TaxDetail>
  <TaxDetail>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <Rate>3</Rate>
  </TaxDetail>
</ArrayOfTaxDetail>