GET api/taxing/checktaxcode?taxCode={taxCode}&customerId={customerId}&effectiveDate={effectiveDate}

Validates if a tax code is valid for a particular customer

Request Information

URI Parameters

NameDescriptionTypeAdditional information
taxCode

The tax code to check

string

Required

customerId

The identification number for the customer

integer

Required

effectiveDate

The date for which to validate the tax code. Defaults to today.

date

None.

Body Parameters

None.

Response Information

Resource Description

An object describing the validation results

TaxCodeValidationResult
NameDescriptionTypeAdditional information
TaxCodeFound

Was the tax code found anywhere in the system

boolean

None.

TaxCodeValidForCustomer

Is the tax code valid for the supplied customerId

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "TaxCodeFound": true,
  "TaxCodeValidForCustomer": true
}

application/xml, text/xml

Sample:
<TaxCodeValidationResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <TaxCodeFound>true</TaxCodeFound>
  <TaxCodeValidForCustomer>true</TaxCodeValidForCustomer>
</TaxCodeValidationResult>