Tax Area Lookup API fields

This table lists the fields included in the request body for O Series Tax Area Lookup API requests.

Field	Details	Description
`asOfDate`	string `<date>`	A date that provides time perspective for a Tax Area Lookup. Tax Area IDs returned for the lookup are based on the jurisdiction boundaries in effect as of this date. Defaults to the current date.
`beginDate`	required string `<date>` (`searchDate`)	Begin date for the search.
`endDate`	string `<date>` (`searchDate`)	End date for the search.
`city`	string `[ 1 .. 60 ] characters`	The proper name of the city used to determine the Tax Area ID (if none is supplied). Optional `(0..1)` but recommended for greatest precision if no Tax Area ID is supplied.
`coordinates`	required object (`CoordinatesType`)	Coordinates declaration.
`country`	required string `[ 1 .. 60 ]` characters	The country associated with the external jurisdiction code. You can use a data extract report to see the valid country values. Refer to Country Names extract in O Series Custom Reports - VRA for information.
`country` (`PostalAddressType`)	string `[ 1 .. 60 ] characters`	The country used to determine the Tax Area ID (if none is supplied). You can use a data extract report to see the valid country values. Refer to Country Names extract in O Series Custom Reports - VRA for information. Defaults to the value of the Default Country Code For Address setting. The default value for this setting is USA. For details about this setting, refer to Tax Area Lookup address parameters in O Series .
`externalJurisdictionCode`	required string `<= 20 characters`	string <= 20 characters A jurisdiction identifier provided by a government authority.
`latitude`	required number `<double>`	A number representing the geographical latitude coordinate of the location.
`longitude`	required number `<double>`	A number representing the geographical longitude coordinate of the location.
`lookupId`	string `[ 1 .. 40 ] characters`	Internal identifier or sequence number for this lookup.
`lookupRequest`	`AddressLookupRequestType` (object)	Object: - `asOfDate` - `postalAddress` - `returnTimeElapsedDetailsIndicator`
`lookupRequest`	`CoordinatesLookupRequestType` (object)	Object: - `asOfDate` - `coordinates`
`lookupRequest`	`TaxAreaIdLookupRequestType` (object)	Object: - `taxAreaId` - `asOfDate`
`lookupRequest`	`ExternalJurisdictionLookupRequestType` (object)	Object: - `externalJurisdictionCode` - `country` - `asOfDate`
`mainDivision`	string `[ 1 .. 60 ] characters`	The proper name or the postal abbreviation of the state, province, or territory used to determine the Tax Area ID if none is supplied. Optional `(0..1)` but recommended for greatest precision if no Tax Area ID is supplied.
`postalAddress`	required object (`PostalAddressType`)	Postal Address declaration. Object: - `city` - `country` - `mainDivision` - `postalCode` - `streetAddress1` - `streetAddress2` - `subDivision`
`postalCode`	string `[ 1 .. 20 ] characters`	The postal code used to determine the Tax Area ID (if none is supplied). For valid formats, see LookupTaxArea web services . Optional `(0..1)` but recommended for greatest precision if no Tax Area ID is supplied.
`returnTimeElapsedDetailsIndicator`	boolean	Indicates whether the response message should contain details of what composed the elapsed time. The default value is false.
`streetAddress1`	string `[ 1 .. 100 ] characters`	The first line of the street address.
`streetAddress2`	string `[ 1 .. 100 ] characters`	The second line of the street address.
`subDivision`	string `[ 1 .. 60 ] characters`	The name of the county or province used to determine the Tax Area ID if none is supplied. Optional `(0..1)` but recommended for greatest precision if no Tax Area ID is supplied.
`taxAreaId`	required string (`taxAreaId`)	A Vertex-specific number that identifies a tax area. When identifying whether a specific tax area has changed, this is the specific tax area for which to check for changes.